snapshot_schedules

Creates, updates, deletes, gets or lists a snapshot_schedules resource.

Overview

Name	snapshot_schedules
Type	Resource
Id	aws.storagegateway.snapshot_schedules

Fields

The following fields are returned by SELECT queries:

describe_snapshot_schedule

Name	Datatype	Description
description	string	The snapshot description.
recurrence_in_hours	integer	The number of hours between snapshots.
start_at	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.
tags	array	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.
timezone	string	A value that indicates the time zone of the gateway.
volume_arn	string	The Amazon Resource Name (ARN) of the volume that was specified in the request. (pattern: <code>arn:(aws(|-cn|-us-gov|-iso[A-Za-z0-9_-]*|-eusc)):storagegateway:[a-z-0-9]+:[0-9]+:gateway/(.+)/volume/vol-(\S+)</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_snapshot_schedule	select	region		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.
update_snapshot_schedule	update	region, VolumeARN, StartAt, RecurrenceInHours		Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the cached volume and stored volume gateway types. The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume. In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots.
delete_snapshot_schedule	delete	region		Deletes a snapshot of a volume. You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Backing up your volumes. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported for cached volume gateway types. To list or delete a snapshot, you must use the Amazon EC2 API. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_snapshot_schedule

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.

SELECT
description,
recurrence_in_hours,
start_at,
tags,
timezone,
volume_arn
FROM aws.storagegateway.snapshot_schedules
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_snapshot_schedule

Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the cached volume and stored volume gateway types. The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume. In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots.

UPDATE aws.storagegateway.snapshot_schedules
SET 
VolumeARN = '{{ VolumeARN }}',
StartAt = {{ StartAt }},
RecurrenceInHours = {{ RecurrenceInHours }},
Description = '{{ Description }}',
Tags = '{{ Tags }}'
WHERE 
region = '{{ region }}' --required
AND VolumeARN = '{{ VolumeARN }}' --required
AND StartAt = '{{ StartAt }}' --required
AND RecurrenceInHours = '{{ RecurrenceInHours }}' --required
RETURNING
volume_arn;

DELETE examples

delete_snapshot_schedule

Deletes a snapshot of a volume. You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Backing up your volumes. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported for cached volume gateway types. To list or delete a snapshot, you must use the Amazon EC2 API. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

DELETE FROM aws.storagegateway.snapshot_schedules
WHERE region = '{{ region }}' --required
;