Skip to content

describe_certificate_authority_audit_report

describe_certificate_authority_audit_report(
    certificate_authority_arn: Arn,
    audit_report_id: AuditReportId,
    *,
    config_overrides: Optional[ACMPCAClientConfig] = None,
) -> DescribeCertificateAuthorityAuditReportResponse

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.

Parameters:

  • certificate_authority_arn (Arn) –

    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 .

  • audit_report_id (AuditReportId) –

    The report ID returned by calling the CreateCertificateAuthorityAuditReport action.

Raises:

Source code in docs_src/capo_acm_pca/_services/acmpca.py
def describe_certificate_authority_audit_report(
    self,
    certificate_authority_arn: "capo_acm_pca.types.arn.Arn",
    audit_report_id: "capo_acm_pca.types.audit_report_id.AuditReportId",
    *,
    config_overrides: Optional[ACMPCAClientConfig] = None,
) -> "capo_acm_pca.types.describe_certificate_authority_audit_report_response.DescribeCertificateAuthorityAuditReportResponse":
    """<p>Lists information about a specific audit report created by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a> action. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html">IssueCertificate</a> action or the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_RevokeCertificate.html">RevokeCertificate</a> action. </p>

    Args:
        certificate_authority_arn: <p>The Amazon Resource Name (ARN) of the private CA. This must be 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>
        audit_report_id: <p>The report ID returned by calling the <a href="https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthorityAuditReport.html">CreateCertificateAuthorityAuditReport</a> action.</p>

    Raises:
        capo_acm_pca.errors.invalid_args_exception.InvalidArgsException: <p>One or more of the specified arguments was not valid.</p>
        capo_acm_pca.errors.invalid_arn_exception.InvalidArnException: <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
        capo_acm_pca.errors.resource_not_found_exception.ResourceNotFoundException: <p>A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.</p>
        capo_acm_pca.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_acm_pca.types.describe_certificate_authority_audit_report_request.DescribeCertificateAuthorityAuditReportRequest]",
    ) -> OperationResponse[
        "capo_acm_pca.types.describe_certificate_authority_audit_report_response.DescribeCertificateAuthorityAuditReportResponse"
    ]:
        import capo_acm_pca._operations.acm_private_ca.describe_certificate_authority_audit_report

        output, http_response = (
            capo_acm_pca._operations.acm_private_ca.describe_certificate_authority_audit_report.describe_certificate_authority_audit_report(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeCertificateAuthorityAuditReport"),
    )
    input_: capo_acm_pca.types.describe_certificate_authority_audit_report_request.DescribeCertificateAuthorityAuditReportRequest = {
        "certificate_authority_arn": certificate_authority_arn,
        "audit_report_id": audit_report_id,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output