DescribeSlot
Gets metadata information about a slot.
Request Syntax
GET /bots/botId/botversions/botVersion/botlocales/localeId/intents/intentId/slots/slotId/ HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- botId
-
The identifier of the bot associated with the slot.
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$Required: Yes
- botVersion
-
The version of the bot associated with the slot.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern:
^(DRAFT|[0-9]+)$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 of the slot to describe. The string must match one of the supported locales. For more information, see Supported languages.
Required: Yes
- slotId
-
The unique identifier for the slot.
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$Required: Yes
Request Body
The request does not have a request body.
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 associated with the slot.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$ - botVersion
-
The version of the bot associated with the slot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern:
^(DRAFT|[0-9]+)$ - creationDateTime
-
A timestamp of the date and time that the slot was created.
Type: Timestamp
- description
-
The description specified for the slot.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2000.
- intentId
-
The identifier of the intent associated with the slot.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$ - lastUpdatedDateTime
-
A timestamp of the date and time that the slot was last updated.
Type: Timestamp
- localeId
-
The language and locale specified for the slot.
Type: String
- multipleValuesSetting
-
Indicates whether the slot accepts multiple values in a single utterance.
If the
multipleValuesSettingis not set, the default value isfalse.Type: MultipleValuesSetting object
- obfuscationSetting
-
Whether slot values are shown in Amazon CloudWatch logs. If the value is
None, the actual value of the slot is shown in logs.Type: ObfuscationSetting object
- slotId
-
The unique identifier generated for the slot.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$ - slotName
-
The name specified for the slot.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^([0-9a-zA-Z][_-]?){1,100}$ - slotTypeId
-
The identifier of the slot type that determines the values entered into 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
-
Prompts that Amazon Lex uses to elicit a value for the slot.
Type: SlotValueElicitationSetting object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerException
-
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
- ResourceNotFoundException
-
You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.
HTTP Status Code: 404
- 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.
- retryAfterSeconds
-
The number of seconds after which the user can invoke the API again.
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:
