KinesisAnalyticsV2 / Client / describe_snapshot

describe_snapshot

KinesisAnalyticsV2.Client.describe_snapshot(**kwargs)

Returns information about an enhanced snapshot. To see a list of the snapshots in your account, use ListSnapshots.

See also: AWS API Documentation

Request Syntax

response = client.describe_snapshot(
    SnapshotName='string'
)
Parameters:

SnapshotName (string) –

[REQUIRED]

The name of the enhanced snapshot. You can retrieve this value using ListSnapshots.

Return type:

dict

Returns:

Response Syntax

{
    'SnapshotInfoDetails': {
        'SnapshotName': 'string',
        'SnapshotArn': 'string',
        'SnapshotDescription': 'string',
        'SnapshotStatus': 'CREATING'|'READY'|'DELETING'|'FAILED',
        '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'|'FLINK-2_2'|'FLINK-2_3',
        'SnapshotSizeInBytes': 123,
        'SnapshotEncryptionConfigurationDescription': {
            'KeyId': 'string',
            'KeyType': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY'
        },
        'SnapshotInitiator': 'USER'|'SYSTEM',
        'SnapshotInitiatorOperation': 'CreateSnapshot'|'ImportSnapshot'|'SystemCreateSnapshot',
        'SnapshotSourceDescription': {
            'S3PrefixLocation': {
                'BucketARN': 'string',
                'KeyPrefix': 'string'
            },
            'SourceApplicationDescription': {
                'ApplicationName': 'string',
                'ApplicationCreationTimestamp': datetime(2015, 1, 1),
                'ApplicationVersionId': 123
            }
        },
        'SnapshotFormat': 'CANONICAL'
    }
}

Response Structure

  • (dict) –

    • SnapshotInfoDetails (dict) –

      An object containing information about the enhanced snapshot.

      • SnapshotName (string) –

        The name of the enhanced snapshot.

      • SnapshotArn (string) –

        The ARN of the enhanced snapshot.

      • SnapshotDescription (string) –

        The summary description of the snapshot.

      • SnapshotStatus (string) –

        The status of the enhanced snapshot.

      • SnapshotCreationTimestamp (datetime) –

        The timestamp that indicates when the snapshot was created.

      • RuntimeEnvironment (string) –

        The Flink runtime of the application that the snapshot was created from. This field is not present for imported snapshots.

      • SnapshotSizeInBytes (integer) –

        The size of the snapshot, in bytes. The value is 0 until the snapshot status is READY.

      • SnapshotEncryptionConfigurationDescription (dict) –

        Describes the encryption settings of data at rest for the snapshot.

        • KeyId (string) –

          The KMS key used for encryption. KeyId is used only when KeyType is CUSTOMER_MANAGED_KEY.

        • KeyType (string) –

          Specifies the type of key used for encryption.

      • SnapshotInitiator (string) –

        Indicates who initiated the snapshot. USER indicates a snapshot that you created or imported. SYSTEM indicates a snapshot that Managed Service for Apache Flink created.

      • SnapshotInitiatorOperation (string) –

        The operation that created the snapshot.

      • SnapshotSourceDescription (dict) –

        Describes the source of the snapshot.

        • S3PrefixLocation (dict) –

          The Amazon S3 location that the snapshot was imported from. This field is present only if SnapshotInitiatorOperation is ImportSnapshot.

          • BucketARN (string) –

            The ARN of the Amazon S3 bucket.

          • KeyPrefix (string) –

            The key prefix in the Amazon S3 bucket.

        • SourceApplicationDescription (dict) –

          Describes the application that the snapshot was created from. This field is not present for imported snapshots.

          • ApplicationName (string) –

            The name of the application.

          • ApplicationCreationTimestamp (datetime) –

            The timestamp that indicates when the source application was created.

          • ApplicationVersionId (integer) –

            The version ID of the source application when the snapshot was created.

      • SnapshotFormat (string) –

        The format of the snapshot.

Exceptions