2016/01/21 - AWS Certificate Manager - 6 new api methods
Requests an ACM Certificate for use with other AWS services. To request an ACM Certificate, you must specify the fully qualified domain name (FQDN) for your site. You can also specify additional FQDNs if users can reach your site by using other names. For each domain name you specify, email is sent to the domain owner to request approval to issue the certificate. After receiving approval from the domain owner, the ACM Certificate is issued. For more information, see the AWS Certificate Manager User Guide .
Request Syntax
client.request_certificate(
DomainName='string',
SubjectAlternativeNames=[
'string',
],
IdempotencyToken='string',
DomainValidationOptions=[
{
'DomainName': 'string',
'ValidationDomain': 'string'
},
]
)
string
[REQUIRED]
Fully qualified domain name (FQDN), such as www.example.com, of the site 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.
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.
(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 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 www.example.com and specify DomainValidationOptions of example.com , ACM sends email to the domain registrant, technical contact, and administrative contact in WHOIS and the following five addresses:
(dict) --
This structure is used in the request object of the RequestCertificate action.
DomainName (string) -- [REQUIRED]
Fully Qualified Domain Name (FQDN) of the certificate being requested.
ValidationDomain (string) -- [REQUIRED]
The domain to which validation email is sent. This is the base validation domain that will act as the suffix of the email addresses. This must be the same as the DomainName value or a superdomain of the DomainName 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 for the base domain and the and the following five addresses:
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
Retrieves a list of the ACM Certificate ARNs, and the domain name for each ARN, owned by the calling account. You can filter the list based on the CertificateStatuses parameter, and you can display up to MaxItems certificates at one time. If you have more than MaxItems certificates, use the NextToken marker from the response object in your next call to the ListCertificates action to retrieve the next set of certificate ARNs.
Request Syntax
client.list_certificates(
CertificateStatuses=[
'PENDING_VALIDATION'|'ISSUED'|'INACTIVE'|'EXPIRED'|'VALIDATION_TIMED_OUT'|'REVOKED'|'FAILED',
],
NextToken='string',
MaxItems=123
)
list
Identifies the statuses of the ACM Certificates for which you want to retrieve the ARNs. This can be one or more of the following values:
PENDING_VALIDATION
ISSUED
INACTIVE
EXPIRED
VALIDATION_TIMED_OUT
REVOKED
FAILED
(string) --
string
String that contains an opaque marker of the next ACM Certificate ARN to be displayed. Use this parameter when paginating results, and only in a subsequent request after you've received a response where the results have been truncated. Set it to an empty string the first time you call this action, and set it to the value of the NextToken element you receive in the response object for subsequent calls.
integer
Specify this parameter when paginating results to indicate the maximum number of ACM Certificates that you want to display for each response. If there are additional certificates beyond the maximum you specify, use the NextToken value in your next call to the ListCertificates action.
dict
Response Syntax
{
'NextToken': 'string',
'CertificateSummaryList': [
{
'CertificateArn': 'string',
'DomainName': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
If the list has been truncated, this value is present and should be used for the NextToken input parameter on your next call to ListCertificates .
CertificateSummaryList (list) --
A list of the certificate ARNs.
(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) and AWS Service Namespaces .
DomainName (string) --
Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.
Returns a list of the fields contained in the specified ACM Certificate. For example, this action returns the certificate status, a flag that indicates whether the certificate is associated with any other AWS service, and the date at which the certificate request was created. The ACM Certificate is specified on input by its Amazon Resource Name (ARN).
Request Syntax
client.describe_certificate(
CertificateArn='string'
)
string
[REQUIRED]
String that contains an ACM Certificate ARN. The ARN 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) and AWS Service Namespaces .
dict
Response Syntax
{
'Certificate': {
'CertificateArn': 'string',
'DomainName': 'string',
'SubjectAlternativeNames': [
'string',
],
'DomainValidationOptions': [
{
'DomainName': 'string',
'ValidationEmails': [
'string',
],
'ValidationDomain': 'string'
},
],
'Serial': 'string',
'Subject': 'string',
'Issuer': 'string',
'CreatedAt': datetime(2015, 1, 1),
'IssuedAt': 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'|'EC_prime256v1',
'SignatureAlgorithm': 'string',
'InUseBy': [
'string',
]
}
}
Response Structure
(dict) --
Certificate (dict) --
Contains a CertificateDetail structure that lists the fields of an ACM Certificate.
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) and AWS Service Namespaces .
DomainName (string) --
Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.
SubjectAlternativeNames (list) --
One or more domain names (subject alternative names) included in the certificate request. After the certificate is issued, this list includes the domain names bound to the public key 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) --
References a DomainValidation structure that contains the domain name in the certificate and the email address that can be used for validation.
(dict) --
Structure that contains the domain name, the base validation domain to which validation email is sent, and the email addresses used to validate the domain identity.
DomainName (string) --
Fully Qualified Domain Name (FQDN) of the form www.example.com or example.com
ValidationEmails (list) --
A list of contact address for the domain registrant.
(string) --
ValidationDomain (string) --
The base validation domain that acts as the suffix of the email addresses that are used to send the emails.
Serial (string) --
String that contains the serial number of the certificate.
Subject (string) --
The X.500 distinguished name of the entity associated with the public key contained in the certificate.
Issuer (string) --
The X.500 distinguished name of the CA that issued and signed the certificate.
CreatedAt (datetime) --
Time at which the certificate was requested.
IssuedAt (datetime) --
Time at which the certificate was issued.
Status (string) --
A CertificateStatus enumeration value that can contain one of the following:
PENDING_VALIDATION
ISSUED
INACTIVE
EXPIRED
REVOKED
FAILED
VALIDATION_TIMED_OUT
RevokedAt (datetime) --
The time, if any, at which the certificate was revoked. This value exists only if the certificate has been revoked.
RevocationReason (string) --
A RevocationReason enumeration value that indicates why the certificate was revoked. This value exists only if the certificate has been revoked. This can be one of the following vales:
UNSPECIFIED
KEY_COMPROMISE
CA_COMPROMISE
AFFILIATION_CHANGED
SUPERCEDED
CESSATION_OF_OPERATION
CERTIFICATE_HOLD
REMOVE_FROM_CRL
PRIVILEGE_WITHDRAWN
A_A_COMPROMISE
NotBefore (datetime) --
Time before which the certificate is not valid.
NotAfter (datetime) --
Time after which the certificate is not valid.
KeyAlgorithm (string) --
Asymmetric algorithm used to generate the public and private key pair. Currently the only supported value is RSA_2048 .
SignatureAlgorithm (string) --
Algorithm used to generate a signature. Currently the only supported value is SHA256WITHRSA .
InUseBy (list) --
List that identifies ARNs that are using the certificate. A single ACM Certificate can be used by multiple AWS resources.
(string) --
Retrieves an ACM Certificate and certificate chain for the certificate specified by an ARN. The chain is an ordered list of certificates that contains the root certificate, intermediate certificates of subordinate CAs, and the ACM Certificate. The certificate and certificate chain are base64 encoded. If you want to decode the certificate chain to see the individual certificate fields, you can use OpenSSL.
Note
Currently, ACM Certificates can be used only with Elastic Load Balancing and Amazon CloudFront.
Request Syntax
client.get_certificate(
CertificateArn='string'
)
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) and AWS Service Namespaces .
dict
Response Syntax
{
'Certificate': 'string',
'CertificateChain': 'string'
}
Response Structure
(dict) --
Certificate (string) --
String that contains the ACM Certificate represented by the ARN specified at input.
CertificateChain (string) --
The certificate chain that contains the root certificate issued by the certificate authority (CA).
Deletes an ACM Certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list of ACM Certificates 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 other AWS services.
Note
You cannot delete an ACM Certificate that is being used by another AWS service. To delete a certificate that is in use, the certificate association must first be removed.
Request Syntax
client.delete_certificate(
CertificateArn='string'
)
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) and AWS Service Namespaces .
None
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.
Request Syntax
client.resend_validation_email(
CertificateArn='string',
Domain='string',
ValidationDomain='string'
)
string
[REQUIRED]
String that contains the ARN of the requested certificate. The certificate ARN is generated and returned by RequestCertificate 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
string
[REQUIRED]
The Fully Qualified Domain Name (FQDN) of the certificate that needs to be validated.
string
[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