KinesisAnalyticsV2 / Client / describe_application_snapshot

describe_application_snapshot#

KinesisAnalyticsV2.Client.describe_application_snapshot(**kwargs)#

Returns information about a snapshot of application state data.

See also: AWS API Documentation

Request Syntax

response = client.describe_application_snapshot(
    ApplicationName='string',
    SnapshotName='string'
)
Parameters:

  • ApplicationName (string) –

    [REQUIRED]

    The name of an existing application.

  • SnapshotName (string) –

    [REQUIRED]

    The identifier of an application snapshot. You can retrieve this value using .

Return type:

dict

Returns:

Response Syntax

{
    'SnapshotDetails': {
        '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'
    }
}

Response Structure

  • (dict) –

    • SnapshotDetails (dict) –

      An object containing information about the application snapshot.

      • 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.

Exceptions