scheduled_reports

Creates, updates, deletes, gets or lists a scheduled_reports resource.

Overview

Name	scheduled_reports
Type	Resource
Id	aws.bcm_dashboards.scheduled_reports

Fields

The following fields are returned by SELECT queries:

get_scheduled_report

Name	Datatype	Description
name	string	The name of the scheduled report. (pattern: <code>(?!.* {2})[a-zA-Z][a-zA-Z0-9 -]{0,48}[a-zA-Z0-9-]</code>)
arn	string	The ARN of the scheduled report. (pattern: <code>arn:aws[-a-z0-9]*:bcm-dashboards::[0-9]{12}:scheduled-report/(*|[-a-z0-9]+)</code>)
created_at	string (date-time)	The timestamp when the scheduled report was created.
dashboard_arn	string	The ARN of the dashboard associated with the scheduled report. (pattern: <code>arn:aws[-a-z0-9]*:bcm-dashboards::[0-9]{12}:dashboard/(*|[-a-z0-9]+)</code>)
description	string	A description of the scheduled report's purpose or contents. (pattern: <code>(?!.* {2})[ a-zA-Z0-9.,!?;:@#$%&-_/\]*</code>)
health_status	object	The health status of the scheduled report at last refresh time.
last_execution_at	string (date-time)	The timestamp of the most recent execution of the scheduled report.
schedule_config	object	The schedule configuration that defines when and how often the report is generated.
scheduled_report_execution_role_arn	string	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. (pattern: <code>arn:aws[-a-z0-9]*:iam::[0-9]{12}:role/[a-zA-Z0-9+=,.@_/-]+</code>)
updated_at	string (date-time)	The timestamp when the scheduled report was last modified.
widget_date_range_override	object	Defines a time period with explicit start and end times for data queries.
widget_ids	array	The list of widget identifiers included in the scheduled report.

list_scheduled_reports

Name	Datatype	Description
name	string	The name of the scheduled report. (pattern: <code>(?!.* {2})[a-zA-Z][a-zA-Z0-9 -]{0,48}[a-zA-Z0-9-]</code>)
arn	string	The ARN of the scheduled report. (pattern: <code>arn:aws[-a-z0-9]*:bcm-dashboards::[0-9]{12}:scheduled-report/(*|[-a-z0-9]+)</code>)
dashboard_arn	string	The ARN of the dashboard associated with the scheduled report. (pattern: <code>arn:aws[-a-z0-9]*:bcm-dashboards::[0-9]{12}:dashboard/(*|[-a-z0-9]+)</code>)
health_status	object	The health status of the scheduled report as of its last refresh time.
schedule_expression	string	The schedule expression that defines when the report runs. (pattern: <code>[\S\s]*</code>)
schedule_expression_time_zone	string	The time zone for the schedule expression, for example, UTC. (pattern: <code>[\S\s]*</code>)
state	string	The state of the schedule: ENABLED or DISABLED. (ENABLED, DISABLED)
widget_ids	array	The list of widget identifiers included in the scheduled report.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_scheduled_report	select	region		Retrieves the configuration and metadata of a specified scheduled report.
list_scheduled_reports	select	region		Returns a list of scheduled reports in your account.
create_scheduled_report	insert	region, scheduledReport		Creates a new scheduled report for a dashboard. A scheduled report automatically generates and delivers dashboard snapshots on a recurring schedule. Reports are delivered within 15 minutes of the scheduled delivery time.
update_scheduled_report	update	region, arn		Updates an existing scheduled report's properties, including its name, description, schedule configuration, and widget settings. Only the parameters included in the request are updated; all other properties remain unchanged.
delete_scheduled_report	delete	region		Deletes a specified scheduled report. This is an irreversible operation.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_scheduled_report

Retrieves the configuration and metadata of a specified scheduled report.

SELECT
name,
arn,
created_at,
dashboard_arn,
description,
health_status,
last_execution_at,
schedule_config,
scheduled_report_execution_role_arn,
updated_at,
widget_date_range_override,
widget_ids
FROM aws.bcm_dashboards.scheduled_reports
WHERE region = '{{ region }}' -- required
;

list_scheduled_reports

Returns a list of scheduled reports in your account.

SELECT
name,
arn,
dashboard_arn,
health_status,
schedule_expression,
schedule_expression_time_zone,
state,
widget_ids
FROM aws.bcm_dashboards.scheduled_reports
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_scheduled_report

Creates a new scheduled report for a dashboard. A scheduled report automatically generates and delivers dashboard snapshots on a recurring schedule. Reports are delivered within 15 minutes of the scheduled delivery time.

INSERT INTO aws.bcm_dashboards.scheduled_reports (
scheduledReport,
resourceTags,
clientToken,
region
)
SELECT 
'{{ scheduledReport }}' /* required */,
'{{ resourceTags }}',
'{{ clientToken }}',
'{{ region }}'
RETURNING
arn
;

Manifest

# Description fields are for documentation purposes
- name: scheduled_reports
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the scheduled_reports resource.
  - name: scheduledReport
    description: |
      The configuration for the scheduled report, including the dashboard to report on, the schedule, and the execution role that the service will use to generate the dashboard snapshot.
    value:
      name: "{{ name }}"
      dashboardArn: "{{ dashboardArn }}"
      scheduledReportExecutionRoleArn: "{{ scheduledReportExecutionRoleArn }}"
      scheduleConfig:
        scheduleExpression: "{{ scheduleExpression }}"
        scheduleExpressionTimeZone: "{{ scheduleExpressionTimeZone }}"
        schedulePeriod:
          startTime: "{{ startTime }}"
          endTime: "{{ endTime }}"
        state: "{{ state }}"
      description: "{{ description }}"
      widgetIds:
        - "{{ widgetIds }}"
      widgetDateRangeOverride:
        startTime:
          type_: "{{ type_ }}"
          value: "{{ value }}"
        endTime:
          type_: "{{ type_ }}"
          value: "{{ value }}"
  - name: resourceTags
    description: |
      The tags to apply to the scheduled report resource for organization and management.
    value:
      - key: "{{ key }}"
        value: "{{ value }}"
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

UPDATE examples

update_scheduled_report

Updates an existing scheduled report's properties, including its name, description, schedule configuration, and widget settings. Only the parameters included in the request are updated; all other properties remain unchanged.

UPDATE aws.bcm_dashboards.scheduled_reports
SET 
arn = '{{ arn }}',
name = '{{ name }}',
description = '{{ description }}',
dashboardArn = '{{ dashboardArn }}',
scheduledReportExecutionRoleArn = '{{ scheduledReportExecutionRoleArn }}',
scheduleConfig = '{{ scheduleConfig }}',
widgetIds = '{{ widgetIds }}',
widgetDateRangeOverride = '{{ widgetDateRangeOverride }}',
clearWidgetIds = {{ clearWidgetIds }},
clearWidgetDateRangeOverride = {{ clearWidgetDateRangeOverride }}
WHERE 
region = '{{ region }}' --required
AND arn = '{{ arn }}' --required
RETURNING
arn;

DELETE examples

delete_scheduled_report

Deletes a specified scheduled report. This is an irreversible operation.

DELETE FROM aws.bcm_dashboards.scheduled_reports
WHERE region = '{{ region }}' --required
;