aws-sdk-lexmodelsv2 1.26.0 → 1.27.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.
@@ -1283,6 +1283,33 @@ module Aws::LexModelsV2
1283
1283
  include Aws::Structure
1284
1284
  end
1285
1285
 
1286
+ # A composite slot is a combination of two or more slots that capture
1287
+ # multiple pieces of information in a single user input.
1288
+ #
1289
+ # @note When making an API call, you may pass CompositeSlotTypeSetting
1290
+ # data as a hash:
1291
+ #
1292
+ # {
1293
+ # sub_slots: [
1294
+ # {
1295
+ # name: "Name", # required
1296
+ # slot_type_id: "BuiltInOrCustomSlotTypeId", # required
1297
+ # },
1298
+ # ],
1299
+ # }
1300
+ #
1301
+ # @!attribute [rw] sub_slots
1302
+ # Subslots in the composite slot.
1303
+ # @return [Array<Types::SubSlotTypeComposition>]
1304
+ #
1305
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CompositeSlotTypeSetting AWS API Documentation
1306
+ #
1307
+ class CompositeSlotTypeSetting < Struct.new(
1308
+ :sub_slots)
1309
+ SENSITIVE = []
1310
+ include Aws::Structure
1311
+ end
1312
+
1286
1313
  # Provides an expression that evaluates to true or false.
1287
1314
  #
1288
1315
  # @note When making an API call, you may pass Condition
@@ -8002,6 +8029,247 @@ module Aws::LexModelsV2
8002
8029
  # multiple_values_setting: {
8003
8030
  # allow_multiple_values: false,
8004
8031
  # },
8032
+ # sub_slot_setting: {
8033
+ # expression: "SubSlotExpression",
8034
+ # slot_specifications: {
8035
+ # "Name" => {
8036
+ # slot_type_id: "BuiltInOrCustomSlotTypeId", # required
8037
+ # value_elicitation_setting: { # required
8038
+ # default_value_specification: {
8039
+ # default_value_list: [ # required
8040
+ # {
8041
+ # default_value: "SlotDefaultValueString", # required
8042
+ # },
8043
+ # ],
8044
+ # },
8045
+ # prompt_specification: { # required
8046
+ # message_groups: [ # required
8047
+ # {
8048
+ # message: { # required
8049
+ # plain_text_message: {
8050
+ # value: "PlainTextMessageValue", # required
8051
+ # },
8052
+ # custom_payload: {
8053
+ # value: "CustomPayloadValue", # required
8054
+ # },
8055
+ # ssml_message: {
8056
+ # value: "SSMLMessageValue", # required
8057
+ # },
8058
+ # image_response_card: {
8059
+ # title: "AttachmentTitle", # required
8060
+ # subtitle: "AttachmentTitle",
8061
+ # image_url: "AttachmentUrl",
8062
+ # buttons: [
8063
+ # {
8064
+ # text: "ButtonText", # required
8065
+ # value: "ButtonValue", # required
8066
+ # },
8067
+ # ],
8068
+ # },
8069
+ # },
8070
+ # variations: [
8071
+ # {
8072
+ # plain_text_message: {
8073
+ # value: "PlainTextMessageValue", # required
8074
+ # },
8075
+ # custom_payload: {
8076
+ # value: "CustomPayloadValue", # required
8077
+ # },
8078
+ # ssml_message: {
8079
+ # value: "SSMLMessageValue", # required
8080
+ # },
8081
+ # image_response_card: {
8082
+ # title: "AttachmentTitle", # required
8083
+ # subtitle: "AttachmentTitle",
8084
+ # image_url: "AttachmentUrl",
8085
+ # buttons: [
8086
+ # {
8087
+ # text: "ButtonText", # required
8088
+ # value: "ButtonValue", # required
8089
+ # },
8090
+ # ],
8091
+ # },
8092
+ # },
8093
+ # ],
8094
+ # },
8095
+ # ],
8096
+ # max_retries: 1, # required
8097
+ # allow_interrupt: false,
8098
+ # message_selection_strategy: "Random", # accepts Random, Ordered
8099
+ # },
8100
+ # sample_utterances: [
8101
+ # {
8102
+ # utterance: "Utterance", # required
8103
+ # },
8104
+ # ],
8105
+ # wait_and_continue_specification: {
8106
+ # waiting_response: { # required
8107
+ # message_groups: [ # required
8108
+ # {
8109
+ # message: { # required
8110
+ # plain_text_message: {
8111
+ # value: "PlainTextMessageValue", # required
8112
+ # },
8113
+ # custom_payload: {
8114
+ # value: "CustomPayloadValue", # required
8115
+ # },
8116
+ # ssml_message: {
8117
+ # value: "SSMLMessageValue", # required
8118
+ # },
8119
+ # image_response_card: {
8120
+ # title: "AttachmentTitle", # required
8121
+ # subtitle: "AttachmentTitle",
8122
+ # image_url: "AttachmentUrl",
8123
+ # buttons: [
8124
+ # {
8125
+ # text: "ButtonText", # required
8126
+ # value: "ButtonValue", # required
8127
+ # },
8128
+ # ],
8129
+ # },
8130
+ # },
8131
+ # variations: [
8132
+ # {
8133
+ # plain_text_message: {
8134
+ # value: "PlainTextMessageValue", # required
8135
+ # },
8136
+ # custom_payload: {
8137
+ # value: "CustomPayloadValue", # required
8138
+ # },
8139
+ # ssml_message: {
8140
+ # value: "SSMLMessageValue", # required
8141
+ # },
8142
+ # image_response_card: {
8143
+ # title: "AttachmentTitle", # required
8144
+ # subtitle: "AttachmentTitle",
8145
+ # image_url: "AttachmentUrl",
8146
+ # buttons: [
8147
+ # {
8148
+ # text: "ButtonText", # required
8149
+ # value: "ButtonValue", # required
8150
+ # },
8151
+ # ],
8152
+ # },
8153
+ # },
8154
+ # ],
8155
+ # },
8156
+ # ],
8157
+ # allow_interrupt: false,
8158
+ # },
8159
+ # continue_response: { # required
8160
+ # message_groups: [ # required
8161
+ # {
8162
+ # message: { # required
8163
+ # plain_text_message: {
8164
+ # value: "PlainTextMessageValue", # required
8165
+ # },
8166
+ # custom_payload: {
8167
+ # value: "CustomPayloadValue", # required
8168
+ # },
8169
+ # ssml_message: {
8170
+ # value: "SSMLMessageValue", # required
8171
+ # },
8172
+ # image_response_card: {
8173
+ # title: "AttachmentTitle", # required
8174
+ # subtitle: "AttachmentTitle",
8175
+ # image_url: "AttachmentUrl",
8176
+ # buttons: [
8177
+ # {
8178
+ # text: "ButtonText", # required
8179
+ # value: "ButtonValue", # required
8180
+ # },
8181
+ # ],
8182
+ # },
8183
+ # },
8184
+ # variations: [
8185
+ # {
8186
+ # plain_text_message: {
8187
+ # value: "PlainTextMessageValue", # required
8188
+ # },
8189
+ # custom_payload: {
8190
+ # value: "CustomPayloadValue", # required
8191
+ # },
8192
+ # ssml_message: {
8193
+ # value: "SSMLMessageValue", # required
8194
+ # },
8195
+ # image_response_card: {
8196
+ # title: "AttachmentTitle", # required
8197
+ # subtitle: "AttachmentTitle",
8198
+ # image_url: "AttachmentUrl",
8199
+ # buttons: [
8200
+ # {
8201
+ # text: "ButtonText", # required
8202
+ # value: "ButtonValue", # required
8203
+ # },
8204
+ # ],
8205
+ # },
8206
+ # },
8207
+ # ],
8208
+ # },
8209
+ # ],
8210
+ # allow_interrupt: false,
8211
+ # },
8212
+ # still_waiting_response: {
8213
+ # message_groups: [ # required
8214
+ # {
8215
+ # message: { # required
8216
+ # plain_text_message: {
8217
+ # value: "PlainTextMessageValue", # required
8218
+ # },
8219
+ # custom_payload: {
8220
+ # value: "CustomPayloadValue", # required
8221
+ # },
8222
+ # ssml_message: {
8223
+ # value: "SSMLMessageValue", # required
8224
+ # },
8225
+ # image_response_card: {
8226
+ # title: "AttachmentTitle", # required
8227
+ # subtitle: "AttachmentTitle",
8228
+ # image_url: "AttachmentUrl",
8229
+ # buttons: [
8230
+ # {
8231
+ # text: "ButtonText", # required
8232
+ # value: "ButtonValue", # required
8233
+ # },
8234
+ # ],
8235
+ # },
8236
+ # },
8237
+ # variations: [
8238
+ # {
8239
+ # plain_text_message: {
8240
+ # value: "PlainTextMessageValue", # required
8241
+ # },
8242
+ # custom_payload: {
8243
+ # value: "CustomPayloadValue", # required
8244
+ # },
8245
+ # ssml_message: {
8246
+ # value: "SSMLMessageValue", # required
8247
+ # },
8248
+ # image_response_card: {
8249
+ # title: "AttachmentTitle", # required
8250
+ # subtitle: "AttachmentTitle",
8251
+ # image_url: "AttachmentUrl",
8252
+ # buttons: [
8253
+ # {
8254
+ # text: "ButtonText", # required
8255
+ # value: "ButtonValue", # required
8256
+ # },
8257
+ # ],
8258
+ # },
8259
+ # },
8260
+ # ],
8261
+ # },
8262
+ # ],
8263
+ # frequency_in_seconds: 1, # required
8264
+ # timeout_in_seconds: 1, # required
8265
+ # allow_interrupt: false,
8266
+ # },
8267
+ # active: false,
8268
+ # },
8269
+ # },
8270
+ # },
8271
+ # },
8272
+ # },
8005
8273
  # }
8006
8274
  #
8007
8275
  # @!attribute [rw] slot_name
@@ -8068,6 +8336,11 @@ module Aws::LexModelsV2
8068
8336
  # `false`.
8069
8337
  # @return [Types::MultipleValuesSetting]
8070
8338
  #
8339
+ # @!attribute [rw] sub_slot_setting
8340
+ # Specifications for the constituent sub slots and the expression for
8341
+ # the composite slot.
8342
+ # @return [Types::SubSlotSetting]
8343
+ #
8071
8344
  # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateSlotRequest AWS API Documentation
8072
8345
  #
8073
8346
  class CreateSlotRequest < Struct.new(
@@ -8080,7 +8353,8 @@ module Aws::LexModelsV2
8080
8353
  :bot_version,
8081
8354
  :locale_id,
8082
8355
  :intent_id,
8083
- :multiple_values_setting)
8356
+ :multiple_values_setting,
8357
+ :sub_slot_setting)
8084
8358
  SENSITIVE = []
8085
8359
  include Aws::Structure
8086
8360
  end
@@ -8135,6 +8409,11 @@ module Aws::LexModelsV2
8135
8409
  # Indicates whether the slot returns multiple values in one response.
8136
8410
  # @return [Types::MultipleValuesSetting]
8137
8411
  #
8412
+ # @!attribute [rw] sub_slot_setting
8413
+ # Specifications for the constituent sub slots and the expression for
8414
+ # the composite slot.
8415
+ # @return [Types::SubSlotSetting]
8416
+ #
8138
8417
  # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateSlotResponse AWS API Documentation
8139
8418
  #
8140
8419
  class CreateSlotResponse < Struct.new(
@@ -8149,7 +8428,8 @@ module Aws::LexModelsV2
8149
8428
  :locale_id,
8150
8429
  :intent_id,
8151
8430
  :creation_date_time,
8152
- :multiple_values_setting)
8431
+ :multiple_values_setting,
8432
+ :sub_slot_setting)
8153
8433
  SENSITIVE = []
8154
8434
  include Aws::Structure
8155
8435
  end
@@ -8173,7 +8453,7 @@ module Aws::LexModelsV2
8173
8453
  # },
8174
8454
  # ],
8175
8455
  # value_selection_setting: {
8176
- # resolution_strategy: "OriginalValue", # required, accepts OriginalValue, TopResolution
8456
+ # resolution_strategy: "OriginalValue", # required, accepts OriginalValue, TopResolution, Concatenation
8177
8457
  # regex_filter: {
8178
8458
  # pattern: "RegexPattern", # required
8179
8459
  # },
@@ -8194,6 +8474,14 @@ module Aws::LexModelsV2
8194
8474
  # },
8195
8475
  # },
8196
8476
  # },
8477
+ # composite_slot_type_setting: {
8478
+ # sub_slots: [
8479
+ # {
8480
+ # name: "Name", # required
8481
+ # slot_type_id: "BuiltInOrCustomSlotTypeId", # required
8482
+ # },
8483
+ # ],
8484
+ # },
8197
8485
  # }
8198
8486
  #
8199
8487
  # @!attribute [rw] slot_type_name
@@ -8260,6 +8548,10 @@ module Aws::LexModelsV2
8260
8548
  # Sets the type of external information used to create the slot type.
8261
8549
  # @return [Types::ExternalSourceSetting]
8262
8550
  #
8551
+ # @!attribute [rw] composite_slot_type_setting
8552
+ # Specifications for a composite slot type.
8553
+ # @return [Types::CompositeSlotTypeSetting]
8554
+ #
8263
8555
  # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateSlotTypeRequest AWS API Documentation
8264
8556
  #
8265
8557
  class CreateSlotTypeRequest < Struct.new(
@@ -8271,7 +8563,8 @@ module Aws::LexModelsV2
8271
8563
  :bot_id,
8272
8564
  :bot_version,
8273
8565
  :locale_id,
8274
- :external_source_setting)
8566
+ :external_source_setting,
8567
+ :composite_slot_type_setting)
8275
8568
  SENSITIVE = []
8276
8569
  include Aws::Structure
8277
8570
  end
@@ -8323,6 +8616,10 @@ module Aws::LexModelsV2
8323
8616
  # The type of external information used to create the slot type.
8324
8617
  # @return [Types::ExternalSourceSetting]
8325
8618
  #
8619
+ # @!attribute [rw] composite_slot_type_setting
8620
+ # Specifications for a composite slot type.
8621
+ # @return [Types::CompositeSlotTypeSetting]
8622
+ #
8326
8623
  # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateSlotTypeResponse AWS API Documentation
8327
8624
  #
8328
8625
  class CreateSlotTypeResponse < Struct.new(
@@ -8336,7 +8633,8 @@ module Aws::LexModelsV2
8336
8633
  :bot_version,
8337
8634
  :locale_id,
8338
8635
  :creation_date_time,
8339
- :external_source_setting)
8636
+ :external_source_setting,
8637
+ :composite_slot_type_setting)
8340
8638
  SENSITIVE = []
8341
8639
  include Aws::Structure
8342
8640
  end
@@ -10355,6 +10653,11 @@ module Aws::LexModelsV2
10355
10653
  # `false`.
10356
10654
  # @return [Types::MultipleValuesSetting]
10357
10655
  #
10656
+ # @!attribute [rw] sub_slot_setting
10657
+ # Specifications for the constituent sub slots and the expression for
10658
+ # the composite slot.
10659
+ # @return [Types::SubSlotSetting]
10660
+ #
10358
10661
  # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeSlotResponse AWS API Documentation
10359
10662
  #
10360
10663
  class DescribeSlotResponse < Struct.new(
@@ -10370,7 +10673,8 @@ module Aws::LexModelsV2
10370
10673
  :intent_id,
10371
10674
  :creation_date_time,
10372
10675
  :last_updated_date_time,
10373
- :multiple_values_setting)
10676
+ :multiple_values_setting,
10677
+ :sub_slot_setting)
10374
10678
  SENSITIVE = []
10375
10679
  include Aws::Structure
10376
10680
  end
@@ -10470,6 +10774,10 @@ module Aws::LexModelsV2
10470
10774
  # definition.
10471
10775
  # @return [Types::ExternalSourceSetting]
10472
10776
  #
10777
+ # @!attribute [rw] composite_slot_type_setting
10778
+ # Specifications for a composite slot type.
10779
+ # @return [Types::CompositeSlotTypeSetting]
10780
+ #
10473
10781
  # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/DescribeSlotTypeResponse AWS API Documentation
10474
10782
  #
10475
10783
  class DescribeSlotTypeResponse < Struct.new(
@@ -10484,7 +10792,8 @@ module Aws::LexModelsV2
10484
10792
  :locale_id,
10485
10793
  :creation_date_time,
10486
10794
  :last_updated_date_time,
10487
- :external_source_setting)
10795
+ :external_source_setting,
10796
+ :composite_slot_type_setting)
10488
10797
  SENSITIVE = []
10489
10798
  include Aws::Structure
10490
10799
  end
@@ -22288,7 +22597,8 @@ module Aws::LexModelsV2
22288
22597
  include Aws::Structure
22289
22598
  end
22290
22599
 
22291
- # Settings that you can use for eliciting a slot value.
22600
+ # Specifies the elicitation setting details for constituent sub slots of
22601
+ # a composite slot.
22292
22602
  #
22293
22603
  # @note When making an API call, you may pass SlotValueElicitationSetting
22294
22604
  # data as a hash:
@@ -23932,7 +24242,7 @@ module Aws::LexModelsV2
23932
24242
  # data as a hash:
23933
24243
  #
23934
24244
  # {
23935
- # resolution_strategy: "OriginalValue", # required, accepts OriginalValue, TopResolution
24245
+ # resolution_strategy: "OriginalValue", # required, accepts OriginalValue, TopResolution, Concatenation
23936
24246
  # regex_filter: {
23937
24247
  # pattern: "RegexPattern", # required
23938
24248
  # },
@@ -23976,40 +24286,618 @@ module Aws::LexModelsV2
23976
24286
  include Aws::Structure
23977
24287
  end
23978
24288
 
23979
- # @note When making an API call, you may pass StartBotRecommendationRequest
24289
+ # Subslot specifications.
24290
+ #
24291
+ # @note When making an API call, you may pass Specifications
23980
24292
  # data as a hash:
23981
24293
  #
23982
24294
  # {
23983
- # bot_id: "Id", # required
23984
- # bot_version: "DraftBotVersion", # required
23985
- # locale_id: "LocaleId", # required
23986
- # transcript_source_setting: { # required
23987
- # s3_bucket_transcript_source: {
23988
- # s3_bucket_name: "S3BucketName", # required
24295
+ # slot_type_id: "BuiltInOrCustomSlotTypeId", # required
24296
+ # value_elicitation_setting: { # required
24297
+ # default_value_specification: {
24298
+ # default_value_list: [ # required
24299
+ # {
24300
+ # default_value: "SlotDefaultValueString", # required
24301
+ # },
24302
+ # ],
24303
+ # },
24304
+ # prompt_specification: { # required
24305
+ # message_groups: [ # required
24306
+ # {
24307
+ # message: { # required
24308
+ # plain_text_message: {
24309
+ # value: "PlainTextMessageValue", # required
24310
+ # },
24311
+ # custom_payload: {
24312
+ # value: "CustomPayloadValue", # required
24313
+ # },
24314
+ # ssml_message: {
24315
+ # value: "SSMLMessageValue", # required
24316
+ # },
24317
+ # image_response_card: {
24318
+ # title: "AttachmentTitle", # required
24319
+ # subtitle: "AttachmentTitle",
24320
+ # image_url: "AttachmentUrl",
24321
+ # buttons: [
24322
+ # {
24323
+ # text: "ButtonText", # required
24324
+ # value: "ButtonValue", # required
24325
+ # },
24326
+ # ],
24327
+ # },
24328
+ # },
24329
+ # variations: [
24330
+ # {
24331
+ # plain_text_message: {
24332
+ # value: "PlainTextMessageValue", # required
24333
+ # },
24334
+ # custom_payload: {
24335
+ # value: "CustomPayloadValue", # required
24336
+ # },
24337
+ # ssml_message: {
24338
+ # value: "SSMLMessageValue", # required
24339
+ # },
24340
+ # image_response_card: {
24341
+ # title: "AttachmentTitle", # required
24342
+ # subtitle: "AttachmentTitle",
24343
+ # image_url: "AttachmentUrl",
24344
+ # buttons: [
24345
+ # {
24346
+ # text: "ButtonText", # required
24347
+ # value: "ButtonValue", # required
24348
+ # },
24349
+ # ],
24350
+ # },
24351
+ # },
24352
+ # ],
24353
+ # },
24354
+ # ],
24355
+ # max_retries: 1, # required
24356
+ # allow_interrupt: false,
24357
+ # message_selection_strategy: "Random", # accepts Random, Ordered
24358
+ # },
24359
+ # sample_utterances: [
24360
+ # {
24361
+ # utterance: "Utterance", # required
24362
+ # },
24363
+ # ],
24364
+ # wait_and_continue_specification: {
24365
+ # waiting_response: { # required
24366
+ # message_groups: [ # required
24367
+ # {
24368
+ # message: { # required
24369
+ # plain_text_message: {
24370
+ # value: "PlainTextMessageValue", # required
24371
+ # },
24372
+ # custom_payload: {
24373
+ # value: "CustomPayloadValue", # required
24374
+ # },
24375
+ # ssml_message: {
24376
+ # value: "SSMLMessageValue", # required
24377
+ # },
24378
+ # image_response_card: {
24379
+ # title: "AttachmentTitle", # required
24380
+ # subtitle: "AttachmentTitle",
24381
+ # image_url: "AttachmentUrl",
24382
+ # buttons: [
24383
+ # {
24384
+ # text: "ButtonText", # required
24385
+ # value: "ButtonValue", # required
24386
+ # },
24387
+ # ],
24388
+ # },
24389
+ # },
24390
+ # variations: [
24391
+ # {
24392
+ # plain_text_message: {
24393
+ # value: "PlainTextMessageValue", # required
24394
+ # },
24395
+ # custom_payload: {
24396
+ # value: "CustomPayloadValue", # required
24397
+ # },
24398
+ # ssml_message: {
24399
+ # value: "SSMLMessageValue", # required
24400
+ # },
24401
+ # image_response_card: {
24402
+ # title: "AttachmentTitle", # required
24403
+ # subtitle: "AttachmentTitle",
24404
+ # image_url: "AttachmentUrl",
24405
+ # buttons: [
24406
+ # {
24407
+ # text: "ButtonText", # required
24408
+ # value: "ButtonValue", # required
24409
+ # },
24410
+ # ],
24411
+ # },
24412
+ # },
24413
+ # ],
24414
+ # },
24415
+ # ],
24416
+ # allow_interrupt: false,
24417
+ # },
24418
+ # continue_response: { # required
24419
+ # message_groups: [ # required
24420
+ # {
24421
+ # message: { # required
24422
+ # plain_text_message: {
24423
+ # value: "PlainTextMessageValue", # required
24424
+ # },
24425
+ # custom_payload: {
24426
+ # value: "CustomPayloadValue", # required
24427
+ # },
24428
+ # ssml_message: {
24429
+ # value: "SSMLMessageValue", # required
24430
+ # },
24431
+ # image_response_card: {
24432
+ # title: "AttachmentTitle", # required
24433
+ # subtitle: "AttachmentTitle",
24434
+ # image_url: "AttachmentUrl",
24435
+ # buttons: [
24436
+ # {
24437
+ # text: "ButtonText", # required
24438
+ # value: "ButtonValue", # required
24439
+ # },
24440
+ # ],
24441
+ # },
24442
+ # },
24443
+ # variations: [
24444
+ # {
24445
+ # plain_text_message: {
24446
+ # value: "PlainTextMessageValue", # required
24447
+ # },
24448
+ # custom_payload: {
24449
+ # value: "CustomPayloadValue", # required
24450
+ # },
24451
+ # ssml_message: {
24452
+ # value: "SSMLMessageValue", # required
24453
+ # },
24454
+ # image_response_card: {
24455
+ # title: "AttachmentTitle", # required
24456
+ # subtitle: "AttachmentTitle",
24457
+ # image_url: "AttachmentUrl",
24458
+ # buttons: [
24459
+ # {
24460
+ # text: "ButtonText", # required
24461
+ # value: "ButtonValue", # required
24462
+ # },
24463
+ # ],
24464
+ # },
24465
+ # },
24466
+ # ],
24467
+ # },
24468
+ # ],
24469
+ # allow_interrupt: false,
24470
+ # },
24471
+ # still_waiting_response: {
24472
+ # message_groups: [ # required
24473
+ # {
24474
+ # message: { # required
24475
+ # plain_text_message: {
24476
+ # value: "PlainTextMessageValue", # required
24477
+ # },
24478
+ # custom_payload: {
24479
+ # value: "CustomPayloadValue", # required
24480
+ # },
24481
+ # ssml_message: {
24482
+ # value: "SSMLMessageValue", # required
24483
+ # },
24484
+ # image_response_card: {
24485
+ # title: "AttachmentTitle", # required
24486
+ # subtitle: "AttachmentTitle",
24487
+ # image_url: "AttachmentUrl",
24488
+ # buttons: [
24489
+ # {
24490
+ # text: "ButtonText", # required
24491
+ # value: "ButtonValue", # required
24492
+ # },
24493
+ # ],
24494
+ # },
24495
+ # },
24496
+ # variations: [
24497
+ # {
24498
+ # plain_text_message: {
24499
+ # value: "PlainTextMessageValue", # required
24500
+ # },
24501
+ # custom_payload: {
24502
+ # value: "CustomPayloadValue", # required
24503
+ # },
24504
+ # ssml_message: {
24505
+ # value: "SSMLMessageValue", # required
24506
+ # },
24507
+ # image_response_card: {
24508
+ # title: "AttachmentTitle", # required
24509
+ # subtitle: "AttachmentTitle",
24510
+ # image_url: "AttachmentUrl",
24511
+ # buttons: [
24512
+ # {
24513
+ # text: "ButtonText", # required
24514
+ # value: "ButtonValue", # required
24515
+ # },
24516
+ # ],
24517
+ # },
24518
+ # },
24519
+ # ],
24520
+ # },
24521
+ # ],
24522
+ # frequency_in_seconds: 1, # required
24523
+ # timeout_in_seconds: 1, # required
24524
+ # allow_interrupt: false,
24525
+ # },
24526
+ # active: false,
24527
+ # },
24528
+ # },
24529
+ # }
24530
+ #
24531
+ # @!attribute [rw] slot_type_id
24532
+ # The unique identifier assigned to the slot type.
24533
+ # @return [String]
24534
+ #
24535
+ # @!attribute [rw] value_elicitation_setting
24536
+ # Specifies the elicitation setting details for constituent sub slots
24537
+ # of a composite slot.
24538
+ # @return [Types::SubSlotValueElicitationSetting]
24539
+ #
24540
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/Specifications AWS API Documentation
24541
+ #
24542
+ class Specifications < Struct.new(
24543
+ :slot_type_id,
24544
+ :value_elicitation_setting)
24545
+ SENSITIVE = []
24546
+ include Aws::Structure
24547
+ end
24548
+
24549
+ # @note When making an API call, you may pass StartBotRecommendationRequest
24550
+ # data as a hash:
24551
+ #
24552
+ # {
24553
+ # bot_id: "Id", # required
24554
+ # bot_version: "DraftBotVersion", # required
24555
+ # locale_id: "LocaleId", # required
24556
+ # transcript_source_setting: { # required
24557
+ # s3_bucket_transcript_source: {
24558
+ # s3_bucket_name: "S3BucketName", # required
23989
24559
  # path_format: {
23990
24560
  # object_prefixes: ["ObjectPrefix"],
23991
24561
  # },
23992
- # transcript_format: "Lex", # required, accepts Lex
23993
- # transcript_filter: {
23994
- # lex_transcript_filter: {
23995
- # date_range_filter: {
23996
- # start_date_time: Time.now, # required
23997
- # end_date_time: Time.now, # required
23998
- # },
23999
- # },
24562
+ # transcript_format: "Lex", # required, accepts Lex
24563
+ # transcript_filter: {
24564
+ # lex_transcript_filter: {
24565
+ # date_range_filter: {
24566
+ # start_date_time: Time.now, # required
24567
+ # end_date_time: Time.now, # required
24568
+ # },
24569
+ # },
24570
+ # },
24571
+ # kms_key_arn: "KmsKeyArn",
24572
+ # },
24573
+ # },
24574
+ # encryption_setting: {
24575
+ # kms_key_arn: "KmsKeyArn",
24576
+ # bot_locale_export_password: "FilePassword",
24577
+ # associated_transcripts_password: "FilePassword",
24578
+ # },
24579
+ # }
24580
+ #
24581
+ # @!attribute [rw] bot_id
24582
+ # The unique identifier of the bot containing the bot recommendation.
24583
+ # @return [String]
24584
+ #
24585
+ # @!attribute [rw] bot_version
24586
+ # The version of the bot containing the bot recommendation.
24587
+ # @return [String]
24588
+ #
24589
+ # @!attribute [rw] locale_id
24590
+ # The identifier of the language and locale of the bot recommendation
24591
+ # to start. The string must match one of the supported locales. For
24592
+ # more information, see [Supported languages][1]
24593
+ #
24594
+ #
24595
+ #
24596
+ # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html
24597
+ # @return [String]
24598
+ #
24599
+ # @!attribute [rw] transcript_source_setting
24600
+ # The object representing the Amazon S3 bucket containing the
24601
+ # transcript, as well as the associated metadata.
24602
+ # @return [Types::TranscriptSourceSetting]
24603
+ #
24604
+ # @!attribute [rw] encryption_setting
24605
+ # The object representing the passwords that will be used to encrypt
24606
+ # the data related to the bot recommendation results, as well as the
24607
+ # KMS key ARN used to encrypt the associated metadata.
24608
+ # @return [Types::EncryptionSetting]
24609
+ #
24610
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StartBotRecommendationRequest AWS API Documentation
24611
+ #
24612
+ class StartBotRecommendationRequest < Struct.new(
24613
+ :bot_id,
24614
+ :bot_version,
24615
+ :locale_id,
24616
+ :transcript_source_setting,
24617
+ :encryption_setting)
24618
+ SENSITIVE = []
24619
+ include Aws::Structure
24620
+ end
24621
+
24622
+ # @!attribute [rw] bot_id
24623
+ # The unique identifier of the bot containing the bot recommendation.
24624
+ # @return [String]
24625
+ #
24626
+ # @!attribute [rw] bot_version
24627
+ # The version of the bot containing the bot recommendation.
24628
+ # @return [String]
24629
+ #
24630
+ # @!attribute [rw] locale_id
24631
+ # The identifier of the language and locale of the bot recommendation
24632
+ # to start. The string must match one of the supported locales. For
24633
+ # more information, see [Supported languages][1]
24634
+ #
24635
+ #
24636
+ #
24637
+ # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html
24638
+ # @return [String]
24639
+ #
24640
+ # @!attribute [rw] bot_recommendation_status
24641
+ # The status of the bot recommendation.
24642
+ #
24643
+ # If the status is Failed, then the reasons for the failure are listed
24644
+ # in the failureReasons field.
24645
+ # @return [String]
24646
+ #
24647
+ # @!attribute [rw] bot_recommendation_id
24648
+ # The identifier of the bot recommendation that you have created.
24649
+ # @return [String]
24650
+ #
24651
+ # @!attribute [rw] creation_date_time
24652
+ # A timestamp of the date and time that the bot recommendation was
24653
+ # created.
24654
+ # @return [Time]
24655
+ #
24656
+ # @!attribute [rw] transcript_source_setting
24657
+ # The object representing the Amazon S3 bucket containing the
24658
+ # transcript, as well as the associated metadata.
24659
+ # @return [Types::TranscriptSourceSetting]
24660
+ #
24661
+ # @!attribute [rw] encryption_setting
24662
+ # The object representing the passwords that were used to encrypt the
24663
+ # data related to the bot recommendation results, as well as the KMS
24664
+ # key ARN used to encrypt the associated metadata.
24665
+ # @return [Types::EncryptionSetting]
24666
+ #
24667
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StartBotRecommendationResponse AWS API Documentation
24668
+ #
24669
+ class StartBotRecommendationResponse < Struct.new(
24670
+ :bot_id,
24671
+ :bot_version,
24672
+ :locale_id,
24673
+ :bot_recommendation_status,
24674
+ :bot_recommendation_id,
24675
+ :creation_date_time,
24676
+ :transcript_source_setting,
24677
+ :encryption_setting)
24678
+ SENSITIVE = []
24679
+ include Aws::Structure
24680
+ end
24681
+
24682
+ # @note When making an API call, you may pass StartImportRequest
24683
+ # data as a hash:
24684
+ #
24685
+ # {
24686
+ # import_id: "Id", # required
24687
+ # resource_specification: { # required
24688
+ # bot_import_specification: {
24689
+ # bot_name: "Name", # required
24690
+ # role_arn: "RoleArn", # required
24691
+ # data_privacy: { # required
24692
+ # child_directed: false, # required
24693
+ # },
24694
+ # idle_session_ttl_in_seconds: 1,
24695
+ # bot_tags: {
24696
+ # "TagKey" => "TagValue",
24697
+ # },
24698
+ # test_bot_alias_tags: {
24699
+ # "TagKey" => "TagValue",
24000
24700
  # },
24001
- # kms_key_arn: "KmsKeyArn",
24701
+ # },
24702
+ # bot_locale_import_specification: {
24703
+ # bot_id: "Id", # required
24704
+ # bot_version: "DraftBotVersion", # required
24705
+ # locale_id: "LocaleId", # required
24706
+ # nlu_intent_confidence_threshold: 1.0,
24707
+ # voice_settings: {
24708
+ # voice_id: "VoiceId", # required
24709
+ # engine: "standard", # accepts standard, neural
24710
+ # },
24711
+ # },
24712
+ # custom_vocabulary_import_specification: {
24713
+ # bot_id: "Id", # required
24714
+ # bot_version: "DraftBotVersion", # required
24715
+ # locale_id: "LocaleId", # required
24002
24716
  # },
24003
24717
  # },
24004
- # encryption_setting: {
24005
- # kms_key_arn: "KmsKeyArn",
24006
- # bot_locale_export_password: "FilePassword",
24007
- # associated_transcripts_password: "FilePassword",
24008
- # },
24718
+ # merge_strategy: "Overwrite", # required, accepts Overwrite, FailOnConflict, Append
24719
+ # file_password: "ImportExportFilePassword",
24720
+ # }
24721
+ #
24722
+ # @!attribute [rw] import_id
24723
+ # The unique identifier for the import. It is included in the response
24724
+ # from the [CreateUploadUrl][1] operation.
24725
+ #
24726
+ #
24727
+ #
24728
+ # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/API_CreateUploadUrl.html
24729
+ # @return [String]
24730
+ #
24731
+ # @!attribute [rw] resource_specification
24732
+ # Parameters for creating the bot, bot locale or custom vocabulary.
24733
+ # @return [Types::ImportResourceSpecification]
24734
+ #
24735
+ # @!attribute [rw] merge_strategy
24736
+ # The strategy to use when there is a name conflict between the
24737
+ # imported resource and an existing resource. When the merge strategy
24738
+ # is `FailOnConflict` existing resources are not overwritten and the
24739
+ # import fails.
24740
+ # @return [String]
24741
+ #
24742
+ # @!attribute [rw] file_password
24743
+ # The password used to encrypt the zip archive that contains the
24744
+ # resource definition. You should always encrypt the zip archive to
24745
+ # protect it during transit between your site and Amazon Lex.
24746
+ # @return [String]
24747
+ #
24748
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StartImportRequest AWS API Documentation
24749
+ #
24750
+ class StartImportRequest < Struct.new(
24751
+ :import_id,
24752
+ :resource_specification,
24753
+ :merge_strategy,
24754
+ :file_password)
24755
+ SENSITIVE = [:file_password]
24756
+ include Aws::Structure
24757
+ end
24758
+
24759
+ # @!attribute [rw] import_id
24760
+ # A unique identifier for the import.
24761
+ # @return [String]
24762
+ #
24763
+ # @!attribute [rw] resource_specification
24764
+ # The parameters used when importing the resource.
24765
+ # @return [Types::ImportResourceSpecification]
24766
+ #
24767
+ # @!attribute [rw] merge_strategy
24768
+ # The strategy used when there was a name conflict between the
24769
+ # imported resource and an existing resource. When the merge strategy
24770
+ # is `FailOnConflict` existing resources are not overwritten and the
24771
+ # import fails.
24772
+ # @return [String]
24773
+ #
24774
+ # @!attribute [rw] import_status
24775
+ # The current status of the import. When the status is `Complete` the
24776
+ # bot, bot alias, or custom vocabulary is ready to use.
24777
+ # @return [String]
24778
+ #
24779
+ # @!attribute [rw] creation_date_time
24780
+ # The date and time that the import request was created.
24781
+ # @return [Time]
24782
+ #
24783
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StartImportResponse AWS API Documentation
24784
+ #
24785
+ class StartImportResponse < Struct.new(
24786
+ :import_id,
24787
+ :resource_specification,
24788
+ :merge_strategy,
24789
+ :import_status,
24790
+ :creation_date_time)
24791
+ SENSITIVE = []
24792
+ include Aws::Structure
24793
+ end
24794
+
24795
+ # Defines the messages that Amazon Lex sends to a user to remind them
24796
+ # that the bot is waiting for a response.
24797
+ #
24798
+ # @note When making an API call, you may pass StillWaitingResponseSpecification
24799
+ # data as a hash:
24800
+ #
24801
+ # {
24802
+ # message_groups: [ # required
24803
+ # {
24804
+ # message: { # required
24805
+ # plain_text_message: {
24806
+ # value: "PlainTextMessageValue", # required
24807
+ # },
24808
+ # custom_payload: {
24809
+ # value: "CustomPayloadValue", # required
24810
+ # },
24811
+ # ssml_message: {
24812
+ # value: "SSMLMessageValue", # required
24813
+ # },
24814
+ # image_response_card: {
24815
+ # title: "AttachmentTitle", # required
24816
+ # subtitle: "AttachmentTitle",
24817
+ # image_url: "AttachmentUrl",
24818
+ # buttons: [
24819
+ # {
24820
+ # text: "ButtonText", # required
24821
+ # value: "ButtonValue", # required
24822
+ # },
24823
+ # ],
24824
+ # },
24825
+ # },
24826
+ # variations: [
24827
+ # {
24828
+ # plain_text_message: {
24829
+ # value: "PlainTextMessageValue", # required
24830
+ # },
24831
+ # custom_payload: {
24832
+ # value: "CustomPayloadValue", # required
24833
+ # },
24834
+ # ssml_message: {
24835
+ # value: "SSMLMessageValue", # required
24836
+ # },
24837
+ # image_response_card: {
24838
+ # title: "AttachmentTitle", # required
24839
+ # subtitle: "AttachmentTitle",
24840
+ # image_url: "AttachmentUrl",
24841
+ # buttons: [
24842
+ # {
24843
+ # text: "ButtonText", # required
24844
+ # value: "ButtonValue", # required
24845
+ # },
24846
+ # ],
24847
+ # },
24848
+ # },
24849
+ # ],
24850
+ # },
24851
+ # ],
24852
+ # frequency_in_seconds: 1, # required
24853
+ # timeout_in_seconds: 1, # required
24854
+ # allow_interrupt: false,
24855
+ # }
24856
+ #
24857
+ # @!attribute [rw] message_groups
24858
+ # One or more message groups, each containing one or more messages,
24859
+ # that define the prompts that Amazon Lex sends to the user.
24860
+ # @return [Array<Types::MessageGroup>]
24861
+ #
24862
+ # @!attribute [rw] frequency_in_seconds
24863
+ # How often a message should be sent to the user. Minimum of 1 second,
24864
+ # maximum of 5 minutes.
24865
+ # @return [Integer]
24866
+ #
24867
+ # @!attribute [rw] timeout_in_seconds
24868
+ # If Amazon Lex waits longer than this length of time for a response,
24869
+ # it will stop sending messages.
24870
+ # @return [Integer]
24871
+ #
24872
+ # @!attribute [rw] allow_interrupt
24873
+ # Indicates that the user can interrupt the response by speaking while
24874
+ # the message is being played.
24875
+ # @return [Boolean]
24876
+ #
24877
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StillWaitingResponseSpecification AWS API Documentation
24878
+ #
24879
+ class StillWaitingResponseSpecification < Struct.new(
24880
+ :message_groups,
24881
+ :frequency_in_seconds,
24882
+ :timeout_in_seconds,
24883
+ :allow_interrupt)
24884
+ SENSITIVE = []
24885
+ include Aws::Structure
24886
+ end
24887
+
24888
+ # @note When making an API call, you may pass StopBotRecommendationRequest
24889
+ # data as a hash:
24890
+ #
24891
+ # {
24892
+ # bot_id: "Id", # required
24893
+ # bot_version: "DraftBotVersion", # required
24894
+ # locale_id: "LocaleId", # required
24895
+ # bot_recommendation_id: "Id", # required
24009
24896
  # }
24010
24897
  #
24011
24898
  # @!attribute [rw] bot_id
24012
- # The unique identifier of the bot containing the bot recommendation.
24899
+ # The unique identifier of the bot containing the bot recommendation
24900
+ # to be stopped.
24013
24901
  # @return [String]
24014
24902
  #
24015
24903
  # @!attribute [rw] bot_version
@@ -24018,49 +24906,43 @@ module Aws::LexModelsV2
24018
24906
  #
24019
24907
  # @!attribute [rw] locale_id
24020
24908
  # The identifier of the language and locale of the bot recommendation
24021
- # to start. The string must match one of the supported locales. For
24909
+ # to stop. The string must match one of the supported locales. For
24022
24910
  # more information, see [Supported languages][1]
24023
24911
  #
24024
24912
  #
24025
24913
  #
24026
- # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html
24027
- # @return [String]
24028
- #
24029
- # @!attribute [rw] transcript_source_setting
24030
- # The object representing the Amazon S3 bucket containing the
24031
- # transcript, as well as the associated metadata.
24032
- # @return [Types::TranscriptSourceSetting]
24033
- #
24034
- # @!attribute [rw] encryption_setting
24035
- # The object representing the passwords that will be used to encrypt
24036
- # the data related to the bot recommendation results, as well as the
24037
- # KMS key ARN used to encrypt the associated metadata.
24038
- # @return [Types::EncryptionSetting]
24039
- #
24040
- # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StartBotRecommendationRequest AWS API Documentation
24914
+ # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html
24915
+ # @return [String]
24041
24916
  #
24042
- class StartBotRecommendationRequest < Struct.new(
24917
+ # @!attribute [rw] bot_recommendation_id
24918
+ # The unique identifier of the bot recommendation to be stopped.
24919
+ # @return [String]
24920
+ #
24921
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StopBotRecommendationRequest AWS API Documentation
24922
+ #
24923
+ class StopBotRecommendationRequest < Struct.new(
24043
24924
  :bot_id,
24044
24925
  :bot_version,
24045
24926
  :locale_id,
24046
- :transcript_source_setting,
24047
- :encryption_setting)
24927
+ :bot_recommendation_id)
24048
24928
  SENSITIVE = []
24049
24929
  include Aws::Structure
24050
24930
  end
24051
24931
 
24052
24932
  # @!attribute [rw] bot_id
24053
- # The unique identifier of the bot containing the bot recommendation.
24933
+ # The unique identifier of the bot containing the bot recommendation
24934
+ # that is being stopped.
24054
24935
  # @return [String]
24055
24936
  #
24056
24937
  # @!attribute [rw] bot_version
24057
- # The version of the bot containing the bot recommendation.
24938
+ # The version of the bot containing the recommendation that is being
24939
+ # stopped.
24058
24940
  # @return [String]
24059
24941
  #
24060
24942
  # @!attribute [rw] locale_id
24061
- # The identifier of the language and locale of the bot recommendation
24062
- # to start. The string must match one of the supported locales. For
24063
- # more information, see [Supported languages][1]
24943
+ # The identifier of the language and locale of the bot response to
24944
+ # stop. The string must match one of the supported locales. For more
24945
+ # information, see [Supported languages][1]
24064
24946
  #
24065
24947
  #
24066
24948
  #
@@ -24068,335 +24950,600 @@ module Aws::LexModelsV2
24068
24950
  # @return [String]
24069
24951
  #
24070
24952
  # @!attribute [rw] bot_recommendation_status
24071
- # The status of the bot recommendation.
24953
+ # The status of the bot recommendation. If the status is Failed, then
24954
+ # the reasons for the failure are listed in the failureReasons field.
24955
+ # @return [String]
24072
24956
  #
24073
- # If the status is Failed, then the reasons for the failure are listed
24074
- # in the failureReasons field.
24957
+ # @!attribute [rw] bot_recommendation_id
24958
+ # The unique identifier of the bot recommendation that is being
24959
+ # stopped.
24075
24960
  # @return [String]
24076
24961
  #
24077
- # @!attribute [rw] bot_recommendation_id
24078
- # The identifier of the bot recommendation that you have created.
24962
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StopBotRecommendationResponse AWS API Documentation
24963
+ #
24964
+ class StopBotRecommendationResponse < Struct.new(
24965
+ :bot_id,
24966
+ :bot_version,
24967
+ :locale_id,
24968
+ :bot_recommendation_status,
24969
+ :bot_recommendation_id)
24970
+ SENSITIVE = []
24971
+ include Aws::Structure
24972
+ end
24973
+
24974
+ # Specifications for the constituent sub slots and the expression for
24975
+ # the composite slot.
24976
+ #
24977
+ # @note When making an API call, you may pass SubSlotSetting
24978
+ # data as a hash:
24979
+ #
24980
+ # {
24981
+ # expression: "SubSlotExpression",
24982
+ # slot_specifications: {
24983
+ # "Name" => {
24984
+ # slot_type_id: "BuiltInOrCustomSlotTypeId", # required
24985
+ # value_elicitation_setting: { # required
24986
+ # default_value_specification: {
24987
+ # default_value_list: [ # required
24988
+ # {
24989
+ # default_value: "SlotDefaultValueString", # required
24990
+ # },
24991
+ # ],
24992
+ # },
24993
+ # prompt_specification: { # required
24994
+ # message_groups: [ # required
24995
+ # {
24996
+ # message: { # required
24997
+ # plain_text_message: {
24998
+ # value: "PlainTextMessageValue", # required
24999
+ # },
25000
+ # custom_payload: {
25001
+ # value: "CustomPayloadValue", # required
25002
+ # },
25003
+ # ssml_message: {
25004
+ # value: "SSMLMessageValue", # required
25005
+ # },
25006
+ # image_response_card: {
25007
+ # title: "AttachmentTitle", # required
25008
+ # subtitle: "AttachmentTitle",
25009
+ # image_url: "AttachmentUrl",
25010
+ # buttons: [
25011
+ # {
25012
+ # text: "ButtonText", # required
25013
+ # value: "ButtonValue", # required
25014
+ # },
25015
+ # ],
25016
+ # },
25017
+ # },
25018
+ # variations: [
25019
+ # {
25020
+ # plain_text_message: {
25021
+ # value: "PlainTextMessageValue", # required
25022
+ # },
25023
+ # custom_payload: {
25024
+ # value: "CustomPayloadValue", # required
25025
+ # },
25026
+ # ssml_message: {
25027
+ # value: "SSMLMessageValue", # required
25028
+ # },
25029
+ # image_response_card: {
25030
+ # title: "AttachmentTitle", # required
25031
+ # subtitle: "AttachmentTitle",
25032
+ # image_url: "AttachmentUrl",
25033
+ # buttons: [
25034
+ # {
25035
+ # text: "ButtonText", # required
25036
+ # value: "ButtonValue", # required
25037
+ # },
25038
+ # ],
25039
+ # },
25040
+ # },
25041
+ # ],
25042
+ # },
25043
+ # ],
25044
+ # max_retries: 1, # required
25045
+ # allow_interrupt: false,
25046
+ # message_selection_strategy: "Random", # accepts Random, Ordered
25047
+ # },
25048
+ # sample_utterances: [
25049
+ # {
25050
+ # utterance: "Utterance", # required
25051
+ # },
25052
+ # ],
25053
+ # wait_and_continue_specification: {
25054
+ # waiting_response: { # required
25055
+ # message_groups: [ # required
25056
+ # {
25057
+ # message: { # required
25058
+ # plain_text_message: {
25059
+ # value: "PlainTextMessageValue", # required
25060
+ # },
25061
+ # custom_payload: {
25062
+ # value: "CustomPayloadValue", # required
25063
+ # },
25064
+ # ssml_message: {
25065
+ # value: "SSMLMessageValue", # required
25066
+ # },
25067
+ # image_response_card: {
25068
+ # title: "AttachmentTitle", # required
25069
+ # subtitle: "AttachmentTitle",
25070
+ # image_url: "AttachmentUrl",
25071
+ # buttons: [
25072
+ # {
25073
+ # text: "ButtonText", # required
25074
+ # value: "ButtonValue", # required
25075
+ # },
25076
+ # ],
25077
+ # },
25078
+ # },
25079
+ # variations: [
25080
+ # {
25081
+ # plain_text_message: {
25082
+ # value: "PlainTextMessageValue", # required
25083
+ # },
25084
+ # custom_payload: {
25085
+ # value: "CustomPayloadValue", # required
25086
+ # },
25087
+ # ssml_message: {
25088
+ # value: "SSMLMessageValue", # required
25089
+ # },
25090
+ # image_response_card: {
25091
+ # title: "AttachmentTitle", # required
25092
+ # subtitle: "AttachmentTitle",
25093
+ # image_url: "AttachmentUrl",
25094
+ # buttons: [
25095
+ # {
25096
+ # text: "ButtonText", # required
25097
+ # value: "ButtonValue", # required
25098
+ # },
25099
+ # ],
25100
+ # },
25101
+ # },
25102
+ # ],
25103
+ # },
25104
+ # ],
25105
+ # allow_interrupt: false,
25106
+ # },
25107
+ # continue_response: { # required
25108
+ # message_groups: [ # required
25109
+ # {
25110
+ # message: { # required
25111
+ # plain_text_message: {
25112
+ # value: "PlainTextMessageValue", # required
25113
+ # },
25114
+ # custom_payload: {
25115
+ # value: "CustomPayloadValue", # required
25116
+ # },
25117
+ # ssml_message: {
25118
+ # value: "SSMLMessageValue", # required
25119
+ # },
25120
+ # image_response_card: {
25121
+ # title: "AttachmentTitle", # required
25122
+ # subtitle: "AttachmentTitle",
25123
+ # image_url: "AttachmentUrl",
25124
+ # buttons: [
25125
+ # {
25126
+ # text: "ButtonText", # required
25127
+ # value: "ButtonValue", # required
25128
+ # },
25129
+ # ],
25130
+ # },
25131
+ # },
25132
+ # variations: [
25133
+ # {
25134
+ # plain_text_message: {
25135
+ # value: "PlainTextMessageValue", # required
25136
+ # },
25137
+ # custom_payload: {
25138
+ # value: "CustomPayloadValue", # required
25139
+ # },
25140
+ # ssml_message: {
25141
+ # value: "SSMLMessageValue", # required
25142
+ # },
25143
+ # image_response_card: {
25144
+ # title: "AttachmentTitle", # required
25145
+ # subtitle: "AttachmentTitle",
25146
+ # image_url: "AttachmentUrl",
25147
+ # buttons: [
25148
+ # {
25149
+ # text: "ButtonText", # required
25150
+ # value: "ButtonValue", # required
25151
+ # },
25152
+ # ],
25153
+ # },
25154
+ # },
25155
+ # ],
25156
+ # },
25157
+ # ],
25158
+ # allow_interrupt: false,
25159
+ # },
25160
+ # still_waiting_response: {
25161
+ # message_groups: [ # required
25162
+ # {
25163
+ # message: { # required
25164
+ # plain_text_message: {
25165
+ # value: "PlainTextMessageValue", # required
25166
+ # },
25167
+ # custom_payload: {
25168
+ # value: "CustomPayloadValue", # required
25169
+ # },
25170
+ # ssml_message: {
25171
+ # value: "SSMLMessageValue", # required
25172
+ # },
25173
+ # image_response_card: {
25174
+ # title: "AttachmentTitle", # required
25175
+ # subtitle: "AttachmentTitle",
25176
+ # image_url: "AttachmentUrl",
25177
+ # buttons: [
25178
+ # {
25179
+ # text: "ButtonText", # required
25180
+ # value: "ButtonValue", # required
25181
+ # },
25182
+ # ],
25183
+ # },
25184
+ # },
25185
+ # variations: [
25186
+ # {
25187
+ # plain_text_message: {
25188
+ # value: "PlainTextMessageValue", # required
25189
+ # },
25190
+ # custom_payload: {
25191
+ # value: "CustomPayloadValue", # required
25192
+ # },
25193
+ # ssml_message: {
25194
+ # value: "SSMLMessageValue", # required
25195
+ # },
25196
+ # image_response_card: {
25197
+ # title: "AttachmentTitle", # required
25198
+ # subtitle: "AttachmentTitle",
25199
+ # image_url: "AttachmentUrl",
25200
+ # buttons: [
25201
+ # {
25202
+ # text: "ButtonText", # required
25203
+ # value: "ButtonValue", # required
25204
+ # },
25205
+ # ],
25206
+ # },
25207
+ # },
25208
+ # ],
25209
+ # },
25210
+ # ],
25211
+ # frequency_in_seconds: 1, # required
25212
+ # timeout_in_seconds: 1, # required
25213
+ # allow_interrupt: false,
25214
+ # },
25215
+ # active: false,
25216
+ # },
25217
+ # },
25218
+ # },
25219
+ # },
25220
+ # }
25221
+ #
25222
+ # @!attribute [rw] expression
25223
+ # The expression text for defining the constituent sub slots in the
25224
+ # composite slot using logical AND and OR operators.
24079
25225
  # @return [String]
24080
25226
  #
24081
- # @!attribute [rw] creation_date_time
24082
- # A timestamp of the date and time that the bot recommendation was
24083
- # created.
24084
- # @return [Time]
24085
- #
24086
- # @!attribute [rw] transcript_source_setting
24087
- # The object representing the Amazon S3 bucket containing the
24088
- # transcript, as well as the associated metadata.
24089
- # @return [Types::TranscriptSourceSetting]
24090
- #
24091
- # @!attribute [rw] encryption_setting
24092
- # The object representing the passwords that were used to encrypt the
24093
- # data related to the bot recommendation results, as well as the KMS
24094
- # key ARN used to encrypt the associated metadata.
24095
- # @return [Types::EncryptionSetting]
25227
+ # @!attribute [rw] slot_specifications
25228
+ # Specifications for the constituent sub slots of a composite slot.
25229
+ # @return [Hash<String,Types::Specifications>]
24096
25230
  #
24097
- # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StartBotRecommendationResponse AWS API Documentation
25231
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SubSlotSetting AWS API Documentation
24098
25232
  #
24099
- class StartBotRecommendationResponse < Struct.new(
24100
- :bot_id,
24101
- :bot_version,
24102
- :locale_id,
24103
- :bot_recommendation_status,
24104
- :bot_recommendation_id,
24105
- :creation_date_time,
24106
- :transcript_source_setting,
24107
- :encryption_setting)
25233
+ class SubSlotSetting < Struct.new(
25234
+ :expression,
25235
+ :slot_specifications)
24108
25236
  SENSITIVE = []
24109
25237
  include Aws::Structure
24110
25238
  end
24111
25239
 
24112
- # @note When making an API call, you may pass StartImportRequest
25240
+ # Subslot type composition.
25241
+ #
25242
+ # @note When making an API call, you may pass SubSlotTypeComposition
24113
25243
  # data as a hash:
24114
25244
  #
24115
25245
  # {
24116
- # import_id: "Id", # required
24117
- # resource_specification: { # required
24118
- # bot_import_specification: {
24119
- # bot_name: "Name", # required
24120
- # role_arn: "RoleArn", # required
24121
- # data_privacy: { # required
24122
- # child_directed: false, # required
24123
- # },
24124
- # idle_session_ttl_in_seconds: 1,
24125
- # bot_tags: {
24126
- # "TagKey" => "TagValue",
24127
- # },
24128
- # test_bot_alias_tags: {
24129
- # "TagKey" => "TagValue",
24130
- # },
24131
- # },
24132
- # bot_locale_import_specification: {
24133
- # bot_id: "Id", # required
24134
- # bot_version: "DraftBotVersion", # required
24135
- # locale_id: "LocaleId", # required
24136
- # nlu_intent_confidence_threshold: 1.0,
24137
- # voice_settings: {
24138
- # voice_id: "VoiceId", # required
24139
- # engine: "standard", # accepts standard, neural
24140
- # },
24141
- # },
24142
- # custom_vocabulary_import_specification: {
24143
- # bot_id: "Id", # required
24144
- # bot_version: "DraftBotVersion", # required
24145
- # locale_id: "LocaleId", # required
24146
- # },
24147
- # },
24148
- # merge_strategy: "Overwrite", # required, accepts Overwrite, FailOnConflict, Append
24149
- # file_password: "ImportExportFilePassword",
25246
+ # name: "Name", # required
25247
+ # slot_type_id: "BuiltInOrCustomSlotTypeId", # required
24150
25248
  # }
24151
25249
  #
24152
- # @!attribute [rw] import_id
24153
- # The unique identifier for the import. It is included in the response
24154
- # from the [CreateUploadUrl][1] operation.
24155
- #
24156
- #
24157
- #
24158
- # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/API_CreateUploadUrl.html
24159
- # @return [String]
24160
- #
24161
- # @!attribute [rw] resource_specification
24162
- # Parameters for creating the bot, bot locale or custom vocabulary.
24163
- # @return [Types::ImportResourceSpecification]
24164
- #
24165
- # @!attribute [rw] merge_strategy
24166
- # The strategy to use when there is a name conflict between the
24167
- # imported resource and an existing resource. When the merge strategy
24168
- # is `FailOnConflict` existing resources are not overwritten and the
24169
- # import fails.
25250
+ # @!attribute [rw] name
25251
+ # Name of a constituent sub slot inside a composite slot.
24170
25252
  # @return [String]
24171
25253
  #
24172
- # @!attribute [rw] file_password
24173
- # The password used to encrypt the zip archive that contains the
24174
- # resource definition. You should always encrypt the zip archive to
24175
- # protect it during transit between your site and Amazon Lex.
25254
+ # @!attribute [rw] slot_type_id
25255
+ # The unique identifier assigned to a slot type. This refers to either
25256
+ # a built-in slot type or the unique slotTypeId of a custom slot type.
24176
25257
  # @return [String]
24177
25258
  #
24178
- # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StartImportRequest AWS API Documentation
25259
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SubSlotTypeComposition AWS API Documentation
24179
25260
  #
24180
- class StartImportRequest < Struct.new(
24181
- :import_id,
24182
- :resource_specification,
24183
- :merge_strategy,
24184
- :file_password)
24185
- SENSITIVE = [:file_password]
25261
+ class SubSlotTypeComposition < Struct.new(
25262
+ :name,
25263
+ :slot_type_id)
25264
+ SENSITIVE = []
24186
25265
  include Aws::Structure
24187
25266
  end
24188
25267
 
24189
- # @!attribute [rw] import_id
24190
- # A unique identifier for the import.
24191
- # @return [String]
24192
- #
24193
- # @!attribute [rw] resource_specification
24194
- # The parameters used when importing the resource.
24195
- # @return [Types::ImportResourceSpecification]
24196
- #
24197
- # @!attribute [rw] merge_strategy
24198
- # The strategy used when there was a name conflict between the
24199
- # imported resource and an existing resource. When the merge strategy
24200
- # is `FailOnConflict` existing resources are not overwritten and the
24201
- # import fails.
24202
- # @return [String]
24203
- #
24204
- # @!attribute [rw] import_status
24205
- # The current status of the import. When the status is `Complete` the
24206
- # bot, bot alias, or custom vocabulary is ready to use.
24207
- # @return [String]
24208
- #
24209
- # @!attribute [rw] creation_date_time
24210
- # The date and time that the import request was created.
24211
- # @return [Time]
25268
+ # Subslot elicitation settings.
24212
25269
  #
24213
- # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StartImportResponse AWS API Documentation
25270
+ # `DefaultValueSpecification` is a list of default values for a
25271
+ # constituent sub slot in a composite slot. Default values are used when
25272
+ # Amazon Lex hasn't determined a value for a slot. You can specify
25273
+ # default values from context variables, session attributes, and defined
25274
+ # values. This is similar to `DefaultValueSpecification` for slots.
24214
25275
  #
24215
- class StartImportResponse < Struct.new(
24216
- :import_id,
24217
- :resource_specification,
24218
- :merge_strategy,
24219
- :import_status,
24220
- :creation_date_time)
24221
- SENSITIVE = []
24222
- include Aws::Structure
24223
- end
24224
-
24225
- # Defines the messages that Amazon Lex sends to a user to remind them
24226
- # that the bot is waiting for a response.
25276
+ # `PromptSpecification` is the prompt that Amazon Lex uses to elicit the
25277
+ # sub slot value from the user. This is similar to `PromptSpecification`
25278
+ # for slots.
24227
25279
  #
24228
- # @note When making an API call, you may pass StillWaitingResponseSpecification
25280
+ # @note When making an API call, you may pass SubSlotValueElicitationSetting
24229
25281
  # data as a hash:
24230
25282
  #
24231
25283
  # {
24232
- # message_groups: [ # required
24233
- # {
24234
- # message: { # required
24235
- # plain_text_message: {
24236
- # value: "PlainTextMessageValue", # required
24237
- # },
24238
- # custom_payload: {
24239
- # value: "CustomPayloadValue", # required
24240
- # },
24241
- # ssml_message: {
24242
- # value: "SSMLMessageValue", # required
25284
+ # default_value_specification: {
25285
+ # default_value_list: [ # required
25286
+ # {
25287
+ # default_value: "SlotDefaultValueString", # required
25288
+ # },
25289
+ # ],
25290
+ # },
25291
+ # prompt_specification: { # required
25292
+ # message_groups: [ # required
25293
+ # {
25294
+ # message: { # required
25295
+ # plain_text_message: {
25296
+ # value: "PlainTextMessageValue", # required
25297
+ # },
25298
+ # custom_payload: {
25299
+ # value: "CustomPayloadValue", # required
25300
+ # },
25301
+ # ssml_message: {
25302
+ # value: "SSMLMessageValue", # required
25303
+ # },
25304
+ # image_response_card: {
25305
+ # title: "AttachmentTitle", # required
25306
+ # subtitle: "AttachmentTitle",
25307
+ # image_url: "AttachmentUrl",
25308
+ # buttons: [
25309
+ # {
25310
+ # text: "ButtonText", # required
25311
+ # value: "ButtonValue", # required
25312
+ # },
25313
+ # ],
25314
+ # },
24243
25315
  # },
24244
- # image_response_card: {
24245
- # title: "AttachmentTitle", # required
24246
- # subtitle: "AttachmentTitle",
24247
- # image_url: "AttachmentUrl",
24248
- # buttons: [
25316
+ # variations: [
25317
+ # {
25318
+ # plain_text_message: {
25319
+ # value: "PlainTextMessageValue", # required
25320
+ # },
25321
+ # custom_payload: {
25322
+ # value: "CustomPayloadValue", # required
25323
+ # },
25324
+ # ssml_message: {
25325
+ # value: "SSMLMessageValue", # required
25326
+ # },
25327
+ # image_response_card: {
25328
+ # title: "AttachmentTitle", # required
25329
+ # subtitle: "AttachmentTitle",
25330
+ # image_url: "AttachmentUrl",
25331
+ # buttons: [
25332
+ # {
25333
+ # text: "ButtonText", # required
25334
+ # value: "ButtonValue", # required
25335
+ # },
25336
+ # ],
25337
+ # },
25338
+ # },
25339
+ # ],
25340
+ # },
25341
+ # ],
25342
+ # max_retries: 1, # required
25343
+ # allow_interrupt: false,
25344
+ # message_selection_strategy: "Random", # accepts Random, Ordered
25345
+ # },
25346
+ # sample_utterances: [
25347
+ # {
25348
+ # utterance: "Utterance", # required
25349
+ # },
25350
+ # ],
25351
+ # wait_and_continue_specification: {
25352
+ # waiting_response: { # required
25353
+ # message_groups: [ # required
25354
+ # {
25355
+ # message: { # required
25356
+ # plain_text_message: {
25357
+ # value: "PlainTextMessageValue", # required
25358
+ # },
25359
+ # custom_payload: {
25360
+ # value: "CustomPayloadValue", # required
25361
+ # },
25362
+ # ssml_message: {
25363
+ # value: "SSMLMessageValue", # required
25364
+ # },
25365
+ # image_response_card: {
25366
+ # title: "AttachmentTitle", # required
25367
+ # subtitle: "AttachmentTitle",
25368
+ # image_url: "AttachmentUrl",
25369
+ # buttons: [
25370
+ # {
25371
+ # text: "ButtonText", # required
25372
+ # value: "ButtonValue", # required
25373
+ # },
25374
+ # ],
25375
+ # },
25376
+ # },
25377
+ # variations: [
24249
25378
  # {
24250
- # text: "ButtonText", # required
24251
- # value: "ButtonValue", # required
25379
+ # plain_text_message: {
25380
+ # value: "PlainTextMessageValue", # required
25381
+ # },
25382
+ # custom_payload: {
25383
+ # value: "CustomPayloadValue", # required
25384
+ # },
25385
+ # ssml_message: {
25386
+ # value: "SSMLMessageValue", # required
25387
+ # },
25388
+ # image_response_card: {
25389
+ # title: "AttachmentTitle", # required
25390
+ # subtitle: "AttachmentTitle",
25391
+ # image_url: "AttachmentUrl",
25392
+ # buttons: [
25393
+ # {
25394
+ # text: "ButtonText", # required
25395
+ # value: "ButtonValue", # required
25396
+ # },
25397
+ # ],
25398
+ # },
24252
25399
  # },
24253
25400
  # ],
24254
25401
  # },
24255
- # },
24256
- # variations: [
25402
+ # ],
25403
+ # allow_interrupt: false,
25404
+ # },
25405
+ # continue_response: { # required
25406
+ # message_groups: [ # required
24257
25407
  # {
24258
- # plain_text_message: {
24259
- # value: "PlainTextMessageValue", # required
24260
- # },
24261
- # custom_payload: {
24262
- # value: "CustomPayloadValue", # required
24263
- # },
24264
- # ssml_message: {
24265
- # value: "SSMLMessageValue", # required
25408
+ # message: { # required
25409
+ # plain_text_message: {
25410
+ # value: "PlainTextMessageValue", # required
25411
+ # },
25412
+ # custom_payload: {
25413
+ # value: "CustomPayloadValue", # required
25414
+ # },
25415
+ # ssml_message: {
25416
+ # value: "SSMLMessageValue", # required
25417
+ # },
25418
+ # image_response_card: {
25419
+ # title: "AttachmentTitle", # required
25420
+ # subtitle: "AttachmentTitle",
25421
+ # image_url: "AttachmentUrl",
25422
+ # buttons: [
25423
+ # {
25424
+ # text: "ButtonText", # required
25425
+ # value: "ButtonValue", # required
25426
+ # },
25427
+ # ],
25428
+ # },
24266
25429
  # },
24267
- # image_response_card: {
24268
- # title: "AttachmentTitle", # required
24269
- # subtitle: "AttachmentTitle",
24270
- # image_url: "AttachmentUrl",
24271
- # buttons: [
24272
- # {
24273
- # text: "ButtonText", # required
24274
- # value: "ButtonValue", # required
25430
+ # variations: [
25431
+ # {
25432
+ # plain_text_message: {
25433
+ # value: "PlainTextMessageValue", # required
24275
25434
  # },
24276
- # ],
25435
+ # custom_payload: {
25436
+ # value: "CustomPayloadValue", # required
25437
+ # },
25438
+ # ssml_message: {
25439
+ # value: "SSMLMessageValue", # required
25440
+ # },
25441
+ # image_response_card: {
25442
+ # title: "AttachmentTitle", # required
25443
+ # subtitle: "AttachmentTitle",
25444
+ # image_url: "AttachmentUrl",
25445
+ # buttons: [
25446
+ # {
25447
+ # text: "ButtonText", # required
25448
+ # value: "ButtonValue", # required
25449
+ # },
25450
+ # ],
25451
+ # },
25452
+ # },
25453
+ # ],
25454
+ # },
25455
+ # ],
25456
+ # allow_interrupt: false,
25457
+ # },
25458
+ # still_waiting_response: {
25459
+ # message_groups: [ # required
25460
+ # {
25461
+ # message: { # required
25462
+ # plain_text_message: {
25463
+ # value: "PlainTextMessageValue", # required
25464
+ # },
25465
+ # custom_payload: {
25466
+ # value: "CustomPayloadValue", # required
25467
+ # },
25468
+ # ssml_message: {
25469
+ # value: "SSMLMessageValue", # required
25470
+ # },
25471
+ # image_response_card: {
25472
+ # title: "AttachmentTitle", # required
25473
+ # subtitle: "AttachmentTitle",
25474
+ # image_url: "AttachmentUrl",
25475
+ # buttons: [
25476
+ # {
25477
+ # text: "ButtonText", # required
25478
+ # value: "ButtonValue", # required
25479
+ # },
25480
+ # ],
25481
+ # },
24277
25482
  # },
25483
+ # variations: [
25484
+ # {
25485
+ # plain_text_message: {
25486
+ # value: "PlainTextMessageValue", # required
25487
+ # },
25488
+ # custom_payload: {
25489
+ # value: "CustomPayloadValue", # required
25490
+ # },
25491
+ # ssml_message: {
25492
+ # value: "SSMLMessageValue", # required
25493
+ # },
25494
+ # image_response_card: {
25495
+ # title: "AttachmentTitle", # required
25496
+ # subtitle: "AttachmentTitle",
25497
+ # image_url: "AttachmentUrl",
25498
+ # buttons: [
25499
+ # {
25500
+ # text: "ButtonText", # required
25501
+ # value: "ButtonValue", # required
25502
+ # },
25503
+ # ],
25504
+ # },
25505
+ # },
25506
+ # ],
24278
25507
  # },
24279
25508
  # ],
25509
+ # frequency_in_seconds: 1, # required
25510
+ # timeout_in_seconds: 1, # required
25511
+ # allow_interrupt: false,
24280
25512
  # },
24281
- # ],
24282
- # frequency_in_seconds: 1, # required
24283
- # timeout_in_seconds: 1, # required
24284
- # allow_interrupt: false,
24285
- # }
24286
- #
24287
- # @!attribute [rw] message_groups
24288
- # One or more message groups, each containing one or more messages,
24289
- # that define the prompts that Amazon Lex sends to the user.
24290
- # @return [Array<Types::MessageGroup>]
24291
- #
24292
- # @!attribute [rw] frequency_in_seconds
24293
- # How often a message should be sent to the user. Minimum of 1 second,
24294
- # maximum of 5 minutes.
24295
- # @return [Integer]
24296
- #
24297
- # @!attribute [rw] timeout_in_seconds
24298
- # If Amazon Lex waits longer than this length of time for a response,
24299
- # it will stop sending messages.
24300
- # @return [Integer]
24301
- #
24302
- # @!attribute [rw] allow_interrupt
24303
- # Indicates that the user can interrupt the response by speaking while
24304
- # the message is being played.
24305
- # @return [Boolean]
24306
- #
24307
- # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StillWaitingResponseSpecification AWS API Documentation
24308
- #
24309
- class StillWaitingResponseSpecification < Struct.new(
24310
- :message_groups,
24311
- :frequency_in_seconds,
24312
- :timeout_in_seconds,
24313
- :allow_interrupt)
24314
- SENSITIVE = []
24315
- include Aws::Structure
24316
- end
24317
-
24318
- # @note When making an API call, you may pass StopBotRecommendationRequest
24319
- # data as a hash:
24320
- #
24321
- # {
24322
- # bot_id: "Id", # required
24323
- # bot_version: "DraftBotVersion", # required
24324
- # locale_id: "LocaleId", # required
24325
- # bot_recommendation_id: "Id", # required
25513
+ # active: false,
25514
+ # },
24326
25515
  # }
24327
25516
  #
24328
- # @!attribute [rw] bot_id
24329
- # The unique identifier of the bot containing the bot recommendation
24330
- # to be stopped.
24331
- # @return [String]
24332
- #
24333
- # @!attribute [rw] bot_version
24334
- # The version of the bot containing the bot recommendation.
24335
- # @return [String]
24336
- #
24337
- # @!attribute [rw] locale_id
24338
- # The identifier of the language and locale of the bot recommendation
24339
- # to stop. The string must match one of the supported locales. For
24340
- # more information, see [Supported languages][1]
24341
- #
24342
- #
24343
- #
24344
- # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html
24345
- # @return [String]
24346
- #
24347
- # @!attribute [rw] bot_recommendation_id
24348
- # The unique identifier of the bot recommendation to be stopped.
24349
- # @return [String]
24350
- #
24351
- # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StopBotRecommendationRequest AWS API Documentation
24352
- #
24353
- class StopBotRecommendationRequest < Struct.new(
24354
- :bot_id,
24355
- :bot_version,
24356
- :locale_id,
24357
- :bot_recommendation_id)
24358
- SENSITIVE = []
24359
- include Aws::Structure
24360
- end
24361
-
24362
- # @!attribute [rw] bot_id
24363
- # The unique identifier of the bot containing the bot recommendation
24364
- # that is being stopped.
24365
- # @return [String]
24366
- #
24367
- # @!attribute [rw] bot_version
24368
- # The version of the bot containing the recommendation that is being
24369
- # stopped.
24370
- # @return [String]
24371
- #
24372
- # @!attribute [rw] locale_id
24373
- # The identifier of the language and locale of the bot response to
24374
- # stop. The string must match one of the supported locales. For more
24375
- # information, see [Supported languages][1]
24376
- #
24377
- #
25517
+ # @!attribute [rw] default_value_specification
25518
+ # Defines a list of values that Amazon Lex should use as the default
25519
+ # value for a slot.
25520
+ # @return [Types::SlotDefaultValueSpecification]
24378
25521
  #
24379
- # [1]: https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html
24380
- # @return [String]
25522
+ # @!attribute [rw] prompt_specification
25523
+ # Specifies a list of message groups that Amazon Lex sends to a user
25524
+ # to elicit a response.
25525
+ # @return [Types::PromptSpecification]
24381
25526
  #
24382
- # @!attribute [rw] bot_recommendation_status
24383
- # The status of the bot recommendation. If the status is Failed, then
24384
- # the reasons for the failure are listed in the failureReasons field.
24385
- # @return [String]
25527
+ # @!attribute [rw] sample_utterances
25528
+ # If you know a specific pattern that users might respond to an Amazon
25529
+ # Lex request for a sub slot value, you can provide those utterances
25530
+ # to improve accuracy. This is optional. In most cases Amazon Lex is
25531
+ # capable of understanding user utterances. This is similar to
25532
+ # `SampleUtterances` for slots.
25533
+ # @return [Array<Types::SampleUtterance>]
24386
25534
  #
24387
- # @!attribute [rw] bot_recommendation_id
24388
- # The unique identifier of the bot recommendation that is being
24389
- # stopped.
24390
- # @return [String]
25535
+ # @!attribute [rw] wait_and_continue_specification
25536
+ # Specifies the prompts that Amazon Lex uses while a bot is waiting
25537
+ # for customer input.
25538
+ # @return [Types::WaitAndContinueSpecification]
24391
25539
  #
24392
- # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StopBotRecommendationResponse AWS API Documentation
25540
+ # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/SubSlotValueElicitationSetting AWS API Documentation
24393
25541
  #
24394
- class StopBotRecommendationResponse < Struct.new(
24395
- :bot_id,
24396
- :bot_version,
24397
- :locale_id,
24398
- :bot_recommendation_status,
24399
- :bot_recommendation_id)
25542
+ class SubSlotValueElicitationSetting < Struct.new(
25543
+ :default_value_specification,
25544
+ :prompt_specification,
25545
+ :sample_utterances,
25546
+ :wait_and_continue_specification)
24400
25547
  SENSITIVE = []
24401
25548
  include Aws::Structure
24402
25549
  end
@@ -30762,6 +31909,247 @@ module Aws::LexModelsV2
30762
31909
  # multiple_values_setting: {
30763
31910
  # allow_multiple_values: false,
30764
31911
  # },
31912
+ # sub_slot_setting: {
31913
+ # expression: "SubSlotExpression",
31914
+ # slot_specifications: {
31915
+ # "Name" => {
31916
+ # slot_type_id: "BuiltInOrCustomSlotTypeId", # required
31917
+ # value_elicitation_setting: { # required
31918
+ # default_value_specification: {
31919
+ # default_value_list: [ # required
31920
+ # {
31921
+ # default_value: "SlotDefaultValueString", # required
31922
+ # },
31923
+ # ],
31924
+ # },
31925
+ # prompt_specification: { # required
31926
+ # message_groups: [ # required
31927
+ # {
31928
+ # message: { # required
31929
+ # plain_text_message: {
31930
+ # value: "PlainTextMessageValue", # required
31931
+ # },
31932
+ # custom_payload: {
31933
+ # value: "CustomPayloadValue", # required
31934
+ # },
31935
+ # ssml_message: {
31936
+ # value: "SSMLMessageValue", # required
31937
+ # },
31938
+ # image_response_card: {
31939
+ # title: "AttachmentTitle", # required
31940
+ # subtitle: "AttachmentTitle",
31941
+ # image_url: "AttachmentUrl",
31942
+ # buttons: [
31943
+ # {
31944
+ # text: "ButtonText", # required
31945
+ # value: "ButtonValue", # required
31946
+ # },
31947
+ # ],
31948
+ # },
31949
+ # },
31950
+ # variations: [
31951
+ # {
31952
+ # plain_text_message: {
31953
+ # value: "PlainTextMessageValue", # required
31954
+ # },
31955
+ # custom_payload: {
31956
+ # value: "CustomPayloadValue", # required
31957
+ # },
31958
+ # ssml_message: {
31959
+ # value: "SSMLMessageValue", # required
31960
+ # },
31961
+ # image_response_card: {
31962
+ # title: "AttachmentTitle", # required
31963
+ # subtitle: "AttachmentTitle",
31964
+ # image_url: "AttachmentUrl",
31965
+ # buttons: [
31966
+ # {
31967
+ # text: "ButtonText", # required
31968
+ # value: "ButtonValue", # required
31969
+ # },
31970
+ # ],
31971
+ # },
31972
+ # },
31973
+ # ],
31974
+ # },
31975
+ # ],
31976
+ # max_retries: 1, # required
31977
+ # allow_interrupt: false,
31978
+ # message_selection_strategy: "Random", # accepts Random, Ordered
31979
+ # },
31980
+ # sample_utterances: [
31981
+ # {
31982
+ # utterance: "Utterance", # required
31983
+ # },
31984
+ # ],
31985
+ # wait_and_continue_specification: {
31986
+ # waiting_response: { # required
31987
+ # message_groups: [ # required
31988
+ # {
31989
+ # message: { # required
31990
+ # plain_text_message: {
31991
+ # value: "PlainTextMessageValue", # required
31992
+ # },
31993
+ # custom_payload: {
31994
+ # value: "CustomPayloadValue", # required
31995
+ # },
31996
+ # ssml_message: {
31997
+ # value: "SSMLMessageValue", # required
31998
+ # },
31999
+ # image_response_card: {
32000
+ # title: "AttachmentTitle", # required
32001
+ # subtitle: "AttachmentTitle",
32002
+ # image_url: "AttachmentUrl",
32003
+ # buttons: [
32004
+ # {
32005
+ # text: "ButtonText", # required
32006
+ # value: "ButtonValue", # required
32007
+ # },
32008
+ # ],
32009
+ # },
32010
+ # },
32011
+ # variations: [
32012
+ # {
32013
+ # plain_text_message: {
32014
+ # value: "PlainTextMessageValue", # required
32015
+ # },
32016
+ # custom_payload: {
32017
+ # value: "CustomPayloadValue", # required
32018
+ # },
32019
+ # ssml_message: {
32020
+ # value: "SSMLMessageValue", # required
32021
+ # },
32022
+ # image_response_card: {
32023
+ # title: "AttachmentTitle", # required
32024
+ # subtitle: "AttachmentTitle",
32025
+ # image_url: "AttachmentUrl",
32026
+ # buttons: [
32027
+ # {
32028
+ # text: "ButtonText", # required
32029
+ # value: "ButtonValue", # required
32030
+ # },
32031
+ # ],
32032
+ # },
32033
+ # },
32034
+ # ],
32035
+ # },
32036
+ # ],
32037
+ # allow_interrupt: false,
32038
+ # },
32039
+ # continue_response: { # required
32040
+ # message_groups: [ # required
32041
+ # {
32042
+ # message: { # required
32043
+ # plain_text_message: {
32044
+ # value: "PlainTextMessageValue", # required
32045
+ # },
32046
+ # custom_payload: {
32047
+ # value: "CustomPayloadValue", # required
32048
+ # },
32049
+ # ssml_message: {
32050
+ # value: "SSMLMessageValue", # required
32051
+ # },
32052
+ # image_response_card: {
32053
+ # title: "AttachmentTitle", # required
32054
+ # subtitle: "AttachmentTitle",
32055
+ # image_url: "AttachmentUrl",
32056
+ # buttons: [
32057
+ # {
32058
+ # text: "ButtonText", # required
32059
+ # value: "ButtonValue", # required
32060
+ # },
32061
+ # ],
32062
+ # },
32063
+ # },
32064
+ # variations: [
32065
+ # {
32066
+ # plain_text_message: {
32067
+ # value: "PlainTextMessageValue", # required
32068
+ # },
32069
+ # custom_payload: {
32070
+ # value: "CustomPayloadValue", # required
32071
+ # },
32072
+ # ssml_message: {
32073
+ # value: "SSMLMessageValue", # required
32074
+ # },
32075
+ # image_response_card: {
32076
+ # title: "AttachmentTitle", # required
32077
+ # subtitle: "AttachmentTitle",
32078
+ # image_url: "AttachmentUrl",
32079
+ # buttons: [
32080
+ # {
32081
+ # text: "ButtonText", # required
32082
+ # value: "ButtonValue", # required
32083
+ # },
32084
+ # ],
32085
+ # },
32086
+ # },
32087
+ # ],
32088
+ # },
32089
+ # ],
32090
+ # allow_interrupt: false,
32091
+ # },
32092
+ # still_waiting_response: {
32093
+ # message_groups: [ # required
32094
+ # {
32095
+ # message: { # required
32096
+ # plain_text_message: {
32097
+ # value: "PlainTextMessageValue", # required
32098
+ # },
32099
+ # custom_payload: {
32100
+ # value: "CustomPayloadValue", # required
32101
+ # },
32102
+ # ssml_message: {
32103
+ # value: "SSMLMessageValue", # required
32104
+ # },
32105
+ # image_response_card: {
32106
+ # title: "AttachmentTitle", # required
32107
+ # subtitle: "AttachmentTitle",
32108
+ # image_url: "AttachmentUrl",
32109
+ # buttons: [
32110
+ # {
32111
+ # text: "ButtonText", # required
32112
+ # value: "ButtonValue", # required
32113
+ # },
32114
+ # ],
32115
+ # },
32116
+ # },
32117
+ # variations: [
32118
+ # {
32119
+ # plain_text_message: {
32120
+ # value: "PlainTextMessageValue", # required
32121
+ # },
32122
+ # custom_payload: {
32123
+ # value: "CustomPayloadValue", # required
32124
+ # },
32125
+ # ssml_message: {
32126
+ # value: "SSMLMessageValue", # required
32127
+ # },
32128
+ # image_response_card: {
32129
+ # title: "AttachmentTitle", # required
32130
+ # subtitle: "AttachmentTitle",
32131
+ # image_url: "AttachmentUrl",
32132
+ # buttons: [
32133
+ # {
32134
+ # text: "ButtonText", # required
32135
+ # value: "ButtonValue", # required
32136
+ # },
32137
+ # ],
32138
+ # },
32139
+ # },
32140
+ # ],
32141
+ # },
32142
+ # ],
32143
+ # frequency_in_seconds: 1, # required
32144
+ # timeout_in_seconds: 1, # required
32145
+ # allow_interrupt: false,
32146
+ # },
32147
+ # active: false,
32148
+ # },
32149
+ # },
32150
+ # },
32151
+ # },
32152
+ # },
30765
32153
  # }
30766
32154
  #
30767
32155
  # @!attribute [rw] slot_id
@@ -30824,6 +32212,11 @@ module Aws::LexModelsV2
30824
32212
  # `false`.
30825
32213
  # @return [Types::MultipleValuesSetting]
30826
32214
  #
32215
+ # @!attribute [rw] sub_slot_setting
32216
+ # Specifications for the constituent sub slots and the expression for
32217
+ # the composite slot.
32218
+ # @return [Types::SubSlotSetting]
32219
+ #
30827
32220
  # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateSlotRequest AWS API Documentation
30828
32221
  #
30829
32222
  class UpdateSlotRequest < Struct.new(
@@ -30837,7 +32230,8 @@ module Aws::LexModelsV2
30837
32230
  :bot_version,
30838
32231
  :locale_id,
30839
32232
  :intent_id,
30840
- :multiple_values_setting)
32233
+ :multiple_values_setting,
32234
+ :sub_slot_setting)
30841
32235
  SENSITIVE = []
30842
32236
  include Aws::Structure
30843
32237
  end
@@ -30898,6 +32292,11 @@ module Aws::LexModelsV2
30898
32292
  # Indicates whether the slot accepts multiple values in one response.
30899
32293
  # @return [Types::MultipleValuesSetting]
30900
32294
  #
32295
+ # @!attribute [rw] sub_slot_setting
32296
+ # Specifications for the constituent sub slots and the expression for
32297
+ # the composite slot.
32298
+ # @return [Types::SubSlotSetting]
32299
+ #
30901
32300
  # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateSlotResponse AWS API Documentation
30902
32301
  #
30903
32302
  class UpdateSlotResponse < Struct.new(
@@ -30913,7 +32312,8 @@ module Aws::LexModelsV2
30913
32312
  :intent_id,
30914
32313
  :creation_date_time,
30915
32314
  :last_updated_date_time,
30916
- :multiple_values_setting)
32315
+ :multiple_values_setting,
32316
+ :sub_slot_setting)
30917
32317
  SENSITIVE = []
30918
32318
  include Aws::Structure
30919
32319
  end
@@ -30938,7 +32338,7 @@ module Aws::LexModelsV2
30938
32338
  # },
30939
32339
  # ],
30940
32340
  # value_selection_setting: {
30941
- # resolution_strategy: "OriginalValue", # required, accepts OriginalValue, TopResolution
32341
+ # resolution_strategy: "OriginalValue", # required, accepts OriginalValue, TopResolution, Concatenation
30942
32342
  # regex_filter: {
30943
32343
  # pattern: "RegexPattern", # required
30944
32344
  # },
@@ -30959,6 +32359,14 @@ module Aws::LexModelsV2
30959
32359
  # },
30960
32360
  # },
30961
32361
  # },
32362
+ # composite_slot_type_setting: {
32363
+ # sub_slots: [
32364
+ # {
32365
+ # name: "Name", # required
32366
+ # slot_type_id: "BuiltInOrCustomSlotTypeId", # required
32367
+ # },
32368
+ # ],
32369
+ # },
30962
32370
  # }
30963
32371
  #
30964
32372
  # @!attribute [rw] slot_type_id
@@ -31011,6 +32419,10 @@ module Aws::LexModelsV2
31011
32419
  # definition.
31012
32420
  # @return [Types::ExternalSourceSetting]
31013
32421
  #
32422
+ # @!attribute [rw] composite_slot_type_setting
32423
+ # Specifications for a composite slot type.
32424
+ # @return [Types::CompositeSlotTypeSetting]
32425
+ #
31014
32426
  # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateSlotTypeRequest AWS API Documentation
31015
32427
  #
31016
32428
  class UpdateSlotTypeRequest < Struct.new(
@@ -31023,7 +32435,8 @@ module Aws::LexModelsV2
31023
32435
  :bot_id,
31024
32436
  :bot_version,
31025
32437
  :locale_id,
31026
- :external_source_setting)
32438
+ :external_source_setting,
32439
+ :composite_slot_type_setting)
31027
32440
  SENSITIVE = []
31028
32441
  include Aws::Structure
31029
32442
  end
@@ -31081,6 +32494,10 @@ module Aws::LexModelsV2
31081
32494
  # definition.
31082
32495
  # @return [Types::ExternalSourceSetting]
31083
32496
  #
32497
+ # @!attribute [rw] composite_slot_type_setting
32498
+ # Specifications for a composite slot type.
32499
+ # @return [Types::CompositeSlotTypeSetting]
32500
+ #
31084
32501
  # @see http://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/UpdateSlotTypeResponse AWS API Documentation
31085
32502
  #
31086
32503
  class UpdateSlotTypeResponse < Struct.new(
@@ -31095,7 +32512,8 @@ module Aws::LexModelsV2
31095
32512
  :locale_id,
31096
32513
  :creation_date_time,
31097
32514
  :last_updated_date_time,
31098
- :external_source_setting)
32515
+ :external_source_setting,
32516
+ :composite_slot_type_setting)
31099
32517
  SENSITIVE = []
31100
32518
  include Aws::Structure
31101
32519
  end