UNPKG

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