AmazonStorageGatewayClient.CreateSnapshot Method (CreateSnapshotRequest)

Initiates a snapshot of a volume.

Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (Amazon S3) for durable off-site recovery, and also 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 an 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 Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the Storage Gateway console. In response, 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.

To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the Amazon Elastic Compute Cloud API Reference.

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

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to CreateSnapshotAsync.

Namespace: Amazon.StorageGateway
Assembly: AWSSDK.StorageGateway.dll
Version: 3.x.y.z

Syntax

public virtual CreateSnapshotResponse CreateSnapshot(
         CreateSnapshotRequest request
)

Parameters

request: Type: Amazon.StorageGateway.Model.CreateSnapshotRequest

Container for the necessary parameters to execute the CreateSnapshot service method.

Return Value

Type: CreateSnapshotResponse

The response from the CreateSnapshot service method, as returned by StorageGateway.

Exceptions

Exception	Condition
InternalServerErrorException	An internal server error has occurred during the request. For more information, see the error and message fields.
InvalidGatewayRequestException	An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.
ServiceUnavailableErrorException	An internal server error has occurred because the service is unavailable. For more information, see the error and message fields.

Examples

Initiates an ad-hoc snapshot of a gateway volume.

To create a snapshot of a gateway volume


var client = new AmazonStorageGatewayClient();
var response = client.CreateSnapshot(new CreateSnapshotRequest 
{
    SnapshotDescription = "My root volume snapshot as of 10/03/2017",
    VolumeARN = "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB"
});

string snapshotId = response.SnapshotId;
string volumeARN = response.VolumeARN;

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

AmazonStorageGatewayClient.CreateSnapshot (CreateSnapshotRequest)

Method