UpdateBotLocale - Amazon Lex

UpdateBotLocale

Updates the settings that a bot has for a specific locale.

Request Syntax

PUT /bots/botId/botversions/botVersion/botlocales/localeId/ HTTP/1.1 Content-type: application/json { "description": "string", "nluIntentConfidenceThreshold": number, "voiceSettings": { "voiceId": "string" } }

URI Request Parameters

The request uses the following URI parameters.

botId

The unique identifier of the bot that contains the locale.

Length Constraints: Fixed length of 10.

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

Required: Yes

botVersion

The version of the bot that contains the locale to be updated. The version can only be the DRAFT version.

Length Constraints: Fixed length of 5.

Pattern: ^DRAFT$

Required: Yes

localeId

The identifier of the language and locale to update. The string must match one of the supported locales. For more information, see Supported languages.

Required: Yes

Request Body

The request accepts the following data in JSON format.

description

The new description of the locale.

Type: String

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

Required: No

nluIntentConfidenceThreshold

The new confidence threshold where Amazon Lex inserts the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.

Type: Double

Valid Range: Minimum value of 0. Maximum value of 1.

Required: Yes

voiceSettings

The new Amazon Polly voice Amazon Lex should use for voice interaction with the user.

Type: VoiceSettings object

Required: No

Response Syntax

HTTP/1.1 202 Content-type: application/json { "botId": "string", "botLocaleStatus": "string", "botVersion": "string", "creationDateTime": number, "description": "string", "failureReasons": [ "string" ], "lastUpdatedDateTime": number, "localeId": "string", "localeName": "string", "nluIntentConfidenceThreshold": number, "voiceSettings": { "voiceId": "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 updated locale.

Type: String

Length Constraints: Fixed length of 10.

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

botLocaleStatus

The current status of the locale. When the bot status is Built the locale is ready for use.

Type: String

Valid Values: Creating | Building | Built | ReadyExpressTesting | Failed | Deleting | NotBuilt

botVersion

The version of the bot that contains the updated locale.

Type: String

Length Constraints: Fixed length of 5.

Pattern: ^DRAFT$

creationDateTime

A timestamp of the date and time that the locale was created.

Type: Timestamp

description

The updated description of the locale.

Type: String

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

failureReasons

If the botLocaleStatus is Failed, the failureReasons field lists the errors that occurred while building the bot.

Type: Array of strings

lastUpdatedDateTime

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

Type: Timestamp

localeId

The language and locale of the updated bot locale.

Type: String

localeName

The updated locale name for the locale.

Type: String

nluIntentConfidenceThreshold

The updated confidence threshold for inserting the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.

Type: Double

Valid Range: Minimum value of 0. Maximum value of 1.

voiceSettings

The updated Amazon Polly voice to use for voice interaction with the user.

Type: VoiceSettings 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: