BillingandCostManagementDashboards / Client / execute_scheduled_report

execute_scheduled_report

BillingandCostManagementDashboards.Client.execute_scheduled_report(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.execute_scheduled_report(
    arn='string',
    clientToken='string',
    dryRun=True|False
)
Parameters:

  • arn (string) –

    [REQUIRED]

    The ARN of the scheduled report to execute.

  • clientToken (string) –

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

    This field is autopopulated if not provided.

  • dryRun (boolean) – When set to true, validates the scheduled report configuration without triggering an actual execution.

Return type:

dict

Returns:

Response Syntax

{
    'healthStatus': {
        'statusCode': 'HEALTHY'|'UNHEALTHY',
        'lastRefreshedAt': datetime(2015, 1, 1),
        'statusReasons': [
            'DATA_SOURCE_ACCESS_DENIED'|'EXECUTION_ROLE_ASSUME_FAILED'|'EXECUTION_ROLE_INSUFFICIENT_PERMISSIONS'|'DASHBOARD_NOT_FOUND'|'DASHBOARD_ACCESS_DENIED'|'INTERNAL_FAILURE'|'WIDGET_ID_NOT_FOUND',
        ]
    },
    'executionTriggered': True|False
}

Response Structure

  • (dict) –

    • healthStatus (dict) –

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

      • statusCode (string) –

        The health status code. HEALTHY indicates the scheduled report is configured properly and has all required permissions to execute. UNHEALTHY indicates the scheduled report is unable to deliver the notification to the default Amazon EventBridge EventBus in your account and your action is needed. The reason for the unhealthy state is captured in the health status reasons.

      • lastRefreshedAt (datetime) –

        The timestamp when the health status was last refreshed.

      • statusReasons (list) –

        The list of reasons for the current health status. Only present when the status is UNHEALTHY.

        • (string) –

    • executionTriggered (boolean) –

      Indicates whether the execution was successfully triggered.

Exceptions