StorageGateway / Client / create_snapshot

create_snapshot#

StorageGateway.Client.create_snapshot(**kwargs)#

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.

Note

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.

Warning

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

See also: AWS API Documentation

Request Syntax

response = client.create_snapshot(
    VolumeARN='string',
    SnapshotDescription='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • VolumeARN (string) –

    [REQUIRED]

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

  • SnapshotDescription (string) –

    [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 Storage Gateway snapshot Details pane, Description field.

  • Tags (list) –

    A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.

    Note

    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.

    • (dict) –

      A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /.

      • Key (string) – [REQUIRED]

        Tag key. The key can’t start with aws:.

      • Value (string) – [REQUIRED]

        Value of the tag key.

Return type:

dict

Returns:

Response Syntax

{
    'VolumeARN': 'string',
    'SnapshotId': 'string'
}

Response Structure

  • (dict) –

    A JSON object containing the following fields:

    • VolumeARN (string) –

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

    • SnapshotId (string) –

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

Exceptions

Examples

Initiates an ad-hoc snapshot of a gateway volume.

response = client.create_snapshot(
    SnapshotDescription='My root volume snapshot as of 10/03/2017',
    VolumeARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
)

print(response)

Expected Output:

{
    'SnapshotId': 'snap-78e22663',
    'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
    'ResponseMetadata': {
        '...': '...',
    },
}