describe_channel_membership_for_app_instance_user

Chime.Client.describe_channel_membership_for_app_instance_user(**kwargs)

Returns the details of a channel based on the membership of the specified AppInstanceUser .

Note

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_channel_membership_for_app_instance_user(
    ChannelArn='string',
    AppInstanceUserArn='string',
    ChimeBearer='string'
)

Parameters

• ChannelArn (string) --

  [REQUIRED]

  The ARN of the channel to which the user belongs.

• AppInstanceUserArn (string) --

  [REQUIRED]

  The ARN of the user in a channel.

• ChimeBearer (string) -- The AppInstanceUserArn of the user that makes the API call.

Return type

dict

Returns

Response Syntax

{
    'ChannelMembership': {
        'ChannelSummary': {
            'Name': 'string',
            'ChannelArn': 'string',
            'Mode': 'UNRESTRICTED'|'RESTRICTED',
            'Privacy': 'PUBLIC'|'PRIVATE',
            'Metadata': 'string',
            'LastMessageTimestamp': datetime(2015, 1, 1)
        },
        'AppInstanceUserMembershipSummary': {
            'Type': 'DEFAULT'|'HIDDEN',
            'ReadMarkerTimestamp': datetime(2015, 1, 1)
        }
    }
}

Response Structure

• (dict) --

  • ChannelMembership (dict) --

    The channel to which a user belongs.

    • ChannelSummary (dict) --

      Summary of the details of a Channel .

      • Name (string) --

        The name of the channel.

      • ChannelArn (string) --

        The ARN of the channel.

      • Mode (string) --

        The mode of the channel.

      • Privacy (string) --

        The privacy setting of the channel.

      • Metadata (string) --

        The metadata of the channel.

      • LastMessageTimestamp (datetime) --

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

    • AppInstanceUserMembershipSummary (dict) --

      Summary of the membership details of an AppInstanceUser .

      • Type (string) --

        The type of ChannelMembership .

      • ReadMarkerTimestamp (datetime) --

        The time at which a message was last read.

Exceptions

• Chime.Client.exceptions.BadRequestException
• Chime.Client.exceptions.ForbiddenException
• Chime.Client.exceptions.UnauthorizedClientException
• Chime.Client.exceptions.ThrottledClientException
• Chime.Client.exceptions.ServiceUnavailableException
• Chime.Client.exceptions.ServiceFailureException