Skip to content

describe_certificate async

describe_certificate(
    certificate_arn: Arn, *, config_overrides: Optional[AsyncACMClientConfig] = 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/async_acm.py
async def describe_certificate(
    self,
    certificate_arn: "capo_acm.types.arn.Arn",
    *,
    config_overrides: Optional[AsyncACMClientConfig] = 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.
    """

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

        (
            output,
            http_response,
        ) = await capo_acm._operations.certificate_manager.describe_certificate.async_describe_certificate(
            req.options, req.input
        )
        return AsyncOperationResponse(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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output