AWS Certificate Manager Private Certificate Authority
AWS Private Certificate Authority Documentation (API Version 2017-08-22)

CreateCertificateAuthorityAuditReport

Creates an audit report that lists every time that the your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate operations use the private key. You can generate a new report every 30 minutes.

Request Syntax

{ "AuditReportResponseFormat": "string", "CertificateAuthorityArn": "string", "S3BucketName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AuditReportResponseFormat

Format in which to create the report. This can be either JSON or CSV.

Type: String

Valid Values: JSON | CSV

Required: Yes

CertificateAuthorityArn

Amazon Resource Name (ARN) of the CA to be audited. This is of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

Type: String

Length Constraints: Minimum length of 5. Maximum length of 200.

Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:[\w+=/,.@-]*:[0-9]+:[\w+=,.@-]+(/[\w+=/,.@-]+)*

Required: Yes

S3BucketName

Name of the S3 bucket that will contain the audit report.

Type: String

Required: Yes

Response Syntax

{ "AuditReportId": "string", "S3Key": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AuditReportId

An alphanumeric string that contains a report identifier.

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}

S3Key

The key that uniquely identifies the report file in your S3 bucket.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidArgsException

One or more of the specified arguments was not valid.

HTTP Status Code: 400

InvalidArnException

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

HTTP Status Code: 400

InvalidStateException

The private CA is in a state during which a report cannot be generated.

HTTP Status Code: 400

RequestFailedException

The request has failed for an unspecified reason.

HTTP Status Code: 400

RequestInProgressException

Your request is already in progress.

HTTP Status Code: 400

ResourceNotFoundException

A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.

HTTP Status Code: 400

Examples

Example

Sample Request

POST / HTTP/1.1 Host: acm-pca.amazonaws.com Accept-Encoding: identity Content-Length: 216 X-Amz-Target: ACMPrivateCA.CreateCertificateAuthorityAuditReport X-Amz-Date: 20180226T184819Z User-Agent: aws-cli/1.14.28 Python/2.7.9 Windows/8 botocore/1.8.32 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AWS_Access_Key_ID/20180226/AWS_Region/acm-pca/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=62380db816189148e510734f0ef2bfec08248fb3f447f64d740f31757e1beda0 { "AuditReportResponseFormat": "JSON", "S3BucketName": "your-bucket-name", "CertificateAuthorityArn": "arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012" }

Example

Sample Response

HTTP/1.1 200 OK Date: Tue, 15 May 2018 16:29:03 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 158 x-amzn-RequestId: e8516078-ff66-4e2a-bc38-eb1aaae2d886 Connection: keep-alive { "AuditReportId": "9654b603-d6a9-4c57-952a-ebcc95631fab", "S3Key": "audit-reportPCA_ID/9654b603-d6a9-4c57-952a-ebcc95631fab.json" }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: