KinesisAnalyticsV2 / Client / list_applications

list_applications#

KinesisAnalyticsV2.Client.list_applications(**kwargs)#

Returns a list of Managed Service for Apache Flink applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status.

If you want detailed information about a specific application, use DescribeApplication.

Request Syntax

response = client.list_applications(
    Limit=123,
    NextToken='string'
)

Parameters:

Limit (integer) – The maximum number of applications to list.
NextToken (string) – If a previous command returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see Using the Amazon Command Line Interface’s Pagination Options.

Return type:

dict

Returns:

Response Syntax

{
    'ApplicationSummaries': [
        {
            'ApplicationName': 'string',
            'ApplicationARN': 'string',
            'ApplicationStatus': 'DELETING'|'STARTING'|'STOPPING'|'READY'|'RUNNING'|'UPDATING'|'AUTOSCALING'|'FORCE_STOPPING'|'ROLLING_BACK'|'MAINTENANCE'|'ROLLED_BACK',
            'ApplicationVersionId': 123,
            'RuntimeEnvironment': 'SQL-1_0'|'FLINK-1_6'|'FLINK-1_8'|'ZEPPELIN-FLINK-1_0'|'FLINK-1_11'|'FLINK-1_13'|'ZEPPELIN-FLINK-2_0'|'FLINK-1_15'|'ZEPPELIN-FLINK-3_0'|'FLINK-1_18'|'FLINK-1_19'|'FLINK-1_20',
            'ApplicationMode': 'STREAMING'|'INTERACTIVE'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- ApplicationSummaries (list) –
  
  A list of ApplicationSummary objects.
  - (dict) –
    
    Provides application summary information, including the application Amazon Resource Name (ARN), name, and status.
    - ApplicationName (string) –
      
      The name of the application.
    - ApplicationARN (string) –
      
      The ARN of the application.
    - ApplicationStatus (string) –
      
      The status of the application.
    - ApplicationVersionId (integer) –
      
      Provides the current application version.
    - RuntimeEnvironment (string) –
      
      The runtime environment for the application.
    - ApplicationMode (string) –
      
      For a Managed Service for Apache Flink application, the mode is STREAMING. For a Managed Service for Apache Flink Studio notebook, it is INTERACTIVE.
- NextToken (string) –
  
  The pagination token for the next set of results, or null if there are no additional results. Pass this token into a subsequent command to retrieve the next set of items For more information about pagination, see Using the Amazon Command Line Interface’s Pagination Options.

Exceptions

KinesisAnalyticsV2.Client.exceptions.InvalidRequestException