Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1490380385.5 KB

Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the cached volume and stored volume gateway types.

The default snapshot schedule for volume 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.

post/#X-Amz-Target=StorageGateway_20130630.UpdateSnapshotSchedule

Headers

X-Amz-Target'StorageGateway_20130630.UpdateSnapshotSchedule' required

Request body

VolumeARNstring required

The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway volumes.

StartAtinteger required

The hour of the day at which the snapshot schedule begins represented as <i>hh</i>, where <i>hh</i> is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

RecurrenceInHoursinteger required

Frequency of snapshots. Specify the number of hours between snapshots.

Descriptionstring

Optional description of the snapshot that overwrites the existing description.

Response

Success

VolumeARNstring

The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway volumes.

Example response

{
  "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
}