:doc:`EMRServerless <../../emr-serverless>` / Paginator / ListApplications

****************
ListApplications
****************



.. py:class:: EMRServerless.Paginator.ListApplications

  ::

    
    paginator = client.get_paginator('list_applications')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`EMRServerless.Client.list_applications`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/emr-serverless-2021-07-13/ListApplications>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          states=[
              'CREATING'|'CREATED'|'STARTING'|'STARTED'|'STOPPING'|'STOPPED'|'TERMINATED',
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type states: list
    :param states: 

      An optional filter for application states. Note that if this filter contains multiple states, the resulting list will be grouped by the state.

      

    
      - *(string) --* 

      
  
    :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.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

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

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

        

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

      
      ::

        {
            'applications': [
                {
                    'id': 'string',
                    'name': 'string',
                    'arn': 'string',
                    'releaseLabel': 'string',
                    'type': 'string',
                    'state': 'CREATING'|'CREATED'|'STARTING'|'STARTED'|'STOPPING'|'STOPPED'|'TERMINATED',
                    'stateDetails': 'string',
                    'createdAt': datetime(2015, 1, 1),
                    'updatedAt': datetime(2015, 1, 1),
                    'architecture': 'ARM64'|'X86_64'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **applications** *(list) --* 

          The output lists the specified applications.

          
          

          - *(dict) --* 

            The summary of attributes associated with an application.

            
            

            - **id** *(string) --* 

              The ID of the application.

              
            

            - **name** *(string) --* 

              The name of the application.

              
            

            - **arn** *(string) --* 

              The ARN of the application.

              
            

            - **releaseLabel** *(string) --* 

              The Amazon EMR release associated with the application.

              
            

            - **type** *(string) --* 

              The type of application, such as Spark or Hive.

              
            

            - **state** *(string) --* 

              The state of the application.

              
            

            - **stateDetails** *(string) --* 

              The state details of the application.

              
            

            - **createdAt** *(datetime) --* 

              The date and time when the application was created.

              
            

            - **updatedAt** *(datetime) --* 

              The date and time when the application was last updated.

              
            

            - **architecture** *(string) --* 

              The CPU architecture of an application.

              
        
      
        

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

          A token to resume pagination.

          
    