KinesisAnalyticsV2 / Client / list_application_snapshots

list_application_snapshots#

KinesisAnalyticsV2.Client.list_application_snapshots(**kwargs)#

Lists information about the current application snapshots.

See also: AWS API Documentation

Request Syntax

response = client.list_application_snapshots(
    ApplicationName='string',
    Limit=123,
    NextToken='string'
)
Parameters:

  • ApplicationName (string) –

    [REQUIRED]

    The name of an existing application.

  • Limit (integer) – The maximum number of application snapshots to list.

  • NextToken (string) – Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call’s NextToken response to indicate where the output should continue from.

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

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.

    • NextToken (string) –

      The token for the next set of results, or null if there are no additional results.

Exceptions

  • KinesisAnalyticsV2.Client.exceptions.InvalidArgumentException

  • KinesisAnalyticsV2.Client.exceptions.UnsupportedOperationException