KinesisAnalyticsV2 / Client / describe_snapshot_operation

describe_snapshot_operation

KinesisAnalyticsV2.Client.describe_snapshot_operation(**kwargs)

Provides a detailed description of a specified operation that was performed on an enhanced snapshot. To see a list of the operations of a snapshot, use ListSnapshotOperations.

Snapshot operations are available for 90 days after they are created.

See also: AWS API Documentation

Request Syntax

response = client.describe_snapshot_operation(
    SnapshotName='string',
    SnapshotOperationId='string'
)
Parameters:

  • SnapshotName (string) –

    [REQUIRED]

    The name of the enhanced snapshot.

  • SnapshotOperationId (string) –

    [REQUIRED]

    The ID of the snapshot operation. You can retrieve this value using ListSnapshotOperations.

Return type:

dict

Returns:

Response Syntax

{
    'SnapshotOperationInfoDetails': {
        'SnapshotOperationId': 'string',
        'SnapshotOperation': 'CreateSnapshot'|'DeleteSnapshot'|'ImportSnapshot'|'ExportSnapshot'|'SystemCreateSnapshot',
        'SnapshotOperationStatus': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'CANCELLED',
        'SnapshotArn': 'string',
        'SourceEncryptionConfigurationDescription': {
            'KeyId': 'string',
            'KeyType': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY'
        },
        'DestinationEncryptionConfigurationDescription': {
            'KeyId': 'string',
            'KeyType': 'AWS_OWNED_KEY'|'CUSTOMER_MANAGED_KEY'
        },
        'SnapshotSourceLocationDescription': {
            'LocationType': 'S3',
            'S3PrefixLocation': {
                'BucketARN': 'string',
                'KeyPrefix': 'string',
                'ExportedPrefix': 'string'
            }
        },
        'SnapshotDestinationLocationDescription': {
            'LocationType': 'S3',
            'S3PrefixLocation': {
                'BucketARN': 'string',
                'KeyPrefix': 'string',
                'ExportedPrefix': 'string'
            }
        },
        'ApplicationOperationDescription': {
            'ApplicationOperationId': 'string',
            'ApplicationName': 'string'
        },
        'StartTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1),
        'SnapshotOperationFailureDetails': {
            'ErrorInfo': {
                'ErrorCode': 'string',
                'ErrorString': 'string'
            }
        }
    }
}

Response Structure

  • (dict) –

    • SnapshotOperationInfoDetails (dict) –

      An object containing information about the snapshot operation.

      • SnapshotOperationId (string) –

        The ID of the snapshot operation.

      • SnapshotOperation (string) –

        The type of operation that was performed on the snapshot.

      • SnapshotOperationStatus (string) –

        The status of the snapshot operation.

      • SnapshotArn (string) –

        The ARN of the enhanced snapshot.

      • SourceEncryptionConfigurationDescription (dict) –

        Describes the encryption configuration of the source data. This field is present only for ImportSnapshot operation.

        • KeyId (string) –

          The KMS key used for encryption.

        • KeyType (string) –

          Specifies the type of key used for encryption.

      • DestinationEncryptionConfigurationDescription (dict) –

        Describes the encryption configuration of the destination data. This field is present only for ImportSnapshot and ExportSnapshot operations.

        • KeyId (string) –

          The KMS key used for encryption.

        • KeyType (string) –

          Specifies the type of key used for encryption.

      • SnapshotSourceLocationDescription (dict) –

        Describes the location that the snapshot data was read from. This field is present only for ImportSnapshot operations.

        • LocationType (string) –

          The type of the location. The only supported value is S3.

        • S3PrefixLocation (dict) –

          Describes the Amazon S3 bucket and key prefix of the location.

          • BucketARN (string) –

            The ARN of the Amazon S3 bucket.

          • KeyPrefix (string) –

            The key prefix in the Amazon S3 bucket that you specified in the request.

          • ExportedPrefix (string) –

            The full key prefix that the exported snapshot data was written to. This value includes the unique prefix that Managed Service for Apache Flink appends to KeyPrefix. This field is present only after an ExportSnapshot operation completes successfully.

      • SnapshotDestinationLocationDescription (dict) –

        Describes the location that the snapshot data was written to. This field is present only for ExportSnapshot operations, after the operation completes.

        • LocationType (string) –

          The type of the location. The only supported value is S3.

        • S3PrefixLocation (dict) –

          Describes the Amazon S3 bucket and key prefix of the location.

          • BucketARN (string) –

            The ARN of the Amazon S3 bucket.

          • KeyPrefix (string) –

            The key prefix in the Amazon S3 bucket that you specified in the request.

          • ExportedPrefix (string) –

            The full key prefix that the exported snapshot data was written to. This value includes the unique prefix that Managed Service for Apache Flink appends to KeyPrefix. This field is present only after an ExportSnapshot operation completes successfully.

      • ApplicationOperationDescription (dict) –

        Describes the application operation that initiated the snapshot operation. This field is present only for SystemCreateSnapshot operations.

        • ApplicationOperationId (string) –

          The operation ID of the request.

        • ApplicationName (string) –

          The name of the application.

      • StartTime (datetime) –

        The timestamp that indicates when the operation was created.

      • EndTime (datetime) –

        The timestamp that indicates when the operation finished. This field is present only after the operation completes.

      • SnapshotOperationFailureDetails (dict) –

        Provides a description of the operation failure. This field is present only if SnapshotOperationStatus is FAILED.

        • ErrorInfo (dict) –

          A description of the error that caused the snapshot operation to fail.

          • ErrorCode (string) –

            The error code that identifies the cause of the failure.

          • ErrorString (string) –

            An error message that is returned when an operation fails.

Exceptions