update_certificate_options ¶

update_certificate_options(
    certificate_arn: Arn,
    options: CertificateOptions,
    *,
    config_overrides: Optional[ACMClientConfig] = None,
) -> None

Updates certificate options. You can use this operation to change the domain validation method or specify whether to export your certificate. For more information, see Migrate from email to DNS validation and Certificate Manager Exportable Managed Certificates.

Parameters:

certificate_arn (Arn) –

ARN of the requested certificate to update. This must be of the form:

arn:aws:acm:us-east-1:account:certificate/12345678-1234-1234-1234-123456789012
options (CertificateOptions) –

Use to update the options for your certificate. Currently, you can change the domain validation method or specify whether to export your certificate. For more information about migrating from email to DNS validation, see Migrate from email to DNS validation.

Raises:

ConflictException –

You are trying to update a resource or configuration that is already being created or updated. Wait for the previous operation to finish and try again.
InvalidArnException –

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

Processing has reached an invalid state.
LimitExceededException –

An ACM quota has been exceeded.
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

def update_certificate_options(
    self,
    certificate_arn: "capo_acm.types.arn.Arn",
    options: "capo_acm.types.certificate_options.CertificateOptions",
    *,
    config_overrides: Optional[ACMClientConfig] = None,
) -> None:
    """<p>Updates certificate options. You can use this operation to change the domain validation method or specify whether to export your certificate. For more information, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/email-to-dns-migration.html">Migrate from email to DNS validation</a> and <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-exportable-certificates.html">Certificate Manager Exportable Managed Certificates</a>.</p>

    Args:
        certificate_arn: <p>ARN of the requested certificate to update. This must be of the form:</p> <p> <code>arn:aws:acm:us-east-1:<i>account</i>:certificate/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>
        options: <p>Use to update the options for your certificate. Currently, you can change the domain validation method or specify whether to export your certificate. For more information about migrating from email to DNS validation, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/email-to-dns-migration.html">Migrate from email to DNS validation</a>.</p>

    Raises:
        capo_acm.errors.conflict_exception.ConflictException: <p>You are trying to update a resource or configuration that is already being created or updated. Wait for the previous operation to finish and try again.</p>
        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.invalid_state_exception.InvalidStateException: <p>Processing has reached an invalid state.</p>
        capo_acm.errors.limit_exceeded_exception.LimitExceededException: <p>An ACM quota has been exceeded.</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.update_certificate_options_request.UpdateCertificateOptionsRequest]",
    ) -> OperationResponse[None]:
        import capo_acm._operations.certificate_manager.update_certificate_options

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateCertificateOptions")
    )
    input_: capo_acm.types.update_certificate_options_request.UpdateCertificateOptionsRequest = {
        "certificate_arn": certificate_arn,
        "options": options,
    }

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