2025/04/28 - AWS Certificate Manager - 3 updated api methods
Changes Add support for file-based HTTP domain control validation, available through Amazon CloudFront.
{'Certificate': {'DomainValidationOptions': {'HttpRedirect': {'RedirectFrom': 'string',
'RedirectTo': 'string'},
'ValidationMethod': {'HTTP'}},
'ManagedBy': 'CLOUDFRONT',
'RenewalSummary': {'DomainValidationOptions': {'HttpRedirect': {'RedirectFrom': 'string',
'RedirectTo': 'string'},
'ValidationMethod': {'HTTP'}}},
'RevocationReason': {'SUPERSEDED'}}}
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'
}
}
}
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.
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.
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 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.
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.
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 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) --
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.
CertificateTransparencyLoggingPreference (string) --
You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED.
{'Includes': {'managedBy': 'CLOUDFRONT'}}
Response {'CertificateSummaryList': {'ManagedBy': 'CLOUDFRONT'}}
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
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',
],
'managedBy': 'CLOUDFRONT'
},
NextToken='string',
MaxItems=123,
SortBy='CREATED_AT',
SortOrder='ASCENDING'|'DESCENDING'
)
list
Filter the certificate list by status value.
(string) --
dict
Filter the certificate list. For more information, see the Filters structure.
extendedKeyUsage (list) --
Specify one or more ExtendedKeyUsage extension values.
(string) --
keyUsage (list) --
Specify one or more KeyUsage extension values.
(string) --
keyTypes (list) --
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.
(string) --
managedBy (string) --
Identifies the Amazon Web Services service that manages the certificate issued by ACM.
string
Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of NextToken from the response you just received.
integer
Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.
string
Specifies the field to sort results by. If you specify SortBy, you must also specify SortOrder.
string
Specifies the order of sorted results. If you specify SortOrder, you must also specify SortBy.
dict
Response Syntax
{
'NextToken': 'string',
'CertificateSummaryList': [
{
'CertificateArn': 'string',
'DomainName': 'string',
'SubjectAlternativeNameSummaries': [
'string',
],
'HasAdditionalSubjectAlternativeNames': True|False,
'Status': 'PENDING_VALIDATION'|'ISSUED'|'INACTIVE'|'EXPIRED'|'VALIDATION_TIMED_OUT'|'REVOKED'|'FAILED',
'Type': 'IMPORTED'|'AMAZON_ISSUED'|'PRIVATE',
'KeyAlgorithm': 'RSA_1024'|'RSA_2048'|'RSA_3072'|'RSA_4096'|'EC_prime256v1'|'EC_secp384r1'|'EC_secp521r1',
'KeyUsages': [
'DIGITAL_SIGNATURE'|'NON_REPUDIATION'|'KEY_ENCIPHERMENT'|'DATA_ENCIPHERMENT'|'KEY_AGREEMENT'|'CERTIFICATE_SIGNING'|'CRL_SIGNING'|'ENCIPHER_ONLY'|'DECIPHER_ONLY'|'ANY'|'CUSTOM',
],
'ExtendedKeyUsages': [
'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',
],
'InUse': True|False,
'Exported': True|False,
'RenewalEligibility': 'ELIGIBLE'|'INELIGIBLE',
'NotBefore': datetime(2015, 1, 1),
'NotAfter': datetime(2015, 1, 1),
'CreatedAt': datetime(2015, 1, 1),
'IssuedAt': datetime(2015, 1, 1),
'ImportedAt': datetime(2015, 1, 1),
'RevokedAt': datetime(2015, 1, 1),
'ManagedBy': 'CLOUDFRONT'
},
]
}
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.
SubjectAlternativeNameSummaries (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.
When called by ListCertificates, this parameter will only return the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.
(string) --
HasAdditionalSubjectAlternativeNames (boolean) --
When called by ListCertificates, indicates whether the full list of subject alternative names has been included in the response. If false, the response includes all of the subject alternative names included in the certificate. If true, the response only includes the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.
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.
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.
KeyAlgorithm (string) --
The algorithm that was used to generate the public-private key pair.
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.
(string) --
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).
(string) --
InUse (boolean) --
Indicates whether the certificate is currently in use by any Amazon Web Services resources.
Exported (boolean) --
Indicates whether the certificate has been exported. This value exists only when the certificate type is PRIVATE.
RenewalEligibility (string) --
Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.
NotBefore (datetime) --
The time before which the certificate is not valid.
NotAfter (datetime) --
The time after which the certificate is not valid.
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.
RevokedAt (datetime) --
The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED.
ManagedBy (string) --
Identifies the Amazon Web Services service that manages the certificate issued by ACM.
{'ManagedBy': 'CLOUDFRONT', 'ValidationMethod': {'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. ACM issues public certificates after receiving approval from the domain owner.
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'
},
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
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.
CertificateTransparencyLoggingPreference (string) --
You can opt out of certificate transparency logging by specifying the DISABLED option. Opt in by specifying ENABLED.
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