Skip to content

DescribeSnapshotScheduleOutput

Source code in docs_src/capo_storage_gateway/types/describe_snapshot_schedule_output.py
class DescribeSnapshotScheduleOutput(TypedDict, closed=True):
    volume_arn: NotRequired["capo_storage_gateway.types.volume_arn.VolumeARN"]
    """<p>The Amazon Resource Name (ARN) of the volume that was specified in the request.</p>"""
    start_at: NotRequired["capo_storage_gateway.types.hour_of_day.HourOfDay"]
    """<p>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.</p>"""
    recurrence_in_hours: NotRequired[
        "capo_storage_gateway.types.recurrence_in_hours.RecurrenceInHours"
    ]
    """<p>The number of hours between snapshots.</p>"""
    description: NotRequired["capo_storage_gateway.types.description.Description"]
    """<p>The snapshot description.</p>"""
    timezone: NotRequired["capo_storage_gateway.types.gateway_timezone.GatewayTimezone"]
    """<p>A value that indicates the time zone of the gateway.</p>"""
    tags: NotRequired["capo_storage_gateway.types.tags.Tags"]
    """<p>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 <code>ListTagsForResource</code> API operation.</p>"""

description instance-attribute

description: NotRequired[Description]

The snapshot description.

recurrence_in_hours instance-attribute

recurrence_in_hours: NotRequired[RecurrenceInHours]

The number of hours between snapshots.

start_at instance-attribute

start_at: NotRequired[HourOfDay]

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 instance-attribute

tags: NotRequired[Tags]

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 instance-attribute

timezone: NotRequired[GatewayTimezone]

A value that indicates the time zone of the gateway.

volume_arn instance-attribute

volume_arn: NotRequired[VolumeARN]

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