Menu
Amazon Lex
Developer Guide

PutSlotType

Creates a custom slot type or replaces an existing custom slot type.

To create a custom slot type, specify a name for the slot type and a set of enumeration values, which are the values that a slot of this type can assume. For more information, see Amazon Lex: How It Works.

If you specify the name of an existing slot type, the fields in the request replace the existing values in the $LATEST version of the slot type. Amazon Lex removes the fields that you don't provide in the request. If you don't specify required fields, Amazon Lex throws an exception.

This operation requires permissions for the lex:PutSlotType action.

Request Syntax

Copy
PUT /slottypes/name/versions/$LATEST HTTP/1.1 Content-type: application/json { "checksum": "string", "description": "string", "enumerationValues": [ { "value": "string" } ] }

URI Request Parameters

The request requires the following URI parameters.

name

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

The name can't match a built-in slot type name, or a built-in slot type name with "AMAZON." removed. For example, because there is a built-in slot type called AMAZON.DATE, you can't create a custom slot type called DATE.

For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit.

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

Pattern: ^[a-zA-Z]+((_[a-zA-Z]+)*|([a-zA-Z]+_)*|_)

Request Body

The request accepts the following data in JSON format.

checksum

Identifies a specific revision of the $LATEST version.

When you create a new slot type, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

When you want to update a slot type, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.

Type: String

Required: No

description

A description of the slot type.

Type: String

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

Required: No

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 1 item. Maximum number of 10000 items.

Required: No

Response Syntax

Copy
HTTP/1.1 200 Content-type: application/json { "checksum": "string", "createdDate": number, "description": "string", "enumerationValues": [ { "value": "string" } ], "lastUpdatedDate": number, "name": "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 1 item. Maximum number of 10000 items.

lastUpdatedDate

The date that the slot type was updated. When you create a slot type, 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]+((_[a-zA-Z]+)*|([a-zA-Z]+_)*|_)

version

The version of the slot type. For a new slot type, the version is always $LATEST.

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

ConflictException

There was a conflict processing the request. Try your request again.

HTTP Status Code: 409

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

PreconditionFailedException

The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.

HTTP Status Code: 412

See Also

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