Skip to content

ACM  >  Operations  >  renew_certificate

renew_certificate

Operation

renew_certificate async

renew_certificate(request: RenewCertificateInput | RenewCertificateInputDict, /, *, plugins: list[Plugin] | None = None) -> RenewCertificateOutput
renew_certificate(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[RenewCertificateInputDict]) -> RenewCertificateOutput

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:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
RenewCertificateOutput

An instance of RenewCertificateOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

RenewCertificateInput dataclass

Bases: _SerdeShape

Dataclass for RenewCertificateInput structure.

Attributes
certificate_arn class-attribute instance-attribute
certificate_arn: str | None = ...

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).

Dictionaries

RenewCertificateInputDict

Bases: TypedDict

Dictionary form of RenewCertificateInput.

Attributes
certificate_arn instance-attribute
certificate_arn: Required[str]

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).

Output

RenewCertificateOutput dataclass

Bases: _SerdeShape

Dataclass for RenewCertificateOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.