2019/11/22 - AWS Certificate Manager - 3 updated api methods
Changes This release adds support for Tag-Based IAM for AWS Certificate Manager and adding tags to certificates upon creation.
{'Certificate': {'FailureReason': {'PCA_NAME_CONSTRAINTS_VALIDATION'},
'RenewalSummary': {'RenewalStatusReason': {'PCA_NAME_CONSTRAINTS_VALIDATION'}}}}
Returns detailed metadata about the specified ACM certificate.
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) and AWS Service Namespaces.
dict
Response Syntax
{
'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_2048'|'RSA_1024'|'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'|'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'|'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) and AWS Service Namespaces in the AWS 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) --
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.
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. This value exists only when the certificate type is AMAZON_ISSUED .
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 at which the certificate was imported. This value exists only when the certificate type is IMPORTED .
Status (string) --
The status of the certificate.
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 AWS resources that are using the certificate. A certificate can be used by multiple AWS 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 AWS 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 AWS 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.
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 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
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 .
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with ACM. Note that integrated services allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see Importing Certificates in the AWS Certificate Manager User Guide .
Note
ACM does not provide managed renewal for certificates that you import.
Note the following guidelines when importing third party certificates:
You must enter the private key that matches the certificate you are importing.
The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase.
If the certificate you are importing is not self-signed, you must enter its certificate chain.
If a certificate chain is included, the issuer must be the subject of one of the certificates in the chain.
The certificate, private key, and certificate chain must be PEM-encoded.
The current time must be between the Not Before and Not After certificate fields.
The Issuer field must not be empty.
The OCSP authority URL, if present, must not exceed 1000 characters.
To import a new certificate, omit the CertificateArn argument. Include this argument only when you want to replace a previously imported certifica
When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the private key by their file names preceded by file:// . For example, you can specify a certificate saved in the C:\temp folder as file://C:\temp\certificate_to_import.pem . If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs.
When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using.
The cryptographic algorithm of an imported certificate must match the algorithm of the signing CA. For example, if the signing CA key type is RSA, then the certificate key type must also be RSA.
This operation returns the Amazon Resource Name (ARN) of the imported certificate.
See also: AWS API Documentation
Request Syntax
client.import_certificate(
CertificateArn='string',
Certificate=b'bytes',
PrivateKey=b'bytes',
CertificateChain=b'bytes',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
The Amazon Resource Name (ARN) of an imported certificate to replace. To import a new certificate, omit this field.
bytes
[REQUIRED]
The certificate to import.
bytes
[REQUIRED]
The private key that matches the public key in the certificate.
bytes
The PEM encoded certificate chain.
list
One or more resource tags to associate with the imported certificate.
Note: You cannot apply tags when reimporting a 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.
dict
Response Syntax
{
'CertificateArn': 'string'
}
Response Structure
(dict) --
CertificateArn (string) --
The Amazon Resource Name (ARN) of the imported certificate.
{'Tags': [{'Key': 'string', 'Value': 'string'}]}
Requests an ACM certificate for use with other AWS services. To request an ACM certificate, you must specify a fully qualified domain name (FQDN) in the DomainName parameter. You can also specify additional FQDNs in the SubjectAlternativeNames parameter.
If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation or email validation. We recommend that you use DNS validation. ACM issues public certificates after receiving approval from the domain owner.
See also: AWS API Documentation
Request Syntax
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'
},
]
)
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.
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 limit is 10 domain names. If you need more than 10 names, you must request a limit increase. For more information, see Limits.
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 AWS 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
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.
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