AWS SDK for C++  1.8.95
AWS SDK for C++
Public Types | Public Member Functions | List of all members
Aws::ACM::ACMClient Class Reference

#include <ACMClient.h>

+ Inheritance diagram for Aws::ACM::ACMClient:

Public Types

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

Public Member Functions

 ACMClient (const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 ACMClient (const Aws::Auth::AWSCredentials &credentials, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 ACMClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
virtual ~ACMClient ()
 
virtual Model::AddTagsToCertificateOutcome AddTagsToCertificate (const Model::AddTagsToCertificateRequest &request) const
 
virtual Model::AddTagsToCertificateOutcomeCallable AddTagsToCertificateCallable (const Model::AddTagsToCertificateRequest &request) const
 
virtual void AddTagsToCertificateAsync (const Model::AddTagsToCertificateRequest &request, const AddTagsToCertificateResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DeleteCertificateOutcome DeleteCertificate (const Model::DeleteCertificateRequest &request) const
 
virtual Model::DeleteCertificateOutcomeCallable DeleteCertificateCallable (const Model::DeleteCertificateRequest &request) const
 
virtual void DeleteCertificateAsync (const Model::DeleteCertificateRequest &request, const DeleteCertificateResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::DescribeCertificateOutcome DescribeCertificate (const Model::DescribeCertificateRequest &request) const
 
virtual Model::DescribeCertificateOutcomeCallable DescribeCertificateCallable (const Model::DescribeCertificateRequest &request) const
 
virtual void DescribeCertificateAsync (const Model::DescribeCertificateRequest &request, const DescribeCertificateResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ExportCertificateOutcome ExportCertificate (const Model::ExportCertificateRequest &request) const
 
virtual Model::ExportCertificateOutcomeCallable ExportCertificateCallable (const Model::ExportCertificateRequest &request) const
 
virtual void ExportCertificateAsync (const Model::ExportCertificateRequest &request, const ExportCertificateResponseReceivedHandler &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::ImportCertificateOutcome ImportCertificate (const Model::ImportCertificateRequest &request) const
 
virtual Model::ImportCertificateOutcomeCallable ImportCertificateCallable (const Model::ImportCertificateRequest &request) const
 
virtual void ImportCertificateAsync (const Model::ImportCertificateRequest &request, const ImportCertificateResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListCertificatesOutcome ListCertificates (const Model::ListCertificatesRequest &request) const
 
virtual Model::ListCertificatesOutcomeCallable ListCertificatesCallable (const Model::ListCertificatesRequest &request) const
 
virtual void ListCertificatesAsync (const Model::ListCertificatesRequest &request, const ListCertificatesResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListTagsForCertificateOutcome ListTagsForCertificate (const Model::ListTagsForCertificateRequest &request) const
 
virtual Model::ListTagsForCertificateOutcomeCallable ListTagsForCertificateCallable (const Model::ListTagsForCertificateRequest &request) const
 
virtual void ListTagsForCertificateAsync (const Model::ListTagsForCertificateRequest &request, const ListTagsForCertificateResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::RemoveTagsFromCertificateOutcome RemoveTagsFromCertificate (const Model::RemoveTagsFromCertificateRequest &request) const
 
virtual Model::RemoveTagsFromCertificateOutcomeCallable RemoveTagsFromCertificateCallable (const Model::RemoveTagsFromCertificateRequest &request) const
 
virtual void RemoveTagsFromCertificateAsync (const Model::RemoveTagsFromCertificateRequest &request, const RemoveTagsFromCertificateResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::RenewCertificateOutcome RenewCertificate (const Model::RenewCertificateRequest &request) const
 
virtual Model::RenewCertificateOutcomeCallable RenewCertificateCallable (const Model::RenewCertificateRequest &request) const
 
virtual void RenewCertificateAsync (const Model::RenewCertificateRequest &request, const RenewCertificateResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::RequestCertificateOutcome RequestCertificate (const Model::RequestCertificateRequest &request) const
 
virtual Model::RequestCertificateOutcomeCallable RequestCertificateCallable (const Model::RequestCertificateRequest &request) const
 
virtual void RequestCertificateAsync (const Model::RequestCertificateRequest &request, const RequestCertificateResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ResendValidationEmailOutcome ResendValidationEmail (const Model::ResendValidationEmailRequest &request) const
 
virtual Model::ResendValidationEmailOutcomeCallable ResendValidationEmailCallable (const Model::ResendValidationEmailRequest &request) const
 
virtual void ResendValidationEmailAsync (const Model::ResendValidationEmailRequest &request, const ResendValidationEmailResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UpdateCertificateOptionsOutcome UpdateCertificateOptions (const Model::UpdateCertificateOptionsRequest &request) const
 
virtual Model::UpdateCertificateOptionsOutcomeCallable UpdateCertificateOptionsCallable (const Model::UpdateCertificateOptionsRequest &request) const
 
virtual void UpdateCertificateOptionsAsync (const Model::UpdateCertificateOptionsRequest &request, const UpdateCertificateOptionsResponseReceivedHandler &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

<fullname>AWS Certificate Manager</fullname>

Welcome to the AWS Certificate Manager (ACM) API documentation.

You can use ACM to manage SSL/TLS certificates for your AWS-based websites and applications. For general information about using ACM, see the AWS Certificate Manager User Guide .

Definition at line 128 of file ACMClient.h.

Member Typedef Documentation

◆ BASECLASS

Definition at line 131 of file ACMClient.h.

Constructor & Destructor Documentation

◆ ACMClient() [1/3]

Aws::ACM::ACMClient::ACMClient ( 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.

◆ ACMClient() [2/3]

Aws::ACM::ACMClient::ACMClient ( 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.

◆ ACMClient() [3/3]

Aws::ACM::ACMClient::ACMClient ( 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

◆ ~ACMClient()

virtual Aws::ACM::ACMClient::~ACMClient ( )
virtual

Member Function Documentation

◆ AddTagsToCertificate()

virtual Model::AddTagsToCertificateOutcome Aws::ACM::ACMClient::AddTagsToCertificate ( const Model::AddTagsToCertificateRequest request) const
virtual

Adds one or more tags to an ACM certificate. 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 certificate 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 certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see Tagging ACM certificates.

To remove one or more tags, use the RemoveTagsFromCertificate action. To view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action.

See Also:

AWS API Reference

◆ AddTagsToCertificateAsync()

virtual void Aws::ACM::ACMClient::AddTagsToCertificateAsync ( const Model::AddTagsToCertificateRequest request,
const AddTagsToCertificateResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Adds one or more tags to an ACM certificate. 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 certificate 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 certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see Tagging ACM certificates.

To remove one or more tags, use the RemoveTagsFromCertificate action. To view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action.

See Also:

AWS API Reference

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

◆ AddTagsToCertificateCallable()

virtual Model::AddTagsToCertificateOutcomeCallable Aws::ACM::ACMClient::AddTagsToCertificateCallable ( const Model::AddTagsToCertificateRequest request) const
virtual

Adds one or more tags to an ACM certificate. 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 certificate 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 certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see Tagging ACM certificates.

To remove one or more tags, use the RemoveTagsFromCertificate action. To view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action.

See Also:

AWS API Reference

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

◆ DeleteCertificate()

virtual Model::DeleteCertificateOutcome Aws::ACM::ACMClient::DeleteCertificate ( const Model::DeleteCertificateRequest request) const
virtual

Deletes a certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action. The certificate will not be available for use by AWS services integrated with ACM.

You cannot delete an ACM certificate that is being used by another AWS service. To delete a certificate that is in use, the certificate association must first be removed.

See Also:

AWS API Reference

◆ DeleteCertificateAsync()

virtual void Aws::ACM::ACMClient::DeleteCertificateAsync ( const Model::DeleteCertificateRequest request,
const DeleteCertificateResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Deletes a certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action. The certificate will not be available for use by AWS services integrated with ACM.

You cannot delete an ACM certificate that is being used by another AWS service. To delete a certificate that is in use, the certificate association must first be removed.

See Also:

AWS API Reference

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

◆ DeleteCertificateCallable()

virtual Model::DeleteCertificateOutcomeCallable Aws::ACM::ACMClient::DeleteCertificateCallable ( const Model::DeleteCertificateRequest request) const
virtual

Deletes a certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action. The certificate will not be available for use by AWS services integrated with ACM.

You cannot delete an ACM certificate that is being used by another AWS service. To delete a certificate that is in use, the certificate association must first be removed.

See Also:

AWS API Reference

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

◆ DescribeCertificate()

virtual Model::DescribeCertificateOutcome Aws::ACM::ACMClient::DescribeCertificate ( const Model::DescribeCertificateRequest request) const
virtual

Returns detailed metadata about the specified ACM certificate.

See Also:

AWS API Reference

◆ DescribeCertificateAsync()

virtual void Aws::ACM::ACMClient::DescribeCertificateAsync ( const Model::DescribeCertificateRequest request,
const DescribeCertificateResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Returns detailed metadata about the specified ACM certificate.

See Also:

AWS API Reference

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

◆ DescribeCertificateCallable()

virtual Model::DescribeCertificateOutcomeCallable Aws::ACM::ACMClient::DescribeCertificateCallable ( const Model::DescribeCertificateRequest request) const
virtual

Returns detailed metadata about the specified ACM certificate.

See Also:

AWS API Reference

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

◆ ExportCertificate()

virtual Model::ExportCertificateOutcome Aws::ACM::ACMClient::ExportCertificate ( const Model::ExportCertificateRequest request) const
virtual

Exports a private certificate issued by a private certificate authority (CA) for use anywhere. The exported file contains the certificate, the certificate chain, and the encrypted private 2048-bit RSA key associated with the public key that is embedded in the certificate. For security, you must assign a passphrase for the private key when exporting it.

For information about exporting and formatting a certificate using the ACM console or CLI, see Export a Private Certificate.

See Also:

AWS API Reference

◆ ExportCertificateAsync()

virtual void Aws::ACM::ACMClient::ExportCertificateAsync ( const Model::ExportCertificateRequest request,
const ExportCertificateResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Exports a private certificate issued by a private certificate authority (CA) for use anywhere. The exported file contains the certificate, the certificate chain, and the encrypted private 2048-bit RSA key associated with the public key that is embedded in the certificate. For security, you must assign a passphrase for the private key when exporting it.

For information about exporting and formatting a certificate using the ACM console or CLI, see Export a Private Certificate.

See Also:

AWS API Reference

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

◆ ExportCertificateCallable()

virtual Model::ExportCertificateOutcomeCallable Aws::ACM::ACMClient::ExportCertificateCallable ( const Model::ExportCertificateRequest request) const
virtual

Exports a private certificate issued by a private certificate authority (CA) for use anywhere. The exported file contains the certificate, the certificate chain, and the encrypted private 2048-bit RSA key associated with the public key that is embedded in the certificate. For security, you must assign a passphrase for the private key when exporting it.

For information about exporting and formatting a certificate using the ACM console or CLI, see Export a Private Certificate.

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::ACM::ACMClient::GetCertificate ( const Model::GetCertificateRequest request) const
virtual

Retrieves an Amazon-issued certificate and its certificate chain. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs. All of the certificates are base64 encoded. You can use OpenSSL to decode the certificates and inspect individual fields.

See Also:

AWS API Reference

◆ GetCertificateAsync()

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

Retrieves an Amazon-issued certificate and its certificate chain. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs. All of the certificates are base64 encoded. You can use OpenSSL to decode the certificates and inspect individual fields.

See Also:

AWS API Reference

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

◆ GetCertificateCallable()

virtual Model::GetCertificateOutcomeCallable Aws::ACM::ACMClient::GetCertificateCallable ( const Model::GetCertificateRequest request) const
virtual

Retrieves an Amazon-issued certificate and its certificate chain. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs. All of the certificates are base64 encoded. You can use OpenSSL to decode the certificates and inspect individual fields.

See Also:

AWS API Reference

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

◆ ImportCertificate()

virtual Model::ImportCertificateOutcome Aws::ACM::ACMClient::ImportCertificate ( const Model::ImportCertificateRequest request) const
virtual

Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with ACM. Note that integrated services allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see Importing Certificates in the AWS Certificate Manager User Guide.

ACM does not provide managed renewal for certificates that you import.

Note the following guidelines when importing third party certificates:

  • You must enter the private key that matches the certificate you are importing.

  • The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase.

  • If the certificate you are importing is not self-signed, you must enter its certificate chain.

  • If a certificate chain is included, the issuer must be the subject of one of the certificates in the chain.

  • The certificate, private key, and certificate chain must be PEM-encoded.

  • The current time must be between the Not Before and Not After certificate fields.

  • The Issuer field must not be empty.

  • The OCSP authority URL, if present, must not exceed 1000 characters.

  • To import a new certificate, omit the CertificateArn argument. Include this argument only when you want to replace a previously imported certifica

  • When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the private key by their file names preceded by file://. For example, you can specify a certificate saved in the C: folder as file://C:.pem. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs.

  • When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using.

  • The cryptographic algorithm of an imported certificate must match the algorithm of the signing CA. For example, if the signing CA key type is RSA, then the certificate key type must also be RSA.

This operation returns the Amazon Resource Name (ARN) of the imported certificate.

See Also:

AWS API Reference

◆ ImportCertificateAsync()

virtual void Aws::ACM::ACMClient::ImportCertificateAsync ( const Model::ImportCertificateRequest request,
const ImportCertificateResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with ACM. Note that integrated services allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see Importing Certificates in the AWS Certificate Manager User Guide.

ACM does not provide managed renewal for certificates that you import.

Note the following guidelines when importing third party certificates:

  • You must enter the private key that matches the certificate you are importing.

  • The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase.

  • If the certificate you are importing is not self-signed, you must enter its certificate chain.

  • If a certificate chain is included, the issuer must be the subject of one of the certificates in the chain.

  • The certificate, private key, and certificate chain must be PEM-encoded.

  • The current time must be between the Not Before and Not After certificate fields.

  • The Issuer field must not be empty.

  • The OCSP authority URL, if present, must not exceed 1000 characters.

  • To import a new certificate, omit the CertificateArn argument. Include this argument only when you want to replace a previously imported certifica

  • When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the private key by their file names preceded by file://. For example, you can specify a certificate saved in the C: folder as file://C:.pem. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs.

  • When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using.

  • The cryptographic algorithm of an imported certificate must match the algorithm of the signing CA. For example, if the signing CA key type is RSA, then the certificate key type must also be RSA.

This operation returns the Amazon Resource Name (ARN) of the imported certificate.

See Also:

AWS API Reference

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

◆ ImportCertificateCallable()

virtual Model::ImportCertificateOutcomeCallable Aws::ACM::ACMClient::ImportCertificateCallable ( const Model::ImportCertificateRequest request) const
virtual

Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with ACM. Note that integrated services allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see Importing Certificates in the AWS Certificate Manager User Guide.

ACM does not provide managed renewal for certificates that you import.

Note the following guidelines when importing third party certificates:

  • You must enter the private key that matches the certificate you are importing.

  • The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase.

  • If the certificate you are importing is not self-signed, you must enter its certificate chain.

  • If a certificate chain is included, the issuer must be the subject of one of the certificates in the chain.

  • The certificate, private key, and certificate chain must be PEM-encoded.

  • The current time must be between the Not Before and Not After certificate fields.

  • The Issuer field must not be empty.

  • The OCSP authority URL, if present, must not exceed 1000 characters.

  • To import a new certificate, omit the CertificateArn argument. Include this argument only when you want to replace a previously imported certifica

  • When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the private key by their file names preceded by file://. For example, you can specify a certificate saved in the C: folder as file://C:.pem. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs.

  • When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using.

  • The cryptographic algorithm of an imported certificate must match the algorithm of the signing CA. For example, if the signing CA key type is RSA, then the certificate key type must also be RSA.

This operation returns the Amazon Resource Name (ARN) of the imported certificate.

See Also:

AWS API Reference

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

◆ ListCertificates()

virtual Model::ListCertificatesOutcome Aws::ACM::ACMClient::ListCertificates ( const Model::ListCertificatesRequest request) const
virtual

Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate. Default filtering returns only RSA_2048 certificates. For more information, see Filters.

See Also:

AWS API Reference

◆ ListCertificatesAsync()

virtual void Aws::ACM::ACMClient::ListCertificatesAsync ( const Model::ListCertificatesRequest request,
const ListCertificatesResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate. Default filtering returns only RSA_2048 certificates. For more information, see Filters.

See Also:

AWS API Reference

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

◆ ListCertificatesCallable()

virtual Model::ListCertificatesOutcomeCallable Aws::ACM::ACMClient::ListCertificatesCallable ( const Model::ListCertificatesRequest request) const
virtual

Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate. Default filtering returns only RSA_2048 certificates. For more information, see Filters.

See Also:

AWS API Reference

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

◆ ListTagsForCertificate()

virtual Model::ListTagsForCertificateOutcome Aws::ACM::ACMClient::ListTagsForCertificate ( const Model::ListTagsForCertificateRequest request) const
virtual

Lists the tags that have been applied to the ACM certificate. Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM certificate, use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action.

See Also:

AWS API Reference

◆ ListTagsForCertificateAsync()

virtual void Aws::ACM::ACMClient::ListTagsForCertificateAsync ( const Model::ListTagsForCertificateRequest request,
const ListTagsForCertificateResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Lists the tags that have been applied to the ACM certificate. Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM certificate, use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action.

See Also:

AWS API Reference

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

◆ ListTagsForCertificateCallable()

virtual Model::ListTagsForCertificateOutcomeCallable Aws::ACM::ACMClient::ListTagsForCertificateCallable ( const Model::ListTagsForCertificateRequest request) const
virtual

Lists the tags that have been applied to the ACM certificate. Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM certificate, use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action.

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::ACM::ACMClient::OverrideEndpoint ( const Aws::String endpoint)

◆ RemoveTagsFromCertificate()

virtual Model::RemoveTagsFromCertificateOutcome Aws::ACM::ACMClient::RemoveTagsFromCertificate ( const Model::RemoveTagsFromCertificateRequest request) const
virtual

Remove one or more tags from an ACM certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, 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 certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate action.

See Also:

AWS API Reference

◆ RemoveTagsFromCertificateAsync()

virtual void Aws::ACM::ACMClient::RemoveTagsFromCertificateAsync ( const Model::RemoveTagsFromCertificateRequest request,
const RemoveTagsFromCertificateResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Remove one or more tags from an ACM certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, 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 certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate action.

See Also:

AWS API Reference

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

◆ RemoveTagsFromCertificateCallable()

virtual Model::RemoveTagsFromCertificateOutcomeCallable Aws::ACM::ACMClient::RemoveTagsFromCertificateCallable ( const Model::RemoveTagsFromCertificateRequest request) const
virtual

Remove one or more tags from an ACM certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, 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 certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate action.

See Also:

AWS API Reference

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

◆ RenewCertificate()

virtual Model::RenewCertificateOutcome Aws::ACM::ACMClient::RenewCertificate ( const Model::RenewCertificateRequest request) const
virtual

Renews an eligable ACM certificate. At this time, only exported private certificates can be renewed with this operation. In order to renew your ACM PCA certificates with ACM, you must first grant the ACM service principal permission to do so. For more information, see Testing Managed Renewal in the ACM User Guide.

See Also:

AWS API Reference

◆ RenewCertificateAsync()

virtual void Aws::ACM::ACMClient::RenewCertificateAsync ( const Model::RenewCertificateRequest request,
const RenewCertificateResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Renews an eligable ACM certificate. At this time, only exported private certificates can be renewed with this operation. In order to renew your ACM PCA certificates with ACM, you must first grant the ACM service principal permission to do so. For more information, see Testing Managed Renewal in the ACM User Guide.

See Also:

AWS API Reference

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

◆ RenewCertificateCallable()

virtual Model::RenewCertificateOutcomeCallable Aws::ACM::ACMClient::RenewCertificateCallable ( const Model::RenewCertificateRequest request) const
virtual

Renews an eligable ACM certificate. At this time, only exported private certificates can be renewed with this operation. In order to renew your ACM PCA certificates with ACM, you must first grant the ACM service principal permission to do so. For more information, see Testing Managed Renewal in the ACM User Guide.

See Also:

AWS API Reference

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

◆ RequestCertificate()

virtual Model::RequestCertificateOutcome Aws::ACM::ACMClient::RequestCertificate ( const Model::RequestCertificateRequest request) const
virtual

Requests an ACM certificate for use with other AWS services. To request an ACM certificate, you must specify a fully qualified domain name (FQDN) in the DomainName parameter. You can also specify additional FQDNs in the SubjectAlternativeNames parameter.

If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation or email validation. We recommend that you use DNS validation. ACM issues public certificates after receiving approval from the domain owner.

See Also:

AWS API Reference

◆ RequestCertificateAsync()

virtual void Aws::ACM::ACMClient::RequestCertificateAsync ( const Model::RequestCertificateRequest request,
const RequestCertificateResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Requests an ACM certificate for use with other AWS services. To request an ACM certificate, you must specify a fully qualified domain name (FQDN) in the DomainName parameter. You can also specify additional FQDNs in the SubjectAlternativeNames parameter.

If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation or email validation. We recommend that you use DNS validation. ACM issues public certificates after receiving approval from the domain owner.

See Also:

AWS API Reference

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

◆ RequestCertificateCallable()

virtual Model::RequestCertificateOutcomeCallable Aws::ACM::ACMClient::RequestCertificateCallable ( const Model::RequestCertificateRequest request) const
virtual

Requests an ACM certificate for use with other AWS services. To request an ACM certificate, you must specify a fully qualified domain name (FQDN) in the DomainName parameter. You can also specify additional FQDNs in the SubjectAlternativeNames parameter.

If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation or email validation. We recommend that you use DNS validation. ACM issues public certificates after receiving approval from the domain owner.

See Also:

AWS API Reference

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

◆ ResendValidationEmail()

virtual Model::ResendValidationEmailOutcome Aws::ACM::ACMClient::ResendValidationEmail ( const Model::ResendValidationEmailRequest request) const
virtual

Resends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking I Approve. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate. For more information about setting up your contact email addresses, see Configure Email for your Domain.

See Also:

AWS API Reference

◆ ResendValidationEmailAsync()

virtual void Aws::ACM::ACMClient::ResendValidationEmailAsync ( const Model::ResendValidationEmailRequest request,
const ResendValidationEmailResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Resends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking I Approve. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate. For more information about setting up your contact email addresses, see Configure Email for your Domain.

See Also:

AWS API Reference

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

◆ ResendValidationEmailCallable()

virtual Model::ResendValidationEmailOutcomeCallable Aws::ACM::ACMClient::ResendValidationEmailCallable ( const Model::ResendValidationEmailRequest request) const
virtual

Resends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking I Approve. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate. For more information about setting up your contact email addresses, see Configure Email for your Domain.

See Also:

AWS API Reference

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

◆ UpdateCertificateOptions()

virtual Model::UpdateCertificateOptionsOutcome Aws::ACM::ACMClient::UpdateCertificateOptions ( const Model::UpdateCertificateOptionsRequest request) const
virtual

Updates a certificate. Currently, you can use this function to specify whether to opt in to or out of recording your certificate in a certificate transparency log. For more information, see Opting Out of Certificate Transparency Logging.

See Also:

AWS API Reference

◆ UpdateCertificateOptionsAsync()

virtual void Aws::ACM::ACMClient::UpdateCertificateOptionsAsync ( const Model::UpdateCertificateOptionsRequest request,
const UpdateCertificateOptionsResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Updates a certificate. Currently, you can use this function to specify whether to opt in to or out of recording your certificate in a certificate transparency log. For more information, see Opting Out of Certificate Transparency Logging.

See Also:

AWS API Reference

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

◆ UpdateCertificateOptionsCallable()

virtual Model::UpdateCertificateOptionsOutcomeCallable Aws::ACM::ACMClient::UpdateCertificateOptionsCallable ( const Model::UpdateCertificateOptionsRequest request) const
virtual

Updates a certificate. Currently, you can use this function to specify whether to opt in to or out of recording your certificate in a certificate transparency log. For more information, see Opting Out of Certificate Transparency Logging.

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: