amazonka-storagegateway- Amazon Storage Gateway SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <>
Portabilitynon-portable (GHC extensions)
Safe HaskellNone




This operation updates a snapshot schedule configured for a gateway volume.

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.

See: AWS API Reference for UpdateSnapshotSchedule.


Creating a Request

updateSnapshotSchedule Source

Creates a value of UpdateSnapshotSchedule with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data UpdateSnapshotSchedule Source

A JSON object containing one or more of the following fields:

  • UpdateSnapshotScheduleInput$Description
  • UpdateSnapshotScheduleInput$RecurrenceInHours
  • UpdateSnapshotScheduleInput$StartAt
  • UpdateSnapshotScheduleInput$VolumeARN

See: updateSnapshotSchedule smart constructor.

Request Lenses

ussDescription :: Lens' UpdateSnapshotSchedule (Maybe Text) Source

Optional description of the snapshot that overwrites the existing description.

ussVolumeARN :: Lens' UpdateSnapshotSchedule Text Source

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

ussStartAt :: Lens' UpdateSnapshotSchedule Natural Source

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.

ussRecurrenceInHours :: Lens' UpdateSnapshotSchedule Natural Source

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

Destructuring the Response

updateSnapshotScheduleResponse Source

Creates a value of UpdateSnapshotScheduleResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Response Lenses