KinesisAnalyticsV2 / Client / delete_snapshot

delete_snapshot

KinesisAnalyticsV2.Client.delete_snapshot(**kwargs)

Deletes an enhanced snapshot. Snapshots are not scoped to an application, so you can delete a snapshot independently of the application that it was created from.

This operation is asynchronous. The response returns the snapshot ARN with the DELETING status. To track the progress of the operation, use DescribeSnapshotOperation.

You can delete a snapshot in the READY or FAILED status. If a snapshot operation, such as an export, uses the snapshot, Managed Service for Apache Flink waits for that operation to finish before it deletes the snapshot. For a snapshot in any other status, ResourceInUseException is returned.

See also: AWS API Documentation

Request Syntax

response = client.delete_snapshot(
    SnapshotName='string',
    SnapshotCreationTimestamp=datetime(2015, 1, 1)
)
Parameters:

  • SnapshotName (string) –

    [REQUIRED]

    The name of the enhanced snapshot to delete.

  • SnapshotCreationTimestamp (datetime) –

    [REQUIRED]

    The creation timestamp of the enhanced snapshot to delete. Use the DescribeSnapshot operation to get this value.

Return type:

dict

Returns:

Response Syntax

{
    'SnapshotArn': 'string',
    'SnapshotStatus': 'CREATING'|'READY'|'DELETING'|'FAILED',
    'SnapshotOperationId': 'string',
    'SnapshotOperationStatus': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'CANCELLED'
}

Response Structure

  • (dict) –

    • SnapshotArn (string) –

      The ARN of the enhanced snapshot.

    • SnapshotStatus (string) –

      The status of the snapshot. When Managed Service for Apache Flink accepts the request, the status is DELETING. If a snapshot operation, such as an export, uses the snapshot, the status stays DELETING until that operation finishes and Managed Service for Apache Flink deletes the snapshot.

    • SnapshotOperationId (string) –

      The ID of the snapshot operation. You can use this value with DescribeSnapshotOperation to track the progress of the operation.

    • SnapshotOperationStatus (string) –

      The status of the snapshot operation.

Exceptions