DescribeSlotType
Gets metadata information about a slot type.
Request Syntax
GET /bots/botId/botversions/botVersion/botlocales/localeId/slottypes/slotTypeId/ HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- botId
-
The identifier of the bot associated with the slot type.
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$Required: Yes
- botVersion
-
The version of the bot associated with the slot type.
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern:
^(DRAFT|[0-9]+)$Required: Yes
- localeId
-
The identifier of the language and locale of the slot type to describe. The string must match one of the supported locales. For more information, see Supported languages.
Required: Yes
- slotTypeId
-
The identifier of the slot type.
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",
"compositeSlotTypeSetting": {
"subSlots": [
{
"name": "string",
"slotTypeId": "string"
}
]
},
"creationDateTime": number,
"description": "string",
"externalSourceSetting": {
"grammarSlotTypeSetting": {
"source": {
"kmsKeyArn": "string",
"s3BucketName": "string",
"s3ObjectKey": "string"
}
}
},
"lastUpdatedDateTime": number,
"localeId": "string",
"parentSlotTypeSignature": "string",
"slotTypeId": "string",
"slotTypeName": "string",
"slotTypeValues": [
{
"sampleValue": {
"value": "string"
},
"synonyms": [
{
"value": "string"
}
]
}
],
"valueSelectionSetting": {
"advancedRecognitionSetting": {
"audioRecognitionStrategy": "string"
},
"regexFilter": {
"pattern": "string"
},
"resolutionStrategy": "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.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$ - botVersion
-
The version of the bot associated with the slot type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 5.
Pattern:
^(DRAFT|[0-9]+)$ - compositeSlotTypeSetting
-
Specifications for a composite slot type.
Type: CompositeSlotTypeSetting object
- creationDateTime
-
A timestamp of the date and time that the slot type was created.
Type: Timestamp
- description
-
The description specified for the slot type.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 200.
- externalSourceSetting
-
Provides information about the external source of the slot type's definition.
Type: ExternalSourceSetting object
- lastUpdatedDateTime
-
A timestamp of the date and time that the slot type was last updated.
Type: Timestamp
- localeId
-
The language and locale specified for the slot type.
Type: String
- parentSlotTypeSignature
-
The built in slot type used as a parent to this slot type.
Type: String
- slotTypeId
-
The unique identifier for the slot type.
Type: String
Length Constraints: Fixed length of 10.
Pattern:
^[0-9a-zA-Z]+$ - slotTypeName
-
The name specified for the slot type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^([0-9a-zA-Z][_-]?){1,100}$ - slotTypeValues
-
The values that the slot type can take. Includes any synonyms for the slot type values.
Type: Array of SlotTypeValue objects
Array Members: Minimum number of 1 item. Maximum number of 10000 items.
- valueSelectionSetting
-
The strategy that Amazon Lex uses to choose a value from a list of possible values.
Type: SlotValueSelectionSetting 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.
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:
