| « PreviousNext » | |
   | Did this page help you? Yes | No | Tell us about it... |
UpdateSnapshotSchedule
Description
This operation updates a snapshot schedule configured for a gateway volume.
The default snapshot schedule for stored volumes is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume.
In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots.
Request
Syntax
POST / HTTP/1.1 Host: storagegateway.region.amazonaws.com Authorization:authorizationContent-Type: application/x-amz-json-1.1 x-amz-date:datex-amz-target: StorageGateway_20120630.UpdateSnapshotSchedule { "VolumeARN": "String", "StartAt":Number, "RecurrenceInHours": "Number", "Description": "String" }
JSON Fields
- Description
Optional description of the snapshot that overwrites the existing description.
Length: Minimum length of 1. Maximum length of 255.
Required: No
Type: String
- RecurrenceInHours
Frequency of snapshots. Specify the number of hours between snapshots.
Valid Values: One of the values 1 | 2 | 4 | 8 | 12 | 24.
Required: Yes
Type: Number
- StartAt
The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.
Length: 2
Valid Values: An integer between 0 and 23.
Required: Yes
Type: Number
- VolumeARN
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
Required: yes
Type: String
Response
Syntax
HTTP/1.1 200 OK x-amzn-RequestId: x-amzn-RequestId Content-Type: application/x-amz-json-1.1 Content-length: payloadLength Date: date { "VolumeARN": "String" }
JSON Fields
- VolumeARN
The Amazon Resource Name (ARN) of the storage volume whose snapshot schedule was updated. It is the same value you provided in your request.
Type: String
Errors
This operation returns the following error codes in addition to exceptions common to all operations. For information about these errors and common exceptions, see Error Responses.
GatewayInternalError
GatewayNotConnected
GatewayNotFound
GatewayProxyNetworkConnectionBusy
InternalError
InvalidParameters
NotSupported
VolumeNotFound
Examples
The following example shows a request that updates a snapshot schedule.
Example Request
POST / HTTP/1.1
Host: storagegateway.us-east-1.amazonaws.com
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20120425/us-east-1/storagegateway/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=9cd5a3584d1d67d57e61f120f35102d6b3649066abdd4bf4bbcf05bd9f2f8fe2
x-amz-date: 20120912T120000Z
x-amz-target: StorageGateway_20120630.UpdateSnapshotSchedule
{
"VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB",
"StartAt": 0,
"RecurrenceInHours": 1,
"Description": "hourly snapshot"
}Example 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: 104
{
"VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/volume/vol-1122AABB"
} 
