POST

/audit/report-jobs/{reportPlanName}

http://backup.{region}.amazonaws.com/audit/report-jobs/{reportPlanName}

Starts an on-demand report job for the specified report plan.

Access Token Required: API Key

Path Parameters

reportPlanNamestringrequired

The unique name of a report plan.

Body Params

IdempotencyTokenstring

A customer-chosen string that you can use to distinguish between otherwise identical calls to <code>StartReportJobInput</code>. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://backup.{region}.amazonaws.com/audit/report-jobs/{reportPlanName}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}