Skip to content

ScheduledReport

Source code in docs_src/capo_bcm_dashboards/types/scheduled_report.py
class ScheduledReport(TypedDict, closed=True):
    arn: NotRequired[
        "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>"""
    scheduled_report_execution_role_arn: (
        "capo_bcm_dashboards.types.service_role_arn.ServiceRoleArn"
    )
    """<p>The ARN of the IAM role that the scheduled report uses to execute. Amazon Web Services Billing and Cost Management Dashboards will assume this IAM role while executing the scheduled report.</p>"""
    schedule_config: "capo_bcm_dashboards.types.schedule_config.ScheduleConfig"
    """<p>The schedule configuration that defines when and how often the report is generated.</p>"""
    description: NotRequired["capo_bcm_dashboards.types.description.Description"]
    """<p>A description of the scheduled report's purpose or contents.</p>"""
    widget_ids: NotRequired["capo_bcm_dashboards.types.widget_id_list.WidgetIdList"]
    """<p>The list of widget identifiers included in the scheduled report.</p>"""
    widget_date_range_override: NotRequired[
        "capo_bcm_dashboards.types.date_time_range.DateTimeRange"
    ]
    """<p>The date range override applied to widgets in the scheduled report.</p>"""
    created_at: NotRequired[
        "capo_bcm_dashboards.types.generic_time_stamp.GenericTimeStamp"
    ]
    """<p>The timestamp when the scheduled report was created.</p>"""
    updated_at: NotRequired[
        "capo_bcm_dashboards.types.generic_time_stamp.GenericTimeStamp"
    ]
    """<p>The timestamp when the scheduled report was last modified.</p>"""
    last_execution_at: NotRequired[
        "capo_bcm_dashboards.types.generic_time_stamp.GenericTimeStamp"
    ]
    """<p>The timestamp of the most recent execution of the scheduled report.</p>"""
    health_status: NotRequired["capo_bcm_dashboards.types.health_status.HealthStatus"]
    """<p>The health status of the scheduled report at last refresh time.</p>"""

arn instance-attribute

arn: NotRequired[ScheduledReportArn]

The ARN of the scheduled report.

created_at instance-attribute

created_at: NotRequired[GenericTimeStamp]

The timestamp when the scheduled report was created.

dashboard_arn instance-attribute

dashboard_arn: DashboardArn

The ARN of the dashboard associated with the scheduled report.

description instance-attribute

description: NotRequired[Description]

A description of the scheduled report's purpose or contents.

health_status instance-attribute

health_status: NotRequired[HealthStatus]

The health status of the scheduled report at last refresh time.

last_execution_at instance-attribute

last_execution_at: NotRequired[GenericTimeStamp]

The timestamp of the most recent execution of the scheduled report.

name instance-attribute

The name of the scheduled report.

schedule_config instance-attribute

schedule_config: ScheduleConfig

The schedule configuration that defines when and how often the report is generated.

scheduled_report_execution_role_arn instance-attribute

scheduled_report_execution_role_arn: ServiceRoleArn

The ARN of the IAM role that the scheduled report uses to execute. Amazon Web Services Billing and Cost Management Dashboards will assume this IAM role while executing the scheduled report.

updated_at instance-attribute

updated_at: NotRequired[GenericTimeStamp]

The timestamp when the scheduled report was last modified.

widget_date_range_override instance-attribute

widget_date_range_override: NotRequired[DateTimeRange]

The date range override applied to widgets in the scheduled report.

widget_ids instance-attribute

widget_ids: NotRequired[WidgetIdList]

The list of widget identifiers included in the scheduled report.