amazonka-storagegateway-1.4.5: Amazon Storage Gateway SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.StorageGateway.UpdateSnapshotSchedule

Contents

Description

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.

Synopsis

Creating a Request

updateSnapshotSchedule #

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:

  • ussDescription - Optional description of the snapshot that overwrites the existing description.
  • ussVolumeARN - The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
  • ussStartAt - 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 - Frequency of snapshots. Specify the number of hours between snapshots.

data UpdateSnapshotSchedule #

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

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

See: updateSnapshotSchedule smart constructor.

Instances

Eq UpdateSnapshotSchedule # 
Data UpdateSnapshotSchedule # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateSnapshotSchedule -> c UpdateSnapshotSchedule #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateSnapshotSchedule #

toConstr :: UpdateSnapshotSchedule -> Constr #

dataTypeOf :: UpdateSnapshotSchedule -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateSnapshotSchedule) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateSnapshotSchedule) #

gmapT :: (forall b. Data b => b -> b) -> UpdateSnapshotSchedule -> UpdateSnapshotSchedule #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateSnapshotSchedule -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateSnapshotSchedule -> r #

gmapQ :: (forall d. Data d => d -> u) -> UpdateSnapshotSchedule -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateSnapshotSchedule -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateSnapshotSchedule -> m UpdateSnapshotSchedule #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateSnapshotSchedule -> m UpdateSnapshotSchedule #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateSnapshotSchedule -> m UpdateSnapshotSchedule #

Read UpdateSnapshotSchedule # 
Show UpdateSnapshotSchedule # 
Generic UpdateSnapshotSchedule # 
Hashable UpdateSnapshotSchedule # 
ToJSON UpdateSnapshotSchedule # 
NFData UpdateSnapshotSchedule # 

Methods

rnf :: UpdateSnapshotSchedule -> () #

AWSRequest UpdateSnapshotSchedule # 
ToQuery UpdateSnapshotSchedule # 
ToPath UpdateSnapshotSchedule # 
ToHeaders UpdateSnapshotSchedule # 
type Rep UpdateSnapshotSchedule # 
type Rep UpdateSnapshotSchedule = D1 (MetaData "UpdateSnapshotSchedule" "Network.AWS.StorageGateway.UpdateSnapshotSchedule" "amazonka-storagegateway-1.4.5-ChAHao40T5hDKKv8LXBPA4" False) (C1 (MetaCons "UpdateSnapshotSchedule'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ussDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ussVolumeARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ussStartAt") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat)) (S1 (MetaSel (Just Symbol "_ussRecurrenceInHours") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat)))))
type Rs UpdateSnapshotSchedule # 

Request Lenses

ussDescription :: Lens' UpdateSnapshotSchedule (Maybe Text) #

Optional description of the snapshot that overwrites the existing description.

ussVolumeARN :: Lens' UpdateSnapshotSchedule Text #

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

ussStartAt :: Lens' UpdateSnapshotSchedule Natural #

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 #

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

Destructuring the Response

updateSnapshotScheduleResponse #

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 #

A JSON object containing the of the updated storage volume.

See: updateSnapshotScheduleResponse smart constructor.

Instances

Eq UpdateSnapshotScheduleResponse # 
Data UpdateSnapshotScheduleResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateSnapshotScheduleResponse -> c UpdateSnapshotScheduleResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateSnapshotScheduleResponse #

toConstr :: UpdateSnapshotScheduleResponse -> Constr #

dataTypeOf :: UpdateSnapshotScheduleResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateSnapshotScheduleResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateSnapshotScheduleResponse) #

gmapT :: (forall b. Data b => b -> b) -> UpdateSnapshotScheduleResponse -> UpdateSnapshotScheduleResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateSnapshotScheduleResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateSnapshotScheduleResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> UpdateSnapshotScheduleResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateSnapshotScheduleResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateSnapshotScheduleResponse -> m UpdateSnapshotScheduleResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateSnapshotScheduleResponse -> m UpdateSnapshotScheduleResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateSnapshotScheduleResponse -> m UpdateSnapshotScheduleResponse #

Read UpdateSnapshotScheduleResponse # 
Show UpdateSnapshotScheduleResponse # 
Generic UpdateSnapshotScheduleResponse # 
NFData UpdateSnapshotScheduleResponse # 
type Rep UpdateSnapshotScheduleResponse # 
type Rep UpdateSnapshotScheduleResponse = D1 (MetaData "UpdateSnapshotScheduleResponse" "Network.AWS.StorageGateway.UpdateSnapshotSchedule" "amazonka-storagegateway-1.4.5-ChAHao40T5hDKKv8LXBPA4" False) (C1 (MetaCons "UpdateSnapshotScheduleResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_ussrsVolumeARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ussrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses