View a markdown version of this page

ListSnapshotOperations - Amazon Managed Service for Apache Flink (formerly Amazon Kinesis Data Analytics for Apache Flink)

ListSnapshotOperations

Lists the operations that were performed on the specified enhanced snapshot, such as CreateSnapshot, ImportSnapshot, and ExportSnapshot. The response includes a summary of each operation.

You can specify only one of the SnapshotOperation or SnapshotOperationStatus filters in a request. If you specify both, InvalidArgumentException is returned.

To get the complete description of a specific operation, use DescribeSnapshotOperation. Snapshot operations are available for 90 days after they are created.

Request Syntax

{ "Limit": number, "NextToken": "string", "SnapshotName": "string", "SnapshotOperation": "string", "SnapshotOperationStatus": "string" }

Request Parameters

The request accepts the following data in JSON format.

Limit

The maximum number of snapshot operations to list.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

NextToken

A pagination token that can be used in a subsequent request.

Type: String

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

Required: No

SnapshotName

The name of the enhanced snapshot.

Type: String

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

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

Required: Yes

SnapshotOperation

Use this parameter to list only the operations of the specified type.

Type: String

Valid Values: CreateSnapshot | DeleteSnapshot | ImportSnapshot | ExportSnapshot | SystemCreateSnapshot

Required: No

SnapshotOperationStatus

Use this parameter to list only the operations with the specified status.

Type: String

Valid Values: IN_PROGRESS | SUCCESSFUL | FAILED | CANCELLED

Required: No

Response Syntax

{ "NextToken": "string", "SnapshotOperationInfoList": [ { "EndTime": number, "SnapshotOperation": "string", "SnapshotOperationId": "string", "SnapshotOperationStatus": "string", "StartTime": number } ] }

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.

NextToken

A pagination token that can be used in a subsequent request.

Type: String

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

SnapshotOperationInfoList

A list of SnapshotOperationInfo objects.

Type: Array of SnapshotOperationInfo objects

Errors

InvalidArgumentException

The specified input parameter value is not valid.

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: