:doc:`SsmSap <../../ssm-sap>` / Paginator / ListApplications

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



.. py:class:: SsmSap.Paginator.ListApplications

  ::

    
    paginator = client.get_paginator('list_applications')

  
  

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

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

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ssm-sap-2018-05-10/ListApplications>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          Filters=[
              {
                  'Name': 'string',
                  'Value': 'string',
                  'Operator': 'Equals'|'GreaterThanOrEquals'|'LessThanOrEquals'
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type Filters: list
    :param Filters: 

      The filter of name, value, and operator.

      

    
      - *(dict) --* 

        A specific result obtained by specifying the name, value, and operator.

        

      
        - **Name** *(string) --* **[REQUIRED]** 

          The name of the filter. Filter names are case-sensitive.

          

        
        - **Value** *(string) --* **[REQUIRED]** 

          The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values

          

        
        - **Operator** *(string) --* **[REQUIRED]** 

          The operator for the filter.

          

        
      
  
    :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',
                    'DiscoveryStatus': 'SUCCESS'|'REGISTRATION_FAILED'|'REFRESH_FAILED'|'REGISTERING'|'DELETING',
                    'Type': 'HANA'|'SAP_ABAP',
                    'Arn': 'string',
                    'Tags': {
                        'string': 'string'
                    }
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Applications** *(list) --* 

          The applications registered with AWS Systems Manager for SAP.

          
          

          - *(dict) --* 

            The summary of the SAP application registered with AWS Systems Manager for SAP.

            
            

            - **Id** *(string) --* 

              The ID of the application.

              
            

            - **DiscoveryStatus** *(string) --* 

              The status of the latest discovery.

              
            

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

              The type of the application.

              
            

            - **Arn** *(string) --* 

              The Amazon Resource Name (ARN) of the application.

              
            

            - **Tags** *(dict) --* 

              The tags on the application.

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
        
      
    