Chime / Client / describe_channel_membership



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


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.


This API is is no longer supported and will not be updated. We recommend using the latest version, DescribeChannelMembership, 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.


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.describe_channel_membership(
  • ChannelArn (string) –


    The ARN of the channel.

  • MemberArn (string) –


    The ARN of the member.

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

Return type:



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)

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.


  • Chime.Client.exceptions.BadRequestException

  • Chime.Client.exceptions.ForbiddenException

  • Chime.Client.exceptions.NotFoundException

  • Chime.Client.exceptions.UnauthorizedClientException

  • Chime.Client.exceptions.ThrottledClientException

  • Chime.Client.exceptions.ServiceUnavailableException

  • Chime.Client.exceptions.ServiceFailureException