renew_certificate `async` ¶

renew_certificate(
    certificate_arn: Arn, *, config_overrides: Optional[AsyncACMClientConfig] = None
) -> None

Renews an eligible ACM certificate. In order to renew your Amazon Web Services Private CA certificates with ACM, you must first grant the ACM service principal permission to do so. For more information, see Testing Managed Renewal in the ACM User Guide.

Parameters:

certificate_arn (Arn) –

String that contains the ARN of the ACM certificate to be renewed. This must be of the 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.
RequestInProgressException –

The certificate request is in process and the certificate in your account has not yet been issued.
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 renew_certificate(
    self,
    certificate_arn: "capo_acm.types.arn.Arn",
    *,
    config_overrides: Optional[AsyncACMClientConfig] = None,
) -> None:
    """<p>Renews an <a href="https://docs.aws.amazon.com/acm/latest/userguide/managed-renewal.html">eligible ACM certificate</a>. In order to renew your Amazon Web Services Private CA certificates with ACM, you must first <a href="https://docs.aws.amazon.com/privateca/latest/userguide/assign-permissions.html#PcaPermissions">grant the ACM service principal permission to do so</a>. For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/managed-renewal.html">Testing Managed Renewal</a> in the ACM User Guide.</p>

    Args:
        certificate_arn: <p>String that contains the ARN of the ACM certificate to be renewed. This must be of the 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.request_in_progress_exception.RequestInProgressException: <p>The certificate request is in process and the certificate in your account has not yet been issued.</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.renew_certificate_request.RenewCertificateRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_acm._operations.certificate_manager.renew_certificate

        (
            output,
            http_response,
        ) = await capo_acm._operations.certificate_manager.renew_certificate.async_renew_certificate(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("RenewCertificate")
    )
    input_: capo_acm.types.renew_certificate_request.RenewCertificateRequest = {
        "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

renew_certificate async ¶

renew_certificate `async` ¶