Copyright | (c) 2013-2015 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 |
This operation 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 Working With Snapshots in the AWS Storage Gateway Console.
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.
To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the EC2 API reference.
See: AWS API Reference for CreateSnapshot.
- createSnapshot :: Text -> Text -> CreateSnapshot
- data CreateSnapshot
- csVolumeARN :: Lens' CreateSnapshot Text
- csSnapshotDescription :: Lens' CreateSnapshot Text
- createSnapshotResponse :: Int -> CreateSnapshotResponse
- data CreateSnapshotResponse
- csrsVolumeARN :: Lens' CreateSnapshotResponse (Maybe Text)
- csrsSnapshotId :: Lens' CreateSnapshotResponse (Maybe Text)
- csrsResponseStatus :: Lens' CreateSnapshotResponse Int
Creating a Request
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:
data CreateSnapshot Source
A JSON object containing one or more of the following fields:
- CreateSnapshotInput$SnapshotDescription
- CreateSnapshotInput$VolumeARN
See: createSnapshot
smart constructor.
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
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:
data CreateSnapshotResponse Source
A JSON object containing the following fields:
See: createSnapshotResponse
smart constructor.
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.