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",
"generativeAISettings": {
"buildtimeSettings": {
"descriptiveBotBuilder": {
"bedrockModelSpecification": {
"customPrompt": "string",
"guardrail": {
"identifier": "string",
"version": "string"
},
"modelArn": "string",
"traceStatus": "string"
},
"enabled": boolean
},
"sampleUtteranceGeneration": {
"bedrockModelSpecification": {
"customPrompt": "string",
"guardrail": {
"identifier": "string",
"version": "string"
},
"modelArn": "string",
"traceStatus": "string"
},
"enabled": boolean
}
},
"runtimeSettings": {
"slotResolutionImprovement": {
"bedrockModelSpecification": {
"customPrompt": "string",
"guardrail": {
"identifier": "string",
"version": "string"
},
"modelArn": "string",
"traceStatus": "string"
},
"enabled": boolean
}
}
},
"nluIntentConfidenceThreshold": number,
"voiceSettings": {
"engine": "string",
"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
DRAFTversion.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
- generativeAISettings
-
Contains settings for generative AI features powered by Amazon Bedrock for your bot locale. Use this object to turn generative AI features on and off. Pricing may differ if you turn a feature on. For more information, see LINK.
Type: GenerativeAISettings object
Required: No
- nluIntentConfidenceThreshold
-
The new confidence threshold where Amazon Lex inserts the
AMAZON.FallbackIntentandAMAZON.KendraSearchIntentintents 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" ],
"generativeAISettings": {
"buildtimeSettings": {
"descriptiveBotBuilder": {
"bedrockModelSpecification": {
"customPrompt": "string",
"guardrail": {
"identifier": "string",
"version": "string"
},
"modelArn": "string",
"traceStatus": "string"
},
"enabled": boolean
},
"sampleUtteranceGeneration": {
"bedrockModelSpecification": {
"customPrompt": "string",
"guardrail": {
"identifier": "string",
"version": "string"
},
"modelArn": "string",
"traceStatus": "string"
},
"enabled": boolean
}
},
"runtimeSettings": {
"slotResolutionImprovement": {
"bedrockModelSpecification": {
"customPrompt": "string",
"guardrail": {
"identifier": "string",
"version": "string"
},
"modelArn": "string",
"traceStatus": "string"
},
"enabled": boolean
}
}
},
"lastUpdatedDateTime": number,
"localeId": "string",
"localeName": "string",
"nluIntentConfidenceThreshold": number,
"recommendedActions": [ "string" ],
"voiceSettings": {
"engine": "string",
"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
Builtthe locale is ready for use.Type: String
Valid Values:
Creating | Building | Built | ReadyExpressTesting | Failed | Deleting | NotBuilt | Importing | Processing - 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
botLocaleStatusisFailed, thefailureReasonsfield lists the errors that occurred while building the bot.Type: Array of strings
- generativeAISettings
-
Contains settings for generative AI features powered by Amazon Bedrock for your bot locale.
Type: GenerativeAISettings object
- 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.FallbackIntentandAMAZON.KendraSearchIntentintents in the list of possible intents for an utterance.Type: Double
Valid Range: Minimum value of 0. Maximum value of 1.
- recommendedActions
-
Recommended actions to take to resolve an error in the
failureReasonsfield.Type: Array of strings
- 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
-
The action that you tried to perform couldn't be completed because the resource is in a conflicting state. For example, deleting a bot that is in the CREATING state. Try your request again.
HTTP Status Code: 409
- InternalServerException
-
The service encountered an unexpected condition. Try your request again.
HTTP Status Code: 500
- PreconditionFailedException
-
Your request couldn't be completed because one or more request fields aren't valid. Check the fields in your request and try again.
HTTP Status Code: 412
- ServiceQuotaExceededException
-
You have reached a quota for your bot.
HTTP Status Code: 402
- ThrottlingException
-
Your request rate is too high. Reduce the frequency of requests.
HTTP Status Code: 429
- ValidationException
-
One of the input parameters in your request isn't valid. Check the parameters and try your request again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
