AWS SDK for C++  1.8.100
AWS SDK for C++
Public Types | Public Member Functions | List of all members
Aws::ACMPCA::ACMPCAClient Class Reference

#include <ACMPCAClient.h>

+ Inheritance diagram for Aws::ACMPCA::ACMPCAClient:

Public Types

typedef Aws::Client::AWSJsonClient BASECLASS
 
- Public Types inherited from Aws::Client::AWSJsonClient
typedef AWSClient BASECLASS
 

Public Member Functions

 ACMPCAClient (const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 ACMPCAClient (const Aws::Auth::AWSCredentials &credentials, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 ACMPCAClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
virtual ~ACMPCAClient ()
 
virtual Model::CreateCertificateAuthorityOutcome CreateCertificateAuthority (const Model::CreateCertificateAuthorityRequest &request) const
 
virtual Model::CreateCertificateAuthorityOutcomeCallable CreateCertificateAuthorityCallable (const Model::CreateCertificateAuthorityRequest &request) const
 
virtual void CreateCertificateAuthorityAsync (const Model::CreateCertificateAuthorityRequest &request, const CreateCertificateAuthorityResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::CreateCertificateAuthorityAuditReportOutcome CreateCertificateAuthorityAuditReport (const Model::CreateCertificateAuthorityAuditReportRequest &request) const
 
virtual Model::CreateCertificateAuthorityAuditReportOutcomeCallable CreateCertificateAuthorityAuditReportCallable (const Model::CreateCertificateAuthorityAuditReportRequest &request) const
 
virtual void CreateCertificateAuthorityAuditReportAsync (const Model::CreateCertificateAuthorityAuditReportRequest &request, const CreateCertificateAuthorityAuditReportResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::CreatePermissionOutcome CreatePermission (const Model::CreatePermissionRequest &request) const
 
virtual Model::CreatePermissionOutcomeCallable CreatePermissionCallable (const Model::CreatePermissionRequest &request) const
 
virtual void CreatePermissionAsync (const Model::CreatePermissionRequest &request, const CreatePermissionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteCertificateAuthorityOutcome DeleteCertificateAuthority (const Model::DeleteCertificateAuthorityRequest &request) const
 
virtual Model::DeleteCertificateAuthorityOutcomeCallable DeleteCertificateAuthorityCallable (const Model::DeleteCertificateAuthorityRequest &request) const
 
virtual void DeleteCertificateAuthorityAsync (const Model::DeleteCertificateAuthorityRequest &request, const DeleteCertificateAuthorityResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeletePermissionOutcome DeletePermission (const Model::DeletePermissionRequest &request) const
 
virtual Model::DeletePermissionOutcomeCallable DeletePermissionCallable (const Model::DeletePermissionRequest &request) const
 
virtual void DeletePermissionAsync (const Model::DeletePermissionRequest &request, const DeletePermissionResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeletePolicyOutcome DeletePolicy (const Model::DeletePolicyRequest &request) const
 
virtual Model::DeletePolicyOutcomeCallable DeletePolicyCallable (const Model::DeletePolicyRequest &request) const
 
virtual void DeletePolicyAsync (const Model::DeletePolicyRequest &request, const DeletePolicyResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeCertificateAuthorityOutcome DescribeCertificateAuthority (const Model::DescribeCertificateAuthorityRequest &request) const
 
virtual Model::DescribeCertificateAuthorityOutcomeCallable DescribeCertificateAuthorityCallable (const Model::DescribeCertificateAuthorityRequest &request) const
 
virtual void DescribeCertificateAuthorityAsync (const Model::DescribeCertificateAuthorityRequest &request, const DescribeCertificateAuthorityResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeCertificateAuthorityAuditReportOutcome DescribeCertificateAuthorityAuditReport (const Model::DescribeCertificateAuthorityAuditReportRequest &request) const
 
virtual Model::DescribeCertificateAuthorityAuditReportOutcomeCallable DescribeCertificateAuthorityAuditReportCallable (const Model::DescribeCertificateAuthorityAuditReportRequest &request) const
 
virtual void DescribeCertificateAuthorityAuditReportAsync (const Model::DescribeCertificateAuthorityAuditReportRequest &request, const DescribeCertificateAuthorityAuditReportResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetCertificateOutcome GetCertificate (const Model::GetCertificateRequest &request) const
 
virtual Model::GetCertificateOutcomeCallable GetCertificateCallable (const Model::GetCertificateRequest &request) const
 
virtual void GetCertificateAsync (const Model::GetCertificateRequest &request, const GetCertificateResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetCertificateAuthorityCertificateOutcome GetCertificateAuthorityCertificate (const Model::GetCertificateAuthorityCertificateRequest &request) const
 
virtual Model::GetCertificateAuthorityCertificateOutcomeCallable GetCertificateAuthorityCertificateCallable (const Model::GetCertificateAuthorityCertificateRequest &request) const
 
virtual void GetCertificateAuthorityCertificateAsync (const Model::GetCertificateAuthorityCertificateRequest &request, const GetCertificateAuthorityCertificateResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetCertificateAuthorityCsrOutcome GetCertificateAuthorityCsr (const Model::GetCertificateAuthorityCsrRequest &request) const
 
virtual Model::GetCertificateAuthorityCsrOutcomeCallable GetCertificateAuthorityCsrCallable (const Model::GetCertificateAuthorityCsrRequest &request) const
 
virtual void GetCertificateAuthorityCsrAsync (const Model::GetCertificateAuthorityCsrRequest &request, const GetCertificateAuthorityCsrResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetPolicyOutcome GetPolicy (const Model::GetPolicyRequest &request) const
 
virtual Model::GetPolicyOutcomeCallable GetPolicyCallable (const Model::GetPolicyRequest &request) const
 
virtual void GetPolicyAsync (const Model::GetPolicyRequest &request, const GetPolicyResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ImportCertificateAuthorityCertificateOutcome ImportCertificateAuthorityCertificate (const Model::ImportCertificateAuthorityCertificateRequest &request) const
 
virtual Model::ImportCertificateAuthorityCertificateOutcomeCallable ImportCertificateAuthorityCertificateCallable (const Model::ImportCertificateAuthorityCertificateRequest &request) const
 
virtual void ImportCertificateAuthorityCertificateAsync (const Model::ImportCertificateAuthorityCertificateRequest &request, const ImportCertificateAuthorityCertificateResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::IssueCertificateOutcome IssueCertificate (const Model::IssueCertificateRequest &request) const
 
virtual Model::IssueCertificateOutcomeCallable IssueCertificateCallable (const Model::IssueCertificateRequest &request) const
 
virtual void IssueCertificateAsync (const Model::IssueCertificateRequest &request, const IssueCertificateResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListCertificateAuthoritiesOutcome ListCertificateAuthorities (const Model::ListCertificateAuthoritiesRequest &request) const
 
virtual Model::ListCertificateAuthoritiesOutcomeCallable ListCertificateAuthoritiesCallable (const Model::ListCertificateAuthoritiesRequest &request) const
 
virtual void ListCertificateAuthoritiesAsync (const Model::ListCertificateAuthoritiesRequest &request, const ListCertificateAuthoritiesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListPermissionsOutcome ListPermissions (const Model::ListPermissionsRequest &request) const
 
virtual Model::ListPermissionsOutcomeCallable ListPermissionsCallable (const Model::ListPermissionsRequest &request) const
 
virtual void ListPermissionsAsync (const Model::ListPermissionsRequest &request, const ListPermissionsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListTagsOutcome ListTags (const Model::ListTagsRequest &request) const
 
virtual Model::ListTagsOutcomeCallable ListTagsCallable (const Model::ListTagsRequest &request) const
 
virtual void ListTagsAsync (const Model::ListTagsRequest &request, const ListTagsResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::PutPolicyOutcome PutPolicy (const Model::PutPolicyRequest &request) const
 
virtual Model::PutPolicyOutcomeCallable PutPolicyCallable (const Model::PutPolicyRequest &request) const
 
virtual void PutPolicyAsync (const Model::PutPolicyRequest &request, const PutPolicyResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::RestoreCertificateAuthorityOutcome RestoreCertificateAuthority (const Model::RestoreCertificateAuthorityRequest &request) const
 
virtual Model::RestoreCertificateAuthorityOutcomeCallable RestoreCertificateAuthorityCallable (const Model::RestoreCertificateAuthorityRequest &request) const
 
virtual void RestoreCertificateAuthorityAsync (const Model::RestoreCertificateAuthorityRequest &request, const RestoreCertificateAuthorityResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::RevokeCertificateOutcome RevokeCertificate (const Model::RevokeCertificateRequest &request) const
 
virtual Model::RevokeCertificateOutcomeCallable RevokeCertificateCallable (const Model::RevokeCertificateRequest &request) const
 
virtual void RevokeCertificateAsync (const Model::RevokeCertificateRequest &request, const RevokeCertificateResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::TagCertificateAuthorityOutcome TagCertificateAuthority (const Model::TagCertificateAuthorityRequest &request) const
 
virtual Model::TagCertificateAuthorityOutcomeCallable TagCertificateAuthorityCallable (const Model::TagCertificateAuthorityRequest &request) const
 
virtual void TagCertificateAuthorityAsync (const Model::TagCertificateAuthorityRequest &request, const TagCertificateAuthorityResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UntagCertificateAuthorityOutcome UntagCertificateAuthority (const Model::UntagCertificateAuthorityRequest &request) const
 
virtual Model::UntagCertificateAuthorityOutcomeCallable UntagCertificateAuthorityCallable (const Model::UntagCertificateAuthorityRequest &request) const
 
virtual void UntagCertificateAuthorityAsync (const Model::UntagCertificateAuthorityRequest &request, const UntagCertificateAuthorityResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UpdateCertificateAuthorityOutcome UpdateCertificateAuthority (const Model::UpdateCertificateAuthorityRequest &request) const
 
virtual Model::UpdateCertificateAuthorityOutcomeCallable UpdateCertificateAuthorityCallable (const Model::UpdateCertificateAuthorityRequest &request) const
 
virtual void UpdateCertificateAuthorityAsync (const Model::UpdateCertificateAuthorityRequest &request, const UpdateCertificateAuthorityResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
void OverrideEndpoint (const Aws::String &endpoint)
 
- Public Member Functions inherited from Aws::Client::AWSJsonClient
 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSJsonClient ()=default
 
- Public Member Functions inherited from Aws::Client::AWSClient
 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSClient ()
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
void DisableRequestProcessing ()
 
void EnableRequestProcessing ()
 
virtual const char * GetServiceClientName () const
 
virtual void SetServiceClientName (const Aws::String &name)
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::Client::AWSJsonClient
virtual AWSError< CoreErrorsBuildAWSError (const std::shared_ptr< Aws::Http::HttpResponse > &response) const override
 
JsonOutcome MakeRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeRequest (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeEventStreamRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 
- Protected Member Functions inherited from Aws::Client::AWSClient
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod httpMethod, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, Http::HttpMethod httpMethod, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const Aws::AmazonWebServiceRequest &request, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
virtual void BuildHttpRequest (const Aws::AmazonWebServiceRequest &request, const std::shared_ptr< Aws::Http::HttpRequest > &httpRequest) const
 
const std::shared_ptr< AWSErrorMarshaller > & GetErrorMarshaller () const
 
Aws::Client::AWSAuthSignerGetSignerByName (const char *name) const
 
std::shared_ptr< Aws::Http::HttpRequestBuildAndSignHttpRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method, const char *signerName) const
 
std::shared_ptr< Aws::Http::HttpResponseMakeHttpRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 
- Protected Attributes inherited from Aws::Client::AWSClient
Aws::String m_region
 

Detailed 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 quota that determines the number of times the action can be called per second. For more information, see API Rate Quotas in ACM Private CA in the ACM Private CA user guide.

Definition at line 179 of file ACMPCAClient.h.

Member Typedef Documentation

◆ BASECLASS

Definition at line 182 of file ACMPCAClient.h.

Constructor & Destructor Documentation

◆ ACMPCAClient() [1/3]

Aws::ACMPCA::ACMPCAClient::ACMPCAClient ( const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration())

Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ ACMPCAClient() [2/3]

Aws::ACMPCA::ACMPCAClient::ACMPCAClient ( const Aws::Auth::AWSCredentials credentials,
const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration() 
)

Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.

◆ ACMPCAClient() [3/3]

Aws::ACMPCA::ACMPCAClient::ACMPCAClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,
const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration() 
)

Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used

◆ ~ACMPCAClient()

virtual Aws::ACMPCA::ACMPCAClient::~ACMPCAClient ( )
virtual

Member Function Documentation

◆ CreateCertificateAuthority()

virtual Model::CreateCertificateAuthorityOutcome Aws::ACMPCA::ACMPCAClient::CreateCertificateAuthority ( const Model::CreateCertificateAuthorityRequest request) const
virtual

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.

ACM Private CAA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs.

Both PCA 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 Configure Access to ACM Private CA.

See Also:

AWS API Reference

◆ CreateCertificateAuthorityAsync()

virtual void Aws::ACMPCA::ACMPCAClient::CreateCertificateAuthorityAsync ( const Model::CreateCertificateAuthorityRequest request,
const CreateCertificateAuthorityResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

ACM Private CAA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs.

Both PCA 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 Configure Access to ACM Private CA.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ CreateCertificateAuthorityAuditReport()

virtual Model::CreateCertificateAuthorityAuditReportOutcome Aws::ACMPCA::ACMPCAClient::CreateCertificateAuthorityAuditReport ( const Model::CreateCertificateAuthorityAuditReportRequest request) const
virtual

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 PCA 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 Configure Access to ACM Private CA.

ACM Private CAA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your Audit Reports.

See Also:

AWS API Reference

◆ CreateCertificateAuthorityAuditReportAsync()

virtual void Aws::ACMPCA::ACMPCAClient::CreateCertificateAuthorityAuditReportAsync ( const Model::CreateCertificateAuthorityAuditReportRequest request,
const CreateCertificateAuthorityAuditReportResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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 PCA 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 Configure Access to ACM Private CA.

ACM Private CAA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your Audit Reports.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ CreateCertificateAuthorityAuditReportCallable()

virtual Model::CreateCertificateAuthorityAuditReportOutcomeCallable Aws::ACMPCA::ACMPCAClient::CreateCertificateAuthorityAuditReportCallable ( const Model::CreateCertificateAuthorityAuditReportRequest request) const
virtual

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 PCA 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 Configure Access to ACM Private CA.

ACM Private CAA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your Audit Reports.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ CreateCertificateAuthorityCallable()

virtual Model::CreateCertificateAuthorityOutcomeCallable Aws::ACMPCA::ACMPCAClient::CreateCertificateAuthorityCallable ( const Model::CreateCertificateAuthorityRequest request) const
virtual

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.

ACM Private CAA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs.

Both PCA 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 Configure Access to ACM Private CA.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ CreatePermission()

virtual Model::CreatePermissionOutcome Aws::ACMPCA::ACMPCAClient::CreatePermission ( const Model::CreatePermissionRequest request) const
virtual

Grants one or more permissions on a private CA to the AWS Certificate Manager (ACM) service principal (acm.amazonaws.com). These permissions allow ACM to issue and renew ACM certificates that reside in the same AWS account as the CA.

You can list current permissions with the ListPermissions action and revoke them with the DeletePermission action.

About Permissions

  • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

  • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

  • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

See Also:

AWS API Reference

◆ CreatePermissionAsync()

virtual void Aws::ACMPCA::ACMPCAClient::CreatePermissionAsync ( const Model::CreatePermissionRequest request,
const CreatePermissionResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Grants one or more permissions on a private CA to the AWS Certificate Manager (ACM) service principal (acm.amazonaws.com). These permissions allow ACM to issue and renew ACM certificates that reside in the same AWS account as the CA.

You can list current permissions with the ListPermissions action and revoke them with the DeletePermission action.

About Permissions

  • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

  • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

  • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ CreatePermissionCallable()

virtual Model::CreatePermissionOutcomeCallable Aws::ACMPCA::ACMPCAClient::CreatePermissionCallable ( const Model::CreatePermissionRequest request) const
virtual

Grants one or more permissions on a private CA to the AWS Certificate Manager (ACM) service principal (acm.amazonaws.com). These permissions allow ACM to issue and renew ACM certificates that reside in the same AWS account as the CA.

You can list current permissions with the ListPermissions action and revoke them with the DeletePermission action.

About Permissions

  • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

  • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

  • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeleteCertificateAuthority()

virtual Model::DeleteCertificateAuthorityOutcome Aws::ACMPCA::ACMPCAClient::DeleteCertificateAuthority ( const Model::DeleteCertificateAuthorityRequest request) const
virtual

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 DISABLED.

Additionally, you can delete a CA if you are waiting for it to be created (that is, the status of the CA is CREATING). You can also delete it if the CA has been created but you haven't yet imported the signed certificate into ACM Private CA (that is, the status of the CA is PENDING_CERTIFICATE).

When you successfully call DeleteCertificateAuthority, the CA's status changes to DELETED. However, the CA won't be permanently 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 action returns the time remaining in the restoration window of a private CA in the DELETED state. To restore an eligible CA, call the RestoreCertificateAuthority action.

See Also:

AWS API Reference

◆ DeleteCertificateAuthorityAsync()

virtual void Aws::ACMPCA::ACMPCAClient::DeleteCertificateAuthorityAsync ( const Model::DeleteCertificateAuthorityRequest request,
const DeleteCertificateAuthorityResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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 DISABLED.

Additionally, you can delete a CA if you are waiting for it to be created (that is, the status of the CA is CREATING). You can also delete it if the CA has been created but you haven't yet imported the signed certificate into ACM Private CA (that is, the status of the CA is PENDING_CERTIFICATE).

When you successfully call DeleteCertificateAuthority, the CA's status changes to DELETED. However, the CA won't be permanently 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 action returns the time remaining in the restoration window of a private CA in the DELETED state. To restore an eligible CA, call the RestoreCertificateAuthority action.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeleteCertificateAuthorityCallable()

virtual Model::DeleteCertificateAuthorityOutcomeCallable Aws::ACMPCA::ACMPCAClient::DeleteCertificateAuthorityCallable ( const Model::DeleteCertificateAuthorityRequest request) const
virtual

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 DISABLED.

Additionally, you can delete a CA if you are waiting for it to be created (that is, the status of the CA is CREATING). You can also delete it if the CA has been created but you haven't yet imported the signed certificate into ACM Private CA (that is, the status of the CA is PENDING_CERTIFICATE).

When you successfully call DeleteCertificateAuthority, the CA's status changes to DELETED. However, the CA won't be permanently 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 action returns the time remaining in the restoration window of a private CA in the DELETED state. To restore an eligible CA, call the RestoreCertificateAuthority action.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeletePermission()

virtual Model::DeletePermissionOutcome Aws::ACMPCA::ACMPCAClient::DeletePermission ( const Model::DeletePermissionRequest request) const
virtual

Revokes permissions on a private CA granted to the AWS Certificate Manager (ACM) service principal (acm.amazonaws.com).

These permissions allow ACM to issue and renew ACM certificates that reside in the same AWS 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

  • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

  • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

  • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

See Also:

AWS API Reference

◆ DeletePermissionAsync()

virtual void Aws::ACMPCA::ACMPCAClient::DeletePermissionAsync ( const Model::DeletePermissionRequest request,
const DeletePermissionResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Revokes permissions on a private CA granted to the AWS Certificate Manager (ACM) service principal (acm.amazonaws.com).

These permissions allow ACM to issue and renew ACM certificates that reside in the same AWS 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

  • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

  • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

  • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeletePermissionCallable()

virtual Model::DeletePermissionOutcomeCallable Aws::ACMPCA::ACMPCAClient::DeletePermissionCallable ( const Model::DeletePermissionRequest request) const
virtual

Revokes permissions on a private CA granted to the AWS Certificate Manager (ACM) service principal (acm.amazonaws.com).

These permissions allow ACM to issue and renew ACM certificates that reside in the same AWS 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

  • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

  • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

  • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DeletePolicy()

virtual Model::DeletePolicyOutcome Aws::ACMPCA::ACMPCAClient::DeletePolicy ( const Model::DeletePolicyRequest request) const
virtual

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 AWS Resource Access Manager (RAM), the CA will be removed from all shares in which it was included.

The AWS 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

See Also:

AWS API Reference

◆ DeletePolicyAsync()

virtual void Aws::ACMPCA::ACMPCAClient::DeletePolicyAsync ( const Model::DeletePolicyRequest request,
const DeletePolicyResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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 AWS Resource Access Manager (RAM), the CA will be removed from all shares in which it was included.

The AWS 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

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeletePolicyCallable()

virtual Model::DeletePolicyOutcomeCallable Aws::ACMPCA::ACMPCAClient::DeletePolicyCallable ( const Model::DeletePolicyRequest request) const
virtual

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 AWS Resource Access Manager (RAM), the CA will be removed from all shares in which it was included.

The AWS 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

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeCertificateAuthority()

virtual Model::DescribeCertificateAuthorityOutcome Aws::ACMPCA::ACMPCAClient::DescribeCertificateAuthority ( const Model::DescribeCertificateAuthorityRequest request) const
virtual

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:

  • CREATING - ACM Private CA is creating your private certificate authority.

  • PENDING_CERTIFICATE - The certificate is pending. You must use your ACM Private CA-hosted or on-premises root or subordinate CA to sign your private CA CSR and then import it into PCA.

  • ACTIVE - Your private CA is active.

  • DISABLED - Your private CA has been disabled.

  • EXPIRED - Your private CA certificate has expired.

  • FAILED - Your private CA has failed. Your CA can fail because of problems such a network outage or backend AWS failure or other errors. A failed CA can never return to the pending state. You must create a new CA.

  • DELETED - Your private CA is within the restoration period, after which it is permanently deleted. The length of time remaining in the CA's restoration period is also included in this action's output.

See Also:

AWS API Reference

◆ DescribeCertificateAuthorityAsync()

virtual void Aws::ACMPCA::ACMPCAClient::DescribeCertificateAuthorityAsync ( const Model::DescribeCertificateAuthorityRequest request,
const DescribeCertificateAuthorityResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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:

  • CREATING - ACM Private CA is creating your private certificate authority.

  • PENDING_CERTIFICATE - The certificate is pending. You must use your ACM Private CA-hosted or on-premises root or subordinate CA to sign your private CA CSR and then import it into PCA.

  • ACTIVE - Your private CA is active.

  • DISABLED - Your private CA has been disabled.

  • EXPIRED - Your private CA certificate has expired.

  • FAILED - Your private CA has failed. Your CA can fail because of problems such a network outage or backend AWS failure or other errors. A failed CA can never return to the pending state. You must create a new CA.

  • DELETED - Your private CA is within the restoration period, after which it is permanently deleted. The length of time remaining in the CA's restoration period is also included in this action's output.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeCertificateAuthorityAuditReport()

virtual Model::DescribeCertificateAuthorityAuditReportOutcome Aws::ACMPCA::ACMPCAClient::DescribeCertificateAuthorityAuditReport ( const Model::DescribeCertificateAuthorityAuditReportRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ DescribeCertificateAuthorityAuditReportAsync()

virtual void Aws::ACMPCA::ACMPCAClient::DescribeCertificateAuthorityAuditReportAsync ( const Model::DescribeCertificateAuthorityAuditReportRequest request,
const DescribeCertificateAuthorityAuditReportResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DescribeCertificateAuthorityAuditReportCallable()

virtual Model::DescribeCertificateAuthorityAuditReportOutcomeCallable Aws::ACMPCA::ACMPCAClient::DescribeCertificateAuthorityAuditReportCallable ( const Model::DescribeCertificateAuthorityAuditReportRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ DescribeCertificateAuthorityCallable()

virtual Model::DescribeCertificateAuthorityOutcomeCallable Aws::ACMPCA::ACMPCAClient::DescribeCertificateAuthorityCallable ( const Model::DescribeCertificateAuthorityRequest request) const
virtual

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:

  • CREATING - ACM Private CA is creating your private certificate authority.

  • PENDING_CERTIFICATE - The certificate is pending. You must use your ACM Private CA-hosted or on-premises root or subordinate CA to sign your private CA CSR and then import it into PCA.

  • ACTIVE - Your private CA is active.

  • DISABLED - Your private CA has been disabled.

  • EXPIRED - Your private CA certificate has expired.

  • FAILED - Your private CA has failed. Your CA can fail because of problems such a network outage or backend AWS failure or other errors. A failed CA can never return to the pending state. You must create a new CA.

  • DELETED - Your private CA is within the restoration period, after which it is permanently deleted. The length of time remaining in the CA's restoration period is also included in this action's output.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GetCertificate()

virtual Model::GetCertificateOutcome Aws::ACMPCA::ACMPCAClient::GetCertificate ( const Model::GetCertificateRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ GetCertificateAsync()

virtual void Aws::ACMPCA::ACMPCAClient::GetCertificateAsync ( const Model::GetCertificateRequest request,
const GetCertificateResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ GetCertificateAuthorityCertificate()

virtual Model::GetCertificateAuthorityCertificateOutcome Aws::ACMPCA::ACMPCAClient::GetCertificateAuthorityCertificate ( const Model::GetCertificateAuthorityCertificateRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ GetCertificateAuthorityCertificateAsync()

virtual void Aws::ACMPCA::ACMPCAClient::GetCertificateAuthorityCertificateAsync ( const Model::GetCertificateAuthorityCertificateRequest request,
const GetCertificateAuthorityCertificateResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ GetCertificateAuthorityCertificateCallable()

virtual Model::GetCertificateAuthorityCertificateOutcomeCallable Aws::ACMPCA::ACMPCAClient::GetCertificateAuthorityCertificateCallable ( const Model::GetCertificateAuthorityCertificateRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GetCertificateAuthorityCsr()

virtual Model::GetCertificateAuthorityCsrOutcome Aws::ACMPCA::ACMPCAClient::GetCertificateAuthorityCsr ( const Model::GetCertificateAuthorityCsrRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ GetCertificateAuthorityCsrAsync()

virtual void Aws::ACMPCA::ACMPCAClient::GetCertificateAuthorityCsrAsync ( const Model::GetCertificateAuthorityCsrRequest request,
const GetCertificateAuthorityCsrResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ GetCertificateAuthorityCsrCallable()

virtual Model::GetCertificateAuthorityCsrOutcomeCallable Aws::ACMPCA::ACMPCAClient::GetCertificateAuthorityCsrCallable ( const Model::GetCertificateAuthorityCsrRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GetCertificateCallable()

virtual Model::GetCertificateOutcomeCallable Aws::ACMPCA::ACMPCAClient::GetCertificateCallable ( const Model::GetCertificateRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GetPolicy()

virtual Model::GetPolicyOutcome Aws::ACMPCA::ACMPCAClient::GetPolicy ( const Model::GetPolicyRequest request) const
virtual

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 ResourceNotFoundException.

The policy can be attached or updated with PutPolicy and removed with DeletePolicy.

About Policies

See Also:

AWS API Reference

◆ GetPolicyAsync()

virtual void Aws::ACMPCA::ACMPCAClient::GetPolicyAsync ( const Model::GetPolicyRequest request,
const GetPolicyResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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 ResourceNotFoundException.

The policy can be attached or updated with PutPolicy and removed with DeletePolicy.

About Policies

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ GetPolicyCallable()

virtual Model::GetPolicyOutcomeCallable Aws::ACMPCA::ACMPCAClient::GetPolicyCallable ( const Model::GetPolicyRequest request) const
virtual

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 ResourceNotFoundException.

The policy can be attached or updated with PutPolicy and removed with DeletePolicy.

About Policies

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ImportCertificateAuthorityCertificate()

virtual Model::ImportCertificateAuthorityCertificateOutcome Aws::ACMPCA::ACMPCAClient::ImportCertificateAuthorityCertificate ( const Model::ImportCertificateAuthorityCertificateRequest request) const
virtual

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:

  1. In ACM Private CA, call the CreateCertificateAuthority action to create the private CA that that you plan to back with the imported certificate.

  2. Call the GetCertificateAuthorityCsr action to generate a certificate signing request (CSR).

  3. Sign the CSR using a root or intermediate CA hosted by either an on-premises PKI hierarchy or by a commercial CA.

  4. Create a certificate chain and copy the signed certificate and the certificate chain to your working directory.

The following requirements apply when you import a CA certificate.

  • You cannot import a non-self-signed certificate for use as a root CA.

  • You cannot import a self-signed certificate for use as a subordinate CA.

  • Your certificate chain must not include the private CA certificate that you are importing.

  • Your ACM Private CA-hosted or 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.

  • The chain must be PEM-encoded.

  • The maximum allowed size of a certificate is 32 KB.

  • The maximum allowed size of a certificate chain is 2 MB.

Enforcement of Critical Constraints

ACM Private CA allows the following extensions to be marked critical in the imported CA certificate or chain.

  • Basic constraints (must be marked critical)

  • Subject alternative names

  • Key usage

  • Extended key usage

  • Authority key identifier

  • Subject key identifier

  • Issuer alternative name

  • Subject directory attributes

  • Subject information access

  • Certificate policies

  • Policy mappings

  • Inhibit anyPolicy

ACM Private CA rejects the following extensions when they are marked critical in an imported CA certificate or chain.

  • Name constraints

  • Policy constraints

  • CRL distribution points

  • Authority information access

  • Freshest CRL

  • Any other extension

See Also:

AWS API Reference

◆ ImportCertificateAuthorityCertificateAsync()

virtual void Aws::ACMPCA::ACMPCAClient::ImportCertificateAuthorityCertificateAsync ( const Model::ImportCertificateAuthorityCertificateRequest request,
const ImportCertificateAuthorityCertificateResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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:

  1. In ACM Private CA, call the CreateCertificateAuthority action to create the private CA that that you plan to back with the imported certificate.

  2. Call the GetCertificateAuthorityCsr action to generate a certificate signing request (CSR).

  3. Sign the CSR using a root or intermediate CA hosted by either an on-premises PKI hierarchy or by a commercial CA.

  4. Create a certificate chain and copy the signed certificate and the certificate chain to your working directory.

The following requirements apply when you import a CA certificate.

  • You cannot import a non-self-signed certificate for use as a root CA.

  • You cannot import a self-signed certificate for use as a subordinate CA.

  • Your certificate chain must not include the private CA certificate that you are importing.

  • Your ACM Private CA-hosted or 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.

  • The chain must be PEM-encoded.

  • The maximum allowed size of a certificate is 32 KB.

  • The maximum allowed size of a certificate chain is 2 MB.

Enforcement of Critical Constraints

ACM Private CA allows the following extensions to be marked critical in the imported CA certificate or chain.

  • Basic constraints (must be marked critical)

  • Subject alternative names

  • Key usage

  • Extended key usage

  • Authority key identifier

  • Subject key identifier

  • Issuer alternative name

  • Subject directory attributes

  • Subject information access

  • Certificate policies

  • Policy mappings

  • Inhibit anyPolicy

ACM Private CA rejects the following extensions when they are marked critical in an imported CA certificate or chain.

  • Name constraints

  • Policy constraints

  • CRL distribution points

  • Authority information access

  • Freshest CRL

  • Any other extension

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ImportCertificateAuthorityCertificateCallable()

virtual Model::ImportCertificateAuthorityCertificateOutcomeCallable Aws::ACMPCA::ACMPCAClient::ImportCertificateAuthorityCertificateCallable ( const Model::ImportCertificateAuthorityCertificateRequest request) const
virtual

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:

  1. In ACM Private CA, call the CreateCertificateAuthority action to create the private CA that that you plan to back with the imported certificate.

  2. Call the GetCertificateAuthorityCsr action to generate a certificate signing request (CSR).

  3. Sign the CSR using a root or intermediate CA hosted by either an on-premises PKI hierarchy or by a commercial CA.

  4. Create a certificate chain and copy the signed certificate and the certificate chain to your working directory.

The following requirements apply when you import a CA certificate.

  • You cannot import a non-self-signed certificate for use as a root CA.

  • You cannot import a self-signed certificate for use as a subordinate CA.

  • Your certificate chain must not include the private CA certificate that you are importing.

  • Your ACM Private CA-hosted or 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.

  • The chain must be PEM-encoded.

  • The maximum allowed size of a certificate is 32 KB.

  • The maximum allowed size of a certificate chain is 2 MB.

Enforcement of Critical Constraints

ACM Private CA allows the following extensions to be marked critical in the imported CA certificate or chain.

  • Basic constraints (must be marked critical)

  • Subject alternative names

  • Key usage

  • Extended key usage

  • Authority key identifier

  • Subject key identifier

  • Issuer alternative name

  • Subject directory attributes

  • Subject information access

  • Certificate policies

  • Policy mappings

  • Inhibit anyPolicy

ACM Private CA rejects the following extensions when they are marked critical in an imported CA certificate or chain.

  • Name constraints

  • Policy constraints

  • CRL distribution points

  • Authority information access

  • Freshest CRL

  • Any other extension

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ IssueCertificate()

virtual Model::IssueCertificateOutcome Aws::ACMPCA::ACMPCAClient::IssueCertificate ( const Model::IssueCertificateRequest request) const
virtual

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 ACM Private CA.

See Also:

AWS API Reference

◆ IssueCertificateAsync()

virtual void Aws::ACMPCA::ACMPCAClient::IssueCertificateAsync ( const Model::IssueCertificateRequest request,
const IssueCertificateResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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 ACM Private CA.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ IssueCertificateCallable()

virtual Model::IssueCertificateOutcomeCallable Aws::ACMPCA::ACMPCAClient::IssueCertificateCallable ( const Model::IssueCertificateRequest request) const
virtual

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 ACM Private CA.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListCertificateAuthorities()

virtual Model::ListCertificateAuthoritiesOutcome Aws::ACMPCA::ACMPCAClient::ListCertificateAuthorities ( const Model::ListCertificateAuthoritiesRequest request) const
virtual

Lists the private certificate authorities that you created by using the CreateCertificateAuthority action.

See Also:

AWS API Reference

◆ ListCertificateAuthoritiesAsync()

virtual void Aws::ACMPCA::ACMPCAClient::ListCertificateAuthoritiesAsync ( const Model::ListCertificateAuthoritiesRequest request,
const ListCertificateAuthoritiesResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Lists the private certificate authorities that you created by using the CreateCertificateAuthority action.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListCertificateAuthoritiesCallable()

virtual Model::ListCertificateAuthoritiesOutcomeCallable Aws::ACMPCA::ACMPCAClient::ListCertificateAuthoritiesCallable ( const Model::ListCertificateAuthoritiesRequest request) const
virtual

Lists the private certificate authorities that you created by using the CreateCertificateAuthority action.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListPermissions()

virtual Model::ListPermissionsOutcome Aws::ACMPCA::ACMPCAClient::ListPermissions ( const Model::ListPermissionsRequest request) const
virtual

List all permissions on a private CA, if any, granted to the AWS Certificate Manager (ACM) service principal (acm.amazonaws.com).

These permissions allow ACM to issue and renew ACM certificates that reside in the same AWS account as the CA.

Permissions can be granted with the CreatePermission action and revoked with the DeletePermission action.

About Permissions

  • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

  • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

  • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

See Also:

AWS API Reference

◆ ListPermissionsAsync()

virtual void Aws::ACMPCA::ACMPCAClient::ListPermissionsAsync ( const Model::ListPermissionsRequest request,
const ListPermissionsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

List all permissions on a private CA, if any, granted to the AWS Certificate Manager (ACM) service principal (acm.amazonaws.com).

These permissions allow ACM to issue and renew ACM certificates that reside in the same AWS account as the CA.

Permissions can be granted with the CreatePermission action and revoked with the DeletePermission action.

About Permissions

  • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

  • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

  • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListPermissionsCallable()

virtual Model::ListPermissionsOutcomeCallable Aws::ACMPCA::ACMPCAClient::ListPermissionsCallable ( const Model::ListPermissionsRequest request) const
virtual

List all permissions on a private CA, if any, granted to the AWS Certificate Manager (ACM) service principal (acm.amazonaws.com).

These permissions allow ACM to issue and renew ACM certificates that reside in the same AWS account as the CA.

Permissions can be granted with the CreatePermission action and revoked with the DeletePermission action.

About Permissions

  • If the private CA and the certificates it issues reside in the same account, you can use CreatePermission to grant permissions for ACM to carry out automatic certificate renewals.

  • For automatic certificate renewal to succeed, the ACM service principal needs permissions to create, retrieve, and list certificates.

  • If the private CA and the ACM certificates reside in different accounts, then permissions cannot be used to enable automatic renewals. Instead, the ACM certificate owner must set up a resource-based policy to enable cross-account issuance and renewals. For more information, see Using a Resource Based Policy with ACM Private CA.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListTags()

virtual Model::ListTagsOutcome Aws::ACMPCA::ACMPCAClient::ListTags ( const Model::ListTagsRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ ListTagsAsync()

virtual void Aws::ACMPCA::ACMPCAClient::ListTagsAsync ( const Model::ListTagsRequest request,
const ListTagsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListTagsCallable()

virtual Model::ListTagsOutcomeCallable Aws::ACMPCA::ACMPCAClient::ListTagsCallable ( const Model::ListTagsRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ OverrideEndpoint()

void Aws::ACMPCA::ACMPCAClient::OverrideEndpoint ( const Aws::String endpoint)

◆ PutPolicy()

virtual Model::PutPolicyOutcome Aws::ACMPCA::ACMPCAClient::PutPolicy ( const Model::PutPolicyRequest request) const
virtual

Attaches a resource-based policy to a private CA.

A policy can also be applied by sharing a private CA through AWS Resource Access Manager (RAM).

The policy can be displayed with GetPolicy and removed with DeletePolicy.

About Policies

See Also:

AWS API Reference

◆ PutPolicyAsync()

virtual void Aws::ACMPCA::ACMPCAClient::PutPolicyAsync ( const Model::PutPolicyRequest request,
const PutPolicyResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Attaches a resource-based policy to a private CA.

A policy can also be applied by sharing a private CA through AWS Resource Access Manager (RAM).

The policy can be displayed with GetPolicy and removed with DeletePolicy.

About Policies

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ PutPolicyCallable()

virtual Model::PutPolicyOutcomeCallable Aws::ACMPCA::ACMPCAClient::PutPolicyCallable ( const Model::PutPolicyRequest request) const
virtual

Attaches a resource-based policy to a private CA.

A policy can also be applied by sharing a private CA through AWS Resource Access Manager (RAM).

The policy can be displayed with GetPolicy and removed with DeletePolicy.

About Policies

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ RestoreCertificateAuthority()

virtual Model::RestoreCertificateAuthorityOutcome Aws::ACMPCA::ACMPCAClient::RestoreCertificateAuthority ( const Model::RestoreCertificateAuthorityRequest request) const
virtual

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 action. 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 actions. The status of a restored CA is set to its pre-deletion status when the RestoreCertificateAuthority action returns. To change its status to ACTIVE, call the UpdateCertificateAuthority action. If the private CA was in the PENDING_CERTIFICATE state at deletion, you must use the ImportCertificateAuthorityCertificate action 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 Reference

◆ RestoreCertificateAuthorityAsync()

virtual void Aws::ACMPCA::ACMPCAClient::RestoreCertificateAuthorityAsync ( const Model::RestoreCertificateAuthorityRequest request,
const RestoreCertificateAuthorityResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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 action. 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 actions. The status of a restored CA is set to its pre-deletion status when the RestoreCertificateAuthority action returns. To change its status to ACTIVE, call the UpdateCertificateAuthority action. If the private CA was in the PENDING_CERTIFICATE state at deletion, you must use the ImportCertificateAuthorityCertificate action 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 Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ RestoreCertificateAuthorityCallable()

virtual Model::RestoreCertificateAuthorityOutcomeCallable Aws::ACMPCA::ACMPCAClient::RestoreCertificateAuthorityCallable ( const Model::RestoreCertificateAuthorityRequest request) const
virtual

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 action. 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 actions. The status of a restored CA is set to its pre-deletion status when the RestoreCertificateAuthority action returns. To change its status to ACTIVE, call the UpdateCertificateAuthority action. If the private CA was in the PENDING_CERTIFICATE state at deletion, you must use the ImportCertificateAuthorityCertificate action 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 Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ RevokeCertificate()

virtual Model::RevokeCertificateOutcome Aws::ACMPCA::ACMPCAClient::RevokeCertificate ( const Model::RevokeCertificateRequest request) const
virtual

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. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason the CRL update fails, ACM Private CA attempts makes further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics CRLGenerated and MisconfiguredCRLBucket. For more information, see Supported CloudWatch Metrics.

Both PCA 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 Configure Access to ACM Private CA.

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.

See Also:

AWS API Reference

◆ RevokeCertificateAsync()

virtual void Aws::ACMPCA::ACMPCAClient::RevokeCertificateAsync ( const Model::RevokeCertificateRequest request,
const RevokeCertificateResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason the CRL update fails, ACM Private CA attempts makes further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics CRLGenerated and MisconfiguredCRLBucket. For more information, see Supported CloudWatch Metrics.

Both PCA 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 Configure Access to ACM Private CA.

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ RevokeCertificateCallable()

virtual Model::RevokeCertificateOutcomeCallable Aws::ACMPCA::ACMPCAClient::RevokeCertificateCallable ( const Model::RevokeCertificateRequest request) const
virtual

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. A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason the CRL update fails, ACM Private CA attempts makes further attempts every 15 minutes. With Amazon CloudWatch, you can create alarms for the metrics CRLGenerated and MisconfiguredCRLBucket. For more information, see Supported CloudWatch Metrics.

Both PCA 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 Configure Access to ACM Private CA.

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ TagCertificateAuthority()

virtual Model::TagCertificateAuthorityOutcome Aws::ACMPCA::ACMPCAClient::TagCertificateAuthority ( const Model::TagCertificateAuthorityRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ TagCertificateAuthorityAsync()

virtual void Aws::ACMPCA::ACMPCAClient::TagCertificateAuthorityAsync ( const Model::TagCertificateAuthorityRequest request,
const TagCertificateAuthorityResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ TagCertificateAuthorityCallable()

virtual Model::TagCertificateAuthorityOutcomeCallable Aws::ACMPCA::ACMPCAClient::TagCertificateAuthorityCallable ( const Model::TagCertificateAuthorityRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UntagCertificateAuthority()

virtual Model::UntagCertificateAuthorityOutcome Aws::ACMPCA::ACMPCAClient::UntagCertificateAuthority ( const Model::UntagCertificateAuthorityRequest request) const
virtual

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.

See Also:

AWS API Reference

◆ UntagCertificateAuthorityAsync()

virtual void Aws::ACMPCA::ACMPCAClient::UntagCertificateAuthorityAsync ( const Model::UntagCertificateAuthorityRequest request,
const UntagCertificateAuthorityResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UntagCertificateAuthorityCallable()

virtual Model::UntagCertificateAuthorityOutcomeCallable Aws::ACMPCA::ACMPCAClient::UntagCertificateAuthorityCallable ( const Model::UntagCertificateAuthorityRequest request) const
virtual

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.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UpdateCertificateAuthority()

virtual Model::UpdateCertificateAuthorityOutcome Aws::ACMPCA::ACMPCAClient::UpdateCertificateAuthority ( const Model::UpdateCertificateAuthorityRequest request) const
virtual

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.

Both PCA 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 Configure Access to ACM Private CA.

See Also:

AWS API Reference

◆ UpdateCertificateAuthorityAsync()

virtual void Aws::ACMPCA::ACMPCAClient::UpdateCertificateAuthorityAsync ( const Model::UpdateCertificateAuthorityRequest request,
const UpdateCertificateAuthorityResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

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.

Both PCA 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 Configure Access to ACM Private CA.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UpdateCertificateAuthorityCallable()

virtual Model::UpdateCertificateAuthorityOutcomeCallable Aws::ACMPCA::ACMPCAClient::UpdateCertificateAuthorityCallable ( const Model::UpdateCertificateAuthorityRequest request) const
virtual

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.

Both PCA 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 Configure Access to ACM Private CA.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.


The documentation for this class was generated from the following file: