:doc:`OpenSearchService <../../opensearch>` / Paginator / ListApplications

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



.. py:class:: OpenSearchService.Paginator.ListApplications

  ::

    
    paginator = client.get_paginator('list_applications')

  
  

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

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

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/ListApplications>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          statuses=[
              'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type statuses: list
    :param statuses: 

      Filters the list of OpenSearch applications by status. Possible values: ``CREATING``, ``UPDATING``, ``DELETING``, ``FAILED``, ``ACTIVE``, and ``DELETED``.

      

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

      
      ::

        {
            'ApplicationSummaries': [
                {
                    'id': 'string',
                    'arn': 'string',
                    'name': 'string',
                    'endpoint': 'string',
                    'status': 'CREATING'|'UPDATING'|'DELETING'|'ACTIVE'|'FAILED',
                    'createdAt': datetime(2015, 1, 1),
                    'lastUpdatedAt': datetime(2015, 1, 1)
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **ApplicationSummaries** *(list) --* 

          Summarizes OpenSearch applications, including ID, ARN, name, endpoint, status, creation time, and last update time.

          
          

          - *(dict) --* 

            Basic details of an OpenSearch application.

            
            

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

              The unique identifier of an OpenSearch application.

              
            

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

              The Amazon Resource Name (ARN) of the domain. See `Identifiers for IAM Entities <https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html>`__ in *Using Amazon Web Services Identity and Access Management* for more information.

              
            

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

              The name of an OpenSearch application.

              
            

            - **endpoint** *(string) --* 

              The endpoint URL of an OpenSearch application.

              
            

            - **status** *(string) --* 

              The current status of an OpenSearch application. Possible values: ``CREATING``, ``UPDATING``, ``DELETING``, ``FAILED``, ``ACTIVE``, and ``DELETED``.

              
            

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

              The timestamp when an OpenSearch application was created.

              
            

            - **lastUpdatedAt** *(datetime) --* 

              The timestamp of the last update to an OpenSearch application.

              
        
      
        

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

          A token to resume pagination.

          
    