Skip to content

ACM  >  Operations  >  revoke_certificate

revoke_certificate

Operation

revoke_certificate async

revoke_certificate(request: RevokeCertificateInput | RevokeCertificateInputDict, /, *, plugins: list[Plugin] | None = None) -> RevokeCertificateOutput
revoke_certificate(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[RevokeCertificateInputDict]) -> RevokeCertificateOutput

Revokes a public ACM certificate. You can only revoke certificates that have been previously exported.

Warning

Once a certificate is revoked, you cannot reuse the certificate. Revoking a certificate is permanent.

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
RevokeCertificateOutput

An instance of RevokeCertificateOutput.

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

RevokeCertificateInput dataclass

Bases: _SerdeShape

Dataclass for RevokeCertificateInput structure.

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

The Amazon Resource Name (ARN) of the public or private certificate that will be revoked. The ARN must have the following form:

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

revocation_reason class-attribute instance-attribute
revocation_reason: str | None = ...

Specifies why you revoked the certificate.

Dictionaries

RevokeCertificateInputDict

Bases: TypedDict

Dictionary form of RevokeCertificateInput.

Attributes
certificate_arn instance-attribute
certificate_arn: Required[str]

The Amazon Resource Name (ARN) of the public or private certificate that will be revoked. The ARN must have the following form:

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

revocation_reason instance-attribute
revocation_reason: Required[str]

Specifies why you revoked the certificate.

Output

RevokeCertificateOutput dataclass

Bases: _SerdeShape

Dataclass for RevokeCertificateOutput structure.

Attributes

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

The Amazon Resource Name (ARN) of the public or private certificate that was revoked.

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.