@aws-sdk/client-lex-models-v2 3.379.1 → 3.385.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -6,6 +6,7 @@ import { LexModelsV2ServiceException as __BaseException } from "./LexModelsV2Ser
6
6
  */
7
7
  export interface ActiveContext {
8
8
  /**
9
+ * @public
9
10
  * <p>The name of active context.</p>
10
11
  */
11
12
  name: string | undefined;
@@ -27,6 +28,7 @@ export type AudioRecognitionStrategy = (typeof AudioRecognitionStrategy)[keyof t
27
28
  */
28
29
  export interface AdvancedRecognitionSetting {
29
30
  /**
31
+ * @public
30
32
  * <p>Enables using the slot values as a custom vocabulary for recognizing user utterances.</p>
31
33
  */
32
34
  audioRecognitionStrategy?: AudioRecognitionStrategy | string;
@@ -37,10 +39,12 @@ export interface AdvancedRecognitionSetting {
37
39
  */
38
40
  export interface ExecutionErrorDetails {
39
41
  /**
42
+ * @public
40
43
  * <p>The error code for the error.</p>
41
44
  */
42
45
  errorCode: string | undefined;
43
46
  /**
47
+ * @public
44
48
  * <p>The message describing the error.</p>
45
49
  */
46
50
  errorMessage: string | undefined;
@@ -51,22 +55,27 @@ export interface ExecutionErrorDetails {
51
55
  */
52
56
  export interface AgentTurnResult {
53
57
  /**
58
+ * @public
54
59
  * <p>The expected agent prompt for the agent turn in a test set execution.</p>
55
60
  */
56
61
  expectedAgentPrompt: string | undefined;
57
62
  /**
63
+ * @public
58
64
  * <p>The actual agent prompt for the agent turn in a test set execution.</p>
59
65
  */
60
66
  actualAgentPrompt?: string;
61
67
  /**
68
+ * @public
62
69
  * <p>Details about an error in an execution of a test set.</p>
63
70
  */
64
71
  errorDetails?: ExecutionErrorDetails;
65
72
  /**
73
+ * @public
66
74
  * <p>The actual elicited slot for the agent turn in a test set execution.</p>
67
75
  */
68
76
  actualElicitedSlot?: string;
69
77
  /**
78
+ * @public
70
79
  * <p>The actual intent for the agent turn in a test set execution.</p>
71
80
  */
72
81
  actualIntent?: string;
@@ -77,6 +86,7 @@ export interface AgentTurnResult {
77
86
  */
78
87
  export interface AgentTurnSpecification {
79
88
  /**
89
+ * @public
80
90
  * <p>The agent prompt for the agent turn in a test set.</p>
81
91
  */
82
92
  agentPrompt: string | undefined;
@@ -111,14 +121,17 @@ export type AggregatedUtterancesFilterOperator = (typeof AggregatedUtterancesFil
111
121
  */
112
122
  export interface AggregatedUtterancesFilter {
113
123
  /**
124
+ * @public
114
125
  * <p>The name of the field to filter the utterance list.</p>
115
126
  */
116
127
  name: AggregatedUtterancesFilterName | string | undefined;
117
128
  /**
129
+ * @public
118
130
  * <p>The value to use for filtering the list of bots.</p>
119
131
  */
120
132
  values: string[] | undefined;
121
133
  /**
134
+ * @public
122
135
  * <p>The operator to use for the filter. Specify <code>EQ</code> when the
123
136
  * <code>ListAggregatedUtterances</code> operation should return only
124
137
  * utterances that equal the specified value. Specify <code>CO</code> when
@@ -157,10 +170,12 @@ export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
157
170
  */
158
171
  export interface AggregatedUtterancesSortBy {
159
172
  /**
173
+ * @public
160
174
  * <p>The utterance attribute to sort by.</p>
161
175
  */
162
176
  attribute: AggregatedUtterancesSortAttribute | string | undefined;
163
177
  /**
178
+ * @public
164
179
  * <p>Specifies whether to sort the aggregated utterances in ascending or
165
180
  * descending order.</p>
166
181
  */
@@ -175,23 +190,27 @@ export interface AggregatedUtterancesSortBy {
175
190
  */
176
191
  export interface AggregatedUtterancesSummary {
177
192
  /**
193
+ * @public
178
194
  * <p>The text of the utterance. If the utterance was used with the
179
195
  * <code>RecognizeUtterance</code> operation, the text is the
180
196
  * transcription of the audio utterance.</p>
181
197
  */
182
198
  utterance?: string;
183
199
  /**
200
+ * @public
184
201
  * <p>The number of times that the utterance was detected by Amazon Lex during
185
202
  * the time period. When an utterance is detected, it activates an intent
186
203
  * or a slot.</p>
187
204
  */
188
205
  hitCount?: number;
189
206
  /**
207
+ * @public
190
208
  * <p>The number of times that the utterance was missed by Amazon Lex An
191
209
  * utterance is missed when it doesn't activate an intent or slot.</p>
192
210
  */
193
211
  missedCount?: number;
194
212
  /**
213
+ * @public
195
214
  * <p>The date and time that the utterance was first recorded in the time
196
215
  * window for aggregation. An utterance may have been sent to Amazon Lex before
197
216
  * that time, but only utterances within the time window are
@@ -199,12 +218,14 @@ export interface AggregatedUtterancesSummary {
199
218
  */
200
219
  utteranceFirstRecordedInAggregationDuration?: Date;
201
220
  /**
221
+ * @public
202
222
  * <p>The last date and time that an utterance was recorded in the time
203
223
  * window for aggregation. An utterance may be sent to Amazon Lex after that
204
224
  * time, but only utterances within the time window are counted.</p>
205
225
  */
206
226
  utteranceLastRecordedInAggregationDuration?: Date;
207
227
  /**
228
+ * @public
208
229
  * <p>Aggregated utterance data may contain utterances from versions of
209
230
  * your bot that have since been deleted. When the aggregated contains
210
231
  * this kind of data, this field is set to true.</p>
@@ -217,10 +238,12 @@ export interface AggregatedUtterancesSummary {
217
238
  */
218
239
  export interface AllowedInputTypes {
219
240
  /**
241
+ * @public
220
242
  * <p>Indicates whether audio input is allowed.</p>
221
243
  */
222
244
  allowAudioInput: boolean | undefined;
223
245
  /**
246
+ * @public
224
247
  * <p>Indicates whether DTMF input is allowed.</p>
225
248
  */
226
249
  allowDTMFInput: boolean | undefined;
@@ -267,14 +290,17 @@ export type AnalyticsSortOrder = (typeof AnalyticsSortOrder)[keyof typeof Analyt
267
290
  */
268
291
  export interface AnalyticsBinBySpecification {
269
292
  /**
293
+ * @public
270
294
  * <p>Specifies the time metric by which to bin the analytics data.</p>
271
295
  */
272
296
  name: AnalyticsBinByName | string | undefined;
273
297
  /**
298
+ * @public
274
299
  * <p>Specifies the interval of time by which to bin the analytics data.</p>
275
300
  */
276
301
  interval: AnalyticsInterval | string | undefined;
277
302
  /**
303
+ * @public
278
304
  * <p>Specifies whether to bin the analytics data in ascending or descending order. If this field is left blank, the default order is by the key of the bin in descending order.</p>
279
305
  */
280
306
  order?: AnalyticsSortOrder | string;
@@ -285,10 +311,12 @@ export interface AnalyticsBinBySpecification {
285
311
  */
286
312
  export interface AnalyticsBinKey {
287
313
  /**
314
+ * @public
288
315
  * <p>The criterion by which to bin the results.</p>
289
316
  */
290
317
  name?: AnalyticsBinByName | string;
291
318
  /**
319
+ * @public
292
320
  * <p>The value of the criterion that defines the bin.</p>
293
321
  */
294
322
  value?: number;
@@ -410,6 +438,7 @@ export type AnalyticsIntentFilterName = (typeof AnalyticsIntentFilterName)[keyof
410
438
  */
411
439
  export interface AnalyticsIntentFilter {
412
440
  /**
441
+ * @public
413
442
  * <p>The category by which to filter the intents. The descriptions for each option are as follows:</p>
414
443
  * <ul>
415
444
  * <li>
@@ -452,6 +481,7 @@ export interface AnalyticsIntentFilter {
452
481
  */
453
482
  name: AnalyticsIntentFilterName | string | undefined;
454
483
  /**
484
+ * @public
455
485
  * <p>The operation by which to filter the category. The following operations are possible:</p>
456
486
  * <ul>
457
487
  * <li>
@@ -513,6 +543,7 @@ export interface AnalyticsIntentFilter {
513
543
  */
514
544
  operator: AnalyticsFilterOperator | string | undefined;
515
545
  /**
546
+ * @public
516
547
  * <p>An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is <code>EQ</code> or <code>CO</code>. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the <code>name</code>, <code>operator</code>, and <code>values</code> fields are <code>Modality</code>, <code>EQ</code>, and <code>[Speech, Text]</code>, the operation filters for results where the modality was either <code>Speech</code> or <code>Text</code>.</p>
517
548
  */
518
549
  values: string[] | undefined;
@@ -523,10 +554,12 @@ export interface AnalyticsIntentFilter {
523
554
  */
524
555
  export interface AnalyticsIntentGroupByKey {
525
556
  /**
557
+ * @public
526
558
  * <p>A category by which the intent analytics were grouped.</p>
527
559
  */
528
560
  name?: AnalyticsIntentField | string;
529
561
  /**
562
+ * @public
530
563
  * <p>A member of the category by which the intent analytics were grouped.</p>
531
564
  */
532
565
  value?: string;
@@ -537,6 +570,7 @@ export interface AnalyticsIntentGroupByKey {
537
570
  */
538
571
  export interface AnalyticsIntentGroupBySpecification {
539
572
  /**
573
+ * @public
540
574
  * <p>Specifies whether to group the intent stages by their name or their end state.</p>
541
575
  */
542
576
  name: AnalyticsIntentField | string | undefined;
@@ -575,6 +609,7 @@ export type AnalyticsMetricStatistic = (typeof AnalyticsMetricStatistic)[keyof t
575
609
  */
576
610
  export interface AnalyticsIntentMetric {
577
611
  /**
612
+ * @public
578
613
  * <p>The metric for which you want to get intent summary statistics.</p>
579
614
  * <ul>
580
615
  * <li>
@@ -601,6 +636,7 @@ export interface AnalyticsIntentMetric {
601
636
  */
602
637
  name: AnalyticsIntentMetricName | string | undefined;
603
638
  /**
639
+ * @public
604
640
  * <p>The summary statistic to calculate.</p>
605
641
  * <ul>
606
642
  * <li>
@@ -619,6 +655,7 @@ export interface AnalyticsIntentMetric {
619
655
  */
620
656
  statistic: AnalyticsMetricStatistic | string | undefined;
621
657
  /**
658
+ * @public
622
659
  * <p>Specifies whether to sort the results in ascending or descending order.</p>
623
660
  */
624
661
  order?: AnalyticsSortOrder | string;
@@ -629,6 +666,7 @@ export interface AnalyticsIntentMetric {
629
666
  */
630
667
  export interface AnalyticsIntentMetricResult {
631
668
  /**
669
+ * @public
632
670
  * <p>The metric that you requested. See <a href="https://docs.aws.amazon.com/lexv2/latest/dg/analytics-key-definitions.html">Key definitions</a> for more details about these metrics.</p>
633
671
  * <ul>
634
672
  * <li>
@@ -655,6 +693,7 @@ export interface AnalyticsIntentMetricResult {
655
693
  */
656
694
  name?: AnalyticsIntentMetricName | string;
657
695
  /**
696
+ * @public
658
697
  * <p>The statistic that you requested to calculate.</p>
659
698
  * <ul>
660
699
  * <li>
@@ -673,6 +712,7 @@ export interface AnalyticsIntentMetricResult {
673
712
  */
674
713
  statistic?: AnalyticsMetricStatistic | string;
675
714
  /**
715
+ * @public
676
716
  * <p>The value of the summary statistic for the metric that you requested.</p>
677
717
  */
678
718
  value?: number;
@@ -695,22 +735,27 @@ export type AnalyticsNodeType = (typeof AnalyticsNodeType)[keyof typeof Analytic
695
735
  */
696
736
  export interface AnalyticsIntentNodeSummary {
697
737
  /**
738
+ * @public
698
739
  * <p>The name of the intent at the end of the requested path.</p>
699
740
  */
700
741
  intentName?: string;
701
742
  /**
743
+ * @public
702
744
  * <p>The path.</p>
703
745
  */
704
746
  intentPath?: string;
705
747
  /**
748
+ * @public
706
749
  * <p>The total number of sessions that follow the given path to the given intent.</p>
707
750
  */
708
751
  intentCount?: number;
709
752
  /**
753
+ * @public
710
754
  * <p>The number of intents up to and including the requested path.</p>
711
755
  */
712
756
  intentLevel?: number;
713
757
  /**
758
+ * @public
714
759
  * <p>Specifies whether the node is the end of a path (<code>Exit</code>) or not (<code>Inner</code>).</p>
715
760
  */
716
761
  nodeType?: AnalyticsNodeType | string;
@@ -721,14 +766,17 @@ export interface AnalyticsIntentNodeSummary {
721
766
  */
722
767
  export interface AnalyticsIntentResult {
723
768
  /**
769
+ * @public
724
770
  * <p>A list of objects containing the criteria you requested for binning results and the values of the bins.</p>
725
771
  */
726
772
  binKeys?: AnalyticsBinKey[];
727
773
  /**
774
+ * @public
728
775
  * <p>A list of objects containing the criteria you requested for grouping results and the values of the groups.</p>
729
776
  */
730
777
  groupByKeys?: AnalyticsIntentGroupByKey[];
731
778
  /**
779
+ * @public
732
780
  * <p>A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.</p>
733
781
  */
734
782
  metricsResults?: AnalyticsIntentMetricResult[];
@@ -821,6 +869,7 @@ export type AnalyticsIntentStageFilterName = (typeof AnalyticsIntentStageFilterN
821
869
  */
822
870
  export interface AnalyticsIntentStageFilter {
823
871
  /**
872
+ * @public
824
873
  * <p>The category by which to filter the intent stages. The descriptions for each option are as follows:</p>
825
874
  * <ul>
826
875
  * <li>
@@ -863,6 +912,7 @@ export interface AnalyticsIntentStageFilter {
863
912
  */
864
913
  name: AnalyticsIntentStageFilterName | string | undefined;
865
914
  /**
915
+ * @public
866
916
  * <p>The operation by which to filter the category. The following operations are possible:</p>
867
917
  * <ul>
868
918
  * <li>
@@ -924,6 +974,7 @@ export interface AnalyticsIntentStageFilter {
924
974
  */
925
975
  operator: AnalyticsFilterOperator | string | undefined;
926
976
  /**
977
+ * @public
927
978
  * <p>An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is <code>EQ</code> or <code>CO</code>. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the <code>name</code>, <code>operator</code>, and <code>values</code> fields are <code>Modality</code>, <code>EQ</code>, and <code>[Speech, Text]</code>, the operation filters for results where the modality was either <code>Speech</code> or <code>Text</code>.</p>
928
979
  */
929
980
  values: string[] | undefined;
@@ -934,10 +985,12 @@ export interface AnalyticsIntentStageFilter {
934
985
  */
935
986
  export interface AnalyticsIntentStageGroupByKey {
936
987
  /**
988
+ * @public
937
989
  * <p>A category by which the intent stage analytics were grouped.</p>
938
990
  */
939
991
  name?: AnalyticsIntentStageField | string;
940
992
  /**
993
+ * @public
941
994
  * <p>A member of the category by which the intent stage analytics were grouped.</p>
942
995
  */
943
996
  value?: string;
@@ -948,6 +1001,7 @@ export interface AnalyticsIntentStageGroupByKey {
948
1001
  */
949
1002
  export interface AnalyticsIntentStageGroupBySpecification {
950
1003
  /**
1004
+ * @public
951
1005
  * <p>Specifies whether to group the intent stages by their name or the intent to which the session was switched.</p>
952
1006
  */
953
1007
  name: AnalyticsIntentStageField | string | undefined;
@@ -973,6 +1027,7 @@ export type AnalyticsIntentStageMetricName = (typeof AnalyticsIntentStageMetricN
973
1027
  */
974
1028
  export interface AnalyticsIntentStageMetric {
975
1029
  /**
1030
+ * @public
976
1031
  * <p>The metric for which you want to get intent stage summary statistics. See <a href="https://docs.aws.amazon.com/lexv2/latest/dg/analytics-key-definitions.html">Key definitions</a> for more details about these metrics.</p>
977
1032
  * <ul>
978
1033
  * <li>
@@ -999,6 +1054,7 @@ export interface AnalyticsIntentStageMetric {
999
1054
  */
1000
1055
  name: AnalyticsIntentStageMetricName | string | undefined;
1001
1056
  /**
1057
+ * @public
1002
1058
  * <p>The summary statistic to calculate.</p>
1003
1059
  * <ul>
1004
1060
  * <li>
@@ -1017,6 +1073,7 @@ export interface AnalyticsIntentStageMetric {
1017
1073
  */
1018
1074
  statistic: AnalyticsMetricStatistic | string | undefined;
1019
1075
  /**
1076
+ * @public
1020
1077
  * <p>Specifies whether to sort the results in ascending or descending order of the summary statistic (<code>value</code> in the response).</p>
1021
1078
  */
1022
1079
  order?: AnalyticsSortOrder | string;
@@ -1027,6 +1084,7 @@ export interface AnalyticsIntentStageMetric {
1027
1084
  */
1028
1085
  export interface AnalyticsIntentStageMetricResult {
1029
1086
  /**
1087
+ * @public
1030
1088
  * <p>The metric that you requested.</p>
1031
1089
  * <ul>
1032
1090
  * <li>
@@ -1053,6 +1111,7 @@ export interface AnalyticsIntentStageMetricResult {
1053
1111
  */
1054
1112
  name?: AnalyticsIntentStageMetricName | string;
1055
1113
  /**
1114
+ * @public
1056
1115
  * <p>The summary statistic that you requested to calculate.</p>
1057
1116
  * <ul>
1058
1117
  * <li>
@@ -1071,6 +1130,7 @@ export interface AnalyticsIntentStageMetricResult {
1071
1130
  */
1072
1131
  statistic?: AnalyticsMetricStatistic | string;
1073
1132
  /**
1133
+ * @public
1074
1134
  * <p>The value of the summary statistic for the metric that you requested.</p>
1075
1135
  */
1076
1136
  value?: number;
@@ -1081,14 +1141,17 @@ export interface AnalyticsIntentStageMetricResult {
1081
1141
  */
1082
1142
  export interface AnalyticsIntentStageResult {
1083
1143
  /**
1144
+ * @public
1084
1145
  * <p>A list of objects containing the criteria you requested for binning results and the values of the bins.</p>
1085
1146
  */
1086
1147
  binKeys?: AnalyticsBinKey[];
1087
1148
  /**
1149
+ * @public
1088
1150
  * <p>A list of objects containing the criteria you requested for grouping results and the values of the bins.</p>
1089
1151
  */
1090
1152
  groupByKeys?: AnalyticsIntentStageGroupByKey[];
1091
1153
  /**
1154
+ * @public
1092
1155
  * <p>A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.</p>
1093
1156
  */
1094
1157
  metricsResults?: AnalyticsIntentStageMetricResult[];
@@ -1148,6 +1211,7 @@ export type AnalyticsModality = (typeof AnalyticsModality)[keyof typeof Analytic
1148
1211
  */
1149
1212
  export interface AnalyticsPathFilter {
1150
1213
  /**
1214
+ * @public
1151
1215
  * <p>The category by which to filter the intent paths. The descriptions for each option are as follows:</p>
1152
1216
  * <ul>
1153
1217
  * <li>
@@ -1174,6 +1238,7 @@ export interface AnalyticsPathFilter {
1174
1238
  */
1175
1239
  name: AnalyticsCommonFilterName | string | undefined;
1176
1240
  /**
1241
+ * @public
1177
1242
  * <p>The operation by which to filter the category. The following operations are possible:</p>
1178
1243
  * <ul>
1179
1244
  * <li>
@@ -1219,6 +1284,7 @@ export interface AnalyticsPathFilter {
1219
1284
  */
1220
1285
  operator: AnalyticsFilterOperator | string | undefined;
1221
1286
  /**
1287
+ * @public
1222
1288
  * <p>An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is <code>EQ</code> or <code>CO</code>. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the <code>name</code>, <code>operator</code>, and <code>values</code> fields are <code>Modality</code>, <code>EQ</code>, and <code>[Speech, Text]</code>, the operation filters for results where the modality was either <code>Speech</code> or <code>Text</code>.</p>
1223
1289
  */
1224
1290
  values: string[] | undefined;
@@ -1316,6 +1382,7 @@ export type AnalyticsSessionFilterName = (typeof AnalyticsSessionFilterName)[key
1316
1382
  */
1317
1383
  export interface AnalyticsSessionFilter {
1318
1384
  /**
1385
+ * @public
1319
1386
  * <p>The category by which to filter the sessions. The descriptions for each option are as follows:</p>
1320
1387
  * <ul>
1321
1388
  * <li>
@@ -1362,6 +1429,7 @@ export interface AnalyticsSessionFilter {
1362
1429
  */
1363
1430
  name: AnalyticsSessionFilterName | string | undefined;
1364
1431
  /**
1432
+ * @public
1365
1433
  * <p>The operation by which to filter the category. The following operations are possible:</p>
1366
1434
  * <ul>
1367
1435
  * <li>
@@ -1427,6 +1495,7 @@ export interface AnalyticsSessionFilter {
1427
1495
  */
1428
1496
  operator: AnalyticsFilterOperator | string | undefined;
1429
1497
  /**
1498
+ * @public
1430
1499
  * <p>An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is <code>EQ</code> or <code>CO</code>. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the <code>name</code>, <code>operator</code>, and <code>values</code> fields are <code>Modality</code>, <code>EQ</code>, and <code>[Speech, Text]</code>, the operation filters for results where the modality was either <code>Speech</code> or <code>Text</code>.</p>
1431
1500
  */
1432
1501
  values: string[] | undefined;
@@ -1437,10 +1506,12 @@ export interface AnalyticsSessionFilter {
1437
1506
  */
1438
1507
  export interface AnalyticsSessionGroupByKey {
1439
1508
  /**
1509
+ * @public
1440
1510
  * <p>The category by which the session analytics were grouped.</p>
1441
1511
  */
1442
1512
  name?: AnalyticsSessionField | string;
1443
1513
  /**
1514
+ * @public
1444
1515
  * <p>A member of the category by which the session analytics were grouped.</p>
1445
1516
  */
1446
1517
  value?: string;
@@ -1451,6 +1522,7 @@ export interface AnalyticsSessionGroupByKey {
1451
1522
  */
1452
1523
  export interface AnalyticsSessionGroupBySpecification {
1453
1524
  /**
1525
+ * @public
1454
1526
  * <p>Specifies whether to group the session by their end state or their locale.</p>
1455
1527
  */
1456
1528
  name: AnalyticsSessionField | string | undefined;
@@ -1478,6 +1550,7 @@ export type AnalyticsSessionMetricName = (typeof AnalyticsSessionMetricName)[key
1478
1550
  */
1479
1551
  export interface AnalyticsSessionMetric {
1480
1552
  /**
1553
+ * @public
1481
1554
  * <p>The metric for which you want to get session summary statistics.</p>
1482
1555
  * <ul>
1483
1556
  * <li>
@@ -1512,6 +1585,7 @@ export interface AnalyticsSessionMetric {
1512
1585
  */
1513
1586
  name: AnalyticsSessionMetricName | string | undefined;
1514
1587
  /**
1588
+ * @public
1515
1589
  * <p>The summary statistic to calculate.</p>
1516
1590
  * <ul>
1517
1591
  * <li>
@@ -1530,6 +1604,7 @@ export interface AnalyticsSessionMetric {
1530
1604
  */
1531
1605
  statistic: AnalyticsMetricStatistic | string | undefined;
1532
1606
  /**
1607
+ * @public
1533
1608
  * <p>Specifies whether to sort the results in ascending or descending order.</p>
1534
1609
  */
1535
1610
  order?: AnalyticsSortOrder | string;
@@ -1540,6 +1615,7 @@ export interface AnalyticsSessionMetric {
1540
1615
  */
1541
1616
  export interface AnalyticsSessionMetricResult {
1542
1617
  /**
1618
+ * @public
1543
1619
  * <p>The metric that you requested.</p>
1544
1620
  * <ul>
1545
1621
  * <li>
@@ -1574,6 +1650,7 @@ export interface AnalyticsSessionMetricResult {
1574
1650
  */
1575
1651
  name?: AnalyticsSessionMetricName | string;
1576
1652
  /**
1653
+ * @public
1577
1654
  * <p>The summary statistic that you requested to calculate.</p>
1578
1655
  * <ul>
1579
1656
  * <li>
@@ -1592,6 +1669,7 @@ export interface AnalyticsSessionMetricResult {
1592
1669
  */
1593
1670
  statistic?: AnalyticsMetricStatistic | string;
1594
1671
  /**
1672
+ * @public
1595
1673
  * <p>The value of the summary statistic for the metric that you requested.</p>
1596
1674
  */
1597
1675
  value?: number;
@@ -1602,14 +1680,17 @@ export interface AnalyticsSessionMetricResult {
1602
1680
  */
1603
1681
  export interface AnalyticsSessionResult {
1604
1682
  /**
1683
+ * @public
1605
1684
  * <p>A list of objects containing the criteria you requested for binning results and the values of the bins.</p>
1606
1685
  */
1607
1686
  binKeys?: AnalyticsBinKey[];
1608
1687
  /**
1688
+ * @public
1609
1689
  * <p>A list of objects containing the criteria you requested for grouping results and the values of the bins.</p>
1610
1690
  */
1611
1691
  groupByKeys?: AnalyticsSessionGroupByKey[];
1612
1692
  /**
1693
+ * @public
1613
1694
  * <p>A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.</p>
1614
1695
  */
1615
1696
  metricsResults?: AnalyticsSessionMetricResult[];
@@ -1644,6 +1725,7 @@ export type AnalyticsUtteranceAttributeName = (typeof AnalyticsUtteranceAttribut
1644
1725
  */
1645
1726
  export interface AnalyticsUtteranceAttribute {
1646
1727
  /**
1728
+ * @public
1647
1729
  * <p>An attribute to return. The only available attribute is the intent that the bot mapped the utterance to.</p>
1648
1730
  */
1649
1731
  name: AnalyticsUtteranceAttributeName | string | undefined;
@@ -1654,6 +1736,7 @@ export interface AnalyticsUtteranceAttribute {
1654
1736
  */
1655
1737
  export interface AnalyticsUtteranceAttributeResult {
1656
1738
  /**
1739
+ * @public
1657
1740
  * <p>The intent that the bot mapped the utterance to.</p>
1658
1741
  */
1659
1742
  lastUsedIntent?: string;
@@ -1746,6 +1829,7 @@ export type AnalyticsUtteranceFilterName = (typeof AnalyticsUtteranceFilterName)
1746
1829
  */
1747
1830
  export interface AnalyticsUtteranceFilter {
1748
1831
  /**
1832
+ * @public
1749
1833
  * <p>The category by which to filter the utterances. The descriptions for each option are as follows:</p>
1750
1834
  * <ul>
1751
1835
  * <li>
@@ -1788,6 +1872,7 @@ export interface AnalyticsUtteranceFilter {
1788
1872
  */
1789
1873
  name: AnalyticsUtteranceFilterName | string | undefined;
1790
1874
  /**
1875
+ * @public
1791
1876
  * <p>The operation by which to filter the category. The following operations are possible:</p>
1792
1877
  * <ul>
1793
1878
  * <li>
@@ -1849,6 +1934,7 @@ export interface AnalyticsUtteranceFilter {
1849
1934
  */
1850
1935
  operator: AnalyticsFilterOperator | string | undefined;
1851
1936
  /**
1937
+ * @public
1852
1938
  * <p>An array containing the values of the category by which to apply the operator to filter the results. You can provide multiple values if the operator is <code>EQ</code> or <code>CO</code>. If you provide multiple values, you filter for results that equal/contain any of the values. For example, if the <code>name</code>, <code>operator</code>, and <code>values</code> fields are <code>Modality</code>, <code>EQ</code>, and <code>[Speech, Text]</code>, the operation filters for results where the modality was either <code>Speech</code> or <code>Text</code>.</p>
1853
1939
  */
1854
1940
  values: string[] | undefined;
@@ -1859,10 +1945,12 @@ export interface AnalyticsUtteranceFilter {
1859
1945
  */
1860
1946
  export interface AnalyticsUtteranceGroupByKey {
1861
1947
  /**
1948
+ * @public
1862
1949
  * <p>The category by which the utterance analytics were grouped.</p>
1863
1950
  */
1864
1951
  name?: AnalyticsUtteranceField | string;
1865
1952
  /**
1953
+ * @public
1866
1954
  * <p>A member of the category by which the utterance analytics were grouped.</p>
1867
1955
  */
1868
1956
  value?: string;
@@ -1873,6 +1961,7 @@ export interface AnalyticsUtteranceGroupByKey {
1873
1961
  */
1874
1962
  export interface AnalyticsUtteranceGroupBySpecification {
1875
1963
  /**
1964
+ * @public
1876
1965
  * <p>Specifies whether to group the utterances by their text or their state.</p>
1877
1966
  */
1878
1967
  name: AnalyticsUtteranceField | string | undefined;
@@ -1897,6 +1986,7 @@ export type AnalyticsUtteranceMetricName = (typeof AnalyticsUtteranceMetricName)
1897
1986
  */
1898
1987
  export interface AnalyticsUtteranceMetric {
1899
1988
  /**
1989
+ * @public
1900
1990
  * <p>The metric for which you want to get utterance summary statistics.</p>
1901
1991
  * <ul>
1902
1992
  * <li>
@@ -1919,6 +2009,7 @@ export interface AnalyticsUtteranceMetric {
1919
2009
  */
1920
2010
  name: AnalyticsUtteranceMetricName | string | undefined;
1921
2011
  /**
2012
+ * @public
1922
2013
  * <p>The summary statistic to calculate.</p>
1923
2014
  * <ul>
1924
2015
  * <li>
@@ -1937,6 +2028,7 @@ export interface AnalyticsUtteranceMetric {
1937
2028
  */
1938
2029
  statistic: AnalyticsMetricStatistic | string | undefined;
1939
2030
  /**
2031
+ * @public
1940
2032
  * <p>Specifies whether to sort the results in ascending or descending order.</p>
1941
2033
  */
1942
2034
  order?: AnalyticsSortOrder | string;
@@ -1947,6 +2039,7 @@ export interface AnalyticsUtteranceMetric {
1947
2039
  */
1948
2040
  export interface AnalyticsUtteranceMetricResult {
1949
2041
  /**
2042
+ * @public
1950
2043
  * <p>The metric that you requested.</p>
1951
2044
  * <ul>
1952
2045
  * <li>
@@ -1969,6 +2062,7 @@ export interface AnalyticsUtteranceMetricResult {
1969
2062
  */
1970
2063
  name?: AnalyticsUtteranceMetricName | string;
1971
2064
  /**
2065
+ * @public
1972
2066
  * <p>The summary statistic that you requested to calculate.</p>
1973
2067
  * <ul>
1974
2068
  * <li>
@@ -1987,6 +2081,7 @@ export interface AnalyticsUtteranceMetricResult {
1987
2081
  */
1988
2082
  statistic?: AnalyticsMetricStatistic | string;
1989
2083
  /**
2084
+ * @public
1990
2085
  * <p>The value of the summary statistic for the metric that you requested.</p>
1991
2086
  */
1992
2087
  value?: number;
@@ -1997,18 +2092,22 @@ export interface AnalyticsUtteranceMetricResult {
1997
2092
  */
1998
2093
  export interface AnalyticsUtteranceResult {
1999
2094
  /**
2095
+ * @public
2000
2096
  * <p>A list of objects containing the criteria you requested for binning results and the values of the bins.</p>
2001
2097
  */
2002
2098
  binKeys?: AnalyticsBinKey[];
2003
2099
  /**
2100
+ * @public
2004
2101
  * <p>A list of objects containing the criteria you requested for grouping results and the values of the bins.</p>
2005
2102
  */
2006
2103
  groupByKeys?: AnalyticsUtteranceGroupByKey[];
2007
2104
  /**
2105
+ * @public
2008
2106
  * <p>A list of objects, each of which contains a metric you want to list, the statistic for the metric you want to return, and the method by which to organize the results.</p>
2009
2107
  */
2010
2108
  metricsResults?: AnalyticsUtteranceMetricResult[];
2011
2109
  /**
2110
+ * @public
2012
2111
  * <p>A list of objects containing information about the last used intent at the time of an utterance.</p>
2013
2112
  */
2014
2113
  attributeResults?: AnalyticsUtteranceAttributeResult[];
@@ -2031,6 +2130,7 @@ export type AnalyticsUtteranceSortByName = (typeof AnalyticsUtteranceSortByName)
2031
2130
  */
2032
2131
  export interface AssociatedTranscript {
2033
2132
  /**
2133
+ * @public
2034
2134
  * <p>The content of the transcript that meets the search filter criteria.
2035
2135
  * For the JSON format of the transcript, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/designing-output-format.html">Output transcript
2036
2136
  * format</a>.</p>
@@ -2055,11 +2155,13 @@ export type AssociatedTranscriptFilterName = (typeof AssociatedTranscriptFilterN
2055
2155
  */
2056
2156
  export interface AssociatedTranscriptFilter {
2057
2157
  /**
2158
+ * @public
2058
2159
  * <p>The name of the field to use for filtering. The allowed names are
2059
2160
  * IntentId and SlotTypeId.</p>
2060
2161
  */
2061
2162
  name: AssociatedTranscriptFilterName | string | undefined;
2062
2163
  /**
2164
+ * @public
2063
2165
  * <p>The values to use to filter the transcript.</p>
2064
2166
  */
2065
2167
  values: string[] | undefined;
@@ -2070,11 +2172,13 @@ export interface AssociatedTranscriptFilter {
2070
2172
  */
2071
2173
  export interface AudioSpecification {
2072
2174
  /**
2175
+ * @public
2073
2176
  * <p>Time for how long Amazon Lex waits before speech input is truncated and the speech
2074
2177
  * is returned to application.</p>
2075
2178
  */
2076
2179
  maxLengthMs: number | undefined;
2077
2180
  /**
2181
+ * @public
2078
2182
  * <p>Time for which a bot waits after the customer stops speaking to assume the
2079
2183
  * utterance is finished.</p>
2080
2184
  */
@@ -2086,20 +2190,24 @@ export interface AudioSpecification {
2086
2190
  */
2087
2191
  export interface DTMFSpecification {
2088
2192
  /**
2193
+ * @public
2089
2194
  * <p>The maximum number of DTMF digits allowed in an utterance.</p>
2090
2195
  */
2091
2196
  maxLength: number | undefined;
2092
2197
  /**
2198
+ * @public
2093
2199
  * <p>How long the bot should wait after the last DTMF character input before assuming
2094
2200
  * that the input has concluded.</p>
2095
2201
  */
2096
2202
  endTimeoutMs: number | undefined;
2097
2203
  /**
2204
+ * @public
2098
2205
  * <p>The DTMF character that clears the accumulated DTMF digits and immediately ends
2099
2206
  * the input.</p>
2100
2207
  */
2101
2208
  deletionCharacter: string | undefined;
2102
2209
  /**
2210
+ * @public
2103
2211
  * <p>The DTMF character that immediately ends input. If the user does not press this
2104
2212
  * character, the input ends after the end timeout.</p>
2105
2213
  */
@@ -2111,15 +2219,18 @@ export interface DTMFSpecification {
2111
2219
  */
2112
2220
  export interface AudioAndDTMFInputSpecification {
2113
2221
  /**
2222
+ * @public
2114
2223
  * <p>Time for which a bot waits before assuming that the customer isn't going to speak or press
2115
2224
  * a key. This timeout is shared between Audio and DTMF inputs.</p>
2116
2225
  */
2117
2226
  startTimeoutMs: number | undefined;
2118
2227
  /**
2228
+ * @public
2119
2229
  * <p>Specifies the settings on audio input.</p>
2120
2230
  */
2121
2231
  audioSpecification?: AudioSpecification;
2122
2232
  /**
2233
+ * @public
2123
2234
  * <p>Specifies the settings on DTMF input.</p>
2124
2235
  */
2125
2236
  dtmfSpecification?: DTMFSpecification;
@@ -2130,16 +2241,19 @@ export interface AudioAndDTMFInputSpecification {
2130
2241
  */
2131
2242
  export interface S3BucketLogDestination {
2132
2243
  /**
2244
+ * @public
2133
2245
  * <p>The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service
2134
2246
  * (KMS) key for encrypting audio log files stored in an S3 bucket.</p>
2135
2247
  */
2136
2248
  kmsKeyArn?: string;
2137
2249
  /**
2250
+ * @public
2138
2251
  * <p>The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio
2139
2252
  * log files are stored.</p>
2140
2253
  */
2141
2254
  s3BucketArn: string | undefined;
2142
2255
  /**
2256
+ * @public
2143
2257
  * <p>The S3 prefix to assign to audio log files.</p>
2144
2258
  */
2145
2259
  logPrefix: string | undefined;
@@ -2151,6 +2265,7 @@ export interface S3BucketLogDestination {
2151
2265
  */
2152
2266
  export interface AudioLogDestination {
2153
2267
  /**
2268
+ * @public
2154
2269
  * <p>The Amazon S3 bucket where the audio log files are stored. The IAM
2155
2270
  * role specified in the <code>roleArn</code> parameter of the <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateBot.html">CreateBot</a> operation must have permission to write to this
2156
2271
  * bucket.</p>
@@ -2165,10 +2280,12 @@ export interface AudioLogDestination {
2165
2280
  */
2166
2281
  export interface AudioLogSetting {
2167
2282
  /**
2283
+ * @public
2168
2284
  * <p>Determines whether audio logging in enabled for the bot.</p>
2169
2285
  */
2170
2286
  enabled: boolean | undefined;
2171
2287
  /**
2288
+ * @public
2172
2289
  * <p>The location of audio log files collected when conversation logging
2173
2290
  * is enabled for a bot.</p>
2174
2291
  */
@@ -2181,16 +2298,19 @@ export interface AudioLogSetting {
2181
2298
  */
2182
2299
  export interface NewCustomVocabularyItem {
2183
2300
  /**
2301
+ * @public
2184
2302
  * <p>The unique phrase for the new custom vocabulary item from the custom
2185
2303
  * vocabulary list.</p>
2186
2304
  */
2187
2305
  phrase: string | undefined;
2188
2306
  /**
2307
+ * @public
2189
2308
  * <p>The weight assigned to the new custom vocabulary item from the custom
2190
2309
  * vocabulary list.</p>
2191
2310
  */
2192
2311
  weight?: number;
2193
2312
  /**
2313
+ * @public
2194
2314
  * <p>The display as value assigned to the new custom vocabulary item from the custom
2195
2315
  * vocabulary list.</p>
2196
2316
  */
@@ -2201,21 +2321,25 @@ export interface NewCustomVocabularyItem {
2201
2321
  */
2202
2322
  export interface BatchCreateCustomVocabularyItemRequest {
2203
2323
  /**
2324
+ * @public
2204
2325
  * <p>The identifier of the bot associated with this custom vocabulary.</p>
2205
2326
  */
2206
2327
  botId: string | undefined;
2207
2328
  /**
2329
+ * @public
2208
2330
  * <p>The identifier of the version of the bot associated with this
2209
2331
  * custom vocabulary.</p>
2210
2332
  */
2211
2333
  botVersion: string | undefined;
2212
2334
  /**
2335
+ * @public
2213
2336
  * <p>The identifier of the language and locale where this custom vocabulary
2214
2337
  * is used. The string must match one of the supported locales. For more
2215
2338
  * information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html"> Supported Languages </a>.</p>
2216
2339
  */
2217
2340
  localeId: string | undefined;
2218
2341
  /**
2342
+ * @public
2219
2343
  * <p>A list of new custom vocabulary items. Each entry must contain a phrase and
2220
2344
  * can optionally contain a displayAs and/or a weight.</p>
2221
2345
  */
@@ -2242,16 +2366,19 @@ export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
2242
2366
  */
2243
2367
  export interface FailedCustomVocabularyItem {
2244
2368
  /**
2369
+ * @public
2245
2370
  * <p>The unique item identifer for the failed custom vocabulary item
2246
2371
  * from the custom vocabulary list.</p>
2247
2372
  */
2248
2373
  itemId?: string;
2249
2374
  /**
2375
+ * @public
2250
2376
  * <p>The error message for the failed custom vocabulary item
2251
2377
  * from the custom vocabulary list.</p>
2252
2378
  */
2253
2379
  errorMessage?: string;
2254
2380
  /**
2381
+ * @public
2255
2382
  * <p>The unique error code for the failed custom vocabulary item
2256
2383
  * from the custom vocabulary list.</p>
2257
2384
  */
@@ -2264,21 +2391,25 @@ export interface FailedCustomVocabularyItem {
2264
2391
  */
2265
2392
  export interface CustomVocabularyItem {
2266
2393
  /**
2394
+ * @public
2267
2395
  * <p>The unique item identifer for the custom vocabulary item
2268
2396
  * from the custom vocabulary list.</p>
2269
2397
  */
2270
2398
  itemId: string | undefined;
2271
2399
  /**
2400
+ * @public
2272
2401
  * <p>The unique phrase for the custom vocabulary item
2273
2402
  * from the custom vocabulary list.</p>
2274
2403
  */
2275
2404
  phrase: string | undefined;
2276
2405
  /**
2406
+ * @public
2277
2407
  * <p>The weight assigned for the custom vocabulary item
2278
2408
  * from the custom vocabulary list.</p>
2279
2409
  */
2280
2410
  weight?: number;
2281
2411
  /**
2412
+ * @public
2282
2413
  * <p>The DisplayAs value for the custom vocabulary item
2283
2414
  * from the custom vocabulary list.</p>
2284
2415
  */
@@ -2289,26 +2420,31 @@ export interface CustomVocabularyItem {
2289
2420
  */
2290
2421
  export interface BatchCreateCustomVocabularyItemResponse {
2291
2422
  /**
2423
+ * @public
2292
2424
  * <p>The identifier of the bot associated with this custom vocabulary.</p>
2293
2425
  */
2294
2426
  botId?: string;
2295
2427
  /**
2428
+ * @public
2296
2429
  * <p>The identifier of the version of the bot associated with this
2297
2430
  * custom vocabulary.</p>
2298
2431
  */
2299
2432
  botVersion?: string;
2300
2433
  /**
2434
+ * @public
2301
2435
  * <p>The identifier of the language and locale where this custom vocabulary is used.
2302
2436
  * The string must match one of the supported locales.
2303
2437
  * For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html"> Supported Languages </a>.</p>
2304
2438
  */
2305
2439
  localeId?: string;
2306
2440
  /**
2441
+ * @public
2307
2442
  * <p>A list of custom vocabulary items that failed to create during the operation.
2308
2443
  * The reason for the error is contained within each error object.</p>
2309
2444
  */
2310
2445
  errors?: FailedCustomVocabularyItem[];
2311
2446
  /**
2447
+ * @public
2312
2448
  * <p>A list of custom vocabulary items that were
2313
2449
  * successfully created during the operation.</p>
2314
2450
  */
@@ -2361,6 +2497,7 @@ export declare class ThrottlingException extends __BaseException {
2361
2497
  readonly name: "ThrottlingException";
2362
2498
  readonly $fault: "client";
2363
2499
  /**
2500
+ * @public
2364
2501
  * <p>The number of seconds after which the user can invoke the API again.</p>
2365
2502
  */
2366
2503
  retryAfterSeconds?: number;
@@ -2389,6 +2526,7 @@ export declare class ValidationException extends __BaseException {
2389
2526
  */
2390
2527
  export interface CustomVocabularyEntryId {
2391
2528
  /**
2529
+ * @public
2392
2530
  * <p>The unique item identifier for the custom vocabulary
2393
2531
  * items.</p>
2394
2532
  */
@@ -2399,21 +2537,25 @@ export interface CustomVocabularyEntryId {
2399
2537
  */
2400
2538
  export interface BatchDeleteCustomVocabularyItemRequest {
2401
2539
  /**
2540
+ * @public
2402
2541
  * <p>The identifier of the bot associated with this custom vocabulary.</p>
2403
2542
  */
2404
2543
  botId: string | undefined;
2405
2544
  /**
2545
+ * @public
2406
2546
  * <p>The identifier of the version of the bot associated with this custom
2407
2547
  * vocabulary.</p>
2408
2548
  */
2409
2549
  botVersion: string | undefined;
2410
2550
  /**
2551
+ * @public
2411
2552
  * <p>The identifier of the language and locale where this custom vocabulary is
2412
2553
  * used. The string must match one of the supported locales.
2413
2554
  * For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html"> Supported Languages </a>.</p>
2414
2555
  */
2415
2556
  localeId: string | undefined;
2416
2557
  /**
2558
+ * @public
2417
2559
  * <p>A list of custom vocabulary items requested to be deleted.
2418
2560
  * Each entry must contain the unique custom vocabulary entry identifier.</p>
2419
2561
  */
@@ -2424,15 +2566,18 @@ export interface BatchDeleteCustomVocabularyItemRequest {
2424
2566
  */
2425
2567
  export interface BatchDeleteCustomVocabularyItemResponse {
2426
2568
  /**
2569
+ * @public
2427
2570
  * <p>The identifier of the bot associated with this custom vocabulary.</p>
2428
2571
  */
2429
2572
  botId?: string;
2430
2573
  /**
2574
+ * @public
2431
2575
  * <p>The identifier of the version of the bot associated with this custom
2432
2576
  * vocabulary.</p>
2433
2577
  */
2434
2578
  botVersion?: string;
2435
2579
  /**
2580
+ * @public
2436
2581
  * <p>The identifier of the language and locale where this custom vocabulary is
2437
2582
  * used. The string must match one of the supported locales.
2438
2583
  * For more information, see Supported
@@ -2440,11 +2585,13 @@ export interface BatchDeleteCustomVocabularyItemResponse {
2440
2585
  */
2441
2586
  localeId?: string;
2442
2587
  /**
2588
+ * @public
2443
2589
  * <p>A list of custom vocabulary items that failed to delete during the operation.
2444
2590
  * The reason for the error is contained within each error object.</p>
2445
2591
  */
2446
2592
  errors?: FailedCustomVocabularyItem[];
2447
2593
  /**
2594
+ * @public
2448
2595
  * <p>A list of custom vocabulary items that were
2449
2596
  * successfully deleted during the operation.</p>
2450
2597
  */
@@ -2455,21 +2602,25 @@ export interface BatchDeleteCustomVocabularyItemResponse {
2455
2602
  */
2456
2603
  export interface BatchUpdateCustomVocabularyItemRequest {
2457
2604
  /**
2605
+ * @public
2458
2606
  * <p>The identifier of the bot associated with this custom vocabulary</p>
2459
2607
  */
2460
2608
  botId: string | undefined;
2461
2609
  /**
2610
+ * @public
2462
2611
  * <p>The identifier of the version of the bot associated with this custom
2463
2612
  * vocabulary.</p>
2464
2613
  */
2465
2614
  botVersion: string | undefined;
2466
2615
  /**
2616
+ * @public
2467
2617
  * <p>The identifier of the language and locale where this custom vocabulary
2468
2618
  * is used. The string must match one of the supported locales. For more
2469
2619
  * information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html"> Supported Languages </a>.</p>
2470
2620
  */
2471
2621
  localeId: string | undefined;
2472
2622
  /**
2623
+ * @public
2473
2624
  * <p>A list of custom vocabulary items with updated fields. Each entry must contain a phrase
2474
2625
  * and can optionally contain a displayAs and/or a weight.</p>
2475
2626
  */
@@ -2480,26 +2631,31 @@ export interface BatchUpdateCustomVocabularyItemRequest {
2480
2631
  */
2481
2632
  export interface BatchUpdateCustomVocabularyItemResponse {
2482
2633
  /**
2634
+ * @public
2483
2635
  * <p>The identifier of the bot associated with this custom vocabulary.</p>
2484
2636
  */
2485
2637
  botId?: string;
2486
2638
  /**
2639
+ * @public
2487
2640
  * <p>The identifier of the version of the bot associated with this custom
2488
2641
  * vocabulary.</p>
2489
2642
  */
2490
2643
  botVersion?: string;
2491
2644
  /**
2645
+ * @public
2492
2646
  * <p>The identifier of the language and locale where this custom vocabulary
2493
2647
  * is used. The string must match one of the supported locales. For more
2494
2648
  * information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html"> Supported Languages </a>.</p>
2495
2649
  */
2496
2650
  localeId?: string;
2497
2651
  /**
2652
+ * @public
2498
2653
  * <p>A list of custom vocabulary items that failed to update during the operation.
2499
2654
  * The reason for the error is contained within each error object.</p>
2500
2655
  */
2501
2656
  errors?: FailedCustomVocabularyItem[];
2502
2657
  /**
2658
+ * @public
2503
2659
  * <p>A list of custom vocabulary items that were
2504
2660
  * successfully updated during the operation.</p>
2505
2661
  */
@@ -2512,14 +2668,17 @@ export interface BatchUpdateCustomVocabularyItemResponse {
2512
2668
  */
2513
2669
  export interface BotAliasHistoryEvent {
2514
2670
  /**
2671
+ * @public
2515
2672
  * <p>The version of the bot that was used in the event. </p>
2516
2673
  */
2517
2674
  botVersion?: string;
2518
2675
  /**
2676
+ * @public
2519
2677
  * <p>The date and time that the event started.</p>
2520
2678
  */
2521
2679
  startDate?: Date;
2522
2680
  /**
2681
+ * @public
2523
2682
  * <p>The date and time that the event ended.</p>
2524
2683
  */
2525
2684
  endDate?: Date;
@@ -2531,10 +2690,12 @@ export interface BotAliasHistoryEvent {
2531
2690
  */
2532
2691
  export interface LambdaCodeHook {
2533
2692
  /**
2693
+ * @public
2534
2694
  * <p>The Amazon Resource Name (ARN) of the Lambda function.</p>
2535
2695
  */
2536
2696
  lambdaARN: string | undefined;
2537
2697
  /**
2698
+ * @public
2538
2699
  * <p>The version of the request-response that you want Amazon Lex to use to
2539
2700
  * invoke your Lambda function.</p>
2540
2701
  */
@@ -2547,6 +2708,7 @@ export interface LambdaCodeHook {
2547
2708
  */
2548
2709
  export interface CodeHookSpecification {
2549
2710
  /**
2711
+ * @public
2550
2712
  * <p>Specifies a Lambda function that verifies requests to a bot or
2551
2713
  * fulfills the user's request to a bot.</p>
2552
2714
  */
@@ -2559,11 +2721,13 @@ export interface CodeHookSpecification {
2559
2721
  */
2560
2722
  export interface BotAliasLocaleSettings {
2561
2723
  /**
2724
+ * @public
2562
2725
  * <p>Determines whether the locale is enabled for the bot. If the value
2563
2726
  * is <code>false</code>, the locale isn't available for use.</p>
2564
2727
  */
2565
2728
  enabled: boolean | undefined;
2566
2729
  /**
2730
+ * @public
2567
2731
  * <p>Specifies the Lambda function that should be used in the
2568
2732
  * locale.</p>
2569
2733
  */
@@ -2589,33 +2753,40 @@ export type BotAliasStatus = (typeof BotAliasStatus)[keyof typeof BotAliasStatus
2589
2753
  */
2590
2754
  export interface BotAliasSummary {
2591
2755
  /**
2756
+ * @public
2592
2757
  * <p>The unique identifier assigned to the bot alias. You can use this ID
2593
2758
  * to get detailed information about the alias using the <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBotAlias.html">DescribeBotAlias</a> operation.</p>
2594
2759
  */
2595
2760
  botAliasId?: string;
2596
2761
  /**
2762
+ * @public
2597
2763
  * <p>The name of the bot alias.</p>
2598
2764
  */
2599
2765
  botAliasName?: string;
2600
2766
  /**
2767
+ * @public
2601
2768
  * <p>The description of the bot alias.</p>
2602
2769
  */
2603
2770
  description?: string;
2604
2771
  /**
2772
+ * @public
2605
2773
  * <p>The version of the bot that the bot alias references.</p>
2606
2774
  */
2607
2775
  botVersion?: string;
2608
2776
  /**
2777
+ * @public
2609
2778
  * <p>The current state of the bot alias. If the status is
2610
2779
  * <code>Available</code>, the alias is ready for use.</p>
2611
2780
  */
2612
2781
  botAliasStatus?: BotAliasStatus | string;
2613
2782
  /**
2783
+ * @public
2614
2784
  * <p>A timestamp of the date and time that the bot alias was
2615
2785
  * created.</p>
2616
2786
  */
2617
2787
  creationDateTime?: Date;
2618
2788
  /**
2789
+ * @public
2619
2790
  * <p>A timestamp of the date and time that the bot alias was last
2620
2791
  * updated.</p>
2621
2792
  */
@@ -2627,14 +2798,17 @@ export interface BotAliasSummary {
2627
2798
  */
2628
2799
  export interface BotAliasTestExecutionTarget {
2629
2800
  /**
2801
+ * @public
2630
2802
  * <p>The bot Id of the bot alias used in the test set execution.</p>
2631
2803
  */
2632
2804
  botId: string | undefined;
2633
2805
  /**
2806
+ * @public
2634
2807
  * <p>The bot alias Id of the bot alias used in the test set execution.</p>
2635
2808
  */
2636
2809
  botAliasId: string | undefined;
2637
2810
  /**
2811
+ * @public
2638
2812
  * <p>The locale Id of the bot alias used in the test set execution.</p>
2639
2813
  */
2640
2814
  localeId: string | undefined;
@@ -2645,10 +2819,12 @@ export interface BotAliasTestExecutionTarget {
2645
2819
  */
2646
2820
  export interface BotExportSpecification {
2647
2821
  /**
2822
+ * @public
2648
2823
  * <p>The identifier of the bot assigned by Amazon Lex.</p>
2649
2824
  */
2650
2825
  botId: string | undefined;
2651
2826
  /**
2827
+ * @public
2652
2828
  * <p>The version of the bot that was exported. This will be either
2653
2829
  * <code>DRAFT</code> or the version number.</p>
2654
2830
  */
@@ -2686,14 +2862,17 @@ export type BotFilterOperator = (typeof BotFilterOperator)[keyof typeof BotFilte
2686
2862
  */
2687
2863
  export interface BotFilter {
2688
2864
  /**
2865
+ * @public
2689
2866
  * <p>The name of the field to filter the list of bots.</p>
2690
2867
  */
2691
2868
  name: BotFilterName | string | undefined;
2692
2869
  /**
2870
+ * @public
2693
2871
  * <p>The value to use for filtering the list of bots.</p>
2694
2872
  */
2695
2873
  values: string[] | undefined;
2696
2874
  /**
2875
+ * @public
2697
2876
  * <p>The operator to use for the filter. Specify <code>EQ</code> when the
2698
2877
  * <code>ListBots</code> operation should return only aliases that
2699
2878
  * equal the specified value. Specify <code>CO</code> when the
@@ -2711,6 +2890,7 @@ export interface BotFilter {
2711
2890
  */
2712
2891
  export interface DataPrivacy {
2713
2892
  /**
2893
+ * @public
2714
2894
  * <p>For each Amazon Lex bot created with the Amazon Lex Model Building Service,
2715
2895
  * you must specify whether your use of Amazon Lex is related to a website,
2716
2896
  * program, or other application that is directed or targeted, in whole or
@@ -2746,15 +2926,18 @@ export interface DataPrivacy {
2746
2926
  */
2747
2927
  export interface BotImportSpecification {
2748
2928
  /**
2929
+ * @public
2749
2930
  * <p>The name that Amazon Lex should use for the bot.</p>
2750
2931
  */
2751
2932
  botName: string | undefined;
2752
2933
  /**
2934
+ * @public
2753
2935
  * <p>The Amazon Resource Name (ARN) of the IAM role used to build and run
2754
2936
  * the bot.</p>
2755
2937
  */
2756
2938
  roleArn: string | undefined;
2757
2939
  /**
2940
+ * @public
2758
2941
  * <p>By default, data stored by Amazon Lex is encrypted. The
2759
2942
  * <code>DataPrivacy</code> structure provides settings that determine
2760
2943
  * how Amazon Lex handles special cases of securing the data for your bot.
@@ -2762,6 +2945,7 @@ export interface BotImportSpecification {
2762
2945
  */
2763
2946
  dataPrivacy: DataPrivacy | undefined;
2764
2947
  /**
2948
+ * @public
2765
2949
  * <p>The time, in seconds, that Amazon Lex should keep information about a
2766
2950
  * user's conversation with the bot. </p>
2767
2951
  * <p>A user interaction remains active for the amount of time specified.
@@ -2772,6 +2956,7 @@ export interface BotImportSpecification {
2772
2956
  */
2773
2957
  idleSessionTTLInSeconds?: number;
2774
2958
  /**
2959
+ * @public
2775
2960
  * <p>A list of tags to add to the bot. You can only add tags when you
2776
2961
  * import a bot. You can't use the <code>UpdateBot</code> operation to
2777
2962
  * update tags. To update tags, use the <code>TagResource</code>
@@ -2779,6 +2964,7 @@ export interface BotImportSpecification {
2779
2964
  */
2780
2965
  botTags?: Record<string, string>;
2781
2966
  /**
2967
+ * @public
2782
2968
  * <p>A list of tags to add to the test alias for a bot. You can only add
2783
2969
  * tags when you import a bot. You can't use the <code>UpdateAlias</code>
2784
2970
  * operation to update tags. To update tags on the test alias, use the
@@ -2793,14 +2979,17 @@ export interface BotImportSpecification {
2793
2979
  */
2794
2980
  export interface BotLocaleExportSpecification {
2795
2981
  /**
2982
+ * @public
2796
2983
  * <p>The identifier of the bot to create the locale for.</p>
2797
2984
  */
2798
2985
  botId: string | undefined;
2799
2986
  /**
2987
+ * @public
2800
2988
  * <p>The version of the bot to export.</p>
2801
2989
  */
2802
2990
  botVersion: string | undefined;
2803
2991
  /**
2992
+ * @public
2804
2993
  * <p>The identifier of the language and locale to export. The string must
2805
2994
  * match one of the locales in the bot.</p>
2806
2995
  */
@@ -2836,14 +3025,17 @@ export type BotLocaleFilterOperator = (typeof BotLocaleFilterOperator)[keyof typ
2836
3025
  */
2837
3026
  export interface BotLocaleFilter {
2838
3027
  /**
3028
+ * @public
2839
3029
  * <p>The name of the field to filter the list of bots.</p>
2840
3030
  */
2841
3031
  name: BotLocaleFilterName | string | undefined;
2842
3032
  /**
3033
+ * @public
2843
3034
  * <p>The value to use for filtering the list of bots.</p>
2844
3035
  */
2845
3036
  values: string[] | undefined;
2846
3037
  /**
3038
+ * @public
2847
3039
  * <p>The operator to use for the filter. Specify <code>EQ</code> when the
2848
3040
  * <code>ListBotLocales</code> operation should return only aliases
2849
3041
  * that equal the specified value. Specify <code>CO</code> when the
@@ -2859,10 +3051,12 @@ export interface BotLocaleFilter {
2859
3051
  */
2860
3052
  export interface BotLocaleHistoryEvent {
2861
3053
  /**
3054
+ * @public
2862
3055
  * <p>A description of the event that occurred.</p>
2863
3056
  */
2864
3057
  event: string | undefined;
2865
3058
  /**
3059
+ * @public
2866
3060
  * <p>A timestamp of the date and time that the event occurred.</p>
2867
3061
  */
2868
3062
  eventDate: Date | undefined;
@@ -2886,10 +3080,12 @@ export type VoiceEngine = (typeof VoiceEngine)[keyof typeof VoiceEngine];
2886
3080
  */
2887
3081
  export interface VoiceSettings {
2888
3082
  /**
3083
+ * @public
2889
3084
  * <p>The identifier of the Amazon Polly voice to use.</p>
2890
3085
  */
2891
3086
  voiceId: string | undefined;
2892
3087
  /**
3088
+ * @public
2893
3089
  * <p>Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the <a href="https://docs.aws.amazon.com/polly/latest/dg/API_SynthesizeSpeech.html#polly-SynthesizeSpeech-request-Engine">
2894
3090
  * <code>engine</code> parameter of the <code>SynthesizeSpeech</code> operation</a> in the <i>Amazon Polly developer guide</i>.</p>
2895
3091
  * <p>If you do not specify a value, the default is <code>standard</code>.</p>
@@ -2903,15 +3099,18 @@ export interface VoiceSettings {
2903
3099
  */
2904
3100
  export interface BotLocaleImportSpecification {
2905
3101
  /**
3102
+ * @public
2906
3103
  * <p>The identifier of the bot to import the locale to.</p>
2907
3104
  */
2908
3105
  botId: string | undefined;
2909
3106
  /**
3107
+ * @public
2910
3108
  * <p>The version of the bot to import the locale to. This can only be the
2911
3109
  * <code>DRAFT</code> version of the bot.</p>
2912
3110
  */
2913
3111
  botVersion: string | undefined;
2914
3112
  /**
3113
+ * @public
2915
3114
  * <p>The identifier of the language and locale that the bot will be used
2916
3115
  * in. The string must match one of the supported locales. All of the
2917
3116
  * intents, slot types, and slots used in the bot must have the same
@@ -2920,6 +3119,7 @@ export interface BotLocaleImportSpecification {
2920
3119
  */
2921
3120
  localeId: string | undefined;
2922
3121
  /**
3122
+ * @public
2923
3123
  * <p>Determines the threshold where Amazon Lex will insert the
2924
3124
  * <code>AMAZON.FallbackIntent</code>,
2925
3125
  * <code>AMAZON.KendraSearchIntent</code>, or both when returning
@@ -2956,6 +3156,7 @@ export interface BotLocaleImportSpecification {
2956
3156
  */
2957
3157
  nluIntentConfidenceThreshold?: number;
2958
3158
  /**
3159
+ * @public
2959
3160
  * <p>Defines settings for using an Amazon Polly voice to communicate with a
2960
3161
  * user.</p>
2961
3162
  */
@@ -2978,10 +3179,12 @@ export type BotLocaleSortAttribute = (typeof BotLocaleSortAttribute)[keyof typeo
2978
3179
  */
2979
3180
  export interface BotLocaleSortBy {
2980
3181
  /**
3182
+ * @public
2981
3183
  * <p>The bot locale attribute to sort by.</p>
2982
3184
  */
2983
3185
  attribute: BotLocaleSortAttribute | string | undefined;
2984
3186
  /**
3187
+ * @public
2985
3188
  * <p>Specifies whether to sort the bot locales in ascending or descending
2986
3189
  * order.</p>
2987
3190
  */
@@ -3012,28 +3215,34 @@ export type BotLocaleStatus = (typeof BotLocaleStatus)[keyof typeof BotLocaleSta
3012
3215
  */
3013
3216
  export interface BotLocaleSummary {
3014
3217
  /**
3218
+ * @public
3015
3219
  * <p>The language and locale of the bot locale.</p>
3016
3220
  */
3017
3221
  localeId?: string;
3018
3222
  /**
3223
+ * @public
3019
3224
  * <p>The name of the bot locale.</p>
3020
3225
  */
3021
3226
  localeName?: string;
3022
3227
  /**
3228
+ * @public
3023
3229
  * <p>The description of the bot locale.</p>
3024
3230
  */
3025
3231
  description?: string;
3026
3232
  /**
3233
+ * @public
3027
3234
  * <p>The current status of the bot locale. When the status is
3028
3235
  * <code>Built</code> the locale is ready for use.</p>
3029
3236
  */
3030
3237
  botLocaleStatus?: BotLocaleStatus | string;
3031
3238
  /**
3239
+ * @public
3032
3240
  * <p>A timestamp of the date and time that the bot locale was last
3033
3241
  * updated.</p>
3034
3242
  */
3035
3243
  lastUpdatedDateTime?: Date;
3036
3244
  /**
3245
+ * @public
3037
3246
  * <p>A timestamp of the date and time that the bot locale was last
3038
3247
  * built.</p>
3039
3248
  */
@@ -3045,22 +3254,27 @@ export interface BotLocaleSummary {
3045
3254
  */
3046
3255
  export interface BotMember {
3047
3256
  /**
3257
+ * @public
3048
3258
  * <p>The unique ID of a bot that is a member of this network of bots.</p>
3049
3259
  */
3050
3260
  botMemberId: string | undefined;
3051
3261
  /**
3262
+ * @public
3052
3263
  * <p>The unique name of a bot that is a member of this network of bots.</p>
3053
3264
  */
3054
3265
  botMemberName: string | undefined;
3055
3266
  /**
3267
+ * @public
3056
3268
  * <p>The alias ID of a bot that is a member of this network of bots.</p>
3057
3269
  */
3058
3270
  botMemberAliasId: string | undefined;
3059
3271
  /**
3272
+ * @public
3060
3273
  * <p>The alias name of a bot that is a member of this network of bots.</p>
3061
3274
  */
3062
3275
  botMemberAliasName: string | undefined;
3063
3276
  /**
3277
+ * @public
3064
3278
  * <p>The version of a bot that is a member of this network of bots.</p>
3065
3279
  */
3066
3280
  botMemberVersion: string | undefined;
@@ -3072,6 +3286,7 @@ export interface BotMember {
3072
3286
  */
3073
3287
  export interface IntentStatistics {
3074
3288
  /**
3289
+ * @public
3075
3290
  * <p>The number of recommended intents associated with the bot
3076
3291
  * recommendation.</p>
3077
3292
  */
@@ -3084,6 +3299,7 @@ export interface IntentStatistics {
3084
3299
  */
3085
3300
  export interface SlotTypeStatistics {
3086
3301
  /**
3302
+ * @public
3087
3303
  * <p>The number of recommended slot types associated with the bot
3088
3304
  * recommendation.</p>
3089
3305
  */
@@ -3095,11 +3311,13 @@ export interface SlotTypeStatistics {
3095
3311
  */
3096
3312
  export interface BotRecommendationResultStatistics {
3097
3313
  /**
3314
+ * @public
3098
3315
  * <p>Statistical information about about the intents associated with the
3099
3316
  * bot recommendation results.</p>
3100
3317
  */
3101
3318
  intents?: IntentStatistics;
3102
3319
  /**
3320
+ * @public
3103
3321
  * <p>Statistical information about the slot types associated with the bot
3104
3322
  * recommendation results.</p>
3105
3323
  */
@@ -3113,14 +3331,17 @@ export interface BotRecommendationResultStatistics {
3113
3331
  */
3114
3332
  export interface BotRecommendationResults {
3115
3333
  /**
3334
+ * @public
3116
3335
  * <p>The presigned URL link of the recommended bot definition.</p>
3117
3336
  */
3118
3337
  botLocaleExportUrl?: string;
3119
3338
  /**
3339
+ * @public
3120
3340
  * <p>The presigned url link of the associated transcript.</p>
3121
3341
  */
3122
3342
  associatedTranscriptsUrl?: string;
3123
3343
  /**
3344
+ * @public
3124
3345
  * <p>The statistical summary of the bot recommendation results.</p>
3125
3346
  */
3126
3347
  statistics?: BotRecommendationResultStatistics;
@@ -3150,22 +3371,26 @@ export type BotRecommendationStatus = (typeof BotRecommendationStatus)[keyof typ
3150
3371
  */
3151
3372
  export interface BotRecommendationSummary {
3152
3373
  /**
3374
+ * @public
3153
3375
  * <p>The status of the bot recommendation.</p>
3154
3376
  * <p>If the status is Failed, then the reasons for the failure are listed
3155
3377
  * in the failureReasons field. </p>
3156
3378
  */
3157
3379
  botRecommendationStatus: BotRecommendationStatus | string | undefined;
3158
3380
  /**
3381
+ * @public
3159
3382
  * <p>The unique identifier of the bot recommendation to be
3160
3383
  * updated.</p>
3161
3384
  */
3162
3385
  botRecommendationId: string | undefined;
3163
3386
  /**
3387
+ * @public
3164
3388
  * <p>A timestamp of the date and time that the bot recommendation was
3165
3389
  * created.</p>
3166
3390
  */
3167
3391
  creationDateTime?: Date;
3168
3392
  /**
3393
+ * @public
3169
3394
  * <p>A timestamp of the date and time that the bot recommendation was
3170
3395
  * last updated.</p>
3171
3396
  */
@@ -3188,10 +3413,12 @@ export type BotSortAttribute = (typeof BotSortAttribute)[keyof typeof BotSortAtt
3188
3413
  */
3189
3414
  export interface BotSortBy {
3190
3415
  /**
3416
+ * @public
3191
3417
  * <p>The attribute to use to sort the list of bots.</p>
3192
3418
  */
3193
3419
  attribute: BotSortAttribute | string | undefined;
3194
3420
  /**
3421
+ * @public
3195
3422
  * <p>The order to sort the list. You can choose ascending or
3196
3423
  * descending.</p>
3197
3424
  */
@@ -3233,32 +3460,39 @@ export type BotType = (typeof BotType)[keyof typeof BotType];
3233
3460
  */
3234
3461
  export interface BotSummary {
3235
3462
  /**
3463
+ * @public
3236
3464
  * <p>The unique identifier assigned to the bot. Use this ID to get
3237
3465
  * detailed information about the bot with the <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBot.html">DescribeBot</a> operation.</p>
3238
3466
  */
3239
3467
  botId?: string;
3240
3468
  /**
3469
+ * @public
3241
3470
  * <p>The name of the bot.</p>
3242
3471
  */
3243
3472
  botName?: string;
3244
3473
  /**
3474
+ * @public
3245
3475
  * <p>The description of the bot.</p>
3246
3476
  */
3247
3477
  description?: string;
3248
3478
  /**
3479
+ * @public
3249
3480
  * <p>The current status of the bot. When the status is
3250
3481
  * <code>Available</code> the bot is ready for use.</p>
3251
3482
  */
3252
3483
  botStatus?: BotStatus | string;
3253
3484
  /**
3485
+ * @public
3254
3486
  * <p>The latest numerical version in use for the bot.</p>
3255
3487
  */
3256
3488
  latestBotVersion?: string;
3257
3489
  /**
3490
+ * @public
3258
3491
  * <p>The date and time that the bot was last updated.</p>
3259
3492
  */
3260
3493
  lastUpdatedDateTime?: Date;
3261
3494
  /**
3495
+ * @public
3262
3496
  * <p>The type of the bot.</p>
3263
3497
  */
3264
3498
  botType?: BotType | string;
@@ -3269,6 +3503,7 @@ export interface BotSummary {
3269
3503
  */
3270
3504
  export interface BotVersionLocaleDetails {
3271
3505
  /**
3506
+ * @public
3272
3507
  * <p>The version of a bot used for a bot locale.</p>
3273
3508
  */
3274
3509
  sourceBotVersion: string | undefined;
@@ -3290,10 +3525,12 @@ export type BotVersionSortAttribute = (typeof BotVersionSortAttribute)[keyof typ
3290
3525
  */
3291
3526
  export interface BotVersionSortBy {
3292
3527
  /**
3528
+ * @public
3293
3529
  * <p>The attribute to use to sort the list of versions.</p>
3294
3530
  */
3295
3531
  attribute: BotVersionSortAttribute | string | undefined;
3296
3532
  /**
3533
+ * @public
3297
3534
  * <p>The order to sort the list. You can specify ascending or descending
3298
3535
  * order.</p>
3299
3536
  */
@@ -3305,24 +3542,29 @@ export interface BotVersionSortBy {
3305
3542
  */
3306
3543
  export interface BotVersionSummary {
3307
3544
  /**
3545
+ * @public
3308
3546
  * <p>The name of the bot associated with the version.</p>
3309
3547
  */
3310
3548
  botName?: string;
3311
3549
  /**
3550
+ * @public
3312
3551
  * <p>The numeric version of the bot, or <code>DRAFT</code> to indicate
3313
3552
  * that this is the version of the bot that can be updated..</p>
3314
3553
  */
3315
3554
  botVersion?: string;
3316
3555
  /**
3556
+ * @public
3317
3557
  * <p>The description of the version.</p>
3318
3558
  */
3319
3559
  description?: string;
3320
3560
  /**
3561
+ * @public
3321
3562
  * <p>The status of the bot. When the status is available, the version of
3322
3563
  * the bot is ready for use.</p>
3323
3564
  */
3324
3565
  botStatus?: BotStatus | string;
3325
3566
  /**
3567
+ * @public
3326
3568
  * <p>A timestamp of the date and time that the version was
3327
3569
  * created.</p>
3328
3570
  */
@@ -3333,16 +3575,19 @@ export interface BotVersionSummary {
3333
3575
  */
3334
3576
  export interface BuildBotLocaleRequest {
3335
3577
  /**
3578
+ * @public
3336
3579
  * <p>The identifier of the bot to build. The identifier is returned in
3337
3580
  * the response from the <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_CreateBot.html">CreateBot</a> operation.</p>
3338
3581
  */
3339
3582
  botId: string | undefined;
3340
3583
  /**
3584
+ * @public
3341
3585
  * <p>The version of the bot to build. This can only be the draft version
3342
3586
  * of the bot.</p>
3343
3587
  */
3344
3588
  botVersion: string | undefined;
3345
3589
  /**
3590
+ * @public
3346
3591
  * <p>The identifier of the language and locale that the bot will be used
3347
3592
  * in. The string must match one of the supported locales. All of the
3348
3593
  * intents, slot types, and slots used in the bot must have the same
@@ -3355,20 +3600,24 @@ export interface BuildBotLocaleRequest {
3355
3600
  */
3356
3601
  export interface BuildBotLocaleResponse {
3357
3602
  /**
3603
+ * @public
3358
3604
  * <p>The identifier of the specified bot.</p>
3359
3605
  */
3360
3606
  botId?: string;
3361
3607
  /**
3608
+ * @public
3362
3609
  * <p>The version of the bot that was built. This is only the draft
3363
3610
  * version of the bot.</p>
3364
3611
  */
3365
3612
  botVersion?: string;
3366
3613
  /**
3614
+ * @public
3367
3615
  * <p>The language and locale specified of where the bot can be
3368
3616
  * used.</p>
3369
3617
  */
3370
3618
  localeId?: string;
3371
3619
  /**
3620
+ * @public
3372
3621
  * <p>The bot's build status. When the status is
3373
3622
  * <code>ReadyExpressTesting</code> you can test the bot using the
3374
3623
  * utterances defined for the intents and slot types. When the status is
@@ -3377,6 +3626,7 @@ export interface BuildBotLocaleResponse {
3377
3626
  */
3378
3627
  botLocaleStatus?: BotLocaleStatus | string;
3379
3628
  /**
3629
+ * @public
3380
3630
  * <p>A timestamp indicating the date and time that the bot was last built
3381
3631
  * for this locale.</p>
3382
3632
  */
@@ -3427,10 +3677,12 @@ export type BuiltInIntentSortAttribute = (typeof BuiltInIntentSortAttribute)[key
3427
3677
  */
3428
3678
  export interface BuiltInIntentSortBy {
3429
3679
  /**
3680
+ * @public
3430
3681
  * <p>The attribute to use to sort the list of built-in intents.</p>
3431
3682
  */
3432
3683
  attribute: BuiltInIntentSortAttribute | string | undefined;
3433
3684
  /**
3685
+ * @public
3434
3686
  * <p>The order to sort the list. You can specify ascending or descending
3435
3687
  * order.</p>
3436
3688
  */
@@ -3442,11 +3694,13 @@ export interface BuiltInIntentSortBy {
3442
3694
  */
3443
3695
  export interface BuiltInIntentSummary {
3444
3696
  /**
3697
+ * @public
3445
3698
  * <p>The signature of the built-in intent. Use this to specify the parent
3446
3699
  * intent of a derived intent.</p>
3447
3700
  */
3448
3701
  intentSignature?: string;
3449
3702
  /**
3703
+ * @public
3450
3704
  * <p>The description of the intent.</p>
3451
3705
  */
3452
3706
  description?: string;
@@ -3469,10 +3723,12 @@ export type BuiltInSlotTypeSortAttribute = (typeof BuiltInSlotTypeSortAttribute)
3469
3723
  */
3470
3724
  export interface BuiltInSlotTypeSortBy {
3471
3725
  /**
3726
+ * @public
3472
3727
  * <p>The attribute to use to sort the list of built-in intents.</p>
3473
3728
  */
3474
3729
  attribute: BuiltInSlotTypeSortAttribute | string | undefined;
3475
3730
  /**
3731
+ * @public
3476
3732
  * <p>The order to sort the list. You can choose ascending or
3477
3733
  * descending.</p>
3478
3734
  */
@@ -3486,11 +3742,13 @@ export interface BuiltInSlotTypeSortBy {
3486
3742
  */
3487
3743
  export interface BuiltInSlotTypeSummary {
3488
3744
  /**
3745
+ * @public
3489
3746
  * <p>The signature of the built-in slot type. Use this to specify the
3490
3747
  * parent slot type of a derived slot type.</p>
3491
3748
  */
3492
3749
  slotTypeSignature?: string;
3493
3750
  /**
3751
+ * @public
3494
3752
  * <p>The description of the built-in slot type.</p>
3495
3753
  */
3496
3754
  description?: string;
@@ -3502,11 +3760,13 @@ export interface BuiltInSlotTypeSummary {
3502
3760
  */
3503
3761
  export interface Button {
3504
3762
  /**
3763
+ * @public
3505
3764
  * <p>The text that appears on the button. Use this to tell the user what
3506
3765
  * value is returned when they choose this button.</p>
3507
3766
  */
3508
3767
  text: string | undefined;
3509
3768
  /**
3769
+ * @public
3510
3770
  * <p>The value returned to Amazon Lex when the user chooses this button. This
3511
3771
  * must be one of the slot values configured for the slot.</p>
3512
3772
  */
@@ -3519,11 +3779,13 @@ export interface Button {
3519
3779
  */
3520
3780
  export interface CloudWatchLogGroupLogDestination {
3521
3781
  /**
3782
+ * @public
3522
3783
  * <p>The Amazon Resource Name (ARN) of the log group where text and
3523
3784
  * metadata logs are delivered.</p>
3524
3785
  */
3525
3786
  cloudWatchLogGroupArn: string | undefined;
3526
3787
  /**
3788
+ * @public
3527
3789
  * <p>The prefix of the log stream name within the log group that you
3528
3790
  * specified </p>
3529
3791
  */
@@ -3535,10 +3797,12 @@ export interface CloudWatchLogGroupLogDestination {
3535
3797
  */
3536
3798
  export interface SubSlotTypeComposition {
3537
3799
  /**
3800
+ * @public
3538
3801
  * <p>Name of a constituent sub slot inside a composite slot.</p>
3539
3802
  */
3540
3803
  name: string | undefined;
3541
3804
  /**
3805
+ * @public
3542
3806
  * <p>The unique identifier assigned to a slot type.
3543
3807
  * This refers to either a built-in slot type or the unique slotTypeId of a custom slot type.</p>
3544
3808
  */
@@ -3551,6 +3815,7 @@ export interface SubSlotTypeComposition {
3551
3815
  */
3552
3816
  export interface CompositeSlotTypeSetting {
3553
3817
  /**
3818
+ * @public
3554
3819
  * <p>Subslots in the composite slot.</p>
3555
3820
  */
3556
3821
  subSlots?: SubSlotTypeComposition[];
@@ -3561,6 +3826,7 @@ export interface CompositeSlotTypeSetting {
3561
3826
  */
3562
3827
  export interface Condition {
3563
3828
  /**
3829
+ * @public
3564
3830
  * <p>The expression string that is evaluated. </p>
3565
3831
  */
3566
3832
  expressionString: string | undefined;
@@ -3591,15 +3857,18 @@ export type DialogActionType = (typeof DialogActionType)[keyof typeof DialogActi
3591
3857
  */
3592
3858
  export interface DialogAction {
3593
3859
  /**
3860
+ * @public
3594
3861
  * <p>The action that the bot should execute. </p>
3595
3862
  */
3596
3863
  type: DialogActionType | string | undefined;
3597
3864
  /**
3865
+ * @public
3598
3866
  * <p>If the dialog action is <code>ElicitSlot</code>, defines the slot to
3599
3867
  * elicit from the user.</p>
3600
3868
  */
3601
3869
  slotToElicit?: string;
3602
3870
  /**
3871
+ * @public
3603
3872
  * <p>When true the next message for the intent is not used.</p>
3604
3873
  */
3605
3874
  suppressNextMessage?: boolean;
@@ -3622,6 +3891,7 @@ export type SlotShape = (typeof SlotShape)[keyof typeof SlotShape];
3622
3891
  */
3623
3892
  export interface SlotValue {
3624
3893
  /**
3894
+ * @public
3625
3895
  * <p>The value that Amazon Lex determines for the slot. The
3626
3896
  * actual value depends on the setting of the value selection strategy for
3627
3897
  * the bot. You can choose to use the value entered by the user, or you
@@ -3637,6 +3907,7 @@ export interface SlotValue {
3637
3907
  */
3638
3908
  export interface CustomPayload {
3639
3909
  /**
3910
+ * @public
3640
3911
  * <p>The string that is sent to your application.</p>
3641
3912
  */
3642
3913
  value: string | undefined;
@@ -3650,23 +3921,27 @@ export interface CustomPayload {
3650
3921
  */
3651
3922
  export interface ImageResponseCard {
3652
3923
  /**
3924
+ * @public
3653
3925
  * <p>The title to display on the response card. The format of the title
3654
3926
  * is determined by the platform displaying the response card.</p>
3655
3927
  */
3656
3928
  title: string | undefined;
3657
3929
  /**
3930
+ * @public
3658
3931
  * <p>The subtitle to display on the response card. The format of the
3659
3932
  * subtitle is determined by the platform displaying the response
3660
3933
  * card.</p>
3661
3934
  */
3662
3935
  subtitle?: string;
3663
3936
  /**
3937
+ * @public
3664
3938
  * <p>The URL of an image to display on the response card. The image URL
3665
3939
  * must be publicly available so that the platform displaying the response
3666
3940
  * card has access to the image.</p>
3667
3941
  */
3668
3942
  imageUrl?: string;
3669
3943
  /**
3944
+ * @public
3670
3945
  * <p>A list of buttons that should be displayed on the response card. The
3671
3946
  * arrangement of the buttons is determined by the platform that displays
3672
3947
  * the button.</p>
@@ -3679,6 +3954,7 @@ export interface ImageResponseCard {
3679
3954
  */
3680
3955
  export interface PlainTextMessage {
3681
3956
  /**
3957
+ * @public
3682
3958
  * <p>The message to send to the user.</p>
3683
3959
  */
3684
3960
  value: string | undefined;
@@ -3689,6 +3965,7 @@ export interface PlainTextMessage {
3689
3965
  */
3690
3966
  export interface SSMLMessage {
3691
3967
  /**
3968
+ * @public
3692
3969
  * <p>The SSML text that defines the prompt.</p>
3693
3970
  */
3694
3971
  value: string | undefined;
@@ -3699,19 +3976,23 @@ export interface SSMLMessage {
3699
3976
  */
3700
3977
  export interface Message {
3701
3978
  /**
3979
+ * @public
3702
3980
  * <p>A message in plain text format.</p>
3703
3981
  */
3704
3982
  plainTextMessage?: PlainTextMessage;
3705
3983
  /**
3984
+ * @public
3706
3985
  * <p>A message in a custom format defined by the client
3707
3986
  * application.</p>
3708
3987
  */
3709
3988
  customPayload?: CustomPayload;
3710
3989
  /**
3990
+ * @public
3711
3991
  * <p>A message in Speech Synthesis Markup Language (SSML).</p>
3712
3992
  */
3713
3993
  ssmlMessage?: SSMLMessage;
3714
3994
  /**
3995
+ * @public
3715
3996
  * <p>A message that defines a response card that the client application
3716
3997
  * can show to the user.</p>
3717
3998
  */
@@ -3724,10 +4005,12 @@ export interface Message {
3724
4005
  */
3725
4006
  export interface MessageGroup {
3726
4007
  /**
4008
+ * @public
3727
4009
  * <p>The primary message that Amazon Lex should send to the user.</p>
3728
4010
  */
3729
4011
  message: Message | undefined;
3730
4012
  /**
4013
+ * @public
3731
4014
  * <p>Message variations to send to the user. When variations are defined,
3732
4015
  * Amazon Lex chooses the primary message or one of the variations to send to
3733
4016
  * the user.</p>
@@ -3741,11 +4024,13 @@ export interface MessageGroup {
3741
4024
  */
3742
4025
  export interface ResponseSpecification {
3743
4026
  /**
4027
+ * @public
3744
4028
  * <p>A collection of responses that Amazon Lex can send to the user. Amazon Lex
3745
4029
  * chooses the actual response to send at runtime.</p>
3746
4030
  */
3747
4031
  messageGroups: MessageGroup[] | undefined;
3748
4032
  /**
4033
+ * @public
3749
4034
  * <p>Indicates whether the user can interrupt a speech response from
3750
4035
  * Amazon Lex.</p>
3751
4036
  */
@@ -3783,10 +4068,12 @@ export type TestResultMatchStatus = (typeof TestResultMatchStatus)[keyof typeof
3783
4068
  */
3784
4069
  export interface ConversationLevelIntentClassificationResultItem {
3785
4070
  /**
4071
+ * @public
3786
4072
  * <p>The intent name used in the evaluation of intent level success or failure.</p>
3787
4073
  */
3788
4074
  intentName: string | undefined;
3789
4075
  /**
4076
+ * @public
3790
4077
  * <p>The number of times the specific intent is used in the evaluation of intent level
3791
4078
  * success or failure.</p>
3792
4079
  */
@@ -3798,10 +4085,12 @@ export interface ConversationLevelIntentClassificationResultItem {
3798
4085
  */
3799
4086
  export interface ConversationLevelResultDetail {
3800
4087
  /**
4088
+ * @public
3801
4089
  * <p>The success or failure of the streaming of the conversation.</p>
3802
4090
  */
3803
4091
  endToEndResult: TestResultMatchStatus | string | undefined;
3804
4092
  /**
4093
+ * @public
3805
4094
  * <p>The speech transcription success or failure details of the conversation.</p>
3806
4095
  */
3807
4096
  speechTranscriptionResult?: TestResultMatchStatus | string;
@@ -3812,14 +4101,17 @@ export interface ConversationLevelResultDetail {
3812
4101
  */
3813
4102
  export interface ConversationLevelSlotResolutionResultItem {
3814
4103
  /**
4104
+ * @public
3815
4105
  * <p>The intents used in the slots list for the slot resolution details.</p>
3816
4106
  */
3817
4107
  intentName: string | undefined;
3818
4108
  /**
4109
+ * @public
3819
4110
  * <p>The slot name in the slots list for the slot resolution details.</p>
3820
4111
  */
3821
4112
  slotName: string | undefined;
3822
4113
  /**
4114
+ * @public
3823
4115
  * <p>The number of matching slots used in the slots listings for the slot resolution evaluation.</p>
3824
4116
  */
3825
4117
  matchResult: TestResultMatchStatus | string | undefined;
@@ -3830,22 +4122,27 @@ export interface ConversationLevelSlotResolutionResultItem {
3830
4122
  */
3831
4123
  export interface ConversationLevelTestResultItem {
3832
4124
  /**
4125
+ * @public
3833
4126
  * <p>The conversation Id of the test result evaluation item.</p>
3834
4127
  */
3835
4128
  conversationId: string | undefined;
3836
4129
  /**
4130
+ * @public
3837
4131
  * <p>The end-to-end success or failure of the test result evaluation item.</p>
3838
4132
  */
3839
4133
  endToEndResult: TestResultMatchStatus | string | undefined;
3840
4134
  /**
4135
+ * @public
3841
4136
  * <p>The speech transcription success or failure of the test result evaluation item.</p>
3842
4137
  */
3843
4138
  speechTranscriptionResult?: TestResultMatchStatus | string;
3844
4139
  /**
4140
+ * @public
3845
4141
  * <p>The intent classification of the test result evaluation item.</p>
3846
4142
  */
3847
4143
  intentClassificationResults: ConversationLevelIntentClassificationResultItem[] | undefined;
3848
4144
  /**
4145
+ * @public
3849
4146
  * <p>The slot success or failure of the test result evaluation item.</p>
3850
4147
  */
3851
4148
  slotResolutionResults: ConversationLevelSlotResolutionResultItem[] | undefined;
@@ -3856,6 +4153,7 @@ export interface ConversationLevelTestResultItem {
3856
4153
  */
3857
4154
  export interface ConversationLevelTestResults {
3858
4155
  /**
4156
+ * @public
3859
4157
  * <p>The item list in the test set results data at the conversation level.</p>
3860
4158
  */
3861
4159
  items: ConversationLevelTestResultItem[] | undefined;
@@ -3866,6 +4164,7 @@ export interface ConversationLevelTestResults {
3866
4164
  */
3867
4165
  export interface ConversationLevelTestResultsFilterBy {
3868
4166
  /**
4167
+ * @public
3869
4168
  * <p>The selection of matched or mismatched end-to-end status to filter test set results data
3870
4169
  * at the conversation level.</p>
3871
4170
  */
@@ -3889,14 +4188,17 @@ export type ConversationLogsInputModeFilter = (typeof ConversationLogsInputModeF
3889
4188
  */
3890
4189
  export interface ConversationLogsDataSourceFilterBy {
3891
4190
  /**
4191
+ * @public
3892
4192
  * <p>The start time for the conversation log.</p>
3893
4193
  */
3894
4194
  startTime: Date | undefined;
3895
4195
  /**
4196
+ * @public
3896
4197
  * <p>The end time for the conversation log.</p>
3897
4198
  */
3898
4199
  endTime: Date | undefined;
3899
4200
  /**
4201
+ * @public
3900
4202
  * <p>The selection to filter by input mode for the conversation logs. </p>
3901
4203
  */
3902
4204
  inputMode: ConversationLogsInputModeFilter | string | undefined;
@@ -3907,18 +4209,22 @@ export interface ConversationLogsDataSourceFilterBy {
3907
4209
  */
3908
4210
  export interface ConversationLogsDataSource {
3909
4211
  /**
4212
+ * @public
3910
4213
  * <p>The bot Id from the conversation logs.</p>
3911
4214
  */
3912
4215
  botId: string | undefined;
3913
4216
  /**
4217
+ * @public
3914
4218
  * <p>The bot alias Id from the conversation logs.</p>
3915
4219
  */
3916
4220
  botAliasId: string | undefined;
3917
4221
  /**
4222
+ * @public
3918
4223
  * <p>The locale Id of the conversation log.</p>
3919
4224
  */
3920
4225
  localeId: string | undefined;
3921
4226
  /**
4227
+ * @public
3922
4228
  * <p>The filter for the data source of the conversation log.</p>
3923
4229
  */
3924
4230
  filter: ConversationLogsDataSourceFilterBy | undefined;
@@ -3930,6 +4236,7 @@ export interface ConversationLogsDataSource {
3930
4236
  */
3931
4237
  export interface TextLogDestination {
3932
4238
  /**
4239
+ * @public
3933
4240
  * <p>Defines the Amazon CloudWatch Logs log group where text and metadata logs are
3934
4241
  * delivered.</p>
3935
4242
  */
@@ -3941,11 +4248,13 @@ export interface TextLogDestination {
3941
4248
  */
3942
4249
  export interface TextLogSetting {
3943
4250
  /**
4251
+ * @public
3944
4252
  * <p>Determines whether conversation logs should be stored for an
3945
4253
  * alias.</p>
3946
4254
  */
3947
4255
  enabled: boolean | undefined;
3948
4256
  /**
4257
+ * @public
3949
4258
  * <p>Defines the Amazon CloudWatch Logs destination log group for
3950
4259
  * conversation text logs.</p>
3951
4260
  */
@@ -3958,10 +4267,12 @@ export interface TextLogSetting {
3958
4267
  */
3959
4268
  export interface ConversationLogSettings {
3960
4269
  /**
4270
+ * @public
3961
4271
  * <p>The Amazon CloudWatch Logs settings for logging text and metadata.</p>
3962
4272
  */
3963
4273
  textLogSettings?: TextLogSetting[];
3964
4274
  /**
4275
+ * @public
3965
4276
  * <p>The Amazon S3 settings for logging audio to an S3 bucket.</p>
3966
4277
  */
3967
4278
  audioLogSettings?: AudioLogSetting[];
@@ -3971,26 +4282,31 @@ export interface ConversationLogSettings {
3971
4282
  */
3972
4283
  export interface CreateBotRequest {
3973
4284
  /**
4285
+ * @public
3974
4286
  * <p>The name of the bot. The bot name must be unique in the account that
3975
4287
  * creates the bot.</p>
3976
4288
  */
3977
4289
  botName: string | undefined;
3978
4290
  /**
4291
+ * @public
3979
4292
  * <p>A description of the bot. It appears in lists to help you identify a
3980
4293
  * particular bot.</p>
3981
4294
  */
3982
4295
  description?: string;
3983
4296
  /**
4297
+ * @public
3984
4298
  * <p>The Amazon Resource Name (ARN) of an IAM role that has permission to
3985
4299
  * access the bot.</p>
3986
4300
  */
3987
4301
  roleArn: string | undefined;
3988
4302
  /**
4303
+ * @public
3989
4304
  * <p>Provides information on additional privacy protections Amazon Lex should
3990
4305
  * use with the bot's data.</p>
3991
4306
  */
3992
4307
  dataPrivacy: DataPrivacy | undefined;
3993
4308
  /**
4309
+ * @public
3994
4310
  * <p>The time, in seconds, that Amazon Lex should keep information about a
3995
4311
  * user's conversation with the bot. </p>
3996
4312
  * <p>A user interaction remains active for the amount of time specified.
@@ -4001,6 +4317,7 @@ export interface CreateBotRequest {
4001
4317
  */
4002
4318
  idleSessionTTLInSeconds: number | undefined;
4003
4319
  /**
4320
+ * @public
4004
4321
  * <p>A list of tags to add to the bot. You can only add tags when you
4005
4322
  * create a bot. You can't use the <code>UpdateBot</code> operation to
4006
4323
  * update tags. To update tags, use the <code>TagResource</code>
@@ -4008,6 +4325,7 @@ export interface CreateBotRequest {
4008
4325
  */
4009
4326
  botTags?: Record<string, string>;
4010
4327
  /**
4328
+ * @public
4011
4329
  * <p>A list of tags to add to the test alias for a bot. You can only add
4012
4330
  * tags when you create a bot. You can't use the <code>UpdateAlias</code>
4013
4331
  * operation to update tags. To update tags on the test alias, use the
@@ -4015,10 +4333,12 @@ export interface CreateBotRequest {
4015
4333
  */
4016
4334
  testBotAliasTags?: Record<string, string>;
4017
4335
  /**
4336
+ * @public
4018
4337
  * <p>The type of a bot to create.</p>
4019
4338
  */
4020
4339
  botType?: BotType | string;
4021
4340
  /**
4341
+ * @public
4022
4342
  * <p>The list of bot members in a network to be created.</p>
4023
4343
  */
4024
4344
  botMembers?: BotMember[];
@@ -4028,31 +4348,38 @@ export interface CreateBotRequest {
4028
4348
  */
4029
4349
  export interface CreateBotResponse {
4030
4350
  /**
4351
+ * @public
4031
4352
  * <p>A unique identifier for a particular bot. You use this to identify
4032
4353
  * the bot when you call other Amazon Lex API operations.</p>
4033
4354
  */
4034
4355
  botId?: string;
4035
4356
  /**
4357
+ * @public
4036
4358
  * <p>The name specified for the bot.</p>
4037
4359
  */
4038
4360
  botName?: string;
4039
4361
  /**
4362
+ * @public
4040
4363
  * <p>The description specified for the bot.</p>
4041
4364
  */
4042
4365
  description?: string;
4043
4366
  /**
4367
+ * @public
4044
4368
  * <p>The IAM role specified for the bot.</p>
4045
4369
  */
4046
4370
  roleArn?: string;
4047
4371
  /**
4372
+ * @public
4048
4373
  * <p>The data privacy settings specified for the bot.</p>
4049
4374
  */
4050
4375
  dataPrivacy?: DataPrivacy;
4051
4376
  /**
4377
+ * @public
4052
4378
  * <p>The session idle time specified for the bot.</p>
4053
4379
  */
4054
4380
  idleSessionTTLInSeconds?: number;
4055
4381
  /**
4382
+ * @public
4056
4383
  * <p>Shows the current status of the bot. The bot is first in the
4057
4384
  * <code>Creating</code> status. Once the bot is read for use, it
4058
4385
  * changes to the <code>Available</code> status. After the bot is created,
@@ -4060,23 +4387,28 @@ export interface CreateBotResponse {
4060
4387
  */
4061
4388
  botStatus?: BotStatus | string;
4062
4389
  /**
4390
+ * @public
4063
4391
  * <p>A timestamp indicating the date and time that the bot was
4064
4392
  * created.</p>
4065
4393
  */
4066
4394
  creationDateTime?: Date;
4067
4395
  /**
4396
+ * @public
4068
4397
  * <p>A list of tags associated with the bot.</p>
4069
4398
  */
4070
4399
  botTags?: Record<string, string>;
4071
4400
  /**
4401
+ * @public
4072
4402
  * <p>A list of tags associated with the test alias for the bot.</p>
4073
4403
  */
4074
4404
  testBotAliasTags?: Record<string, string>;
4075
4405
  /**
4406
+ * @public
4076
4407
  * <p>The type of a bot that was created.</p>
4077
4408
  */
4078
4409
  botType?: BotType | string;
4079
4410
  /**
4411
+ * @public
4080
4412
  * <p>The list of bots in a network that was created.</p>
4081
4413
  */
4082
4414
  botMembers?: BotMember[];
@@ -4088,6 +4420,7 @@ export interface CreateBotResponse {
4088
4420
  */
4089
4421
  export interface SentimentAnalysisSettings {
4090
4422
  /**
4423
+ * @public
4091
4424
  * <p>Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user
4092
4425
  * utterances.</p>
4093
4426
  */
@@ -4098,27 +4431,32 @@ export interface SentimentAnalysisSettings {
4098
4431
  */
4099
4432
  export interface CreateBotAliasRequest {
4100
4433
  /**
4434
+ * @public
4101
4435
  * <p>The alias to create. The name must be unique for the bot.</p>
4102
4436
  */
4103
4437
  botAliasName: string | undefined;
4104
4438
  /**
4439
+ * @public
4105
4440
  * <p>A description of the alias. Use this description to help identify
4106
4441
  * the alias.</p>
4107
4442
  */
4108
4443
  description?: string;
4109
4444
  /**
4445
+ * @public
4110
4446
  * <p>The version of the bot that this alias points to. You can use the
4111
4447
  * <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_UpdateBotAlias.html">UpdateBotAlias</a> operation to change the
4112
4448
  * bot version associated with the alias.</p>
4113
4449
  */
4114
4450
  botVersion?: string;
4115
4451
  /**
4452
+ * @public
4116
4453
  * <p>Maps configuration information to a specific locale. You can use
4117
4454
  * this parameter to specify a specific Lambda function to run different
4118
4455
  * functions in different locales.</p>
4119
4456
  */
4120
4457
  botAliasLocaleSettings?: Record<string, BotAliasLocaleSettings>;
4121
4458
  /**
4459
+ * @public
4122
4460
  * <p>Specifies whether Amazon Lex logs text and audio for a conversation with
4123
4461
  * the bot. When you enable conversation logs, text logs store text input,
4124
4462
  * transcripts of audio input, and associated metadata in Amazon CloudWatch Logs. Audio
@@ -4126,15 +4464,18 @@ export interface CreateBotAliasRequest {
4126
4464
  */
4127
4465
  conversationLogSettings?: ConversationLogSettings;
4128
4466
  /**
4467
+ * @public
4129
4468
  * <p>Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of
4130
4469
  * user utterances.</p>
4131
4470
  */
4132
4471
  sentimentAnalysisSettings?: SentimentAnalysisSettings;
4133
4472
  /**
4473
+ * @public
4134
4474
  * <p>The unique identifier of the bot that the alias applies to.</p>
4135
4475
  */
4136
4476
  botId: string | undefined;
4137
4477
  /**
4478
+ * @public
4138
4479
  * <p>A list of tags to add to the bot alias. You can only add tags when
4139
4480
  * you create an alias, you can't use the <code>UpdateBotAlias</code>
4140
4481
  * operation to update the tags on a bot alias. To update tags, use the
@@ -4147,35 +4488,43 @@ export interface CreateBotAliasRequest {
4147
4488
  */
4148
4489
  export interface CreateBotAliasResponse {
4149
4490
  /**
4491
+ * @public
4150
4492
  * <p>The unique identifier of the bot alias.</p>
4151
4493
  */
4152
4494
  botAliasId?: string;
4153
4495
  /**
4496
+ * @public
4154
4497
  * <p>The name specified for the bot alias.</p>
4155
4498
  */
4156
4499
  botAliasName?: string;
4157
4500
  /**
4501
+ * @public
4158
4502
  * <p>The description specified for the bot alias.</p>
4159
4503
  */
4160
4504
  description?: string;
4161
4505
  /**
4506
+ * @public
4162
4507
  * <p>The version of the bot associated with this alias.</p>
4163
4508
  */
4164
4509
  botVersion?: string;
4165
4510
  /**
4511
+ * @public
4166
4512
  * <p>Configuration information for a specific locale.</p>
4167
4513
  */
4168
4514
  botAliasLocaleSettings?: Record<string, BotAliasLocaleSettings>;
4169
4515
  /**
4516
+ * @public
4170
4517
  * <p>The conversation log settings specified for the alias.</p>
4171
4518
  */
4172
4519
  conversationLogSettings?: ConversationLogSettings;
4173
4520
  /**
4521
+ * @public
4174
4522
  * <p>Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of
4175
4523
  * user utterances.</p>
4176
4524
  */
4177
4525
  sentimentAnalysisSettings?: SentimentAnalysisSettings;
4178
4526
  /**
4527
+ * @public
4179
4528
  * <p>The current status of the alias. The alias is first put into the
4180
4529
  * <code>Creating</code> state. When the alias is ready to be used, it
4181
4530
  * is put into the <code>Available</code> state. You can use the
@@ -4184,15 +4533,18 @@ export interface CreateBotAliasResponse {
4184
4533
  */
4185
4534
  botAliasStatus?: BotAliasStatus | string;
4186
4535
  /**
4536
+ * @public
4187
4537
  * <p>The unique identifier of the bot that this alias applies to.</p>
4188
4538
  */
4189
4539
  botId?: string;
4190
4540
  /**
4541
+ * @public
4191
4542
  * <p>A Unix timestamp indicating the date and time that the bot alias was
4192
4543
  * created.</p>
4193
4544
  */
4194
4545
  creationDateTime?: Date;
4195
4546
  /**
4547
+ * @public
4196
4548
  * <p>A list of tags associated with the bot alias.</p>
4197
4549
  */
4198
4550
  tags?: Record<string, string>;
@@ -4202,15 +4554,18 @@ export interface CreateBotAliasResponse {
4202
4554
  */
4203
4555
  export interface CreateBotLocaleRequest {
4204
4556
  /**
4557
+ * @public
4205
4558
  * <p>The identifier of the bot to create the locale for.</p>
4206
4559
  */
4207
4560
  botId: string | undefined;
4208
4561
  /**
4562
+ * @public
4209
4563
  * <p>The version of the bot to create the locale for. This can only be
4210
4564
  * the draft version of the bot.</p>
4211
4565
  */
4212
4566
  botVersion: string | undefined;
4213
4567
  /**
4568
+ * @public
4214
4569
  * <p>The identifier of the language and locale that the bot will be used
4215
4570
  * in. The string must match one of the supported locales. All of the
4216
4571
  * intents, slot types, and slots used in the bot must have the same
@@ -4218,11 +4573,13 @@ export interface CreateBotLocaleRequest {
4218
4573
  */
4219
4574
  localeId: string | undefined;
4220
4575
  /**
4576
+ * @public
4221
4577
  * <p>A description of the bot locale. Use this to help identify the bot
4222
4578
  * locale in lists.</p>
4223
4579
  */
4224
4580
  description?: string;
4225
4581
  /**
4582
+ * @public
4226
4583
  * <p>Determines the threshold where Amazon Lex will insert the
4227
4584
  * <code>AMAZON.FallbackIntent</code>,
4228
4585
  * <code>AMAZON.KendraSearchIntent</code>, or both when returning
@@ -4251,6 +4608,7 @@ export interface CreateBotLocaleRequest {
4251
4608
  */
4252
4609
  nluIntentConfidenceThreshold: number | undefined;
4253
4610
  /**
4611
+ * @public
4254
4612
  * <p>The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the
4255
4613
  * user.</p>
4256
4614
  */
@@ -4261,37 +4619,45 @@ export interface CreateBotLocaleRequest {
4261
4619
  */
4262
4620
  export interface CreateBotLocaleResponse {
4263
4621
  /**
4622
+ * @public
4264
4623
  * <p>The specified bot identifier.</p>
4265
4624
  */
4266
4625
  botId?: string;
4267
4626
  /**
4627
+ * @public
4268
4628
  * <p>The specified bot version.</p>
4269
4629
  */
4270
4630
  botVersion?: string;
4271
4631
  /**
4632
+ * @public
4272
4633
  * <p>The specified locale name.</p>
4273
4634
  */
4274
4635
  localeName?: string;
4275
4636
  /**
4637
+ * @public
4276
4638
  * <p>The specified locale identifier.</p>
4277
4639
  */
4278
4640
  localeId?: string;
4279
4641
  /**
4642
+ * @public
4280
4643
  * <p>The specified description of the bot locale.</p>
4281
4644
  */
4282
4645
  description?: string;
4283
4646
  /**
4647
+ * @public
4284
4648
  * <p>The specified confidence threshold for inserting the
4285
4649
  * <code>AMAZON.FallbackIntent</code> and
4286
4650
  * <code>AMAZON.KendraSearchIntent</code> intents.</p>
4287
4651
  */
4288
4652
  nluIntentConfidenceThreshold?: number;
4289
4653
  /**
4654
+ * @public
4290
4655
  * <p>The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the
4291
4656
  * user.</p>
4292
4657
  */
4293
4658
  voiceSettings?: VoiceSettings;
4294
4659
  /**
4660
+ * @public
4295
4661
  * <p>The status of the bot.</p>
4296
4662
  * <p>When the status is <code>Creating</code> the bot locale is being
4297
4663
  * configured. When the status is <code>Building</code> Amazon Lex is building
@@ -4306,6 +4672,7 @@ export interface CreateBotLocaleResponse {
4306
4672
  */
4307
4673
  botLocaleStatus?: BotLocaleStatus | string;
4308
4674
  /**
4675
+ * @public
4309
4676
  * <p>A timestamp specifying the date and time that the bot locale was
4310
4677
  * created.</p>
4311
4678
  */
@@ -4316,15 +4683,18 @@ export interface CreateBotLocaleResponse {
4316
4683
  */
4317
4684
  export interface CreateBotVersionRequest {
4318
4685
  /**
4686
+ * @public
4319
4687
  * <p>The identifier of the bot to create the version for.</p>
4320
4688
  */
4321
4689
  botId: string | undefined;
4322
4690
  /**
4691
+ * @public
4323
4692
  * <p>A description of the version. Use the description to help identify
4324
4693
  * the version in lists.</p>
4325
4694
  */
4326
4695
  description?: string;
4327
4696
  /**
4697
+ * @public
4328
4698
  * <p>Specifies the locales that Amazon Lex adds to this version. You can
4329
4699
  * choose the <code>Draft</code> version or any other previously published
4330
4700
  * version for each locale. When you specify a source version, the locale
@@ -4337,22 +4707,27 @@ export interface CreateBotVersionRequest {
4337
4707
  */
4338
4708
  export interface CreateBotVersionResponse {
4339
4709
  /**
4710
+ * @public
4340
4711
  * <p>The bot identifier specified in the request.</p>
4341
4712
  */
4342
4713
  botId?: string;
4343
4714
  /**
4715
+ * @public
4344
4716
  * <p>The description of the version specified in the request.</p>
4345
4717
  */
4346
4718
  description?: string;
4347
4719
  /**
4720
+ * @public
4348
4721
  * <p>The version number assigned to the version.</p>
4349
4722
  */
4350
4723
  botVersion?: string;
4351
4724
  /**
4725
+ * @public
4352
4726
  * <p>The source versions used for each locale in the new version.</p>
4353
4727
  */
4354
4728
  botVersionLocaleSpecification?: Record<string, BotVersionLocaleDetails>;
4355
4729
  /**
4730
+ * @public
4356
4731
  * <p>When you send a request to create or update a bot, Amazon Lex sets the
4357
4732
  * status response element to <code>Creating</code>. After Amazon Lex builds
4358
4733
  * the bot, it sets status to <code>Available</code>. If Amazon Lex can't build
@@ -4360,6 +4735,7 @@ export interface CreateBotVersionResponse {
4360
4735
  */
4361
4736
  botStatus?: BotStatus | string;
4362
4737
  /**
4738
+ * @public
4363
4739
  * <p>A timestamp of the date and time that the version was
4364
4740
  * created.</p>
4365
4741
  */
@@ -4384,14 +4760,17 @@ export type ImportExportFileFormat = (typeof ImportExportFileFormat)[keyof typeo
4384
4760
  */
4385
4761
  export interface CustomVocabularyExportSpecification {
4386
4762
  /**
4763
+ * @public
4387
4764
  * <p>The identifier of the bot that contains the custom vocabulary to export.</p>
4388
4765
  */
4389
4766
  botId: string | undefined;
4390
4767
  /**
4768
+ * @public
4391
4769
  * <p>The version of the bot that contains the custom vocabulary to export.</p>
4392
4770
  */
4393
4771
  botVersion: string | undefined;
4394
4772
  /**
4773
+ * @public
4395
4774
  * <p>The locale of the bot that contains the custom vocabulary to export.</p>
4396
4775
  */
4397
4776
  localeId: string | undefined;
@@ -4402,6 +4781,7 @@ export interface CustomVocabularyExportSpecification {
4402
4781
  */
4403
4782
  export interface TestSetExportSpecification {
4404
4783
  /**
4784
+ * @public
4405
4785
  * <p>The unique identifier of the test set.</p>
4406
4786
  */
4407
4787
  testSetId: string | undefined;
@@ -4414,18 +4794,22 @@ export interface TestSetExportSpecification {
4414
4794
  */
4415
4795
  export interface ExportResourceSpecification {
4416
4796
  /**
4797
+ * @public
4417
4798
  * <p>Parameters for exporting a bot.</p>
4418
4799
  */
4419
4800
  botExportSpecification?: BotExportSpecification;
4420
4801
  /**
4802
+ * @public
4421
4803
  * <p>Parameters for exporting a bot locale.</p>
4422
4804
  */
4423
4805
  botLocaleExportSpecification?: BotLocaleExportSpecification;
4424
4806
  /**
4807
+ * @public
4425
4808
  * <p>The parameters required to export a custom vocabulary.</p>
4426
4809
  */
4427
4810
  customVocabularyExportSpecification?: CustomVocabularyExportSpecification;
4428
4811
  /**
4812
+ * @public
4429
4813
  * <p>Specifications for the test set that is exported as a resource.</p>
4430
4814
  */
4431
4815
  testSetExportSpecification?: TestSetExportSpecification;
@@ -4435,15 +4819,18 @@ export interface ExportResourceSpecification {
4435
4819
  */
4436
4820
  export interface CreateExportRequest {
4437
4821
  /**
4822
+ * @public
4438
4823
  * <p>Specifies the type of resource to export, either a bot or a bot
4439
4824
  * locale. You can only specify one type of resource to export.</p>
4440
4825
  */
4441
4826
  resourceSpecification: ExportResourceSpecification | undefined;
4442
4827
  /**
4828
+ * @public
4443
4829
  * <p>The file format of the bot or bot locale definition files.</p>
4444
4830
  */
4445
4831
  fileFormat: ImportExportFileFormat | string | undefined;
4446
4832
  /**
4833
+ * @public
4447
4834
  * <p>An password to use to encrypt the exported archive. Using a password
4448
4835
  * is optional, but you should encrypt the archive to protect the data in
4449
4836
  * transit between Amazon Lex and your local computer.</p>
@@ -4469,26 +4856,31 @@ export type ExportStatus = (typeof ExportStatus)[keyof typeof ExportStatus];
4469
4856
  */
4470
4857
  export interface CreateExportResponse {
4471
4858
  /**
4859
+ * @public
4472
4860
  * <p>An identifier for a specific request to create an export.</p>
4473
4861
  */
4474
4862
  exportId?: string;
4475
4863
  /**
4864
+ * @public
4476
4865
  * <p>A description of the type of resource that was exported, either a
4477
4866
  * bot or a bot locale.</p>
4478
4867
  */
4479
4868
  resourceSpecification?: ExportResourceSpecification;
4480
4869
  /**
4870
+ * @public
4481
4871
  * <p>The file format used for the bot or bot locale definition
4482
4872
  * files.</p>
4483
4873
  */
4484
4874
  fileFormat?: ImportExportFileFormat | string;
4485
4875
  /**
4876
+ * @public
4486
4877
  * <p>The status of the export. When the status is <code>Completed</code>,
4487
4878
  * you can use the <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeExport.html">DescribeExport</a> operation to get the
4488
4879
  * pre-signed S3 URL link to your exported bot or bot locale.</p>
4489
4880
  */
4490
4881
  exportStatus?: ExportStatus | string;
4491
4882
  /**
4883
+ * @public
4492
4884
  * <p>The date and time that the request to export a bot was
4493
4885
  * created.</p>
4494
4886
  */
@@ -4501,6 +4893,7 @@ export interface CreateExportResponse {
4501
4893
  */
4502
4894
  export interface DialogCodeHookSettings {
4503
4895
  /**
4896
+ * @public
4504
4897
  * <p>Enables the dialog code hook so that it processes user
4505
4898
  * requests.</p>
4506
4899
  */
@@ -4513,17 +4906,20 @@ export interface DialogCodeHookSettings {
4513
4906
  */
4514
4907
  export interface FulfillmentStartResponseSpecification {
4515
4908
  /**
4909
+ * @public
4516
4910
  * <p>The delay between when the Lambda fulfillment function starts running
4517
4911
  * and the start message is played. If the Lambda function returns before
4518
4912
  * the delay is over, the start message isn't played.</p>
4519
4913
  */
4520
4914
  delayInSeconds: number | undefined;
4521
4915
  /**
4916
+ * @public
4522
4917
  * <p>1 - 5 message groups that contain start messages. Amazon Lex chooses
4523
4918
  * one of the messages to play to the user.</p>
4524
4919
  */
4525
4920
  messageGroups: MessageGroup[] | undefined;
4526
4921
  /**
4922
+ * @public
4527
4923
  * <p>Determines whether the user can interrupt the start message while it
4528
4924
  * is playing.</p>
4529
4925
  */
@@ -4536,6 +4932,7 @@ export interface FulfillmentStartResponseSpecification {
4536
4932
  */
4537
4933
  export interface FulfillmentUpdateResponseSpecification {
4538
4934
  /**
4935
+ * @public
4539
4936
  * <p>The frequency that a message is sent to the user. When the period
4540
4937
  * ends, Amazon Lex chooses a message from the message groups and plays it to
4541
4938
  * the user. If the fulfillment Lambda returns before the first period
@@ -4543,11 +4940,13 @@ export interface FulfillmentUpdateResponseSpecification {
4543
4940
  */
4544
4941
  frequencyInSeconds: number | undefined;
4545
4942
  /**
4943
+ * @public
4546
4944
  * <p>1 - 5 message groups that contain update messages. Amazon Lex chooses
4547
4945
  * one of the messages to play to the user.</p>
4548
4946
  */
4549
4947
  messageGroups: MessageGroup[] | undefined;
4550
4948
  /**
4949
+ * @public
4551
4950
  * <p>Determines whether the user can interrupt an update message while it
4552
4951
  * is playing.</p>
4553
4952
  */
@@ -4560,6 +4959,7 @@ export interface FulfillmentUpdateResponseSpecification {
4560
4959
  */
4561
4960
  export interface FulfillmentUpdatesSpecification {
4562
4961
  /**
4962
+ * @public
4563
4963
  * <p>Determines whether fulfillment updates are sent to the user. When
4564
4964
  * this field is true, updates are sent.</p>
4565
4965
  * <p>If the <code>active</code> field is set to true, the
@@ -4568,16 +4968,19 @@ export interface FulfillmentUpdatesSpecification {
4568
4968
  */
4569
4969
  active: boolean | undefined;
4570
4970
  /**
4971
+ * @public
4571
4972
  * <p>Provides configuration information for the message sent to users
4572
4973
  * when the fulfillment Lambda functions starts running.</p>
4573
4974
  */
4574
4975
  startResponse?: FulfillmentStartResponseSpecification;
4575
4976
  /**
4977
+ * @public
4576
4978
  * <p>Provides configuration information for messages sent periodically to
4577
4979
  * the user while the fulfillment Lambda function is running.</p>
4578
4980
  */
4579
4981
  updateResponse?: FulfillmentUpdateResponseSpecification;
4580
4982
  /**
4983
+ * @public
4581
4984
  * <p>The length of time that the fulfillment Lambda function should run
4582
4985
  * before it times out.</p>
4583
4986
  */
@@ -4590,6 +4993,7 @@ export interface FulfillmentUpdatesSpecification {
4590
4993
  */
4591
4994
  export interface InputContext {
4592
4995
  /**
4996
+ * @public
4593
4997
  * <p>The name of the context.</p>
4594
4998
  */
4595
4999
  name: string | undefined;
@@ -4600,11 +5004,13 @@ export interface InputContext {
4600
5004
  */
4601
5005
  export interface ElicitationCodeHookInvocationSetting {
4602
5006
  /**
5007
+ * @public
4603
5008
  * <p>Indicates whether a Lambda function should be invoked
4604
5009
  * for the dialog.</p>
4605
5010
  */
4606
5011
  enableCodeHookInvocation: boolean | undefined;
4607
5012
  /**
5013
+ * @public
4608
5014
  * <p>A label that indicates the dialog step from which the dialog code
4609
5015
  * hook is happening.</p>
4610
5016
  */
@@ -4644,6 +5050,7 @@ export type PromptAttempt = (typeof PromptAttempt)[keyof typeof PromptAttempt];
4644
5050
  */
4645
5051
  export interface TextInputSpecification {
4646
5052
  /**
5053
+ * @public
4647
5054
  * <p>Time for which a bot waits before re-prompting a customer for text input.</p>
4648
5055
  */
4649
5056
  startTimeoutMs: number | undefined;
@@ -4654,18 +5061,22 @@ export interface TextInputSpecification {
4654
5061
  */
4655
5062
  export interface PromptAttemptSpecification {
4656
5063
  /**
5064
+ * @public
4657
5065
  * <p>Indicates whether the user can interrupt a speech prompt attempt from the bot.</p>
4658
5066
  */
4659
5067
  allowInterrupt?: boolean;
4660
5068
  /**
5069
+ * @public
4661
5070
  * <p>Indicates the allowed input types of the prompt attempt.</p>
4662
5071
  */
4663
5072
  allowedInputTypes: AllowedInputTypes | undefined;
4664
5073
  /**
5074
+ * @public
4665
5075
  * <p>Specifies the settings on audio and DTMF input.</p>
4666
5076
  */
4667
5077
  audioAndDTMFInputSpecification?: AudioAndDTMFInputSpecification;
4668
5078
  /**
5079
+ * @public
4669
5080
  * <p>Specifies the settings on text input.</p>
4670
5081
  */
4671
5082
  textInputSpecification?: TextInputSpecification;
@@ -4677,25 +5088,30 @@ export interface PromptAttemptSpecification {
4677
5088
  */
4678
5089
  export interface PromptSpecification {
4679
5090
  /**
5091
+ * @public
4680
5092
  * <p>A collection of messages that Amazon Lex can send to the user. Amazon Lex
4681
5093
  * chooses the actual message to send at runtime.</p>
4682
5094
  */
4683
5095
  messageGroups: MessageGroup[] | undefined;
4684
5096
  /**
5097
+ * @public
4685
5098
  * <p>The maximum number of times the bot tries to elicit a response from
4686
5099
  * the user using this prompt.</p>
4687
5100
  */
4688
5101
  maxRetries: number | undefined;
4689
5102
  /**
5103
+ * @public
4690
5104
  * <p>Indicates whether the user can interrupt a speech prompt from the
4691
5105
  * bot.</p>
4692
5106
  */
4693
5107
  allowInterrupt?: boolean;
4694
5108
  /**
5109
+ * @public
4695
5110
  * <p>Indicates how a message is selected from a message group among retries.</p>
4696
5111
  */
4697
5112
  messageSelectionStrategy?: MessageSelectionStrategy | string;
4698
5113
  /**
5114
+ * @public
4699
5115
  * <p>Specifies the advanced settings on each attempt of the prompt.</p>
4700
5116
  */
4701
5117
  promptAttemptsSpecification?: Record<string, PromptAttemptSpecification>;
@@ -4709,17 +5125,20 @@ export interface PromptSpecification {
4709
5125
  */
4710
5126
  export interface KendraConfiguration {
4711
5127
  /**
5128
+ * @public
4712
5129
  * <p>The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the
4713
5130
  * <code>AMAZON.KendraSearchIntent</code> intent to search. The index must be in the
4714
5131
  * same account and Region as the Amazon Lex bot.</p>
4715
5132
  */
4716
5133
  kendraIndex: string | undefined;
4717
5134
  /**
5135
+ * @public
4718
5136
  * <p>Determines whether the <code>AMAZON.KendraSearchIntent</code> intent uses a
4719
5137
  * custom query string to query the Amazon Kendra index.</p>
4720
5138
  */
4721
5139
  queryFilterStringEnabled?: boolean;
4722
5140
  /**
5141
+ * @public
4723
5142
  * <p>A query filter that Amazon Lex sends to Amazon Kendra to filter the response from
4724
5143
  * a query. The filter is in the format defined by Amazon Kendra. For more
4725
5144
  * information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/filtering.html">Filtering
@@ -4734,16 +5153,19 @@ export interface KendraConfiguration {
4734
5153
  */
4735
5154
  export interface OutputContext {
4736
5155
  /**
5156
+ * @public
4737
5157
  * <p>The name of the output context.</p>
4738
5158
  */
4739
5159
  name: string | undefined;
4740
5160
  /**
5161
+ * @public
4741
5162
  * <p>The amount of time, in seconds, that the output context should
4742
5163
  * remain active. The time is figured from the first time the context is
4743
5164
  * sent to the user.</p>
4744
5165
  */
4745
5166
  timeToLiveInSeconds: number | undefined;
4746
5167
  /**
5168
+ * @public
4747
5169
  * <p>The number of conversation turns that the output context should
4748
5170
  * remain active. The number of turns is counted from the first time that
4749
5171
  * the context is sent to the user.</p>
@@ -4757,6 +5179,7 @@ export interface OutputContext {
4757
5179
  */
4758
5180
  export interface SampleUtterance {
4759
5181
  /**
5182
+ * @public
4760
5183
  * <p>The sample utterance that Amazon Lex uses to build its machine-learning
4761
5184
  * model to recognize intents.</p>
4762
5185
  */
@@ -4767,11 +5190,13 @@ export interface SampleUtterance {
4767
5190
  */
4768
5191
  export interface CreateResourcePolicyRequest {
4769
5192
  /**
5193
+ * @public
4770
5194
  * <p>The Amazon Resource Name (ARN) of the bot or bot alias that the
4771
5195
  * resource policy is attached to.</p>
4772
5196
  */
4773
5197
  resourceArn: string | undefined;
4774
5198
  /**
5199
+ * @public
4775
5200
  * <p>A resource policy to add to the resource. The policy is a JSON
4776
5201
  * structure that contains one or more statements that define the policy.
4777
5202
  * The policy must follow the IAM syntax. For more information about the
@@ -4787,11 +5212,13 @@ export interface CreateResourcePolicyRequest {
4787
5212
  */
4788
5213
  export interface CreateResourcePolicyResponse {
4789
5214
  /**
5215
+ * @public
4790
5216
  * <p>The Amazon Resource Name (ARN) of the bot or bot alias that the
4791
5217
  * resource policy was attached to.</p>
4792
5218
  */
4793
5219
  resourceArn?: string;
4794
5220
  /**
5221
+ * @public
4795
5222
  * <p>The current revision of the resource policy. Use the revision ID to
4796
5223
  * make sure that you are updating the most current version of a resource
4797
5224
  * policy when you add a policy statement to a resource, delete a
@@ -4819,11 +5246,13 @@ export type Effect = (typeof Effect)[keyof typeof Effect];
4819
5246
  */
4820
5247
  export interface Principal {
4821
5248
  /**
5249
+ * @public
4822
5250
  * <p>The name of the Amazon Web Services service that should allowed or denied access to
4823
5251
  * an Amazon Lex action.</p>
4824
5252
  */
4825
5253
  service?: string;
4826
5254
  /**
5255
+ * @public
4827
5256
  * <p>The Amazon Resource Name (ARN) of the principal.</p>
4828
5257
  */
4829
5258
  arn?: string;
@@ -4833,11 +5262,13 @@ export interface Principal {
4833
5262
  */
4834
5263
  export interface CreateResourcePolicyStatementRequest {
4835
5264
  /**
5265
+ * @public
4836
5266
  * <p>The Amazon Resource Name (ARN) of the bot or bot alias that the
4837
5267
  * resource policy is attached to.</p>
4838
5268
  */
4839
5269
  resourceArn: string | undefined;
4840
5270
  /**
5271
+ * @public
4841
5272
  * <p>The name of the statement. The ID is the same as the
4842
5273
  * <code>Sid</code> IAM property. The statement name must be unique
4843
5274
  * within the policy. For more information, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_sid.html">IAM
@@ -4845,11 +5276,13 @@ export interface CreateResourcePolicyStatementRequest {
4845
5276
  */
4846
5277
  statementId: string | undefined;
4847
5278
  /**
5279
+ * @public
4848
5280
  * <p>Determines whether the statement allows or denies access to the
4849
5281
  * resource.</p>
4850
5282
  */
4851
5283
  effect: Effect | string | undefined;
4852
5284
  /**
5285
+ * @public
4853
5286
  * <p>An IAM principal, such as an IAM user, IAM role,
4854
5287
  * or Amazon Web Services services
4855
5288
  * that is allowed or denied access to a resource. For more information,
@@ -4857,6 +5290,7 @@ export interface CreateResourcePolicyStatementRequest {
4857
5290
  */
4858
5291
  principal: Principal[] | undefined;
4859
5292
  /**
5293
+ * @public
4860
5294
  * <p>The Amazon Lex action that this policy either allows or denies. The
4861
5295
  * action must apply to the resource type of the specified ARN. For more
4862
5296
  * information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonlexv2.html">
@@ -4864,6 +5298,7 @@ export interface CreateResourcePolicyStatementRequest {
4864
5298
  */
4865
5299
  action: string[] | undefined;
4866
5300
  /**
5301
+ * @public
4867
5302
  * <p>Specifies a condition when the policy is in effect. If the principal
4868
5303
  * of the policy is a service principal, you must provide two condition
4869
5304
  * blocks, one with a SourceAccount global condition key and one with a
@@ -4872,6 +5307,7 @@ export interface CreateResourcePolicyStatementRequest {
4872
5307
  */
4873
5308
  condition?: Record<string, Record<string, string>>;
4874
5309
  /**
5310
+ * @public
4875
5311
  * <p>The identifier of the revision of the policy to edit. If this
4876
5312
  * revision ID doesn't match the current revision ID, Amazon Lex throws an
4877
5313
  * exception.</p>
@@ -4885,11 +5321,13 @@ export interface CreateResourcePolicyStatementRequest {
4885
5321
  */
4886
5322
  export interface CreateResourcePolicyStatementResponse {
4887
5323
  /**
5324
+ * @public
4888
5325
  * <p>The Amazon Resource Name (ARN) of the bot or bot alias that the
4889
5326
  * resource policy is attached to.</p>
4890
5327
  */
4891
5328
  resourceArn?: string;
4892
5329
  /**
5330
+ * @public
4893
5331
  * <p>The current revision of the resource policy. Use the revision ID to
4894
5332
  * make sure that you are updating the most current version of a resource
4895
5333
  * policy when you add a policy statement to a resource, delete a
@@ -4903,6 +5341,7 @@ export interface CreateResourcePolicyStatementResponse {
4903
5341
  */
4904
5342
  export interface MultipleValuesSetting {
4905
5343
  /**
5344
+ * @public
4906
5345
  * <p>Indicates whether a slot can return multiple values. When
4907
5346
  * <code>true</code>, the slot may return more than one value in a
4908
5347
  * response. When <code>false</code>, the slot returns only a single
@@ -4934,6 +5373,7 @@ export type ObfuscationSettingType = (typeof ObfuscationSettingType)[keyof typeo
4934
5373
  */
4935
5374
  export interface ObfuscationSetting {
4936
5375
  /**
5376
+ * @public
4937
5377
  * <p>Value that determines whether Amazon Lex obscures slot values in
4938
5378
  * conversation logs. The default is to obscure the values.</p>
4939
5379
  */
@@ -4946,6 +5386,7 @@ export interface ObfuscationSetting {
4946
5386
  */
4947
5387
  export interface SlotDefaultValue {
4948
5388
  /**
5389
+ * @public
4949
5390
  * <p>The default value to use when a user doesn't provide a value for a
4950
5391
  * slot.</p>
4951
5392
  */
@@ -4958,6 +5399,7 @@ export interface SlotDefaultValue {
4958
5399
  */
4959
5400
  export interface SlotDefaultValueSpecification {
4960
5401
  /**
5402
+ * @public
4961
5403
  * <p>A list of default values. Amazon Lex chooses the default value to use in
4962
5404
  * the order that they are presented in the list.</p>
4963
5405
  */
@@ -4970,21 +5412,25 @@ export interface SlotDefaultValueSpecification {
4970
5412
  */
4971
5413
  export interface StillWaitingResponseSpecification {
4972
5414
  /**
5415
+ * @public
4973
5416
  * <p>One or more message groups, each containing one or more messages,
4974
5417
  * that define the prompts that Amazon Lex sends to the user.</p>
4975
5418
  */
4976
5419
  messageGroups: MessageGroup[] | undefined;
4977
5420
  /**
5421
+ * @public
4978
5422
  * <p>How often a message should be sent to the user. Minimum of 1 second,
4979
5423
  * maximum of 5 minutes.</p>
4980
5424
  */
4981
5425
  frequencyInSeconds: number | undefined;
4982
5426
  /**
5427
+ * @public
4983
5428
  * <p>If Amazon Lex waits longer than this length of time for a response, it
4984
5429
  * will stop sending messages.</p>
4985
5430
  */
4986
5431
  timeoutInSeconds: number | undefined;
4987
5432
  /**
5433
+ * @public
4988
5434
  * <p>Indicates that the user can interrupt the response by speaking while
4989
5435
  * the message is being played.</p>
4990
5436
  */
@@ -4997,21 +5443,25 @@ export interface StillWaitingResponseSpecification {
4997
5443
  */
4998
5444
  export interface WaitAndContinueSpecification {
4999
5445
  /**
5446
+ * @public
5000
5447
  * <p>The response that Amazon Lex sends to indicate that the bot is waiting
5001
5448
  * for the conversation to continue.</p>
5002
5449
  */
5003
5450
  waitingResponse: ResponseSpecification | undefined;
5004
5451
  /**
5452
+ * @public
5005
5453
  * <p>The response that Amazon Lex sends to indicate that the bot is ready to
5006
5454
  * continue the conversation.</p>
5007
5455
  */
5008
5456
  continueResponse: ResponseSpecification | undefined;
5009
5457
  /**
5458
+ * @public
5010
5459
  * <p>A response that Amazon Lex sends periodically to the user to indicate
5011
5460
  * that the bot is still waiting for input from the user.</p>
5012
5461
  */
5013
5462
  stillWaitingResponse?: StillWaitingResponseSpecification;
5014
5463
  /**
5464
+ * @public
5015
5465
  * <p>Specifies whether the bot will wait for a user to respond. When this
5016
5466
  * field is false, wait and continue responses for a slot aren't used. If
5017
5467
  * the <code>active</code> field isn't specified, the default is
@@ -5032,22 +5482,26 @@ export interface WaitAndContinueSpecification {
5032
5482
  */
5033
5483
  export interface SubSlotValueElicitationSetting {
5034
5484
  /**
5485
+ * @public
5035
5486
  * <p>Defines a list of values that Amazon Lex should use as the default value
5036
5487
  * for a slot.</p>
5037
5488
  */
5038
5489
  defaultValueSpecification?: SlotDefaultValueSpecification;
5039
5490
  /**
5491
+ * @public
5040
5492
  * <p>Specifies a list of message groups that Amazon Lex sends to a user to
5041
5493
  * elicit a response.</p>
5042
5494
  */
5043
5495
  promptSpecification: PromptSpecification | undefined;
5044
5496
  /**
5497
+ * @public
5045
5498
  * <p>If you know a specific pattern that users might respond to an Amazon Lex request for a sub slot value,
5046
5499
  * you can provide those utterances to improve accuracy. This is optional. In most cases Amazon Lex is capable
5047
5500
  * of understanding user utterances. This is similar to <code>SampleUtterances</code> for slots.</p>
5048
5501
  */
5049
5502
  sampleUtterances?: SampleUtterance[];
5050
5503
  /**
5504
+ * @public
5051
5505
  * <p>Specifies the prompts that Amazon Lex uses while a bot is waiting for
5052
5506
  * customer input. </p>
5053
5507
  */
@@ -5059,10 +5513,12 @@ export interface SubSlotValueElicitationSetting {
5059
5513
  */
5060
5514
  export interface Specifications {
5061
5515
  /**
5516
+ * @public
5062
5517
  * <p>The unique identifier assigned to the slot type.</p>
5063
5518
  */
5064
5519
  slotTypeId: string | undefined;
5065
5520
  /**
5521
+ * @public
5066
5522
  * <p>Specifies the elicitation setting details for constituent sub slots of a composite slot.</p>
5067
5523
  */
5068
5524
  valueElicitationSetting: SubSlotValueElicitationSetting | undefined;
@@ -5074,10 +5530,12 @@ export interface Specifications {
5074
5530
  */
5075
5531
  export interface SubSlotSetting {
5076
5532
  /**
5533
+ * @public
5077
5534
  * <p>The expression text for defining the constituent sub slots in the composite slot using logical AND and OR operators.</p>
5078
5535
  */
5079
5536
  expression?: string;
5080
5537
  /**
5538
+ * @public
5081
5539
  * <p>Specifications for the constituent sub slots of a composite slot.</p>
5082
5540
  */
5083
5541
  slotSpecifications?: Record<string, Specifications>;
@@ -5101,14 +5559,17 @@ export type SlotConstraint = (typeof SlotConstraint)[keyof typeof SlotConstraint
5101
5559
  */
5102
5560
  export interface GrammarSlotTypeSource {
5103
5561
  /**
5562
+ * @public
5104
5563
  * <p>The name of the Amazon S3 bucket that contains the grammar source.</p>
5105
5564
  */
5106
5565
  s3BucketName: string | undefined;
5107
5566
  /**
5567
+ * @public
5108
5568
  * <p>The path to the grammar in the Amazon S3 bucket.</p>
5109
5569
  */
5110
5570
  s3ObjectKey: string | undefined;
5111
5571
  /**
5572
+ * @public
5112
5573
  * <p>The KMS key required to decrypt the contents of the grammar, if any.</p>
5113
5574
  */
5114
5575
  kmsKeyArn?: string;
@@ -5119,6 +5580,7 @@ export interface GrammarSlotTypeSource {
5119
5580
  */
5120
5581
  export interface GrammarSlotTypeSetting {
5121
5582
  /**
5583
+ * @public
5122
5584
  * <p>The source of the grammar used to create the slot type.</p>
5123
5585
  */
5124
5586
  source?: GrammarSlotTypeSource;
@@ -5129,6 +5591,7 @@ export interface GrammarSlotTypeSetting {
5129
5591
  */
5130
5592
  export interface ExternalSourceSetting {
5131
5593
  /**
5594
+ * @public
5132
5595
  * <p>Settings required for a slot type based on a grammar that you provide.</p>
5133
5596
  */
5134
5597
  grammarSlotTypeSetting?: GrammarSlotTypeSetting;
@@ -5139,6 +5602,7 @@ export interface ExternalSourceSetting {
5139
5602
  */
5140
5603
  export interface SampleValue {
5141
5604
  /**
5605
+ * @public
5142
5606
  * <p>The value that can be used for a slot type.</p>
5143
5607
  */
5144
5608
  value: string | undefined;
@@ -5151,10 +5615,12 @@ export interface SampleValue {
5151
5615
  */
5152
5616
  export interface SlotTypeValue {
5153
5617
  /**
5618
+ * @public
5154
5619
  * <p>The value of the slot type entry.</p>
5155
5620
  */
5156
5621
  sampleValue?: SampleValue;
5157
5622
  /**
5623
+ * @public
5158
5624
  * <p>Additional values related to the slot type entry.</p>
5159
5625
  */
5160
5626
  synonyms?: SampleValue[];
@@ -5166,6 +5632,7 @@ export interface SlotTypeValue {
5166
5632
  */
5167
5633
  export interface SlotValueRegexFilter {
5168
5634
  /**
5635
+ * @public
5169
5636
  * <p>A regular expression used to validate the value of a slot.</p>
5170
5637
  * <p> Use a standard regular expression. Amazon Lex supports the following
5171
5638
  * characters in the regular expression: </p>
@@ -5213,6 +5680,7 @@ export type SlotValueResolutionStrategy = (typeof SlotValueResolutionStrategy)[k
5213
5680
  */
5214
5681
  export interface SlotValueSelectionSetting {
5215
5682
  /**
5683
+ * @public
5216
5684
  * <p>Determines the slot resolution strategy that Amazon Lex uses to
5217
5685
  * return slot type values. The field can be set to one of the following
5218
5686
  * values:</p>
@@ -5234,10 +5702,12 @@ export interface SlotValueSelectionSetting {
5234
5702
  */
5235
5703
  resolutionStrategy: SlotValueResolutionStrategy | string | undefined;
5236
5704
  /**
5705
+ * @public
5237
5706
  * <p>A regular expression used to validate the value of a slot.</p>
5238
5707
  */
5239
5708
  regexFilter?: SlotValueRegexFilter;
5240
5709
  /**
5710
+ * @public
5241
5711
  * <p>Provides settings that enable advanced recognition settings for slot
5242
5712
  * values. You can use this to enable using slot values as a custom
5243
5713
  * vocabulary for recognizing user utterances.</p>
@@ -5249,16 +5719,19 @@ export interface SlotValueSelectionSetting {
5249
5719
  */
5250
5720
  export interface CreateSlotTypeRequest {
5251
5721
  /**
5722
+ * @public
5252
5723
  * <p>The name for the slot. A slot type name must be unique within the
5253
5724
  * intent.</p>
5254
5725
  */
5255
5726
  slotTypeName: string | undefined;
5256
5727
  /**
5728
+ * @public
5257
5729
  * <p>A description of the slot type. Use the description to help identify
5258
5730
  * the slot type in lists.</p>
5259
5731
  */
5260
5732
  description?: string;
5261
5733
  /**
5734
+ * @public
5262
5735
  * <p>A list of <code>SlotTypeValue</code> objects that defines the values
5263
5736
  * that the slot type can take. Each value can have a list of synonyms,
5264
5737
  * additional values that help train the machine learning model about the
@@ -5266,6 +5739,7 @@ export interface CreateSlotTypeRequest {
5266
5739
  */
5267
5740
  slotTypeValues?: SlotTypeValue[];
5268
5741
  /**
5742
+ * @public
5269
5743
  * <p>Determines the strategy that Amazon Lex uses to select a value from the
5270
5744
  * list of possible values. The field can be set to one of the following
5271
5745
  * values:</p>
@@ -5287,6 +5761,7 @@ export interface CreateSlotTypeRequest {
5287
5761
  */
5288
5762
  valueSelectionSetting?: SlotValueSelectionSetting;
5289
5763
  /**
5764
+ * @public
5290
5765
  * <p>The built-in slot type used as a parent of this slot type. When you
5291
5766
  * define a parent slot type, the new slot type has the configuration of
5292
5767
  * the parent slot type.</p>
@@ -5294,15 +5769,18 @@ export interface CreateSlotTypeRequest {
5294
5769
  */
5295
5770
  parentSlotTypeSignature?: string;
5296
5771
  /**
5772
+ * @public
5297
5773
  * <p>The identifier of the bot associated with this slot type.</p>
5298
5774
  */
5299
5775
  botId: string | undefined;
5300
5776
  /**
5777
+ * @public
5301
5778
  * <p>The identifier of the bot version associated with this slot
5302
5779
  * type.</p>
5303
5780
  */
5304
5781
  botVersion: string | undefined;
5305
5782
  /**
5783
+ * @public
5306
5784
  * <p>The identifier of the language and locale that the slot type will be
5307
5785
  * used in. The string must match one of the supported locales. All of the
5308
5786
  * bots, intents, and slots used by the slot type must have the same
@@ -5310,11 +5788,13 @@ export interface CreateSlotTypeRequest {
5310
5788
  */
5311
5789
  localeId: string | undefined;
5312
5790
  /**
5791
+ * @public
5313
5792
  * <p>Sets the type of external information used to create the slot
5314
5793
  * type.</p>
5315
5794
  */
5316
5795
  externalSourceSetting?: ExternalSourceSetting;
5317
5796
  /**
5797
+ * @public
5318
5798
  * <p>Specifications for a composite slot type.</p>
5319
5799
  */
5320
5800
  compositeSlotTypeSetting?: CompositeSlotTypeSetting;
@@ -5324,56 +5804,68 @@ export interface CreateSlotTypeRequest {
5324
5804
  */
5325
5805
  export interface CreateSlotTypeResponse {
5326
5806
  /**
5807
+ * @public
5327
5808
  * <p>The unique identifier assigned to the slot type. Use this to
5328
5809
  * identify the slot type in the <code>UpdateSlotType</code> and
5329
5810
  * <code>DeleteSlotType</code> operations.</p>
5330
5811
  */
5331
5812
  slotTypeId?: string;
5332
5813
  /**
5814
+ * @public
5333
5815
  * <p>The name specified for the slot type.</p>
5334
5816
  */
5335
5817
  slotTypeName?: string;
5336
5818
  /**
5819
+ * @public
5337
5820
  * <p>The description specified for the slot type.</p>
5338
5821
  */
5339
5822
  description?: string;
5340
5823
  /**
5824
+ * @public
5341
5825
  * <p>The list of values that the slot type can assume.</p>
5342
5826
  */
5343
5827
  slotTypeValues?: SlotTypeValue[];
5344
5828
  /**
5829
+ * @public
5345
5830
  * <p>The strategy that Amazon Lex uses to select a value from the list of
5346
5831
  * possible values.</p>
5347
5832
  */
5348
5833
  valueSelectionSetting?: SlotValueSelectionSetting;
5349
5834
  /**
5835
+ * @public
5350
5836
  * <p>The signature of the base slot type specified for the slot
5351
5837
  * type.</p>
5352
5838
  */
5353
5839
  parentSlotTypeSignature?: string;
5354
5840
  /**
5841
+ * @public
5355
5842
  * <p>The identifier for the bot associated with the slot type.</p>
5356
5843
  */
5357
5844
  botId?: string;
5358
5845
  /**
5846
+ * @public
5359
5847
  * <p>The version of the bot associated with the slot type.</p>
5360
5848
  */
5361
5849
  botVersion?: string;
5362
5850
  /**
5851
+ * @public
5363
5852
  * <p>The specified language and local specified for the slot type.</p>
5364
5853
  */
5365
5854
  localeId?: string;
5366
5855
  /**
5856
+ * @public
5367
5857
  * <p>A timestamp of the date and time that the slot type was
5368
5858
  * created.</p>
5369
5859
  */
5370
5860
  creationDateTime?: Date;
5371
5861
  /**
5862
+ * @public
5372
5863
  * <p>The type of external information used to create the slot
5373
5864
  * type.</p>
5374
5865
  */
5375
5866
  externalSourceSetting?: ExternalSourceSetting;
5376
5867
  /**
5868
+ * @public
5377
5869
  * <p>Specifications for a composite slot type.</p>
5378
5870
  */
5379
5871
  compositeSlotTypeSetting?: CompositeSlotTypeSetting;
@@ -5385,14 +5877,17 @@ export interface CreateSlotTypeResponse {
5385
5877
  */
5386
5878
  export interface TestSetDiscrepancyReportBotAliasTarget {
5387
5879
  /**
5880
+ * @public
5388
5881
  * <p>The unique identifier for the bot alias.</p>
5389
5882
  */
5390
5883
  botId: string | undefined;
5391
5884
  /**
5885
+ * @public
5392
5886
  * <p>The unique identifier for the bot associated with the bot alias.</p>
5393
5887
  */
5394
5888
  botAliasId: string | undefined;
5395
5889
  /**
5890
+ * @public
5396
5891
  * <p>The unique identifier of the locale associated with the bot alias.</p>
5397
5892
  */
5398
5893
  localeId: string | undefined;
@@ -5404,6 +5899,7 @@ export interface TestSetDiscrepancyReportBotAliasTarget {
5404
5899
  */
5405
5900
  export interface TestSetDiscrepancyReportResourceTarget {
5406
5901
  /**
5902
+ * @public
5407
5903
  * <p>Contains information about the bot alias used as the resource for the
5408
5904
  * test set discrepancy report.</p>
5409
5905
  */
@@ -5414,10 +5910,12 @@ export interface TestSetDiscrepancyReportResourceTarget {
5414
5910
  */
5415
5911
  export interface CreateTestSetDiscrepancyReportRequest {
5416
5912
  /**
5913
+ * @public
5417
5914
  * <p>The test set Id for the test set discrepancy report.</p>
5418
5915
  */
5419
5916
  testSetId: string | undefined;
5420
5917
  /**
5918
+ * @public
5421
5919
  * <p>The target bot for the test set discrepancy report.</p>
5422
5920
  */
5423
5921
  target: TestSetDiscrepancyReportResourceTarget | undefined;
@@ -5427,18 +5925,22 @@ export interface CreateTestSetDiscrepancyReportRequest {
5427
5925
  */
5428
5926
  export interface CreateTestSetDiscrepancyReportResponse {
5429
5927
  /**
5928
+ * @public
5430
5929
  * <p>The unique identifier of the test set discrepancy report to describe.</p>
5431
5930
  */
5432
5931
  testSetDiscrepancyReportId?: string;
5433
5932
  /**
5933
+ * @public
5434
5934
  * <p>The creation date and time for the test set discrepancy report.</p>
5435
5935
  */
5436
5936
  creationDateTime?: Date;
5437
5937
  /**
5938
+ * @public
5438
5939
  * <p>The test set Id for the test set discrepancy report.</p>
5439
5940
  */
5440
5941
  testSetId?: string;
5441
5942
  /**
5943
+ * @public
5442
5944
  * <p>The target bot for the test set discrepancy report.</p>
5443
5945
  */
5444
5946
  target?: TestSetDiscrepancyReportResourceTarget;
@@ -5453,11 +5955,13 @@ export interface CreateUploadUrlRequest {
5453
5955
  */
5454
5956
  export interface CreateUploadUrlResponse {
5455
5957
  /**
5958
+ * @public
5456
5959
  * <p>An identifier for a unique import job. Use it when you call the
5457
5960
  * <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_StartImport.html">StartImport</a> operation.</p>
5458
5961
  */
5459
5962
  importId?: string;
5460
5963
  /**
5964
+ * @public
5461
5965
  * <p>A pre-signed S3 write URL. Upload the zip archive file that contains
5462
5966
  * the definition of your bot or bot locale.</p>
5463
5967
  */
@@ -5469,14 +5973,17 @@ export interface CreateUploadUrlResponse {
5469
5973
  */
5470
5974
  export interface CustomVocabularyImportSpecification {
5471
5975
  /**
5976
+ * @public
5472
5977
  * <p>The identifier of the bot to import the custom vocabulary to.</p>
5473
5978
  */
5474
5979
  botId: string | undefined;
5475
5980
  /**
5981
+ * @public
5476
5982
  * <p>The version of the bot to import the custom vocabulary to.</p>
5477
5983
  */
5478
5984
  botVersion: string | undefined;
5479
5985
  /**
5986
+ * @public
5480
5987
  * <p>The identifier of the local to import the custom vocabulary to. The value must
5481
5988
  * be <code>en_GB</code>.</p>
5482
5989
  */
@@ -5504,11 +6011,13 @@ export type CustomVocabularyStatus = (typeof CustomVocabularyStatus)[keyof typeo
5504
6011
  */
5505
6012
  export interface DateRangeFilter {
5506
6013
  /**
6014
+ * @public
5507
6015
  * <p>A timestamp indicating the start date for the date range
5508
6016
  * filter.</p>
5509
6017
  */
5510
6018
  startDateTime: Date | undefined;
5511
6019
  /**
6020
+ * @public
5512
6021
  * <p>A timestamp indicating the end date for the date range
5513
6022
  * filter.</p>
5514
6023
  */
@@ -5519,10 +6028,12 @@ export interface DateRangeFilter {
5519
6028
  */
5520
6029
  export interface DeleteBotRequest {
5521
6030
  /**
6031
+ * @public
5522
6032
  * <p>The identifier of the bot to delete. </p>
5523
6033
  */
5524
6034
  botId: string | undefined;
5525
6035
  /**
6036
+ * @public
5526
6037
  * <p>By default, Amazon Lex checks if any other resource, such as an alias or
5527
6038
  * bot network, is using the bot version before it is deleted and throws a
5528
6039
  * <code>ResourceInUseException</code> exception if the bot is
@@ -5537,10 +6048,12 @@ export interface DeleteBotRequest {
5537
6048
  */
5538
6049
  export interface DeleteBotResponse {
5539
6050
  /**
6051
+ * @public
5540
6052
  * <p>The unique identifier of the bot that Amazon Lex is deleting.</p>
5541
6053
  */
5542
6054
  botId?: string;
5543
6055
  /**
6056
+ * @public
5544
6057
  * <p>The current status of the bot. The status is <code>Deleting</code>
5545
6058
  * while the bot and its associated resources are being deleted.</p>
5546
6059
  */
@@ -5551,15 +6064,18 @@ export interface DeleteBotResponse {
5551
6064
  */
5552
6065
  export interface DeleteBotAliasRequest {
5553
6066
  /**
6067
+ * @public
5554
6068
  * <p>The unique identifier of the bot alias to delete.</p>
5555
6069
  */
5556
6070
  botAliasId: string | undefined;
5557
6071
  /**
6072
+ * @public
5558
6073
  * <p>The unique identifier of the bot associated with the alias to
5559
6074
  * delete.</p>
5560
6075
  */
5561
6076
  botId: string | undefined;
5562
6077
  /**
6078
+ * @public
5563
6079
  * <p>By default, Amazon Lex checks if any other resource, such as a bot network,
5564
6080
  * is using the bot alias before it is deleted and throws a
5565
6081
  * <code>ResourceInUseException</code> exception if the alias is
@@ -5574,15 +6090,18 @@ export interface DeleteBotAliasRequest {
5574
6090
  */
5575
6091
  export interface DeleteBotAliasResponse {
5576
6092
  /**
6093
+ * @public
5577
6094
  * <p>The unique identifier of the bot alias to delete.</p>
5578
6095
  */
5579
6096
  botAliasId?: string;
5580
6097
  /**
6098
+ * @public
5581
6099
  * <p>The unique identifier of the bot that contains the alias to
5582
6100
  * delete.</p>
5583
6101
  */
5584
6102
  botId?: string;
5585
6103
  /**
6104
+ * @public
5586
6105
  * <p>The current status of the alias. The status is <code>Deleting</code>
5587
6106
  * while the alias is in the process of being deleted. Once the alias is
5588
6107
  * deleted, it will no longer appear in the list of aliases returned by
@@ -5595,14 +6114,17 @@ export interface DeleteBotAliasResponse {
5595
6114
  */
5596
6115
  export interface DeleteBotLocaleRequest {
5597
6116
  /**
6117
+ * @public
5598
6118
  * <p>The unique identifier of the bot that contains the locale.</p>
5599
6119
  */
5600
6120
  botId: string | undefined;
5601
6121
  /**
6122
+ * @public
5602
6123
  * <p>The version of the bot that contains the locale. </p>
5603
6124
  */
5604
6125
  botVersion: string | undefined;
5605
6126
  /**
6127
+ * @public
5606
6128
  * <p>The identifier of the language and locale that will be deleted. The
5607
6129
  * string must match one of the supported locales. For more information,
5608
6130
  * see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.</p>
@@ -5614,18 +6136,22 @@ export interface DeleteBotLocaleRequest {
5614
6136
  */
5615
6137
  export interface DeleteBotLocaleResponse {
5616
6138
  /**
6139
+ * @public
5617
6140
  * <p>The identifier of the bot that contained the deleted locale.</p>
5618
6141
  */
5619
6142
  botId?: string;
5620
6143
  /**
6144
+ * @public
5621
6145
  * <p>The version of the bot that contained the deleted locale.</p>
5622
6146
  */
5623
6147
  botVersion?: string;
5624
6148
  /**
6149
+ * @public
5625
6150
  * <p>The language and locale of the deleted locale.</p>
5626
6151
  */
5627
6152
  localeId?: string;
5628
6153
  /**
6154
+ * @public
5629
6155
  * <p>The status of deleting the bot locale. The locale first enters the
5630
6156
  * <code>Deleting</code> status. Once the locale is deleted it no
5631
6157
  * longer appears in the list of locales for the bot.</p>
@@ -5637,14 +6163,17 @@ export interface DeleteBotLocaleResponse {
5637
6163
  */
5638
6164
  export interface DeleteBotVersionRequest {
5639
6165
  /**
6166
+ * @public
5640
6167
  * <p>The identifier of the bot that contains the version.</p>
5641
6168
  */
5642
6169
  botId: string | undefined;
5643
6170
  /**
6171
+ * @public
5644
6172
  * <p>The version of the bot to delete.</p>
5645
6173
  */
5646
6174
  botVersion: string | undefined;
5647
6175
  /**
6176
+ * @public
5648
6177
  * <p>By default, Amazon Lex checks if any other resource, such as an alias or bot network,
5649
6178
  * is using the bot version before it is deleted and throws a
5650
6179
  * <code>ResourceInUseException</code> exception if the version is
@@ -5659,14 +6188,17 @@ export interface DeleteBotVersionRequest {
5659
6188
  */
5660
6189
  export interface DeleteBotVersionResponse {
5661
6190
  /**
6191
+ * @public
5662
6192
  * <p>The identifier of the bot that is being deleted.</p>
5663
6193
  */
5664
6194
  botId?: string;
5665
6195
  /**
6196
+ * @public
5666
6197
  * <p>The version of the bot that is being deleted.</p>
5667
6198
  */
5668
6199
  botVersion?: string;
5669
6200
  /**
6201
+ * @public
5670
6202
  * <p>The current status of the bot. </p>
5671
6203
  */
5672
6204
  botStatus?: BotStatus | string;
@@ -5676,16 +6208,19 @@ export interface DeleteBotVersionResponse {
5676
6208
  */
5677
6209
  export interface DeleteCustomVocabularyRequest {
5678
6210
  /**
6211
+ * @public
5679
6212
  * <p>The unique identifier of the bot to remove the custom
5680
6213
  * vocabulary from.</p>
5681
6214
  */
5682
6215
  botId: string | undefined;
5683
6216
  /**
6217
+ * @public
5684
6218
  * <p>The version of the bot to remove the custom vocabulary
5685
6219
  * from.</p>
5686
6220
  */
5687
6221
  botVersion: string | undefined;
5688
6222
  /**
6223
+ * @public
5689
6224
  * <p>The locale identifier for the locale that contains the
5690
6225
  * custom vocabulary to remove.</p>
5691
6226
  */
@@ -5696,21 +6231,25 @@ export interface DeleteCustomVocabularyRequest {
5696
6231
  */
5697
6232
  export interface DeleteCustomVocabularyResponse {
5698
6233
  /**
6234
+ * @public
5699
6235
  * <p>The identifier of the bot that the custom vocabulary
5700
6236
  * was removed from.</p>
5701
6237
  */
5702
6238
  botId?: string;
5703
6239
  /**
6240
+ * @public
5704
6241
  * <p>The version of the bot that the custom vocabulary
5705
6242
  * was removed from.</p>
5706
6243
  */
5707
6244
  botVersion?: string;
5708
6245
  /**
6246
+ * @public
5709
6247
  * <p>The locale identifier for the locale that the
5710
6248
  * custom vocabulary was removed from.</p>
5711
6249
  */
5712
6250
  localeId?: string;
5713
6251
  /**
6252
+ * @public
5714
6253
  * <p>The status of removing the custom vocabulary.</p>
5715
6254
  */
5716
6255
  customVocabularyStatus?: CustomVocabularyStatus | string;
@@ -5720,6 +6259,7 @@ export interface DeleteCustomVocabularyResponse {
5720
6259
  */
5721
6260
  export interface DeleteExportRequest {
5722
6261
  /**
6262
+ * @public
5723
6263
  * <p>The unique identifier of the export to delete.</p>
5724
6264
  */
5725
6265
  exportId: string | undefined;
@@ -5729,10 +6269,12 @@ export interface DeleteExportRequest {
5729
6269
  */
5730
6270
  export interface DeleteExportResponse {
5731
6271
  /**
6272
+ * @public
5732
6273
  * <p>The unique identifier of the deleted export.</p>
5733
6274
  */
5734
6275
  exportId?: string;
5735
6276
  /**
6277
+ * @public
5736
6278
  * <p>The current status of the deletion. When the deletion is complete,
5737
6279
  * the export will no longer be returned by the <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListExports.html">ListExports</a> operation and calls to the <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeExport.html">
5738
6280
  * DescribeExport</a> operation with the export identifier will
@@ -5745,6 +6287,7 @@ export interface DeleteExportResponse {
5745
6287
  */
5746
6288
  export interface DeleteImportRequest {
5747
6289
  /**
6290
+ * @public
5748
6291
  * <p>The unique identifier of the import to delete.</p>
5749
6292
  */
5750
6293
  importId: string | undefined;
@@ -5768,10 +6311,12 @@ export type ImportStatus = (typeof ImportStatus)[keyof typeof ImportStatus];
5768
6311
  */
5769
6312
  export interface DeleteImportResponse {
5770
6313
  /**
6314
+ * @public
5771
6315
  * <p>The unique identifier of the deleted import.</p>
5772
6316
  */
5773
6317
  importId?: string;
5774
6318
  /**
6319
+ * @public
5775
6320
  * <p>The current status of the deletion. When the deletion is complete,
5776
6321
  * the import will no longer be returned by the <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListImports.html">ListImports</a> operation and calls to the <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeImport.html">DescribeImport</a> operation with the import identifier will
5777
6322
  * fail.</p>
@@ -5783,18 +6328,22 @@ export interface DeleteImportResponse {
5783
6328
  */
5784
6329
  export interface DeleteIntentRequest {
5785
6330
  /**
6331
+ * @public
5786
6332
  * <p>The unique identifier of the intent to delete.</p>
5787
6333
  */
5788
6334
  intentId: string | undefined;
5789
6335
  /**
6336
+ * @public
5790
6337
  * <p>The identifier of the bot associated with the intent.</p>
5791
6338
  */
5792
6339
  botId: string | undefined;
5793
6340
  /**
6341
+ * @public
5794
6342
  * <p>The version of the bot associated with the intent.</p>
5795
6343
  */
5796
6344
  botVersion: string | undefined;
5797
6345
  /**
6346
+ * @public
5798
6347
  * <p>The identifier of the language and locale where the bot will be
5799
6348
  * deleted. The string must match one of the supported locales. For more
5800
6349
  * information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.</p>
@@ -5806,11 +6355,13 @@ export interface DeleteIntentRequest {
5806
6355
  */
5807
6356
  export interface DeleteResourcePolicyRequest {
5808
6357
  /**
6358
+ * @public
5809
6359
  * <p>The Amazon Resource Name (ARN) of the bot or bot alias that has the
5810
6360
  * resource policy attached.</p>
5811
6361
  */
5812
6362
  resourceArn: string | undefined;
5813
6363
  /**
6364
+ * @public
5814
6365
  * <p>The identifier of the revision to edit. If this ID doesn't match the
5815
6366
  * current revision number, Amazon Lex returns an exception</p>
5816
6367
  * <p>If you don't specify a revision ID, Amazon Lex will delete the current
@@ -5823,11 +6374,13 @@ export interface DeleteResourcePolicyRequest {
5823
6374
  */
5824
6375
  export interface DeleteResourcePolicyResponse {
5825
6376
  /**
6377
+ * @public
5826
6378
  * <p>The Amazon Resource Name (ARN) of the bot or bot alias that the
5827
6379
  * resource policy was deleted from.</p>
5828
6380
  */
5829
6381
  resourceArn?: string;
5830
6382
  /**
6383
+ * @public
5831
6384
  * <p>The current revision of the resource policy. Use the revision ID to
5832
6385
  * make sure that you are updating the most current version of a resource
5833
6386
  * policy when you add a policy statement to a resource, delete a
@@ -5840,15 +6393,18 @@ export interface DeleteResourcePolicyResponse {
5840
6393
  */
5841
6394
  export interface DeleteResourcePolicyStatementRequest {
5842
6395
  /**
6396
+ * @public
5843
6397
  * <p>The Amazon Resource Name (ARN) of the bot or bot alias that the
5844
6398
  * resource policy is attached to.</p>
5845
6399
  */
5846
6400
  resourceArn: string | undefined;
5847
6401
  /**
6402
+ * @public
5848
6403
  * <p>The name of the statement (SID) to delete from the policy.</p>
5849
6404
  */
5850
6405
  statementId: string | undefined;
5851
6406
  /**
6407
+ * @public
5852
6408
  * <p>The identifier of the revision of the policy to delete the statement
5853
6409
  * from. If this revision ID doesn't match the current revision ID, Amazon Lex
5854
6410
  * throws an exception.</p>
@@ -5862,11 +6418,13 @@ export interface DeleteResourcePolicyStatementRequest {
5862
6418
  */
5863
6419
  export interface DeleteResourcePolicyStatementResponse {
5864
6420
  /**
6421
+ * @public
5865
6422
  * <p>The Amazon Resource Name (ARN) of the bot or bot alias that the
5866
6423
  * resource policy statement was removed from.</p>
5867
6424
  */
5868
6425
  resourceArn?: string;
5869
6426
  /**
6427
+ * @public
5870
6428
  * <p>The current revision of the resource policy. Use the revision ID to
5871
6429
  * make sure that you are updating the most current version of a resource
5872
6430
  * policy when you add a policy statement to a resource, delete a
@@ -5879,24 +6437,29 @@ export interface DeleteResourcePolicyStatementResponse {
5879
6437
  */
5880
6438
  export interface DeleteSlotRequest {
5881
6439
  /**
6440
+ * @public
5882
6441
  * <p>The identifier of the slot to delete. </p>
5883
6442
  */
5884
6443
  slotId: string | undefined;
5885
6444
  /**
6445
+ * @public
5886
6446
  * <p>The identifier of the bot associated with the slot to delete.</p>
5887
6447
  */
5888
6448
  botId: string | undefined;
5889
6449
  /**
6450
+ * @public
5890
6451
  * <p>The version of the bot associated with the slot to delete.</p>
5891
6452
  */
5892
6453
  botVersion: string | undefined;
5893
6454
  /**
6455
+ * @public
5894
6456
  * <p>The identifier of the language and locale that the slot will be
5895
6457
  * deleted from. The string must match one of the supported locales. For
5896
6458
  * more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.</p>
5897
6459
  */
5898
6460
  localeId: string | undefined;
5899
6461
  /**
6462
+ * @public
5900
6463
  * <p>The identifier of the intent associated with the slot.</p>
5901
6464
  */
5902
6465
  intentId: string | undefined;
@@ -5906,24 +6469,29 @@ export interface DeleteSlotRequest {
5906
6469
  */
5907
6470
  export interface DeleteSlotTypeRequest {
5908
6471
  /**
6472
+ * @public
5909
6473
  * <p>The identifier of the slot type to delete.</p>
5910
6474
  */
5911
6475
  slotTypeId: string | undefined;
5912
6476
  /**
6477
+ * @public
5913
6478
  * <p>The identifier of the bot associated with the slot type.</p>
5914
6479
  */
5915
6480
  botId: string | undefined;
5916
6481
  /**
6482
+ * @public
5917
6483
  * <p>The version of the bot associated with the slot type.</p>
5918
6484
  */
5919
6485
  botVersion: string | undefined;
5920
6486
  /**
6487
+ * @public
5921
6488
  * <p>The identifier of the language and locale that the slot type will be
5922
6489
  * deleted from. The string must match one of the supported locales. For
5923
6490
  * more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.</p>
5924
6491
  */
5925
6492
  localeId: string | undefined;
5926
6493
  /**
6494
+ * @public
5927
6495
  * <p>By default, the <code>DeleteSlotType</code> operations throws a
5928
6496
  * <code>ResourceInUseException</code> exception if you try to delete a
5929
6497
  * slot type used by a slot. Set the <code>skipResourceInUseCheck</code>
@@ -5937,6 +6505,7 @@ export interface DeleteSlotTypeRequest {
5937
6505
  */
5938
6506
  export interface DeleteTestSetRequest {
5939
6507
  /**
6508
+ * @public
5940
6509
  * <p>The test set Id of the test set to be deleted.</p>
5941
6510
  */
5942
6511
  testSetId: string | undefined;
@@ -5946,11 +6515,13 @@ export interface DeleteTestSetRequest {
5946
6515
  */
5947
6516
  export interface DeleteUtterancesRequest {
5948
6517
  /**
6518
+ * @public
5949
6519
  * <p>The unique identifier of the bot that contains the
5950
6520
  * utterances.</p>
5951
6521
  */
5952
6522
  botId: string | undefined;
5953
6523
  /**
6524
+ * @public
5954
6525
  * <p>The identifier of the language and locale where the utterances were
5955
6526
  * collected. The string must match one of the supported locales. For more
5956
6527
  * information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported
@@ -5958,6 +6529,7 @@ export interface DeleteUtterancesRequest {
5958
6529
  */
5959
6530
  localeId?: string;
5960
6531
  /**
6532
+ * @public
5961
6533
  * <p>The unique identifier of the session with the user. The ID is
5962
6534
  * returned in the response from the <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_RecognizeText.html">RecognizeText</a> and <a href="https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_RecognizeUtterance.html">RecognizeUtterance</a> operations.</p>
5963
6535
  */
@@ -5973,6 +6545,7 @@ export interface DeleteUtterancesResponse {
5973
6545
  */
5974
6546
  export interface DescribeBotRequest {
5975
6547
  /**
6548
+ * @public
5976
6549
  * <p>The unique identifier of the bot to describe.</p>
5977
6550
  */
5978
6551
  botId: string | undefined;
@@ -5982,56 +6555,68 @@ export interface DescribeBotRequest {
5982
6555
  */
5983
6556
  export interface DescribeBotResponse {
5984
6557
  /**
6558
+ * @public
5985
6559
  * <p>The unique identifier of the bot.</p>
5986
6560
  */
5987
6561
  botId?: string;
5988
6562
  /**
6563
+ * @public
5989
6564
  * <p>The name of the bot.</p>
5990
6565
  */
5991
6566
  botName?: string;
5992
6567
  /**
6568
+ * @public
5993
6569
  * <p>The description of the bot. </p>
5994
6570
  */
5995
6571
  description?: string;
5996
6572
  /**
6573
+ * @public
5997
6574
  * <p>The Amazon Resource Name (ARN) of an IAM role that has permission to
5998
6575
  * access the bot.</p>
5999
6576
  */
6000
6577
  roleArn?: string;
6001
6578
  /**
6579
+ * @public
6002
6580
  * <p>Settings for managing data privacy of the bot and its conversations
6003
6581
  * with users.</p>
6004
6582
  */
6005
6583
  dataPrivacy?: DataPrivacy;
6006
6584
  /**
6585
+ * @public
6007
6586
  * <p>The maximum time in seconds that Amazon Lex retains the data gathered in
6008
6587
  * a conversation.</p>
6009
6588
  */
6010
6589
  idleSessionTTLInSeconds?: number;
6011
6590
  /**
6591
+ * @public
6012
6592
  * <p>The current status of the bot. When the status is
6013
6593
  * <code>Available</code> the bot is ready to be used in conversations
6014
6594
  * with users.</p>
6015
6595
  */
6016
6596
  botStatus?: BotStatus | string;
6017
6597
  /**
6598
+ * @public
6018
6599
  * <p>A timestamp of the date and time that the bot was created.</p>
6019
6600
  */
6020
6601
  creationDateTime?: Date;
6021
6602
  /**
6603
+ * @public
6022
6604
  * <p>A timestamp of the date and time that the bot was last
6023
6605
  * updated.</p>
6024
6606
  */
6025
6607
  lastUpdatedDateTime?: Date;
6026
6608
  /**
6609
+ * @public
6027
6610
  * <p>The type of the bot that was described.</p>
6028
6611
  */
6029
6612
  botType?: BotType | string;
6030
6613
  /**
6614
+ * @public
6031
6615
  * <p>The list of bots in the network that was described.</p>
6032
6616
  */
6033
6617
  botMembers?: BotMember[];
6034
6618
  /**
6619
+ * @public
6035
6620
  * <p>If the <code>botStatus</code> is <code>Failed</code>, this contains
6036
6621
  * a list of reasons that the bot couldn't be built.</p>
6037
6622
  */
@@ -6042,10 +6627,12 @@ export interface DescribeBotResponse {
6042
6627
  */
6043
6628
  export interface DescribeBotAliasRequest {
6044
6629
  /**
6630
+ * @public
6045
6631
  * <p>The identifier of the bot alias to describe.</p>
6046
6632
  */
6047
6633
  botAliasId: string | undefined;
6048
6634
  /**
6635
+ * @public
6049
6636
  * <p>The identifier of the bot associated with the bot alias to
6050
6637
  * describe.</p>
6051
6638
  */
@@ -6057,10 +6644,12 @@ export interface DescribeBotAliasRequest {
6057
6644
  */
6058
6645
  export interface ParentBotNetwork {
6059
6646
  /**
6647
+ * @public
6060
6648
  * <p>The identifier of the network of bots assigned by Amazon Lex.</p>
6061
6649
  */
6062
6650
  botId: string | undefined;
6063
6651
  /**
6652
+ * @public
6064
6653
  * <p>The version of the network of bots.</p>
6065
6654
  */
6066
6655
  botVersion: string | undefined;
@@ -6070,60 +6659,73 @@ export interface ParentBotNetwork {
6070
6659
  */
6071
6660
  export interface DescribeBotAliasResponse {
6072
6661
  /**
6662
+ * @public
6073
6663
  * <p>The identifier of the bot alias.</p>
6074
6664
  */
6075
6665
  botAliasId?: string;
6076
6666
  /**
6667
+ * @public
6077
6668
  * <p>The name of the bot alias.</p>
6078
6669
  */
6079
6670
  botAliasName?: string;
6080
6671
  /**
6672
+ * @public
6081
6673
  * <p>The description of the bot alias.</p>
6082
6674
  */
6083
6675
  description?: string;
6084
6676
  /**
6677
+ * @public
6085
6678
  * <p>The version of the bot associated with the bot alias.</p>
6086
6679
  */
6087
6680
  botVersion?: string;
6088
6681
  /**
6682
+ * @public
6089
6683
  * <p>The locale settings that are unique to the alias.</p>
6090
6684
  */
6091
6685
  botAliasLocaleSettings?: Record<string, BotAliasLocaleSettings>;
6092
6686
  /**
6687
+ * @public
6093
6688
  * <p>Specifics of how Amazon Lex logs text and audio conversations with the
6094
6689
  * bot associated with the alias.</p>
6095
6690
  */
6096
6691
  conversationLogSettings?: ConversationLogSettings;
6097
6692
  /**
6693
+ * @public
6098
6694
  * <p>Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of
6099
6695
  * user utterances.</p>
6100
6696
  */
6101
6697
  sentimentAnalysisSettings?: SentimentAnalysisSettings;
6102
6698
  /**
6699
+ * @public
6103
6700
  * <p>A list of events that affect a bot alias. For example, an event is
6104
6701
  * recorded when the version that the alias points to changes.</p>
6105
6702
  */
6106
6703
  botAliasHistoryEvents?: BotAliasHistoryEvent[];
6107
6704
  /**
6705
+ * @public
6108
6706
  * <p>The current status of the alias. When the alias is
6109
6707
  * <code>Available</code>, the alias is ready for use with your
6110
6708
  * bot.</p>
6111
6709
  */
6112
6710
  botAliasStatus?: BotAliasStatus | string;
6113
6711
  /**
6712
+ * @public
6114
6713
  * <p>The identifier of the bot associated with the bot alias.</p>
6115
6714
  */
6116
6715
  botId?: string;
6117
6716
  /**
6717
+ * @public
6118
6718
  * <p>A timestamp of the date and time that the alias was created.</p>
6119
6719
  */
6120
6720
  creationDateTime?: Date;
6121
6721
  /**
6722
+ * @public
6122
6723
  * <p>A timestamp of the date and time that the alias was last
6123
6724
  * updated.</p>
6124
6725
  */
6125
6726
  lastUpdatedDateTime?: Date;
6126
6727
  /**
6728
+ * @public
6127
6729
  * <p>A list of the networks to which the bot alias you described belongs.</p>
6128
6730
  */
6129
6731
  parentBotNetworks?: ParentBotNetwork[];
@@ -6133,15 +6735,18 @@ export interface DescribeBotAliasResponse {
6133
6735
  */
6134
6736
  export interface DescribeBotLocaleRequest {
6135
6737
  /**
6738
+ * @public
6136
6739
  * <p>The identifier of the bot associated with the locale.</p>
6137
6740
  */
6138
6741
  botId: string | undefined;
6139
6742
  /**
6743
+ * @public
6140
6744
  * <p>The version of the bot associated with the
6141
6745
  * locale.</p>
6142
6746
  */
6143
6747
  botVersion: string | undefined;
6144
6748
  /**
6749
+ * @public
6145
6750
  * <p>The unique identifier of the locale to describe. The string must
6146
6751
  * match one of the supported locales. For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>. </p>
6147
6752
  */
@@ -6152,27 +6757,33 @@ export interface DescribeBotLocaleRequest {
6152
6757
  */
6153
6758
  export interface DescribeBotLocaleResponse {
6154
6759
  /**
6760
+ * @public
6155
6761
  * <p>The identifier of the bot associated with the locale.</p>
6156
6762
  */
6157
6763
  botId?: string;
6158
6764
  /**
6765
+ * @public
6159
6766
  * <p>The version of the bot associated with the
6160
6767
  * locale.</p>
6161
6768
  */
6162
6769
  botVersion?: string;
6163
6770
  /**
6771
+ * @public
6164
6772
  * <p>The unique identifier of the described locale.</p>
6165
6773
  */
6166
6774
  localeId?: string;
6167
6775
  /**
6776
+ * @public
6168
6777
  * <p>The name of the locale.</p>
6169
6778
  */
6170
6779
  localeName?: string;
6171
6780
  /**
6781
+ * @public
6172
6782
  * <p>The description of the locale.</p>
6173
6783
  */
6174
6784
  description?: string;
6175
6785
  /**
6786
+ * @public
6176
6787
  * <p>The confidence threshold where Amazon Lex inserts the
6177
6788
  * <code>AMAZON.FallbackIntent</code> and
6178
6789
  * <code>AMAZON.KendraSearchIntent</code> intents in the list of
@@ -6180,48 +6791,58 @@ export interface DescribeBotLocaleResponse {
6180
6791
  */
6181
6792
  nluIntentConfidenceThreshold?: number;
6182
6793
  /**
6794
+ * @public
6183
6795
  * <p>The Amazon Polly voice Amazon Lex uses for voice interaction with the
6184
6796
  * user.</p>
6185
6797
  */
6186
6798
  voiceSettings?: VoiceSettings;
6187
6799
  /**
6800
+ * @public
6188
6801
  * <p>The number of intents defined for the locale.</p>
6189
6802
  */
6190
6803
  intentsCount?: number;
6191
6804
  /**
6805
+ * @public
6192
6806
  * <p>The number of slot types defined for the locale.</p>
6193
6807
  */
6194
6808
  slotTypesCount?: number;
6195
6809
  /**
6810
+ * @public
6196
6811
  * <p>The status of the bot. If the status is <code>Failed</code>, the
6197
6812
  * reasons for the failure are listed in the <code>failureReasons</code>
6198
6813
  * field.</p>
6199
6814
  */
6200
6815
  botLocaleStatus?: BotLocaleStatus | string;
6201
6816
  /**
6817
+ * @public
6202
6818
  * <p>if <code>botLocaleStatus</code> is <code>Failed</code>, Amazon Lex
6203
6819
  * explains why it failed to build the bot.</p>
6204
6820
  */
6205
6821
  failureReasons?: string[];
6206
6822
  /**
6823
+ * @public
6207
6824
  * <p>The date and time that the locale was created.</p>
6208
6825
  */
6209
6826
  creationDateTime?: Date;
6210
6827
  /**
6828
+ * @public
6211
6829
  * <p>The date and time that the locale was last updated.</p>
6212
6830
  */
6213
6831
  lastUpdatedDateTime?: Date;
6214
6832
  /**
6833
+ * @public
6215
6834
  * <p>The date and time that the locale was last submitted for
6216
6835
  * building.</p>
6217
6836
  */
6218
6837
  lastBuildSubmittedDateTime?: Date;
6219
6838
  /**
6839
+ * @public
6220
6840
  * <p>History of changes, such as when a locale is used in an alias, that
6221
6841
  * have taken place for the locale.</p>
6222
6842
  */
6223
6843
  botLocaleHistoryEvents?: BotLocaleHistoryEvent[];
6224
6844
  /**
6845
+ * @public
6225
6846
  * <p>Recommended actions to take to resolve an error in the
6226
6847
  * <code>failureReasons</code> field.</p>
6227
6848
  */
@@ -6232,22 +6853,26 @@ export interface DescribeBotLocaleResponse {
6232
6853
  */
6233
6854
  export interface DescribeBotRecommendationRequest {
6234
6855
  /**
6856
+ * @public
6235
6857
  * <p>The unique identifier of the bot associated with the bot
6236
6858
  * recommendation.</p>
6237
6859
  */
6238
6860
  botId: string | undefined;
6239
6861
  /**
6862
+ * @public
6240
6863
  * <p>The version of the bot associated with the bot
6241
6864
  * recommendation.</p>
6242
6865
  */
6243
6866
  botVersion: string | undefined;
6244
6867
  /**
6868
+ * @public
6245
6869
  * <p>The identifier of the language and locale of the bot recommendation
6246
6870
  * to describe. The string must match one of the supported locales. For
6247
6871
  * more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.</p>
6248
6872
  */
6249
6873
  localeId: string | undefined;
6250
6874
  /**
6875
+ * @public
6251
6876
  * <p>The identifier of the bot recommendation to describe.</p>
6252
6877
  */
6253
6878
  botRecommendationId: string | undefined;
@@ -6260,16 +6885,19 @@ export interface DescribeBotRecommendationRequest {
6260
6885
  */
6261
6886
  export interface EncryptionSetting {
6262
6887
  /**
6888
+ * @public
6263
6889
  * <p>The KMS key ARN used to encrypt the metadata associated with the bot
6264
6890
  * recommendation.</p>
6265
6891
  */
6266
6892
  kmsKeyArn?: string;
6267
6893
  /**
6894
+ * @public
6268
6895
  * <p>The password used to encrypt the recommended bot recommendation
6269
6896
  * file.</p>
6270
6897
  */
6271
6898
  botLocaleExportPassword?: string;
6272
6899
  /**
6900
+ * @public
6273
6901
  * <p>The password used to encrypt the associated transcript file.</p>
6274
6902
  */
6275
6903
  associatedTranscriptsPassword?: string;
@@ -6283,6 +6911,7 @@ export interface EncryptionSetting {
6283
6911
  */
6284
6912
  export interface PathFormat {
6285
6913
  /**
6914
+ * @public
6286
6915
  * <p>A list of Amazon S3 prefixes that points to sub-folders in the Amazon S3
6287
6916
  * bucket. Specify this list if you only want Lex to read the files under
6288
6917
  * this set of sub-folders.</p>
@@ -6296,6 +6925,7 @@ export interface PathFormat {
6296
6925
  */
6297
6926
  export interface LexTranscriptFilter {
6298
6927
  /**
6928
+ * @public
6299
6929
  * <p>The object that contains a date range filter that will be applied to
6300
6930
  * the transcript. Specify this object if you want Amazon Lex to only read the
6301
6931
  * files that are within the date range.</p>
@@ -6309,6 +6939,7 @@ export interface LexTranscriptFilter {
6309
6939
  */
6310
6940
  export interface TranscriptFilter {
6311
6941
  /**
6942
+ * @public
6312
6943
  * <p>The object representing the filter that Amazon Lex will use to select the
6313
6944
  * appropriate transcript when the transcript format is the Amazon Lex
6314
6945
  * format.</p>
@@ -6333,11 +6964,13 @@ export type TranscriptFormat = (typeof TranscriptFormat)[keyof typeof Transcript
6333
6964
  */
6334
6965
  export interface S3BucketTranscriptSource {
6335
6966
  /**
6967
+ * @public
6336
6968
  * <p>The name of the bucket containing the transcript and the associated
6337
6969
  * metadata.</p>
6338
6970
  */
6339
6971
  s3BucketName: string | undefined;
6340
6972
  /**
6973
+ * @public
6341
6974
  * <p>The object that contains a path format that will be applied when
6342
6975
  * Amazon Lex reads the transcript file in the bucket you provide. Specify this
6343
6976
  * object if you only want Lex to read a subset of files in your Amazon S3
@@ -6345,11 +6978,13 @@ export interface S3BucketTranscriptSource {
6345
6978
  */
6346
6979
  pathFormat?: PathFormat;
6347
6980
  /**
6981
+ * @public
6348
6982
  * <p>The format of the transcript content. Currently, Genie only supports
6349
6983
  * the Amazon Lex transcript format.</p>
6350
6984
  */
6351
6985
  transcriptFormat: TranscriptFormat | string | undefined;
6352
6986
  /**
6987
+ * @public
6353
6988
  * <p>The object that contains the filter which will be applied when Amazon Lex
6354
6989
  * reads through the Amazon S3 bucket. Specify this object if you want Amazon Lex to
6355
6990
  * read only a subset of the Amazon S3 bucket based on the filter you
@@ -6357,6 +6992,7 @@ export interface S3BucketTranscriptSource {
6357
6992
  */
6358
6993
  transcriptFilter?: TranscriptFilter;
6359
6994
  /**
6995
+ * @public
6360
6996
  * <p>The ARN of the KMS key that customer use to encrypt their Amazon S3
6361
6997
  * bucket. Only use this field if your bucket is encrypted using a
6362
6998
  * customer managed KMS key.</p>
@@ -6370,6 +7006,7 @@ export interface S3BucketTranscriptSource {
6370
7006
  */
6371
7007
  export interface TranscriptSourceSetting {
6372
7008
  /**
7009
+ * @public
6373
7010
  * <p>Indicates the setting of the Amazon S3 bucket where the transcript is
6374
7011
  * stored.</p>
6375
7012
  */
@@ -6380,55 +7017,66 @@ export interface TranscriptSourceSetting {
6380
7017
  */
6381
7018
  export interface DescribeBotRecommendationResponse {
6382
7019
  /**
7020
+ * @public
6383
7021
  * <p>The identifier of the bot associated with the bot
6384
7022
  * recommendation.</p>
6385
7023
  */
6386
7024
  botId?: string;
6387
7025
  /**
7026
+ * @public
6388
7027
  * <p>The version of the bot associated with the bot
6389
7028
  * recommendation.</p>
6390
7029
  */
6391
7030
  botVersion?: string;
6392
7031
  /**
7032
+ * @public
6393
7033
  * <p>The identifier of the language and locale of the bot recommendation
6394
7034
  * to describe.</p>
6395
7035
  */
6396
7036
  localeId?: string;
6397
7037
  /**
7038
+ * @public
6398
7039
  * <p>The status of the bot recommendation. If the status is Failed, then
6399
7040
  * the reasons for the failure are listed in the failureReasons field.
6400
7041
  * </p>
6401
7042
  */
6402
7043
  botRecommendationStatus?: BotRecommendationStatus | string;
6403
7044
  /**
7045
+ * @public
6404
7046
  * <p>The identifier of the bot recommendation being described.</p>
6405
7047
  */
6406
7048
  botRecommendationId?: string;
6407
7049
  /**
7050
+ * @public
6408
7051
  * <p>If botRecommendationStatus is Failed, Amazon Lex explains why.</p>
6409
7052
  */
6410
7053
  failureReasons?: string[];
6411
7054
  /**
7055
+ * @public
6412
7056
  * <p>The date and time that the bot recommendation was created.</p>
6413
7057
  */
6414
7058
  creationDateTime?: Date;
6415
7059
  /**
7060
+ * @public
6416
7061
  * <p>The date and time that the bot recommendation was last
6417
7062
  * updated.</p>
6418
7063
  */
6419
7064
  lastUpdatedDateTime?: Date;
6420
7065
  /**
7066
+ * @public
6421
7067
  * <p>The object representing the Amazon S3 bucket containing the transcript,
6422
7068
  * as well as the associated metadata.</p>
6423
7069
  */
6424
7070
  transcriptSourceSetting?: TranscriptSourceSetting;
6425
7071
  /**
7072
+ * @public
6426
7073
  * <p>The object representing the passwords that were used to encrypt the
6427
7074
  * data related to the bot recommendation results, as well as the KMS key
6428
7075
  * ARN used to encrypt the associated metadata.</p>
6429
7076
  */
6430
7077
  encryptionSetting?: EncryptionSetting;
6431
7078
  /**
7079
+ * @public
6432
7080
  * <p>The object representing the URL of the bot definition, the URL of
6433
7081
  * the associated transcript and a statistical summary of the bot
6434
7082
  * recommendation results.</p>
@@ -6440,11 +7088,13 @@ export interface DescribeBotRecommendationResponse {
6440
7088
  */
6441
7089
  export interface DescribeBotVersionRequest {
6442
7090
  /**
7091
+ * @public
6443
7092
  * <p>The identifier of the bot containing the version to return metadata
6444
7093
  * for.</p>
6445
7094
  */
6446
7095
  botId: string | undefined;
6447
7096
  /**
7097
+ * @public
6448
7098
  * <p>The version of the bot to return metadata for.</p>
6449
7099
  */
6450
7100
  botVersion: string | undefined;
@@ -6454,59 +7104,72 @@ export interface DescribeBotVersionRequest {
6454
7104
  */
6455
7105
  export interface DescribeBotVersionResponse {
6456
7106
  /**
7107
+ * @public
6457
7108
  * <p>The identifier of the bot that contains the version.</p>
6458
7109
  */
6459
7110
  botId?: string;
6460
7111
  /**
7112
+ * @public
6461
7113
  * <p>The name of the bot that contains the version.</p>
6462
7114
  */
6463
7115
  botName?: string;
6464
7116
  /**
7117
+ * @public
6465
7118
  * <p>The version of the bot that was described.</p>
6466
7119
  */
6467
7120
  botVersion?: string;
6468
7121
  /**
7122
+ * @public
6469
7123
  * <p>The description specified for the bot.</p>
6470
7124
  */
6471
7125
  description?: string;
6472
7126
  /**
7127
+ * @public
6473
7128
  * <p>The Amazon Resource Name (ARN) of an IAM role that has permission to
6474
7129
  * access the bot version.</p>
6475
7130
  */
6476
7131
  roleArn?: string;
6477
7132
  /**
7133
+ * @public
6478
7134
  * <p>Data privacy settings for the bot version.</p>
6479
7135
  */
6480
7136
  dataPrivacy?: DataPrivacy;
6481
7137
  /**
7138
+ * @public
6482
7139
  * <p>The number of seconds that a session with the bot remains active
6483
7140
  * before it is discarded by Amazon Lex.</p>
6484
7141
  */
6485
7142
  idleSessionTTLInSeconds?: number;
6486
7143
  /**
7144
+ * @public
6487
7145
  * <p>The current status of the bot. When the status is
6488
7146
  * <code>Available</code>, the bot version is ready for use.</p>
6489
7147
  */
6490
7148
  botStatus?: BotStatus | string;
6491
7149
  /**
7150
+ * @public
6492
7151
  * <p>If the <code>botStatus</code> is <code>Failed</code>, this contains
6493
7152
  * a list of reasons that the version couldn't be built.</p>
6494
7153
  */
6495
7154
  failureReasons?: string[];
6496
7155
  /**
7156
+ * @public
6497
7157
  * <p>A timestamp of the date and time that the bot version was
6498
7158
  * created.</p>
6499
7159
  */
6500
7160
  creationDateTime?: Date;
6501
7161
  /**
7162
+ * @public
6502
7163
  * <p>A list of the networks to which the bot version you described belongs.</p>
6503
7164
  */
6504
7165
  parentBotNetworks?: ParentBotNetwork[];
6505
7166
  /**
7167
+ * @public
6506
7168
  * <p>The type of the bot in the version that was described.</p>
6507
7169
  */
6508
7170
  botType?: BotType | string;
6509
7171
  /**
7172
+ * @public
6510
7173
  * <p>The members of bot network in the version that was described.</p>
6511
7174
  */
6512
7175
  botMembers?: BotMember[];
@@ -6516,14 +7179,17 @@ export interface DescribeBotVersionResponse {
6516
7179
  */
6517
7180
  export interface DescribeCustomVocabularyMetadataRequest {
6518
7181
  /**
7182
+ * @public
6519
7183
  * <p>The unique identifier of the bot that contains the custom vocabulary.</p>
6520
7184
  */
6521
7185
  botId: string | undefined;
6522
7186
  /**
7187
+ * @public
6523
7188
  * <p>The bot version of the bot to return metadata for.</p>
6524
7189
  */
6525
7190
  botVersion: string | undefined;
6526
7191
  /**
7192
+ * @public
6527
7193
  * <p>The locale to return the custom vocabulary information for.
6528
7194
  * The locale must be <code>en_GB</code>.</p>
6529
7195
  */
@@ -6534,27 +7200,33 @@ export interface DescribeCustomVocabularyMetadataRequest {
6534
7200
  */
6535
7201
  export interface DescribeCustomVocabularyMetadataResponse {
6536
7202
  /**
7203
+ * @public
6537
7204
  * <p>The identifier of the bot that contains the custom vocabulary.</p>
6538
7205
  */
6539
7206
  botId?: string;
6540
7207
  /**
7208
+ * @public
6541
7209
  * <p>The version of the bot that contains the custom vocabulary to describe.</p>
6542
7210
  */
6543
7211
  botVersion?: string;
6544
7212
  /**
7213
+ * @public
6545
7214
  * <p>The locale that contains the custom vocabulary to describe.</p>
6546
7215
  */
6547
7216
  localeId?: string;
6548
7217
  /**
7218
+ * @public
6549
7219
  * <p>The status of the custom vocabulary. If the status is
6550
7220
  * <code>Ready</code> the custom vocabulary is ready to use.</p>
6551
7221
  */
6552
7222
  customVocabularyStatus?: CustomVocabularyStatus | string;
6553
7223
  /**
7224
+ * @public
6554
7225
  * <p>The date and time that the custom vocabulary was created.</p>
6555
7226
  */
6556
7227
  creationDateTime?: Date;
6557
7228
  /**
7229
+ * @public
6558
7230
  * <p>The date and time that the custom vocabulary was last updated.</p>
6559
7231
  */
6560
7232
  lastUpdatedDateTime?: Date;
@@ -6564,6 +7236,7 @@ export interface DescribeCustomVocabularyMetadataResponse {
6564
7236
  */
6565
7237
  export interface DescribeExportRequest {
6566
7238
  /**
7239
+ * @public
6567
7240
  * <p>The unique identifier of the export to describe.</p>
6568
7241
  */
6569
7242
  exportId: string | undefined;
@@ -6573,40 +7246,48 @@ export interface DescribeExportRequest {
6573
7246
  */
6574
7247
  export interface DescribeExportResponse {
6575
7248
  /**
7249
+ * @public
6576
7250
  * <p>The unique identifier of the described export.</p>
6577
7251
  */
6578
7252
  exportId?: string;
6579
7253
  /**
7254
+ * @public
6580
7255
  * <p>The bot, bot ID, and optional locale ID of the exported bot or bot
6581
7256
  * locale.</p>
6582
7257
  */
6583
7258
  resourceSpecification?: ExportResourceSpecification;
6584
7259
  /**
7260
+ * @public
6585
7261
  * <p>The file format used in the files that describe the resource.
6586
7262
  * </p>
6587
7263
  */
6588
7264
  fileFormat?: ImportExportFileFormat | string;
6589
7265
  /**
7266
+ * @public
6590
7267
  * <p>The status of the export. When the status is <code>Complete</code>
6591
7268
  * the export archive file is available for download.</p>
6592
7269
  */
6593
7270
  exportStatus?: ExportStatus | string;
6594
7271
  /**
7272
+ * @public
6595
7273
  * <p>If the <code>exportStatus</code> is failed, contains one or more
6596
7274
  * reasons why the export could not be completed.</p>
6597
7275
  */
6598
7276
  failureReasons?: string[];
6599
7277
  /**
7278
+ * @public
6600
7279
  * <p>A pre-signed S3 URL that points to the bot or bot locale archive.
6601
7280
  * The URL is only available for 5 minutes after calling the
6602
7281
  * <code>DescribeExport</code> operation.</p>
6603
7282
  */
6604
7283
  downloadUrl?: string;
6605
7284
  /**
7285
+ * @public
6606
7286
  * <p>The date and time that the export was created.</p>
6607
7287
  */
6608
7288
  creationDateTime?: Date;
6609
7289
  /**
7290
+ * @public
6610
7291
  * <p>The last date and time that the export was updated.</p>
6611
7292
  */
6612
7293
  lastUpdatedDateTime?: Date;
@@ -6616,6 +7297,7 @@ export interface DescribeExportResponse {
6616
7297
  */
6617
7298
  export interface DescribeImportRequest {
6618
7299
  /**
7300
+ * @public
6619
7301
  * <p>The unique identifier of the import to describe.</p>
6620
7302
  */
6621
7303
  importId: string | undefined;
@@ -6639,10 +7321,12 @@ export type MergeStrategy = (typeof MergeStrategy)[keyof typeof MergeStrategy];
6639
7321
  */
6640
7322
  export interface TestSetImportInputLocation {
6641
7323
  /**
7324
+ * @public
6642
7325
  * <p>The name of the Amazon S3 bucket.</p>
6643
7326
  */
6644
7327
  s3BucketName: string | undefined;
6645
7328
  /**
7329
+ * @public
6646
7330
  * <p>The path inside the Amazon S3 bucket pointing to the test-set CSV file.</p>
6647
7331
  */
6648
7332
  s3Path: string | undefined;
@@ -6665,14 +7349,17 @@ export type TestSetModality = (typeof TestSetModality)[keyof typeof TestSetModal
6665
7349
  */
6666
7350
  export interface TestSetStorageLocation {
6667
7351
  /**
7352
+ * @public
6668
7353
  * <p>The name of the Amazon S3 bucket in which the test set is stored.</p>
6669
7354
  */
6670
7355
  s3BucketName: string | undefined;
6671
7356
  /**
7357
+ * @public
6672
7358
  * <p>The path inside the Amazon S3 bucket where the test set is stored.</p>
6673
7359
  */
6674
7360
  s3Path: string | undefined;
6675
7361
  /**
7362
+ * @public
6676
7363
  * <p>The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service
6677
7364
  * (KMS) key for encrypting the test set.</p>
6678
7365
  */
@@ -6684,31 +7371,38 @@ export interface TestSetStorageLocation {
6684
7371
  */
6685
7372
  export interface TestSetImportResourceSpecification {
6686
7373
  /**
7374
+ * @public
6687
7375
  * <p>The name of the test set.</p>
6688
7376
  */
6689
7377
  testSetName: string | undefined;
6690
7378
  /**
7379
+ * @public
6691
7380
  * <p>The description of the test set.</p>
6692
7381
  */
6693
7382
  description?: string;
6694
7383
  /**
7384
+ * @public
6695
7385
  * <p>The Amazon Resource Name (ARN) of an IAM role that has
6696
7386
  * permission to access the test set.</p>
6697
7387
  */
6698
7388
  roleArn: string | undefined;
6699
7389
  /**
7390
+ * @public
6700
7391
  * <p>Contains information about the location that Amazon Lex uses to store the test-set.</p>
6701
7392
  */
6702
7393
  storageLocation: TestSetStorageLocation | undefined;
6703
7394
  /**
7395
+ * @public
6704
7396
  * <p>Contains information about the input location from where test-set should be imported.</p>
6705
7397
  */
6706
7398
  importInputLocation: TestSetImportInputLocation | undefined;
6707
7399
  /**
7400
+ * @public
6708
7401
  * <p>Specifies whether the test-set being imported contains written or spoken data.</p>
6709
7402
  */
6710
7403
  modality: TestSetModality | string | undefined;
6711
7404
  /**
7405
+ * @public
6712
7406
  * <p>A list of tags to add to the test set. You can only add tags when you import/generate a new test set. You can't use the <code>UpdateTestSet</code> operation to update tags. To update tags, use the <code>TagResource</code> operation.</p>
6713
7407
  */
6714
7408
  testSetTags?: Record<string, string>;
@@ -6721,18 +7415,22 @@ export interface TestSetImportResourceSpecification {
6721
7415
  */
6722
7416
  export interface ImportResourceSpecification {
6723
7417
  /**
7418
+ * @public
6724
7419
  * <p>Parameters for importing a bot.</p>
6725
7420
  */
6726
7421
  botImportSpecification?: BotImportSpecification;
6727
7422
  /**
7423
+ * @public
6728
7424
  * <p>Parameters for importing a bot locale.</p>
6729
7425
  */
6730
7426
  botLocaleImportSpecification?: BotLocaleImportSpecification;
6731
7427
  /**
7428
+ * @public
6732
7429
  * <p>Provides the parameters required for importing a custom vocabulary.</p>
6733
7430
  */
6734
7431
  customVocabularyImportSpecification?: CustomVocabularyImportSpecification;
6735
7432
  /**
7433
+ * @public
6736
7434
  * <p>Specifications for the test set that is imported.</p>
6737
7435
  */
6738
7436
  testSetImportResourceSpecification?: TestSetImportResourceSpecification;
@@ -6742,24 +7440,29 @@ export interface ImportResourceSpecification {
6742
7440
  */
6743
7441
  export interface DescribeImportResponse {
6744
7442
  /**
7443
+ * @public
6745
7444
  * <p>The unique identifier of the described import.</p>
6746
7445
  */
6747
7446
  importId?: string;
6748
7447
  /**
7448
+ * @public
6749
7449
  * <p>The specifications of the imported bot, bot locale, or custom
6750
7450
  * vocabulary.</p>
6751
7451
  */
6752
7452
  resourceSpecification?: ImportResourceSpecification;
6753
7453
  /**
7454
+ * @public
6754
7455
  * <p>The unique identifier that Amazon Lex assigned to the resource created by
6755
7456
  * the import.</p>
6756
7457
  */
6757
7458
  importedResourceId?: string;
6758
7459
  /**
7460
+ * @public
6759
7461
  * <p>The name of the imported resource.</p>
6760
7462
  */
6761
7463
  importedResourceName?: string;
6762
7464
  /**
7465
+ * @public
6763
7466
  * <p>The strategy used when there was a name conflict between the
6764
7467
  * imported resource and an existing resource. When the merge strategy is
6765
7468
  * <code>FailOnConflict</code> existing resources are not overwritten
@@ -6767,21 +7470,25 @@ export interface DescribeImportResponse {
6767
7470
  */
6768
7471
  mergeStrategy?: MergeStrategy | string;
6769
7472
  /**
7473
+ * @public
6770
7474
  * <p>The status of the import process. When the status is
6771
7475
  * <code>Completed</code> the resource is imported and ready for
6772
7476
  * use.</p>
6773
7477
  */
6774
7478
  importStatus?: ImportStatus | string;
6775
7479
  /**
7480
+ * @public
6776
7481
  * <p>If the <code>importStatus</code> field is <code>Failed</code>, this
6777
7482
  * provides one or more reasons for the failure.</p>
6778
7483
  */
6779
7484
  failureReasons?: string[];
6780
7485
  /**
7486
+ * @public
6781
7487
  * <p>The date and time that the import was created.</p>
6782
7488
  */
6783
7489
  creationDateTime?: Date;
6784
7490
  /**
7491
+ * @public
6785
7492
  * <p>The date and time that the import was last updated.</p>
6786
7493
  */
6787
7494
  lastUpdatedDateTime?: Date;
@@ -6791,18 +7498,22 @@ export interface DescribeImportResponse {
6791
7498
  */
6792
7499
  export interface DescribeIntentRequest {
6793
7500
  /**
7501
+ * @public
6794
7502
  * <p>The identifier of the intent to describe.</p>
6795
7503
  */
6796
7504
  intentId: string | undefined;
6797
7505
  /**
7506
+ * @public
6798
7507
  * <p>The identifier of the bot associated with the intent.</p>
6799
7508
  */
6800
7509
  botId: string | undefined;
6801
7510
  /**
7511
+ * @public
6802
7512
  * <p>The version of the bot associated with the intent.</p>
6803
7513
  */
6804
7514
  botVersion: string | undefined;
6805
7515
  /**
7516
+ * @public
6806
7517
  * <p>The identifier of the language and locale of the intent to describe.
6807
7518
  * The string must match one of the supported locales. For more
6808
7519
  * information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.</p>
@@ -6816,10 +7527,12 @@ export interface DescribeIntentRequest {
6816
7527
  */
6817
7528
  export interface SlotPriority {
6818
7529
  /**
7530
+ * @public
6819
7531
  * <p>The priority that Amazon Lex should apply to the slot.</p>
6820
7532
  */
6821
7533
  priority: number | undefined;
6822
7534
  /**
7535
+ * @public
6823
7536
  * <p>The unique identifier of the slot.</p>
6824
7537
  */
6825
7538
  slotId: string | undefined;
@@ -6829,6 +7542,7 @@ export interface SlotPriority {
6829
7542
  */
6830
7543
  export interface DescribeResourcePolicyRequest {
6831
7544
  /**
7545
+ * @public
6832
7546
  * <p>The Amazon Resource Name (ARN) of the bot or bot alias that the
6833
7547
  * resource policy is attached to.</p>
6834
7548
  */
@@ -6839,17 +7553,20 @@ export interface DescribeResourcePolicyRequest {
6839
7553
  */
6840
7554
  export interface DescribeResourcePolicyResponse {
6841
7555
  /**
7556
+ * @public
6842
7557
  * <p>The Amazon Resource Name (ARN) of the bot or bot alias that the
6843
7558
  * resource policy is attached to.</p>
6844
7559
  */
6845
7560
  resourceArn?: string;
6846
7561
  /**
7562
+ * @public
6847
7563
  * <p>The JSON structure that contains the resource policy. For more
6848
7564
  * information about the contents of a JSON policy document, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html"> IAM JSON policy
6849
7565
  * reference </a>.</p>
6850
7566
  */
6851
7567
  policy?: string;
6852
7568
  /**
7569
+ * @public
6853
7570
  * <p>The current revision of the resource policy. Use the revision ID to
6854
7571
  * make sure that you are updating the most current version of a resource
6855
7572
  * policy when you add a policy statement to a resource, delete a
@@ -6862,24 +7579,29 @@ export interface DescribeResourcePolicyResponse {
6862
7579
  */
6863
7580
  export interface DescribeSlotRequest {
6864
7581
  /**
7582
+ * @public
6865
7583
  * <p>The unique identifier for the slot.</p>
6866
7584
  */
6867
7585
  slotId: string | undefined;
6868
7586
  /**
7587
+ * @public
6869
7588
  * <p>The identifier of the bot associated with the slot.</p>
6870
7589
  */
6871
7590
  botId: string | undefined;
6872
7591
  /**
7592
+ * @public
6873
7593
  * <p>The version of the bot associated with the slot.</p>
6874
7594
  */
6875
7595
  botVersion: string | undefined;
6876
7596
  /**
7597
+ * @public
6877
7598
  * <p>The identifier of the language and locale of the slot to describe.
6878
7599
  * The string must match one of the supported locales. For more
6879
7600
  * information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.</p>
6880
7601
  */
6881
7602
  localeId: string | undefined;
6882
7603
  /**
7604
+ * @public
6883
7605
  * <p>The identifier of the intent that contains the slot.</p>
6884
7606
  */
6885
7607
  intentId: string | undefined;
@@ -6889,18 +7611,22 @@ export interface DescribeSlotRequest {
6889
7611
  */
6890
7612
  export interface DescribeSlotTypeRequest {
6891
7613
  /**
7614
+ * @public
6892
7615
  * <p>The identifier of the slot type.</p>
6893
7616
  */
6894
7617
  slotTypeId: string | undefined;
6895
7618
  /**
7619
+ * @public
6896
7620
  * <p>The identifier of the bot associated with the slot type.</p>
6897
7621
  */
6898
7622
  botId: string | undefined;
6899
7623
  /**
7624
+ * @public
6900
7625
  * <p>The version of the bot associated with the slot type.</p>
6901
7626
  */
6902
7627
  botVersion: string | undefined;
6903
7628
  /**
7629
+ * @public
6904
7630
  * <p>The identifier of the language and locale of the slot type to
6905
7631
  * describe. The string must match one of the supported locales. For more
6906
7632
  * information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.</p>