KinesisAnalyticsV2 / Paginator / ListApplications

ListApplications

class KinesisAnalyticsV2.Paginator.ListApplications

paginator = client.get_paginator('list_applications')

paginate(**kwargs)

Creates an iterator that will paginate through responses from KinesisAnalyticsV2.Client.list_applications().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

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.

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'
        },
    ],

}

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.