:doc:`SNS <../../sns>` / Client / list_endpoints_by_platform_application

**************************************
list_endpoints_by_platform_application
**************************************



.. py:method:: SNS.Client.list_endpoints_by_platform_application(**kwargs)

  

  Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM (Firebase Cloud Messaging) and APNS. The results for ``ListEndpointsByPlatformApplication`` are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ``ListEndpointsByPlatformApplication`` again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see `Using Amazon SNS Mobile Push Notifications <https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html>`__.

   

  This action is throttled at 30 transactions per second (TPS).

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31/ListEndpointsByPlatformApplication>`_  


  **Request Syntax**
  ::

    response = client.list_endpoints_by_platform_application(
        PlatformApplicationArn='string',
        NextToken='string'
    )
    
  :type PlatformApplicationArn: string
  :param PlatformApplicationArn: **[REQUIRED]** 

    ``PlatformApplicationArn`` for ``ListEndpointsByPlatformApplicationInput`` action.

    

  
  :type NextToken: string
  :param NextToken: 

    ``NextToken`` string is used when calling ``ListEndpointsByPlatformApplication`` action to retrieve additional records that are available after the first page results.

    

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

    
    ::

      {
          'Endpoints': [
              {
                  'EndpointArn': 'string',
                  'Attributes': {
                      'string': 'string'
                  }
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Response for ``ListEndpointsByPlatformApplication`` action.

      
      

      - **Endpoints** *(list) --* 

        Endpoints returned for ``ListEndpointsByPlatformApplication`` action.

        
        

        - *(dict) --* 

          The endpoint for mobile app and device.

          
          

          - **EndpointArn** *(string) --* 

            The ``EndpointArn`` for mobile app and device.

            
          

          - **Attributes** *(dict) --* 

            Attributes for endpoint.

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
      
    
      

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

        ``NextToken`` string is returned when calling ``ListEndpointsByPlatformApplication`` action if additional records are available after the first page results.

        
  
  **Exceptions**
  
  *   :py:class:`SNS.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`SNS.Client.exceptions.InternalErrorException`

  
  *   :py:class:`SNS.Client.exceptions.AuthorizationErrorException`

  
  *   :py:class:`SNS.Client.exceptions.NotFoundException`

  