bot_locales

Creates, updates, deletes, gets or lists a bot_locales resource.

Overview

Name	bot_locales
Type	Resource
Id	aws.lexv2_models.bot_locales

Fields

The following fields are returned by SELECT queries:

describe_bot_locale

Name	Datatype	Description
audio_filler_settings	object	The audio filler settings configured for the bot locale.
bot_id	string	The identifier of the bot associated with the locale. (pattern: <code>^[0-9a-zA-Z]+$</code>)
bot_locale_history_events	array	History of changes, such as when a locale is used in an alias, that have taken place for the locale.
bot_locale_status	string	The status of the bot. If the status is Failed, the reasons for the failure are listed in the failureReasons field. (Creating, Building, Built, ReadyExpressTesting, Failed, Deleting, NotBuilt, Importing, Processing)
bot_version	string	The version of the bot associated with the locale. (pattern: <code>^(DRAFT|[0-9]+)$</code>)
creation_date_time	string (date-time)	The date and time that the locale was created.
description	string	The description of the locale.
failure_reasons	array	if botLocaleStatus is Failed, Amazon Lex explains why it failed to build the bot.
generative_ai_settings	object	Contains settings for Amazon Bedrock's generative AI features for your bot locale.
intents_count	integer	The number of intents defined for the locale.
last_build_submitted_date_time	string (date-time)	The date and time that the locale was last submitted for building.
last_updated_date_time	string (date-time)	The date and time that the locale was last updated.
locale_id	string	The unique identifier of the described locale.
locale_name	string	The name of the locale.
nlu_intent_confidence_threshold	number (double)	The confidence threshold where Amazon Lex inserts the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.
recommended_actions	array	Recommended actions to take to resolve an error in the failureReasons field.
slot_types_count	integer	The number of slot types defined for the locale.
speech_detection_sensitivity	string	The sensitivity level for voice activity detection (VAD) configured for the bot locale. (Default, HighNoiseTolerance, MaximumNoiseTolerance)
speech_recognition_settings	object	The speech-to-text settings configured for the bot locale.
unified_speech_settings	object	The unified speech settings configured for the bot locale.
voice_settings	object	The Amazon Polly voice Amazon Lex uses for voice interaction with the user.

list_bot_locales

Name	Datatype	Description
bot_id	string	The identifier of the bot to list locales for. (pattern: <code>^[0-9a-zA-Z]+$</code>)
bot_locale_summaries	array	Summary information for the locales that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more locales available, the nextToken field contains a token to get the next page of results.
bot_version	string	The version of the bot. (pattern: <code>^(DRAFT|[0-9]+)$</code>)
next_token	string	A token that indicates whether there are more results to return in a response to the ListBotLocales operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBotLocales operation request to get the next page of results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_bot_locale	select	bot_id, bot_version, locale_id, region		Describes the settings that a bot has for a specific locale.
list_bot_locales	select	bot_id, bot_version, region		Gets a list of locales for the specified bot.
create_bot_locale	insert	bot_id, bot_version, region, localeId, nluIntentConfidenceThreshold		Creates a locale in the bot. The locale contains the intents and slot types that the bot uses in conversations with users in the specified language and locale. You must add a locale to a bot before you can add intents and slot types to the bot.
update_bot_locale	update	bot_id, bot_version, locale_id, region, nluIntentConfidenceThreshold		Updates the settings that a bot has for a specific locale.
delete_bot_locale	delete	bot_id, bot_version, locale_id, region		Removes a locale from a bot. When you delete a locale, all intents, slots, and slot types defined for the locale are also deleted.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
bot_id	string	The unique identifier of the bot that contains the locale.
bot_version	string	The version of the bot that contains the locale.
locale_id	string	The identifier of the language and locale that will be deleted. The string must match one of the supported locales. For more information, see Supported languages.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_bot_locale

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

SELECT
audio_filler_settings,
bot_id,
bot_locale_history_events,
bot_locale_status,
bot_version,
creation_date_time,
description,
failure_reasons,
generative_ai_settings,
intents_count,
last_build_submitted_date_time,
last_updated_date_time,
locale_id,
locale_name,
nlu_intent_confidence_threshold,
recommended_actions,
slot_types_count,
speech_detection_sensitivity,
speech_recognition_settings,
unified_speech_settings,
voice_settings
FROM aws.lexv2_models.bot_locales
WHERE bot_id = '{{ bot_id }}' -- required
AND bot_version = '{{ bot_version }}' -- required
AND locale_id = '{{ locale_id }}' -- required
AND region = '{{ region }}' -- required
;

list_bot_locales

Gets a list of locales for the specified bot.

SELECT
bot_id,
bot_locale_summaries,
bot_version,
next_token
FROM aws.lexv2_models.bot_locales
WHERE bot_id = '{{ bot_id }}' -- required
AND bot_version = '{{ bot_version }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_bot_locale

Creates a locale in the bot. The locale contains the intents and slot types that the bot uses in conversations with users in the specified language and locale. You must add a locale to a bot before you can add intents and slot types to the bot.

INSERT INTO aws.lexv2_models.bot_locales (
localeId,
description,
nluIntentConfidenceThreshold,
voiceSettings,
unifiedSpeechSettings,
audioFillerSettings,
speechRecognitionSettings,
generativeAISettings,
speechDetectionSensitivity,
bot_id,
bot_version,
region
)
SELECT 
'{{ localeId }}' /* required */,
'{{ description }}',
{{ nluIntentConfidenceThreshold }} /* required */,
'{{ voiceSettings }}',
'{{ unifiedSpeechSettings }}',
'{{ audioFillerSettings }}',
'{{ speechRecognitionSettings }}',
'{{ generativeAISettings }}',
'{{ speechDetectionSensitivity }}',
'{{ bot_id }}',
'{{ bot_version }}',
'{{ region }}'
RETURNING
audio_filler_settings,
bot_id,
bot_locale_status,
bot_version,
creation_date_time,
description,
generative_ai_settings,
locale_id,
locale_name,
nlu_intent_confidence_threshold,
speech_detection_sensitivity,
speech_recognition_settings,
unified_speech_settings,
voice_settings
;

Manifest

# Description fields are for documentation purposes
- name: bot_locales
props:
  - name: bot_id
    value: "{{ bot_id }}"
    description: Required parameter for the bot_locales resource.
  - name: bot_version
    value: "{{ bot_version }}"
    description: Required parameter for the bot_locales resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the bot_locales resource.
  - name: localeId
    value: "{{ localeId }}"
  - name: description
    value: "{{ description }}"
  - name: nluIntentConfidenceThreshold
    value: {{ nluIntentConfidenceThreshold }}
  - name: voiceSettings
    description: |
      Defines settings for using an Amazon Polly voice to communicate with a user. Valid values include: standard neural long-form generative
    value:
      engine: "{{ engine }}"
      voiceId: "{{ voiceId }}"
  - name: unifiedSpeechSettings
    description: |
      Unified configuration settings that combine speech recognition and synthesis capabilities.
    value:
      speechFoundationModel:
        modelArn: "{{ modelArn }}"
        voiceId: "{{ voiceId }}"
  - name: audioFillerSettings
    description: |
      Configuration that plays background filler audio during speech-to-speech interactions to mask processing delays and improve the perceived responsiveness of the bot. Audio filler requires unifiedSpeechSettings (speech-to-speech) to be enabled on the bot locale when enabled is true.
    value:
      enabled: {{ enabled }}
      audioType: "{{ audioType }}"
      startDelayInMilliseconds: {{ startDelayInMilliseconds }}
      minimumPlayDurationInMilliseconds: {{ minimumPlayDurationInMilliseconds }}
      responseDeliveryDelayInMilliseconds: {{ responseDeliveryDelayInMilliseconds }}
  - name: speechRecognitionSettings
    description: |
      Settings that control how Amazon Lex processes and recognizes speech input from users.
    value:
      speechModelPreference: "{{ speechModelPreference }}"
      speechModelConfig:
        deepgramConfig:
          apiTokenSecretArn: "{{ apiTokenSecretArn }}"
          modelId: "{{ modelId }}"
  - name: generativeAISettings
    description: |
      Contains specifications about the generative AI capabilities from Amazon Bedrock that you can turn on for your bot.
    value:
      runtimeSettings:
        slotResolutionImprovement:
          enabled: {{ enabled }}
          bedrockModelSpecification:
            modelArn: "{{ modelArn }}"
            guardrail:
              identifier: "{{ identifier }}"
              version: "{{ version }}"
            traceStatus: "{{ traceStatus }}"
            customPrompt: "{{ customPrompt }}"
        nluImprovement:
          enabled: {{ enabled }}
          assistedNluMode: "{{ assistedNluMode }}"
          intentDisambiguationSettings:
            enabled: {{ enabled }}
            maxDisambiguationIntents: {{ maxDisambiguationIntents }}
            customDisambiguationMessage: "{{ customDisambiguationMessage }}"
      buildtimeSettings:
        descriptiveBotBuilder:
          enabled: {{ enabled }}
          bedrockModelSpecification:
            modelArn: "{{ modelArn }}"
            guardrail:
              identifier: "{{ identifier }}"
              version: "{{ version }}"
            traceStatus: "{{ traceStatus }}"
            customPrompt: "{{ customPrompt }}"
        sampleUtteranceGeneration:
          enabled: {{ enabled }}
          bedrockModelSpecification:
            modelArn: "{{ modelArn }}"
            guardrail:
              identifier: "{{ identifier }}"
              version: "{{ version }}"
            traceStatus: "{{ traceStatus }}"
            customPrompt: "{{ customPrompt }}"
  - name: speechDetectionSensitivity
    value: "{{ speechDetectionSensitivity }}"
    description: |
      Determines the sensitivity level for voice activity detection (VAD) in noisy environments. This setting helps optimize speech recognition accuracy by adjusting how the system responds to background noise. Valid values include: Default - Standard sensitivity level suitable for most environments HighNoiseTolerance - Increased tolerance for moderate background noise MaximumNoiseTolerance - Maximum tolerance for high levels of background noise
    valid_values: ['Default', 'HighNoiseTolerance', 'MaximumNoiseTolerance']

UPDATE examples

update_bot_locale

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

UPDATE aws.lexv2_models.bot_locales
SET 
description = '{{ description }}',
nluIntentConfidenceThreshold = {{ nluIntentConfidenceThreshold }},
voiceSettings = '{{ voiceSettings }}',
unifiedSpeechSettings = '{{ unifiedSpeechSettings }}',
audioFillerSettings = '{{ audioFillerSettings }}',
speechRecognitionSettings = '{{ speechRecognitionSettings }}',
generativeAISettings = '{{ generativeAISettings }}',
speechDetectionSensitivity = '{{ speechDetectionSensitivity }}'
WHERE 
bot_id = '{{ bot_id }}' --required
AND bot_version = '{{ bot_version }}' --required
AND locale_id = '{{ locale_id }}' --required
AND region = '{{ region }}' --required
AND nluIntentConfidenceThreshold = '{{ nluIntentConfidenceThreshold }}' --required
RETURNING
audio_filler_settings,
bot_id,
bot_locale_status,
bot_version,
creation_date_time,
description,
failure_reasons,
generative_ai_settings,
last_updated_date_time,
locale_id,
locale_name,
nlu_intent_confidence_threshold,
recommended_actions,
speech_detection_sensitivity,
speech_recognition_settings,
unified_speech_settings,
voice_settings;

DELETE examples

delete_bot_locale

Removes a locale from a bot. When you delete a locale, all intents, slots, and slot types defined for the locale are also deleted.

DELETE FROM aws.lexv2_models.bot_locales
WHERE bot_id = '{{ bot_id }}' --required
AND bot_version = '{{ bot_version }}' --required
AND locale_id = '{{ locale_id }}' --required
AND region = '{{ region }}' --required
;