Skip to content

aws.lexv2_models.describe_bot_recommendation

Example SQL Queries

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

Description

Provides metadata information about a bot recommendation. This information will enable you to get a description on the request inputs, to download associated transcripts after processing is complete, and to download intents and slot-types generated by the bot recommendation.

Table Definition

Column NameColumn Data Type
bot_id Required Input Column

The identifier of the bot associated with the bot recommendation.

VARCHAR
bot_recommendation_id Required Input Column

The identifier of the bot recommendation being described.

VARCHAR
bot_version Required Input Column

The version of the bot associated with the bot recommendation.

VARCHAR
locale_id Required Input Column

The identifier of the language and locale of the bot recommendation to describe.

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_recommendation_results

The object representing the URL of the bot definition, the URL of the associated transcript and a statistical summary of the bot recommendation results.

STRUCT(
"bot_locale_export_url" VARCHAR,
"associated_transcripts_url" VARCHAR,
"statistics" STRUCT(
"intents" STRUCT(
"discovered_intent_count" BIGINT
),
"slot_types" STRUCT(
"discovered_slot_type_count" BIGINT
)
)
)
Show child fields
bot_recommendation_results.associated_transcripts_url

The presigned url link of the associated transcript.

bot_recommendation_results.bot_locale_export_url

The presigned URL link of the recommended bot definition.

bot_recommendation_results.statistics

The statistical summary of the bot recommendation results.

Show child fields
bot_recommendation_results.statistics.intents

Statistical information about about the intents associated with the bot recommendation results.

Show child fields
bot_recommendation_results.statistics.intents.discovered_intent_count

The number of recommended intents associated with the bot recommendation.

bot_recommendation_results.statistics.slot_types

Statistical information about the slot types associated with the bot recommendation results.

Show child fields
bot_recommendation_results.statistics.slot_types.discovered_slot_type_count

The number of recommended slot types associated with the bot recommendation.

bot_recommendation_status

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

VARCHAR
creation_date_time

The date and time that the bot recommendation was created.

TIMESTAMP_S
encryption_setting

The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.

STRUCT(
"kms_key_arn" VARCHAR,
"bot_locale_export_password" VARCHAR,
"associated_transcripts_password" VARCHAR
)
Show child fields
encryption_setting.associated_transcripts_password

The password used to encrypt the associated transcript file.

encryption_setting.bot_locale_export_password

The password used to encrypt the recommended bot recommendation file.

encryption_setting.kms_key_arn

The KMS key ARN used to encrypt the metadata associated with the bot recommendation.

failure_reasons

If botRecommendationStatus is Failed, Amazon Lex explains why.

VARCHAR[]
Show child fields
failure_reasons[]
last_updated_date_time

The date and time that the bot recommendation was last updated.

TIMESTAMP_S
transcript_source_setting

The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

STRUCT(
"s3_bucket_transcript_source" STRUCT(
"s3_bucket_name" VARCHAR,
"path_format" STRUCT(
"object_prefixes" VARCHAR[]
),
"transcript_format" VARCHAR,
"transcript_filter" STRUCT(
"lex_transcript_filter" STRUCT(
"date_range_filter" STRUCT(
"start_date_time" TIMESTAMP_S,
"end_date_time" TIMESTAMP_S
)
)
),
"kms_key_arn" VARCHAR
)
)
Show child fields
transcript_source_setting.s3_bucket_transcript_source

Indicates the setting of the Amazon S3 bucket where the transcript is stored.

Show child fields
transcript_source_setting.s3_bucket_transcript_source.kms_key_arn

The ARN of the KMS key that customer use to encrypt their Amazon S3 bucket. Only use this field if your bucket is encrypted using a customer managed KMS key.

transcript_source_setting.s3_bucket_transcript_source.path_format

The object that contains a path format that will be applied when Amazon Lex reads the transcript file in the bucket you provide. Specify this object if you only want Lex to read a subset of files in your Amazon S3 bucket.

Show child fields
transcript_source_setting.s3_bucket_transcript_source.path_format.object_prefixes[]
transcript_source_setting.s3_bucket_transcript_source.s3_bucket_name

The name of the bucket containing the transcript and the associated metadata.

transcript_source_setting.s3_bucket_transcript_source.transcript_filter

The object that contains the filter which will be applied when Amazon Lex reads through the Amazon S3 bucket. Specify this object if you want Amazon Lex to read only a subset of the Amazon S3 bucket based on the filter you provide.

Show child fields
transcript_source_setting.s3_bucket_transcript_source.transcript_filter.lex_transcript_filter

The object representing the filter that Amazon Lex will use to select the appropriate transcript when the transcript format is the Amazon Lex format.

Show child fields
transcript_source_setting.s3_bucket_transcript_source.transcript_filter.lex_transcript_filter.date_range_filter

The object that contains a date range filter that will be applied to the transcript. Specify this object if you want Amazon Lex to only read the files that are within the date range.

Show child fields
transcript_source_setting.s3_bucket_transcript_source.transcript_filter.lex_transcript_filter.date_range_filter.end_date_time

A timestamp indicating the end date for the date range filter.

transcript_source_setting.s3_bucket_transcript_source.transcript_filter.lex_transcript_filter.date_range_filter.start_date_time

A timestamp indicating the start date for the date range filter.

transcript_source_setting.s3_bucket_transcript_source.transcript_format

The format of the transcript content. Currently, Genie only supports the Amazon Lex transcript format.