Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1441397379.2 KB

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

post/#X-Amz-Target=AWSSimbaAPIService_v20180301.RestoreVolumeFromSnapshot

Headers

X-Amz-Target'AWSSimbaAPIService_v20180301.RestoreVolumeFromSnapshot' required

Request body

ClientRequestTokenstring

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

VolumeIdstring required

The ID of the volume that you are restoring.

SnapshotIdstring required

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

OptionsRestoreOpenZFSVolumeOption[]
<p>The settings used when restoring the specified volume from snapshot.</p> <ul> <li> <p> <code>DELETE_INTERMEDIATE_SNAPSHOTS</code> - Deletes snapshots between the current state and the specified snapshot. If there are intermediate snapshots and this option isn't used, <code>RestoreVolumeFromSnapshot</code> fails.</p> </li> <li> <p> <code>DELETE_CLONED_VOLUMES</code> - Deletes any dependent clone volumes created from intermediate snapshots. If there are any dependent clone volumes and this option isn't used, <code>RestoreVolumeFromSnapshot</code> fails.</p> </li> </ul>

Response

Success

VolumeIdstring

The ID of the volume that you restored.

Lifecycle'CREATING' | 'CREATED' | 'DELETING' | 'FAILED' | 'MISCONFIGURED' | 'PENDING' | 'AVAILABLE'

The lifecycle state of the volume being restored.