Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

UpdateScheduledReport

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.

Request Syntax


{
   "arn": "string",
   "clearWidgetDateRangeOverride": boolean,
   "clearWidgetIds": boolean,
   "dashboardArn": "string",
   "description": "string",
   "name": "string",
   "scheduleConfig": { 
      "scheduleExpression": "string",
      "scheduleExpressionTimeZone": "string",
      "schedulePeriod": { 
         "endTime": number,
         "startTime": number
      },
      "state": "string"
   },
   "scheduledReportExecutionRoleArn": "string",
   "widgetDateRangeOverride": { 
      "endTime": { 
         "type": "string",
         "value": "string"
      },
      "startTime": { 
         "type": "string",
         "value": "string"
      }
   },
   "widgetIds": [ "string" ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

arn

The ARN of the scheduled report to update.

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

clearWidgetDateRangeOverride

Set to true to clear the existing date range override from the scheduled report.

Type: Boolean

Required: No

clearWidgetIds

Set to true to clear existing widget IDs from the scheduled report.

Type: Boolean

Required: No

dashboardArn

The ARN of the dashboard to associate 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: No

description

The new description for the scheduled report.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: (?!.* {2})[ a-zA-Z0-9.,!?;:@#$%&\-_/\\]*

Required: No

name

The new name for 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: No

scheduleConfig

The updated schedule configuration for the report.

Type: ScheduleConfig object

Required: No

scheduledReportExecutionRoleArn

The ARN of the IAM role that the scheduled report uses to execute. Amazon 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: 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

Response Syntax


{
   "arn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

arn

The ARN of the updated 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]+)

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You do not have sufficient permissions to perform this action. Verify your IAM permissions and any resource policies.

HTTP Status Code: 400

ConflictException

The request could not be completed due to a conflict with the current state of the resource. For example, attempting to create a resource that already exists or is being created.

HTTP Status Code: 400

InternalServerException

An internal error occurred while processing the request. Retry your request. If the problem persists, contact Amazon Support.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource (dashboard, policy, or widget) was not found. Verify the ARN and try again.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling. Reduce the frequency of requests and use exponential backoff.

HTTP Status Code: 400

ValidationException

The input parameters do not satisfy the requirements. Check the error message for specific validation details.

HTTP Status Code: 400

Examples

To update a scheduled report

The following example updates the name and schedule of a scheduled report.


{
    "arn": "arn:aws:bcm-dashboards::123456789012:scheduled-report/report-1",
    "name": "daily-cost-report",
    "scheduleConfig": {
        "scheduleExpression": "cron(0 8 * * ? *)",
        "scheduleExpressionTimeZone": "America/Los_Angeles",
        "schedulePeriod": {
            "startTime": "2026-04-01T00:00:00Z"
        },
        "state": "ENABLED"
    }
}