Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
- updateSnapshotSchedule :: Text -> Natural -> Natural -> UpdateSnapshotSchedule
- data UpdateSnapshotSchedule
- ussDescription :: Lens' UpdateSnapshotSchedule (Maybe Text)
- ussVolumeARN :: Lens' UpdateSnapshotSchedule Text
- ussStartAt :: Lens' UpdateSnapshotSchedule Natural
- ussRecurrenceInHours :: Lens' UpdateSnapshotSchedule Natural
- updateSnapshotScheduleResponse :: Int -> UpdateSnapshotScheduleResponse
- data UpdateSnapshotScheduleResponse
- ussrsVolumeARN :: Lens' UpdateSnapshotScheduleResponse (Maybe Text)
- ussrsResponseStatus :: Lens' UpdateSnapshotScheduleResponse Int
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:
- UpdateSnapshotScheduleInputDescription>
- UpdateSnapshotScheduleInputRecurrenceInHours>
- UpdateSnapshotScheduleInputStartAt>
- UpdateSnapshotScheduleInputVolumeARN>
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:
data UpdateSnapshotScheduleResponse Source #
A JSON object containing the of the updated storage volume.
See: updateSnapshotScheduleResponse
smart constructor.
Response Lenses
ussrsResponseStatus :: Lens' UpdateSnapshotScheduleResponse Int Source #
The response status code.