:doc:`SNS <../../sns>` / Paginator / ListEndpointsByPlatformApplication

**********************************
ListEndpointsByPlatformApplication
**********************************



.. py:class:: SNS.Paginator.ListEndpointsByPlatformApplication

  ::

    
    paginator = client.get_paginator('list_endpoints_by_platform_application')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`SNS.Client.list_endpoints_by_platform_application`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PlatformApplicationArn='string',
          PaginationConfig={
              'MaxItems': 123,
              'StartingToken': 'string'
          }
      )
      
    :type PlatformApplicationArn: string
    :param PlatformApplicationArn: **[REQUIRED]** 

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

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

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

      
      ::

        {
            'Endpoints': [
                {
                    'EndpointArn': 'string',
                    'Attributes': {
                        'string': '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) --* 
          
        
        
      
    