ChimeSDKMessaging / Client / describe_channel_membership_for_app_instance_user

describe_channel_membership_for_app_instance_user#

ChimeSDKMessaging.Client.describe_channel_membership_for_app_instance_user(**kwargs)#

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

Note

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.

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 or bot in a channel.

  • ChimeBearer (string) –

    [REQUIRED]

    The ARN of the AppInstanceUser or AppInstanceBot 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),
            'SubChannelId': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • ChannelMembership (dict) –

      The channel to which a user belongs.

      • ChannelSummary (dict) –

        Returns the channel data for an AppInstance.

        • 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 persistent message visible to the caller in a channel was sent.

      • AppInstanceUserMembershipSummary (dict) –

        Returns the channel membership data for an AppInstance.

        • Type (string) –

          The type of ChannelMembership.

        • ReadMarkerTimestamp (datetime) –

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

        • SubChannelId (string) –

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

Exceptions