Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

UpdateSlot - Amazon Lex API Reference

UpdateSlot

Updates the settings for a slot.

Request Syntax

PUT /bots/botId/botversions/botVersion/botlocales/localeId/intents/intentId/slots/slotId/ HTTP/1.1 Content-type: application/json { "description": "string", "multipleValuesSetting": { "allowMultipleValues": boolean }, "obfuscationSetting": { "obfuscationSettingType": "string" }, "slotName": "string", "slotTypeId": "string", "subSlotSetting": { "expression": "string", "slotSpecifications": { "string" : { "slotTypeId": "string", "valueElicitationSetting": { "defaultValueSpecification": { "defaultValueList": [ { "defaultValue": "string" } ] }, "promptSpecification": { "allowInterrupt": boolean, "maxRetries": number, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ], "messageSelectionStrategy": "string", "promptAttemptsSpecification": { "string" : { "allowedInputTypes": { "allowAudioInput": boolean, "allowDTMFInput": boolean }, "allowInterrupt": boolean, "audioAndDTMFInputSpecification": { "audioSpecification": { "endTimeoutMs": number, "maxLengthMs": number }, "dtmfSpecification": { "deletionCharacter": "string", "endCharacter": "string", "endTimeoutMs": number, "maxLength": number }, "startTimeoutMs": number }, "textInputSpecification": { "startTimeoutMs": number } } } }, "sampleUtterances": [ { "utterance": "string" } ], "waitAndContinueSpecification": { "active": boolean, "continueResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] }, "stillWaitingResponse": { "allowInterrupt": boolean, "frequencyInSeconds": number, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ], "timeoutInSeconds": number }, "waitingResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } } } } }, "valueElicitationSetting": { "defaultValueSpecification": { "defaultValueList": [ { "defaultValue": "string" } ] }, "promptSpecification": { "allowInterrupt": boolean, "maxRetries": number, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ], "messageSelectionStrategy": "string", "promptAttemptsSpecification": { "string" : { "allowedInputTypes": { "allowAudioInput": boolean, "allowDTMFInput": boolean }, "allowInterrupt": boolean, "audioAndDTMFInputSpecification": { "audioSpecification": { "endTimeoutMs": number, "maxLengthMs": number }, "dtmfSpecification": { "deletionCharacter": "string", "endCharacter": "string", "endTimeoutMs": number, "maxLength": number }, "startTimeoutMs": number }, "textInputSpecification": { "startTimeoutMs": number } } } }, "sampleUtterances": [ { "utterance": "string" } ], "slotCaptureSetting": { "captureConditional": { "active": boolean, "conditionalBranches": [ { "condition": { "expressionString": "string" }, "name": "string", "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } ], "defaultBranch": { "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "captureNextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "captureResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] }, "codeHook": { "active": boolean, "enableCodeHookInvocation": boolean, "invocationLabel": "string", "postCodeHookSpecification": { "failureConditional": { "active": boolean, "conditionalBranches": [ { "condition": { "expressionString": "string" }, "name": "string", "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } ], "defaultBranch": { "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "failureNextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "failureResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] }, "successConditional": { "active": boolean, "conditionalBranches": [ { "condition": { "expressionString": "string" }, "name": "string", "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } ], "defaultBranch": { "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "successNextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "successResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] }, "timeoutConditional": { "active": boolean, "conditionalBranches": [ { "condition": { "expressionString": "string" }, "name": "string", "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } ], "defaultBranch": { "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "timeoutNextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "timeoutResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "elicitationCodeHook": { "enableCodeHookInvocation": boolean, "invocationLabel": "string" }, "failureConditional": { "active": boolean, "conditionalBranches": [ { "condition": { "expressionString": "string" }, "name": "string", "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } ], "defaultBranch": { "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "failureNextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "failureResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } }, "slotConstraint": "string", "slotResolutionSetting": { "slotResolutionStrategy": "string" }, "waitAndContinueSpecification": { "active": boolean, "continueResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] }, "stillWaitingResponse": { "allowInterrupt": boolean, "frequencyInSeconds": number, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ], "timeoutInSeconds": number }, "waitingResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } } }

URI Request Parameters

The request uses the following URI parameters.

botId

The unique identifier of the bot that contains the slot.

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

Required: Yes

botVersion

The version of the bot that contains the slot. Must always be DRAFT.

Length Constraints: Fixed length of 5.

Pattern: ^DRAFT$

Required: Yes

intentId

The identifier of the intent that contains the slot.

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

Required: Yes

localeId

The identifier of the language and locale that contains the slot. The string must match one of the supported locales. For more information, see Supported languages.

Required: Yes

slotId

The unique identifier for the slot to update.

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

Required: Yes

Request Body

The request accepts the following data in JSON format.

description

The new description for the slot.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 200.

Required: No

multipleValuesSetting

Determines whether the slot accepts multiple values in one response. Multiple value slots are only available in the en-US locale. If you set this value to true in any other locale, Amazon Lex throws a ValidationException.

If the multipleValuesSetting is not set, the default value is false.

Type: MultipleValuesSetting object

Required: No

obfuscationSetting

New settings that determine how slot values are formatted in Amazon CloudWatch logs.

Type: ObfuscationSetting object

Required: No

slotName

The new name for the slot.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^([0-9a-zA-Z][_-]?){1,100}$

Required: Yes

slotTypeId

The unique identifier of the new slot type to associate with this slot.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 25.

Pattern: ^((AMAZON\.)[a-zA-Z_]+?|[0-9a-zA-Z]+)$

Required: No

subSlotSetting

Specifications for the constituent sub slots and the expression for the composite slot.

Type: SubSlotSetting object

Required: No

valueElicitationSetting

A new set of prompts that Amazon Lex sends to the user to elicit a response the provides a value for the slot.

Type: SlotValueElicitationSetting object

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "botId": "string", "botVersion": "string", "creationDateTime": number, "description": "string", "intentId": "string", "lastUpdatedDateTime": number, "localeId": "string", "multipleValuesSetting": { "allowMultipleValues": boolean }, "obfuscationSetting": { "obfuscationSettingType": "string" }, "slotId": "string", "slotName": "string", "slotTypeId": "string", "subSlotSetting": { "expression": "string", "slotSpecifications": { "string" : { "slotTypeId": "string", "valueElicitationSetting": { "defaultValueSpecification": { "defaultValueList": [ { "defaultValue": "string" } ] }, "promptSpecification": { "allowInterrupt": boolean, "maxRetries": number, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ], "messageSelectionStrategy": "string", "promptAttemptsSpecification": { "string" : { "allowedInputTypes": { "allowAudioInput": boolean, "allowDTMFInput": boolean }, "allowInterrupt": boolean, "audioAndDTMFInputSpecification": { "audioSpecification": { "endTimeoutMs": number, "maxLengthMs": number }, "dtmfSpecification": { "deletionCharacter": "string", "endCharacter": "string", "endTimeoutMs": number, "maxLength": number }, "startTimeoutMs": number }, "textInputSpecification": { "startTimeoutMs": number } } } }, "sampleUtterances": [ { "utterance": "string" } ], "waitAndContinueSpecification": { "active": boolean, "continueResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] }, "stillWaitingResponse": { "allowInterrupt": boolean, "frequencyInSeconds": number, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ], "timeoutInSeconds": number }, "waitingResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } } } } }, "valueElicitationSetting": { "defaultValueSpecification": { "defaultValueList": [ { "defaultValue": "string" } ] }, "promptSpecification": { "allowInterrupt": boolean, "maxRetries": number, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ], "messageSelectionStrategy": "string", "promptAttemptsSpecification": { "string" : { "allowedInputTypes": { "allowAudioInput": boolean, "allowDTMFInput": boolean }, "allowInterrupt": boolean, "audioAndDTMFInputSpecification": { "audioSpecification": { "endTimeoutMs": number, "maxLengthMs": number }, "dtmfSpecification": { "deletionCharacter": "string", "endCharacter": "string", "endTimeoutMs": number, "maxLength": number }, "startTimeoutMs": number }, "textInputSpecification": { "startTimeoutMs": number } } } }, "sampleUtterances": [ { "utterance": "string" } ], "slotCaptureSetting": { "captureConditional": { "active": boolean, "conditionalBranches": [ { "condition": { "expressionString": "string" }, "name": "string", "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } ], "defaultBranch": { "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "captureNextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "captureResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] }, "codeHook": { "active": boolean, "enableCodeHookInvocation": boolean, "invocationLabel": "string", "postCodeHookSpecification": { "failureConditional": { "active": boolean, "conditionalBranches": [ { "condition": { "expressionString": "string" }, "name": "string", "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } ], "defaultBranch": { "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "failureNextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "failureResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] }, "successConditional": { "active": boolean, "conditionalBranches": [ { "condition": { "expressionString": "string" }, "name": "string", "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } ], "defaultBranch": { "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "successNextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "successResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] }, "timeoutConditional": { "active": boolean, "conditionalBranches": [ { "condition": { "expressionString": "string" }, "name": "string", "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } ], "defaultBranch": { "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "timeoutNextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "timeoutResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "elicitationCodeHook": { "enableCodeHookInvocation": boolean, "invocationLabel": "string" }, "failureConditional": { "active": boolean, "conditionalBranches": [ { "condition": { "expressionString": "string" }, "name": "string", "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } ], "defaultBranch": { "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "failureNextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "failureResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } }, "slotConstraint": "string", "slotResolutionSetting": { "slotResolutionStrategy": "string" }, "waitAndContinueSpecification": { "active": boolean, "continueResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] }, "stillWaitingResponse": { "allowInterrupt": boolean, "frequencyInSeconds": number, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ], "timeoutInSeconds": number }, "waitingResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

botId

The identifier of the bot that contains the slot.

Type: String

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

botVersion

The version of the bot that contains the slot. Will always be DRAFT.

Type: String

Length Constraints: Fixed length of 5.

Pattern: ^DRAFT$

creationDateTime

The timestamp of the date and time that the slot was created.

Type: Timestamp

description

The updated description of the bot.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 200.

intentId

The intent that contains the slot.

Type: String

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

lastUpdatedDateTime

The timestamp of the date and time that the slot was last updated.

Type: Timestamp

localeId

The locale that contains the slot.

Type: String

multipleValuesSetting

Indicates whether the slot accepts multiple values in one response.

Type: MultipleValuesSetting object

obfuscationSetting

The updated setting that determines whether the slot value is obfuscated in the Amazon CloudWatch logs.

Type: ObfuscationSetting object

slotId

The unique identifier of the slot that was updated.

Type: String

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

slotName

The updated name of the slot.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^([0-9a-zA-Z][_-]?){1,100}$

slotTypeId

The updated identifier of the slot type that provides values for the slot.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 25.

Pattern: ^((AMAZON\.)[a-zA-Z_]+?|[0-9a-zA-Z]+)$

subSlotSetting

Specifications for the constituent sub slots and the expression for the composite slot.

Type: SubSlotSetting object

valueElicitationSetting

The updated prompts that Amazon Lex sends to the user to elicit a response that provides a value for the slot.

Type: SlotValueElicitationSetting object

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.

HTTP Status Code: 409

InternalServerException

The service encountered an unexpected condition. Try your request again.

HTTP Status Code: 500

PreconditionFailedException

Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.

HTTP Status Code: 412

ServiceQuotaExceededException

You have reached a quota for your bot.

HTTP Status Code: 402

ThrottlingException

Your request rate is too high. Reduce the frequency of requests.

HTTP Status Code: 429

ValidationException

One of the input parameters in your request isn't valid. Check the parameters and try your request again.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.