Skip to content
AWS for Query.Farm

aws.chime.describe_channel_ban

Example SQL Queries

SELECT * FROM
aws.chime.describe_channel_ban
WHERE
"channel_arn" = 'VALUE'
AND "member_arn" = 'VALUE';

Description

Returns the full details of a channel ban.

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelBan, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Table Definition

Column NameColumn Data Type
channel_arn Required Input Column

The ARN of the channel from which the user is banned.

VARCHAR
member_arn Required Input Column

The ARN of the member being banned.

VARCHAR
chime_bearer Input Column

The AppInstanceUserArn of the user 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_ban

The details of the ban.

STRUCT(
    "member" STRUCT(
        "arn" VARCHAR,
        "name" VARCHAR
    ),
    "channel_arn" VARCHAR,
    "created_timestamp" TIMESTAMP_S,
    "created_by" STRUCT(
        "arn" VARCHAR,
        "name" VARCHAR
    )
)
Show child fields
channel_ban.channel_arn

The ARN of the channel from which a member is being banned.

channel_ban.created_by

The AppInstanceUser who created the ban.

Show child fields
channel_ban.created_by.arn

The ARN in an Identity.

channel_ban.created_by.name

The name in an Identity.

channel_ban.created_timestamp

The time at which the ban was created.

channel_ban.member

The member being banned from the channel.

Show child fields
channel_ban.member.arn

The ARN in an Identity.

channel_ban.member.name

The name in an Identity.