describe_channel_membership

describe_channel_membership(**kwargs)

Returns the full details of a user's channel membership.

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(
    ChannelArn='string',
    MemberArn='string',
    ChimeBearer='string',
    SubChannelId='string'
)

Parameters

• ChannelArn (string) --

  [REQUIRED]

  The ARN of the channel.

• MemberArn (string) --

  [REQUIRED]

  The AppInstanceUserArn of the member.

• ChimeBearer (string) --

  [REQUIRED]

  The AppInstanceUserArn of the user that makes the API call.

• SubChannelId (string) --

  The ID of the SubChannel in the request. The response contains an ElasticChannelConfiguration object.

  Note

  Only required to get a user’s SubChannel membership details.

Return type

dict

Returns

Response Syntax

{
    'ChannelMembership': {
        'InvitedBy': {
            'Arn': 'string',
            'Name': 'string'
        },
        'Type': 'DEFAULT'|'HIDDEN',
        'Member': {
            'Arn': 'string',
            'Name': 'string'
        },
        'ChannelArn': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'LastUpdatedTimestamp': datetime(2015, 1, 1),
        'SubChannelId': 'string'
    }
}

Response Structure

• (dict) --

  • ChannelMembership (dict) --

    The details of the membership.

    • InvitedBy (dict) --

      The identifier of the member who invited another member.

      • Arn (string) --

        The ARN in an Identity.

      • Name (string) --

        The name in an Identity.

    • Type (string) --

      The membership type set for the channel member.

    • Member (dict) --

      The data of the channel member.

      • Arn (string) --

        The ARN in an Identity.

      • Name (string) --

        The name in an Identity.

    • ChannelArn (string) --

      The ARN of the member's channel.

    • CreatedTimestamp (datetime) --

      The time at which the channel membership was created.

    • LastUpdatedTimestamp (datetime) --

      The time at which a channel membership was last updated.

    • SubChannelId (string) --

      The ID of the SubChannel that a user belongs to.

Exceptions

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