@ThreadSafe public class AWSCertificateManagerAsyncClient extends AWSCertificateManagerClient implements AWSCertificateManagerAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Welcome to the AWS Certificate Manager (ACM) Command Reference. This guide provides descriptions, syntax, and usage examples for each ACM command. You can use AWS Certificate Manager to request ACM Certificates for your AWS-based websites and applications. For general information about using ACM and for more information about using the console, see the AWS Certificate Manager User Guide. For more information about using the ACM API, see the AWS Certificate Manager API Reference.
LOGGING_AWS_REQUEST_METRIC| Constructor and Description |
|---|
AWSCertificateManagerAsyncClient()
Constructs a new asynchronous client to invoke service methods on ACM.
|
AWSCertificateManagerAsyncClient(AWSCredentials awsCredentials)
Constructs a new asynchronous client to invoke service methods on ACM
using the specified AWS account credentials.
|
AWSCertificateManagerAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on ACM
using the specified AWS account credentials, executor service, and client
configuration options.
|
AWSCertificateManagerAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on ACM
using the specified AWS account credentials and executor service.
|
AWSCertificateManagerAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new asynchronous client to invoke service methods on ACM
using the specified AWS account credentials provider.
|
AWSCertificateManagerAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on ACM
using the provided AWS account credentials provider and client
configuration options.
|
AWSCertificateManagerAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on ACM
using the specified AWS account credentials provider, executor service,
and client configuration options.
|
AWSCertificateManagerAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on ACM
using the specified AWS account credentials provider and executor
service.
|
AWSCertificateManagerAsyncClient(ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on ACM.
|
addTagsToCertificate, deleteCertificate, describeCertificate, getCachedResponseMetadata, getCertificate, listCertificates, listTagsForCertificate, removeTagsFromCertificate, requestCertificate, resendValidationEmailaddRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddTagsToCertificate, deleteCertificate, describeCertificate, getCachedResponseMetadata, getCertificate, listCertificates, listTagsForCertificate, removeTagsFromCertificate, requestCertificate, resendValidationEmail, setEndpoint, setRegionpublic AWSCertificateManagerAsyncClient()
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
public AWSCertificateManagerAsyncClient(ClientConfiguration clientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing
a number of threads equal to the maximum number of concurrent connections
configured via ClientConfiguration.getMaxConnections().
clientConfiguration - The client configuration options controlling how this client
connects to ACM (ex: proxy settings, retry counts, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)public AWSCertificateManagerAsyncClient(AWSCredentials awsCredentials)
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentials - The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.Executors.newFixedThreadPool(int)public AWSCertificateManagerAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
awsCredentials - The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.executorService - The executor service by which all asynchronous requests will be
executed.public AWSCertificateManagerAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
awsCredentials - The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings,
etc).executorService - The executor service by which all asynchronous requests will be
executed.public AWSCertificateManagerAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentialsProvider - The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.Executors.newFixedThreadPool(int)public AWSCertificateManagerAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing
a number of threads equal to the maximum number of concurrent connections
configured via ClientConfiguration.getMaxConnections().
awsCredentialsProvider - The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings,
etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)public AWSCertificateManagerAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
awsCredentialsProvider - The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.executorService - The executor service by which all asynchronous requests will be
executed.public AWSCertificateManagerAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
awsCredentialsProvider - The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings,
etc).executorService - The executor service by which all asynchronous requests will be
executed.public ExecutorService getExecutorService()
public Future<AddTagsToCertificateResult> addTagsToCertificateAsync(AddTagsToCertificateRequest request)
AWSCertificateManagerAsync
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.
addTagsToCertificateAsync in interface AWSCertificateManagerAsyncpublic Future<AddTagsToCertificateResult> addTagsToCertificateAsync(AddTagsToCertificateRequest request, AsyncHandler<AddTagsToCertificateRequest,AddTagsToCertificateResult> asyncHandler)
AWSCertificateManagerAsync
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.
addTagsToCertificateAsync in interface AWSCertificateManagerAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteCertificateResult> deleteCertificateAsync(DeleteCertificateRequest request)
AWSCertificateManagerAsyncDeletes an ACM Certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list of ACM Certificates 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 other AWS services.
deleteCertificateAsync in interface AWSCertificateManagerAsyncpublic Future<DeleteCertificateResult> deleteCertificateAsync(DeleteCertificateRequest request, AsyncHandler<DeleteCertificateRequest,DeleteCertificateResult> asyncHandler)
AWSCertificateManagerAsyncDeletes an ACM Certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list of ACM Certificates 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 other AWS services.
deleteCertificateAsync in interface AWSCertificateManagerAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeCertificateResult> describeCertificateAsync(DescribeCertificateRequest request)
AWSCertificateManagerAsyncReturns a list of the fields contained in the specified ACM Certificate. For example, this action returns the certificate status, a flag that indicates whether the certificate is associated with any other AWS service, and the date at which the certificate request was created. You specify the ACM Certificate on input by its Amazon Resource Name (ARN).
describeCertificateAsync in interface AWSCertificateManagerAsyncpublic Future<DescribeCertificateResult> describeCertificateAsync(DescribeCertificateRequest request, AsyncHandler<DescribeCertificateRequest,DescribeCertificateResult> asyncHandler)
AWSCertificateManagerAsyncReturns a list of the fields contained in the specified ACM Certificate. For example, this action returns the certificate status, a flag that indicates whether the certificate is associated with any other AWS service, and the date at which the certificate request was created. You specify the ACM Certificate on input by its Amazon Resource Name (ARN).
describeCertificateAsync in interface AWSCertificateManagerAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GetCertificateResult> getCertificateAsync(GetCertificateRequest request)
AWSCertificateManagerAsyncRetrieves an ACM Certificate and certificate chain for the certificate specified by an ARN. The chain is an ordered list of certificates that contains the root certificate, intermediate certificates of subordinate CAs, and the ACM Certificate. The certificate and certificate chain are base64 encoded. If you want to decode the certificate chain to see the individual certificate fields, you can use OpenSSL.
getCertificateAsync in interface AWSCertificateManagerAsyncpublic Future<GetCertificateResult> getCertificateAsync(GetCertificateRequest request, AsyncHandler<GetCertificateRequest,GetCertificateResult> asyncHandler)
AWSCertificateManagerAsyncRetrieves an ACM Certificate and certificate chain for the certificate specified by an ARN. The chain is an ordered list of certificates that contains the root certificate, intermediate certificates of subordinate CAs, and the ACM Certificate. The certificate and certificate chain are base64 encoded. If you want to decode the certificate chain to see the individual certificate fields, you can use OpenSSL.
getCertificateAsync in interface AWSCertificateManagerAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListCertificatesResult> listCertificatesAsync(ListCertificatesRequest request)
AWSCertificateManagerAsync
Retrieves a list of the ACM Certificate ARNs, and the domain name for
each ARN, owned by the calling account. You can filter the list based on
the CertificateStatuses parameter, and you can display up to
MaxItems certificates at one time. If you have more than
MaxItems certificates, use the NextToken marker
from the response object in your next call to the
ListCertificates action to retrieve the next set of
certificate ARNs.
listCertificatesAsync in interface AWSCertificateManagerAsyncpublic Future<ListCertificatesResult> listCertificatesAsync(ListCertificatesRequest request, AsyncHandler<ListCertificatesRequest,ListCertificatesResult> asyncHandler)
AWSCertificateManagerAsync
Retrieves a list of the ACM Certificate ARNs, and the domain name for
each ARN, owned by the calling account. You can filter the list based on
the CertificateStatuses parameter, and you can display up to
MaxItems certificates at one time. If you have more than
MaxItems certificates, use the NextToken marker
from the response object in your next call to the
ListCertificates action to retrieve the next set of
certificate ARNs.
listCertificatesAsync in interface AWSCertificateManagerAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsForCertificateResult> listTagsForCertificateAsync(ListTagsForCertificateRequest request)
AWSCertificateManagerAsyncLists the tags that have been applied to the ACM Certificate. Use the certificate 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.
listTagsForCertificateAsync in interface AWSCertificateManagerAsyncpublic Future<ListTagsForCertificateResult> listTagsForCertificateAsync(ListTagsForCertificateRequest request, AsyncHandler<ListTagsForCertificateRequest,ListTagsForCertificateResult> asyncHandler)
AWSCertificateManagerAsyncLists the tags that have been applied to the ACM Certificate. Use the certificate 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.
listTagsForCertificateAsync in interface AWSCertificateManagerAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RemoveTagsFromCertificateResult> removeTagsFromCertificateAsync(RemoveTagsFromCertificateRequest request)
AWSCertificateManagerAsyncRemove 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.
removeTagsFromCertificateAsync in interface AWSCertificateManagerAsyncpublic Future<RemoveTagsFromCertificateResult> removeTagsFromCertificateAsync(RemoveTagsFromCertificateRequest request, AsyncHandler<RemoveTagsFromCertificateRequest,RemoveTagsFromCertificateResult> asyncHandler)
AWSCertificateManagerAsyncRemove 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.
removeTagsFromCertificateAsync in interface AWSCertificateManagerAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RequestCertificateResult> requestCertificateAsync(RequestCertificateRequest request)
AWSCertificateManagerAsyncRequests an ACM Certificate for use with other AWS services. To request an ACM Certificate, you must specify the fully qualified domain name (FQDN) for your site. You can also specify additional FQDNs if users can reach your site by using other names. For each domain name you specify, email is sent to the domain owner to request approval to issue the certificate. After receiving approval from the domain owner, the ACM Certificate is issued. For more information, see the AWS Certificate Manager User Guide .
requestCertificateAsync in interface AWSCertificateManagerAsyncpublic Future<RequestCertificateResult> requestCertificateAsync(RequestCertificateRequest request, AsyncHandler<RequestCertificateRequest,RequestCertificateResult> asyncHandler)
AWSCertificateManagerAsyncRequests an ACM Certificate for use with other AWS services. To request an ACM Certificate, you must specify the fully qualified domain name (FQDN) for your site. You can also specify additional FQDNs if users can reach your site by using other names. For each domain name you specify, email is sent to the domain owner to request approval to issue the certificate. After receiving approval from the domain owner, the ACM Certificate is issued. For more information, see the AWS Certificate Manager User Guide .
requestCertificateAsync in interface AWSCertificateManagerAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ResendValidationEmailResult> resendValidationEmailAsync(ResendValidationEmailRequest request)
AWSCertificateManagerAsyncResends 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.
resendValidationEmailAsync in interface AWSCertificateManagerAsyncpublic Future<ResendValidationEmailResult> resendValidationEmailAsync(ResendValidationEmailRequest request, AsyncHandler<ResendValidationEmailRequest,ResendValidationEmailResult> asyncHandler)
AWSCertificateManagerAsyncResends 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.
resendValidationEmailAsync in interface AWSCertificateManagerAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public void shutdown()
getExecutorService().shutdown() followed by
getExecutorService().awaitTermination() prior to calling this
method.shutdown in interface AWSCertificateManagershutdown in class AmazonWebServiceClientCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.