:doc:`KinesisAnalytics <../../kinesisanalytics>` / Client / list_applications

*****************
list_applications
*****************



.. py:method:: KinesisAnalytics.Client.list_applications(**kwargs)

  

  .. note::

    

    This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see `Amazon Kinesis Data Analytics API V2 Documentation </kinesisanalytics/latest/apiv2/Welcome.html>`__.

    

   

  Returns a list of Amazon Kinesis Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If the response returns the ``HasMoreApplications`` value as true, you can send another request by adding the ``ExclusiveStartApplicationName`` in the request body, and set the value of this to the last application name from the previous response.

   

  If you want detailed information about a specific application, use `DescribeApplication <https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html>`__.

   

  This operation requires permissions to perform the ``kinesisanalytics:ListApplications`` action.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/kinesisanalytics-2015-08-14/ListApplications>`_  


  **Request Syntax**
  ::

    response = client.list_applications(
        Limit=123,
        ExclusiveStartApplicationName='string'
    )
    
  :type Limit: integer
  :param Limit: 

    Maximum number of applications to list.

    

  
  :type ExclusiveStartApplicationName: string
  :param ExclusiveStartApplicationName: 

    Name of the application to start the list with. When using pagination to retrieve the list, you don't need to specify this parameter in the first request. However, in subsequent requests, you add the last application name from the previous response to get the next page of applications.

    

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

    
    ::

      {
          'ApplicationSummaries': [
              {
                  'ApplicationName': 'string',
                  'ApplicationARN': 'string',
                  'ApplicationStatus': 'DELETING'|'STARTING'|'STOPPING'|'READY'|'RUNNING'|'UPDATING'
              },
          ],
          'HasMoreApplications': True|False
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        List of ``ApplicationSummary`` objects.

        
        

        - *(dict) --* 

          .. note::

            

            This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see `Amazon Kinesis Data Analytics API V2 Documentation </kinesisanalytics/latest/apiv2/Welcome.html>`__.

            

           

          Provides application summary information, including the application Amazon Resource Name (ARN), name, and status.

          
          

          - **ApplicationName** *(string) --* 

            Name of the application.

            
          

          - **ApplicationARN** *(string) --* 

            ARN of the application.

            
          

          - **ApplicationStatus** *(string) --* 

            Status of the application.

            
      
    
      

      - **HasMoreApplications** *(boolean) --* 

        Returns true if there are more applications to retrieve.

        
  