ACMPCA / Client / create_certificate_authority_audit_report

create_certificate_authority_audit_report

ACMPCA.Client.create_certificate_authority_audit_report(**kwargs)

Creates an audit report that lists every time that your CA private key is used to issue a certificate. The IssueCertificate and RevokeCertificate actions use the private key.

To save the audit report to your designated Amazon S3 bucket, you must create a bucket policy that grants Amazon Web Services Private CA permission to access and write to it. For an example policy, see Prepare an Amazon S3 bucket for audit reports.

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.

Note

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

See also: AWS API Documentation

Request Syntax

response = client.create_certificate_authority_audit_report(
    CertificateAuthorityArn='string',
    S3BucketName='string',
    AuditReportResponseFormat='JSON'|'CSV'
)

Parameters:

• CertificateAuthorityArn (string) –

  [REQUIRED]

  The 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 ``.

• S3BucketName (string) –

  [REQUIRED]

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

• AuditReportResponseFormat (string) –

  [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'AuditReportId': 'string',
    'S3Key': 'string'
}

Response Structure

• (dict) –

  • AuditReportId (string) –

    An alphanumeric string that contains a report identifier.

  • S3Key (string) –

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

Exceptions

• ACMPCA.Client.exceptions.ResourceNotFoundException

• ACMPCA.Client.exceptions.InvalidArnException

• ACMPCA.Client.exceptions.InvalidArgsException

• ACMPCA.Client.exceptions.RequestFailedException

• ACMPCA.Client.exceptions.InvalidStateException

• ACMPCA.Client.exceptions.RequestInProgressException