ScheduledReportSummary

Contains summary information for a scheduled report.

arn

The ARN of the scheduled report.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws[-a-z0-9]*:bcm-dashboards::[0-9]{12}:scheduled-report/(\*|[-a-z0-9]+)

Required: Yes

dashboardArn

The ARN of the dashboard associated with the scheduled report.

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

healthStatus

The health status of the scheduled report as of its last refresh time.

Type: HealthStatus object

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

scheduleExpression

The schedule expression that defines when the report runs.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: [\S\s]*

Required: Yes

state

The state of the schedule: ENABLED or DISABLED.

Type: String

Valid Values: ENABLED | DISABLED

Required: Yes

scheduleExpressionTimeZone

The time zone for the schedule expression, for example, UTC.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: [\S\s]*

Required: No

widgetIds

The list of widget identifiers included in the scheduled report.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 1 item.

Required: No

Contents