Skip to content

ScheduleConfig

Used by
Source code in docs_src/capo_bcm_dashboards/types/schedule_config.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
class ScheduleConfig(TypedDict, closed=True):
    schedule_expression: NotRequired[
        "capo_bcm_dashboards.types.generic_string.GenericString"
    ]
    """<p>The schedule expression that specifies when to trigger the scheduled report run. This value must be a cron expression consisting of six fields separated by white spaces: <code>cron(minutes hours day_of_month month day_of_week year)</code>.</p>"""
    schedule_expression_time_zone: NotRequired[
        "capo_bcm_dashboards.types.generic_string.GenericString"
    ]
    """<p>The time zone for the schedule expression, for example, <code>UTC</code>.</p>"""
    schedule_period: NotRequired[
        "capo_bcm_dashboards.types.schedule_period.SchedulePeriod"
    ]
    """<p>The time period during which the schedule is active.</p>"""
    state: NotRequired["capo_bcm_dashboards.types.schedule_state.ScheduleState"]
    """<p>The state of the schedule. <code>ENABLED</code> means the scheduled report runs according to its schedule expression. <code>DISABLED</code> means the scheduled report is paused and will not run until re-enabled.</p>"""

schedule_expression instance-attribute 

schedule_expression: NotRequired[GenericString]

The schedule expression that specifies when to trigger the scheduled report run. This value must be a cron expression consisting of six fields separated by white spaces: cron(minutes hours day_of_month month day_of_week year).

schedule_expression_time_zone instance-attribute 

schedule_expression_time_zone: NotRequired[GenericString]

The time zone for the schedule expression, for example, UTC.

schedule_period instance-attribute 

schedule_period: NotRequired[SchedulePeriod]

The time period during which the schedule is active.

state instance-attribute 

state: NotRequired[ScheduleState]

The state of the schedule. ENABLED means the scheduled report runs according to its schedule expression. DISABLED means the scheduled report is paused and will not run until re-enabled.