Icon

AWS Certificate Manager (version v1.*.*)

add_tags_to_certificate

Adds one or more tags to an ACM certificate. Tags are labels that you can use to identify and organize your AWS 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.
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.

Parameters

$body

Type: object

{
"Tags" : [ {
"Value" : "The value of the tag.",
"Key" : "The key of the tag."
} ],
"CertificateArn" : "String that contains the ARN of the ACM certificate to which the tag is to be applied. This must be of the form: \n arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 \nFor more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces. "
}

delete_certificate

Deletes a certificate and its associated private key. If this action succeeds, 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. The certificate will not be available for use by AWS services integrated with ACM.
You cannot delete an ACM certificate that is being used by another AWS service. To delete a certificate that is in use, the certificate association must first be removed.

Parameters

$body

Type: object

{
"CertificateArn" : "String that contains the ARN of the ACM certificate to be deleted. This must be of the form: \n arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 \nFor more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces."
}

describe_certificate

Returns detailed metadata about the specified ACM certificate.

Parameters

$body

Type: object

{
"CertificateArn" : "The Amazon Resource Name (ARN) of the ACM certificate. The ARN must have the following form: \n arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 \nFor more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces."
}

export_certificate

Exports a private certificate issued by a private certificate authority (CA) for use anywhere. You can export the certificate, the certificate chain, and the encrypted private key associated with the public key embedded in the certificate. You must store the private key securely. The private key is a 2048 bit RSA key. You must provide a passphrase for the private key when exporting it. You can use the following OpenSSL command to decrypt it later. Provide the passphrase when prompted.
openssl rsa -in encrypted_key.pem -out decrypted_key.pem

Parameters

$body

Type: object

{
"Passphrase" : "Passphrase to associate with the encrypted exported private key. If you want to later decrypt the private key, you must have the passphrase. You can use the following OpenSSL command to decrypt a private key: \n openssl rsa -in encrypted_key.pem -out decrypted_key.pem ",
"CertificateArn" : "An Amazon Resource Name (ARN) of the issued certificate. This must be of the form: \n arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 "
}

get_certificate

Retrieves a certificate specified by an ARN and its certificate chain . The chain is an ordered list of certificates that contains the end entity certificate, intermediate certificates of subordinate CAs, and the root certificate in that order. The certificate and certificate chain are base64 encoded. If you want to decode the certificate to see the individual fields, you can use OpenSSL.

Parameters

$body

Type: object

{
"CertificateArn" : "String that contains a certificate ARN in the following format: \n arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 \nFor more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces."
}

import_certificate

Imports a certificate into AWS 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 AWS 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.
If the certificate you are importing is not self-signed, you must enter its certificate chain.
If a certificate chain is included, the issuer must be the subject of one of the certificates in the chain.
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 file://. For example, you can specify a certificate saved in the C:\temp folder as file://C:\temp\certificate_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.
This operation returns the Amazon Resource Name (ARN) of the imported certificate.

Parameters

$body

Type: object

{
"PrivateKey" : "The private key that matches the public key in the certificate.",
"CertificateChain" : "The PEM encoded certificate chain.",
"CertificateArn" : "The Amazon Resource Name (ARN) of an imported certificate to replace. To import a new certificate, omit this field. ",
"Certificate" : "The certificate to import."
}

list_certificates

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.

Parameters

$body

Type: object

{
"Includes" : {
"keyUsage" : [ "string. Possible values: DIGITAL_SIGNATURE | NON_REPUDIATION | KEY_ENCIPHERMENT | DATA_ENCIPHERMENT | KEY_AGREEMENT | CERTIFICATE_SIGNING | CRL_SIGNING | ENCIPHER_ONLY | DECIPHER_ONLY | ANY | CUSTOM" ],
"extendedKeyUsage" : [ "string. Possible values: TLS_WEB_SERVER_AUTHENTICATION | TLS_WEB_CLIENT_AUTHENTICATION | CODE_SIGNING | EMAIL_PROTECTION | TIME_STAMPING | OCSP_SIGNING | IPSEC_END_SYSTEM | IPSEC_TUNNEL | IPSEC_USER | ANY | NONE | CUSTOM" ],
"keyTypes" : [ "string. Possible values: RSA_2048 | RSA_1024 | RSA_4096 | EC_prime256v1 | EC_secp384r1 | EC_secp521r1" ]
},
"CertificateStatuses" : [ "string. Possible values: PENDING_VALIDATION | ISSUED | INACTIVE | EXPIRED | VALIDATION_TIMED_OUT | REVOKED | FAILED" ]
}

list_tags_for_certificate

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.

Parameters

$body

Type: object

{
"CertificateArn" : "String that contains the ARN of the ACM certificate for which you want to list the tags. This must have the following form: \n arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 \nFor more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces. "
}

remove_tags_from_certificate

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

Parameters

$body

Type: object

{
"Tags" : [ {
"Value" : "The value of the tag.",
"Key" : "The key of the tag."
} ],
"CertificateArn" : "String that contains the ARN of the ACM Certificate with one or more tags that you want to remove. This must be of the form: \n arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 \nFor more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces. "
}

renew_certificate

Renews an eligable ACM certificate. At this time, only exported private certificates can be renewed with this operation. In order to renew your ACM PCA 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

$body

Type: object

{
"CertificateArn" : "String that contains the ARN of the ACM certificate to be renewed. This must be of the form: \n arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012 \nFor more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces."
}

request_certificate

Requests an ACM certificate for use with other AWS 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 issues public certificates after receiving approval from the domain owner.

Parameters

$body

Type: object

{
"IdempotencyToken" : "Customer chosen string that can be used to distinguish between calls to RequestCertificate. Idempotency tokens time out after one hour. Therefore, if you call RequestCertificate multiple times with the same idempotency token within one hour, ACM recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, ACM recognizes that you are requesting multiple certificates.",
"Options" : {
"CertificateTransparencyLoggingPreference" : "You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED. "
},
"CertificateAuthorityArn" : "The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate. For more information about private CAs, see the AWS Certificate Manager Private Certificate Authority (PCA) user guide. The ARN must have the following form: \n arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 ",
"DomainValidationOptions" : [ {
"DomainName" : "A fully qualified domain name (FQDN) in the certificate request.",
"ValidationDomain" : "The domain name that you want ACM to use to send you validation emails. This domain name is the suffix of the email addresses that you want ACM to use. This must be the same as the DomainName value or a superdomain of the DomainName value. For example, if you request a certificate for testing.example.com, you can specify example.com for this value. In that case, ACM sends domain validation emails to the following five addresses: \n admin@example.com \n administrator@example.com \n hostmaster@example.com \n postmaster@example.com \n webmaster@example.com "
} ],
"DomainName" : " Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com. \n The first domain name you enter cannot exceed 63 octets, including periods. Each subsequent Subject Alternative Name (SAN), however, can be up to 253 octets in length. ",
"ValidationMethod" : "The method you want to use if you are requesting a public certificate to validate that you own or control domain. You can validate with DNS or validate with email. We recommend that you use DNS validation. ",
"SubjectAlternativeNames" : [ "string" ]
}

resend_validation_email

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.

Parameters

$body

Type: object

{
"Domain" : "The fully qualified domain name (FQDN) of the certificate that needs to be validated.",
"ValidationDomain" : "The base validation domain that will act as the suffix of the email addresses that are used to send the emails. This must be the same as the Domain value or a superdomain of the Domain value. For example, if you requested a certificate for site.subdomain.example.com and specify a ValidationDomain of subdomain.example.com, ACM sends email to the domain registrant, technical contact, and administrative contact in WHOIS and the following five addresses: \n admin@subdomain.example.com \n administrator@subdomain.example.com \n hostmaster@subdomain.example.com \n postmaster@subdomain.example.com \n webmaster@subdomain.example.com ",
"CertificateArn" : "String that contains the ARN of the requested certificate. The certificate ARN is generated and returned by the RequestCertificate action as soon as the request is made. By default, using this parameter causes email to be sent to all top-level domains you specified in the certificate request. The ARN must be of the form: \n arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012 "
}

update_certificate_options

Updates a certificate. Currently, you can use this function to specify whether to opt in to or out of recording your certificate in a certificate transparency log. For more information, see Opting Out of Certificate Transparency Logging.

Parameters

$body

Type: object

{
"Options" : {
"CertificateTransparencyLoggingPreference" : "You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED. "
},
"CertificateArn" : "ARN of the requested certificate to update. This must be of the form: \n arn:aws:acm:us-east-1:account:certificate/12345678-1234-1234-1234-123456789012 "
}