RestoreVolumeFromSnapshot - Amazon FSx
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also

RestoreVolumeFromSnapshot

Returns an Amazon FSx for OpenZFS volume to the state saved by the specified snapshot.

Request Syntax

{
   "ClientRequestToken": "string",
   "Options": [ "string" ],
   "SnapshotId": "string",
   "VolumeId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ClientRequestToken

(Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

Type: String

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

Pattern: [A-za-z0-9_.-]{0,63}$

Required: No

Options

The settings used when restoring the specified volume from snapshot.

  • DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots between the current state and the specified snapshot. If there are intermediate snapshots and this option isn't used, RestoreVolumeFromSnapshot fails.

  • DELETE_CLONED_VOLUMES - Deletes any dependent clone volumes created from intermediate snapshots. If there are any dependent clone volumes and this option isn't used, RestoreVolumeFromSnapshot fails.

Type: Array of strings

Array Members: Maximum number of 2 items.

Valid Values: DELETE_INTERMEDIATE_SNAPSHOTS | DELETE_CLONED_VOLUMES

Required: No

SnapshotId

The ID of the source snapshot. Specifies the snapshot that you are restoring from.

Type: String

Length Constraints: Minimum length of 11. Maximum length of 28.

Pattern: ^((fs)?volsnap-[0-9a-f]{8,})$

Required: Yes

VolumeId

The ID of the volume that you are restoring.

Type: String

Length Constraints: Fixed length of 23.

Pattern: ^(fsvol-[0-9a-f]{17,})$

Required: Yes

Response Syntax

{
   "Lifecycle": "string",
   "VolumeId": "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.

Lifecycle

The lifecycle state of the volume being restored.

Type: String

Valid Values: CREATING | CREATED | DELETING | FAILED | MISCONFIGURED | PENDING | AVAILABLE

VolumeId

The ID of the volume that you restored.

Type: String

Length Constraints: Fixed length of 23.

Pattern: ^(fsvol-[0-9a-f]{17,})$

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequest

A generic error indicating a failure with a client request.

HTTP Status Code: 400

InternalServerError

A generic error indicating a server-side failure.

HTTP Status Code: 500

VolumeNotFound

No Amazon FSx volumes were found based upon the supplied parameters.

HTTP Status Code: 400

See Also

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