PUT

/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/slottypes/

http://models-v2-lex.{region}.amazonaws.com/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/slottypes/

Creates a custom slot type To create a custom slot type, specify a name for the slot type and a set of enumeration values, the values that a slot of this type can assume.

Access Token Required: API Key

Path Parameters

botIdstringrequired

The identifier of the bot associated with this slot type.

botVersionstringrequired

The identifier of the bot version associated with this slot type.

localeIdstringrequired

The identifier of the language and locale that the slot type will be used in. The string must match one of the supported locales. All of the bots, intents, and slots used by the slot type must have the same locale. For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.

Body Params

descriptionstring

A description of the slot type. Use the description to help identify the slot type in lists.

slotTypeNamestringrequired

The name for the slot. A slot type name must be unique within the account.

slotTypeValuesarray

A list of <code>SlotTypeValue</code> objects that defines the values that the slot type can take. Each value can have a list of synonyms, additional values that help train the machine learning model about the values that it resolves for a slot.

externalSourceSettingobject

Provides information about the external source of the slot type's definition.

valueSelectionSettingobject

Contains settings used by Amazon Lex to select a slot value.

parentSlotTypeSignaturestring

The built-in slot type used as a parent of this slot type. When you define a parent slot type, the new slot type has the configuration of the parent slot type. Only <code>AMAZON.AlphaNumeric</code> is supported.

compositeSlotTypeSettingobject

A composite slot is a combination of two or more slots that capture multiple pieces of information in a single user input.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://models-v2-lex.{region}.amazonaws.com/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/slottypes/' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

PUT