Skip to content

TopicRefreshSchedule

Source code in docs_src/capo_quicksight/types/topic_refresh_schedule.py
class TopicRefreshSchedule(TypedDict, closed=True):
    is_enabled: "capo_quicksight.types.nullable_boolean.NullableBoolean"
    """<p>A Boolean value that controls whether to schedule is enabled.</p>"""
    based_on_spice_schedule: "capo_quicksight.types.boolean.Boolean"
    """<p>A Boolean value that controls whether to schedule runs at the same schedule that is specified in SPICE dataset.</p>"""
    starting_at: NotRequired["capo_quicksight.types.timestamp.Timestamp"]
    """<p>The starting date and time for the refresh schedule.</p>"""
    timezone: NotRequired["capo_quicksight.types.limited_string.LimitedString"]
    """<p>The timezone that you want the refresh schedule to use.</p>"""
    repeat_at: NotRequired["capo_quicksight.types.limited_string.LimitedString"]
    """<p>The time of day when the refresh should run, for example, Monday-Sunday.</p>"""
    topic_schedule_type: NotRequired[
        "capo_quicksight.types.topic_schedule_type.TopicScheduleType"
    ]
    """<p>The type of refresh schedule. Valid values for this structure are <code>HOURLY</code>, <code>DAILY</code>, <code>WEEKLY</code>, and <code>MONTHLY</code>.</p>"""

based_on_spice_schedule instance-attribute

based_on_spice_schedule: Boolean

A Boolean value that controls whether to schedule runs at the same schedule that is specified in SPICE dataset.

is_enabled instance-attribute

is_enabled: NullableBoolean

A Boolean value that controls whether to schedule is enabled.

repeat_at instance-attribute

repeat_at: NotRequired[LimitedString]

The time of day when the refresh should run, for example, Monday-Sunday.

starting_at instance-attribute

starting_at: NotRequired[Timestamp]

The starting date and time for the refresh schedule.

timezone instance-attribute

timezone: NotRequired[LimitedString]

The timezone that you want the refresh schedule to use.

topic_schedule_type instance-attribute

topic_schedule_type: NotRequired[TopicScheduleType]

The type of refresh schedule. Valid values for this structure are HOURLY, DAILY, WEEKLY, and MONTHLY.