Skip to content

aws.lexv2_models.describe_bot_alias

Example SQL Queries

SELECT * FROM
aws.lexv2_models.describe_bot_alias
WHERE
"bot_alias_id" = 'VALUE'
AND "bot_id" = 'VALUE';

Description

Get information about a specific bot alias.

Table Definition

Column NameColumn Data Type
bot_alias_id Required Input Column

The identifier of the bot alias.

VARCHAR
bot_id Required Input Column

The identifier of the bot associated with the bot alias.

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_alias_history_events

A list of events that affect a bot alias. For example, an event is recorded when the version that the alias points to changes.

STRUCT(
"bot_version" VARCHAR,
"start_date" TIMESTAMP_S,
"end_date" TIMESTAMP_S
)[]
Show child fields
bot_alias_history_events[]
Show child fields
bot_alias_history_events[].bot_version

The version of the bot that was used in the event.

bot_alias_history_events[].end_date

The date and time that the event ended.

bot_alias_history_events[].start_date

The date and time that the event started.

bot_alias_locale_settings

The locale settings that are unique to the alias.

MAP(VARCHAR, STRUCT(
"enabled" BOOLEAN,
"code_hook_specification" STRUCT(
"lambda_code_hook" STRUCT(
"lambda_arn" VARCHAR,
"code_hook_interface_version" VARCHAR
)
)
))
bot_alias_name

The name of the bot alias.

VARCHAR
bot_alias_status

The current status of the alias. When the alias is Available, the alias is ready for use with your bot.

VARCHAR
bot_version

The version of the bot associated with the bot alias.

VARCHAR
conversation_log_settings

Specifics of how Amazon Lex logs text and audio conversations with the bot associated with the alias.

STRUCT(
"text_log_settings" STRUCT(
"enabled" BOOLEAN,
"destination" STRUCT(
"cloud_watch" STRUCT(
"cloud_watch_log_group_arn" VARCHAR,
"log_prefix" VARCHAR
)
),
"selective_logging_enabled" BOOLEAN
)[],
"audio_log_settings" STRUCT(
"enabled" BOOLEAN,
"destination" STRUCT(
"s3_bucket" STRUCT(
"kms_key_arn" VARCHAR,
"s3_bucket_arn" VARCHAR,
"log_prefix" VARCHAR
)
),
"selective_logging_enabled" BOOLEAN
)[]
)
Show child fields
conversation_log_settings.audio_log_settings[]
Show child fields
conversation_log_settings.audio_log_settings[].destination

The location of audio log files collected when conversation logging is enabled for a bot.

Show child fields
conversation_log_settings.audio_log_settings[].destination.s3_bucket

The Amazon S3 bucket where the audio log files are stored. The IAM role specified in the roleArn parameter of the CreateBot operation must have permission to write to this bucket.

Show child fields
conversation_log_settings.audio_log_settings[].destination.s3_bucket.kms_key_arn

The Amazon Resource Name (ARN) of an Amazon Web Services Key Management Service (KMS) key for encrypting audio log files stored in an S3 bucket.

conversation_log_settings.audio_log_settings[].destination.s3_bucket.log_prefix

The S3 prefix to assign to audio log files.

conversation_log_settings.audio_log_settings[].destination.s3_bucket.s3_bucket_arn

The Amazon Resource Name (ARN) of an Amazon S3 bucket where audio log files are stored.

conversation_log_settings.audio_log_settings[].enabled

Determines whether audio logging in enabled for the bot.

conversation_log_settings.audio_log_settings[].selective_logging_enabled

The option to enable selective conversation log capture for audio.

conversation_log_settings.text_log_settings[]
Show child fields
conversation_log_settings.text_log_settings[].destination

Defines the Amazon CloudWatch Logs destination log group for conversation text logs.

Show child fields
conversation_log_settings.text_log_settings[].destination.cloud_watch

Defines the Amazon CloudWatch Logs log group where text and metadata logs are delivered.

Show child fields
conversation_log_settings.text_log_settings[].destination.cloud_watch.cloud_watch_log_group_arn

The Amazon Resource Name (ARN) of the log group where text and metadata logs are delivered.

conversation_log_settings.text_log_settings[].destination.cloud_watch.log_prefix

The prefix of the log stream name within the log group that you specified

conversation_log_settings.text_log_settings[].enabled

Determines whether conversation logs should be stored for an alias.

conversation_log_settings.text_log_settings[].selective_logging_enabled

The option to enable selective conversation log capture for text.

creation_date_time

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

TIMESTAMP_S
description

The description of the bot alias.

VARCHAR
last_updated_date_time

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

TIMESTAMP_S
parent_bot_networks

A list of the networks to which the bot alias you described belongs.

STRUCT(
"bot_id" VARCHAR,
"bot_version" VARCHAR
)[]
Show child fields
parent_bot_networks[]
Show child fields
parent_bot_networks[].bot_id

The identifier of the network of bots assigned by Amazon Lex.

parent_bot_networks[].bot_version

The version of the network of bots.

sentiment_analysis_settings

Determines whether Amazon Lex will use Amazon Comprehend to detect the sentiment of user utterances.

STRUCT(
"detect_sentiment" BOOLEAN
)
Show child fields
sentiment_analysis_settings.detect_sentiment

Sets whether Amazon Lex uses Amazon Comprehend to detect the sentiment of user utterances.