Skip to content

describe_certificate 

describe_certificate(
    certificate_arn: Arn, *, config_overrides: Optional[ACMClientConfig] = None
) -> DescribeCertificateResponse

Returns detailed metadata about the specified ACM certificate.

If you have just created a certificate using the RequestCertificate action, there is a delay of several seconds before you can retrieve information about it.

Parameters:

  • certificate_arn (Arn) –

    The Amazon Resource Name (ARN) of the ACM certificate. The ARN must have the following form:

    arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

    For more information about ARNs, see Amazon Resource Names (ARNs).

Raises:

  • InvalidArnException –

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

  • ResourceNotFoundException –

    The specified certificate cannot be found in the caller's account or the caller's account cannot be found.

  • ValidationException –

    The supplied input failed to satisfy constraints of an Amazon Web Services service.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_acm/_services/acm.py 
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
def describe_certificate(
    self,
    certificate_arn: "capo_acm.types.arn.Arn",
    *,
    config_overrides: Optional[ACMClientConfig] = None,
) -> "capo_acm.types.describe_certificate_response.DescribeCertificateResponse":
    """<p>Returns detailed metadata about the specified ACM certificate.</p> <p>If you have just created a certificate using the <code>RequestCertificate</code> action, there is a delay of several seconds before you can retrieve information about it.</p>

    Args:
        certificate_arn: <p>The Amazon Resource Name (ARN) of the ACM certificate. The ARN must have the following form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a>.</p>

    Raises:
        capo_acm.errors.invalid_arn_exception.InvalidArnException: <p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>
        capo_acm.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified certificate cannot be found in the caller's account or the caller's account cannot be found.</p>
        capo_acm.errors.validation_exception.ValidationException: <p>The supplied input failed to satisfy constraints of an Amazon Web Services service.</p>
        capo_acm.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_acm.types.describe_certificate_request.DescribeCertificateRequest]",
    ) -> OperationResponse[
        "capo_acm.types.describe_certificate_response.DescribeCertificateResponse"
    ]:
        import capo_acm._operations.certificate_manager.describe_certificate

        output, http_response = (
            capo_acm._operations.certificate_manager.describe_certificate.describe_certificate(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeCertificate")
    )
    input_: capo_acm.types.describe_certificate_request.DescribeCertificateRequest = {
        "certificate_arn": certificate_arn
    }

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