Amazon Storage Gateway · Schema
UpdateSnapshotScheduleInput
A JSON object containing one or more of the following fields:
BackupFile StorageGatewayHybrid CloudStorage
Properties
| Name | Type | Description |
|---|---|---|
| VolumeARN | object | |
| StartAt | object | |
| RecurrenceInHours | object | |
| Description | object | |
| Tags | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-storage-gateway/refs/heads/main/json-schema/amazon-storage-gateway-update-snapshot-schedule-input-schema.json",
"title": "UpdateSnapshotScheduleInput",
"description": "<p>A JSON object containing one or more of the following fields:</p> <ul> <li> <p> <a>UpdateSnapshotScheduleInput$Description</a> </p> </li> <li> <p> <a>UpdateSnapshotScheduleInput$RecurrenceInHours</a> </p> </li> <li> <p> <a>UpdateSnapshotScheduleInput$StartAt</a> </p> </li> <li> <p> <a>UpdateSnapshotScheduleInput$VolumeARN</a> </p> </li> </ul>",
"type": "object",
"properties": {
"VolumeARN": {
"allOf": [
{
"$ref": "#/components/schemas/VolumeARN"
},
{
"description": "The Amazon Resource Name (ARN) of the volume. Use the <a>ListVolumes</a> operation to return a list of gateway volumes."
}
]
},
"StartAt": {
"allOf": [
{
"$ref": "#/components/schemas/HourOfDay"
},
{
"description": "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."
}
]
},
"RecurrenceInHours": {
"allOf": [
{
"$ref": "#/components/schemas/RecurrenceInHours"
},
{
"description": "Frequency of snapshots. Specify the number of hours between snapshots."
}
]
},
"Description": {
"allOf": [
{
"$ref": "#/components/schemas/Description"
},
{
"description": "Optional description of the snapshot that overwrites the existing description."
}
]
},
"Tags": {
"allOf": [
{
"$ref": "#/components/schemas/Tags"
},
{
"description": "<p>A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.</p> <note> <p>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.</p> </note>"
}
]
}
},
"required": [
"VolumeARN",
"StartAt",
"RecurrenceInHours"
]
}