GetSlotType - Amazon Lex V1
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

If you are using Amazon Lex V2, refer to the Amazon Lex V2 guide instead.

 

If you are using Amazon Lex V1, we recommend upgrading your bots to Amazon Lex V2. We are no longer adding new features to V1 and strongly recommend using V2 for all new bots.

GetSlotType

Returns information about a specific version of a slot type. In addition to specifying the slot type name, you must specify the slot type version.

This operation requires permissions for the lex:GetSlotType action.

Request Syntax

GET /slottypes/name/versions/version HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

name

The name of the slot type. The name is case sensitive.

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

Pattern: ^([A-Za-z]_?)+$

Required: Yes

version

The version of the slot type.

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

Pattern: \$LATEST|[0-9]+

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "checksum": "string",
   "createdDate": number,
   "description": "string",
   "enumerationValues": [ 
      { 
         "synonyms": [ "string" ],
         "value": "string"
      }
   ],
   "lastUpdatedDate": number,
   "name": "string",
   "parentSlotTypeSignature": "string",
   "slotTypeConfigurations": [ 
      { 
         "regexConfiguration": { 
            "pattern": "string"
         }
      }
   ],
   "valueSelectionStrategy": "string",
   "version": "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.

checksum

Checksum of the $LATEST version of the slot type.

Type: String

createdDate

The date that the slot type was created.

Type: Timestamp

description

A description of the slot type.

Type: String

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

enumerationValues

A list of EnumerationValue objects that defines the values that the slot type can take.

Type: Array of EnumerationValue objects

Array Members: Minimum number of 0 items. Maximum number of 10000 items.

lastUpdatedDate

The date that the slot type was updated. When you create a resource, the creation date and last update date are the same.

Type: Timestamp

name

The name of the slot type.

Type: String

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

Pattern: ^([A-Za-z]_?)+$

parentSlotTypeSignature

The built-in slot type used as a parent for the slot type.

Type: String

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

Pattern: ^((AMAZON\.)_?|[A-Za-z]_?)+

slotTypeConfigurations

Configuration information that extends the parent built-in slot type.

Type: Array of SlotTypeConfiguration objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

valueSelectionStrategy

The strategy that Amazon Lex uses to determine the value of the slot. For more information, see PutSlotType.

Type: String

Valid Values: ORIGINAL_VALUE | TOP_RESOLUTION

version

The version of the slot type.

Type: String

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

Pattern: \$LATEST|[0-9]+

Errors

BadRequestException

The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.

HTTP Status Code: 400

InternalFailureException

An internal Amazon Lex error occurred. Try your request again.

HTTP Status Code: 500

LimitExceededException

The request exceeded a limit. Try your request again.

HTTP Status Code: 429

NotFoundException

The resource specified in the request was not found. Check the resource and try again.

HTTP Status Code: 404

See Also

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