UNPKG

24.9 kBJSONView Raw
1{
2 "version": "2.0",
3 "metadata": {
4 "apiVersion": "2019-02-03",
5 "endpointPrefix": "kendra",
6 "jsonVersion": "1.1",
7 "protocol": "json",
8 "serviceAbbreviation": "kendra",
9 "serviceFullName": "AWSKendraFrontendService",
10 "serviceId": "kendra",
11 "signatureVersion": "v4",
12 "signingName": "kendra",
13 "targetPrefix": "AWSKendraFrontendService",
14 "uid": "kendra-2019-02-03"
15 },
16 "operations": {
17 "BatchDeleteDocument": {
18 "input": {
19 "type": "structure",
20 "required": [
21 "IndexId",
22 "DocumentIdList"
23 ],
24 "members": {
25 "IndexId": {},
26 "DocumentIdList": {
27 "type": "list",
28 "member": {}
29 }
30 }
31 },
32 "output": {
33 "type": "structure",
34 "members": {
35 "FailedDocuments": {
36 "type": "list",
37 "member": {
38 "type": "structure",
39 "members": {
40 "Id": {},
41 "ErrorCode": {},
42 "ErrorMessage": {}
43 }
44 }
45 }
46 }
47 }
48 },
49 "BatchPutDocument": {
50 "input": {
51 "type": "structure",
52 "required": [
53 "IndexId",
54 "Documents"
55 ],
56 "members": {
57 "IndexId": {},
58 "RoleArn": {},
59 "Documents": {
60 "type": "list",
61 "member": {
62 "type": "structure",
63 "required": [
64 "Id"
65 ],
66 "members": {
67 "Id": {},
68 "Title": {},
69 "Blob": {
70 "type": "blob"
71 },
72 "S3Path": {
73 "shape": "Sg"
74 },
75 "Attributes": {
76 "shape": "Sj"
77 },
78 "AccessControlList": {
79 "type": "list",
80 "member": {
81 "type": "structure",
82 "required": [
83 "Name",
84 "Type",
85 "Access"
86 ],
87 "members": {
88 "Name": {},
89 "Type": {},
90 "Access": {}
91 }
92 }
93 },
94 "ContentType": {}
95 }
96 }
97 }
98 }
99 },
100 "output": {
101 "type": "structure",
102 "members": {
103 "FailedDocuments": {
104 "type": "list",
105 "member": {
106 "type": "structure",
107 "members": {
108 "Id": {},
109 "ErrorCode": {},
110 "ErrorMessage": {}
111 }
112 }
113 }
114 }
115 }
116 },
117 "CreateDataSource": {
118 "input": {
119 "type": "structure",
120 "required": [
121 "Name",
122 "IndexId",
123 "Type",
124 "Configuration",
125 "RoleArn"
126 ],
127 "members": {
128 "Name": {},
129 "IndexId": {},
130 "Type": {},
131 "Configuration": {
132 "shape": "S14"
133 },
134 "Description": {},
135 "Schedule": {},
136 "RoleArn": {}
137 }
138 },
139 "output": {
140 "type": "structure",
141 "required": [
142 "Id"
143 ],
144 "members": {
145 "Id": {}
146 }
147 }
148 },
149 "CreateFaq": {
150 "input": {
151 "type": "structure",
152 "required": [
153 "IndexId",
154 "Name",
155 "S3Path",
156 "RoleArn"
157 ],
158 "members": {
159 "IndexId": {},
160 "Name": {},
161 "Description": {},
162 "S3Path": {
163 "shape": "Sg"
164 },
165 "RoleArn": {}
166 }
167 },
168 "output": {
169 "type": "structure",
170 "members": {
171 "Id": {}
172 }
173 }
174 },
175 "CreateIndex": {
176 "input": {
177 "type": "structure",
178 "required": [
179 "Name",
180 "RoleArn"
181 ],
182 "members": {
183 "Name": {},
184 "RoleArn": {},
185 "ServerSideEncryptionConfiguration": {
186 "shape": "S2b"
187 },
188 "Description": {},
189 "ClientToken": {
190 "idempotencyToken": true
191 }
192 }
193 },
194 "output": {
195 "type": "structure",
196 "members": {
197 "Id": {}
198 }
199 }
200 },
201 "DeleteFaq": {
202 "input": {
203 "type": "structure",
204 "required": [
205 "Id",
206 "IndexId"
207 ],
208 "members": {
209 "Id": {},
210 "IndexId": {}
211 }
212 }
213 },
214 "DeleteIndex": {
215 "input": {
216 "type": "structure",
217 "required": [
218 "Id"
219 ],
220 "members": {
221 "Id": {}
222 }
223 }
224 },
225 "DescribeDataSource": {
226 "input": {
227 "type": "structure",
228 "required": [
229 "Id",
230 "IndexId"
231 ],
232 "members": {
233 "Id": {},
234 "IndexId": {}
235 }
236 },
237 "output": {
238 "type": "structure",
239 "members": {
240 "Id": {},
241 "IndexId": {},
242 "Name": {},
243 "Type": {},
244 "Configuration": {
245 "shape": "S14"
246 },
247 "CreatedAt": {
248 "type": "timestamp"
249 },
250 "UpdatedAt": {
251 "type": "timestamp"
252 },
253 "Description": {},
254 "Status": {},
255 "Schedule": {},
256 "RoleArn": {},
257 "ErrorMessage": {}
258 }
259 }
260 },
261 "DescribeFaq": {
262 "input": {
263 "type": "structure",
264 "required": [
265 "Id",
266 "IndexId"
267 ],
268 "members": {
269 "Id": {},
270 "IndexId": {}
271 }
272 },
273 "output": {
274 "type": "structure",
275 "members": {
276 "Id": {},
277 "IndexId": {},
278 "Name": {},
279 "Description": {},
280 "CreatedAt": {
281 "type": "timestamp"
282 },
283 "UpdatedAt": {
284 "type": "timestamp"
285 },
286 "S3Path": {
287 "shape": "Sg"
288 },
289 "Status": {},
290 "RoleArn": {},
291 "ErrorMessage": {}
292 }
293 }
294 },
295 "DescribeIndex": {
296 "input": {
297 "type": "structure",
298 "required": [
299 "Id"
300 ],
301 "members": {
302 "Id": {}
303 }
304 },
305 "output": {
306 "type": "structure",
307 "members": {
308 "Name": {},
309 "Id": {},
310 "RoleArn": {},
311 "ServerSideEncryptionConfiguration": {
312 "shape": "S2b"
313 },
314 "Status": {},
315 "Description": {},
316 "CreatedAt": {
317 "type": "timestamp"
318 },
319 "UpdatedAt": {
320 "type": "timestamp"
321 },
322 "DocumentMetadataConfigurations": {
323 "shape": "S2q"
324 },
325 "IndexStatistics": {
326 "type": "structure",
327 "required": [
328 "FaqStatistics",
329 "TextDocumentStatistics"
330 ],
331 "members": {
332 "FaqStatistics": {
333 "type": "structure",
334 "required": [
335 "IndexedQuestionAnswersCount"
336 ],
337 "members": {
338 "IndexedQuestionAnswersCount": {
339 "type": "integer"
340 }
341 }
342 },
343 "TextDocumentStatistics": {
344 "type": "structure",
345 "required": [
346 "IndexedTextDocumentsCount"
347 ],
348 "members": {
349 "IndexedTextDocumentsCount": {
350 "type": "integer"
351 }
352 }
353 }
354 }
355 },
356 "ErrorMessage": {}
357 }
358 }
359 },
360 "ListDataSourceSyncJobs": {
361 "input": {
362 "type": "structure",
363 "required": [
364 "Id",
365 "IndexId"
366 ],
367 "members": {
368 "Id": {},
369 "IndexId": {},
370 "NextToken": {},
371 "MaxResults": {
372 "type": "integer"
373 },
374 "StartTimeFilter": {
375 "type": "structure",
376 "members": {
377 "StartTime": {
378 "type": "timestamp"
379 },
380 "EndTime": {
381 "type": "timestamp"
382 }
383 }
384 },
385 "StatusFilter": {}
386 }
387 },
388 "output": {
389 "type": "structure",
390 "members": {
391 "History": {
392 "type": "list",
393 "member": {
394 "type": "structure",
395 "members": {
396 "ExecutionId": {},
397 "StartTime": {
398 "type": "timestamp"
399 },
400 "EndTime": {
401 "type": "timestamp"
402 },
403 "Status": {},
404 "ErrorMessage": {},
405 "ErrorCode": {},
406 "DataSourceErrorCode": {}
407 }
408 }
409 },
410 "NextToken": {}
411 }
412 }
413 },
414 "ListDataSources": {
415 "input": {
416 "type": "structure",
417 "required": [
418 "IndexId"
419 ],
420 "members": {
421 "IndexId": {},
422 "NextToken": {},
423 "MaxResults": {
424 "type": "integer"
425 }
426 }
427 },
428 "output": {
429 "type": "structure",
430 "members": {
431 "SummaryItems": {
432 "type": "list",
433 "member": {
434 "type": "structure",
435 "members": {
436 "Name": {},
437 "Id": {},
438 "Type": {},
439 "CreatedAt": {
440 "type": "timestamp"
441 },
442 "UpdatedAt": {
443 "type": "timestamp"
444 },
445 "Status": {}
446 }
447 }
448 },
449 "NextToken": {}
450 }
451 }
452 },
453 "ListFaqs": {
454 "input": {
455 "type": "structure",
456 "required": [
457 "IndexId"
458 ],
459 "members": {
460 "IndexId": {},
461 "NextToken": {},
462 "MaxResults": {
463 "type": "integer"
464 }
465 }
466 },
467 "output": {
468 "type": "structure",
469 "members": {
470 "NextToken": {},
471 "FaqSummaryItems": {
472 "type": "list",
473 "member": {
474 "type": "structure",
475 "members": {
476 "Id": {},
477 "Name": {},
478 "Status": {},
479 "CreatedAt": {
480 "type": "timestamp"
481 },
482 "UpdatedAt": {
483 "type": "timestamp"
484 }
485 }
486 }
487 }
488 }
489 }
490 },
491 "ListIndices": {
492 "input": {
493 "type": "structure",
494 "members": {
495 "NextToken": {},
496 "MaxResults": {
497 "type": "integer"
498 }
499 }
500 },
501 "output": {
502 "type": "structure",
503 "members": {
504 "IndexConfigurationSummaryItems": {
505 "type": "list",
506 "member": {
507 "type": "structure",
508 "required": [
509 "CreatedAt",
510 "UpdatedAt",
511 "Status"
512 ],
513 "members": {
514 "Name": {},
515 "Id": {},
516 "CreatedAt": {
517 "type": "timestamp"
518 },
519 "UpdatedAt": {
520 "type": "timestamp"
521 },
522 "Status": {}
523 }
524 }
525 },
526 "NextToken": {}
527 }
528 }
529 },
530 "Query": {
531 "input": {
532 "type": "structure",
533 "required": [
534 "IndexId",
535 "QueryText"
536 ],
537 "members": {
538 "IndexId": {},
539 "QueryText": {},
540 "AttributeFilter": {
541 "shape": "S3w"
542 },
543 "Facets": {
544 "type": "list",
545 "member": {
546 "type": "structure",
547 "members": {
548 "DocumentAttributeKey": {}
549 }
550 }
551 },
552 "RequestedDocumentAttributes": {
553 "type": "list",
554 "member": {}
555 },
556 "QueryResultTypeFilter": {},
557 "PageNumber": {
558 "type": "integer"
559 },
560 "PageSize": {
561 "type": "integer"
562 }
563 }
564 },
565 "output": {
566 "type": "structure",
567 "members": {
568 "QueryId": {},
569 "ResultItems": {
570 "type": "list",
571 "member": {
572 "type": "structure",
573 "members": {
574 "Id": {},
575 "Type": {},
576 "AdditionalAttributes": {
577 "type": "list",
578 "member": {
579 "type": "structure",
580 "required": [
581 "Key",
582 "ValueType",
583 "Value"
584 ],
585 "members": {
586 "Key": {},
587 "ValueType": {},
588 "Value": {
589 "type": "structure",
590 "members": {
591 "TextWithHighlightsValue": {
592 "shape": "S4c"
593 }
594 }
595 }
596 }
597 }
598 },
599 "DocumentId": {},
600 "DocumentTitle": {
601 "shape": "S4c"
602 },
603 "DocumentExcerpt": {
604 "shape": "S4c"
605 },
606 "DocumentURI": {},
607 "DocumentAttributes": {
608 "shape": "Sj"
609 }
610 }
611 }
612 },
613 "FacetResults": {
614 "type": "list",
615 "member": {
616 "type": "structure",
617 "members": {
618 "DocumentAttributeKey": {},
619 "DocumentAttributeValueCountPairs": {
620 "type": "list",
621 "member": {
622 "type": "structure",
623 "members": {
624 "DocumentAttributeValue": {
625 "shape": "Sm"
626 },
627 "Count": {
628 "type": "integer"
629 }
630 }
631 }
632 }
633 }
634 }
635 },
636 "TotalNumberOfResults": {
637 "type": "integer"
638 }
639 }
640 }
641 },
642 "StartDataSourceSyncJob": {
643 "input": {
644 "type": "structure",
645 "required": [
646 "Id",
647 "IndexId"
648 ],
649 "members": {
650 "Id": {},
651 "IndexId": {}
652 }
653 },
654 "output": {
655 "type": "structure",
656 "members": {
657 "ExecutionId": {}
658 }
659 }
660 },
661 "StopDataSourceSyncJob": {
662 "input": {
663 "type": "structure",
664 "required": [
665 "Id",
666 "IndexId"
667 ],
668 "members": {
669 "Id": {},
670 "IndexId": {}
671 }
672 }
673 },
674 "SubmitFeedback": {
675 "input": {
676 "type": "structure",
677 "required": [
678 "IndexId",
679 "QueryId"
680 ],
681 "members": {
682 "IndexId": {},
683 "QueryId": {},
684 "ClickFeedbackItems": {
685 "type": "list",
686 "member": {
687 "type": "structure",
688 "required": [
689 "ResultId",
690 "ClickTime"
691 ],
692 "members": {
693 "ResultId": {},
694 "ClickTime": {
695 "type": "timestamp"
696 }
697 }
698 }
699 },
700 "RelevanceFeedbackItems": {
701 "type": "list",
702 "member": {
703 "type": "structure",
704 "required": [
705 "ResultId",
706 "RelevanceValue"
707 ],
708 "members": {
709 "ResultId": {},
710 "RelevanceValue": {}
711 }
712 }
713 }
714 }
715 }
716 },
717 "UpdateDataSource": {
718 "input": {
719 "type": "structure",
720 "required": [
721 "Id",
722 "IndexId"
723 ],
724 "members": {
725 "Id": {},
726 "Name": {},
727 "IndexId": {},
728 "Configuration": {
729 "shape": "S14"
730 },
731 "Description": {},
732 "Schedule": {},
733 "RoleArn": {}
734 }
735 }
736 },
737 "UpdateIndex": {
738 "input": {
739 "type": "structure",
740 "required": [
741 "Id"
742 ],
743 "members": {
744 "Id": {},
745 "Name": {},
746 "RoleArn": {},
747 "Description": {},
748 "DocumentMetadataConfigurationUpdates": {
749 "shape": "S2q"
750 }
751 }
752 }
753 }
754 },
755 "shapes": {
756 "Sg": {
757 "type": "structure",
758 "required": [
759 "Bucket",
760 "Key"
761 ],
762 "members": {
763 "Bucket": {},
764 "Key": {}
765 }
766 },
767 "Sj": {
768 "type": "list",
769 "member": {
770 "shape": "Sk"
771 }
772 },
773 "Sk": {
774 "type": "structure",
775 "required": [
776 "Key",
777 "Value"
778 ],
779 "members": {
780 "Key": {},
781 "Value": {
782 "shape": "Sm"
783 }
784 }
785 },
786 "Sm": {
787 "type": "structure",
788 "members": {
789 "StringValue": {},
790 "StringListValue": {
791 "type": "list",
792 "member": {}
793 },
794 "LongValue": {
795 "type": "long"
796 },
797 "DateValue": {
798 "type": "timestamp"
799 }
800 }
801 },
802 "S14": {
803 "type": "structure",
804 "members": {
805 "S3Configuration": {
806 "type": "structure",
807 "required": [
808 "BucketName"
809 ],
810 "members": {
811 "BucketName": {},
812 "InclusionPrefixes": {
813 "shape": "S16"
814 },
815 "ExclusionPatterns": {
816 "shape": "S16"
817 },
818 "DocumentsMetadataConfiguration": {
819 "type": "structure",
820 "members": {
821 "S3Prefix": {}
822 }
823 },
824 "AccessControlListConfiguration": {
825 "type": "structure",
826 "members": {
827 "KeyPath": {}
828 }
829 }
830 }
831 },
832 "SharePointConfiguration": {
833 "type": "structure",
834 "required": [
835 "SharePointVersion",
836 "Urls",
837 "SecretArn"
838 ],
839 "members": {
840 "SharePointVersion": {},
841 "Urls": {
842 "type": "list",
843 "member": {}
844 },
845 "SecretArn": {},
846 "CrawlAttachments": {
847 "type": "boolean"
848 },
849 "UseChangeLog": {
850 "type": "boolean"
851 },
852 "InclusionPatterns": {
853 "shape": "S16"
854 },
855 "ExclusionPatterns": {
856 "shape": "S16"
857 },
858 "VpcConfiguration": {
859 "shape": "S1g"
860 },
861 "FieldMappings": {
862 "shape": "S1l"
863 },
864 "DocumentTitleFieldName": {}
865 }
866 },
867 "DatabaseConfiguration": {
868 "type": "structure",
869 "required": [
870 "DatabaseEngineType",
871 "ConnectionConfiguration",
872 "ColumnConfiguration"
873 ],
874 "members": {
875 "DatabaseEngineType": {},
876 "ConnectionConfiguration": {
877 "type": "structure",
878 "required": [
879 "DatabaseHost",
880 "DatabasePort",
881 "DatabaseName",
882 "TableName",
883 "SecretArn"
884 ],
885 "members": {
886 "DatabaseHost": {},
887 "DatabasePort": {
888 "type": "integer"
889 },
890 "DatabaseName": {},
891 "TableName": {},
892 "SecretArn": {}
893 }
894 },
895 "VpcConfiguration": {
896 "shape": "S1g"
897 },
898 "ColumnConfiguration": {
899 "type": "structure",
900 "required": [
901 "DocumentIdColumnName",
902 "DocumentDataColumnName",
903 "ChangeDetectingColumns"
904 ],
905 "members": {
906 "DocumentIdColumnName": {},
907 "DocumentDataColumnName": {},
908 "DocumentTitleColumnName": {},
909 "FieldMappings": {
910 "shape": "S1l"
911 },
912 "ChangeDetectingColumns": {
913 "type": "list",
914 "member": {}
915 }
916 }
917 },
918 "AclConfiguration": {
919 "type": "structure",
920 "required": [
921 "AllowedGroupsColumnName"
922 ],
923 "members": {
924 "AllowedGroupsColumnName": {}
925 }
926 }
927 }
928 }
929 }
930 },
931 "S16": {
932 "type": "list",
933 "member": {}
934 },
935 "S1g": {
936 "type": "structure",
937 "required": [
938 "SubnetIds",
939 "SecurityGroupIds"
940 ],
941 "members": {
942 "SubnetIds": {
943 "type": "list",
944 "member": {}
945 },
946 "SecurityGroupIds": {
947 "type": "list",
948 "member": {}
949 }
950 }
951 },
952 "S1l": {
953 "type": "list",
954 "member": {
955 "type": "structure",
956 "required": [
957 "DataSourceFieldName",
958 "IndexFieldName"
959 ],
960 "members": {
961 "DataSourceFieldName": {},
962 "DateFieldFormat": {},
963 "IndexFieldName": {}
964 }
965 }
966 },
967 "S2b": {
968 "type": "structure",
969 "members": {
970 "KmsKeyId": {
971 "type": "string",
972 "sensitive": true
973 }
974 }
975 },
976 "S2q": {
977 "type": "list",
978 "member": {
979 "type": "structure",
980 "required": [
981 "Name",
982 "Type"
983 ],
984 "members": {
985 "Name": {},
986 "Type": {},
987 "Relevance": {
988 "type": "structure",
989 "members": {
990 "Freshness": {
991 "type": "boolean"
992 },
993 "Importance": {
994 "type": "integer"
995 },
996 "Duration": {},
997 "RankOrder": {},
998 "ValueImportanceMap": {
999 "type": "map",
1000 "key": {},
1001 "value": {
1002 "type": "integer"
1003 }
1004 }
1005 }
1006 },
1007 "Search": {
1008 "type": "structure",
1009 "members": {
1010 "Facetable": {
1011 "type": "boolean"
1012 },
1013 "Searchable": {
1014 "type": "boolean"
1015 },
1016 "Displayable": {
1017 "type": "boolean"
1018 }
1019 }
1020 }
1021 }
1022 }
1023 },
1024 "S3w": {
1025 "type": "structure",
1026 "members": {
1027 "AndAllFilters": {
1028 "shape": "S3x"
1029 },
1030 "OrAllFilters": {
1031 "shape": "S3x"
1032 },
1033 "NotFilter": {
1034 "shape": "S3w"
1035 },
1036 "EqualsTo": {
1037 "shape": "Sk"
1038 },
1039 "ContainsAll": {
1040 "shape": "Sk"
1041 },
1042 "ContainsAny": {
1043 "shape": "Sk"
1044 },
1045 "GreaterThan": {
1046 "shape": "Sk"
1047 },
1048 "GreaterThanOrEquals": {
1049 "shape": "Sk"
1050 },
1051 "LessThan": {
1052 "shape": "Sk"
1053 },
1054 "LessThanOrEquals": {
1055 "shape": "Sk"
1056 }
1057 }
1058 },
1059 "S3x": {
1060 "type": "list",
1061 "member": {
1062 "shape": "S3w"
1063 }
1064 },
1065 "S4c": {
1066 "type": "structure",
1067 "members": {
1068 "Text": {},
1069 "Highlights": {
1070 "type": "list",
1071 "member": {
1072 "type": "structure",
1073 "required": [
1074 "BeginOffset",
1075 "EndOffset"
1076 ],
1077 "members": {
1078 "BeginOffset": {
1079 "type": "integer"
1080 },
1081 "EndOffset": {
1082 "type": "integer"
1083 },
1084 "TopAnswer": {
1085 "type": "boolean"
1086 }
1087 }
1088 }
1089 }
1090 }
1091 }
1092 }
1093}
\No newline at end of file