ScheduledReportInput
Defines the configuration for creating a new scheduled report, including the dashboard, schedule, execution role, and optional widget settings.
Contents
- dashboardArn
-
The ARN of the dashboard to generate the scheduled report from.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:aws[-a-z0-9]*:bcm-dashboards::[0-9]{12}:dashboard/(\*|[-a-z0-9]+)Required: Yes
- name
-
The name of the scheduled report.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 50.
Pattern:
(?!.* {2})[a-zA-Z][a-zA-Z0-9 _-]{0,48}[a-zA-Z0-9_-]Required: Yes
- 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.Type: ScheduleConfig object
Required: Yes
- scheduledReportExecutionRoleArn
-
The ARN of the IAM role that the scheduled report uses to execute. AWS Billing and Cost Management Dashboards will assume this IAM role while executing the scheduled report.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:aws[-a-z0-9]*:iam::[0-9]{12}:role/[a-zA-Z0-9+=,.@_/-]+Required: Yes
- description
-
A description of the scheduled report's purpose or contents.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
(?!.* {2})[ a-zA-Z0-9.,!?;:@#$%&\-_/\\]*Required: No
- widgetDateRangeOverride
-
The date range override to apply to widgets in the scheduled report.
Type: DateTimeRange object
Required: No
- widgetIds
-
The list of widget identifiers to include in the scheduled report. If not specified, all widgets in the dashboard are included.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
