Chime / Client / list_channel_memberships_for_app_instance_user
list_channel_memberships_for_app_instance_user#
- Chime.Client.list_channel_memberships_for_app_instance_user(**kwargs)#
Lists all channels that a particular
AppInstanceUser
is a part of. Only anAppInstanceAdmin
can call the API with a user ARN that is not their own.Note
The
x-amz-chime-bearer
request header is mandatory. Use theAppInstanceUserArn
of the user that makes the API call as the value in the header.Warning
This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelMembershipsForAppInstanceUser, in the Amazon Chime SDK.
Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
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) – 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) } }, ], '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) –
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.
NextToken (string) –
The token passed by previous API calls until all requested users are returned.
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