KinesisAnalyticsV2 / Paginator / ListApplicationSnapshots

ListApplicationSnapshots

class KinesisAnalyticsV2.Paginator.ListApplicationSnapshots

paginator = client.get_paginator('list_application_snapshots')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• ApplicationName (string) –

  [REQUIRED]

  The name of an existing application.

• 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

{
    'SnapshotSummaries': [
        {
            'SnapshotName': 'string',
            'SnapshotStatus': 'CREATING'|'READY'|'DELETING'|'FAILED',
            'ApplicationVersionId': 123,
            'SnapshotCreationTimestamp': datetime(2015, 1, 1),
            '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',
            'ApplicationEncryptionConfigurationDescription': {
                'KeyId': 'string',
                'KeyType': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY'
            }
        },
    ],

}

Response Structure

• (dict) –

  • SnapshotSummaries (list) –

    A collection of objects containing information about the application snapshots.

    • (dict) –

      Provides details about a snapshot of application state.

      • SnapshotName (string) –

        The identifier for the application snapshot.

      • SnapshotStatus (string) –

        The status of the application snapshot.

      • ApplicationVersionId (integer) –

        The current application version ID when the snapshot was created.

      • SnapshotCreationTimestamp (datetime) –

        The timestamp of the application snapshot.

      • RuntimeEnvironment (string) –

        The Flink Runtime for the application snapshot.

      • ApplicationEncryptionConfigurationDescription (dict) –

        Specifies the encryption settings of data at rest for the application snapshot.

        • KeyId (string) –

          The key ARN, key ID, alias ARN, or alias name of the KMS key used for encryption at rest.

        • KeyType (string) –

          Specifies the type of key used for encryption at rest.