Skip to content
AWS for Query.Farm

aws.lexv2_models.describe_bot_locale

Example SQL Queries

SELECT * FROM
aws.lexv2_models.describe_bot_locale
WHERE
"bot_id" = 'VALUE'
AND "bot_version" = 'VALUE'
AND "locale_id" = 'VALUE';

Description

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

Table Definition

Column NameColumn Data Type
bot_id Required Input Column

The identifier of the bot associated with the locale.

VARCHAR
bot_version Required Input Column

The version of the bot associated with the locale.

VARCHAR
locale_id Required Input Column

The unique identifier of the described locale.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

bot_locale_history_events

History of changes, such as when a locale is used in an alias, that have taken place for the locale.

STRUCT(
    "event" VARCHAR,
    "event_date" TIMESTAMP_S
)[]
Show child fields
bot_locale_history_events[]
Show child fields
bot_locale_history_events[].event

A description of the event that occurred.

bot_locale_history_events[].event_date

A timestamp of the date and time that the event occurred.

bot_locale_status

The status of the bot. If the status is Failed, the reasons for the failure are listed in the failureReasons field.

VARCHAR
creation_date_time

The date and time that the locale was created.

TIMESTAMP_S
description

The description of the locale.

VARCHAR
failure_reasons

if botLocaleStatus is Failed, Amazon Lex explains why it failed to build the bot.

VARCHAR[]
Show child fields
failure_reasons[]
generative_ai_settings

Contains settings for Amazon Bedrock's generative AI features for your bot locale.

STRUCT(
    "runtime_settings" STRUCT(
        "slot_resolution_improvement" STRUCT(
            "enabled" BOOLEAN,
            "bedrock_model_specification" STRUCT(
                "model_arn" VARCHAR,
                "guardrail" STRUCT(
                    "identifier" VARCHAR,
                    "version" VARCHAR
                ),
                "trace_status" VARCHAR,
                "custom_prompt" VARCHAR
            )
        )
    ),
    "buildtime_settings" STRUCT(
        "descriptive_bot_builder" STRUCT(
            "enabled" BOOLEAN,
            "bedrock_model_specification" STRUCT(
                "model_arn" VARCHAR,
                "guardrail" STRUCT(
                    "identifier" VARCHAR,
                    "version" VARCHAR
                ),
                "trace_status" VARCHAR,
                "custom_prompt" VARCHAR
            )
        ),
        "sample_utterance_generation" STRUCT(
            "enabled" BOOLEAN,
            "bedrock_model_specification" STRUCT(
                "model_arn" VARCHAR,
                "guardrail" STRUCT(
                    "identifier" VARCHAR,
                    "version" VARCHAR
                ),
                "trace_status" VARCHAR,
                "custom_prompt" VARCHAR
            )
        )
    )
)
Show child fields
generative_ai_settings.buildtime_settings

Contains specifications about the Amazon Lex build time generative AI capabilities from Amazon Bedrock that you can turn on for your bot.

Show child fields
generative_ai_settings.buildtime_settings.descriptive_bot_builder

An object containing specifications for the descriptive bot building feature.

Show child fields
generative_ai_settings.buildtime_settings.descriptive_bot_builder.bedrock_model_specification

An object containing information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.

Show child fields
generative_ai_settings.buildtime_settings.descriptive_bot_builder.bedrock_model_specification.custom_prompt

The custom prompt used in the Bedrock model specification details.

generative_ai_settings.buildtime_settings.descriptive_bot_builder.bedrock_model_specification.guardrail

The guardrail configuration in the Bedrock model specification details.

Show child fields
generative_ai_settings.buildtime_settings.descriptive_bot_builder.bedrock_model_specification.guardrail.identifier

The unique guardrail id for the Bedrock guardrail configuration.

generative_ai_settings.buildtime_settings.descriptive_bot_builder.bedrock_model_specification.guardrail.version

The guardrail version for the Bedrock guardrail configuration.

generative_ai_settings.buildtime_settings.descriptive_bot_builder.bedrock_model_specification.model_arn

The ARN of the foundation model used in descriptive bot building.

generative_ai_settings.buildtime_settings.descriptive_bot_builder.bedrock_model_specification.trace_status

The Bedrock trace status in the Bedrock model specification details.

generative_ai_settings.buildtime_settings.descriptive_bot_builder.enabled

Specifies whether the descriptive bot building feature is activated or not.

generative_ai_settings.buildtime_settings.sample_utterance_generation

Contains specifications for the sample utterance generation feature.

Show child fields
generative_ai_settings.buildtime_settings.sample_utterance_generation.bedrock_model_specification

Contains information about the Amazon Bedrock model used to interpret the prompt used in descriptive bot building.

Show child fields
generative_ai_settings.buildtime_settings.sample_utterance_generation.bedrock_model_specification.custom_prompt

The custom prompt used in the Bedrock model specification details.

generative_ai_settings.buildtime_settings.sample_utterance_generation.bedrock_model_specification.guardrail

The guardrail configuration in the Bedrock model specification details.

Show child fields
generative_ai_settings.buildtime_settings.sample_utterance_generation.bedrock_model_specification.guardrail.identifier

The unique guardrail id for the Bedrock guardrail configuration.

generative_ai_settings.buildtime_settings.sample_utterance_generation.bedrock_model_specification.guardrail.version

The guardrail version for the Bedrock guardrail configuration.

generative_ai_settings.buildtime_settings.sample_utterance_generation.bedrock_model_specification.model_arn

The ARN of the foundation model used in descriptive bot building.

generative_ai_settings.buildtime_settings.sample_utterance_generation.bedrock_model_specification.trace_status

The Bedrock trace status in the Bedrock model specification details.

generative_ai_settings.buildtime_settings.sample_utterance_generation.enabled

Specifies whether to enable sample utterance generation or not.

generative_ai_settings.runtime_settings

Contains specifications about the Amazon Lex runtime generative AI capabilities from Amazon Bedrock that you can turn on for your bot.

Show child fields
generative_ai_settings.runtime_settings.slot_resolution_improvement

An object containing specifications for the assisted slot resolution feature.

Show child fields
generative_ai_settings.runtime_settings.slot_resolution_improvement.bedrock_model_specification

An object containing information about the Amazon Bedrock model used to assist slot resolution.

Show child fields
generative_ai_settings.runtime_settings.slot_resolution_improvement.bedrock_model_specification.custom_prompt

The custom prompt used in the Bedrock model specification details.

generative_ai_settings.runtime_settings.slot_resolution_improvement.bedrock_model_specification.guardrail

The guardrail configuration in the Bedrock model specification details.

Show child fields
generative_ai_settings.runtime_settings.slot_resolution_improvement.bedrock_model_specification.guardrail.identifier

The unique guardrail id for the Bedrock guardrail configuration.

generative_ai_settings.runtime_settings.slot_resolution_improvement.bedrock_model_specification.guardrail.version

The guardrail version for the Bedrock guardrail configuration.

generative_ai_settings.runtime_settings.slot_resolution_improvement.bedrock_model_specification.model_arn

The ARN of the foundation model used in descriptive bot building.

generative_ai_settings.runtime_settings.slot_resolution_improvement.bedrock_model_specification.trace_status

The Bedrock trace status in the Bedrock model specification details.

generative_ai_settings.runtime_settings.slot_resolution_improvement.enabled

Specifies whether assisted slot resolution is turned on or off.

intents_count

The number of intents defined for the locale.

BIGINT
last_build_submitted_date_time

The date and time that the locale was last submitted for building.

TIMESTAMP_S
last_updated_date_time

The date and time that the locale was last updated.

TIMESTAMP_S
locale_name

The name of the locale.

VARCHAR
nlu_intent_confidence_threshold

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

DOUBLE
recommended_actions

Recommended actions to take to resolve an error in the failureReasons field.

VARCHAR[]
Show child fields
recommended_actions[]
slot_types_count

The number of slot types defined for the locale.

BIGINT
voice_settings

The Amazon Polly voice Amazon Lex uses for voice interaction with the user.

STRUCT(
    "voice_id" VARCHAR,
    "engine" VARCHAR
)
Show child fields
voice_settings.engine

Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see the engine parameter of the SynthesizeSpeech operation in the Amazon Polly developer guide.

If you do not specify a value, the default is standard.

voice_settings.voice_id

The identifier of the Amazon Polly voice to use.