Skip to content

UpdateScheduledReportRequest

Source code in docs_src/capo_bcm_dashboards/types/update_scheduled_report_request.py
class UpdateScheduledReportRequest(TypedDict, closed=True):
    arn: "capo_bcm_dashboards.types.scheduled_report_arn.ScheduledReportArn"
    """<p>The ARN of the scheduled report to update.</p>"""
    name: NotRequired[
        "capo_bcm_dashboards.types.scheduled_report_name.ScheduledReportName"
    ]
    """<p>The new name for the scheduled report.</p>"""
    description: NotRequired["capo_bcm_dashboards.types.description.Description"]
    """<p>The new description for the scheduled report.</p>"""
    dashboard_arn: NotRequired["capo_bcm_dashboards.types.dashboard_arn.DashboardArn"]
    """<p>The ARN of the dashboard to associate with the scheduled report.</p>"""
    scheduled_report_execution_role_arn: NotRequired[
        "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: NotRequired[
        "capo_bcm_dashboards.types.schedule_config.ScheduleConfig"
    ]
    """<p>The updated schedule configuration for the report.</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>"""
    clear_widget_ids: "bool"
    """Set to true to clear existing widgetIds."""
    clear_widget_date_range_override: "bool"
    """Set to true to clear existing widgetDateRangeOverride."""

arn instance-attribute

The ARN of the scheduled report to update.

clear_widget_date_range_override instance-attribute

clear_widget_date_range_override: bool

Set to true to clear existing widgetDateRangeOverride.

clear_widget_ids instance-attribute

clear_widget_ids: bool

Set to true to clear existing widgetIds.

dashboard_arn instance-attribute

dashboard_arn: NotRequired[DashboardArn]

The ARN of the dashboard to associate with the scheduled report.

description instance-attribute

description: NotRequired[Description]

The new description for the scheduled report.

name instance-attribute

name: NotRequired[ScheduledReportName]

The new name for the scheduled report.

schedule_config instance-attribute

schedule_config: NotRequired[ScheduleConfig]

The updated schedule configuration for the report.

scheduled_report_execution_role_arn instance-attribute

scheduled_report_execution_role_arn: NotRequired[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.