Table of Contents
A low-level client representing AWS Certificate Manager Private Certificate Authority (ACM-PCA):
import boto3
client = boto3.client('acm-pca')
These are the available methods:
Check if an operation can be paginated.
Creates a private subordinate certificate authority (CA). You must specify the CA configuration, the revocation configuration, the CA type, and an optional idempotency token. 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 to sign, and X.500 subject information. The CRL (certificate revocation list) 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 operation returns the Amazon Resource Name (ARN) of the CA.
See also: AWS API Documentation
Request Syntax
response = 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='SUBORDINATE',
IdempotencyToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject information.
Type of the public key algorithm and size, in bits, of the key pair that your key pair creates when it issues a certificate.
Name of the algorithm your private CA uses to sign certificate requests.
Structure that contains X.500 distinguished name information for your private CA.
Two-digit code that specifies the country in which the certificate subject located.
Legal name of the organization with which the certificate subject is affiliated.
A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.
Disambiguating information for the certificate subject.
State in which the subject of the certificate is located.
Fully qualified domain name (FQDN) associated with the certificate subject.
The certificate serial number.
The locality (such as a city or town) in which the certificate subject is located.
A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.
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.
First name.
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 .
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.
Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.
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 PCA 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.
Configuration of the certificate revocation list (CRL), if any, maintained by your private CA.
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 operation or for an existing CA when you call the UpdateCertificateAuthority operation.
Number of days until a certificate expires.
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.
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 operation. You must specify a bucket policy that allows ACM PCA to write the CRL to your bucket.
[REQUIRED]
The type of the certificate authority. Currently, this must be SUBORDINATE .
Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a private CA.
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 operation. To remove a tag, call the UntagCertificateAuthority operation.
Key (name) of the tag.
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 `` .
Creates an audit report that lists every time that the your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate operations use the private key. You can generate a new report every 30 minutes.
See also: AWS API Documentation
Request Syntax
response = client.create_certificate_authority_audit_report(
CertificateAuthorityArn='string',
S3BucketName='string',
AuditReportResponseFormat='JSON'|'CSV'
)
[REQUIRED]
Amazon Resource Name (ARN) of the CA to be audited. This is of the form:
``arn:aws:acm-pca:region :account :certificate-authority/12345678-1234-1234-1234-123456789012 `` .
[REQUIRED]
Name of the S3 bucket that will contain the audit report.
[REQUIRED]
Format in which to create the report. This can be either JSON or CSV .
dict
Response Syntax
{
'AuditReportId': 'string',
'S3Key': 'string'
}
Response Structure
(dict) --
AuditReportId (string) --
An alphanumeric string that contains a report identifier.
S3Key (string) --
The key that uniquely identifies the report file in your S3 bucket.
Deletes a private certificate authority (CA). You must provide the ARN (Amazon Resource Name) of the private CA that you want to delete. You can find the ARN by calling the ListCertificateAuthorities operation. Before you can delete a CA, you must disable it. Call the UpdateCertificateAuthority operation and set the CertificateAuthorityStatus parameter to DISABLED .
Additionally, you can delete a CA if you are waiting for it to be created (the Status field of the CertificateAuthority is CREATING ). You can also delete it if the CA has been created but you haven't yet imported the signed certificate (the Status is PENDING_CERTIFICATE ) into ACM PCA.
If the CA is in one of the aforementioned states and you call DeleteCertificateAuthority , the CA's status changes to DELETED . However, the CA won't be permentantly deleted until the restoration period has passed. By default, if you do not set the PermanentDeletionTimeInDays parameter, the CA remains restorable for 30 days. You can set the parameter from 7 to 30 days. The DescribeCertificateAuthority operation returns the time remaining in the restoration window of a Private CA in the DELETED state. To restore an eligable CA, call the RestoreCertificateAuthority operation.
See also: AWS API Documentation
Request Syntax
response = client.delete_certificate_authority(
CertificateAuthorityArn='string',
PermanentDeletionTimeInDays=123
)
[REQUIRED]
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority . This must have the following form:
``arn:aws:acm-pca:region :account :certificate-authority/12345678-1234-1234-1234-123456789012 `` .
None
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:
See also: AWS API Documentation
Request Syntax
response = client.describe_certificate_authority(
CertificateAuthorityArn='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 `` .
{
'CertificateAuthority': {
'Arn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastStateChangeAt': datetime(2015, 1, 1),
'Type': '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
A CertificateAuthority structure that contains information about your private CA.
Amazon Resource Name (ARN) for your private certificate authority (CA). The format is `` 12345678-1234-1234-1234-123456789012 `` .
Date and time at which your private CA was created.
Date and time at which your private CA was last updated.
Type of your private CA.
Serial number of your private CA.
Status of your private CA.
Date and time before which your private CA certificate is not valid.
Date and time after which your private CA certificate is not valid.
Reason the request to create your private CA failed.
Your private CA configuration.
Type of the public key algorithm and size, in bits, of the key pair that your key pair creates when it issues a certificate.
Name of the algorithm your private CA uses to sign certificate requests.
Structure that contains X.500 distinguished name information for your private CA.
Two-digit code that specifies the country in which the certificate subject located.
Legal name of the organization with which the certificate subject is affiliated.
A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.
Disambiguating information for the certificate subject.
State in which the subject of the certificate is located.
Fully qualified domain name (FQDN) associated with the certificate subject.
The certificate serial number.
The locality (such as a city or town) in which the certificate subject is located.
A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.
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.
First name.
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 .
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.
Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.
Information about the certificate revocation list (CRL) created and maintained by your private CA.
Configuration of the certificate revocation list (CRL), if any, maintained by your private CA.
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 operation or for an existing CA when you call the UpdateCertificateAuthority operation.
Number of days until a certificate expires.
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.
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 operation. You must specify a bucket policy that allows ACM PCA to write the CRL to your bucket.
The period during which a deleted CA can be restored. For more information, see the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest operation.
Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport operation. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the IssueCertificate operation or the RevokeCertificate operation.
See also: AWS API Documentation
Request Syntax
response = client.describe_certificate_authority_audit_report(
CertificateAuthorityArn='string',
AuditReportId='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the private CA. This must be of the form:
``arn:aws:acm-pca:region :account :certificate-authority/12345678-1234-1234-1234-123456789012 `` .
[REQUIRED]
The report ID returned by calling the CreateCertificateAuthorityAuditReport operation.
dict
Response Syntax
{
'AuditReportStatus': 'CREATING'|'SUCCESS'|'FAILED',
'S3BucketName': 'string',
'S3Key': 'string',
'CreatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
AuditReportStatus (string) --
Specifies whether report creation is in progress, has succeeded, or has failed.
S3BucketName (string) --
Name of the S3 bucket that contains the report.
S3Key (string) --
S3 key that uniquely identifies the report file in your S3 bucket.
CreatedAt (datetime) --
The date and time at which the report was created.
Generate a presigned url given a client, its method, and arguments
The presigned url
Retrieves a certificate from your private CA. The ARN of the certificate is returned when you call the IssueCertificate operation. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the GetCertificate operation. You can retrieve the certificate if it is in the ISSUED state. You can call the CreateCertificateAuthorityAuditReport operation to create a report that contains information about all of the certificates issued and revoked by your private CA.
See also: AWS API Documentation
Request Syntax
response = client.get_certificate(
CertificateAuthorityArn='string',
CertificateArn='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 `` .
[REQUIRED]
The ARN of the issued certificate. The ARN contains the certificate serial number and must be in the following form:
``arn:aws:acm-pca:region :account :certificate-authority/12345678-1234-1234-1234-123456789012 /certificate/286535153982981100925020015808220737245 ``
dict
Response Syntax
{
'Certificate': 'string',
'CertificateChain': 'string'
}
Response Structure
(dict) --
Certificate (string) --
The base64 PEM-encoded certificate specified by the CertificateArn parameter.
CertificateChain (string) --
The base64 PEM-encoded certificate chain that chains up to the on-premises root CA certificate that you used to sign your private CA certificate.
Retrieves the certificate and certificate chain for your private certificate authority (CA). Both the certificate and the chain are base64 PEM-encoded. The chain does not include the CA certificate. Each certificate in the chain signs the one before it.
See also: AWS API Documentation
Request Syntax
response = client.get_certificate_authority_certificate(
CertificateAuthorityArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of your private CA. This is of the form:
``arn:aws:acm-pca:region :account :certificate-authority/12345678-1234-1234-1234-123456789012 `` .
{
'Certificate': 'string',
'CertificateChain': 'string'
}
Response Structure
Base64-encoded certificate authority (CA) certificate.
Base64-encoded certificate chain that includes any intermediate certificates and chains up to root on-premises certificate that you used to sign your private CA certificate. The chain does not include your private CA certificate.
Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the CreateCertificateAuthority operation. Take the CSR to your on-premises X.509 infrastructure and sign it by using your root or a subordinate CA. Then import the signed certificate back into ACM PCA by calling the ImportCertificateAuthorityCertificate operation. The CSR is returned as a base64 PEM-encoded string.
See also: AWS API Documentation
Request Syntax
response = client.get_certificate_authority_csr(
CertificateAuthorityArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority operation. This must be of the form:
``arn:aws:acm-pca:region :account :certificate-authority/12345678-1234-1234-1234-123456789012 ``
{
'Csr': 'string'
}
Response Structure
The base64 PEM-encoded certificate signing request (CSR) for your private CA certificate.
Create a paginator for an operation.
Returns an object that can wait for some condition.
Imports your signed private CA certificate into ACM PCA. Before you can call this operation, you must create the private certificate authority by calling the CreateCertificateAuthority operation. You must then generate a certificate signing request (CSR) by calling the GetCertificateAuthorityCsr operation. Take the CSR to your on-premises CA and use the root certificate or a subordinate certificate to sign it. Create a certificate chain and copy the signed certificate and the certificate chain to your working directory.
Note
Your certificate chain must not include the private CA certificate that you are importing.
Note
Your on-premises CA certificate must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built.
Note
The chain must be PEM-encoded.
See also: AWS API Documentation
Request Syntax
response = client.import_certificate_authority_certificate(
CertificateAuthorityArn='string',
Certificate=b'bytes',
CertificateChain=b'bytes'
)
[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 ``
[REQUIRED]
The PEM-encoded certificate for your private CA. This must be signed by using your on-premises CA.
[REQUIRED]
A PEM-encoded file that contains all of your certificates, other than the certificate you're importing, chaining up to your root CA. Your on-premises root certificate is the last in the chain, and each certificate in the chain signs the one preceding.
None
Uses your private certificate authority (CA) to issue a client certificate. This operation returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the GetCertificate operation and specifying the ARN.
Note
You cannot use the ACM ListCertificateAuthorities operation to retrieve the ARNs of the certificates that you issue by using ACM PCA.
See also: AWS API Documentation
Request Syntax
response = client.issue_certificate(
CertificateAuthorityArn='string',
Csr=b'bytes',
SigningAlgorithm='SHA256WITHECDSA'|'SHA384WITHECDSA'|'SHA512WITHECDSA'|'SHA256WITHRSA'|'SHA384WITHRSA'|'SHA512WITHRSA',
Validity={
'Value': 123,
'Type': 'END_DATE'|'ABSOLUTE'|'DAYS'|'MONTHS'|'YEARS'
},
IdempotencyToken='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 ``
[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
[REQUIRED]
The name of the algorithm that will be used to sign the certificate to be issued.
[REQUIRED]
The type of the validity period.
Time period.
Specifies whether the Value parameter represents days, months, or years.
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 ``
Lists the private certificate authorities that you created by using the CreateCertificateAuthority operation.
See also: AWS API Documentation
Request Syntax
response = client.list_certificate_authorities(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'CertificateAuthorities': [
{
'Arn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastStateChangeAt': datetime(2015, 1, 1),
'Type': '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 operation to create your private CA. You must then call the GetCertificateAuthorityCertificate operation to retrieve a private CA certificate signing request (CSR). Take the CSR to your on-premises CA and sign it with the root CA certificate or a subordinate certificate. Call the ImportCertificateAuthorityCertificate operation 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 key pair creates when it issues a certificate.
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 operation or for an existing CA when you call the UpdateCertificateAuthority operation.
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 operation. You must specify a bucket policy that allows ACM PCA 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 operation.
NextToken (string) --
When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.
Lists the tags, if any, that are associated with your private CA. Tags are labels that you can use to identify and organize your CAs. Each tag consists of a key and an optional value. Call the TagCertificateAuthority operation to add one or more tags to your CA. Call the UntagCertificateAuthority operation to remove tags.
See also: AWS API Documentation
Request Syntax
response = client.list_tags(
CertificateAuthorityArn='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority operation. This must be of the form:
``arn:aws:acm-pca:region :account :certificate-authority/12345678-1234-1234-1234-123456789012 ``
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Tags (list) --
The tags associated with your private CA.
(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 operation. To remove a tag, call the UntagCertificateAuthority operation.
Key (string) --
Key (name) of the tag.
Value (string) --
Value of the tag.
NextToken (string) --
When the list is truncated, this value is present and should be used for the NextToken parameter in a subsequent pagination request.
Restores a certificate authority (CA) that is in the DELETED state. You can restore a CA during the period that you defined in the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthority operation. Currently, you can specify 7 to 30 days. If you did not specify a PermanentDeletionTimeInDays value, by default you can restore the CA at any time in a 30 day period. You can check the time remaining in the restoration period of a private CA in the DELETED state by calling the DescribeCertificateAuthority or ListCertificateAuthorities operations. The status of a restored CA is set to its pre-deletion status when the RestoreCertificateAuthority operation returns. To change its status to ACTIVE , call the UpdateCertificateAuthority operation. If the private CA was in the PENDING_CERTIFICATE state at deletion, you must use the ImportCertificateAuthorityCertificate operation to import a certificate authority into the private CA before it can be activated. You cannot restore a CA after the restoration period has ended.
See also: AWS API Documentation
Request Syntax
response = client.restore_certificate_authority(
CertificateAuthorityArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority operation. This must be of the form:
``arn:aws:acm-pca:region :account :certificate-authority/12345678-1234-1234-1234-123456789012 ``
Revokes a certificate that you issued by calling the IssueCertificate operation. If you enable a certificate revocation list (CRL) when you create or update your private CA, information about the revoked certificates will be included in the CRL. ACM PCA writes the CRL to an S3 bucket that you specify. For more information about revocation, see the CrlConfiguration structure. ACM PCA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport .
See also: AWS API Documentation
Request Syntax
response = client.revoke_certificate(
CertificateAuthorityArn='string',
CertificateSerial='string',
RevocationReason='UNSPECIFIED'|'KEY_COMPROMISE'|'CERTIFICATE_AUTHORITY_COMPROMISE'|'AFFILIATION_CHANGED'|'SUPERSEDED'|'CESSATION_OF_OPERATION'|'PRIVILEGE_WITHDRAWN'|'A_A_COMPROMISE'
)
[REQUIRED]
Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:
``arn:aws:acm-pca:region :account :certificate-authority/12345678-1234-1234-1234-123456789012 ``
[REQUIRED]
Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling GetCertificate with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The GetCertificate operation retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number.
openssl x509 -in *file_path* -text -noout
You can also copy the serial number from the console or use the DescribeCertificate operation in the AWS Certificate Manager API Reference .
[REQUIRED]
Specifies why you revoked the certificate.
None
Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. You specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one private CA if you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs if you want to filter for a common relationship among those CAs. To remove one or more tags, use the UntagCertificateAuthority operation. Call the ListTags operation to see what tags are associated with your CA.
See also: AWS API Documentation
Request Syntax
response = client.tag_certificate_authority(
CertificateAuthorityArn='string',
Tags=[
{
'Key': 'string',
'Value': '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 ``
[REQUIRED]
List of tags to be associated with the CA.
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 operation. To remove a tag, call the UntagCertificateAuthority operation.
Key (name) of the tag.
Value of the tag.
None
Remove one or more tags from your private CA. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this operation, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. To add tags to a private CA, use the TagCertificateAuthority . Call the ListTags operation to see what tags are associated with your CA.
See also: AWS API Documentation
Request Syntax
response = client.untag_certificate_authority(
CertificateAuthorityArn='string',
Tags=[
{
'Key': 'string',
'Value': '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 ``
[REQUIRED]
List of tags to be removed from the CA.
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 operation. To remove a tag, call the UntagCertificateAuthority operation.
Key (name) of the tag.
Value of the tag.
None
Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the ACTIVE or DISABLED state before you can update it. You can disable a private CA that is in the ACTIVE state or make a CA that is in the DISABLED state active again.
See also: AWS API Documentation
Request Syntax
response = client.update_certificate_authority(
CertificateAuthorityArn='string',
RevocationConfiguration={
'CrlConfiguration': {
'Enabled': True|False,
'ExpirationInDays': 123,
'CustomCname': 'string',
'S3BucketName': 'string'
}
},
Status='CREATING'|'PENDING_CERTIFICATE'|'ACTIVE'|'DELETED'|'DISABLED'|'EXPIRED'|'FAILED'
)
[REQUIRED]
Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:
``arn:aws:acm-pca:region :account :certificate-authority/12345678-1234-1234-1234-123456789012 ``
Revocation information for your private CA.
Configuration of the certificate revocation list (CRL), if any, maintained by your private CA.
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 operation or for an existing CA when you call the UpdateCertificateAuthority operation.
Number of days until a certificate expires.
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.
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 operation. You must specify a bucket policy that allows ACM PCA to write the CRL to your bucket.
None
The available paginators are:
paginator = client.get_paginator('list_certificate_authorities')
Creates an iterator that will paginate through responses from ACMPCA.Client.list_certificate_authorities().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'CertificateAuthorities': [
{
'Arn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'LastStateChangeAt': datetime(2015, 1, 1),
'Type': '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
Summary information about each certificate authority you have created.
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 operation to create your private CA. You must then call the GetCertificateAuthorityCertificate operation to retrieve a private CA certificate signing request (CSR). Take the CSR to your on-premises CA and sign it with the root CA certificate or a subordinate certificate. Call the ImportCertificateAuthorityCertificate operation to import the signed certificate into AWS Certificate Manager (ACM).
Amazon Resource Name (ARN) for your private certificate authority (CA). The format is `` 12345678-1234-1234-1234-123456789012 `` .
Date and time at which your private CA was created.
Date and time at which your private CA was last updated.
Type of your private CA.
Serial number of your private CA.
Status of your private CA.
Date and time before which your private CA certificate is not valid.
Date and time after which your private CA certificate is not valid.
Reason the request to create your private CA failed.
Your private CA configuration.
Type of the public key algorithm and size, in bits, of the key pair that your key pair creates when it issues a certificate.
Name of the algorithm your private CA uses to sign certificate requests.
Structure that contains X.500 distinguished name information for your private CA.
Two-digit code that specifies the country in which the certificate subject located.
Legal name of the organization with which the certificate subject is affiliated.
A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.
Disambiguating information for the certificate subject.
State in which the subject of the certificate is located.
Fully qualified domain name (FQDN) associated with the certificate subject.
The certificate serial number.
The locality (such as a city or town) in which the certificate subject is located.
A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.
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.
First name.
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 .
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.
Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.
Information about the certificate revocation list (CRL) created and maintained by your private CA.
Configuration of the certificate revocation list (CRL), if any, maintained by your private CA.
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 operation or for an existing CA when you call the UpdateCertificateAuthority operation.
Number of days until a certificate expires.
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.
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 operation. You must specify a bucket policy that allows ACM PCA to write the CRL to your bucket.
The period during which a deleted CA can be restored. For more information, see the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest operation.
paginator = client.get_paginator('list_tags')
Creates an iterator that will paginate through responses from ACMPCA.Client.list_tags().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
CertificateAuthorityArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority operation. This must be of the form:
``arn:aws:acm-pca:region :account :certificate-authority/12345678-1234-1234-1234-123456789012 ``
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
}
Response Structure
(dict) --
Tags (list) --
The tags associated with your private CA.
(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 operation. To remove a tag, call the UntagCertificateAuthority operation.
Key (string) --
Key (name) of the tag.
Value (string) --
Value of the tag.
The available waiters are:
waiter = client.get_waiter('audit_report_created')
Polls ACMPCA.Client.describe_certificate_authority_audit_report() every 3 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
CertificateAuthorityArn='string',
AuditReportId='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the private CA. This must be of the form:
``arn:aws:acm-pca:region :account :certificate-authority/12345678-1234-1234-1234-123456789012 `` .
[REQUIRED]
The report ID returned by calling the CreateCertificateAuthorityAuditReport operation.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 3
The maximum number of attempts to be made. Default: 60
None
waiter = client.get_waiter('certificate_authority_csr_created')
Polls ACMPCA.Client.get_certificate_authority_csr() every 3 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
CertificateAuthorityArn='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority operation. This must be of the form:
``arn:aws:acm-pca:region :account :certificate-authority/12345678-1234-1234-1234-123456789012 ``
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 3
The maximum number of attempts to be made. Default: 60
None
waiter = client.get_waiter('certificate_issued')
Polls ACMPCA.Client.get_certificate() every 3 seconds until a successful state is reached. An error is returned after 60 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
CertificateAuthorityArn='string',
CertificateArn='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[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 `` .
[REQUIRED]
The ARN of the issued certificate. The ARN contains the certificate serial number and must be in the following form:
``arn:aws:acm-pca:region :account :certificate-authority/12345678-1234-1234-1234-123456789012 /certificate/286535153982981100925020015808220737245 ``
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 3
The maximum number of attempts to be made. Default: 60
None