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.
Interface for accessing ACMPCA
This is the Amazon Web Services Private Certificate Authority API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing a private certificate authority (CA) for your organization.The documentation for each action shows the API request parameters and the JSON response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you prefer. For more information, see Amazon Web Services SDKs.
Each Amazon Web Services Private CA API operation has a quota that determines the number of times the operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid request because the request exceeds the operation's quota for the number of requests per second. When a request is throttled, Amazon Web Services Private CA returns a ThrottlingException error. Amazon Web Services Private CA does not guarantee a minimum request rate for APIs.
To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase, log into your Amazon Web Services account and visit the Service Quotas console.
Namespace: Amazon.ACMPCA
Assembly: AWSSDK.ACMPCA.dll
Version: 3.x.y.z
public interface IAmazonACMPCA IAmazonService, IDisposable
The IAmazonACMPCA type exposes the following members
Name | Type | Description | |
---|---|---|---|
Paginators | Amazon.ACMPCA.Model.IACMPCAPaginatorFactory |
Paginators for the service |
Name | Description | |
---|---|---|
CreateCertificateAuthority(CreateCertificateAuthorityRequest) |
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. |
|
CreateCertificateAuthorityAsync(CreateCertificateAuthorityRequest, CancellationToken) |
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. |
|
CreateCertificateAuthorityAuditReport(CreateCertificateAuthorityAuditReportRequest) |
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. |
|
CreateCertificateAuthorityAuditReportAsync(CreateCertificateAuthorityAuditReportRequest, CancellationToken) |
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. |
|
CreatePermission(CreatePermissionRequest) |
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
|
|
CreatePermissionAsync(CreatePermissionRequest, CancellationToken) |
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
|
|
DeleteCertificateAuthority(DeleteCertificateAuthorityRequest) |
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 |
|
DeleteCertificateAuthorityAsync(DeleteCertificateAuthorityRequest, CancellationToken) |
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 |
|
DeletePermission(DeletePermissionRequest) |
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
|
|
DeletePermissionAsync(DeletePermissionRequest, CancellationToken) |
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
|
|
DeletePolicy(DeletePolicyRequest) |
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
|
|
DeletePolicyAsync(DeletePolicyRequest, CancellationToken) |
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
|
|
DescribeCertificateAuthority(DescribeCertificateAuthorityRequest) |
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:
|
|
DescribeCertificateAuthorityAsync(DescribeCertificateAuthorityRequest, CancellationToken) |
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:
|
|
DescribeCertificateAuthorityAuditReport(DescribeCertificateAuthorityAuditReportRequest) |
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. |
|
DescribeCertificateAuthorityAuditReportAsync(DescribeCertificateAuthorityAuditReportRequest, CancellationToken) |
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. |
|
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
|
GetCertificate(GetCertificateRequest) |
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. |
|
GetCertificateAsync(GetCertificateRequest, CancellationToken) |
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. |
|
GetCertificateAuthorityCertificate(GetCertificateAuthorityCertificateRequest) |
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. |
|
GetCertificateAuthorityCertificateAsync(GetCertificateAuthorityCertificateRequest, CancellationToken) |
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. |
|
GetCertificateAuthorityCsr(GetCertificateAuthorityCsrRequest) |
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. |
|
GetCertificateAuthorityCsrAsync(GetCertificateAuthorityCsrRequest, CancellationToken) |
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. |
|
GetPolicy(GetPolicyRequest) |
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
|
|
GetPolicyAsync(GetPolicyRequest, CancellationToken) |
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
|
|
ImportCertificateAuthorityCertificate(ImportCertificateAuthorityCertificateRequest) |
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.
|
|
ImportCertificateAuthorityCertificateAsync(ImportCertificateAuthorityCertificateRequest, CancellationToken) |
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.
|
|
IssueCertificate(IssueCertificateRequest) |
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.
|
|
IssueCertificateAsync(IssueCertificateRequest, CancellationToken) |
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.
|
|
ListCertificateAuthorities(ListCertificateAuthoritiesRequest) |
Lists the private certificate authorities that you created by using the CreateCertificateAuthority action. |
|
ListCertificateAuthoritiesAsync(ListCertificateAuthoritiesRequest, CancellationToken) |
Lists the private certificate authorities that you created by using the CreateCertificateAuthority action. |
|
ListPermissions(ListPermissionsRequest) |
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
|
|
ListPermissionsAsync(ListPermissionsRequest, CancellationToken) |
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
|
|
ListTags(ListTagsRequest) |
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. |
|
ListTagsAsync(ListTagsRequest, CancellationToken) |
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. |
|
PutPolicy(PutPolicyRequest) |
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
|
|
PutPolicyAsync(PutPolicyRequest, CancellationToken) |
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
|
|
RestoreCertificateAuthority(RestoreCertificateAuthorityRequest) |
Restores a certificate authority (CA) that is in the |
|
RestoreCertificateAuthorityAsync(RestoreCertificateAuthorityRequest, CancellationToken) |
Restores a certificate authority (CA) that is in the |
|
RevokeCertificate(RevokeCertificateRequest) |
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. |
|
RevokeCertificateAsync(RevokeCertificateRequest, CancellationToken) |
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. |
|
TagCertificateAuthority(TagCertificateAuthorityRequest) |
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 |
|
TagCertificateAuthorityAsync(TagCertificateAuthorityRequest, CancellationToken) |
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 |
|
UntagCertificateAuthority(UntagCertificateAuthorityRequest) |
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. |
|
UntagCertificateAuthorityAsync(UntagCertificateAuthorityRequest, CancellationToken) |
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. |
|
UpdateCertificateAuthority(UpdateCertificateAuthorityRequest) |
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.
|
|
UpdateCertificateAuthorityAsync(UpdateCertificateAuthorityRequest, CancellationToken) |
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.
|
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5