Expand description
This is the ACM Private CA API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing private certificate authorities (CA) for your organization.
The documentation for each action shows the Query API request parameters and the XML response. Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs.
Each ACM Private CA API action has a throttling limit which determines the number of times the action can be called per second. For more information, see API Rate Limits in ACM Private CA in the ACM Private CA user guide.
If you’re using the service, you’re probably looking for AcmPcaClient and AcmPca.
Structs§
- ASN1
Subject Contains information about the certificate subject. The certificate can be one issued by your private certificate authority (CA) or it can be your private CA certificate. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate. The DN must be unique for each entity, but your private CA can issue more than one certificate with the same DN to the same entity.
- AcmPca
Client - A client for the ACM-PCA API.
- Certificate
Authority 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).
- Certificate
Authority Configuration Contains configuration information for your private certificate authority (CA). This includes information about the class of public key algorithm and the key pair that your private CA creates when it issues a certificate. It also includes the signature algorithm that it uses when issuing certificates, and its X.500 distinguished name. You must specify this information when you call the CreateCertificateAuthority action.
- Create
Certificate Authority Audit Report Request - Create
Certificate Authority Audit Report Response - Create
Certificate Authority Request - Create
Certificate Authority Response - Create
Permission Request - CrlConfiguration
Contains configuration information for a certificate revocation list (CRL). Your private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You can enable CRLs for your new or an existing private CA by setting the Enabled parameter to
true. Your private CA writes CRLs to an S3 bucket that you specify in the S3BucketName parameter. You can hide the name of your bucket by specifying a value for the CustomCname parameter. Your private CA copies the CNAME or the S3 bucket name to the CRL Distribution Points extension of each certificate it issues. Your S3 bucket policy must give write permission to ACM Private CA.Your private CA uses the value in the ExpirationInDays parameter to calculate the nextUpdate field in the CRL. The CRL is refreshed at 1/2 the age of next update or when a certificate is revoked. When a certificate is revoked, it is recorded in the next CRL that is generated and in the next audit report. Only time valid certificates are listed in the CRL. Expired certificates are not included.
CRLs contain the following fields:
-
Version: The current version number defined in RFC 5280 is V2. The integer value is 0x1.
-
Signature Algorithm: The name of the algorithm used to sign the CRL.
-
Issuer: The X.500 distinguished name of your private CA that issued the CRL.
-
Last Update: The issue date and time of this CRL.
-
Next Update: The day and time by which the next CRL will be issued.
-
Revoked Certificates: List of revoked certificates. Each list item contains the following information.
-
Serial Number: The serial number, in hexadecimal format, of the revoked certificate.
-
Revocation Date: Date and time the certificate was revoked.
-
CRL Entry Extensions: Optional extensions for the CRL entry.
-
X509v3 CRL Reason Code: Reason the certificate was revoked.
-
-
-
CRL Extensions: Optional extensions for the CRL.
-
X509v3 Authority Key Identifier: Identifies the public key associated with the private key used to sign the certificate.
-
X509v3 CRL Number:: Decimal sequence number for the CRL.
-
-
Signature Algorithm: Algorithm used by your private CA to sign the CRL.
-
Signature Value: Signature computed over the CRL.
Certificate revocation lists created by ACM Private CA are DER-encoded. You can use the following OpenSSL command to list a CRL.
openssl crl -inform DER -text -in crl_path -noout-
- Delete
Certificate Authority Request - Delete
Permission Request - Describe
Certificate Authority Audit Report Request - Describe
Certificate Authority Audit Report Response - Describe
Certificate Authority Request - Describe
Certificate Authority Response - GetCertificate
Authority Certificate Request - GetCertificate
Authority Certificate Response - GetCertificate
Authority CsrRequest - GetCertificate
Authority CsrResponse - GetCertificate
Request - GetCertificate
Response - Import
Certificate Authority Certificate Request - Issue
Certificate Request - Issue
Certificate Response - List
Certificate Authorities Request - List
Certificate Authorities Response - List
Permissions Request - List
Permissions Response - List
Tags Request - List
Tags Response - Permission
Permissions designate which private CA actions can be performed by an AWS service or entity. In order for ACM to automatically renew private certificates, you must give the ACM service principal all available permissions (
IssueCertificate,GetCertificate, andListPermissions). Permissions can be assigned with the CreatePermission action, removed with the DeletePermission action, and listed with the ListPermissions action.- Restore
Certificate Authority Request - Revocation
Configuration Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions. Your private certificate authority (CA) can create and maintain a certificate revocation list (CRL). A CRL contains information about certificates revoked by your CA. For more information, see RevokeCertificate.
- Revoke
Certificate Request - Tag
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.
- TagCertificate
Authority Request - Untag
Certificate Authority Request - Update
Certificate Authority Request - Validity
Length of time for which the certificate issued by your private certificate authority (CA), or by the private CA itself, is valid in days, months, or years. You can issue a certificate by calling the IssueCertificate action.
Enums§
- Create
Certificate Authority Audit Report Error - Errors returned by CreateCertificateAuthorityAuditReport
- Create
Certificate Authority Error - Errors returned by CreateCertificateAuthority
- Create
Permission Error - Errors returned by CreatePermission
- Delete
Certificate Authority Error - Errors returned by DeleteCertificateAuthority
- Delete
Permission Error - Errors returned by DeletePermission
- Describe
Certificate Authority Audit Report Error - Errors returned by DescribeCertificateAuthorityAuditReport
- Describe
Certificate Authority Error - Errors returned by DescribeCertificateAuthority
- GetCertificate
Authority Certificate Error - Errors returned by GetCertificateAuthorityCertificate
- GetCertificate
Authority CsrError - Errors returned by GetCertificateAuthorityCsr
- GetCertificate
Error - Errors returned by GetCertificate
- Import
Certificate Authority Certificate Error - Errors returned by ImportCertificateAuthorityCertificate
- Issue
Certificate Error - Errors returned by IssueCertificate
- List
Certificate Authorities Error - Errors returned by ListCertificateAuthorities
- List
Permissions Error - Errors returned by ListPermissions
- List
Tags Error - Errors returned by ListTags
- Restore
Certificate Authority Error - Errors returned by RestoreCertificateAuthority
- Revoke
Certificate Error - Errors returned by RevokeCertificate
- TagCertificate
Authority Error - Errors returned by TagCertificateAuthority
- Untag
Certificate Authority Error - Errors returned by UntagCertificateAuthority
- Update
Certificate Authority Error - Errors returned by UpdateCertificateAuthority
Traits§
- AcmPca
- Trait representing the capabilities of the ACM-PCA API. ACM-PCA clients implement this trait.