View Source AWS.ACM (aws-elixir v1.0.14)

Certificate Manager

You can use Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites and applications.

For more information about using ACM, see the Certificate Manager User Guide.

Link to this section Summary

Functions

Adds one or more tags to an ACM certificate.

Creates a domain validation for an ACME endpoint.

Creates an ACME endpoint, which is a managed ACME server with a unique endpoint URL.

Creates an external account binding (EAB) for an ACME endpoint.

Deletes a certificate and its associated private key.

Returns detailed metadata about the specified ACME account, including its status, public key thumbprint, and associated external account binding.

Returns detailed metadata about the specified domain validation, including its status, domain scope, and DNS resource records required for validation.

Returns detailed metadata about the specified ACME endpoint, including its status, URL, authorization behavior, and certificate authority configuration.

Returns detailed metadata about the specified external account binding, including the associated IAM role, expiration time, and usage history.

Returns detailed metadata about the specified ACM certificate.

Exports a private certificate issued by a private certificate authority (CA) or a public certificate for use anywhere.

Returns the account configuration options associated with an Amazon Web Services account.

Retrieves the key ID and MAC key credentials for an external account binding.

Retrieves a certificate and its certificate chain.

Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with ACM.

Retrieves a list of ACME accounts registered with the specified ACME endpoint.

Retrieves a list of domain validations for the specified ACME endpoint.

Retrieves a list of ACME endpoints in your account.

Retrieves a list of external account bindings for the specified ACME endpoint.

Retrieves a list of certificate ARNs and domain names.

Lists the tags that have been applied to the ACM certificate.

Lists the tags associated with an ACM resource.

Adds or modifies account-level configurations in ACM.

Remove one or more tags from an ACM certificate.

Requests an ACM certificate for use with other Amazon Web Services services.

Resends the email that requests domain ownership validation.

Revokes an ACME account, preventing it from requesting or revoking certificates.

Revokes an external account binding, preventing new ACME accounts from being registered using this binding.

Revokes a public ACM certificate.

Retrieves a list of certificates matching search criteria.

Adds one or more tags to an ACM resource.

Removes one or more tags from an ACM resource.

Updates the prevalidation configuration of an existing domain validation.

Updates the configuration of an existing ACME endpoint.

Link to this section Functions

Link to this function

add_tags_to_certificate(client, input, options \\ [])

View Source

Adds one or more tags to an ACM certificate.

Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a key and an optional value. You specify the certificate on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair.

This action applies only to the certificate resource type. For all other ACM resource types, use TagResource instead.

You can apply a tag to just one certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see Tagging ACM certificates.

To remove one or more tags, use the RemoveTagsFromCertificate action. To view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action.

Link to this function

create_acme_domain_validation(client, input, options \\ [])

View Source

Creates a domain validation for an ACME endpoint.

Domain validations authorize the endpoint to issue certificates for specified domain names. You configure prevalidation to prove domain ownership.

Link to this function

create_acme_endpoint(client, input, options \\ [])

View Source

Creates an ACME endpoint, which is a managed ACME server with a unique endpoint URL.

After creation, ACME clients can use the endpoint URL to automate certificate issuance using the ACME protocol.

Link to this function

create_acme_external_account_binding(client, input, options \\ [])

View Source

Creates an external account binding (EAB) for an ACME endpoint.

An EAB provides credentials that authorize an ACME client to register an account with the endpoint. Each EAB is associated with an IAM role that controls what certificate operations the ACME client can perform.

Link to this function

delete_acme_domain_validation(client, input, options \\ [])

View Source

Deletes a domain validation.

After deletion, the ACME endpoint can no longer issue certificates for the associated domain.

Link to this function

delete_acme_endpoint(client, input, options \\ [])

View Source

Deletes an ACME endpoint.

After deletion, the endpoint URL is no longer accessible and ACME clients cannot issue certificates through it. Any existing external account bindings and domain validations associated with the endpoint are also deleted.

Link to this function

delete_acme_external_account_binding(client, input, options \\ [])

View Source

Deletes an external account binding.

Previously fetched credentials for this binding will no longer be usable for account registration. A deleted binding cannot be recovered.

Link to this function

delete_certificate(client, input, options \\ [])

View Source

Deletes a certificate and its associated private key.

If this action succeeds, the certificate is not available for use by Amazon Web Services services integrated with ACM. Deleting a certificate is eventually consistent. The may be a short delay before the certificate no longer appears in the list that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action.

You cannot delete an ACM certificate that is being used by another Amazon Web Services service. To delete a certificate that is in use, you must first remove the certificate association using the console or the CLI for the associated service.

Deleting a certificate issued by a private certificate authority (CA) has no effect on the CA. You will continue to be charged for the CA until it is deleted. For more information, see Deleting Your Private CA in the Private Certificate Authority User Guide.

You cannot delete a certificate with a CertificateKeyPairOrigin of ACME. ACM automatically deletes these certificates 1 year after they expire.

Deleting a certificate issued by a private certificate authority (CA) has no effect on the CA. You will continue to be charged for the CA until it is deleted. For more information, see Deleting your private CA in the Amazon Web Services Private Certificate Authority User Guide.

Link to this function

describe_acme_account(client, input, options \\ [])

View Source

Returns detailed metadata about the specified ACME account, including its status, public key thumbprint, and associated external account binding.

Link to this function

describe_acme_domain_validation(client, input, options \\ [])

View Source

Returns detailed metadata about the specified domain validation, including its status, domain scope, and DNS resource records required for validation.

Link to this function

describe_acme_endpoint(client, input, options \\ [])

View Source

Returns detailed metadata about the specified ACME endpoint, including its status, URL, authorization behavior, and certificate authority configuration.

Link to this function

describe_acme_external_account_binding(client, input, options \\ [])

View Source

Returns detailed metadata about the specified external account binding, including the associated IAM role, expiration time, and usage history.

Link to this function

describe_certificate(client, input, options \\ [])

View Source

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.

Link to this function

export_certificate(client, input, options \\ [])

View Source

Exports a private certificate issued by a private certificate authority (CA) or a public certificate for use anywhere.

The exported file contains the certificate, the certificate chain, and the encrypted private key associated with the public key that is embedded in the certificate. For security, you must assign a passphrase for the private key when exporting it.

For information about exporting and formatting a certificate using the ACM console or CLI, see Export a private certificate and Export a public certificate.

ACM public certificates created prior to June 17, 2025 cannot be exported.

Link to this function

get_account_configuration(client, input, options \\ [])

View Source

Returns the account configuration options associated with an Amazon Web Services account.

Link to this function

get_acme_external_account_binding_credentials(client, input, options \\ [])

View Source

Retrieves the key ID and MAC key credentials for an external account binding.

These credentials are used by ACME clients during account registration to bind to the endpoint.

Link to this function

get_certificate(client, input, options \\ [])

View Source

Retrieves a certificate and its certificate chain.

The certificate may be either a public or private certificate issued using the ACM RequestCertificate action, or a certificate imported into ACM using the ImportCertificate action. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs. All of the certificates are base64 encoded. You can use OpenSSL to decode the certificates and inspect individual fields.

Link to this function

import_certificate(client, input, options \\ [])

View Source

Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with ACM.

Note that integrated services allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see Importing Certificates in the Certificate Manager User Guide.

ACM does not provide managed renewal for certificates that you import.

Note the following guidelines when importing third party certificates:

  • You must enter the private key that matches the certificate you are importing.

  • The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase.

  • The private key must be no larger than 5 KB (5,120 bytes).

  • The certificate, private key, and certificate chain must be PEM-encoded.

  • The current time must be between the Not Before and Not After certificate fields.

  • The Issuer field must not be empty.

  • The OCSP authority URL, if present, must not exceed 1000 characters.

  • To import a new certificate, omit the CertificateArn argument. Include this argument only when you want to replace a previously imported certificate.

  • When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the private key by their file names preceded by fileb://. For example, you can specify a certificate saved in the C: emp folder as fileb://C: empcertificate_to_import.pem. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs.

  • When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using.

  • The cryptographic algorithm of an imported certificate must match the algorithm of the signing CA. For example, if the signing CA key type is RSA, then the certificate key type must also be RSA.

This operation returns the Amazon Resource Name (ARN) of the imported certificate.

Link to this function

list_acme_accounts(client, input, options \\ [])

View Source

Retrieves a list of ACME accounts registered with the specified ACME endpoint.

ACME accounts are created when clients use external account binding credentials to register.

Link to this function

list_acme_domain_validations(client, input, options \\ [])

View Source

Retrieves a list of domain validations for the specified ACME endpoint.

Link to this function

list_acme_endpoints(client, input, options \\ [])

View Source

Retrieves a list of ACME endpoints in your account.

Use this operation to view all configured ACME endpoints and their current status.

Link to this function

list_acme_external_account_bindings(client, input, options \\ [])

View Source

Retrieves a list of external account bindings for the specified ACME endpoint.

Link to this function

list_certificates(client, input, options \\ [])

View Source

Retrieves a list of certificate ARNs and domain names.

You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate. Default filtering returns only RSA_2048 certificates. For more information, see Filters.

By default, this action does not return certificates with a CertificateKeyPairOrigin of ACME. To include ACME certificates, specify ACME in the CertificateKeyPairOrigins filter.

Link to this function

list_tags_for_certificate(client, input, options \\ [])

View Source

Lists the tags that have been applied to the ACM certificate.

Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM certificate, use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action.

This action applies only to the certificate resource type. For all other ACM resource types, use ListTagsForResource instead.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

Lists the tags associated with an ACM resource.

Use this action for all ACM resource types except the certificate resource type. For certificate resources, use ListTagsForCertificate instead.

To add one or more tags, use the TagResource action. To remove one or more tags, use the UntagResource action.

Link to this function

put_account_configuration(client, input, options \\ [])

View Source

Adds or modifies account-level configurations in ACM.

The supported configuration option is DaysBeforeExpiry. This option specifies the number of days prior to certificate expiration when ACM starts generating EventBridge events. ACM sends one event per day per certificate until the certificate expires. By default, accounts receive events starting 45 days before certificate expiration.

Link to this function

remove_tags_from_certificate(client, input, options \\ [])

View Source

Remove one or more tags from an ACM certificate.

A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value.

This action applies only to the certificate resource type. For all other ACM resource types, use UntagResource instead.

To add tags to a certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate action.

Link to this function

renew_certificate(client, input, options \\ [])

View Source

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.

Link to this function

request_certificate(client, input, options \\ [])

View Source

Requests an ACM certificate for use with other Amazon Web Services services.

To request an ACM certificate, you must specify a fully qualified domain name (FQDN) in the DomainName parameter. You can also specify additional FQDNs in the SubjectAlternativeNames parameter.

If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation or email validation. We recommend that you use DNS validation.

ACM behavior differs from the RFC 6125 specification of the certificate validation process. ACM first checks for a Subject Alternative Name, and, if it finds one, ignores the common name (CN).

After successful completion of the RequestCertificate action, there is a delay of several seconds before you can retrieve information about the new certificate.

Link to this function

resend_validation_email(client, input, options \\ [])

View Source

Resends the email that requests domain ownership validation.

The domain owner or an authorized representative must approve the ACM certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking I Approve. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate. For more information about setting up your contact email addresses, see Configure Email for your Domain.

Link to this function

revoke_acme_account(client, input, options \\ [])

View Source

Revokes an ACME account, preventing it from requesting or revoking certificates.

This operation is irreversible.

Link to this function

revoke_acme_external_account_binding(client, input, options \\ [])

View Source

Revokes an external account binding, preventing new ACME accounts from being registered using this binding.

Existing ACME accounts that were previously registered using the binding are not affected and must be revoked separately.

Link to this function

revoke_certificate(client, input, options \\ [])

View Source

Revokes a public ACM certificate.

You can only revoke certificates that have been previously exported.

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

Link to this function

search_certificates(client, input, options \\ [])

View Source

Retrieves a list of certificates matching search criteria.

You can filter certificates by X.509 attributes and ACM specific properties like certificate status, type and renewal eligibility. This operation provides more flexible filtering than ListCertificates by supporting complex filter statements.

Link to this function

tag_resource(client, input, options \\ [])

View Source

Adds one or more tags to an ACM resource.

Tags are labels that you can use to identify and organize your Amazon Web Services resources. Each tag consists of a key and an optional value.

Use this action for all ACM resource types except the certificate resource type. For certificate resources, use AddTagsToCertificate instead.

To remove one or more tags, use the UntagResource action. To view all of the tags that have been applied to a resource, use the ListTagsForResource action.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Removes one or more tags from an ACM resource.

Use this action for all ACM resource types except the certificate resource type. For certificate resources, use RemoveTagsFromCertificate instead.

To add one or more tags, use the TagResource action. To view all of the tags that have been applied to a resource, use the ListTagsForResource action.

Link to this function

update_acme_domain_validation(client, input, options \\ [])

View Source

Updates the prevalidation configuration of an existing domain validation.

Link to this function

update_acme_endpoint(client, input, options \\ [])

View Source

Updates the configuration of an existing ACME endpoint.

You can change the authorization behavior, contact requirement, or certificate authority settings.

Link to this function

update_certificate_options(client, input, options \\ [])

View Source

Updates a certificate.

You can use this function to specify whether to export your certificate. Certificate transparency logging opt-out is no longer available. For more information, see Certificate Transparency Logging and Certificate Manager Exportable Managed Certificates.