Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1490380385.5 KB

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.

post/#X-Amz-Target=StorageGateway_20130630.DescribeSnapshotSchedule

Headers

X-Amz-Target'StorageGateway_20130630.DescribeSnapshotSchedule' required

Request body

VolumeARNstring required

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

Response

Success

VolumeARNstring

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

StartAtinteger

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

RecurrenceInHoursinteger

The number of hours between snapshots.

Descriptionstring

The snapshot description.

Timezonestring

A value that indicates the time zone of the gateway.

Example response

{
  "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"
}