cloudsearch-2013-01-01.min.json (23201B)
1 { 2 "version": "2.0", 3 "metadata": { 4 "apiVersion": "2013-01-01", 5 "endpointPrefix": "cloudsearch", 6 "serviceFullName": "Amazon CloudSearch", 7 "signatureVersion": "v4", 8 "xmlNamespace": "http://cloudsearch.amazonaws.com/doc/2013-01-01/", 9 "protocol": "query" 10 }, 11 "operations": { 12 "BuildSuggesters": { 13 "input": { 14 "type": "structure", 15 "required": [ 16 "DomainName" 17 ], 18 "members": { 19 "DomainName": {} 20 } 21 }, 22 "output": { 23 "resultWrapper": "BuildSuggestersResult", 24 "type": "structure", 25 "members": { 26 "FieldNames": { 27 "shape": "S4" 28 } 29 } 30 } 31 }, 32 "CreateDomain": { 33 "input": { 34 "type": "structure", 35 "required": [ 36 "DomainName" 37 ], 38 "members": { 39 "DomainName": {} 40 } 41 }, 42 "output": { 43 "resultWrapper": "CreateDomainResult", 44 "type": "structure", 45 "members": { 46 "DomainStatus": { 47 "shape": "S8" 48 } 49 } 50 } 51 }, 52 "DefineAnalysisScheme": { 53 "input": { 54 "type": "structure", 55 "required": [ 56 "DomainName", 57 "AnalysisScheme" 58 ], 59 "members": { 60 "DomainName": {}, 61 "AnalysisScheme": { 62 "shape": "Sl" 63 } 64 } 65 }, 66 "output": { 67 "resultWrapper": "DefineAnalysisSchemeResult", 68 "type": "structure", 69 "required": [ 70 "AnalysisScheme" 71 ], 72 "members": { 73 "AnalysisScheme": { 74 "shape": "Ss" 75 } 76 } 77 } 78 }, 79 "DefineExpression": { 80 "input": { 81 "type": "structure", 82 "required": [ 83 "DomainName", 84 "Expression" 85 ], 86 "members": { 87 "DomainName": {}, 88 "Expression": { 89 "shape": "Sy" 90 } 91 } 92 }, 93 "output": { 94 "resultWrapper": "DefineExpressionResult", 95 "type": "structure", 96 "required": [ 97 "Expression" 98 ], 99 "members": { 100 "Expression": { 101 "shape": "S11" 102 } 103 } 104 } 105 }, 106 "DefineIndexField": { 107 "input": { 108 "type": "structure", 109 "required": [ 110 "DomainName", 111 "IndexField" 112 ], 113 "members": { 114 "DomainName": {}, 115 "IndexField": { 116 "shape": "S13" 117 } 118 } 119 }, 120 "output": { 121 "resultWrapper": "DefineIndexFieldResult", 122 "type": "structure", 123 "required": [ 124 "IndexField" 125 ], 126 "members": { 127 "IndexField": { 128 "shape": "S1n" 129 } 130 } 131 } 132 }, 133 "DefineSuggester": { 134 "input": { 135 "type": "structure", 136 "required": [ 137 "DomainName", 138 "Suggester" 139 ], 140 "members": { 141 "DomainName": {}, 142 "Suggester": { 143 "shape": "S1p" 144 } 145 } 146 }, 147 "output": { 148 "resultWrapper": "DefineSuggesterResult", 149 "type": "structure", 150 "required": [ 151 "Suggester" 152 ], 153 "members": { 154 "Suggester": { 155 "shape": "S1t" 156 } 157 } 158 } 159 }, 160 "DeleteAnalysisScheme": { 161 "input": { 162 "type": "structure", 163 "required": [ 164 "DomainName", 165 "AnalysisSchemeName" 166 ], 167 "members": { 168 "DomainName": {}, 169 "AnalysisSchemeName": {} 170 } 171 }, 172 "output": { 173 "resultWrapper": "DeleteAnalysisSchemeResult", 174 "type": "structure", 175 "required": [ 176 "AnalysisScheme" 177 ], 178 "members": { 179 "AnalysisScheme": { 180 "shape": "Ss" 181 } 182 } 183 } 184 }, 185 "DeleteDomain": { 186 "input": { 187 "type": "structure", 188 "required": [ 189 "DomainName" 190 ], 191 "members": { 192 "DomainName": {} 193 } 194 }, 195 "output": { 196 "resultWrapper": "DeleteDomainResult", 197 "type": "structure", 198 "members": { 199 "DomainStatus": { 200 "shape": "S8" 201 } 202 } 203 } 204 }, 205 "DeleteExpression": { 206 "input": { 207 "type": "structure", 208 "required": [ 209 "DomainName", 210 "ExpressionName" 211 ], 212 "members": { 213 "DomainName": {}, 214 "ExpressionName": {} 215 } 216 }, 217 "output": { 218 "resultWrapper": "DeleteExpressionResult", 219 "type": "structure", 220 "required": [ 221 "Expression" 222 ], 223 "members": { 224 "Expression": { 225 "shape": "S11" 226 } 227 } 228 } 229 }, 230 "DeleteIndexField": { 231 "input": { 232 "type": "structure", 233 "required": [ 234 "DomainName", 235 "IndexFieldName" 236 ], 237 "members": { 238 "DomainName": {}, 239 "IndexFieldName": {} 240 } 241 }, 242 "output": { 243 "resultWrapper": "DeleteIndexFieldResult", 244 "type": "structure", 245 "required": [ 246 "IndexField" 247 ], 248 "members": { 249 "IndexField": { 250 "shape": "S1n" 251 } 252 } 253 } 254 }, 255 "DeleteSuggester": { 256 "input": { 257 "type": "structure", 258 "required": [ 259 "DomainName", 260 "SuggesterName" 261 ], 262 "members": { 263 "DomainName": {}, 264 "SuggesterName": {} 265 } 266 }, 267 "output": { 268 "resultWrapper": "DeleteSuggesterResult", 269 "type": "structure", 270 "required": [ 271 "Suggester" 272 ], 273 "members": { 274 "Suggester": { 275 "shape": "S1t" 276 } 277 } 278 } 279 }, 280 "DescribeAnalysisSchemes": { 281 "input": { 282 "type": "structure", 283 "required": [ 284 "DomainName" 285 ], 286 "members": { 287 "DomainName": {}, 288 "AnalysisSchemeNames": { 289 "shape": "S25" 290 }, 291 "Deployed": { 292 "type": "boolean" 293 } 294 } 295 }, 296 "output": { 297 "resultWrapper": "DescribeAnalysisSchemesResult", 298 "type": "structure", 299 "required": [ 300 "AnalysisSchemes" 301 ], 302 "members": { 303 "AnalysisSchemes": { 304 "type": "list", 305 "member": { 306 "shape": "Ss" 307 } 308 } 309 } 310 } 311 }, 312 "DescribeAvailabilityOptions": { 313 "input": { 314 "type": "structure", 315 "required": [ 316 "DomainName" 317 ], 318 "members": { 319 "DomainName": {}, 320 "Deployed": { 321 "type": "boolean" 322 } 323 } 324 }, 325 "output": { 326 "resultWrapper": "DescribeAvailabilityOptionsResult", 327 "type": "structure", 328 "members": { 329 "AvailabilityOptions": { 330 "shape": "S2a" 331 } 332 } 333 } 334 }, 335 "DescribeDomains": { 336 "input": { 337 "type": "structure", 338 "members": { 339 "DomainNames": { 340 "type": "list", 341 "member": {} 342 } 343 } 344 }, 345 "output": { 346 "resultWrapper": "DescribeDomainsResult", 347 "type": "structure", 348 "required": [ 349 "DomainStatusList" 350 ], 351 "members": { 352 "DomainStatusList": { 353 "type": "list", 354 "member": { 355 "shape": "S8" 356 } 357 } 358 } 359 } 360 }, 361 "DescribeExpressions": { 362 "input": { 363 "type": "structure", 364 "required": [ 365 "DomainName" 366 ], 367 "members": { 368 "DomainName": {}, 369 "ExpressionNames": { 370 "shape": "S25" 371 }, 372 "Deployed": { 373 "type": "boolean" 374 } 375 } 376 }, 377 "output": { 378 "resultWrapper": "DescribeExpressionsResult", 379 "type": "structure", 380 "required": [ 381 "Expressions" 382 ], 383 "members": { 384 "Expressions": { 385 "type": "list", 386 "member": { 387 "shape": "S11" 388 } 389 } 390 } 391 } 392 }, 393 "DescribeIndexFields": { 394 "input": { 395 "type": "structure", 396 "required": [ 397 "DomainName" 398 ], 399 "members": { 400 "DomainName": {}, 401 "FieldNames": { 402 "type": "list", 403 "member": {} 404 }, 405 "Deployed": { 406 "type": "boolean" 407 } 408 } 409 }, 410 "output": { 411 "resultWrapper": "DescribeIndexFieldsResult", 412 "type": "structure", 413 "required": [ 414 "IndexFields" 415 ], 416 "members": { 417 "IndexFields": { 418 "type": "list", 419 "member": { 420 "shape": "S1n" 421 } 422 } 423 } 424 } 425 }, 426 "DescribeScalingParameters": { 427 "input": { 428 "type": "structure", 429 "required": [ 430 "DomainName" 431 ], 432 "members": { 433 "DomainName": {} 434 } 435 }, 436 "output": { 437 "resultWrapper": "DescribeScalingParametersResult", 438 "type": "structure", 439 "required": [ 440 "ScalingParameters" 441 ], 442 "members": { 443 "ScalingParameters": { 444 "shape": "S2p" 445 } 446 } 447 } 448 }, 449 "DescribeServiceAccessPolicies": { 450 "input": { 451 "type": "structure", 452 "required": [ 453 "DomainName" 454 ], 455 "members": { 456 "DomainName": {}, 457 "Deployed": { 458 "type": "boolean" 459 } 460 } 461 }, 462 "output": { 463 "resultWrapper": "DescribeServiceAccessPoliciesResult", 464 "type": "structure", 465 "required": [ 466 "AccessPolicies" 467 ], 468 "members": { 469 "AccessPolicies": { 470 "shape": "S2u" 471 } 472 } 473 } 474 }, 475 "DescribeSuggesters": { 476 "input": { 477 "type": "structure", 478 "required": [ 479 "DomainName" 480 ], 481 "members": { 482 "DomainName": {}, 483 "SuggesterNames": { 484 "shape": "S25" 485 }, 486 "Deployed": { 487 "type": "boolean" 488 } 489 } 490 }, 491 "output": { 492 "resultWrapper": "DescribeSuggestersResult", 493 "type": "structure", 494 "required": [ 495 "Suggesters" 496 ], 497 "members": { 498 "Suggesters": { 499 "type": "list", 500 "member": { 501 "shape": "S1t" 502 } 503 } 504 } 505 } 506 }, 507 "IndexDocuments": { 508 "input": { 509 "type": "structure", 510 "required": [ 511 "DomainName" 512 ], 513 "members": { 514 "DomainName": {} 515 } 516 }, 517 "output": { 518 "resultWrapper": "IndexDocumentsResult", 519 "type": "structure", 520 "members": { 521 "FieldNames": { 522 "shape": "S4" 523 } 524 } 525 } 526 }, 527 "ListDomainNames": { 528 "output": { 529 "resultWrapper": "ListDomainNamesResult", 530 "type": "structure", 531 "members": { 532 "DomainNames": { 533 "type": "map", 534 "key": {}, 535 "value": {} 536 } 537 } 538 } 539 }, 540 "UpdateAvailabilityOptions": { 541 "input": { 542 "type": "structure", 543 "required": [ 544 "DomainName", 545 "MultiAZ" 546 ], 547 "members": { 548 "DomainName": {}, 549 "MultiAZ": { 550 "type": "boolean" 551 } 552 } 553 }, 554 "output": { 555 "resultWrapper": "UpdateAvailabilityOptionsResult", 556 "type": "structure", 557 "members": { 558 "AvailabilityOptions": { 559 "shape": "S2a" 560 } 561 } 562 } 563 }, 564 "UpdateScalingParameters": { 565 "input": { 566 "type": "structure", 567 "required": [ 568 "DomainName", 569 "ScalingParameters" 570 ], 571 "members": { 572 "DomainName": {}, 573 "ScalingParameters": { 574 "shape": "S2q" 575 } 576 } 577 }, 578 "output": { 579 "resultWrapper": "UpdateScalingParametersResult", 580 "type": "structure", 581 "required": [ 582 "ScalingParameters" 583 ], 584 "members": { 585 "ScalingParameters": { 586 "shape": "S2p" 587 } 588 } 589 } 590 }, 591 "UpdateServiceAccessPolicies": { 592 "input": { 593 "type": "structure", 594 "required": [ 595 "DomainName", 596 "AccessPolicies" 597 ], 598 "members": { 599 "DomainName": {}, 600 "AccessPolicies": {} 601 } 602 }, 603 "output": { 604 "resultWrapper": "UpdateServiceAccessPoliciesResult", 605 "type": "structure", 606 "required": [ 607 "AccessPolicies" 608 ], 609 "members": { 610 "AccessPolicies": { 611 "shape": "S2u" 612 } 613 } 614 } 615 } 616 }, 617 "shapes": { 618 "S4": { 619 "type": "list", 620 "member": {} 621 }, 622 "S8": { 623 "type": "structure", 624 "required": [ 625 "DomainId", 626 "DomainName", 627 "RequiresIndexDocuments" 628 ], 629 "members": { 630 "DomainId": {}, 631 "DomainName": {}, 632 "ARN": {}, 633 "Created": { 634 "type": "boolean" 635 }, 636 "Deleted": { 637 "type": "boolean" 638 }, 639 "DocService": { 640 "shape": "Sc" 641 }, 642 "SearchService": { 643 "shape": "Sc" 644 }, 645 "RequiresIndexDocuments": { 646 "type": "boolean" 647 }, 648 "Processing": { 649 "type": "boolean" 650 }, 651 "SearchInstanceType": {}, 652 "SearchPartitionCount": { 653 "type": "integer" 654 }, 655 "SearchInstanceCount": { 656 "type": "integer" 657 }, 658 "Limits": { 659 "type": "structure", 660 "required": [ 661 "MaximumReplicationCount", 662 "MaximumPartitionCount" 663 ], 664 "members": { 665 "MaximumReplicationCount": { 666 "type": "integer" 667 }, 668 "MaximumPartitionCount": { 669 "type": "integer" 670 } 671 } 672 } 673 } 674 }, 675 "Sc": { 676 "type": "structure", 677 "members": { 678 "Endpoint": {} 679 } 680 }, 681 "Sl": { 682 "type": "structure", 683 "required": [ 684 "AnalysisSchemeName", 685 "AnalysisSchemeLanguage" 686 ], 687 "members": { 688 "AnalysisSchemeName": {}, 689 "AnalysisSchemeLanguage": {}, 690 "AnalysisOptions": { 691 "type": "structure", 692 "members": { 693 "Synonyms": {}, 694 "Stopwords": {}, 695 "StemmingDictionary": {}, 696 "JapaneseTokenizationDictionary": {}, 697 "AlgorithmicStemming": {} 698 } 699 } 700 } 701 }, 702 "Ss": { 703 "type": "structure", 704 "required": [ 705 "Options", 706 "Status" 707 ], 708 "members": { 709 "Options": { 710 "shape": "Sl" 711 }, 712 "Status": { 713 "shape": "St" 714 } 715 } 716 }, 717 "St": { 718 "type": "structure", 719 "required": [ 720 "CreationDate", 721 "UpdateDate", 722 "State" 723 ], 724 "members": { 725 "CreationDate": { 726 "type": "timestamp" 727 }, 728 "UpdateDate": { 729 "type": "timestamp" 730 }, 731 "UpdateVersion": { 732 "type": "integer" 733 }, 734 "State": {}, 735 "PendingDeletion": { 736 "type": "boolean" 737 } 738 } 739 }, 740 "Sy": { 741 "type": "structure", 742 "required": [ 743 "ExpressionName", 744 "ExpressionValue" 745 ], 746 "members": { 747 "ExpressionName": {}, 748 "ExpressionValue": {} 749 } 750 }, 751 "S11": { 752 "type": "structure", 753 "required": [ 754 "Options", 755 "Status" 756 ], 757 "members": { 758 "Options": { 759 "shape": "Sy" 760 }, 761 "Status": { 762 "shape": "St" 763 } 764 } 765 }, 766 "S13": { 767 "type": "structure", 768 "required": [ 769 "IndexFieldName", 770 "IndexFieldType" 771 ], 772 "members": { 773 "IndexFieldName": {}, 774 "IndexFieldType": {}, 775 "IntOptions": { 776 "type": "structure", 777 "members": { 778 "DefaultValue": { 779 "type": "long" 780 }, 781 "SourceField": {}, 782 "FacetEnabled": { 783 "type": "boolean" 784 }, 785 "SearchEnabled": { 786 "type": "boolean" 787 }, 788 "ReturnEnabled": { 789 "type": "boolean" 790 }, 791 "SortEnabled": { 792 "type": "boolean" 793 } 794 } 795 }, 796 "DoubleOptions": { 797 "type": "structure", 798 "members": { 799 "DefaultValue": { 800 "type": "double" 801 }, 802 "SourceField": {}, 803 "FacetEnabled": { 804 "type": "boolean" 805 }, 806 "SearchEnabled": { 807 "type": "boolean" 808 }, 809 "ReturnEnabled": { 810 "type": "boolean" 811 }, 812 "SortEnabled": { 813 "type": "boolean" 814 } 815 } 816 }, 817 "LiteralOptions": { 818 "type": "structure", 819 "members": { 820 "DefaultValue": {}, 821 "SourceField": {}, 822 "FacetEnabled": { 823 "type": "boolean" 824 }, 825 "SearchEnabled": { 826 "type": "boolean" 827 }, 828 "ReturnEnabled": { 829 "type": "boolean" 830 }, 831 "SortEnabled": { 832 "type": "boolean" 833 } 834 } 835 }, 836 "TextOptions": { 837 "type": "structure", 838 "members": { 839 "DefaultValue": {}, 840 "SourceField": {}, 841 "ReturnEnabled": { 842 "type": "boolean" 843 }, 844 "SortEnabled": { 845 "type": "boolean" 846 }, 847 "HighlightEnabled": { 848 "type": "boolean" 849 }, 850 "AnalysisScheme": {} 851 } 852 }, 853 "DateOptions": { 854 "type": "structure", 855 "members": { 856 "DefaultValue": {}, 857 "SourceField": {}, 858 "FacetEnabled": { 859 "type": "boolean" 860 }, 861 "SearchEnabled": { 862 "type": "boolean" 863 }, 864 "ReturnEnabled": { 865 "type": "boolean" 866 }, 867 "SortEnabled": { 868 "type": "boolean" 869 } 870 } 871 }, 872 "LatLonOptions": { 873 "type": "structure", 874 "members": { 875 "DefaultValue": {}, 876 "SourceField": {}, 877 "FacetEnabled": { 878 "type": "boolean" 879 }, 880 "SearchEnabled": { 881 "type": "boolean" 882 }, 883 "ReturnEnabled": { 884 "type": "boolean" 885 }, 886 "SortEnabled": { 887 "type": "boolean" 888 } 889 } 890 }, 891 "IntArrayOptions": { 892 "type": "structure", 893 "members": { 894 "DefaultValue": { 895 "type": "long" 896 }, 897 "SourceFields": {}, 898 "FacetEnabled": { 899 "type": "boolean" 900 }, 901 "SearchEnabled": { 902 "type": "boolean" 903 }, 904 "ReturnEnabled": { 905 "type": "boolean" 906 } 907 } 908 }, 909 "DoubleArrayOptions": { 910 "type": "structure", 911 "members": { 912 "DefaultValue": { 913 "type": "double" 914 }, 915 "SourceFields": {}, 916 "FacetEnabled": { 917 "type": "boolean" 918 }, 919 "SearchEnabled": { 920 "type": "boolean" 921 }, 922 "ReturnEnabled": { 923 "type": "boolean" 924 } 925 } 926 }, 927 "LiteralArrayOptions": { 928 "type": "structure", 929 "members": { 930 "DefaultValue": {}, 931 "SourceFields": {}, 932 "FacetEnabled": { 933 "type": "boolean" 934 }, 935 "SearchEnabled": { 936 "type": "boolean" 937 }, 938 "ReturnEnabled": { 939 "type": "boolean" 940 } 941 } 942 }, 943 "TextArrayOptions": { 944 "type": "structure", 945 "members": { 946 "DefaultValue": {}, 947 "SourceFields": {}, 948 "ReturnEnabled": { 949 "type": "boolean" 950 }, 951 "HighlightEnabled": { 952 "type": "boolean" 953 }, 954 "AnalysisScheme": {} 955 } 956 }, 957 "DateArrayOptions": { 958 "type": "structure", 959 "members": { 960 "DefaultValue": {}, 961 "SourceFields": {}, 962 "FacetEnabled": { 963 "type": "boolean" 964 }, 965 "SearchEnabled": { 966 "type": "boolean" 967 }, 968 "ReturnEnabled": { 969 "type": "boolean" 970 } 971 } 972 } 973 } 974 }, 975 "S1n": { 976 "type": "structure", 977 "required": [ 978 "Options", 979 "Status" 980 ], 981 "members": { 982 "Options": { 983 "shape": "S13" 984 }, 985 "Status": { 986 "shape": "St" 987 } 988 } 989 }, 990 "S1p": { 991 "type": "structure", 992 "required": [ 993 "SuggesterName", 994 "DocumentSuggesterOptions" 995 ], 996 "members": { 997 "SuggesterName": {}, 998 "DocumentSuggesterOptions": { 999 "type": "structure", 1000 "required": [ 1001 "SourceField" 1002 ], 1003 "members": { 1004 "SourceField": {}, 1005 "FuzzyMatching": {}, 1006 "SortExpression": {} 1007 } 1008 } 1009 } 1010 }, 1011 "S1t": { 1012 "type": "structure", 1013 "required": [ 1014 "Options", 1015 "Status" 1016 ], 1017 "members": { 1018 "Options": { 1019 "shape": "S1p" 1020 }, 1021 "Status": { 1022 "shape": "St" 1023 } 1024 } 1025 }, 1026 "S25": { 1027 "type": "list", 1028 "member": {} 1029 }, 1030 "S2a": { 1031 "type": "structure", 1032 "required": [ 1033 "Options", 1034 "Status" 1035 ], 1036 "members": { 1037 "Options": { 1038 "type": "boolean" 1039 }, 1040 "Status": { 1041 "shape": "St" 1042 } 1043 } 1044 }, 1045 "S2p": { 1046 "type": "structure", 1047 "required": [ 1048 "Options", 1049 "Status" 1050 ], 1051 "members": { 1052 "Options": { 1053 "shape": "S2q" 1054 }, 1055 "Status": { 1056 "shape": "St" 1057 } 1058 } 1059 }, 1060 "S2q": { 1061 "type": "structure", 1062 "members": { 1063 "DesiredInstanceType": {}, 1064 "DesiredReplicationCount": { 1065 "type": "integer" 1066 }, 1067 "DesiredPartitionCount": { 1068 "type": "integer" 1069 } 1070 } 1071 }, 1072 "S2u": { 1073 "type": "structure", 1074 "required": [ 1075 "Options", 1076 "Status" 1077 ], 1078 "members": { 1079 "Options": {}, 1080 "Status": { 1081 "shape": "St" 1082 } 1083 } 1084 } 1085 } 1086 }