CreateSnapshotFromVolumeRecoveryPoint
Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type.
A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for cached volume gateway, use ListVolumeRecoveryPoints.
In the CreateSnapshotFromVolumeRecoveryPoint
request, you identify the
volume by providing its Amazon Resource Name (ARN). You must also provide a description for
the snapshot. When the gateway takes a snapshot of the specified volume, the snapshot and
its description appear in the Storage Gateway console.
In response, the gateway returns
you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use
it when you want to create a volume from a snapshot.
Note
To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the Amazon Elastic Compute Cloud API Reference.
Request Syntax
{
"SnapshotDescription": "string
",
"Tags": [
{
"Key": "string
",
"Value": "string
"
}
],
"VolumeARN": "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.
- SnapshotDescription
-
Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the Storage Gateway snapshot Details pane, Description field.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
- Tags
-
A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.
Note
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
Type: Array of Tag objects
Required: No
- VolumeARN
-
The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern:
arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)
Required: Yes
Response Syntax
{
"SnapshotId": "string",
"VolumeARN": "string",
"VolumeRecoveryPointTime": "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.
- SnapshotId
-
The ID of the snapshot.
Type: String
Pattern:
\Asnap-([0-9A-Fa-f]{8}|[0-9A-Fa-f]{17})\z
- VolumeARN
-
The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Pattern:
arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*)):storagegateway:[a-z\-0-9]+:[0-9]+:gateway\/(.+)\/volume\/vol-(\S+)
- VolumeRecoveryPointTime
-
The time the volume was created from the recovery point.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerError
-
An internal server error has occurred during the request. For more information, see the error and message fields.
HTTP Status Code: 400
- InvalidGatewayRequestException
-
An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
HTTP Status Code: 400
- ServiceUnavailableError
-
An internal server error has occurred because the service is unavailable. For more information, see the error and message fields.
HTTP Status Code: 400
Examples
Example request
The following example sends a CreateSnapshotFromVolumeRecoveryPoint
request to take snapshot of the specified an example volume.
Sample Request
POST / HTTP/1.1
Host: storagegateway.us-east-2.amazonaws.com
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-2/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2
x-amz-date: 20120912T120000Z
x-amz-target: StorageGateway_20130630.CreateSnapshotFromVolumeRecoveryPoint
{
"VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
"SnapshotDescription": "snapshot description"
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: gur28r2rqlgb8vvs0mq17hlgij1q8glle1qeu3kpgg6f0kstauu0
Date: Wed, 12 Sep 2012 12:00:02 GMT
Content-Type: application/x-amz-json-1.1
Content-length: 137
{
"SnapshotId": "snap-78e22663",
"VolumeARN": "arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB",
"VolumeRecoveryPointTime": "2012-06-30T10:10:10.000Z"
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: