:doc:`ChimeSDKIdentity <../../chime-sdk-identity>` / Client / list_app_instance_users

***********************
list_app_instance_users
***********************



.. py:method:: ChimeSDKIdentity.Client.list_app_instance_users(**kwargs)

  

  List all ``AppInstanceUsers`` created under a single ``AppInstance``.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-identity-2021-04-20/ListAppInstanceUsers>`_  


  **Request Syntax**
  ::

    response = client.list_app_instance_users(
        AppInstanceArn='string',
        MaxResults=123,
        NextToken='string'
    )
    
  :type AppInstanceArn: string
  :param AppInstanceArn: **[REQUIRED]** 

    The ARN of the ``AppInstance``.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of requests that you want returned.

    

  
  :type NextToken: string
  :param NextToken: 

    The token passed by previous API calls until all requested users are returned.

    

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

    
    ::

      {
          'AppInstanceArn': 'string',
          'AppInstanceUsers': [
              {
                  'AppInstanceUserArn': 'string',
                  'Name': 'string',
                  'Metadata': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **AppInstanceArn** *(string) --* 

        The ARN of the ``AppInstance``.

        
      

      - **AppInstanceUsers** *(list) --* 

        The information for each requested ``AppInstanceUser``.

        
        

        - *(dict) --* 

          Summary of the details of an ``AppInstanceUser``.

          
          

          - **AppInstanceUserArn** *(string) --* 

            The ARN of the ``AppInstanceUser``.

            
          

          - **Name** *(string) --* 

            The name of an ``AppInstanceUser``.

            
          

          - **Metadata** *(string) --* 

            The metadata of the ``AppInstanceUser``.

            
      
    
      

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

        The token passed by previous API calls until all requested users are returned.

        
  
  **Exceptions**
  
  *   :py:class:`ChimeSDKIdentity.Client.exceptions.BadRequestException`

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

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

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

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

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

  