Skip to content
AWS for Query.Farm

aws.chime_sdk_messaging.list_channel_memberships_for_app_instance_user

Example SQL Queries

SELECT * FROM
aws.chime_sdk_messaging.list_channel_memberships_for_app_instance_user
WHERE
"chime_bearer" = 'VALUE';

Description

Lists all channels that an AppInstanceUser or AppInstanceBot is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own.

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
chime_bearer Required Input Column

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

VARCHAR
app_instance_user_arn Input Column

The ARN of the user or bot.

VARCHAR
max_results Input Column

The maximum number of users that you want returned.

BIGINT
next_token Input Column

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

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(
    "channel_summary" STRUCT(
        "name" VARCHAR,
        "channel_arn" VARCHAR,
        "mode" VARCHAR,
        "privacy" VARCHAR,
        "metadata" VARCHAR,
        "last_message_timestamp" TIMESTAMP_S
    ),
    "app_instance_user_membership_summary" STRUCT(
        "type" VARCHAR,
        "read_marker_timestamp" TIMESTAMP_S,
        "sub_channel_id" VARCHAR
    )
)[]
Show child fields
channel_memberships[]
Show child fields
channel_memberships[].app_instance_user_membership_summary

Returns the channel membership data for an AppInstance.

Show child fields
channel_memberships[].app_instance_user_membership_summary.read_marker_timestamp

The time at which an AppInstanceUser last marked a channel as read.

channel_memberships[].app_instance_user_membership_summary.sub_channel_id

The ID of the SubChannel that the AppInstanceUser is a member of.

channel_memberships[].app_instance_user_membership_summary.type

The type of ChannelMembership.

channel_memberships[].channel_summary

Returns the channel data for an AppInstance.

Show child fields
channel_memberships[].channel_summary.channel_arn

The ARN of the channel.

channel_memberships[].channel_summary.last_message_timestamp

The time at which the last persistent message visible to the caller in a channel was sent.

channel_memberships[].channel_summary.metadata

The metadata of the channel.

channel_memberships[].channel_summary.mode

The mode of the channel.

channel_memberships[].channel_summary.name

The name of the channel.

channel_memberships[].channel_summary.privacy

The privacy setting of the channel.