ACMPCA / Client / describe_certificate_authority_audit_report

describe_certificate_authority_audit_report#

ACMPCA.Client.describe_certificate_authority_audit_report(**kwargs)#

Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport action. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the IssueCertificate action or the RevokeCertificate action.

See also: AWS API Documentation

Request Syntax

response = client.describe_certificate_authority_audit_report(
    CertificateAuthorityArn='string',
    AuditReportId='string'
)
Parameters:
  • CertificateAuthorityArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the private CA. This must be of the form:

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

  • AuditReportId (string) –

    [REQUIRED]

    The report ID returned by calling the CreateCertificateAuthorityAuditReport action.

Return type:

dict

Returns:

Response Syntax

{
    'AuditReportStatus': 'CREATING'|'SUCCESS'|'FAILED',
    'S3BucketName': 'string',
    'S3Key': 'string',
    'CreatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • AuditReportStatus (string) –

      Specifies whether report creation is in progress, has succeeded, or has failed.

    • S3BucketName (string) –

      Name of the S3 bucket that contains the report.

    • S3Key (string) –

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

    • CreatedAt (datetime) –

      The date and time at which the report was created.

Exceptions