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.
Name | Description | |
---|---|---|
AccessDescription |
Provides access information used by the |
|
AccessMethod |
Describes the type and format of extension access. Only one of |
|
ACMPCAPaginatorFactory |
Paginators for the ACMPCA service |
|
ApiPassthrough |
Contains X.509 certificate information to be placed in an issued certificate. An If conflicting or duplicate certificate information is supplied from other sources, Amazon Web Services Private CA applies order of operation rules to determine what information is used. |
|
ASN1Subject |
Contains information about the certificate subject. The |
|
CertificateAuthority |
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 Amazon Web Services Private CA-hosted or on-premises root or subordinate CA certificate. Call the ImportCertificateAuthorityCertificate action to import the signed certificate into Certificate Manager (ACM). |
|
CertificateAuthorityConfiguration |
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. |
|
CertificateMismatchException |
The certificate authority certificate you are importing does not comply with conditions specified in the certificate that signed it. |
|
ConcurrentModificationException |
A previous update to your private CA is still ongoing. |
|
CreateCertificateAuthorityAuditReportRequest |
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.
Both Amazon Web Services Private CA and the IAM principal must have permission to
write to the S3 bucket that you specify. If the IAM principal making the call does
not have permission to write to the bucket, then an exception is thrown. For more
information, see Access
policies for CRLs in Amazon S3.
Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your Audit Reports. You can generate a maximum of one report every 30 minutes. |
|
CreateCertificateAuthorityAuditReportResponse |
This is the response object from the CreateCertificateAuthorityAuditReport operation. |
|
CreateCertificateAuthorityRequest |
Container for the parameters to the CreateCertificateAuthority operation.
Creates a root or subordinate private certificate authority (CA). You must specify
the CA configuration, an optional configuration for Online Certificate Status Protocol
(OCSP) and/or a certificate revocation list (CRL), 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 OCSP
configuration can optionally specify a custom URL for the OCSP responder. 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.
Both Amazon Web Services Private CA and the IAM principal must have permission to
write to the S3 bucket that you specify. If the IAM principal making the call does
not have permission to write to the bucket, then an exception is thrown. For more
information, see Access
policies for CRLs in Amazon S3.
Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs. |
|
CreateCertificateAuthorityResponse |
This is the response object from the CreateCertificateAuthority operation. |
|
CreatePermissionRequest |
Container for the parameters to the CreatePermission operation.
Grants one or more permissions on a private CA to the Certificate Manager (ACM) service
principal ( You can list current permissions with the ListPermissions action and revoke them with the DeletePermission action. About Permissions
|
|
CreatePermissionResponse |
This is the response object from the CreatePermission operation. |
|
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 Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs. Your private CA uses the value in the ExpirationInDays parameter to calculate the nextUpdate field in the CRL. The CRL is refreshed prior to a certificate's expiration date or when a certificate is revoked. When a certificate is revoked, it appears in the CRL until the certificate expires, and then in one additional CRL after expiration, and it always appears in the audit report. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason a CRL update fails, Amazon Web Services Private CA makes further attempts every 15 minutes. CRLs contain the following fields:
Certificate revocation lists created by Amazon Web Services Private CA are DER-encoded. You can use the following OpenSSL command to list a CRL.
For more information, see Planning a certificate revocation list (CRL) in the Amazon Web Services Private Certificate Authority User Guide |
|
CrlDistributionPointExtensionConfiguration |
Contains configuration information for the default behavior of the CRL Distribution Point (CDP) extension in certificates issued by your CA. This extension contains a link to download the CRL, so you can check whether a certificate has been revoked. To choose whether you want this extension omitted or not in certificates issued by your CA, you can set the OmitExtension parameter. |
|
CsrExtensions |
Describes the certificate extensions to be added to the certificate signing request (CSR). |
|
CustomAttribute |
Defines the X.500 relative distinguished name (RDN). |
|
CustomExtension |
Specifies the X.509 extension information for a certificate.
Extensions present in |
|
DeleteCertificateAuthorityRequest |
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.
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 parameter to
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 to |
|
DeleteCertificateAuthorityResponse |
This is the response object from the DeleteCertificateAuthority operation. |
|
DeletePermissionRequest |
Container for the parameters to the DeletePermission operation. Revokes permissions on a private CA granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com). These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA. If you revoke these permissions, ACM will no longer renew the affected certificates automatically. Permissions can be granted with the CreatePermission action and listed with the ListPermissions action. About Permissions
|
|
DeletePermissionResponse |
This is the response object from the DeletePermission operation. |
|
DeletePolicyRequest |
Container for the parameters to the DeletePolicy operation. Deletes the resource-based policy attached to a private CA. Deletion will remove any access that the policy has granted. If there is no policy attached to the private CA, this action will return successful. If you delete a policy that was applied through Amazon Web Services Resource Access Manager (RAM), the CA will be removed from all shares in which it was included. The Certificate Manager Service Linked Role that the policy supports is not affected when you delete the policy. The current policy can be shown with GetPolicy and updated with PutPolicy. About Policies
|
|
DeletePolicyResponse |
This is the response object from the DeletePolicy operation. |
|
DescribeCertificateAuthorityAuditReportRequest |
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. |
|
DescribeCertificateAuthorityAuditReportResponse |
This is the response object from the DescribeCertificateAuthorityAuditReport operation. |
|
DescribeCertificateAuthorityRequest |
Container for the parameters to the DescribeCertificateAuthority operation. Lists information about your private certificate authority (CA) or one that has been shared with you. 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:
|
|
DescribeCertificateAuthorityResponse |
This is the response object from the DescribeCertificateAuthority operation. |
|
EdiPartyName |
Describes an Electronic Data Interchange (EDI) entity as described in as defined in Subject Alternative Name in RFC 5280. |
|
ExtendedKeyUsage |
Specifies additional purposes for which the certified public key may be used other
than basic purposes indicated in the |
|
Extensions |
Contains X.509 extension information for a certificate. |
|
GeneralName |
Describes an ASN.1 X.400 |
|
GetCertificateAuthorityCertificateRequest |
Container for the parameters to the GetCertificateAuthorityCertificate operation. Retrieves the certificate and certificate chain for your private certificate authority (CA) or one that has been shared with you. 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. |
|
GetCertificateAuthorityCertificateResponse |
This is the response object from the GetCertificateAuthorityCertificate operation. |
|
GetCertificateAuthorityCsrRequest |
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 Amazon Web Services Private CA-hosted or on-premises root or subordinate CA. Then import the signed certificate back into Amazon Web Services Private CA by calling the ImportCertificateAuthorityCertificate action. The CSR is returned as a base64 PEM-encoded string. |
|
GetCertificateAuthorityCsrResponse |
This is the response object from the GetCertificateAuthorityCsr operation. |
|
GetCertificateRequest |
Container for the parameters to the GetCertificate operation. Retrieves a certificate from your private CA or one that has been shared with you. 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. |
|
GetCertificateResponse |
This is the response object from the GetCertificate operation. |
|
GetPolicyRequest |
Container for the parameters to the GetPolicy operation.
Retrieves the resource-based policy attached to a private CA. If either the private
CA resource or the policy cannot be found, this action returns a The policy can be attached or updated with PutPolicy and removed with DeletePolicy. About Policies
|
|
GetPolicyResponse |
This is the response object from the GetPolicy operation. |
|
ImportCertificateAuthorityCertificateRequest |
Container for the parameters to the ImportCertificateAuthorityCertificate operation. Imports a signed private CA certificate into Amazon Web Services Private CA. This action is used when you are using a chain of trust whose root is located outside Amazon Web Services Private CA. Before you can call this action, the following preparations must in place:
Amazon Web Services Private CA supports three scenarios for installing a CA certificate:
The following additional requirements apply when you import a CA certificate.
Enforcement of Critical Constraints Amazon Web Services Private CA allows the following extensions to be marked critical in the imported CA certificate or chain.
Amazon Web Services Private CA rejects the following extensions when they are marked critical in an imported CA certificate or chain.
|
|
ImportCertificateAuthorityCertificateResponse |
This is the response object from the ImportCertificateAuthorityCertificate operation. |
|
InvalidArgsException |
One or more of the specified arguments was not valid. |
|
InvalidArnException |
The requested Amazon Resource Name (ARN) does not refer to an existing resource. |
|
InvalidNextTokenException |
The token specified in the |
|
InvalidPolicyException |
The resource policy is invalid or is missing a required statement. For general information about IAM policy and statement structure, see Overview of JSON Policies. |
|
InvalidRequestException |
The request action cannot be performed or is prohibited. |
|
InvalidStateException |
The state of the private CA does not allow this action to occur. |
|
InvalidTagException |
The tag associated with the CA is not valid. The invalid argument is contained in the message field. |
|
IssueCertificateRequest |
Container for the parameters to the IssueCertificate operation.
Uses your private certificate authority (CA), or one that has been shared with you,
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 Amazon Web Services Private CA.
|
|
IssueCertificateResponse |
This is the response object from the IssueCertificate operation. |
|
KeyUsage |
Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false. |
|
LimitExceededException |
An Amazon Web Services Private CA quota has been exceeded. See the exception message returned to determine the quota that was exceeded. |
|
ListCertificateAuthoritiesRequest |
Container for the parameters to the ListCertificateAuthorities operation. Lists the private certificate authorities that you created by using the CreateCertificateAuthority action. |
|
ListCertificateAuthoritiesResponse |
This is the response object from the ListCertificateAuthorities operation. |
|
ListPermissionsRequest |
Container for the parameters to the ListPermissions operation. List all permissions on a private CA, if any, granted to the Certificate Manager (ACM) service principal (acm.amazonaws.com). These permissions allow ACM to issue and renew ACM certificates that reside in the same Amazon Web Services account as the CA. Permissions can be granted with the CreatePermission action and revoked with the DeletePermission action. About Permissions
|
|
ListPermissionsResponse |
This is the response object from the ListPermissions operation. |
|
ListTagsRequest |
Container for the parameters to the ListTags operation. Lists the tags, if any, that are associated with your private CA or one that has been shared with you. 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. |
|
ListTagsResponse |
This is the response object from the ListTags operation. |
|
LockoutPreventedException |
The current action was prevented because it would lock the caller out from performing subsequent actions. Verify that the specified parameters would not result in the caller being denied access to the resource. |
|
MalformedCertificateException |
One or more fields in the certificate are invalid. |
|
MalformedCSRException |
The certificate signing request is invalid. |
|
OcspConfiguration |
Contains information to enable and configure Online Certificate Status Protocol (OCSP) for validating certificate revocation status. When you revoke a certificate, OCSP responses may take up to 60 minutes to reflect the new status. |
|
OtherName |
Defines a custom ASN.1 X.400 |
|
Permission |
Permissions designate which private CA actions can be performed by an Amazon Web Services
service or entity. In order for ACM to automatically renew private certificates, you
must give the ACM service principal all available permissions ( |
|
PermissionAlreadyExistsException |
The designated permission has already been given to the user. |
|
PolicyInformation |
Defines the X.509 |
|
PolicyQualifierInfo |
Modifies the |
|
PutPolicyRequest |
Container for the parameters to the PutPolicy operation. Attaches a resource-based policy to a private CA. A policy can also be applied by sharing a private CA through Amazon Web Services Resource Access Manager (RAM). For more information, see Attach a Policy for Cross-Account Access. The policy can be displayed with GetPolicy and removed with DeletePolicy. About Policies
|
|
PutPolicyResponse |
This is the response object from the PutPolicy operation. |
|
Qualifier |
Defines a |
|
RequestAlreadyProcessedException |
Your request has already been completed. |
|
RequestFailedException |
The request has failed for an unspecified reason. |
|
RequestInProgressException |
Your request is already in progress. |
|
ResourceNotFoundException |
A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found. |
|
RestoreCertificateAuthorityRequest |
Container for the parameters to the RestoreCertificateAuthority operation.
Restores a certificate authority (CA) that is in the |
|
RestoreCertificateAuthorityResponse |
This is the response object from the RestoreCertificateAuthority operation. |
|
RevocationConfiguration |
Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions. Your private certificate authority (CA) can configure Online Certificate Status Protocol (OCSP) support and/or maintain a certificate revocation list (CRL). OCSP returns validation information about certificates as requested by clients, and a CRL contains an updated list of certificates revoked by your CA. For more information, see RevokeCertificate and Setting up a certificate revocation method in the Amazon Web Services Private Certificate Authority User Guide. |
|
RevokeCertificateRequest |
Container for the parameters to the RevokeCertificate operation.
Revokes a certificate that was issued inside Amazon Web Services 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. Amazon
Web Services Private CA writes the CRL to an S3 bucket that you specify. A CRL is
typically updated approximately 30 minutes after a certificate is revoked. If for
any reason the CRL update fails, Amazon Web Services Private CA attempts makes further
attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics
Both Amazon Web Services Private CA and the IAM principal must have permission to
write to the S3 bucket that you specify. If the IAM principal making the call does
not have permission to write to the bucket, then an exception is thrown. For more
information, see Access
policies for CRLs in Amazon S3.
Amazon Web Services Private CA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport. You cannot revoke a root CA self-signed certificate. |
|
RevokeCertificateResponse |
This is the response object from the RevokeCertificate operation. |
|
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. |
|
TagCertificateAuthorityRequest |
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 Amazon Web Services 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.
To attach tags to a private CA during the creation procedure, a CA administrator must
first associate an inline IAM policy with the |
|
TagCertificateAuthorityResponse |
This is the response object from the TagCertificateAuthority operation. |
|
TooManyTagsException |
You can associate up to 50 tags with a private CA. Exception information is contained in the exception message field. |
|
UntagCertificateAuthorityRequest |
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. |
|
UntagCertificateAuthorityResponse |
This is the response object from the UntagCertificateAuthority operation. |
|
UpdateCertificateAuthorityRequest |
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
Both Amazon Web Services Private CA and the IAM principal must have permission to
write to the S3 bucket that you specify. If the IAM principal making the call does
not have permission to write to the bucket, then an exception is thrown. For more
information, see Access
policies for CRLs in Amazon S3.
|
|
UpdateCertificateAuthorityResponse |
This is the response object from the UpdateCertificateAuthority operation. |
|
Validity |
Validity specifies the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the validity of a certificate starts or expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280.
Amazon Web Services Private CA API consumes the |
Name | Description | |
---|---|---|
IACMPCAPaginatorFactory |
Paginators for the ACMPCA service |
|
IListCertificateAuthoritiesPaginator |
Paginator for the ListCertificateAuthorities operation |
|
IListPermissionsPaginator |
Paginator for the ListPermissions operation |
|
IListTagsPaginator |
Paginator for the ListTags operation |