Table of Contents
A low-level client representing AWS Certificate Manager (ACM)
You can use Amazon Web Services 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 Amazon Web Services Certificate Manager User Guide .
import boto3
client = boto3.client('acm')
These are the available methods:
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.
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.
See also: AWS API Documentation
Request Syntax
response = client.add_tags_to_certificate(
CertificateArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
String that contains the ARN of the ACM certificate to which the tag is to be applied. 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) .
[REQUIRED]
The key-value pair that defines the tag. The tag value is optional.
A key-value pair that identifies or specifies metadata about an ACM resource.
The key of the tag.
The value of the tag.
None
Exceptions
Check if an operation can be paginated.
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 Amazon Web Services services integrated with ACM.
Note
You cannot delete an ACM certificate that is being used by another Amazon Web Services service. To delete a certificate that is in use, the certificate association must first be removed.
See also: AWS API Documentation
Request Syntax
response = client.delete_certificate(
CertificateArn='string'
)
[REQUIRED]
String that contains the ARN of the ACM certificate to be deleted. 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) .
Exceptions
Returns detailed metadata about the specified ACM certificate.
See also: AWS API Documentation
Request Syntax
response = client.describe_certificate(
CertificateArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the ACM certificate. The ARN must have the following form:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs) .
{
'Certificate': {
'CertificateArn': 'string',
'DomainName': 'string',
'SubjectAlternativeNames': [
'string',
],
'DomainValidationOptions': [
{
'DomainName': 'string',
'ValidationEmails': [
'string',
],
'ValidationDomain': 'string',
'ValidationStatus': 'PENDING_VALIDATION'|'SUCCESS'|'FAILED',
'ResourceRecord': {
'Name': 'string',
'Type': 'CNAME',
'Value': 'string'
},
'ValidationMethod': 'EMAIL'|'DNS'
},
],
'Serial': 'string',
'Subject': 'string',
'Issuer': 'string',
'CreatedAt': datetime(2015, 1, 1),
'IssuedAt': datetime(2015, 1, 1),
'ImportedAt': datetime(2015, 1, 1),
'Status': 'PENDING_VALIDATION'|'ISSUED'|'INACTIVE'|'EXPIRED'|'VALIDATION_TIMED_OUT'|'REVOKED'|'FAILED',
'RevokedAt': datetime(2015, 1, 1),
'RevocationReason': 'UNSPECIFIED'|'KEY_COMPROMISE'|'CA_COMPROMISE'|'AFFILIATION_CHANGED'|'SUPERCEDED'|'CESSATION_OF_OPERATION'|'CERTIFICATE_HOLD'|'REMOVE_FROM_CRL'|'PRIVILEGE_WITHDRAWN'|'A_A_COMPROMISE',
'NotBefore': datetime(2015, 1, 1),
'NotAfter': datetime(2015, 1, 1),
'KeyAlgorithm': 'RSA_1024'|'RSA_2048'|'RSA_3072'|'RSA_4096'|'EC_prime256v1'|'EC_secp384r1'|'EC_secp521r1',
'SignatureAlgorithm': 'string',
'InUseBy': [
'string',
],
'FailureReason': 'NO_AVAILABLE_CONTACTS'|'ADDITIONAL_VERIFICATION_REQUIRED'|'DOMAIN_NOT_ALLOWED'|'INVALID_PUBLIC_DOMAIN'|'DOMAIN_VALIDATION_DENIED'|'CAA_ERROR'|'PCA_LIMIT_EXCEEDED'|'PCA_INVALID_ARN'|'PCA_INVALID_STATE'|'PCA_REQUEST_FAILED'|'PCA_NAME_CONSTRAINTS_VALIDATION'|'PCA_RESOURCE_NOT_FOUND'|'PCA_INVALID_ARGS'|'PCA_INVALID_DURATION'|'PCA_ACCESS_DENIED'|'SLR_NOT_FOUND'|'OTHER',
'Type': 'IMPORTED'|'AMAZON_ISSUED'|'PRIVATE',
'RenewalSummary': {
'RenewalStatus': 'PENDING_AUTO_RENEWAL'|'PENDING_VALIDATION'|'SUCCESS'|'FAILED',
'DomainValidationOptions': [
{
'DomainName': 'string',
'ValidationEmails': [
'string',
],
'ValidationDomain': 'string',
'ValidationStatus': 'PENDING_VALIDATION'|'SUCCESS'|'FAILED',
'ResourceRecord': {
'Name': 'string',
'Type': 'CNAME',
'Value': 'string'
},
'ValidationMethod': 'EMAIL'|'DNS'
},
],
'RenewalStatusReason': 'NO_AVAILABLE_CONTACTS'|'ADDITIONAL_VERIFICATION_REQUIRED'|'DOMAIN_NOT_ALLOWED'|'INVALID_PUBLIC_DOMAIN'|'DOMAIN_VALIDATION_DENIED'|'CAA_ERROR'|'PCA_LIMIT_EXCEEDED'|'PCA_INVALID_ARN'|'PCA_INVALID_STATE'|'PCA_REQUEST_FAILED'|'PCA_NAME_CONSTRAINTS_VALIDATION'|'PCA_RESOURCE_NOT_FOUND'|'PCA_INVALID_ARGS'|'PCA_INVALID_DURATION'|'PCA_ACCESS_DENIED'|'SLR_NOT_FOUND'|'OTHER',
'UpdatedAt': datetime(2015, 1, 1)
},
'KeyUsages': [
{
'Name': 'DIGITAL_SIGNATURE'|'NON_REPUDIATION'|'KEY_ENCIPHERMENT'|'DATA_ENCIPHERMENT'|'KEY_AGREEMENT'|'CERTIFICATE_SIGNING'|'CRL_SIGNING'|'ENCIPHER_ONLY'|'DECIPHER_ONLY'|'ANY'|'CUSTOM'
},
],
'ExtendedKeyUsages': [
{
'Name': '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',
'OID': 'string'
},
],
'CertificateAuthorityArn': 'string',
'RenewalEligibility': 'ELIGIBLE'|'INELIGIBLE',
'Options': {
'CertificateTransparencyLoggingPreference': 'ENABLED'|'DISABLED'
}
}
}
Response Structure
Metadata about an ACM certificate.
The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference .
The fully qualified domain name for the certificate, such as www.example.com or example.com.
One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.
Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED .
Contains information about the validation of each domain name in the certificate.
A fully qualified domain name (FQDN) in the certificate. For example, www.example.com or example.com .
A list of email addresses that ACM used to send domain validation emails.
The domain name that ACM used to send domain validation emails.
The validation status of the domain name. This can be one of the following values:
Contains the CNAME record that you add to your DNS database for domain validation. For more information, see Use DNS to Validate Domain Ownership .
Note: The CNAME information that you need does not include the name of your domain. If you include your domain name in the DNS database CNAME record, validation fails. For example, if the name is "_a79865eb4cd1a6ab990a45779b4e0b96.yourdomain.com", only "_a79865eb4cd1a6ab990a45779b4e0b96" must be used.
The name of the DNS record to create in your domain. This is supplied by ACM.
The type of DNS record. Currently this can be CNAME .
The value of the CNAME record to add to your DNS database. This is supplied by ACM.
Specifies the domain validation method.
The serial number of the certificate.
The name of the entity that is associated with the public key contained in the certificate.
The name of the certificate authority that issued and signed the certificate.
The time at which the certificate was requested.
The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED .
The date and time at which the certificate was imported. This value exists only when the certificate type is IMPORTED .
The status of the certificate.
The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED .
The reason the certificate was revoked. This value exists only when the certificate status is REVOKED .
The time before which the certificate is not valid.
The time after which the certificate is not valid.
The algorithm that was used to generate the public-private key pair.
The algorithm that was used to sign the certificate.
A list of ARNs for the Amazon Web Services resources that are using the certificate. A certificate can be used by multiple Amazon Web Services resources.
The reason the certificate request failed. This value exists only when the certificate status is FAILED . For more information, see Certificate Request Failed in the Amazon Web Services Certificate Manager User Guide .
The source of the certificate. For certificates provided by ACM, this value is AMAZON_ISSUED . For certificates that you imported with ImportCertificate , this value is IMPORTED . ACM does not provide managed renewal for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see Importing Certificates in the Amazon Web Services Certificate Manager User Guide .
Contains information about the status of ACM's managed renewal for the certificate. This field exists only when the certificate type is AMAZON_ISSUED .
The status of ACM's managed renewal of the certificate.
Contains information about the validation of each domain name in the certificate, as it pertains to ACM's managed renewal . This is different from the initial validation that occurs as a result of the RequestCertificate request. This field exists only when the certificate type is AMAZON_ISSUED .
Contains information about the validation of each domain name in the certificate.
A fully qualified domain name (FQDN) in the certificate. For example, www.example.com or example.com .
A list of email addresses that ACM used to send domain validation emails.
The domain name that ACM used to send domain validation emails.
The validation status of the domain name. This can be one of the following values:
Contains the CNAME record that you add to your DNS database for domain validation. For more information, see Use DNS to Validate Domain Ownership .
Note: The CNAME information that you need does not include the name of your domain. If you include your domain name in the DNS database CNAME record, validation fails. For example, if the name is "_a79865eb4cd1a6ab990a45779b4e0b96.yourdomain.com", only "_a79865eb4cd1a6ab990a45779b4e0b96" must be used.
The name of the DNS record to create in your domain. This is supplied by ACM.
The type of DNS record. Currently this can be CNAME .
The value of the CNAME record to add to your DNS database. This is supplied by ACM.
Specifies the domain validation method.
The reason that a renewal request was unsuccessful.
The time at which the renewal summary was last updated.
A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.
The Key Usage X.509 v3 extension defines the purpose of the public key contained in the certificate.
A string value that contains a Key Usage extension name.
Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).
The Extended Key Usage X.509 v3 extension defines one or more purposes for which the public key can be used. This is in addition to or in place of the basic purposes specified by the Key Usage extension.
The name of an Extended Key Usage value.
An object identifier (OID) for the extension value. OIDs are strings of numbers separated by periods. The following OIDs are defined in RFC 3280 and RFC 5280.
The Amazon Resource Name (ARN) of the ACM PCA private certificate authority (CA) that issued the certificate. This has the following format:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.
Value that specifies whether to add the certificate to a transparency log. Certificate transparency makes it possible to detect SSL certificates that have been mistakenly or maliciously issued. A browser might respond to certificate that has not been logged by showing an error message. The logs are cryptographically secure.
You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED .
Exceptions
Exports a private certificate issued by a private certificate authority (CA) for use anywhere. The exported file contains the certificate, the certificate chain, and the encrypted private 2048-bit RSA 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 .
See also: AWS API Documentation
Request Syntax
response = client.export_certificate(
CertificateArn='string',
Passphrase=b'bytes'
)
[REQUIRED]
An Amazon Resource Name (ARN) of the issued certificate. This must be of the form:
arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012
[REQUIRED]
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:
openssl rsa -in encrypted_key.pem -out decrypted_key.pem
dict
Response Syntax
{
'Certificate': 'string',
'CertificateChain': 'string',
'PrivateKey': 'string'
}
Response Structure
(dict) --
Certificate (string) --
The base64 PEM-encoded certificate.
CertificateChain (string) --
The base64 PEM-encoded certificate chain. This does not include the certificate that you are exporting.
PrivateKey (string) --
The encrypted private key associated with the public key in the certificate. The key is output in PKCS #8 format and is base64 PEM-encoded.
Exceptions
Returns the account configuration options associated with an Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.get_account_configuration()
{
'ExpiryEvents': {
'DaysBeforeExpiry': 123
}
}
Response Structure
Expiration events configuration options associated with the Amazon Web Services account.
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.
Exceptions
Retrieves an Amazon-issued certificate and its certificate chain. 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.
See also: AWS API Documentation
Request Syntax
response = client.get_certificate(
CertificateArn='string'
)
[REQUIRED]
String that contains a certificate ARN in the following format:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs) .
{
'Certificate': 'string',
'CertificateChain': 'string'
}
Response Structure
The ACM-issued certificate corresponding to the ARN specified as input.
Certificates forming the requested certificate's chain of trust. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs.
Exceptions
Create a paginator for an operation.
Returns an object that can wait for some condition.
Imports a certificate into Amazon Web Services 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 Amazon Web Services Certificate Manager User Guide .
Note
ACM does not provide managed renewal for certificates that you import.
Note the following guidelines when importing third party certificates:
This operation returns the Amazon Resource Name (ARN) of the imported certificate.
See also: AWS API Documentation
Request Syntax
response = client.import_certificate(
CertificateArn='string',
Certificate=b'bytes',
PrivateKey=b'bytes',
CertificateChain=b'bytes',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The certificate to import.
[REQUIRED]
The private key that matches the public key in the certificate.
One or more resource tags to associate with the imported certificate.
Note: You cannot apply tags when reimporting a certificate.
A key-value pair that identifies or specifies metadata about an ACM resource.
The key of the tag.
The value of the tag.
dict
Response Syntax
{
'CertificateArn': 'string'
}
Response Structure
(dict) --
CertificateArn (string) --
The Amazon Resource Name (ARN) of the imported certificate.
Exceptions
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 .
See also: AWS API Documentation
Request Syntax
response = client.list_certificates(
CertificateStatuses=[
'PENDING_VALIDATION'|'ISSUED'|'INACTIVE'|'EXPIRED'|'VALIDATION_TIMED_OUT'|'REVOKED'|'FAILED',
],
Includes={
'extendedKeyUsage': [
'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',
],
'keyUsage': [
'DIGITAL_SIGNATURE'|'NON_REPUDIATION'|'KEY_ENCIPHERMENT'|'DATA_ENCIPHERMENT'|'KEY_AGREEMENT'|'CERTIFICATE_SIGNING'|'CRL_SIGNING'|'ENCIPHER_ONLY'|'DECIPHER_ONLY'|'ANY'|'CUSTOM',
],
'keyTypes': [
'RSA_1024'|'RSA_2048'|'RSA_3072'|'RSA_4096'|'EC_prime256v1'|'EC_secp384r1'|'EC_secp521r1',
]
},
NextToken='string',
MaxItems=123
)
Filter the certificate list by status value.
Filter the certificate list. For more information, see the Filters structure.
Specify one or more ExtendedKeyUsage extension values.
Specify one or more KeyUsage extension values.
Specify one or more algorithms that can be used to generate key pairs.
Default filtering returns only RSA_1024 and RSA_2048 certificates that have at least one domain. To return other certificate types, provide the desired type signatures in a comma-separated list. For example, "keyTypes": ["RSA_2048,RSA_4096"] returns both RSA_2048 and RSA_4096 certificates.
dict
Response Syntax
{
'NextToken': 'string',
'CertificateSummaryList': [
{
'CertificateArn': 'string',
'DomainName': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
When the list is truncated, this value is present and contains the value to use for the NextToken parameter in a subsequent pagination request.
CertificateSummaryList (list) --
A list of ACM certificates.
(dict) --
This structure is returned in the response object of ListCertificates action.
CertificateArn (string) --
Amazon Resource Name (ARN) of the certificate. This is of the form:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs) .
DomainName (string) --
Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_certificate(
CertificateArn='string'
)
[REQUIRED]
String that contains the ARN of the ACM certificate for which you want to list the tags. This must have the following form:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs) .
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
The key-value pairs that define the applied tags.
A key-value pair that identifies or specifies metadata about an ACM resource.
The key of the tag.
The value of the tag.
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.put_account_configuration(
ExpiryEvents={
'DaysBeforeExpiry': 123
},
IdempotencyToken='string'
)
Specifies expiration events associated with an account.
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.
[REQUIRED]
Customer-chosen string used to distinguish between calls to PutAccountConfiguration . Idempotency tokens time out after one hour. If you call PutAccountConfiguration multiple times with the same unexpired idempotency token, ACM treats it as the same request and returns the original result. If you change the idempotency token for each call, ACM treats each call as a new request.
None
Exceptions
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.
See also: AWS API Documentation
Request Syntax
response = client.remove_tags_from_certificate(
CertificateArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
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:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs) .
[REQUIRED]
The key-value pair that defines the tag to remove.
A key-value pair that identifies or specifies metadata about an ACM resource.
The key of the tag.
The value of the tag.
None
Exceptions
Renews an eligible 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.
See also: AWS API Documentation
Request Syntax
response = client.renew_certificate(
CertificateArn='string'
)
[REQUIRED]
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) .
Exceptions
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 issues public certificates after receiving approval from the domain owner.
Note
ACM behavior differs from the https://tools.ietf.org/html/rfc6125#appendix-B.2 RFC 6125 specification of the certificate validation process. first checks for a subject alternative name, and, if it finds one, ignores the common name (CN)
See also: AWS API Documentation
Request Syntax
response = client.request_certificate(
DomainName='string',
ValidationMethod='EMAIL'|'DNS',
SubjectAlternativeNames=[
'string',
],
IdempotencyToken='string',
DomainValidationOptions=[
{
'DomainName': 'string',
'ValidationDomain': 'string'
},
],
Options={
'CertificateTransparencyLoggingPreference': 'ENABLED'|'DISABLED'
},
CertificateAuthorityArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
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.
The first domain name you enter cannot exceed 64 octets, including periods. Each subsequent Subject Alternative Name (SAN), however, can be up to 253 octets in length.
Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, add the name www.example.net to a certificate for which the DomainName field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM certificate is 100. However, the initial quota is 10 domain names. If you need more than 10 names, you must request a quota increase. For more information, see Quotas .
The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples:
The domain name that you want ACM to use to send you emails so that you can validate domain ownership.
Contains information about the domain names that you want ACM to use to send you emails that enable you to validate domain ownership.
A fully qualified domain name (FQDN) in the certificate request.
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:
Currently, you can use this parameter to specify whether to add the certificate to a certificate transparency log. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser. For more information, see Opting Out of Certificate Transparency Logging .
You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED .
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 Amazon Web Services Certificate Manager Private Certificate Authority (PCA) user guide. The ARN must have the following form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
One or more resource tags to associate with the certificate.
A key-value pair that identifies or specifies metadata about an ACM resource.
The key of the tag.
The value of the tag.
dict
Response Syntax
{
'CertificateArn': 'string'
}
Response Structure
(dict) --
CertificateArn (string) --
String that contains the ARN of the issued certificate. This must be of the form:
arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
Exceptions
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 .
See also: AWS API Documentation
Request Syntax
response = client.resend_validation_email(
CertificateArn='string',
Domain='string',
ValidationDomain='string'
)
[REQUIRED]
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:
arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
[REQUIRED]
The fully qualified domain name (FQDN) of the certificate that needs to be validated.
[REQUIRED]
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:
None
Exceptions
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 .
See also: AWS API Documentation
Request Syntax
response = client.update_certificate_options(
CertificateArn='string',
Options={
'CertificateTransparencyLoggingPreference': 'ENABLED'|'DISABLED'
}
)
[REQUIRED]
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 ``
[REQUIRED]
Use to update the options for your certificate. Currently, you can specify whether to add your certificate to a transparency log. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser.
You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED .
None
Exceptions
The available paginators are:
paginator = client.get_paginator('list_certificates')
Creates an iterator that will paginate through responses from ACM.Client.list_certificates().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CertificateStatuses=[
'PENDING_VALIDATION'|'ISSUED'|'INACTIVE'|'EXPIRED'|'VALIDATION_TIMED_OUT'|'REVOKED'|'FAILED',
],
Includes={
'extendedKeyUsage': [
'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',
],
'keyUsage': [
'DIGITAL_SIGNATURE'|'NON_REPUDIATION'|'KEY_ENCIPHERMENT'|'DATA_ENCIPHERMENT'|'KEY_AGREEMENT'|'CERTIFICATE_SIGNING'|'CRL_SIGNING'|'ENCIPHER_ONLY'|'DECIPHER_ONLY'|'ANY'|'CUSTOM',
],
'keyTypes': [
'RSA_1024'|'RSA_2048'|'RSA_3072'|'RSA_4096'|'EC_prime256v1'|'EC_secp384r1'|'EC_secp521r1',
]
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Filter the certificate list by status value.
Filter the certificate list. For more information, see the Filters structure.
Specify one or more ExtendedKeyUsage extension values.
Specify one or more KeyUsage extension values.
Specify one or more algorithms that can be used to generate key pairs.
Default filtering returns only RSA_1024 and RSA_2048 certificates that have at least one domain. To return other certificate types, provide the desired type signatures in a comma-separated list. For example, "keyTypes": ["RSA_2048,RSA_4096"] returns both RSA_2048 and RSA_4096 certificates.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'CertificateSummaryList': [
{
'CertificateArn': 'string',
'DomainName': 'string'
},
]
}
Response Structure
(dict) --
CertificateSummaryList (list) --
A list of ACM certificates.
(dict) --
This structure is returned in the response object of ListCertificates action.
CertificateArn (string) --
Amazon Resource Name (ARN) of the certificate. This is of the form:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs) .
DomainName (string) --
Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.
The available waiters are:
waiter = client.get_waiter('certificate_validated')
Polls ACM.Client.describe_certificate() every 60 seconds until a successful state is reached. An error is returned after 40 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
CertificateArn='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the ACM certificate. The ARN must have the following form:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs) .
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 60
The maximum number of attempts to be made. Default: 40
None