Network.AWS.StorageGateway.UpdateSnapshotSchedule

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.

Creating a Request

updateSnapshotSchedule

Arguments

:: Text

ussVolumeARN

-> Natural

ussStartAt

-> Natural

ussRecurrenceInHours

-> 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

Defined in Network.AWS.StorageGateway.UpdateSnapshotSchedule

Methods

(==) :: UpdateSnapshotSchedule -> UpdateSnapshotSchedule -> Bool

(/=) :: UpdateSnapshotSchedule -> UpdateSnapshotSchedule -> Bool

Data UpdateSnapshotSchedule

Defined in Network.AWS.StorageGateway.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

Defined in Network.AWS.StorageGateway.UpdateSnapshotSchedule

Methods

readsPrec :: Int -> ReadS UpdateSnapshotSchedule

readList :: ReadS [UpdateSnapshotSchedule]

readPrec :: ReadPrec UpdateSnapshotSchedule

readListPrec :: ReadPrec [UpdateSnapshotSchedule]

Show UpdateSnapshotSchedule

Defined in Network.AWS.StorageGateway.UpdateSnapshotSchedule

Methods

showsPrec :: Int -> UpdateSnapshotSchedule -> ShowS

show :: UpdateSnapshotSchedule -> String

showList :: [UpdateSnapshotSchedule] -> ShowS

Generic UpdateSnapshotSchedule

Defined in Network.AWS.StorageGateway.UpdateSnapshotSchedule

Associated Types

type Rep UpdateSnapshotSchedule :: Type -> Type

Methods

from :: UpdateSnapshotSchedule -> Rep UpdateSnapshotSchedule x

to :: Rep UpdateSnapshotSchedule x -> UpdateSnapshotSchedule

Hashable UpdateSnapshotSchedule

Defined in Network.AWS.StorageGateway.UpdateSnapshotSchedule

Methods

hashWithSalt :: Int -> UpdateSnapshotSchedule -> Int

hash :: UpdateSnapshotSchedule -> Int

ToJSON UpdateSnapshotSchedule

Defined in Network.AWS.StorageGateway.UpdateSnapshotSchedule

Methods

toJSON :: UpdateSnapshotSchedule -> Value

toEncoding :: UpdateSnapshotSchedule -> Encoding

toJSONList :: [UpdateSnapshotSchedule] -> Value

toEncodingList :: [UpdateSnapshotSchedule] -> Encoding

AWSRequest UpdateSnapshotSchedule

Defined in Network.AWS.StorageGateway.UpdateSnapshotSchedule

Associated Types

type Rs UpdateSnapshotSchedule :: Type

Methods

request :: UpdateSnapshotSchedule -> Request UpdateSnapshotSchedule

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy UpdateSnapshotSchedule -> ClientResponse -> m (Response UpdateSnapshotSchedule)

ToHeaders UpdateSnapshotSchedule

Defined in Network.AWS.StorageGateway.UpdateSnapshotSchedule

Methods

toHeaders :: UpdateSnapshotSchedule -> [Header]

ToPath UpdateSnapshotSchedule

Defined in Network.AWS.StorageGateway.UpdateSnapshotSchedule

Methods

toPath :: UpdateSnapshotSchedule -> ByteString

ToQuery UpdateSnapshotSchedule

Defined in Network.AWS.StorageGateway.UpdateSnapshotSchedule

Methods

toQuery :: UpdateSnapshotSchedule -> QueryString

NFData UpdateSnapshotSchedule

Defined in Network.AWS.StorageGateway.UpdateSnapshotSchedule

Methods

rnf :: UpdateSnapshotSchedule -> ()

type Rep UpdateSnapshotSchedule

Defined in Network.AWS.StorageGateway.UpdateSnapshotSchedule

type Rep UpdateSnapshotSchedule = D1 (MetaData "UpdateSnapshotSchedule" "Network.AWS.StorageGateway.UpdateSnapshotSchedule" "amazonka-storagegateway-1.6.1-8r5RVaLfJcl46lpEVK6Ktc" False) (C1 (MetaCons "UpdateSnapshotSchedule'" PrefixI True) ((S1 (MetaSel (Just "_ussDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ussVolumeARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "_ussStartAt") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat) :*: S1 (MetaSel (Just "_ussRecurrenceInHours") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat))))

type Rs UpdateSnapshotSchedule

Defined in Network.AWS.StorageGateway.UpdateSnapshotSchedule

type Rs UpdateSnapshotSchedule = UpdateSnapshotScheduleResponse

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

Arguments

:: Int

ussrsResponseStatus

-> 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:

• ussrsVolumeARN -
• ussrsResponseStatus - -- | The response status code.

data UpdateSnapshotScheduleResponse

A JSON object containing the of the updated storage volume.

See: updateSnapshotScheduleResponse smart constructor.

Instances

Eq UpdateSnapshotScheduleResponse

Defined in Network.AWS.StorageGateway.UpdateSnapshotSchedule

Methods

(==) :: UpdateSnapshotScheduleResponse -> UpdateSnapshotScheduleResponse -> Bool

(/=) :: UpdateSnapshotScheduleResponse -> UpdateSnapshotScheduleResponse -> Bool

Data UpdateSnapshotScheduleResponse

Defined in Network.AWS.StorageGateway.UpdateSnapshotSchedule

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

Defined in Network.AWS.StorageGateway.UpdateSnapshotSchedule

Methods

readsPrec :: Int -> ReadS UpdateSnapshotScheduleResponse

readList :: ReadS [UpdateSnapshotScheduleResponse]

readPrec :: ReadPrec UpdateSnapshotScheduleResponse

readListPrec :: ReadPrec [UpdateSnapshotScheduleResponse]

Show UpdateSnapshotScheduleResponse

Defined in Network.AWS.StorageGateway.UpdateSnapshotSchedule

Methods

showsPrec :: Int -> UpdateSnapshotScheduleResponse -> ShowS

show :: UpdateSnapshotScheduleResponse -> String

showList :: [UpdateSnapshotScheduleResponse] -> ShowS

Generic UpdateSnapshotScheduleResponse

Defined in Network.AWS.StorageGateway.UpdateSnapshotSchedule

Associated Types

type Rep UpdateSnapshotScheduleResponse :: Type -> Type

Methods

from :: UpdateSnapshotScheduleResponse -> Rep UpdateSnapshotScheduleResponse x

to :: Rep UpdateSnapshotScheduleResponse x -> UpdateSnapshotScheduleResponse

NFData UpdateSnapshotScheduleResponse

Defined in Network.AWS.StorageGateway.UpdateSnapshotSchedule

Methods

rnf :: UpdateSnapshotScheduleResponse -> ()

type Rep UpdateSnapshotScheduleResponse

Defined in Network.AWS.StorageGateway.UpdateSnapshotSchedule

type Rep UpdateSnapshotScheduleResponse = D1 (MetaData "UpdateSnapshotScheduleResponse" "Network.AWS.StorageGateway.UpdateSnapshotSchedule" "amazonka-storagegateway-1.6.1-8r5RVaLfJcl46lpEVK6Ktc" False) (C1 (MetaCons "UpdateSnapshotScheduleResponse'" PrefixI True) (S1 (MetaSel (Just "_ussrsVolumeARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_ussrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

ussrsVolumeARN :: Lens' UpdateSnapshotScheduleResponse (Maybe Text)

ussrsResponseStatus :: Lens' UpdateSnapshotScheduleResponse Int

• - | The response status code.