:doc:`Chime <../../chime>` / Client / list_room_memberships

*********************
list_room_memberships
*********************



.. py:method:: Chime.Client.list_room_memberships(**kwargs)

  

  Lists the membership details for the specified room in an Amazon Chime Enterprise account, such as the members' IDs, email addresses, and names.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListRoomMemberships>`_  


  **Request Syntax**
  ::

    response = client.list_room_memberships(
        AccountId='string',
        RoomId='string',
        MaxResults=123,
        NextToken='string'
    )
    
  :type AccountId: string
  :param AccountId: **[REQUIRED]** 

    The Amazon Chime account ID.

    

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

    The room ID.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return in a single call.

    

  
  :type NextToken: string
  :param NextToken: 

    The token to use to retrieve the next page of results.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'RoomMemberships': [
              {
                  'RoomId': 'string',
                  'Member': {
                      'MemberId': 'string',
                      'MemberType': 'User'|'Bot'|'Webhook',
                      'Email': 'string',
                      'FullName': 'string',
                      'AccountId': 'string'
                  },
                  'Role': 'Administrator'|'Member',
                  'InvitedBy': 'string',
                  'UpdatedTimestamp': datetime(2015, 1, 1)
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **RoomMemberships** *(list) --* 

        The room membership details.

        
        

        - *(dict) --* 

          The room membership details.

          
          

          - **RoomId** *(string) --* 

            The room ID.

            
          

          - **Member** *(dict) --* 

            The member details, such as email address, name, member ID, and member type.

            
            

            - **MemberId** *(string) --* 

              The member ID (user ID or bot ID).

              
            

            - **MemberType** *(string) --* 

              The member type.

              
            

            - **Email** *(string) --* 

              The member email address.

              
            

            - **FullName** *(string) --* 

              The member name.

              
            

            - **AccountId** *(string) --* 

              The Amazon Chime account ID.

              
        
          

          - **Role** *(string) --* 

            The membership role.

            
          

          - **InvitedBy** *(string) --* 

            The identifier of the user that invited the room member.

            
          

          - **UpdatedTimestamp** *(datetime) --* 

            The room membership update timestamp, in ISO 8601 format.

            
      
    
      

      - **NextToken** *(string) --* 

        The token to use to retrieve the next page of results.

        
  
  **Exceptions**
  
  *   :py:class:`Chime.Client.exceptions.NotFoundException`

  
  *   :py:class:`Chime.Client.exceptions.BadRequestException`

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

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

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

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

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

  