AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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.
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).
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.
The certificate authority certificate you are importing does not comply with conditions specified in the certificate that signed it.
A previous update to your private CA is still ongoing.
Container for the parameters to the CreateCertificateAuthorityAuditReport operation. Creates an audit report that lists every time that your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate actions use the private key.
This is the response object from the CreateCertificateAuthorityAuditReport operation.
Container for the parameters to the CreateCertificateAuthority operation. 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.
This is the response object from the CreateCertificateAuthority operation.
Container for the parameters to the CreatePermission operation. Assigns permissions from a private CA to a designated AWS service. Services are specified by their service principals and can be given permission to create and retrieve certificates on a private CA. Services can also be given permission to list the active permissions that the private CA has granted. For ACM to automatically renew your private CA's certificates, you must assign all possible permissions from the CA to the ACM service principal.
This is the response object from the CreatePermission operation.
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
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:
Certificate revocation lists created by ACM Private CA are DER-encoded. You can use the following OpenSSL command to list a CRL.
Container for the parameters to the DeleteCertificateAuthority operation.
Deletes a private certificate authority (CA). You must provide the Amazon Resource
Name (ARN) of the private CA that you want to delete. You can find the ARN by calling
the ListCertificateAuthorities action.
Deleting a CA will invalidate other CAs and certificates below it in your CA hierarchy.
Deleting a CA will invalidate other CAs and certificates below it in your CA hierarchy.
Before you can delete a CA that you have created and activated, you must disable it.
To do this, call the UpdateCertificateAuthority action and set the CertificateAuthorityStatus
Additionally, you can delete a CA if you are waiting for it to be created (that is,
the status of the CA is
When you successfully call DeleteCertificateAuthority, the CA's status changes
This is the response object from the DeleteCertificateAuthority operation.
Container for the parameters to the DeletePermission operation. Revokes permissions that a private CA assigned to a designated AWS service. Permissions can be created with the CreatePermission action and listed with the ListPermissions action.
This is the response object from the DeletePermission operation.
Container for the parameters to the DescribeCertificateAuthorityAuditReport operation. Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport action. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the IssueCertificate action or the RevokeCertificate action.
This is the response object from the DescribeCertificateAuthorityAuditReport operation.
Container for the parameters to the DescribeCertificateAuthority operation. 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:
This is the response object from the DescribeCertificateAuthority operation.
Container for the parameters to the GetCertificateAuthorityCertificate operation. 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.
This is the response object from the GetCertificateAuthorityCertificate operation.
Container for the parameters to the GetCertificateAuthorityCsr operation. Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the CreateCertificateAuthority action. Sign the CSR with your ACM Private CA-hosted or on-premises root or subordinate CA. Then import the signed certificate back into ACM Private CA by calling the ImportCertificateAuthorityCertificate action. The CSR is returned as a base64 PEM-encoded string.
This is the response object from the GetCertificateAuthorityCsr operation.
Container for the parameters to the GetCertificate operation. Retrieves a certificate from your private CA. The ARN of the certificate is returned when you call the IssueCertificate action. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the GetCertificate action. You can retrieve the certificate if it is in the ISSUED state. You can call the CreateCertificateAuthorityAuditReport action to create a report that contains information about all of the certificates issued and revoked by your private CA.
This is the response object from the GetCertificate operation.
Container for the parameters to the ImportCertificateAuthorityCertificate operation. Imports a signed private CA certificate into ACM Private CA. This action is used when you are using a chain of trust whose root is located outside ACM Private CA. Before you can call this action, the following preparations must in place:
The following requirements apply when you import a CA certificate.
This is the response object from the ImportCertificateAuthorityCertificate operation.
One or more of the specified arguments was not valid.
The requested Amazon Resource Name (ARN) does not refer to an existing resource.
The token specified in the
The S3 bucket policy is not valid. The policy must give ACM Private CA rights to read from and write to the bucket and find the bucket location.
The request action cannot be performed or is prohibited.
The private CA is in a state during which a report or certificate cannot be generated.
The tag associated with the CA is not valid. The invalid argument is contained in the message field.
Container for the parameters to the IssueCertificate operation.
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.
You cannot use the ACM ListCertificateAuthorities action to retrieve the ARNs
of the certificates that you issue by using ACM Private CA.
You cannot use the ACM ListCertificateAuthorities action to retrieve the ARNs of the certificates that you issue by using ACM Private CA.
This is the response object from the IssueCertificate operation.
An ACM Private CA limit has been exceeded. See the exception message returned to determine the limit that was exceeded.
Container for the parameters to the ListCertificateAuthorities operation. Lists the private certificate authorities that you created by using the CreateCertificateAuthority action.
This is the response object from the ListCertificateAuthorities operation.
Container for the parameters to the ListPermissions operation. Lists all the permissions, if any, that have been assigned by a private CA. Permissions can be granted with the CreatePermission action and revoked with the DeletePermission action.
This is the response object from the ListPermissions operation.
Container for the parameters to the ListTags operation. 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 action to add one or more tags to your CA. Call the UntagCertificateAuthority action to remove tags.
This is the response object from the ListTags operation.
One or more fields in the certificate are invalid.
The certificate signing request is invalid.
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 (
The designated permission has already been given to the user.
Your request has already been completed.
The request has failed for an unspecified reason.
Your request is already in progress.
A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.
Container for the parameters to the RestoreCertificateAuthority operation.
Restores a certificate authority (CA) that is in the
This is the response object from the RestoreCertificateAuthority operation.
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.
Container for the parameters to the RevokeCertificate operation.
Revokes a certificate that was issued inside ACM Private CA. 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 Private CA writes the CRL
to an S3 bucket that you specify. For more information about revocation, see the CrlConfiguration
structure. ACM Private CA also writes revocation information to the audit report.
For more information, see CreateCertificateAuthorityAuditReport.
You cannot revoke a root CA self-signed certificate.
You cannot revoke a root CA self-signed certificate.
This is the response object from the RevokeCertificate operation.
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.
Container for the parameters to the TagCertificateAuthority operation. 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 action. Call the ListTags action to see what tags are associated with your CA.
This is the response object from the TagCertificateAuthority operation.
You can associate up to 50 tags with a private CA. Exception information is contained in the exception message field.
Container for the parameters to the UntagCertificateAuthority operation. 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 action, 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 action to see what tags are associated with your CA.
This is the response object from the UntagCertificateAuthority operation.
Container for the parameters to the UpdateCertificateAuthority operation.
Updates the status or configuration of a private certificate authority (CA). Your
private CA must be in the
This is the response object from the UpdateCertificateAuthority operation.
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.