Skip to content

aws.lexv2_models.list_bots

Example SQL Queries

SELECT * FROM
aws.lexv2_models.list_bots;

Description

Gets a list of available bots.

Table Definition

Column NameColumn Data Type
filters Input Column

Provides the specification of a filter used to limit the bots in the response to only those that match the filter specification. You can only specify one filter and one string to filter on.

STRUCT(
"name" VARCHAR,
"values" VARCHAR[],
"operator" VARCHAR
)[]
Show child fields
filters[]
Show child fields
filters[].name

The name of the field to filter the list of bots.

filters[].operator

The operator to use for the filter. Specify EQ when the ListBots operation should return only aliases that equal the specified value. Specify CO when the ListBots operation should return aliases that contain the specified value.

filters[].values[]
max_results Input Column

The maximum number of bots to return in each page of results. If there are fewer results than the maximum page size, only the actual number of results are returned.

BIGINT
next_token Input Column

A token that indicates whether there are more results to return in a response to the ListBots operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListBots operation request to get the next page of results.

VARCHAR
sort_by Input Column

Specifies sorting parameters for the list of bots. You can specify that the list be sorted by bot name in ascending or descending order.

STRUCT(
"attribute" VARCHAR,
"order" VARCHAR
)
Show child fields
sort_by.attribute

The attribute to use to sort the list of bots.

sort_by.order

The order to sort the list. You can choose ascending or descending.

_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_summaries

Summary information for the bots 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 bots available, the nextToken field contains a token to the next page of results.

STRUCT(
"bot_id" VARCHAR,
"bot_name" VARCHAR,
"description" VARCHAR,
"bot_status" VARCHAR,
"latest_bot_version" VARCHAR,
"last_updated_date_time" TIMESTAMP_S,
"bot_type" VARCHAR
)[]
Show child fields
bot_summaries[]
Show child fields
bot_summaries[].bot_id

The unique identifier assigned to the bot. Use this ID to get detailed information about the bot with the DescribeBot operation.

bot_summaries[].bot_name

The name of the bot.

bot_summaries[].bot_status

The current status of the bot. When the status is Available the bot is ready for use.

bot_summaries[].bot_type

The type of the bot.

bot_summaries[].description

The description of the bot.

bot_summaries[].last_updated_date_time

The date and time that the bot was last updated.

bot_summaries[].latest_bot_version

The latest numerical version in use for the bot.