storagegateway_create_snapshot: Initiates a snapshot of a volume

Description Usage Arguments Value Request syntax Examples

View source: R/storagegateway_operations.R

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 (Amazon 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 an ad hoc snapshot. For more information, see Editing a snapshot schedule.

In the create_snapshot 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.

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.

Usage

1
storagegateway_create_snapshot(VolumeARN, SnapshotDescription, Tags)

Arguments

VolumeARN

[required] The Amazon Resource Name (ARN) of the volume. Use the list_volumes operation to return a list of gateway volumes.

SnapshotDescription

[required] 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.

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.

Value

A list with the following syntax:

1
2
3
4
list(
  VolumeARN = "string",
  SnapshotId = "string"
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
svc$create_snapshot(
  VolumeARN = "string",
  SnapshotDescription = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

Examples

1
2
3
4
5
6
7
8
## Not run: 
# Initiates an ad-hoc snapshot of a gateway volume.
svc$create_snapshot(
  SnapshotDescription = "My root volume snapshot as of 10/03/2017",
  VolumeARN = "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12..."
)

## End(Not run)

paws.storage documentation built on Aug. 23, 2021, 1:06 a.m.