Skip to content

ScheduledReportInput

Source code in docs_src/capo_bcm_dashboards/types/scheduled_report_input.py
class ScheduledReportInput(TypedDict, closed=True):
    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 to generate the scheduled report from.</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. If the schedule state is not specified, it defaults to <code>ENABLED</code>.</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 to include in the scheduled report. If not specified, all widgets in the dashboard are included.</p>"""
    widget_date_range_override: NotRequired[
        "capo_bcm_dashboards.types.date_time_range.DateTimeRange"
    ]
    """<p>The date range override to apply to widgets in the scheduled report.</p>"""

dashboard_arn instance-attribute

dashboard_arn: DashboardArn

The ARN of the dashboard to generate the scheduled report from.

description instance-attribute

description: NotRequired[Description]

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

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. If the schedule state is not specified, it defaults to ENABLED.

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.

widget_date_range_override instance-attribute

widget_date_range_override: NotRequired[DateTimeRange]

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

widget_ids instance-attribute

widget_ids: NotRequired[WidgetIdList]

The list of widget identifiers to include in the scheduled report. If not specified, all widgets in the dashboard are included.