list_channel_memberships_for_app_instance_user

ChimeSDKMessaging.Client.list_channel_memberships_for_app_instance_user(**kwargs)

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

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.list_channel_memberships_for_app_instance_user(
    AppInstanceUserArn='string',
    MaxResults=123,
    NextToken='string',
    ChimeBearer='string'
)

Parameters

• AppInstanceUserArn (string) -- The ARN of the AppInstanceUser s
• MaxResults (integer) -- The maximum number of users that you want returned.
• NextToken (string) -- The token returned from previous API requests until the number of channel memberships is reached.
• ChimeBearer (string) --

  [REQUIRED]

  The AppInstanceUserArn of the user that makes the API call.

Return type

dict

Returns

Response Syntax

{
    'ChannelMemberships': [
        {
            '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'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • ChannelMemberships (list) --

    The information for the requested channel memberships.

    • (dict) --

      Summary of the channel membership details of an AppInstanceUser .

      • 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 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.

  • NextToken (string) --

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

Exceptions

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