:doc:`ChimeSDKMessaging <../../chime-sdk-messaging>` / Client / describe_channel_membership_for_app_instance_user

*************************************************
describe_channel_membership_for_app_instance_user
*************************************************



.. py:method:: 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 <https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelMembershipForAppInstanceUser>`_  


  **Request Syntax**
  ::

    response = client.describe_channel_membership_for_app_instance_user(
        ChannelArn='string',
        AppInstanceUserArn='string',
        ChimeBearer='string'
    )
    
  :type ChannelArn: string
  :param ChannelArn: **[REQUIRED]** 

    The ARN of the channel to which the user belongs.

    

  
  :type AppInstanceUserArn: string
  :param AppInstanceUserArn: **[REQUIRED]** 

    The ARN of the user or bot in a channel.

    

  
  :type ChimeBearer: string
  :param ChimeBearer: **[REQUIRED]** 

    The ARN of the ``AppInstanceUser`` or ``AppInstanceBot`` that makes the API call.

    

  
  
  :rtype: 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**
  
  *   :py:class:`ChimeSDKMessaging.Client.exceptions.BadRequestException`

  
  *   :py:class:`ChimeSDKMessaging.Client.exceptions.ForbiddenException`

  
  *   :py:class:`ChimeSDKMessaging.Client.exceptions.UnauthorizedClientException`

  
  *   :py:class:`ChimeSDKMessaging.Client.exceptions.ThrottledClientException`

  
  *   :py:class:`ChimeSDKMessaging.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`ChimeSDKMessaging.Client.exceptions.ServiceFailureException`

  