2019/06/20 - AWS Certificate Manager Private Certificate Authority - 4 updated api methods
Changes ACM Private CA is launching Root CAs and hierarchy management, a new feature that expands the scope of ACM Private CA from supporting only subordinate issuing CAs, to now include a full CA hierarchy that includes root CAs - the cryptographic root of trust for an organization.
{'CertificateAuthorityType': {'ROOT'}}
Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, the certificate revocation list (CRL) configuration, the CA type, and an optional idempotency token to avoid accidental creation of multiple CAs. The CA configuration specifies the name of the algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses, and X.500 subject information. The CRL configuration specifies the CRL expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this action returns the Amazon Resource Name (ARN) of the CA.
See also: AWS API Documentation
Request Syntax
client.create_certificate_authority(
CertificateAuthorityConfiguration={
'KeyAlgorithm': 'RSA_2048'|'RSA_4096'|'EC_prime256v1'|'EC_secp384r1',
'SigningAlgorithm': 'SHA256WITHECDSA'|'SHA384WITHECDSA'|'SHA512WITHECDSA'|'SHA256WITHRSA'|'SHA384WITHRSA'|'SHA512WITHRSA',
'Subject': {
'Country': 'string',
'Organization': 'string',
'OrganizationalUnit': 'string',
'DistinguishedNameQualifier': 'string',
'State': 'string',
'CommonName': 'string',
'SerialNumber': 'string',
'Locality': 'string',
'Title': 'string',
'Surname': 'string',
'GivenName': 'string',
'Initials': 'string',
'Pseudonym': 'string',
'GenerationQualifier': 'string'
}
},
RevocationConfiguration={
'CrlConfiguration': {
'Enabled': True|False,
'ExpirationInDays': 123,
'CustomCname': 'string',
'S3BucketName': 'string'
}
},
CertificateAuthorityType='ROOT'|'SUBORDINATE',
IdempotencyToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
dict
[REQUIRED]
Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject information.
KeyAlgorithm (string) -- [REQUIRED]
Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. When you create a subordinate CA, you must use a key algorithm supported by the parent CA.
SigningAlgorithm (string) -- [REQUIRED]
Name of the algorithm your private CA uses to sign certificate requests.
Subject (dict) -- [REQUIRED]
Structure that contains X.500 distinguished name information for your private CA.
Country (string) --
Two-digit code that specifies the country in which the certificate subject located.
Organization (string) --
Legal name of the organization with which the certificate subject is affiliated.
OrganizationalUnit (string) --
A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.
DistinguishedNameQualifier (string) --
Disambiguating information for the certificate subject.
State (string) --
State in which the subject of the certificate is located.
CommonName (string) --
Fully qualified domain name (FQDN) associated with the certificate subject.
SerialNumber (string) --
The certificate serial number.
Locality (string) --
The locality (such as a city or town) in which the certificate subject is located.
Title (string) --
A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.
Surname (string) --
Family name. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.
GivenName (string) --
First name.
Initials (string) --
Concatenation that typically contains the first letter of the GivenName , the first letter of the middle name if one exists, and the first letter of the SurName .
Pseudonym (string) --
Typically a shortened version of a longer GivenName . For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza.
GenerationQualifier (string) --
Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.
dict
Contains a Boolean value that you can use to enable a certification revocation list (CRL) for the CA, the name of the S3 bucket to which ACM Private CA will write the CRL, and an optional CNAME alias that you can use to hide the name of your bucket in the CRL Distribution Points extension of your CA certificate. For more information, see the CrlConfiguration structure.
CrlConfiguration (dict) --
Configuration of the certificate revocation list (CRL), if any, maintained by your private CA.
Enabled (boolean) -- [REQUIRED]
Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. You can use this value to enable certificate revocation for a new CA when you call the CreateCertificateAuthority action or for an existing CA when you call the UpdateCertificateAuthority action.
ExpirationInDays (integer) --
Number of days until a certificate expires.
CustomCname (string) --
Name inserted into the certificate CRL Distribution Points extension that enables the use of an alias for the CRL distribution point. Use this value if you don't want the name of your S3 bucket to be public.
S3BucketName (string) --
Name of the S3 bucket that contains the CRL. If you do not provide a value for the CustomCname argument, the name of your S3 bucket is placed into the CRL Distribution Points extension of the issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority action. You must specify a bucket policy that allows ACM Private CA to write the CRL to your bucket.
string
[REQUIRED]
The type of the certificate authority.
string
Alphanumeric string that can be used to distinguish between calls to CreateCertificateAuthority . Idempotency tokens time out after five minutes. Therefore, if you call CreateCertificateAuthority multiple times with the same idempotency token within a five minute period, ACM Private CA recognizes that you are requesting only one certificate. As a result, ACM Private CA issues only one. If you change the idempotency token for each call, however, ACM Private CA recognizes that you are requesting multiple certificates.
list
Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a private CA. For information using tags with
IAM to manage permissions, see Controlling Access Using IAM Tags.
(dict) --
Tags are labels that you can use to identify and organize your private CAs. Each tag consists of a key and an optional value. You can associate up to 50 tags with a private CA. To add one or more tags to a private CA, call the TagCertificateAuthority action. To remove a tag, call the UntagCertificateAuthority action.
Key (string) -- [REQUIRED]
Key (name) of the tag.
Value (string) --
Value of the tag.
dict
Response Syntax
{
'CertificateAuthorityArn': 'string'
}
Response Structure
(dict) --
CertificateAuthorityArn (string) --
If successful, the Amazon Resource Name (ARN) of the certificate authority (CA). This is of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
{'CertificateAuthority': {'Type': {'ROOT'}}}
Lists information about your private certificate authority (CA). You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following:
CREATING - ACM Private CA is creating your private certificate authority.
PENDING_CERTIFICATE - The certificate is pending. You must use your ACM Private CA-hosted or on-premises root or subordinate CA to sign your private CA CSR and then import it into PCA.
ACTIVE - Your private CA is active.
DISABLED - Your private CA has been disabled.
EXPIRED - Your private CA certificate has expired.
FAILED - Your private CA has failed. Your CA can fail because of problems such a network outage or backend AWS failure or other errors. A failed CA can never return to the pending state. You must create a new CA.
DELETED - Your private CA is within the restoration period, after which it is permanently deleted. The length of time remaining in the CA's restoration period is also included in this action's output.
See also: AWS API Documentation
Request Syntax
client.describe_certificate_authority(
CertificateAuthorityArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
dict
Response Syntax
{
'CertificateAuthority': {
'Arn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastStateChangeAt': datetime(2015, 1, 1),
'Type': 'ROOT'|'SUBORDINATE',
'Serial': 'string',
'Status': 'CREATING'|'PENDING_CERTIFICATE'|'ACTIVE'|'DELETED'|'DISABLED'|'EXPIRED'|'FAILED',
'NotBefore': datetime(2015, 1, 1),
'NotAfter': datetime(2015, 1, 1),
'FailureReason': 'REQUEST_TIMED_OUT'|'UNSUPPORTED_ALGORITHM'|'OTHER',
'CertificateAuthorityConfiguration': {
'KeyAlgorithm': 'RSA_2048'|'RSA_4096'|'EC_prime256v1'|'EC_secp384r1',
'SigningAlgorithm': 'SHA256WITHECDSA'|'SHA384WITHECDSA'|'SHA512WITHECDSA'|'SHA256WITHRSA'|'SHA384WITHRSA'|'SHA512WITHRSA',
'Subject': {
'Country': 'string',
'Organization': 'string',
'OrganizationalUnit': 'string',
'DistinguishedNameQualifier': 'string',
'State': 'string',
'CommonName': 'string',
'SerialNumber': 'string',
'Locality': 'string',
'Title': 'string',
'Surname': 'string',
'GivenName': 'string',
'Initials': 'string',
'Pseudonym': 'string',
'GenerationQualifier': 'string'
}
},
'RevocationConfiguration': {
'CrlConfiguration': {
'Enabled': True|False,
'ExpirationInDays': 123,
'CustomCname': 'string',
'S3BucketName': 'string'
}
},
'RestorableUntil': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
CertificateAuthority (dict) --
A CertificateAuthority structure that contains information about your private CA.
Arn (string) --
Amazon Resource Name (ARN) for your private certificate authority (CA). The format is 12345678-1234-1234-1234-123456789012 .
CreatedAt (datetime) --
Date and time at which your private CA was created.
LastStateChangeAt (datetime) --
Date and time at which your private CA was last updated.
Type (string) --
Type of your private CA.
Serial (string) --
Serial number of your private CA.
Status (string) --
Status of your private CA.
NotBefore (datetime) --
Date and time before which your private CA certificate is not valid.
NotAfter (datetime) --
Date and time after which your private CA certificate is not valid.
FailureReason (string) --
Reason the request to create your private CA failed.
CertificateAuthorityConfiguration (dict) --
Your private CA configuration.
KeyAlgorithm (string) --
Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. When you create a subordinate CA, you must use a key algorithm supported by the parent CA.
SigningAlgorithm (string) --
Name of the algorithm your private CA uses to sign certificate requests.
Subject (dict) --
Structure that contains X.500 distinguished name information for your private CA.
Country (string) --
Two-digit code that specifies the country in which the certificate subject located.
Organization (string) --
Legal name of the organization with which the certificate subject is affiliated.
OrganizationalUnit (string) --
A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.
DistinguishedNameQualifier (string) --
Disambiguating information for the certificate subject.
State (string) --
State in which the subject of the certificate is located.
CommonName (string) --
Fully qualified domain name (FQDN) associated with the certificate subject.
SerialNumber (string) --
The certificate serial number.
Locality (string) --
The locality (such as a city or town) in which the certificate subject is located.
Title (string) --
A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.
Surname (string) --
Family name. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.
GivenName (string) --
First name.
Initials (string) --
Concatenation that typically contains the first letter of the GivenName , the first letter of the middle name if one exists, and the first letter of the SurName .
Pseudonym (string) --
Typically a shortened version of a longer GivenName . For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza.
GenerationQualifier (string) --
Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.
RevocationConfiguration (dict) --
Information about the certificate revocation list (CRL) created and maintained by your private CA.
CrlConfiguration (dict) --
Configuration of the certificate revocation list (CRL), if any, maintained by your private CA.
Enabled (boolean) --
Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. You can use this value to enable certificate revocation for a new CA when you call the CreateCertificateAuthority action or for an existing CA when you call the UpdateCertificateAuthority action.
ExpirationInDays (integer) --
Number of days until a certificate expires.
CustomCname (string) --
Name inserted into the certificate CRL Distribution Points extension that enables the use of an alias for the CRL distribution point. Use this value if you don't want the name of your S3 bucket to be public.
S3BucketName (string) --
Name of the S3 bucket that contains the CRL. If you do not provide a value for the CustomCname argument, the name of your S3 bucket is placed into the CRL Distribution Points extension of the issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority action. You must specify a bucket policy that allows ACM Private CA to write the CRL to your bucket.
RestorableUntil (datetime) --
The period during which a deleted CA can be restored. For more information, see the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest action.
{'TemplateArn': 'string'}
Uses your private certificate authority (CA) to issue a client certificate. This action returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the GetCertificate action and specifying the ARN.
Note
You cannot use the ACM ListCertificateAuthorities action to retrieve the ARNs of the certificates that you issue by using ACM Private CA.
See also: AWS API Documentation
Request Syntax
client.issue_certificate(
CertificateAuthorityArn='string',
Csr=b'bytes',
SigningAlgorithm='SHA256WITHECDSA'|'SHA384WITHECDSA'|'SHA512WITHECDSA'|'SHA256WITHRSA'|'SHA384WITHRSA'|'SHA512WITHRSA',
TemplateArn='string',
Validity={
'Value': 123,
'Type': 'END_DATE'|'ABSOLUTE'|'DAYS'|'MONTHS'|'YEARS'
},
IdempotencyToken='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
bytes
[REQUIRED]
The certificate signing request (CSR) for the certificate you want to issue. You can use the following OpenSSL command to create the CSR and a 2048 bit RSA private key.
openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr
If you have a configuration file, you can use the following OpenSSL command. The usr_cert block in the configuration file contains your X509 version 3 extensions.
openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days -365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr
string
[REQUIRED]
The name of the algorithm that will be used to sign the certificate to be issued.
string
Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template.
The following service-owned TemplateArn values are supported by ACM Private CA:
arn:aws:acm-pca:::template/EndEntityCertificate/V1
arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen0/V1
arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen1/V1
arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen2/V1
arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen3/V1
arn:aws:acm-pca:::template/RootCACertificate/V1
For more information, see Using Templates.
dict
[REQUIRED]
The type of the validity period.
Value (integer) -- [REQUIRED]
Time period.
Type (string) -- [REQUIRED]
Specifies whether the Value parameter represents days, months, or years.
string
Custom string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens time out after one hour. Therefore, if you call IssueCertificate multiple times with the same idempotency token within 5 minutes, ACM Private CA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificates.
dict
Response Syntax
{
'CertificateArn': 'string'
}
Response Structure
(dict) --
CertificateArn (string) --
The Amazon Resource Name (ARN) of the issued certificate and the certificate serial number. This is of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245
{'CertificateAuthorities': {'Type': {'ROOT'}}}
Lists the private certificate authorities that you created by using the CreateCertificateAuthority action.
See also: AWS API Documentation
Request Syntax
client.list_certificate_authorities(
NextToken='string',
MaxResults=123
)
string
Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the NextToken parameter 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 on each page. 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.
dict
Response Syntax
{
'CertificateAuthorities': [
{
'Arn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastStateChangeAt': datetime(2015, 1, 1),
'Type': 'ROOT'|'SUBORDINATE',
'Serial': 'string',
'Status': 'CREATING'|'PENDING_CERTIFICATE'|'ACTIVE'|'DELETED'|'DISABLED'|'EXPIRED'|'FAILED',
'NotBefore': datetime(2015, 1, 1),
'NotAfter': datetime(2015, 1, 1),
'FailureReason': 'REQUEST_TIMED_OUT'|'UNSUPPORTED_ALGORITHM'|'OTHER',
'CertificateAuthorityConfiguration': {
'KeyAlgorithm': 'RSA_2048'|'RSA_4096'|'EC_prime256v1'|'EC_secp384r1',
'SigningAlgorithm': 'SHA256WITHECDSA'|'SHA384WITHECDSA'|'SHA512WITHECDSA'|'SHA256WITHRSA'|'SHA384WITHRSA'|'SHA512WITHRSA',
'Subject': {
'Country': 'string',
'Organization': 'string',
'OrganizationalUnit': 'string',
'DistinguishedNameQualifier': 'string',
'State': 'string',
'CommonName': 'string',
'SerialNumber': 'string',
'Locality': 'string',
'Title': 'string',
'Surname': 'string',
'GivenName': 'string',
'Initials': 'string',
'Pseudonym': 'string',
'GenerationQualifier': 'string'
}
},
'RevocationConfiguration': {
'CrlConfiguration': {
'Enabled': True|False,
'ExpirationInDays': 123,
'CustomCname': 'string',
'S3BucketName': 'string'
}
},
'RestorableUntil': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
CertificateAuthorities (list) --
Summary information about each certificate authority you have created.
(dict) --
Contains information about your private certificate authority (CA). Your private CA can issue and revoke X.509 digital certificates. Digital certificates verify that the entity named in the certificate Subject field owns or controls the public key contained in the Subject Public Key Info field. Call the CreateCertificateAuthority action to create your private CA. You must then call the GetCertificateAuthorityCertificate action to retrieve a private CA certificate signing request (CSR). Sign the CSR with your ACM Private CA-hosted or on-premises root or subordinate CA certificate. Call the ImportCertificateAuthorityCertificate action to import the signed certificate into AWS Certificate Manager (ACM).
Arn (string) --
Amazon Resource Name (ARN) for your private certificate authority (CA). The format is 12345678-1234-1234-1234-123456789012 .
CreatedAt (datetime) --
Date and time at which your private CA was created.
LastStateChangeAt (datetime) --
Date and time at which your private CA was last updated.
Type (string) --
Type of your private CA.
Serial (string) --
Serial number of your private CA.
Status (string) --
Status of your private CA.
NotBefore (datetime) --
Date and time before which your private CA certificate is not valid.
NotAfter (datetime) --
Date and time after which your private CA certificate is not valid.
FailureReason (string) --
Reason the request to create your private CA failed.
CertificateAuthorityConfiguration (dict) --
Your private CA configuration.
KeyAlgorithm (string) --
Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. When you create a subordinate CA, you must use a key algorithm supported by the parent CA.
SigningAlgorithm (string) --
Name of the algorithm your private CA uses to sign certificate requests.
Subject (dict) --
Structure that contains X.500 distinguished name information for your private CA.
Country (string) --
Two-digit code that specifies the country in which the certificate subject located.
Organization (string) --
Legal name of the organization with which the certificate subject is affiliated.
OrganizationalUnit (string) --
A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.
DistinguishedNameQualifier (string) --
Disambiguating information for the certificate subject.
State (string) --
State in which the subject of the certificate is located.
CommonName (string) --
Fully qualified domain name (FQDN) associated with the certificate subject.
SerialNumber (string) --
The certificate serial number.
Locality (string) --
The locality (such as a city or town) in which the certificate subject is located.
Title (string) --
A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.
Surname (string) --
Family name. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.
GivenName (string) --
First name.
Initials (string) --
Concatenation that typically contains the first letter of the GivenName , the first letter of the middle name if one exists, and the first letter of the SurName .
Pseudonym (string) --
Typically a shortened version of a longer GivenName . For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza.
GenerationQualifier (string) --
Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.
RevocationConfiguration (dict) --
Information about the certificate revocation list (CRL) created and maintained by your private CA.
CrlConfiguration (dict) --
Configuration of the certificate revocation list (CRL), if any, maintained by your private CA.
Enabled (boolean) --
Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. You can use this value to enable certificate revocation for a new CA when you call the CreateCertificateAuthority action or for an existing CA when you call the UpdateCertificateAuthority action.
ExpirationInDays (integer) --
Number of days until a certificate expires.
CustomCname (string) --
Name inserted into the certificate CRL Distribution Points extension that enables the use of an alias for the CRL distribution point. Use this value if you don't want the name of your S3 bucket to be public.
S3BucketName (string) --
Name of the S3 bucket that contains the CRL. If you do not provide a value for the CustomCname argument, the name of your S3 bucket is placed into the CRL Distribution Points extension of the issued certificate. You can change the name of your bucket by calling the UpdateCertificateAuthority action. You must specify a bucket policy that allows ACM Private CA to write the CRL to your bucket.
RestorableUntil (datetime) --
The period during which a deleted CA can be restored. For more information, see the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest action.
NextToken (string) --
When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.