PUT

/audit/report-plans/{reportPlanName}

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

Updates an existing report plan identified by its <code>ReportPlanName</code> with the input document in JSON format.

Access Token Required: API Key

Path Parameters

reportPlanNamestringrequired

The unique name of the report plan. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

Body Params

ReportSettingobject

Contains detailed information about a report setting.

IdempotencyTokenstring

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

ReportDeliveryChannelobject

Contains information from your report plan about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

ReportPlanDescriptionstring

An optional description of the report plan with a maximum 1,024 characters.

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 PUT \
2     --url 'http://backup.{region}.amazonaws.com/audit/report-plans/{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}

PUT