Skip to content
AWS for Query.Farm

aws.chatbot.describe_chime_webhook_configurations

Example SQL Queries

SELECT * FROM
aws.chatbot.describe_chime_webhook_configurations;

Description

Lists Chime Webhook Configurations optionally filtered by ChatConfigurationArn

Table Definition

Column NameColumn Data Type
chat_configuration_arn Input Column

An optional ARN of a ChimeWebhookConfiguration to describe.

VARCHAR
max_results Input Column

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

BIGINT
next_token Input Column

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

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.

webhook_configurations

A list of Chime webhooks associated with the account.

STRUCT(
    "webhook_description" VARCHAR,
    "chat_configuration_arn" VARCHAR,
    "iam_role_arn" VARCHAR,
    "sns_topic_arns" VARCHAR[],
    "configuration_name" VARCHAR,
    "logging_level" VARCHAR,
    "tags" STRUCT(
        "tag_key" VARCHAR,
        "tag_value" VARCHAR
    )[]
)[]
Show child fields
webhook_configurations[]
Show child fields
webhook_configurations[].chat_configuration_arn

The ARN of the ChimeWebhookConfiguration.

webhook_configurations[].configuration_name

The name of the configuration.

webhook_configurations[].iam_role_arn

The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.

webhook_configurations[].logging_level

Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs.Logging levels include ERROR, INFO, or NONE.

webhook_configurations[].sns_topic_arns[]
webhook_configurations[].tags[]
Show child fields
webhook_configurations[].tags[].tag_key

The tag key.

webhook_configurations[].tags[].tag_value

The tag value.

webhook_configurations[].webhook_description

Description of the webhook. Recommend using the convention `RoomName/WebhookName`. See Chime setup tutorial for more details: https://docs.aws.amazon.com/chatbot/latest/adminguide/chime-setup.html.