2026/08/13 - AWS Certificate Manager - 1 new3 updated api methods
Changes This change allows customers to update their existing email-validated certificates to use the DNS validation method.
Returns per-domain validation summaries for an ACM certificate. Each summary includes the domain name, the active validation configuration, and the requested validation configuration when a validation method migration is in progress. You can use the results to monitor the progress of an email-to-DNS validation migration and to retrieve the CNAME records required for DNS validation.
See also: AWS API Documentation
Request Syntax
client.list_certificate_domain_validations(
CertificateArn='string',
NextToken='string',
MaxItems=123
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the certificate for which to list domain validation summaries.
string
A token returned by a previous call to ListCertificateDomainValidations. If the number of results exceeds MaxItems, use this token to retrieve the next page of results.
integer
The maximum number of domain validation summaries to return. If you don't specify a value, the default is 1000.
dict
Response Syntax
{
'DomainValidationSummaryList': [
{
'DomainName': 'string',
'ActiveValidationConfiguration': {
'ValidationMethod': 'EMAIL'|'DNS'|'HTTP',
'ValidationChallenge': {
'EmailValidationChallenge': {
'ValidationEmails': [
'string',
],
'ValidationDomain': 'string'
},
'DnsValidationChallenge': {
'ResourceRecord': {
'Name': 'string',
'Type': 'CNAME',
'Value': 'string'
}
}
},
'ValidationStatus': 'PENDING_VALIDATION'|'SUCCESS'|'FAILED'
},
'RequestedValidationConfiguration': {
'ValidationMethod': 'EMAIL'|'DNS'|'HTTP',
'ValidationChallenge': {
'EmailValidationChallenge': {
'ValidationEmails': [
'string',
],
'ValidationDomain': 'string'
},
'DnsValidationChallenge': {
'ResourceRecord': {
'Name': 'string',
'Type': 'CNAME',
'Value': 'string'
}
}
},
'ValidationStatus': 'PENDING_VALIDATION'|'SUCCESS'|'FAILED'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DomainValidationSummaryList (list) --
A list of DomainValidationSummary objects, one for each domain on the certificate. Each object contains the domain name and its active and requested validation configurations.
(dict) --
Contains per-domain validation information for a certificate. This structure is returned as a member of the ListCertificateDomainValidations response.
DomainName (string) --
The fully qualified domain name (FQDN) in the certificate for which this validation summary applies.
ActiveValidationConfiguration (dict) --
The validation configuration currently in effect for this domain. This reflects the validation method that ACM is currently using to validate domain ownership (for example, email or DNS).
ValidationMethod (string) --
The validation method for this configuration. Valid values:
DNS – Validation using a CNAME record added to your DNS configuration.
EMAIL – Validation using an approval email sent to domain contacts.
HTTP – Validation using an HTTP resource placed on your web server.
ValidationChallenge (dict) --
The validation challenge details for this configuration. The structure varies by validation method: for DNS validation, contains a DnsValidationChallenge with the CNAME record to add; for email validation, contains an EmailValidationChallenge with the validation email addresses.
EmailValidationChallenge (dict) --
Contains the email addresses used for email-based domain validation.
ValidationEmails (list) --
A list of email addresses that ACM uses to send domain validation emails.
(string) --
ValidationDomain (string) --
The domain name that ACM uses to send validation emails.
DnsValidationChallenge (dict) --
Contains the CNAME record that you must add to your DNS configuration to validate domain ownership using DNS validation.
ResourceRecord (dict) --
The CNAME record that ACM creates for DNS validation. Add this record to your DNS configuration to prove that you own or control the domain.
Name (string) --
The name of the DNS record to create in your domain. This is supplied by ACM.
Type (string) --
The type of DNS record. Currently this can be CNAME.
Value (string) --
The value of the CNAME record to add to your DNS database. This is supplied by ACM.
ValidationStatus (string) --
The validation status for this domain. Valid values:
PENDING_VALIDATION – The domain is waiting for validation to complete.
SUCCESS – Validation completed successfully.
FAILED – Validation failed.
RequestedValidationConfiguration (dict) --
The validation configuration for a pending validation method migration. This field is present only when a migration is in progress (for example, from email to DNS validation). It contains the target validation method, the current validation status, and the validation challenge details (such as the CNAME record to add to your DNS configuration).
ValidationMethod (string) --
The validation method for this configuration. Valid values:
DNS – Validation using a CNAME record added to your DNS configuration.
EMAIL – Validation using an approval email sent to domain contacts.
HTTP – Validation using an HTTP resource placed on your web server.
ValidationChallenge (dict) --
The validation challenge details for this configuration. The structure varies by validation method: for DNS validation, contains a DnsValidationChallenge with the CNAME record to add; for email validation, contains an EmailValidationChallenge with the validation email addresses.
EmailValidationChallenge (dict) --
Contains the email addresses used for email-based domain validation.
ValidationEmails (list) --
A list of email addresses that ACM uses to send domain validation emails.
(string) --
ValidationDomain (string) --
The domain name that ACM uses to send validation emails.
DnsValidationChallenge (dict) --
Contains the CNAME record that you must add to your DNS configuration to validate domain ownership using DNS validation.
ResourceRecord (dict) --
The CNAME record that ACM creates for DNS validation. Add this record to your DNS configuration to prove that you own or control the domain.
Name (string) --
The name of the DNS record to create in your domain. This is supplied by ACM.
Type (string) --
The type of DNS record. Currently this can be CNAME.
Value (string) --
The value of the CNAME record to add to your DNS database. This is supplied by ACM.
ValidationStatus (string) --
The validation status for this domain. Valid values:
PENDING_VALIDATION – The domain is waiting for validation to complete.
SUCCESS – Validation completed successfully.
FAILED – Validation failed.
NextToken (string) --
If the number of results exceeds MaxItems, this token is included in the response. Use this token in a subsequent ListCertificateDomainValidations request to retrieve the next page of results.
{'Certificate': {'Options': {'ValidationMethod': 'EMAIL | DNS | HTTP'},
'UpdateSummary': {'DomainValidationMethodUpdateSummary': {'From': 'EMAIL '
'| '
'DNS '
'| '
'HTTP',
'To': 'EMAIL '
'| '
'DNS '
'| '
'HTTP'},
'RequestedAt': 'timestamp',
'Status': 'PENDING_DOMAIN_VALIDATION | '
'SUCCESS | FAILED',
'Type': 'DOMAIN_VALIDATION_METHOD',
'UpdatedAt': 'timestamp'}}}
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.
See also: AWS API Documentation
Request Syntax
client.describe_certificate(
CertificateArn='string'
)
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).
dict
Response Syntax
{
'Certificate': {
'CertificateArn': 'string',
'DomainName': 'string',
'SubjectAlternativeNames': [
'string',
],
'ManagedBy': 'CLOUDFRONT',
'DomainValidationOptions': [
{
'DomainName': 'string',
'ValidationEmails': [
'string',
],
'ValidationDomain': 'string',
'ValidationStatus': 'PENDING_VALIDATION'|'SUCCESS'|'FAILED',
'ResourceRecord': {
'Name': 'string',
'Type': 'CNAME',
'Value': 'string'
},
'HttpRedirect': {
'RedirectFrom': 'string',
'RedirectTo': 'string'
},
'ValidationMethod': 'EMAIL'|'DNS'|'HTTP'
},
],
'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'|'SUPERSEDED'|'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'
},
'HttpRedirect': {
'RedirectFrom': 'string',
'RedirectTo': 'string'
},
'ValidationMethod': 'EMAIL'|'DNS'|'HTTP'
},
],
'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',
'Export': 'ENABLED'|'DISABLED',
'ValidationMethod': 'EMAIL'|'DNS'|'HTTP'
},
'UpdateSummary': {
'Status': 'PENDING_DOMAIN_VALIDATION'|'SUCCESS'|'FAILED',
'Type': 'DOMAIN_VALIDATION_METHOD',
'DomainValidationMethodUpdateSummary': {
'From': 'EMAIL'|'DNS'|'HTTP',
'To': 'EMAIL'|'DNS'|'HTTP'
},
'RequestedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
},
'CertificateKeyPairOrigin': 'AWS_MANAGED'|'ACME'|'CUSTOMER_PROVIDED',
'AcmeEndpointArn': 'string',
'AcmeAccountId': 'string'
}
}
Response Structure
(dict) --
Certificate (dict) --
Metadata about an ACM certificate.
CertificateArn (string) --
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.
DomainName (string) --
The fully qualified domain name for the certificate, such as www.example.com or example.com.
SubjectAlternativeNames (list) --
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.
(string) --
ManagedBy (string) --
Identifies the Amazon Web Services service that manages the certificate issued by ACM.
DomainValidationOptions (list) --
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.
(dict) --
Contains information about the validation of each domain name in the certificate.
DomainName (string) --
A fully qualified domain name (FQDN) in the certificate. For example, www.example.com or example.com.
ValidationEmails (list) --
A list of email addresses that ACM used to send domain validation emails.
(string) --
ValidationDomain (string) --
The domain name that ACM used to send domain validation emails.
ValidationStatus (string) --
The validation status of the domain name. This can be one of the following values:
PENDING_VALIDATION
SUCCESS
FAILED
ResourceRecord (dict) --
Contains the CNAME record that you add to your DNS database for domain validation. For more information, see Use DNS to Validate Domain Ownership.
Name (string) --
The name of the DNS record to create in your domain. This is supplied by ACM.
Type (string) --
The type of DNS record. Currently this can be CNAME.
Value (string) --
The value of the CNAME record to add to your DNS database. This is supplied by ACM.
HttpRedirect (dict) --
Contains information for HTTP-based domain validation of certificates requested through Amazon CloudFront and issued by ACM. This field exists only when the certificate type is AMAZON_ISSUED and the validation method is HTTP.
RedirectFrom (string) --
The URL including the domain to be validated. The certificate authority sends GET requests here during validation.
RedirectTo (string) --
The URL hosting the validation token. RedirectFrom must return this content or redirect here.
ValidationMethod (string) --
Specifies the domain validation method.
Serial (string) --
The serial number of the certificate.
Subject (string) --
The name of the entity that is associated with the public key contained in the certificate.
Issuer (string) --
The name of the certificate authority that issued and signed the certificate.
CreatedAt (datetime) --
The time at which the certificate was requested.
IssuedAt (datetime) --
The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED.
ImportedAt (datetime) --
The date and time when the certificate was imported. This value exists only when the certificate type is IMPORTED.
Status (string) --
The status of the certificate.
A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.
RevokedAt (datetime) --
The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED.
RevocationReason (string) --
The reason the certificate was revoked. This value exists only when the certificate status is REVOKED.
NotBefore (datetime) --
The time before which the certificate is not valid.
NotAfter (datetime) --
The time after which the certificate is not valid.
KeyAlgorithm (string) --
The algorithm that was used to generate the public-private key pair.
SignatureAlgorithm (string) --
The algorithm that was used to sign the certificate.
InUseBy (list) --
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.
(string) --
FailureReason (string) --
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 Certificate Manager User Guide.
Type (string) --
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 Certificate Manager User Guide.
RenewalSummary (dict) --
Contains information about the status of ACM's managed renewal for the certificate. This field exists only when the certificate type is AMAZON_ISSUED.
RenewalStatus (string) --
The status of ACM's managed renewal of the certificate.
DomainValidationOptions (list) --
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.
(dict) --
Contains information about the validation of each domain name in the certificate.
DomainName (string) --
A fully qualified domain name (FQDN) in the certificate. For example, www.example.com or example.com.
ValidationEmails (list) --
A list of email addresses that ACM used to send domain validation emails.
(string) --
ValidationDomain (string) --
The domain name that ACM used to send domain validation emails.
ValidationStatus (string) --
The validation status of the domain name. This can be one of the following values:
PENDING_VALIDATION
SUCCESS
FAILED
ResourceRecord (dict) --
Contains the CNAME record that you add to your DNS database for domain validation. For more information, see Use DNS to Validate Domain Ownership.
Name (string) --
The name of the DNS record to create in your domain. This is supplied by ACM.
Type (string) --
The type of DNS record. Currently this can be CNAME.
Value (string) --
The value of the CNAME record to add to your DNS database. This is supplied by ACM.
HttpRedirect (dict) --
Contains information for HTTP-based domain validation of certificates requested through Amazon CloudFront and issued by ACM. This field exists only when the certificate type is AMAZON_ISSUED and the validation method is HTTP.
RedirectFrom (string) --
The URL including the domain to be validated. The certificate authority sends GET requests here during validation.
RedirectTo (string) --
The URL hosting the validation token. RedirectFrom must return this content or redirect here.
ValidationMethod (string) --
Specifies the domain validation method.
RenewalStatusReason (string) --
The reason that a renewal request was unsuccessful.
UpdatedAt (datetime) --
The time at which the renewal summary was last updated.
KeyUsages (list) --
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.
(dict) --
The Key Usage X.509 v3 extension defines the purpose of the public key contained in the certificate.
Name (string) --
A string value that contains a Key Usage extension name.
ExtendedKeyUsages (list) --
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).
(dict) --
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.
Name (string) --
The name of an Extended Key Usage value.
OID (string) --
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.
1.3.6.1.5.5.7.3.1 (TLS_WEB_SERVER_AUTHENTICATION)
1.3.6.1.5.5.7.3.2 (TLS_WEB_CLIENT_AUTHENTICATION)
1.3.6.1.5.5.7.3.3 (CODE_SIGNING)
1.3.6.1.5.5.7.3.4 (EMAIL_PROTECTION)
1.3.6.1.5.5.7.3.8 (TIME_STAMPING)
1.3.6.1.5.5.7.3.9 (OCSP_SIGNING)
1.3.6.1.5.5.7.3.5 (IPSEC_END_SYSTEM)
1.3.6.1.5.5.7.3.6 (IPSEC_TUNNEL)
1.3.6.1.5.5.7.3.7 (IPSEC_USER)
CertificateAuthorityArn (string) --
The Amazon Resource Name (ARN) of the 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
RenewalEligibility (string) --
Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.
Options (dict) --
Contains the certificate options. Certificate transparency logging opt-out is no longer available. All public certificates are recorded in a certificate transparency log.
CertificateTransparencyLoggingPreference (string) --
This parameter has been deprecated. Certificate transparency logging opt-out is no longer available. All public certificates are recorded in a certificate transparency log.
Export (string) --
You can opt in to allow the export of your certificates by specifying ENABLED. You cannot update the value of Export after the the certificate is created.
ValidationMethod (string) --
The domain validation method for the certificate. To migrate from email to DNS validation, specify DNS.
UpdateSummary (dict) --
Contains information about the most recent update to the certificate. This field exists only when the certificate type is AMAZON_ISSUED and a certificate update has been requested.
Status (string) --
The status of the certificate update. The following are valid values:
PENDING_DOMAIN_VALIDATION – The certificate update is waiting for domain ownership validation to complete.
SUCCESS – The certificate was updated successfully.
FAILED – The certificate update failed.
Type (string) --
The type of update that was requested for the certificate. The following are valid values:
DOMAIN_VALIDATION_METHOD – The update changes the domain validation method for the certificate.
DomainValidationMethodUpdateSummary (dict) --
Contains information about a domain validation method migration, including the previous and target validation methods.
From (string) --
The validation method that the certificate was using before the update.
To (string) --
The target validation method for the update.
RequestedAt (datetime) --
The time at which the certificate update was requested.
UpdatedAt (datetime) --
The time at which the certificate update status was last changed.
CertificateKeyPairOrigin (string) --
The origin of the certificate's key pair.
AcmeEndpointArn (string) --
The ARN of the ACME endpoint used to issue the certificate.
AcmeAccountId (string) --
The ACME account identifier associated with the certificate.
{'Options': {'ValidationMethod': 'EMAIL | DNS | HTTP'}}
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.
After successful completion of the RequestCertificate action, there is a delay of several seconds before you can retrieve information about the new certificate.
See also: AWS API Documentation
Request Syntax
client.request_certificate(
DomainName='string',
ValidationMethod='EMAIL'|'DNS'|'HTTP',
SubjectAlternativeNames=[
'string',
],
IdempotencyToken='string',
DomainValidationOptions=[
{
'DomainName': 'string',
'ValidationDomain': 'string'
},
],
Options={
'CertificateTransparencyLoggingPreference': 'ENABLED'|'DISABLED',
'Export': 'ENABLED'|'DISABLED',
'ValidationMethod': 'EMAIL'|'DNS'|'HTTP'
},
CertificateAuthorityArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
KeyAlgorithm='RSA_1024'|'RSA_2048'|'RSA_3072'|'RSA_4096'|'EC_prime256v1'|'EC_secp384r1'|'EC_secp521r1',
ManagedBy='CLOUDFRONT'
)
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.
In compliance with RFC 5280, the length of the domain name (technically, the Common Name) that you provide cannot exceed 64 octets (characters), including periods. To add a longer domain name, specify it in the Subject Alternative Name field, which supports names up to 253 octets in length.
string
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.
list
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:
(63 octets).(63 octets).(63 octets).(61 octets) is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.
(64 octets).(63 octets).(63 octets).(61 octets) is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets.
(63 octets).(63 octets).(63 octets).(62 octets) is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.
(string) --
string
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.
list
The domain name that you want ACM to use to send you emails so that you can validate domain ownership.
(dict) --
Contains information about the domain names that you want ACM to use to send you emails that enable you to validate domain ownership.
DomainName (string) -- [REQUIRED]
A fully qualified domain name (FQDN) in the certificate request.
ValidationDomain (string) -- [REQUIRED]
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:
dict
You can use this parameter to specify whether to export your certificate.
Certificate transparency logging opt-out is no longer available. All public certificates are recorded in a certificate transparency log. For more information, see Certificate Transparency Logging.
You can export public ACM certificates to use with Amazon Web Services services as well as outside the Amazon Web Services Cloud. For more information, see Certificate Manager exportable public certificate.
CertificateTransparencyLoggingPreference (string) --
This parameter has been deprecated. Certificate transparency logging opt-out is no longer available. All public certificates are recorded in a certificate transparency log.
Export (string) --
You can opt in to allow the export of your certificates by specifying ENABLED. You cannot update the value of Export after the the certificate is created.
ValidationMethod (string) --
The domain validation method for the certificate. To migrate from email to DNS validation, specify DNS.
string
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 Private Certificate Authority user guide. The ARN must have the following form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
list
One or more resource tags to associate with the certificate.
(dict) --
A key-value pair that identifies or specifies metadata about an ACM resource.
Key (string) -- [REQUIRED]
The key of the tag.
Value (string) --
The value of the tag.
string
Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data. RSA is the default key algorithm for ACM certificates. Elliptic Curve Digital Signature Algorithm (ECDSA) keys are smaller, offering security comparable to RSA keys but with greater computing efficiency. However, ECDSA is not supported by all network clients. Some Amazon Web Services services may require RSA keys, or only support ECDSA keys of a particular size, while others allow the use of either RSA and ECDSA keys to ensure that compatibility is not broken. Check the requirements for the Amazon Web Services service where you plan to deploy your certificate. For more information about selecting an algorithm, see Key algorithms.
Default: RSA_2048
string
Identifies the Amazon Web Services service that manages the certificate issued by ACM.
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
{'Options': {'ValidationMethod': 'EMAIL | DNS | HTTP'}}
Updates certificate options. You can use this operation to change the domain validation method or specify whether to export your certificate. For more information, see Migrate from email to DNS validation and Certificate Manager Exportable Managed Certificates.
See also: AWS API Documentation
Request Syntax
client.update_certificate_options(
CertificateArn='string',
Options={
'CertificateTransparencyLoggingPreference': 'ENABLED'|'DISABLED',
'Export': 'ENABLED'|'DISABLED',
'ValidationMethod': 'EMAIL'|'DNS'|'HTTP'
}
)
string
[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
dict
[REQUIRED]
Use to update the options for your certificate. Currently, you can change the domain validation method or specify whether to export your certificate. For more information about migrating from email to DNS validation, see Migrate from email to DNS validation.
CertificateTransparencyLoggingPreference (string) --
This parameter has been deprecated. Certificate transparency logging opt-out is no longer available. All public certificates are recorded in a certificate transparency log.
Export (string) --
You can opt in to allow the export of your certificates by specifying ENABLED. You cannot update the value of Export after the the certificate is created.
ValidationMethod (string) --
The domain validation method for the certificate. To migrate from email to DNS validation, specify DNS.
None