v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1423146150.1 KB

Creates an audit report that lists every time that your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate actions use the private key.

Both Amazon Web Services Private CA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Access policies for CRLs in Amazon S3.

Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your Audit Reports.

You can generate a maximum of one report every 30 minutes.

post/#X-Amz-Target=ACMPrivateCA.CreateCertificateAuthorityAuditReport

Headers

X-Amz-Target'ACMPrivateCA.CreateCertificateAuthorityAuditReport' required

Request body

CertificateAuthorityArnstring required
<p>The Amazon Resource Name (ARN) of the CA to be audited. This is of the form:</p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>.</p>
S3BucketNamestring required

The name of the S3 bucket that will contain the audit report.

AuditReportResponseFormat'JSON' | 'CSV' required

The format in which to create the report. This can be either <b>JSON</b> or <b>CSV</b>.

Response

Success

AuditReportIdstring

An alphanumeric string that contains a report identifier.

S3Keystring

The <b>key</b> that uniquely identifies the report file in your S3 bucket.