Skip to content
AWS for Query.Farm

aws.chime_sdk_messaging.get_channel_membership_preferences

Example SQL Queries

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

Description

Gets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified channel. A user or a bot must be a member of the channel and own the membership in order to retrieve membership preferences. Users or bots in the AppInstanceAdmin and channel moderator roles can't retrieve preferences for other users or bots. Banned users or bots can't retrieve membership preferences for the channel from which they are banned.

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

The AppInstanceUserArn of the member retrieving the preferences.

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.

member

The details of a user.

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

The ARN in an Identity.

member.name

The name in an Identity.

preferences

The channel membership preferences for an AppInstanceUser .

STRUCT(
    "push_notifications" STRUCT(
        "allow_notifications" VARCHAR,
        "filter_rule" VARCHAR
    )
)
Show child fields
preferences.push_notifications

The push notification configuration of a message.

Show child fields
preferences.push_notifications.allow_notifications

Enum value that indicates which push notifications to send to the requested member of a channel. ALL sends all push notifications, NONE sends no push notifications, FILTERED sends only filtered push notifications.

preferences.push_notifications.filter_rule

The simple JSON object used to send a subset of a push notification to the requested member.