Skip to content
AWS for Query.Farm

aws.lex_models.get_bot

Example SQL Queries

SELECT * FROM
aws.lex_models.get_bot
WHERE
"name" = 'VALUE'
AND "version_or_alias" = 'VALUE';

Description

Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias.

This operation requires permissions for the lex:GetBot action.

Table Definition

Column NameColumn Data Type
name Required Input Column

The name of the bot.

VARCHAR
version_or_alias Required Input Column

The version or alias of the bot.

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.

abort_statement

The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see PutBot.

STRUCT(
    "messages" STRUCT(
        "content_type" VARCHAR,
        "content" VARCHAR,
        "group_number" BIGINT
    )[],
    "response_card" VARCHAR
)
Show child fields
abort_statement.messages[]
Show child fields
abort_statement.messages[].content

The text of the message.

abort_statement.messages[].content_type

The content type of the message string.

abort_statement.messages[].group_number

Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

abort_statement.response_card

At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

checksum

Checksum of the bot used to identify a specific revision of the bot's $LATEST version.

VARCHAR
child_directed

For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.

If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ. 

BOOLEAN
clarification_prompt

The message Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot. 

STRUCT(
    "messages" STRUCT(
        "content_type" VARCHAR,
        "content" VARCHAR,
        "group_number" BIGINT
    )[],
    "max_attempts" BIGINT,
    "response_card" VARCHAR
)
Show child fields
clarification_prompt.max_attempts

The number of times to prompt the user for information.

clarification_prompt.messages[]
Show child fields
clarification_prompt.messages[].content

The text of the message.

clarification_prompt.messages[].content_type

The content type of the message string.

clarification_prompt.messages[].group_number

Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

clarification_prompt.response_card

A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

created_date

The date that the bot was created.

TIMESTAMP_S
description

A description of the bot.

VARCHAR
detect_sentiment

Indicates whether user utterances should be sent to Amazon Comprehend for sentiment analysis.

BOOLEAN
enable_model_improvements

Indicates whether the bot uses accuracy improvements. true indicates that the bot is using the improvements, otherwise, false.

BOOLEAN
failure_reason

If status is FAILED, Amazon Lex explains why it failed to build the bot.

VARCHAR
idle_session_ttl_in_seconds

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.

BIGINT
intents

An array of intent objects. For more information, see PutBot.

STRUCT(
    "intent_name" VARCHAR,
    "intent_version" VARCHAR
)[]
Show child fields
intents[]
Show child fields
intents[].intent_name

The name of the intent.

intents[].intent_version

The version of the intent.

last_updated_date

The date that the bot was updated. When you create a resource, the creation date and last updated date are the same. 

TIMESTAMP_S
locale

The target locale for the bot. 

VARCHAR
nlu_intent_confidence_threshold

The score that determines where Amazon Lex inserts the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a PostContent or PostText response. AMAZON.FallbackIntent is inserted if the confidence score for all intents is below this value. AMAZON.KendraSearchIntent is only inserted if it is configured for the bot.

DOUBLE
status

The status of the bot.

When the status is BUILDING Amazon Lex is building the bot for testing and use.

If the status of the bot is READY_BASIC_TESTING, you can test the bot using the exact utterances specified in the bot's intents. When the bot is ready for full testing or to run, the status is READY.

If there was a problem with building the bot, the status is FAILED and the failureReason field explains why the bot did not build.

If the bot was saved but not built, the status is NOT_BUILT.

VARCHAR
version

The version of the bot. For a new bot, the version is always $LATEST.

VARCHAR
voice_id

The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.

VARCHAR