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

********************************
list_app_instance_user_endpoints
********************************



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

  

  Lists all the ``AppInstanceUserEndpoints`` created under a single ``AppInstanceUser``.

  

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


  **Request Syntax**
  ::

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

    The ARN of the ``AppInstanceUser``.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of endpoints that you want to return.

    

  
  :type NextToken: string
  :param NextToken: 

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

    

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

    
    ::

      {
          'AppInstanceUserEndpoints': [
              {
                  'AppInstanceUserArn': 'string',
                  'EndpointId': 'string',
                  'Name': 'string',
                  'Type': 'APNS'|'APNS_SANDBOX'|'GCM',
                  'AllowMessages': 'ALL'|'NONE',
                  'EndpointState': {
                      'Status': 'ACTIVE'|'INACTIVE',
                      'StatusReason': 'INVALID_DEVICE_TOKEN'|'INVALID_PINPOINT_ARN'
                  }
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **AppInstanceUserEndpoints** *(list) --* 

        The information for each requested ``AppInstanceUserEndpoint``.

        
        

        - *(dict) --* 

          Summary of the details of an ``AppInstanceUserEndpoint``.

          
          

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

            The ARN of the ``AppInstanceUser``.

            
          

          - **EndpointId** *(string) --* 

            The unique identifier of the ``AppInstanceUserEndpoint``.

            
          

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

            The name of the ``AppInstanceUserEndpoint``.

            
          

          - **Type** *(string) --* 

            The type of the ``AppInstanceUserEndpoint``.

            
          

          - **AllowMessages** *(string) --* 

            BBoolean that controls whether the ``AppInstanceUserEndpoint`` is opted in to receive messages. ``ALL`` indicates the endpoint will receive all messages. ``NONE`` indicates the endpoint will receive no messages.

            
          

          - **EndpointState** *(dict) --* 

            A read-only field that represent the state of an ``AppInstanceUserEndpoint``.

            
            

            - **Status** *(string) --* 

              Enum that indicates the Status of an ``AppInstanceUserEndpoint``.

              
            

            - **StatusReason** *(string) --* 

              The reason for the ``EndpointStatus``.

              
        
      
    
      

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

        The token passed by previous API calls until all requested endpoints 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`

  