AWS Storage Gateway

{'Tags': [{'Key': 'string', 'Value': 'string'}]}

Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type.

A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for cached volume gateway, use ListVolumeRecoveryPoints.

In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When the gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, the 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.

See also: AWS API Documentation

Request Syntax

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

type VolumeARN

string

param VolumeARN

[REQUIRED]

The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

type SnapshotDescription

string

param 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

type Tags

list

param Tags

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 (String). The key can't start with aws:.

  • Value (string) -- [REQUIRED]

    Value of the tag key.

rtype

dict

returns

Response Syntax

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

Response Structure

• (dict) --

  • SnapshotId (string) --

    The ID of the snapshot.

  • VolumeARN (string) --

    The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

  • VolumeRecoveryPointTime (string) --

    The time the volume was created from the recovery point.

{'Tags': [{'Key': 'string', 'Value': 'string'}]}

Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. This operation is only supported in the cached volume and stored volume types.

See also: AWS API Documentation

Request Syntax

client.describe_snapshot_schedule(
    VolumeARN='string'
)

type VolumeARN

string

param VolumeARN

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'VolumeARN': 'string',
    'StartAt': 123,
    'RecurrenceInHours': 123,
    'Description': 'string',
    'Timezone': 'string',
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • VolumeARN (string) --

    The Amazon Resource Name (ARN) of the volume that was specified in the request.

  • StartAt (integer) --

    The hour of the day at which the snapshot schedule begins represented as hh , where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

  • RecurrenceInHours (integer) --

    The number of hours between snapshots.

  • Description (string) --

    The snapshot description.

  • Timezone (string) --

    A value that indicates the time zone of the gateway.

  • Tags (list) --

    A list of up to 50 tags assigned to the snapshot schedule, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

    • (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) --

        Tag key (String). The key can't start with aws:.

      • Value (string) --

        Value of the tag key.