View a markdown version of this page

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

DescribeSnapshotOperation

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.

Request Syntax

{ "SnapshotName": "string", "SnapshotOperationId": "string" }

Request Parameters

The request accepts the following data in JSON format.

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

SnapshotOperationId

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

Type: String

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

Required: Yes

Response Syntax

{ "SnapshotOperationInfoDetails": { "ApplicationOperationDescription": { "ApplicationName": "string", "ApplicationOperationId": "string" }, "DestinationEncryptionConfigurationDescription": { "KeyId": "string", "KeyType": "string" }, "EndTime": number, "SnapshotArn": "string", "SnapshotDestinationLocationDescription": { "LocationType": "string", "S3PrefixLocation": { "BucketARN": "string", "ExportedPrefix": "string", "KeyPrefix": "string" } }, "SnapshotOperation": "string", "SnapshotOperationFailureDetails": { "ErrorInfo": { "ErrorCode": "string", "ErrorString": "string" } }, "SnapshotOperationId": "string", "SnapshotOperationStatus": "string", "SnapshotSourceLocationDescription": { "LocationType": "string", "S3PrefixLocation": { "BucketARN": "string", "ExportedPrefix": "string", "KeyPrefix": "string" } }, "SourceEncryptionConfigurationDescription": { "KeyId": "string", "KeyType": "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.

SnapshotOperationInfoDetails

An object containing information about the snapshot operation.

Type: SnapshotOperationInfoDetails object

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: