---
title: "POST /audit/report-plans"
method: POST
path: "/audit/report-plans"
---

# POST /audit/report-plans

`POST /audit/report-plans`

Creates a report plan. A report plan is a document that contains information about the contents of the report and where Backup will deliver it.

If you call `CreateReportPlan` with a plan that already exists, you receive an `AlreadyExistsException` exception.

## Request body

- object
  - `ReportPlanName` string, required — The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
  - `ReportPlanDescription` string — An optional description of the report plan with a maximum of 1,024 characters.
  - `ReportDeliveryChannel` object, required — 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.
    - `S3BucketName` string — The unique name of the S3 bucket that receives your reports.
    - `S3KeyPrefix` string — The prefix for where Backup Audit Manager delivers your reports to Amazon S3. The prefix is this part of the following path: s3://your-bucket-name/<code>prefix</code>/Backup/us-west-2/year/month/day/report-name. If not specified, there is no prefix.
    - `Formats` String[] — A list of the format of your reports: <code>CSV</code>, <code>JSON</code>, or both. If not specified, the default format is <code>CSV</code>.
  - `ReportSetting` object, required — Contains detailed information about a report setting.
    - `ReportTemplate` string — <p>Identifies the report template for the report. Reports are built using a report template. The report templates are:</p> <p> <code>RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT</code> </p>
    - `FrameworkArns` String[] — The Amazon Resource Names (ARNs) of the frameworks a report covers.
    - `NumberOfFrameworks` integer — The number of frameworks a report covers.
    - `Accounts` String[] — These are the accounts to be included in the report.
    - `OrganizationUnits` String[] — These are the Organizational Units to be included in the report.
    - `Regions` String[] — These are the Regions to be included in the report.
  - `ReportPlanTags` object — Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
  - `IdempotencyToken` string — A customer-chosen string that you can use to distinguish between otherwise identical calls to <code>CreateReportPlanInput</code>. Retrying a successful request with the same idempotency token results in a success message with no action taken.

## Response `200`

Success

- CreateReportPlanOutput
  - `ReportPlanName` string — The unique name of the report plan.
  - `ReportPlanArn` string — An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
  - `CreationTime` string, date-time — The date and time a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationTime</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

## Other responses

- `480` — AlreadyExistsException
- `481` — LimitExceededException
- `482` — InvalidParameterValueException
- `483` — ServiceUnavailableException
- `484` — MissingParameterValueException

---

[API](https://skmtc.net/aws/apis/backup.md) · [All operations](https://skmtc.net/aws/apis/backup/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/backup/versions/386d8a5f8871/schema)