Skip to content
AWS for Query.Farm

aws.chime_sdk_messaging.list_channel_memberships

Example SQL Queries

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

Description

Lists all channel memberships in a channel.

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.

If you want to list the channels to which a specific app instance user belongs, see the ListChannelMembershipsForAppInstanceUser API.

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
max_results Input Column

The maximum number of channel memberships that you want returned.

BIGINT
next_token Input Column

The token passed by previous API calls until all requested channel memberships are returned.

VARCHAR
sub_channel_id Input Column

The ID of the SubChannel in the request.

Only required when listing a user's memberships in a particular sub-channel of an elastic channel.

VARCHAR
type Input Column

The membership type of a user, DEFAULT or HIDDEN. Default members are returned as part of ListChannelMemberships if no type is specified. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN.

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_memberships

The information for the requested channel memberships.

STRUCT(
    "member" STRUCT(
        "arn" VARCHAR,
        "name" VARCHAR
    )
)[]
Show child fields
channel_memberships[]
Show child fields
channel_memberships[].member

A member's summary data.

Show child fields
channel_memberships[].member.arn

The ARN in an Identity.

channel_memberships[].member.name

The name in an Identity.