StorageGateway / Client / describe_snapshot_schedule

describe_snapshot_schedule

StorageGateway.Client.describe_snapshot_schedule(**kwargs)

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

response = client.describe_snapshot_schedule(
    VolumeARN='string'
)

Parameters:

VolumeARN (string) –

[REQUIRED]

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

Return type:

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. The key can’t start with aws:.

      • Value (string) –

        Value of the tag key.

Exceptions

• StorageGateway.Client.exceptions.InvalidGatewayRequestException

• StorageGateway.Client.exceptions.InternalServerError

Examples

Describes the snapshot schedule for the specified gateway volume including intervals at which snapshots are automatically initiated.

response = client.describe_snapshot_schedule(
    VolumeARN='arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
)

print(response)

Expected Output:

{
    'Description': 'sgw-AABB1122:vol-AABB1122:Schedule',
    'RecurrenceInHours': 24,
    'StartAt': 6,
    'Timezone': 'GMT+7:00',
    'VolumeARN': 'arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB',
    'ResponseMetadata': {
        '...': '...',
    },
}