Network.AWS.StorageGateway.CreateSnapshot

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.

Creating a Request

createSnapshot

Arguments

:: Text

csVolumeARN

-> Text

csSnapshotDescription

-> CreateSnapshot

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

data CreateSnapshot

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

• CreateSnapshotInput$SnapshotDescription
• CreateSnapshotInput$VolumeARN

See: createSnapshot smart constructor.

Instances

Eq CreateSnapshot

Data CreateSnapshot

Read CreateSnapshot

Show CreateSnapshot

Generic CreateSnapshot

ToJSON CreateSnapshot

AWSRequest CreateSnapshot

ToPath CreateSnapshot

ToHeaders CreateSnapshot

ToQuery CreateSnapshot

Typeable * CreateSnapshot

type Rep CreateSnapshot

type Rs CreateSnapshot = CreateSnapshotResponse

Request Lenses

csVolumeARN :: Lens' CreateSnapshot Text

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

csSnapshotDescription :: Lens' CreateSnapshot Text

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

Arguments

:: Int

csrsStatus

-> CreateSnapshotResponse

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
• csrsSnapshotId
• csrsStatus

data CreateSnapshotResponse

A JSON object containing the following fields:

See: createSnapshotResponse smart constructor.

Instances

Eq CreateSnapshotResponse

Data CreateSnapshotResponse

Read CreateSnapshotResponse

Show CreateSnapshotResponse

Generic CreateSnapshotResponse

Typeable * CreateSnapshotResponse

type Rep CreateSnapshotResponse

Response Lenses

csrsVolumeARN :: Lens' CreateSnapshotResponse (Maybe Text)

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

csrsSnapshotId :: Lens' CreateSnapshotResponse (Maybe Text)

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

csrsStatus :: Lens' CreateSnapshotResponse Int

The response status code.