UpdateSlotType - Amazon Lex

UpdateSlotType

Updates the configuration of an existing slot type.

Request Syntax

PUT /bots/botId/botversions/botVersion/botlocales/localeId/slottypes/slotTypeId/ HTTP/1.1 Content-type: application/json { "description": "string", "parentSlotTypeSignature": "string", "slotTypeName": "string", "slotTypeValues": [ { "sampleValue": { "value": "string" }, "synonyms": [ { "value": "string" } ] } ], "valueSelectionSetting": { "regexFilter": { "pattern": "string" }, "resolutionStrategy": "string" } }

URI Request Parameters

The request uses the following URI parameters.

botId

The identifier of the bot that contains the slot type.

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

Required: Yes

botVersion

The version of the bot that contains the slot type. Must be DRAFT.

Length Constraints: Fixed length of 5.

Pattern: ^DRAFT$

Required: Yes

localeId

The identifier of the language and locale that contains the slot type. The string must match one of the supported locales. For more information, see Supported languages.

Required: Yes

slotTypeId

The unique identifier of the slot type to update.

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

Required: Yes

Request Body

The request accepts the following data in JSON format.

description

The new description of the slot type.

Type: String

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

Required: No

parentSlotTypeSignature

The new built-in slot type that should be used as the parent of this slot type.

Type: String

Required: No

slotTypeName

The new name of the slot type.

Type: String

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

Pattern: ^([0-9a-zA-Z][_-]?)+$

Required: Yes

slotTypeValues

A new list of values and their optional synonyms that define the values that the slot type can take.

Type: Array of SlotTypeValue objects

Array Members: Minimum number of 1 item. Maximum number of 10000 items.

Required: No

valueSelectionSetting

The strategy that Amazon Lex should use when deciding on a value from the list of slot type values.

Type: SlotValueSelectionSetting object

Required: Yes

Response Syntax

HTTP/1.1 202 Content-type: application/json { "botId": "string", "botVersion": "string", "creationDateTime": number, "description": "string", "lastUpdatedDateTime": number, "localeId": "string", "parentSlotTypeSignature": "string", "slotTypeId": "string", "slotTypeName": "string", "slotTypeValues": [ { "sampleValue": { "value": "string" }, "synonyms": [ { "value": "string" } ] } ], "valueSelectionSetting": { "regexFilter": { "pattern": "string" }, "resolutionStrategy": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

botId

The identifier of the bot that contains the slot type.

Type: String

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

botVersion

The version of the bot that contains the slot type. This is always DRAFT.

Type: String

Length Constraints: Fixed length of 5.

Pattern: ^DRAFT$

creationDateTime

The timestamp of the date and time that the slot type was created.

Type: Timestamp

description

The updated description of the slot type.

Type: String

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

lastUpdatedDateTime

A timestamp of the date and time that the slot type was last updated.

Type: Timestamp

localeId

The language and locale of the updated slot type.

Type: String

parentSlotTypeSignature

The updated signature of the built-in slot type that is the parent of this slot type.

Type: String

slotTypeId

The unique identifier of the updated slot type.

Type: String

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

slotTypeName

The updated name of the slot type.

Type: String

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

Pattern: ^([0-9a-zA-Z][_-]?)+$

slotTypeValues

The updated values that the slot type provides.

Type: Array of SlotTypeValue objects

Array Members: Minimum number of 1 item. Maximum number of 10000 items.

valueSelectionSetting

The updated strategy that Amazon Lex uses to determine which value to select from the slot type.

Type: SlotValueSelectionSetting object

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

HTTP Status Code: 409

InternalServerException

HTTP Status Code: 500

PreconditionFailedException

HTTP Status Code: 412

ServiceQuotaExceededException

HTTP Status Code: 402

ThrottlingException

HTTP Status Code: 429

ValidationException

HTTP Status Code: 400

See Also

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