Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ExecuteScheduledReport

Triggers an immediate execution of a scheduled report, outside of its regular schedule. The scheduled report must be in ENABLED state. Calling this operation on a DISABLED scheduled report returns a ValidationException.

Note

If a clientToken is provided, the service uses it for idempotency. Requests with the same client token will not trigger a new execution within the same minute.

Request Syntax


{
   "arn": "string",
   "clientToken": "string",
   "dryRun": boolean
}

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 execute.

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

clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Type: String

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

Pattern: [\u0021-\u007E]+

Required: No

dryRun

When set to true, validates the scheduled report configuration without triggering an actual execution.

Type: Boolean

Required: No

Response Syntax


{
   "executionTriggered": boolean,
   "healthStatus": { 
      "lastRefreshedAt": number,
      "statusCode": "string",
      "statusReasons": [ "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.

executionTriggered

Indicates whether the execution was successfully triggered.

Type: Boolean

healthStatus

The health status of the scheduled report after the execution request.

Type: HealthStatus object

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 AWS 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