Skip to content
AWS for Query.Farm

aws.chime_sdk_messaging.describe_channel

Example SQL Queries

SELECT * FROM
aws.chime_sdk_messaging.describe_channel
WHERE
"channel_arn" = 'VALUE'
AND "chime_bearer" = 'VALUE';

Description

Returns the full details of a channel in an Amazon Chime AppInstance.

The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call as the value in the header.

Table Definition

Column NameColumn Data Type
channel_arn Required Input Column

The ARN of the channel.

VARCHAR
chime_bearer Required Input Column

The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.

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.

channel

The channel details.

STRUCT(
    "name" VARCHAR,
    "channel_arn" VARCHAR,
    "mode" VARCHAR,
    "privacy" VARCHAR,
    "metadata" VARCHAR,
    "created_by" STRUCT(
        "arn" VARCHAR,
        "name" VARCHAR
    ),
    "created_timestamp" TIMESTAMP_S,
    "last_message_timestamp" TIMESTAMP_S,
    "last_updated_timestamp" TIMESTAMP_S,
    "channel_flow_arn" VARCHAR,
    "elastic_channel_configuration" STRUCT(
        "maximum_sub_channels" BIGINT,
        "target_memberships_per_sub_channel" BIGINT,
        "minimum_membership_percentage" BIGINT
    ),
    "expiration_settings" STRUCT(
        "expiration_days" BIGINT,
        "expiration_criterion" VARCHAR
    )
)
Show child fields
channel.channel_arn

The ARN of a channel.

channel.channel_flow_arn

The ARN of the channel flow.

channel.created_by

The AppInstanceUser who created the channel.

Show child fields
channel.created_by.arn

The ARN in an Identity.

channel.created_by.name

The name in an Identity.

channel.created_timestamp

The time at which the AppInstanceUser created the channel.

channel.elastic_channel_configuration

The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.

Show child fields
channel.elastic_channel_configuration.maximum_sub_channels

The maximum number of SubChannels that you want to allow in the elastic channel.

channel.elastic_channel_configuration.minimum_membership_percentage

The minimum allowed percentage of TargetMembershipsPerSubChannel users. Ceil of the calculated value is used in balancing members among SubChannels of the elastic channel.

channel.elastic_channel_configuration.target_memberships_per_sub_channel

The maximum number of members allowed in a SubChannel.

channel.expiration_settings

Settings that control when a channel expires.

Show child fields
channel.expiration_settings.expiration_criterion

The conditions that must be met for a channel to expire.

channel.expiration_settings.expiration_days

The period in days after which the system automatically deletes a channel.

channel.last_message_timestamp

The time at which a member sent the last message in the channel.

channel.last_updated_timestamp

The time at which a channel was last updated.

channel.metadata

The channel's metadata.

channel.mode

The mode of the channel.

channel.name

The name of a channel.

channel.privacy

The channel's privacy setting.