/AWS1/CL_STG=>CREATESNAPSHOT()¶
About CreateSnapshot¶
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.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_VOLUMEARN TYPE /AWS1/STGVOLUMEARN /AWS1/STGVOLUMEARN¶
The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.
IV_SNAPSHOTDESCRIPTION TYPE /AWS1/STGSNAPSHOTDESCRIPTION /AWS1/STGSNAPSHOTDESCRIPTION¶
Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the Storage Gateway snapshot Details pane, Description field.
Optional arguments:¶
IT_TAGS TYPE /AWS1/CL_STGTAG=>TT_TAGS TT_TAGS¶
A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.