amazonka-storagegateway-1.6.1: Amazon Storage Gateway SDK.

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

Network.AWS.StorageGateway.CreateSnapshot

Contents

Description

Initiates a snapshot of a volume.

AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad-hoc basis. This API enables you to take ad-hoc snapshot. For more information, see Editing a Snapshot Schedule .

In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. This operation is only supported in stored and cached volume gateway type.

Important: Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome page.

Synopsis

Creating a Request

createSnapshot Source #

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

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

  • csVolumeARN - The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
  • csSnapshotDescription - Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field

data CreateSnapshot Source #

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

  • 'CreateSnapshotInput$SnapshotDescription'
  • 'CreateSnapshotInput$VolumeARN'

See: createSnapshot smart constructor.

Instances
Eq CreateSnapshot Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateSnapshot

Data CreateSnapshot Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateSnapshot

Methods

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

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

toConstr :: CreateSnapshot -> Constr #

dataTypeOf :: CreateSnapshot -> DataType #

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

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

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

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

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

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

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

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

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

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

Read CreateSnapshot Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateSnapshot

Show CreateSnapshot Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateSnapshot

Generic CreateSnapshot Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateSnapshot

Associated Types

type Rep CreateSnapshot :: Type -> Type #

Hashable CreateSnapshot Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateSnapshot

ToJSON CreateSnapshot Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateSnapshot

AWSRequest CreateSnapshot Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateSnapshot

Associated Types

type Rs CreateSnapshot :: Type #

ToHeaders CreateSnapshot Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateSnapshot

ToPath CreateSnapshot Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateSnapshot

ToQuery CreateSnapshot Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateSnapshot

NFData CreateSnapshot Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateSnapshot

Methods

rnf :: CreateSnapshot -> () #

type Rep CreateSnapshot Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateSnapshot

type Rep CreateSnapshot = D1 (MetaData "CreateSnapshot" "Network.AWS.StorageGateway.CreateSnapshot" "amazonka-storagegateway-1.6.1-8r5RVaLfJcl46lpEVK6Ktc" False) (C1 (MetaCons "CreateSnapshot'" PrefixI True) (S1 (MetaSel (Just "_csVolumeARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_csSnapshotDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))
type Rs CreateSnapshot Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateSnapshot

Request Lenses

csVolumeARN :: Lens' CreateSnapshot Text Source #

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

csSnapshotDescription :: Lens' CreateSnapshot Text Source #

Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field

Destructuring the Response

createSnapshotResponse Source #

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

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

  • csrsVolumeARN - The Amazon Resource Name (ARN) of the volume of which the snapshot was taken.
  • csrsSnapshotId - The snapshot ID that is used to refer to the snapshot in future operations such as describing snapshots (Amazon Elastic Compute Cloud API DescribeSnapshots ) or creating a volume from a snapshot (CreateStorediSCSIVolume ).
  • csrsResponseStatus - -- | The response status code.

data CreateSnapshotResponse Source #

A JSON object containing the following fields:

See: createSnapshotResponse smart constructor.

Instances
Eq CreateSnapshotResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateSnapshot

Data CreateSnapshotResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateSnapshot

Methods

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

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

toConstr :: CreateSnapshotResponse -> Constr #

dataTypeOf :: CreateSnapshotResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read CreateSnapshotResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateSnapshot

Show CreateSnapshotResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateSnapshot

Generic CreateSnapshotResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateSnapshot

Associated Types

type Rep CreateSnapshotResponse :: Type -> Type #

NFData CreateSnapshotResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateSnapshot

Methods

rnf :: CreateSnapshotResponse -> () #

type Rep CreateSnapshotResponse Source # 
Instance details

Defined in Network.AWS.StorageGateway.CreateSnapshot

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

Response Lenses

csrsVolumeARN :: Lens' CreateSnapshotResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the volume of which the snapshot was taken.

csrsSnapshotId :: Lens' CreateSnapshotResponse (Maybe Text) Source #

The snapshot ID that is used to refer to the snapshot in future operations such as describing snapshots (Amazon Elastic Compute Cloud API DescribeSnapshots ) or creating a volume from a snapshot (CreateStorediSCSIVolume ).

csrsResponseStatus :: Lens' CreateSnapshotResponse Int Source #

  • - | The response status code.