Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ExportSnapshot

Exports the data of an enhanced snapshot to an Amazon S3 location. Managed Service for Apache Flink assumes the IAM role that you specify in ExportDestinationConfiguration to write the snapshot data. The snapshot must be in the READY status.

This operation is asynchronous. To track the progress of the export, use DescribeSnapshotOperation.

A snapshot can have only one export in progress at a time. If an export of the snapshot is already in progress, LimitExceededException is returned.

For more information, see Import and export.

Request Syntax


{
   "ExportDestinationConfiguration": { 
      "DestinationEncryptionConfiguration": { 
         "KeyId": "string",
         "KeyType": "string"
      },
      "DestinationS3PrefixLocation": { 
         "BucketARN": "string",
         "KeyPrefix": "string"
      },
      "DestinationType": "string",
      "ExportRoleArn": "string"
   },
   "SnapshotName": "string"
}

Request Parameters

The request accepts the following data in JSON format.

ExportDestinationConfiguration

Describes the location, IAM role, and encryption configuration of the export destination.

Type: ExportDestinationConfiguration object

Required: Yes

SnapshotName

The name of the enhanced snapshot to export.

Type: String

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

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

Required: Yes

Response Syntax


{
   "SnapshotOperationId": "string",
   "SnapshotOperationStatus": "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.

SnapshotOperationId

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

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

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

LimitExceededException

The number of allowed resources has been exceeded.

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