Skip to content
AWS for Query.Farm

aws.chime_sdk_identity.describe_app_instance_bot

Example SQL Queries

SELECT * FROM
aws.chime_sdk_identity.describe_app_instance_bot
WHERE
"app_instance_bot_arn" = 'VALUE';

Description

The AppInstanceBot's information.

Table Definition

Column NameColumn Data Type
app_instance_bot_arn Required Input Column

The ARN of the AppInstanceBot.

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.

app_instance_bot

The detials of the AppInstanceBot.

STRUCT(
    "app_instance_bot_arn" VARCHAR,
    "name" VARCHAR,
    "configuration" STRUCT(
        "lex" STRUCT(
            "responds_to" VARCHAR,
            "invoked_by" STRUCT(
                "standard_messages" VARCHAR,
                "targeted_messages" VARCHAR
            ),
            "lex_bot_alias_arn" VARCHAR,
            "locale_id" VARCHAR,
            "welcome_intent" VARCHAR
        )
    ),
    "created_timestamp" TIMESTAMP_S,
    "last_updated_timestamp" TIMESTAMP_S,
    "metadata" VARCHAR
)
Show child fields
app_instance_bot.app_instance_bot_arn

The ARN of the AppInstanceBot.

app_instance_bot.configuration

The data processing instructions for an AppInstanceBot.

Show child fields
app_instance_bot.configuration.lex

The configuration for an Amazon Lex V2 bot.

Show child fields
app_instance_bot.configuration.lex.invoked_by

Specifies the type of message that triggers a bot.

Show child fields
app_instance_bot.configuration.lex.invoked_by.standard_messages

Sets standard messages as the bot trigger. For standard messages:

  • ALL: The bot processes all standard messages.

  • AUTO: The bot responds to ALL messages when the channel has one other non-hidden member, and responds to MENTIONS when the channel has more than one other non-hidden member.

  • MENTIONS: The bot processes all standard messages that have a message attribute with CHIME.mentions and a value of the bot ARN.

  • NONE: The bot processes no standard messages.

app_instance_bot.configuration.lex.invoked_by.targeted_messages

Sets targeted messages as the bot trigger. For targeted messages:

  • ALL: The bot processes all TargetedMessages sent to it. The bot then responds with a targeted message back to the sender.

  • NONE: The bot processes no targeted messages.

app_instance_bot.configuration.lex.lex_bot_alias_arn

The ARN of the Amazon Lex V2 bot's alias. The ARN uses this format: arn:aws:lex:REGION:ACCOUNT:bot-alias/MYBOTID/MYBOTALIAS

app_instance_bot.configuration.lex.locale_id

Identifies the Amazon Lex V2 bot's language and locale. The string must match one of the supported locales in Amazon Lex V2. All of the intents, slot types, and slots used in the bot must have the same locale. For more information, see Supported languages in the Amazon Lex V2 Developer Guide.

app_instance_bot.configuration.lex.responds_to

Deprecated. Use InvokedBy instead.

Determines whether the Amazon Lex V2 bot responds to all standard messages. Control messages are not supported.

app_instance_bot.configuration.lex.welcome_intent

The name of the welcome intent configured in the Amazon Lex V2 bot.

app_instance_bot.created_timestamp

The time at which the AppInstanceBot was created.

app_instance_bot.last_updated_timestamp

The time at which the AppInstanceBot was last updated.

app_instance_bot.metadata

The metadata for an AppInstanceBot.

app_instance_bot.name

The name of the AppInstanceBot.