/
docs-2.json
3312 lines (3312 loc) · 234 KB
/
docs-2.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version": "2.0",
"service": "<p/>",
"operations": {
"BuildBotLocale": "<p>Builds a bot, its intents, and its slot types into a specific locale. A bot can be built into multiple locales. At runtime the locale is used to choose a specific build of the bot.</p>",
"CreateBot": "<p>Creates an Amazon Lex conversational bot. </p>",
"CreateBotAlias": "<p>Creates an alias for the specified version of a bot. Use an alias to enable you to change the version of a bot without updating applications that use the bot.</p> <p>For example, you can create an alias called \"PROD\" that your applications use to call the Amazon Lex bot. </p>",
"CreateBotLocale": "<p>Creates a locale in the bot. The locale contains the intents and slot types that the bot uses in conversations with users in the specified language and locale. You must add a locale to a bot before you can add intents and slot types to the bot.</p>",
"CreateBotVersion": "<p>Creates a new version of the bot based on the <code>DRAFT</code> version. If the <code>DRAFT</code> version of this resource hasn't changed since you created the last version, Amazon Lex doesn't create a new version, it returns the last created version.</p> <p>When you create the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1.</p>",
"CreateExport": "<p>Creates a zip archive containing the contents of a bot or a bot locale. The archive contains a directory structure that contains JSON files that define the bot.</p> <p>You can create an archive that contains the complete definition of a bot, or you can specify that the archive contain only the definition of a single bot locale.</p> <p>For more information about exporting bots, and about the structure of the export archive, see <a href=\"https://docs.aws.amazon.com/lexv2/latest/dg/importing-exporting.html\"> Importing and exporting bots </a> </p>",
"CreateIntent": "<p>Creates an intent.</p> <p>To define the interaction between the user and your bot, you define one or more intents. For example, for a pizza ordering bot you would create an <code>OrderPizza</code> intent.</p> <p>When you create an intent, you must provide a name. You can optionally provide the following:</p> <ul> <li> <p>Sample utterances. For example, \"I want to order a pizza\" and \"Can I order a pizza.\" You can't provide utterances for built-in intents.</p> </li> <li> <p>Information to be gathered. You specify slots for the information that you bot requests from the user. You can specify standard slot types, such as date and time, or custom slot types for your application.</p> </li> <li> <p>How the intent is fulfilled. You can provide a Lambda function or configure the intent to return the intent information to your client application. If you use a Lambda function, Amazon Lex invokes the function when all of the intent information is available.</p> </li> <li> <p>A confirmation prompt to send to the user to confirm an intent. For example, \"Shall I order your pizza?\"</p> </li> <li> <p>A conclusion statement to send to the user after the intent is fulfilled. For example, \"I ordered your pizza.\"</p> </li> <li> <p>A follow-up prompt that asks the user for additional activity. For example, \"Do you want a drink with your pizza?\"</p> </li> </ul>",
"CreateResourcePolicy": "<p>Creates a new resource policy with the specified policy statements.</p>",
"CreateResourcePolicyStatement": "<p>Adds a new resource policy statement to a bot or bot alias. If a resource policy exists, the statement is added to the current resource policy. If a policy doesn't exist, a new policy is created.</p> <p>You can't create a resource policy statement that allows cross-account access.</p>",
"CreateSlot": "<p>Creates a slot in an intent. A slot is a variable needed to fulfill an intent. For example, an <code>OrderPizza</code> intent might need slots for size, crust, and number of pizzas. For each slot, you define one or more utterances that Amazon Lex uses to elicit a response from the user. </p>",
"CreateSlotType": "<p>Creates a custom slot type</p> <p> To create a custom slot type, specify a name for the slot type and a set of enumeration values, the values that a slot of this type can assume. </p>",
"CreateUploadUrl": "<p>Gets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale. </p>",
"DeleteBot": "<p>Deletes all versions of a bot, including the <code>Draft</code> version. To delete a specific version, use the <code>DeleteBotVersion</code> operation.</p> <p>When you delete a bot, all of the resources contained in the bot are also deleted. Deleting a bot removes all locales, intents, slot, and slot types defined for the bot.</p> <p>If a bot has an alias, the <code>DeleteBot</code> operation returns a <code>ResourceInUseException</code> exception. If you want to delete the bot and the alias, set the <code>skipResourceInUseCheck</code> parameter to <code>true</code>.</p>",
"DeleteBotAlias": "<p>Deletes the specified bot alias.</p>",
"DeleteBotLocale": "<p>Removes a locale from a bot.</p> <p>When you delete a locale, all intents, slots, and slot types defined for the locale are also deleted.</p>",
"DeleteBotVersion": "<p>Deletes a specific version of a bot. To delete all version of a bot, use the <a href=\"https://docs.aws.amazon.com/lexv2/latest/dg/API_DeleteBot.html\">DeleteBot</a> operation.</p>",
"DeleteCustomVocabulary": "<p>Removes a custom vocabulary from the specified locale in the specified bot.</p>",
"DeleteExport": "<p>Removes a previous export and the associated files stored in an S3 bucket.</p>",
"DeleteImport": "<p>Removes a previous import and the associated file stored in an S3 bucket.</p>",
"DeleteIntent": "<p>Removes the specified intent.</p> <p>Deleting an intent also deletes the slots associated with the intent.</p>",
"DeleteResourcePolicy": "<p>Removes an existing policy from a bot or bot alias. If the resource doesn't have a policy attached, Amazon Lex returns an exception.</p>",
"DeleteResourcePolicyStatement": "<p>Deletes a policy statement from a resource policy. If you delete the last statement from a policy, the policy is deleted. If you specify a statement ID that doesn't exist in the policy, or if the bot or bot alias doesn't have a policy attached, Amazon Lex returns an exception.</p>",
"DeleteSlot": "<p>Deletes the specified slot from an intent.</p>",
"DeleteSlotType": "<p>Deletes a slot type from a bot locale.</p> <p>If a slot is using the slot type, Amazon Lex throws a <code>ResourceInUseException</code> exception. To avoid the exception, set the <code>skipResourceInUseCheck</code> parameter to <code>true</code>.</p>",
"DeleteUtterances": "<p>Deletes stored utterances.</p> <p>Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the <a href=\"https://docs.aws.amazon.com/lexv2/latest/dg/API_ListAggregatedUtterances.html\">ListAggregatedUtterances</a> operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input..</p> <p>Use the <code>DeleteUtterances</code> operation to manually delete utterances for a specific session. When you use the <code>DeleteUtterances</code> operation, utterances stored for improving your bot's ability to respond to user input are deleted immediately. Utterances stored for use with the <code>ListAggregatedUtterances</code> operation are deleted after 15 days.</p>",
"DescribeBot": "<p>Provides metadata information about a bot. </p>",
"DescribeBotAlias": "<p>Get information about a specific bot alias.</p>",
"DescribeBotLocale": "<p>Describes the settings that a bot has for a specific locale. </p>",
"DescribeBotRecommendation": "<p>Provides metadata information about a bot recommendation. This information will enable you to get a description on the request inputs, to download associated transcripts after processing is complete, and to download intents and slot-types generated by the bot recommendation.</p>",
"DescribeBotVersion": "<p>Provides metadata about a version of a bot.</p>",
"DescribeCustomVocabularyMetadata": "<p>Provides metadata information about a custom vocabulary.</p>",
"DescribeExport": "<p>Gets information about a specific export.</p>",
"DescribeImport": "<p>Gets information about a specific import.</p>",
"DescribeIntent": "<p>Returns metadata about an intent.</p>",
"DescribeResourcePolicy": "<p>Gets the resource policy and policy revision for a bot or bot alias.</p>",
"DescribeSlot": "<p>Gets metadata information about a slot.</p>",
"DescribeSlotType": "<p>Gets metadata information about a slot type.</p>",
"ListAggregatedUtterances": "<p>Provides a list of utterances that users have sent to the bot.</p> <p>Utterances are aggregated by the text of the utterance. For example, all instances where customers used the phrase \"I want to order pizza\" are aggregated into the same line in the response.</p> <p>You can see both detected utterances and missed utterances. A detected utterance is where the bot properly recognized the utterance and activated the associated intent. A missed utterance was not recognized by the bot and didn't activate an intent.</p> <p>Utterances can be aggregated for a bot alias or for a bot version, but not both at the same time.</p> <p>Utterances statistics are not generated under the following conditions:</p> <ul> <li> <p>The <code>childDirected</code> field was set to true when the bot was created.</p> </li> <li> <p>You are using slot obfuscation with one or more slots.</p> </li> <li> <p>You opted out of participating in improving Amazon Lex.</p> </li> </ul>",
"ListBotAliases": "<p>Gets a list of aliases for the specified bot.</p>",
"ListBotLocales": "<p>Gets a list of locales for the specified bot.</p>",
"ListBotRecommendations": "<p>Get a list of bot recommendations that meet the specified criteria.</p>",
"ListBotVersions": "<p>Gets information about all of the versions of a bot.</p> <p>The <code>ListBotVersions</code> operation returns a summary of each version of a bot. For example, if a bot has three numbered versions, the <code>ListBotVersions</code> operation returns for summaries, one for each numbered version and one for the <code>DRAFT</code> version.</p> <p>The <code>ListBotVersions</code> operation always returns at least one version, the <code>DRAFT</code> version.</p>",
"ListBots": "<p>Gets a list of available bots.</p>",
"ListBuiltInIntents": "<p>Gets a list of built-in intents provided by Amazon Lex that you can use in your bot. </p> <p>To use a built-in intent as a the base for your own intent, include the built-in intent signature in the <code>parentIntentSignature</code> parameter when you call the <code>CreateIntent</code> operation. For more information, see <a href=\"https://docs.aws.amazon.com/lexv2/latest/dg/API_CreateIntent.html\">CreateIntent</a>.</p>",
"ListBuiltInSlotTypes": "<p>Gets a list of built-in slot types that meet the specified criteria.</p>",
"ListExports": "<p>Lists the exports for a bot, bot locale, or custom vocabulary. Exports are kept in the list for 7 days.</p>",
"ListImports": "<p>Lists the imports for a bot, bot locale, or custom vocabulary. Imports are kept in the list for 7 days.</p>",
"ListIntents": "<p>Get a list of intents that meet the specified criteria.</p>",
"ListRecommendedIntents": "<p>Gets a list of recommended intents provided by the bot recommendation that you can use in your bot.</p>",
"ListSlotTypes": "<p>Gets a list of slot types that match the specified criteria.</p>",
"ListSlots": "<p>Gets a list of slots that match the specified criteria.</p>",
"ListTagsForResource": "<p>Gets a list of tags associated with a resource. Only bots, bot aliases, and bot channels can have tags associated with them.</p>",
"SearchAssociatedTranscripts": "<p>Search for associated transcripts that meet the specified criteria.</p>",
"StartBotRecommendation": "<p>Use this to provide your transcript data, and to start the bot recommendation process.</p>",
"StartImport": "<p>Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.</p>",
"TagResource": "<p>Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.</p>",
"UntagResource": "<p>Removes tags from a bot, bot alias, or bot channel.</p>",
"UpdateBot": "<p>Updates the configuration of an existing bot. </p>",
"UpdateBotAlias": "<p>Updates the configuration of an existing bot alias.</p>",
"UpdateBotLocale": "<p>Updates the settings that a bot has for a specific locale.</p>",
"UpdateBotRecommendation": "<p>Updates an existing bot recommendation request.</p>",
"UpdateExport": "<p>Updates the password used to protect an export zip archive.</p> <p>The password is not required. If you don't supply a password, Amazon Lex generates a zip file that is not protected by a password. This is the archive that is available at the pre-signed S3 URL provided by the <a href=\"https://docs.aws.amazon.com/lexv2/latest/dg/API_DescribeExport.html\">DescribeExport</a> operation.</p>",
"UpdateIntent": "<p>Updates the settings for an intent.</p>",
"UpdateResourcePolicy": "<p>Replaces the existing resource policy for a bot or bot alias with a new one. If the policy doesn't exist, Amazon Lex returns an exception.</p>",
"UpdateSlot": "<p>Updates the settings for a slot.</p>",
"UpdateSlotType": "<p>Updates the configuration of an existing slot type.</p>"
},
"shapes": {
"AdvancedRecognitionSetting": {
"base": "<p>Provides settings that enable advanced recognition settings for slot values.</p>",
"refs": {
"SlotValueSelectionSetting$advancedRecognitionSetting": "<p>Provides settings that enable advanced recognition settings for slot values.</p>"
}
},
"AggregatedUtterancesFilter": {
"base": "<p>Filters responses returned by the <code>ListAggregatedUtterances</code> operation.</p>",
"refs": {
"AggregatedUtterancesFilters$member": null
}
},
"AggregatedUtterancesFilterName": {
"base": null,
"refs": {
"AggregatedUtterancesFilter$name": "<p>The name of the field to filter the utterance list.</p>"
}
},
"AggregatedUtterancesFilterOperator": {
"base": null,
"refs": {
"AggregatedUtterancesFilter$operator": "<p>The operator to use for the filter. Specify <code>EQ</code> when the <code>ListAggregatedUtterances</code> operation should return only utterances that equal the specified value. Specify <code>CO</code> when the <code>ListAggregatedUtterances</code> operation should return utterances that contain the specified value.</p>"
}
},
"AggregatedUtterancesFilters": {
"base": null,
"refs": {
"ListAggregatedUtterancesRequest$filters": "<p>Provides the specification of a filter used to limit the utterances in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.</p>"
}
},
"AggregatedUtterancesSortAttribute": {
"base": null,
"refs": {
"AggregatedUtterancesSortBy$attribute": "<p>The utterance attribute to sort by.</p>"
}
},
"AggregatedUtterancesSortBy": {
"base": "<p>Specifies attributes for sorting a list of utterances.</p>",
"refs": {
"ListAggregatedUtterancesRequest$sortBy": "<p>Specifies sorting parameters for the list of utterances. You can sort by the hit count, the missed count, or the number of distinct sessions the utterance appeared in.</p>"
}
},
"AggregatedUtterancesSummary": {
"base": "<p>Provides summary information for aggregated utterances. The <code>ListAggregatedUtterances</code> operations combines all instances of the same utterance into a single aggregated summary.</p>",
"refs": {
"AggregatedUtterancesSummaryList$member": null
}
},
"AggregatedUtterancesSummaryList": {
"base": null,
"refs": {
"ListAggregatedUtterancesResponse$aggregatedUtterancesSummaries": "<p>Summaries of the aggregated utterance data. Each response contains information about the number of times that the utterance was seen during the time period, whether it was detected or missed, and when it was seen during the time period.</p>"
}
},
"AmazonResourceName": {
"base": null,
"refs": {
"CreateResourcePolicyRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.</p>",
"CreateResourcePolicyResponse$resourceArn": "<p>The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy was attached to.</p>",
"CreateResourcePolicyStatementRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.</p>",
"CreateResourcePolicyStatementResponse$resourceArn": "<p>The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.</p>",
"DeleteResourcePolicyRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the bot or bot alias that has the resource policy attached.</p>",
"DeleteResourcePolicyResponse$resourceArn": "<p>The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy was deleted from.</p>",
"DeleteResourcePolicyStatementRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.</p>",
"DeleteResourcePolicyStatementResponse$resourceArn": "<p>The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy statement was removed from.</p>",
"DescribeResourcePolicyRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.</p>",
"DescribeResourcePolicyResponse$resourceArn": "<p>The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.</p>",
"ListTagsForResourceRequest$resourceARN": "<p>The Amazon Resource Name (ARN) of the resource to get a list of tags for.</p>",
"TagResourceRequest$resourceARN": "<p>The Amazon Resource Name (ARN) of the bot, bot alias, or bot channel to tag.</p>",
"UntagResourceRequest$resourceARN": "<p>The Amazon Resource Name (ARN) of the resource to remove the tags from.</p>",
"UpdateResourcePolicyRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.</p>",
"UpdateResourcePolicyResponse$resourceArn": "<p>The Amazon Resource Name (ARN) of the bot or bot alias that the resource policy is attached to.</p>"
}
},
"AssociatedTranscript": {
"base": "<p>The object containing information that associates the recommended intent/slot type with a conversation.</p>",
"refs": {
"AssociatedTranscriptList$member": null
}
},
"AssociatedTranscriptFilter": {
"base": "<p>Filters to search for the associated transcript.</p>",
"refs": {
"AssociatedTranscriptFilters$member": null
}
},
"AssociatedTranscriptFilterName": {
"base": null,
"refs": {
"AssociatedTranscriptFilter$name": "<p>The name of the field to use for filtering. The allowed names are IntentId and SlotTypeId.</p>"
}
},
"AssociatedTranscriptFilters": {
"base": null,
"refs": {
"SearchAssociatedTranscriptsRequest$filters": "<p>A list of filter objects.</p>"
}
},
"AssociatedTranscriptList": {
"base": null,
"refs": {
"SearchAssociatedTranscriptsResponse$associatedTranscripts": "<p>The object that contains the associated transcript that meet the criteria you specified.</p>"
}
},
"AttachmentTitle": {
"base": null,
"refs": {
"ImageResponseCard$title": "<p>The title to display on the response card. The format of the title is determined by the platform displaying the response card.</p>",
"ImageResponseCard$subtitle": "<p>The subtitle to display on the response card. The format of the subtitle is determined by the platform displaying the response card.</p>"
}
},
"AttachmentUrl": {
"base": null,
"refs": {
"ImageResponseCard$imageUrl": "<p>The URL of an image to display on the response card. The image URL must be publicly available so that the platform displaying the response card has access to the image.</p>"
}
},
"AudioLogDestination": {
"base": "<p>The location of audio log files collected when conversation logging is enabled for a bot.</p>",
"refs": {
"AudioLogSetting$destination": null
}
},
"AudioLogSetting": {
"base": "<p>Settings for logging audio of conversations between Amazon Lex and a user. You specify whether to log audio and the Amazon S3 bucket where the audio file is stored.</p>",
"refs": {
"AudioLogSettingsList$member": null
}
},
"AudioLogSettingsList": {
"base": null,
"refs": {
"ConversationLogSettings$audioLogSettings": "<p>The Amazon S3 settings for logging audio to an S3 bucket.</p>"
}
},
"AudioRecognitionStrategy": {
"base": null,
"refs": {
"AdvancedRecognitionSetting$audioRecognitionStrategy": "<p>Enables using the slot values as a custom vocabulary for recognizing user utterances.</p>"
}
},
"Boolean": {
"base": null,
"refs": {
"AudioLogSetting$enabled": "<p>Determines whether audio logging in enabled for the bot.</p>",
"BotAliasLocaleSettings$enabled": "<p>Determines whether the locale is enabled for the bot. If the value is <code>false</code>, the locale isn't available for use.</p>",
"DialogCodeHookSettings$enabled": "<p>Enables the dialog code hook so that it processes user requests.</p>",
"FulfillmentCodeHookSettings$enabled": "<p>Indicates whether a Lambda function should be invoked to fulfill a specific intent.</p>",
"KendraConfiguration$queryFilterStringEnabled": "<p>Determines whether the AMAZON.KendraSearchIntent intent uses a custom query string to query the Amazon Kendra index.</p>",
"MultipleValuesSetting$allowMultipleValues": "<p>Indicates whether a slot can return multiple values. When <code>true</code>, the slot may return more than one value in a response. When <code>false</code>, the slot returns only a single value.</p> <p>Multi-value slots are only available in the en-US locale. If you set this value to <code>true</code> in any other locale, Amazon Lex throws a <code>ValidationException</code>.</p> <p>If the <code>allowMutlipleValues</code> is not set, the default value is <code>false</code>.</p>",
"SentimentAnalysisSettings$detectSentiment": "<p>Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances.</p>",
"TextLogSetting$enabled": "<p>Determines whether conversation logs should be stored for an alias.</p>"
}
},
"BotAliasHistoryEvent": {
"base": "<p>Provides a record of an event that affects a bot alias. For example, when the version of a bot that the alias points to changes.</p>",
"refs": {
"BotAliasHistoryEventsList$member": null
}
},
"BotAliasHistoryEventsList": {
"base": null,
"refs": {
"DescribeBotAliasResponse$botAliasHistoryEvents": "<p>A list of events that affect a bot alias. For example, an event is recorded when the version that the alias points to changes.</p>"
}
},
"BotAliasId": {
"base": null,
"refs": {
"BotAliasSummary$botAliasId": "<p>The unique identifier assigned to the bot alias. You can use this ID to get detailed information about the alias using the <a href=\"https://docs.aws.amazon.com/lexv2/latest/dg/API_DescribeBotAlias.html\">DescribeBotAlias</a> operation.</p>",
"CreateBotAliasResponse$botAliasId": "<p>The unique identifier of the bot alias.</p>",
"DeleteBotAliasRequest$botAliasId": "<p>The unique identifier of the bot alias to delete.</p>",
"DeleteBotAliasResponse$botAliasId": "<p>The unique identifier of the bot alias to delete.</p>",
"DescribeBotAliasRequest$botAliasId": "<p>The identifier of the bot alias to describe.</p>",
"DescribeBotAliasResponse$botAliasId": "<p>The identifier of the bot alias.</p>",
"ListAggregatedUtterancesRequest$botAliasId": "<p>The identifier of the bot alias associated with this request. If you specify the bot alias, you can't specify the bot version.</p>",
"ListAggregatedUtterancesResponse$botAliasId": "<p>The identifier of the bot alias that contains the utterances. If you specified the bot version, the bot alias ID isn't returned.</p>",
"UpdateBotAliasRequest$botAliasId": "<p>The unique identifier of the bot alias.</p>",
"UpdateBotAliasResponse$botAliasId": "<p>The identifier of the updated bot alias.</p>"
}
},
"BotAliasLocaleSettings": {
"base": "<p>Specifies settings that are unique to a locale. For example, you can use different Lambda function depending on the bot's locale.</p>",
"refs": {
"BotAliasLocaleSettingsMap$value": null
}
},
"BotAliasLocaleSettingsMap": {
"base": null,
"refs": {
"CreateBotAliasRequest$botAliasLocaleSettings": "<p>Maps configuration information to a specific locale. You can use this parameter to specify a specific Lambda function to run different functions in different locales.</p>",
"CreateBotAliasResponse$botAliasLocaleSettings": "<p>Configuration information for a specific locale.</p>",
"DescribeBotAliasResponse$botAliasLocaleSettings": "<p>The locale settings that are unique to the alias.</p>",
"UpdateBotAliasRequest$botAliasLocaleSettings": "<p>The new Lambda functions to use in each locale for the bot alias.</p>",
"UpdateBotAliasResponse$botAliasLocaleSettings": "<p>The updated Lambda functions to use in each locale for the bot alias.</p>"
}
},
"BotAliasStatus": {
"base": null,
"refs": {
"BotAliasSummary$botAliasStatus": "<p>The current state of the bot alias. If the status is <code>Available</code>, the alias is ready for use.</p>",
"CreateBotAliasResponse$botAliasStatus": "<p>The current status of the alias. The alias is first put into the <code>Creating</code> state. When the alias is ready to be used, it is put into the <code>Available</code> state. You can use the <code>DescribeBotAlias</code> operation to get the current state of an alias.</p>",
"DeleteBotAliasResponse$botAliasStatus": "<p>The current status of the alias. The status is <code>Deleting</code> while the alias is in the process of being deleted. Once the alias is deleted, it will no longer appear in the list of aliases returned by the <code>ListBotAliases</code> operation.</p>",
"DescribeBotAliasResponse$botAliasStatus": "<p>The current status of the alias. When the alias is <code>Available</code>, the alias is ready for use with your bot.</p>",
"UpdateBotAliasResponse$botAliasStatus": "<p>The current status of the bot alias. When the status is <code>Available</code> the alias is ready for use.</p>"
}
},
"BotAliasSummary": {
"base": "<p>Summary information about bot aliases returned from the <a href=\"https://docs.aws.amazon.com/lexv2/latest/dg/API_ListBotAliases.html\">ListBotAliases</a> operation.</p>",
"refs": {
"BotAliasSummaryList$member": null
}
},
"BotAliasSummaryList": {
"base": null,
"refs": {
"ListBotAliasesResponse$botAliasSummaries": "<p>Summary information for the bot aliases that meet the filter criteria specified in the request. The length of the list is specified in the <code>maxResults</code> parameter of the request. If there are more aliases available, the <code>nextToken</code> field contains a token to get the next page of results.</p>"
}
},
"BotExportSpecification": {
"base": "<p>Provides the identity of a the bot that was exported.</p>",
"refs": {
"ExportResourceSpecification$botExportSpecification": "<p>Parameters for exporting a bot.</p>"
}
},
"BotFilter": {
"base": "<p>Filters the responses returned by the <code>ListBots</code> operation.</p>",
"refs": {
"BotFilters$member": null
}
},
"BotFilterName": {
"base": null,
"refs": {
"BotFilter$name": "<p>The name of the field to filter the list of bots.</p>"
}
},
"BotFilterOperator": {
"base": null,
"refs": {
"BotFilter$operator": "<p>The operator to use for the filter. Specify <code>EQ</code> when the <code>ListBots</code> operation should return only aliases that equal the specified value. Specify <code>CO</code> when the <code>ListBots</code> operation should return aliases that contain the specified value.</p>"
}
},
"BotFilters": {
"base": null,
"refs": {
"ListBotsRequest$filters": "<p>Provides the specification of a filter used to limit the bots in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.</p>"
}
},
"BotImportSpecification": {
"base": "<p>Provides the bot parameters required for importing a bot.</p>",
"refs": {
"ImportResourceSpecification$botImportSpecification": "<p>Parameters for importing a bot.</p>"
}
},
"BotLocaleExportSpecification": {
"base": "<p>Provides the bot locale parameters required for exporting a bot locale.</p>",
"refs": {
"ExportResourceSpecification$botLocaleExportSpecification": "<p>Parameters for exporting a bot locale.</p>"
}
},
"BotLocaleFilter": {
"base": "<p>Filters responses returned by the <code>ListBotLocales</code> operation.</p>",
"refs": {
"BotLocaleFilters$member": null
}
},
"BotLocaleFilterName": {
"base": null,
"refs": {
"BotLocaleFilter$name": "<p>The name of the field to filter the list of bots.</p>"
}
},
"BotLocaleFilterOperator": {
"base": null,
"refs": {
"BotLocaleFilter$operator": "<p>The operator to use for the filter. Specify <code>EQ</code> when the <code>ListBotLocales</code> operation should return only aliases that equal the specified value. Specify <code>CO</code> when the <code>ListBotLocales</code> operation should return aliases that contain the specified value.</p>"
}
},
"BotLocaleFilters": {
"base": null,
"refs": {
"ListBotLocalesRequest$filters": "<p>Provides the specification for a filter used to limit the response to only those locales that match the filter specification. You can only specify one filter and one value to filter on.</p>"
}
},
"BotLocaleHistoryEvent": {
"base": "<p>Provides information about an event that occurred affecting the bot locale.</p>",
"refs": {
"BotLocaleHistoryEventsList$member": null
}
},
"BotLocaleHistoryEventDescription": {
"base": null,
"refs": {
"BotLocaleHistoryEvent$event": "<p>A description of the event that occurred.</p>"
}
},
"BotLocaleHistoryEventsList": {
"base": null,
"refs": {
"DescribeBotLocaleResponse$botLocaleHistoryEvents": "<p>History of changes, such as when a locale is used in an alias, that have taken place for the locale.</p>"
}
},
"BotLocaleImportSpecification": {
"base": "<p>Provides the bot locale parameters required for importing a bot locale.</p>",
"refs": {
"ImportResourceSpecification$botLocaleImportSpecification": "<p>Parameters for importing a bot locale.</p>"
}
},
"BotLocaleSortAttribute": {
"base": null,
"refs": {
"BotLocaleSortBy$attribute": "<p>The bot locale attribute to sort by.</p>"
}
},
"BotLocaleSortBy": {
"base": "<p>Specifies attributes for sorting a list of bot locales.</p>",
"refs": {
"ListBotLocalesRequest$sortBy": "<p>Specifies sorting parameters for the list of locales. You can sort by locale name in ascending or descending order.</p>"
}
},
"BotLocaleStatus": {
"base": null,
"refs": {
"BotLocaleSummary$botLocaleStatus": "<p>The current status of the bot locale. When the status is <code>Built</code> the locale is ready for use.</p>",
"BuildBotLocaleResponse$botLocaleStatus": "<p>The bot's build status. When the status is <code>ReadyExpressTesting</code> you can test the bot using the utterances defined for the intents and slot types. When the status is <code>Built</code>, the bot is ready for use and can be tested using any utterance.</p>",
"CreateBotLocaleResponse$botLocaleStatus": "<p>The status of the bot.</p> <p>When the status is <code>Creating</code> the bot locale is being configured. When the status is <code>Building</code> Amazon Lex is building the bot for testing and use.</p> <p>If the status of the bot is <code>ReadyExpressTesting</code>, you can test the bot using the exact utterances specified in the bots' intents. When the bot is ready for full testing or to run, the status is <code>Built</code>.</p> <p>If there was a problem with building the bot, the status is <code>Failed</code>. If the bot was saved but not built, the status is <code>NotBuilt</code>.</p>",
"DeleteBotLocaleResponse$botLocaleStatus": "<p>The status of deleting the bot locale. The locale first enters the <code>Deleting</code> status. Once the locale is deleted it no longer appears in the list of locales for the bot.</p>",
"DescribeBotLocaleResponse$botLocaleStatus": "<p>The status of the bot. If the status is <code>Failed</code>, the reasons for the failure are listed in the <code>failureReasons</code> field.</p>",
"UpdateBotLocaleResponse$botLocaleStatus": "<p>The current status of the locale. When the bot status is <code>Built</code> the locale is ready for use.</p>"
}
},
"BotLocaleSummary": {
"base": "<p>Summary information about bot locales returned by the <a href=\"https://docs.aws.amazon.com/lexv2/latest/dg/API_ListBotLocales.html\">ListBotLocales</a> operation.</p>",
"refs": {
"BotLocaleSummaryList$member": null
}
},
"BotLocaleSummaryList": {
"base": null,
"refs": {
"ListBotLocalesResponse$botLocaleSummaries": "<p>Summary information for the locales that meet the filter criteria specified in the request. The length of the list is specified in the <code>maxResults</code> parameter of the request. If there are more locales available, the <code>nextToken</code> field contains a token to get the next page of results.</p>"
}
},
"BotRecommendationResultStatistics": {
"base": "<p>A statistical summary of the bot recommendation results.</p>",
"refs": {
"BotRecommendationResults$statistics": "<p>The statistical summary of the bot recommendation results.</p>"
}
},
"BotRecommendationResults": {
"base": "<p>The object representing the URL of the bot definition, the URL of the associated transcript, and a statistical summary of the bot recommendation results.</p>",
"refs": {
"DescribeBotRecommendationResponse$botRecommendationResults": "<p>The object representing the URL of the bot definition, the URL of the associated transcript and a statistical summary of the bot recommendation results.</p>"
}
},
"BotRecommendationStatus": {
"base": null,
"refs": {
"BotRecommendationSummary$botRecommendationStatus": "<p>The status of the bot recommendation.</p> <p>If the status is Failed, then the reasons for the failure are listed in the failureReasons field. </p>",
"DescribeBotRecommendationResponse$botRecommendationStatus": "<p>The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field. </p>",
"StartBotRecommendationResponse$botRecommendationStatus": "<p>The status of the bot recommendation.</p> <p>If the status is Failed, then the reasons for the failure are listed in the failureReasons field. </p>",
"UpdateBotRecommendationResponse$botRecommendationStatus": "<p>The status of the bot recommendation.</p> <p>If the status is Failed, then the reasons for the failure are listed in the failureReasons field. </p>"
}
},
"BotRecommendationSummary": {
"base": "<p>A summary of the bot recommendation.</p>",
"refs": {
"BotRecommendationSummaryList$member": null
}
},
"BotRecommendationSummaryList": {
"base": null,
"refs": {
"ListBotRecommendationsResponse$botRecommendationSummaries": "<p>Summary information for the bot recommendations that meet the filter specified in this request. The length of the list is specified in the maxResults parameter of the request. If there are more bot recommendations available, the nextToken field contains a token to get the next page of results.</p>"
}
},
"BotSortAttribute": {
"base": null,
"refs": {
"BotSortBy$attribute": "<p>The attribute to use to sort the list of bots.</p>"
}
},
"BotSortBy": {
"base": "<p>Specifies attributes for sorting a list of bots.</p>",
"refs": {
"ListBotsRequest$sortBy": "<p>Specifies sorting parameters for the list of bots. You can specify that the list be sorted by bot name in ascending or descending order.</p>"
}
},
"BotStatus": {
"base": null,
"refs": {
"BotSummary$botStatus": "<p>The current status of the bot. When the status is <code>Available</code> the bot is ready for use.</p>",
"BotVersionSummary$botStatus": "<p>The status of the bot. When the status is available, the version of the bot is ready for use.</p>",
"CreateBotResponse$botStatus": "<p>Shows the current status of the bot. The bot is first in the <code>Creating</code> status. Once the bot is read for use, it changes to the <code>Available</code> status. After the bot is created, you can use the <code>Draft</code> version of the bot.</p>",
"CreateBotVersionResponse$botStatus": "<p>When you send a request to create or update a bot, Amazon Lex sets the status response element to <code>Creating</code>. After Amazon Lex builds the bot, it sets status to <code>Available</code>. If Amazon Lex can't build the bot, it sets status to <code>Failed</code>.</p>",
"DeleteBotResponse$botStatus": "<p>The current status of the bot. The status is <code>Deleting</code> while the bot and its associated resources are being deleted.</p>",
"DeleteBotVersionResponse$botStatus": "<p>The current status of the bot. </p>",
"DescribeBotResponse$botStatus": "<p>The current status of the bot. When the status is <code>Available</code> the bot is ready to be used in conversations with users.</p>",
"DescribeBotVersionResponse$botStatus": "<p>The current status of the bot. When the status is <code>Available</code>, the bot version is ready for use.</p>",
"UpdateBotResponse$botStatus": "<p>Shows the current status of the bot. The bot is first in the <code>Creating</code> status. Once the bot is read for use, it changes to the <code>Available</code> status. After the bot is created, you can use the <code>DRAFT</code> version of the bot.</p>"
}
},
"BotSummary": {
"base": "<p>Summary information about a bot returned by the <a href=\"https://docs.aws.amazon.com/lexv2/latest/dg/API_ListBots.html\">ListBots</a> operation.</p>",
"refs": {
"BotSummaryList$member": null
}
},
"BotSummaryList": {
"base": null,
"refs": {
"ListBotsResponse$botSummaries": "<p>Summary information for the bots that meet the filter criteria specified in the request. The length of the list is specified in the <code>maxResults</code> parameter of the request. If there are more bots available, the <code>nextToken</code> field contains a token to the next page of results.</p>"
}
},
"BotVersion": {
"base": null,
"refs": {
"BotAliasHistoryEvent$botVersion": "<p>The version of the bot that was used in the event. </p>",
"BotAliasSummary$botVersion": "<p>The version of the bot that the bot alias references.</p>",
"BotExportSpecification$botVersion": "<p>The version of the bot that was exported. This will be either <code>DRAFT</code> or the version number.</p>",
"BotLocaleExportSpecification$botVersion": "<p>The version of the bot to export.</p>",
"BotVersionLocaleDetails$sourceBotVersion": "<p>The version of a bot used for a bot locale.</p>",
"BotVersionSummary$botVersion": "<p>The numeric version of the bot, or <code>DRAFT</code> to indicate that this is the version of the bot that can be updated..</p>",
"CustomVocabularyExportSpecification$botVersion": "<p>The version of the bot that contains the custom vocabulary to export.</p>",
"DescribeBotAliasResponse$botVersion": "<p>The version of the bot associated with the bot alias.</p>",
"DescribeBotLocaleRequest$botVersion": "<p>The identifier of the version of the bot associated with the locale.</p>",
"DescribeBotLocaleResponse$botVersion": "<p>The identifier of the version of the bot associated with the locale.</p>",
"DescribeCustomVocabularyMetadataRequest$botVersion": "<p>The bot version of the bot to return metadata for.</p>",
"DescribeCustomVocabularyMetadataResponse$botVersion": "<p>The version of the bot that contains the custom vocabulary to describe.</p>",
"DescribeIntentRequest$botVersion": "<p>The version of the bot associated with the intent.</p>",
"DescribeSlotRequest$botVersion": "<p>The version of the bot associated with the slot.</p>",
"DescribeSlotResponse$botVersion": "<p>The version of the bot associated with the slot.</p>",
"DescribeSlotTypeRequest$botVersion": "<p>The version of the bot associated with the slot type.</p>",
"DescribeSlotTypeResponse$botVersion": "<p>The version of the bot associated with the slot type.</p>",
"ListAggregatedUtterancesRequest$botVersion": "<p>The identifier of the bot version associated with this request. If you specify the bot version, you can't specify the bot alias.</p>",
"ListAggregatedUtterancesResponse$botVersion": "<p>The identifier of the bot version that contains the utterances. If you specified the bot alias, the bot version isn't returned.</p>",
"ListBotLocalesRequest$botVersion": "<p>The version of the bot to list locales for.</p>",
"ListBotLocalesResponse$botVersion": "<p>The version of the bot.</p>",
"ListExportsRequest$botVersion": "<p>The version of the bot to list exports for. </p>",
"ListExportsResponse$botVersion": "<p>The version of the bot that was exported.</p>",
"ListIntentsRequest$botVersion": "<p>The version of the bot that contains the intent.</p>",
"ListIntentsResponse$botVersion": "<p>The version of the bot that contains the intent.</p>",
"ListSlotTypesRequest$botVersion": "<p>The version of the bot that contains the slot type.</p>",
"ListSlotTypesResponse$botVersion": "<p>The version of the bot that contains the slot types.</p>",
"ListSlotsRequest$botVersion": "<p>The version of the bot that contains the slot.</p>",
"ListSlotsResponse$botVersion": "<p>The version of the bot that contains the slots.</p>",
"SearchAssociatedTranscriptsRequest$botVersion": "<p>The version of the bot containing the transcripts that you are searching.</p>",
"SearchAssociatedTranscriptsResponse$botVersion": "<p>The version of the bot containing the transcripts that you are searching.</p>",
"UpdateBotAliasRequest$botVersion": "<p>The new bot version to assign to the bot alias.</p>",
"UpdateBotAliasResponse$botVersion": "<p>The updated version of the bot that the alias points to.</p>"
}
},
"BotVersionLocaleDetails": {
"base": "<p>The version of a bot used for a bot locale.</p>",
"refs": {
"BotVersionLocaleSpecification$value": null
}
},
"BotVersionLocaleSpecification": {
"base": null,
"refs": {
"CreateBotVersionRequest$botVersionLocaleSpecification": "<p>Specifies the locales that Amazon Lex adds to this version. You can choose the <code>Draft</code> version or any other previously published version for each locale. When you specify a source version, the locale data is copied from the source version to the new version.</p>",
"CreateBotVersionResponse$botVersionLocaleSpecification": "<p>The source versions used for each locale in the new version.</p>"
}
},
"BotVersionSortAttribute": {
"base": null,
"refs": {
"BotVersionSortBy$attribute": "<p>The attribute to use to sort the list of versions.</p>"
}
},
"BotVersionSortBy": {
"base": "<p>Specifies attributes for sorting a list of bot versions.</p>",
"refs": {
"ListBotVersionsRequest$sortBy": "<p>Specifies sorting parameters for the list of versions. You can specify that the list be sorted by version name in either ascending or descending order.</p>"
}
},
"BotVersionSummary": {
"base": "<p>Summary information about a bot version returned by the <a href=\"https://docs.aws.amazon.com/lexv2/latest/dg/API_ListBotVersions.html\">ListBotVersions</a> operation.</p>",
"refs": {
"BotVersionSummaryList$member": null
}
},
"BotVersionSummaryList": {
"base": null,
"refs": {
"ListBotVersionsResponse$botVersionSummaries": "<p>Summary information for the bot versions that meet the filter criteria specified in the request. The length of the list is specified in the <code>maxResults</code> parameter of the request. If there are more versions available, the <code>nextToken</code> field contains a token to get the next page of results.</p>"
}
},
"BoxedBoolean": {
"base": null,
"refs": {
"AggregatedUtterancesSummary$containsDataFromDeletedResources": "<p>Aggregated utterance data may contain utterances from versions of your bot that have since been deleted. When the aggregated contains this kind of data, this field is set to true.</p>",
"FulfillmentStartResponseSpecification$allowInterrupt": "<p>Determines whether the user can interrupt the start message while it is playing.</p>",
"FulfillmentUpdateResponseSpecification$allowInterrupt": "<p>Determines whether the user can interrupt an update message while it is playing.</p>",
"FulfillmentUpdatesSpecification$active": "<p>Determines whether fulfillment updates are sent to the user. When this field is true, updates are sent.</p> <p>If the <code>active</code> field is set to true, the <code>startResponse</code>, <code>updateResponse</code>, and <code>timeoutInSeconds</code> fields are required.</p>",
"IntentClosingSetting$active": "<p>Specifies whether an intent's closing response is used. When this field is false, the closing response isn't sent to the user. If the <code>active</code> field isn't specified, the default is true.</p>",
"IntentConfirmationSetting$active": "<p>Specifies whether the intent's confirmation is sent to the user. When this field is false, confirmation and declination responses aren't sent. If the <code>active</code> field isn't specified, the default is true.</p>",
"PromptSpecification$allowInterrupt": "<p>Indicates whether the user can interrupt a speech prompt from the bot.</p>",
"ResponseSpecification$allowInterrupt": "<p>Indicates whether the user can interrupt a speech response from Amazon Lex.</p>",
"StillWaitingResponseSpecification$allowInterrupt": "<p>Indicates that the user can interrupt the response by speaking while the message is being played.</p>",
"WaitAndContinueSpecification$active": "<p>Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used. If the <code>active</code> field isn't specified, the default is true.</p>"
}
},
"BuildBotLocaleRequest": {
"base": null,
"refs": {
}
},
"BuildBotLocaleResponse": {
"base": null,
"refs": {
}
},
"BuiltInIntentSortAttribute": {
"base": null,
"refs": {
"BuiltInIntentSortBy$attribute": "<p>The attribute to use to sort the list of built-in intents.</p>"
}
},
"BuiltInIntentSortBy": {
"base": "<p>Specifies attributes for sorting a list of built-in intents.</p>",
"refs": {
"ListBuiltInIntentsRequest$sortBy": "<p>Specifies sorting parameters for the list of built-in intents. You can specify that the list be sorted by the built-in intent signature in either ascending or descending order.</p>"
}
},
"BuiltInIntentSummary": {
"base": "<p>Provides summary information about a built-in intent for the <a href=\"https://docs.aws.amazon.com/lexv2/latest/dg/API_ListBuiltInIntents.html\"> ListBuiltInIntents </a> operation.</p>",
"refs": {
"BuiltInIntentSummaryList$member": null
}
},
"BuiltInIntentSummaryList": {
"base": null,
"refs": {
"ListBuiltInIntentsResponse$builtInIntentSummaries": "<p>Summary information for the built-in intents that meet the filter criteria specified in the request. The length of the list is specified in the <code>maxResults</code> parameter of the request. If there are more intents available, the <code>nextToken</code> field contains a token to get the next page of results.</p>"
}
},
"BuiltInOrCustomSlotTypeId": {
"base": null,
"refs": {
"CreateSlotRequest$slotTypeId": "<p>The unique identifier for the slot type associated with this slot. The slot type determines the values that can be entered into the slot.</p>",
"CreateSlotResponse$slotTypeId": "<p>The unique identifier of the slot type associated with this slot.</p>",
"DescribeSlotResponse$slotTypeId": "<p>The identifier of the slot type that determines the values entered into the slot.</p>",
"SlotSummary$slotTypeId": "<p>The unique identifier for the slot type that defines the values for the slot.</p>",
"UpdateSlotRequest$slotTypeId": "<p>The unique identifier of the new slot type to associate with this slot. </p>",
"UpdateSlotResponse$slotTypeId": "<p>The updated identifier of the slot type that provides values for the slot.</p>"
}
},
"BuiltInSlotTypeSortAttribute": {
"base": null,
"refs": {
"BuiltInSlotTypeSortBy$attribute": "<p>The attribute to use to sort the list of built-in intents.</p>"
}
},
"BuiltInSlotTypeSortBy": {
"base": "<p>Specifies attributes for sorting a list of built-in slot types.</p>",
"refs": {
"ListBuiltInSlotTypesRequest$sortBy": "<p>Determines the sort order for the response from the <code>ListBuiltInSlotTypes</code> operation. You can choose to sort by the slot type signature in either ascending or descending order.</p>"
}
},
"BuiltInSlotTypeSummary": {
"base": "<p>Provides summary information about a built-in slot type for the <a href=\"https://docs.aws.amazon.com/lexv2/latest/dg/API_ListBuiltInSlotTypes.html\"> ListBuiltInSlotTypes </a> operation.</p>",
"refs": {
"BuiltInSlotTypeSummaryList$member": null
}
},
"BuiltInSlotTypeSummaryList": {
"base": null,
"refs": {
"ListBuiltInSlotTypesResponse$builtInSlotTypeSummaries": "<p>Summary information for the built-in slot types that meet the filter criteria specified in the request. The length of the list is specified in the <code>maxResults</code> parameter of the request. If there are more slot types available, the <code>nextToken</code> field contains a token to get the next page of results.</p>"
}
},
"BuiltInsMaxResults": {
"base": null,
"refs": {
"ListBuiltInIntentsRequest$maxResults": "<p>The maximum number of built-in intents to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.</p>",
"ListBuiltInSlotTypesRequest$maxResults": "<p>The maximum number of built-in slot types to return in each page of results. If there are fewer results than the max page size, only the actual number of results are returned.</p>"
}
},
"Button": {
"base": "<p>Describes a button to use on a response card used to gather slot values from a user.</p>",
"refs": {
"ButtonsList$member": null
}
},
"ButtonText": {
"base": null,
"refs": {
"Button$text": "<p>The text that appears on the button. Use this to tell the user what value is returned when they choose this button.</p>"
}
},
"ButtonValue": {
"base": null,
"refs": {
"Button$value": "<p>The value returned to Amazon Lex when the user chooses this button. This must be one of the slot values configured for the slot.</p>"
}
},
"ButtonsList": {
"base": null,
"refs": {
"ImageResponseCard$buttons": "<p>A list of buttons that should be displayed on the response card. The arrangement of the buttons is determined by the platform that displays the button.</p>"
}
},
"ChildDirected": {
"base": null,
"refs": {
"DataPrivacy$childDirected": "<p>For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying <code>true</code> or <code>false</code> in the <code>childDirected</code> field. By specifying <code>true</code> in the <code>childDirected</code> field, you confirm that your use of Amazon Lex <b>is</b> related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying <code>false</code> in the <code>childDirected</code> field, you confirm that your use of Amazon Lex <b>is not</b> related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the <code>childDirected</code> field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the <a href=\"https://aws.amazon.com/lex/faqs#data-security\">Amazon Lex FAQ</a>.</p>"
}
},
"CloudWatchLogGroupArn": {
"base": null,
"refs": {
"CloudWatchLogGroupLogDestination$cloudWatchLogGroupArn": "<p>The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.</p>"
}
},
"CloudWatchLogGroupLogDestination": {
"base": "<p>The Amazon CloudWatch Logs log group where the text and metadata logs are delivered. The log group must exist before you enable logging.</p>",
"refs": {
"TextLogDestination$cloudWatch": "<p>Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered.</p>"
}
},
"CodeHookInterfaceVersion": {
"base": null,
"refs": {
"LambdaCodeHook$codeHookInterfaceVersion": "<p>The version of the request-response that you want Amazon Lex to use to invoke your Lambda function.</p>"
}
},
"CodeHookSpecification": {
"base": "<p>Contains information about code hooks that Amazon Lex calls during a conversation.</p>",
"refs": {
"BotAliasLocaleSettings$codeHookSpecification": "<p>Specifies the Lambda function that should be used in the locale.</p>"
}
},
"ConditionKey": {
"base": null,
"refs": {
"ConditionKeyValueMap$key": null
}
},
"ConditionKeyValueMap": {
"base": null,
"refs": {
"ConditionMap$value": null
}
},
"ConditionMap": {
"base": null,
"refs": {
"CreateResourcePolicyStatementRequest$condition": "<p>Specifies a condition when the policy is in effect. If the principal of the policy is a service principal, you must provide two condition blocks, one with a SourceAccount global condition key and one with a SourceArn global condition key.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition.html\">IAM JSON policy elements: Condition </a>.</p>"
}
},
"ConditionOperator": {
"base": null,
"refs": {
"ConditionMap$key": null
}
},
"ConditionValue": {
"base": null,
"refs": {
"ConditionKeyValueMap$value": null
}
},
"ConfidenceThreshold": {
"base": null,
"refs": {
"BotLocaleImportSpecification$nluIntentConfidenceThreshold": "<p>Determines the threshold where Amazon Lex will insert the <code>AMAZON.FallbackIntent</code>, <code>AMAZON.KendraSearchIntent</code>, or both when returning alternative intents. <code>AMAZON.FallbackIntent</code> and <code>AMAZON.KendraSearchIntent</code> are only inserted if they are configured for the bot. </p> <p>For example, suppose a bot is configured with the confidence threshold of 0.80 and the <code>AMAZON.FallbackIntent</code>. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the <code>PostText</code> operation would be:</p> <ul> <li> <p> <code>AMAZON.FallbackIntent</code> </p> </li> <li> <p> <code>IntentA</code> </p> </li> <li> <p> <code>IntentB</code> </p> </li> <li> <p> <code>IntentC</code> </p> </li> </ul>",
"CreateBotLocaleRequest$nluIntentConfidenceThreshold": "<p>Determines the threshold where Amazon Lex will insert the <code>AMAZON.FallbackIntent</code>, <code>AMAZON.KendraSearchIntent</code>, or both when returning alternative intents. <code>AMAZON.FallbackIntent</code> and <code>AMAZON.KendraSearchIntent</code> are only inserted if they are configured for the bot.</p> <p>For example, suppose a bot is configured with the confidence threshold of 0.80 and the <code>AMAZON.FallbackIntent</code>. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the <code>RecognizeText</code> operation would be:</p> <ul> <li> <p>AMAZON.FallbackIntent</p> </li> <li> <p>IntentA</p> </li> <li> <p>IntentB</p> </li> <li> <p>IntentC</p> </li> </ul>",
"CreateBotLocaleResponse$nluIntentConfidenceThreshold": "<p>The specified confidence threshold for inserting the <code>AMAZON.FallbackIntent</code> and <code>AMAZON.KendraSearchIntent</code> intents.</p>",
"DescribeBotLocaleResponse$nluIntentConfidenceThreshold": "<p>The confidence threshold where Amazon Lex inserts the <code>AMAZON.FallbackIntent</code> and <code>AMAZON.KendraSearchIntent</code> intents in the list of possible intents for an utterance.</p>",
"UpdateBotLocaleRequest$nluIntentConfidenceThreshold": "<p>The new confidence threshold where Amazon Lex inserts the <code>AMAZON.FallbackIntent</code> and <code>AMAZON.KendraSearchIntent</code> intents in the list of possible intents for an utterance.</p>",
"UpdateBotLocaleResponse$nluIntentConfidenceThreshold": "<p>The updated confidence threshold for inserting the <code>AMAZON.FallbackIntent</code> and <code>AMAZON.KendraSearchIntent</code> intents in the list of possible intents for an utterance.</p>"
}
},
"ConflictException": {
"base": "<p>The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again. </p>",
"refs": {
}
},
"ContextTimeToLiveInSeconds": {
"base": null,
"refs": {
"OutputContext$timeToLiveInSeconds": "<p>The amount of time, in seconds, that the output context should remain active. The time is figured from the first time the context is sent to the user.</p>"
}
},
"ContextTurnsToLive": {
"base": null,
"refs": {
"OutputContext$turnsToLive": "<p>The number of conversation turns that the output context should remain active. The number of turns is counted from the first time that the context is sent to the user.</p>"
}
},
"ConversationLogSettings": {
"base": "<p>Configures conversation logging that saves audio, text, and metadata for the conversations with your users.</p>",
"refs": {
"CreateBotAliasRequest$conversationLogSettings": "<p>Specifies whether Amazon Lex logs text and audio for a conversation with the bot. When you enable conversation logs, text logs store text input, transcripts of audio input, and associated metadata in Amazon CloudWatch Logs. Audio logs store audio input in Amazon S3.</p>",
"CreateBotAliasResponse$conversationLogSettings": "<p>The conversation log settings specified for the alias.</p>",
"DescribeBotAliasResponse$conversationLogSettings": "<p>Specifics of how Amazon Lex logs text and audio conversations with the bot associated with the alias.</p>",
"UpdateBotAliasRequest$conversationLogSettings": "<p>The new settings for storing conversation logs in Amazon CloudWatch Logs and Amazon S3 buckets.</p>",
"UpdateBotAliasResponse$conversationLogSettings": "<p>The updated settings for storing conversation logs in Amazon CloudWatch Logs and Amazon S3 buckets.</p>"
}
},
"Count": {
"base": null,
"refs": {
"IntentStatistics$discoveredIntentCount": "<p>The number of recommended intents associated with the bot recommendation.</p>",
"SlotTypeStatistics$discoveredSlotTypeCount": "<p>The number of recommended slot types associated with the bot recommendation.</p>"
}
},
"CreateBotAliasRequest": {
"base": null,
"refs": {
}
},
"CreateBotAliasResponse": {
"base": null,
"refs": {
}
},
"CreateBotLocaleRequest": {
"base": null,
"refs": {
}
},
"CreateBotLocaleResponse": {
"base": null,
"refs": {
}
},
"CreateBotRequest": {
"base": null,
"refs": {
}
},
"CreateBotResponse": {
"base": null,
"refs": {
}
},
"CreateBotVersionRequest": {
"base": null,
"refs": {
}
},
"CreateBotVersionResponse": {
"base": null,
"refs": {
}
},
"CreateExportRequest": {
"base": null,
"refs": {
}
},
"CreateExportResponse": {
"base": null,
"refs": {
}
},
"CreateIntentRequest": {
"base": null,
"refs": {
}
},
"CreateIntentResponse": {
"base": null,
"refs": {
}
},
"CreateResourcePolicyRequest": {
"base": null,
"refs": {
}
},
"CreateResourcePolicyResponse": {
"base": null,
"refs": {
}
},
"CreateResourcePolicyStatementRequest": {
"base": null,
"refs": {
}
},
"CreateResourcePolicyStatementResponse": {
"base": null,
"refs": {
}
},
"CreateSlotRequest": {
"base": null,
"refs": {
}
},
"CreateSlotResponse": {
"base": null,
"refs": {
}
},
"CreateSlotTypeRequest": {
"base": null,
"refs": {
}
},
"CreateSlotTypeResponse": {
"base": null,
"refs": {
}
},
"CreateUploadUrlRequest": {
"base": null,
"refs": {
}
},
"CreateUploadUrlResponse": {
"base": null,
"refs": {
}
},
"CustomPayload": {
"base": "<p>A custom response string that Amazon Lex sends to your application. You define the content and structure the string.</p>",
"refs": {
"Message$customPayload": "<p>A message in a custom format defined by the client application.</p>"
}
},
"CustomPayloadValue": {
"base": null,
"refs": {
"CustomPayload$value": "<p>The string that is sent to your application.</p>"
}
},
"CustomVocabularyExportSpecification": {
"base": "<p>Provides the parameters required for exporting a custom vocabulary.</p>",
"refs": {
"ExportResourceSpecification$customVocabularyExportSpecification": "<p>The parameters required to export a custom vocabulary.</p>"
}
},
"CustomVocabularyImportSpecification": {
"base": "<p>Provides the parameters required for importing a custom vocabulary.</p>",
"refs": {
"ImportResourceSpecification$customVocabularyImportSpecification": null
}
},
"CustomVocabularyStatus": {
"base": null,
"refs": {
"DeleteCustomVocabularyResponse$customVocabularyStatus": "<p>The status of removing the custom vocabulary.</p>",
"DescribeCustomVocabularyMetadataResponse$customVocabularyStatus": "<p>The status of the custom vocabulary. If the status is <code>Ready</code> the custom vocabulary is ready to use.</p>"
}
},
"DataPrivacy": {
"base": "<p>By default, data stored by Amazon Lex is encrypted. The <code>DataPrivacy</code> structure provides settings that determine how Amazon Lex handles special cases of securing the data for your bot. </p>",
"refs": {
"BotImportSpecification$dataPrivacy": null,
"CreateBotRequest$dataPrivacy": "<p>Provides information on additional privacy protections Amazon Lex should use with the bot's data.</p>",
"CreateBotResponse$dataPrivacy": "<p>The data privacy settings specified for the bot.</p>",
"DescribeBotResponse$dataPrivacy": "<p>Settings for managing data privacy of the bot and its conversations with users.</p>",
"DescribeBotVersionResponse$dataPrivacy": "<p>Data privacy settings for the bot version.</p>",
"UpdateBotRequest$dataPrivacy": "<p>Provides information on additional privacy protections Amazon Lex should use with the bot's data.</p>",
"UpdateBotResponse$dataPrivacy": "<p>The data privacy settings for the bot after the update.</p>"
}
},
"DateRangeFilter": {
"base": "<p>The object used for specifying the data range that the customer wants Amazon Lex to read through in the input transcripts.</p>",
"refs": {
"LexTranscriptFilter$dateRangeFilter": "<p>The object that contains a date range filter that will be applied to the transcript. Specify this object if you want Amazon Lex to only read the files that are within the date range.</p>"
}
},
"DeleteBotAliasRequest": {
"base": null,
"refs": {
}
},
"DeleteBotAliasResponse": {
"base": null,
"refs": {
}
},
"DeleteBotLocaleRequest": {
"base": null,
"refs": {
}
},
"DeleteBotLocaleResponse": {
"base": null,
"refs": {
}
},
"DeleteBotRequest": {
"base": null,
"refs": {
}
},
"DeleteBotResponse": {
"base": null,
"refs": {
}
},
"DeleteBotVersionRequest": {
"base": null,
"refs": {
}
},
"DeleteBotVersionResponse": {
"base": null,
"refs": {
}
},
"DeleteCustomVocabularyRequest": {
"base": null,
"refs": {
}
},
"DeleteCustomVocabularyResponse": {
"base": null,
"refs": {
}
},
"DeleteExportRequest": {
"base": null,
"refs": {
}
},
"DeleteExportResponse": {
"base": null,
"refs": {
}