Skip to content

ScheduledReportSummary

Source code in docs_src/capo_bcm_dashboards/types/scheduled_report_summary.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class ScheduledReportSummary(TypedDict, closed=True):
    arn: "capo_bcm_dashboards.types.scheduled_report_arn.ScheduledReportArn"
    """<p>The ARN of the scheduled report.</p>"""
    name: "capo_bcm_dashboards.types.scheduled_report_name.ScheduledReportName"
    """<p>The name of the scheduled report.</p>"""
    dashboard_arn: "capo_bcm_dashboards.types.dashboard_arn.DashboardArn"
    """<p>The ARN of the dashboard associated with the scheduled report.</p>"""
    schedule_expression: "capo_bcm_dashboards.types.generic_string.GenericString"
    """<p>The schedule expression that defines when the report runs.</p>"""
    state: "capo_bcm_dashboards.types.schedule_state.ScheduleState"
    """<p>The state of the schedule: <code>ENABLED</code> or <code>DISABLED</code>.</p>"""
    health_status: "capo_bcm_dashboards.types.health_status.HealthStatus"
    """<p>The health status of the scheduled report as of its last refresh time.</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>"""
    widget_ids: NotRequired["capo_bcm_dashboards.types.widget_id_list.WidgetIdList"]
    """<p>The list of widget identifiers included in the scheduled report.</p>"""

arn instance-attribute 

arn: ScheduledReportArn

The ARN of the scheduled report.

dashboard_arn instance-attribute 

dashboard_arn: DashboardArn

The ARN of the dashboard associated with the scheduled report.

health_status instance-attribute 

health_status: HealthStatus

The health status of the scheduled report as of its last refresh time.

name instance-attribute 

name: ScheduledReportName

The name of the scheduled report.

schedule_expression instance-attribute 

schedule_expression: GenericString

The schedule expression that defines when the report runs.

schedule_expression_time_zone instance-attribute 

schedule_expression_time_zone: NotRequired[GenericString]

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

state instance-attribute 

state: ScheduleState

The state of the schedule: ENABLED or DISABLED.

widget_ids instance-attribute 

widget_ids: NotRequired[WidgetIdList]

The list of widget identifiers included in the scheduled report.