Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DeleteSnapshot

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.

Request Syntax


{
   "SnapshotCreationTimestamp": number,
   "SnapshotName": "string"
}

Request Parameters

The request accepts the following data in JSON format.

SnapshotCreationTimestamp

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

Type: Timestamp

Required: Yes

SnapshotName

The name of the enhanced snapshot to delete.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [a-zA-Z0-9_.-]+

Required: Yes

Response Syntax


{
   "SnapshotArn": "string",
   "SnapshotOperationId": "string",
   "SnapshotOperationStatus": "string",
   "SnapshotStatus": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

SnapshotArn

The ARN of the enhanced snapshot.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

SnapshotOperationId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

SnapshotOperationStatus

The status of the snapshot operation.

Type: String

Valid Values: IN_PROGRESS | SUCCESSFUL | FAILED | CANCELLED

SnapshotStatus

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.

Type: String

Valid Values: CREATING | READY | DELETING | FAILED

Errors

ConcurrentModificationException

Exception thrown as a result of concurrent modifications to an application or snapshot. This error can be the result of attempting to modify an application without using the current application ID.

HTTP Status Code: 400

InvalidArgumentException

The specified input parameter value is not valid.

HTTP Status Code: 400

ResourceInUseException

The application or snapshot is not available for this operation.

HTTP Status Code: 400

ResourceNotFoundException

The specified application, snapshot, or snapshot operation can't be found.

HTTP Status Code: 400

UnsupportedOperationException

The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

HTTP Status Code: 400