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

******************
list_app_instances
******************



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

  

  Lists all Amazon Chime ``AppInstance``s created under a single AWS account.

  

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


  **Request Syntax**
  ::

    response = client.list_app_instances(
        MaxResults=123,
        NextToken='string'
    )
    
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of ``AppInstance``s that you want to return.

    

  
  :type NextToken: string
  :param NextToken: 

    The token passed by previous API requests until you reach the maximum number of ``AppInstances``.

    

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

    
    ::

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

    

    - *(dict) --* 
      

      - **AppInstances** *(list) --* 

        The information for each ``AppInstance``.

        
        

        - *(dict) --* 

          Summary of the data for an ``AppInstance``.

          
          

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

            The ``AppInstance`` ARN.

            
          

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

            The name of the ``AppInstance``.

            
          

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

            The metadata of the ``AppInstance``.

            
      
    
      

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

        The token passed by previous API requests until the maximum number of ``AppInstance``s is reached.

        
  
  **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`

  