@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") 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) 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 .
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AWSCertificateManagerAsyncClient()
Deprecated.
|
AWSCertificateManagerAsyncClient(AWSCredentials awsCredentials)
Deprecated.
|
AWSCertificateManagerAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AWSCertificateManagerAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
|
AWSCertificateManagerAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSCertificateManagerAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSCertificateManagerAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AWSCertificateManagerAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
|
AWSCertificateManagerAsyncClient(ClientConfiguration clientConfiguration)
Deprecated.
|
addTagsToCertificate, builder, deleteCertificate, describeCertificate, getCachedResponseMetadata, getCertificate, importCertificate, listCertificates, listTagsForCertificate, removeTagsFromCertificate, requestCertificate, resendValidationEmailaddRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddTagsToCertificate, deleteCertificate, describeCertificate, getCachedResponseMetadata, getCertificate, importCertificate, listCertificates, listTagsForCertificate, removeTagsFromCertificate, requestCertificate, resendValidationEmail, setEndpoint, setRegion@Deprecated public AWSCertificateManagerAsyncClient()
AWSCertificateManagerAsyncClientBuilder.defaultClient()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).
@Deprecated public AWSCertificateManagerAsyncClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(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)@Deprecated public AWSCertificateManagerAsyncClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(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).
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AWSCertificateManagerAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)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.@Deprecated public AWSCertificateManagerAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)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.@Deprecated public AWSCertificateManagerAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(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)@Deprecated public AWSCertificateManagerAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(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)@Deprecated public AWSCertificateManagerAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)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.@Deprecated public AWSCertificateManagerAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)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 static AWSCertificateManagerAsyncClientBuilder asyncBuilder()
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.
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.
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.
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.
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 detailed metadata about the specified ACM Certificate.
describeCertificateAsync in interface AWSCertificateManagerAsyncpublic Future<DescribeCertificateResult> describeCertificateAsync(DescribeCertificateRequest request, AsyncHandler<DescribeCertificateRequest,DescribeCertificateResult> asyncHandler)
AWSCertificateManagerAsyncReturns detailed metadata about the specified ACM Certificate.
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 ACM Certificate, intermediate certificates of subordinate CAs, and the root certificate in that order. 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 ACM Certificate, intermediate certificates of subordinate CAs, and the root certificate in that order. 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<ImportCertificateResult> importCertificateAsync(ImportCertificateRequest request)
AWSCertificateManagerAsyncImports an SSL/TLS certificate into AWS Certificate Manager (ACM) to use with ACM's integrated AWS services.
ACM does not provide managed renewal for certificates that you import.
For more information about importing certificates into ACM, including the differences between certificates that you import and those that ACM provides, see Importing Certificates in the AWS Certificate Manager User Guide.
To import a certificate, you must provide the certificate and the matching private key. When the certificate is not self-signed, you must also provide a certificate chain. You can omit the certificate chain when importing a self-signed certificate.
The certificate, private key, and certificate chain must be PEM-encoded. For more information about converting these items to PEM format, see Importing Certificates Troubleshooting in the AWS Certificate Manager User Guide.
To import a new certificate, omit the CertificateArn field. Include this field only when you want to
replace a previously imported certificate.
When you import a certificate by using the CLI or one of the SDKs, you must specify the certificate, chain, and
private key parameters as file names preceded by file://. For example, you can specify a certificate
saved in the C:\temp folder as C:\temp\certificate_to_import.pem. If you are making an
HTTP or HTTPS Query request, include these parameters as BLOBs.
This operation returns the Amazon Resource Name (ARN) of the imported certificate.
importCertificateAsync in interface AWSCertificateManagerAsyncpublic Future<ImportCertificateResult> importCertificateAsync(ImportCertificateRequest request, AsyncHandler<ImportCertificateRequest,ImportCertificateResult> asyncHandler)
AWSCertificateManagerAsyncImports an SSL/TLS certificate into AWS Certificate Manager (ACM) to use with ACM's integrated AWS services.
ACM does not provide managed renewal for certificates that you import.
For more information about importing certificates into ACM, including the differences between certificates that you import and those that ACM provides, see Importing Certificates in the AWS Certificate Manager User Guide.
To import a certificate, you must provide the certificate and the matching private key. When the certificate is not self-signed, you must also provide a certificate chain. You can omit the certificate chain when importing a self-signed certificate.
The certificate, private key, and certificate chain must be PEM-encoded. For more information about converting these items to PEM format, see Importing Certificates Troubleshooting in the AWS Certificate Manager User Guide.
To import a new certificate, omit the CertificateArn field. Include this field only when you want to
replace a previously imported certificate.
When you import a certificate by using the CLI or one of the SDKs, you must specify the certificate, chain, and
private key parameters as file names preceded by file://. For example, you can specify a certificate
saved in the C:\temp folder as C:\temp\certificate_to_import.pem. If you are making an
HTTP or HTTPS Query request, include these parameters as BLOBs.
This operation returns the Amazon Resource Name (ARN) of the imported certificate.
importCertificateAsync 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)
AWSCertificateManagerAsyncRetrieves a list of ACM Certificates and the domain name for each. You can optionally filter the list to return only the certificates that match the specified status.
listCertificatesAsync in interface AWSCertificateManagerAsyncpublic Future<ListCertificatesResult> listCertificatesAsync(ListCertificatesRequest request, AsyncHandler<ListCertificatesRequest,ListCertificatesResult> asyncHandler)
AWSCertificateManagerAsyncRetrieves a list of ACM Certificates and the domain name for each. You can optionally filter the list to return only the certificates that match the specified status.
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'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.
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'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.
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)
AWSCertificateManagerAsync
Requests 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 in the DomainName parameter. You can also specify
additional FQDNs in the SubjectAlternativeNames parameter 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.
Email is sent to three registered contact addresses in the WHOIS database and to five common system
administration addresses formed from the DomainName you enter or the optional
ValidationDomain parameter. For more information, see Validate Domain Ownership.
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)
AWSCertificateManagerAsync
Requests 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 in the DomainName parameter. You can also specify
additional FQDNs in the SubjectAlternativeNames parameter 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.
Email is sent to three registered contact addresses in the WHOIS database and to five common system
administration addresses formed from the DomainName you enter or the optional
ValidationDomain parameter. For more information, see Validate Domain Ownership.
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. For more information about setting up your contact email addresses, see Configure Email for your Domain.
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. For more information about setting up your contact email addresses, see Configure Email for your Domain.
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.