Class AWSCertificateManagerAsyncClient

All Implemented Interfaces:
AWSCertificateManager, AWSCertificateManagerAsync

@ThreadSafe public class AWSCertificateManagerAsyncClient extends AWSCertificateManagerClient implements AWSCertificateManagerAsync
Interface for accessing ACM asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

AWS Certificate Manager

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.

  • Constructor Details

    • AWSCertificateManagerAsyncClient

      public AWSCertificateManagerAsyncClient()
      Constructs a new asynchronous client to invoke service methods on ACM. A credentials provider chain will be used that searches for credentials in this order:
      • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
      • Java System Properties - aws.accessKeyId and aws.secretKey
      • Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
      • Instance profile credentials delivered through the Amazon EC2 metadata service

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

      See Also:
    • AWSCertificateManagerAsyncClient

      public AWSCertificateManagerAsyncClient(ClientConfiguration clientConfiguration)
      Constructs a new asynchronous client to invoke service methods on ACM. A credentials provider chain will be used that searches for credentials in this order:
      • Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
      • Java System Properties - aws.accessKeyId and aws.secretKey
      • Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
      • Instance profile credentials delivered through the Amazon EC2 metadata service

      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().

      Parameters:
      clientConfiguration - The client configuration options controlling how this client connects to ACM (ex: proxy settings, retry counts, etc).
      See Also:
    • AWSCertificateManagerAsyncClient

      public AWSCertificateManagerAsyncClient(AWSCredentials awsCredentials)
      Constructs a new asynchronous client to invoke service methods on ACM using the specified AWS account credentials.

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

      Parameters:
      awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
      See Also:
    • AWSCertificateManagerAsyncClient

      public 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. Default client settings will be used.
      Parameters:
      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.
    • AWSCertificateManagerAsyncClient

      public 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.
      Parameters:
      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.
    • AWSCertificateManagerAsyncClient

      public AWSCertificateManagerAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
      Constructs a new asynchronous client to invoke service methods on ACM using the specified AWS account credentials provider. Default client settings will be used.

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

      Parameters:
      awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
      See Also:
    • AWSCertificateManagerAsyncClient

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

      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().

      Parameters:
      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).
      See Also:
    • AWSCertificateManagerAsyncClient

      public 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. Default client settings will be used.
      Parameters:
      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.
    • AWSCertificateManagerAsyncClient

      public 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.
      Parameters:
      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.
  • Method Details

    • getExecutorService

      public ExecutorService getExecutorService()
      Returns the executor service used by this client to execute async requests.
      Returns:
      The executor service used by this client to execute async requests.
    • addTagsToCertificateAsync

      public Future<AddTagsToCertificateResult> addTagsToCertificateAsync(AddTagsToCertificateRequest request)
      Description copied from interface: 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.

      Specified by:
      addTagsToCertificateAsync in interface AWSCertificateManagerAsync
      Returns:
      A Java Future containing the result of the AddTagsToCertificate operation returned by the service.
    • addTagsToCertificateAsync

      Description copied from interface: 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.

      Specified by:
      addTagsToCertificateAsync in interface AWSCertificateManagerAsync
      asyncHandler - 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.
      Returns:
      A Java Future containing the result of the AddTagsToCertificate operation returned by the service.
    • deleteCertificateAsync

      public Future<DeleteCertificateResult> deleteCertificateAsync(DeleteCertificateRequest request)
      Description copied from interface: AWSCertificateManagerAsync

      Deletes 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.
      Specified by:
      deleteCertificateAsync in interface AWSCertificateManagerAsync
      Returns:
      A Java Future containing the result of the DeleteCertificate operation returned by the service.
    • deleteCertificateAsync

      Description copied from interface: AWSCertificateManagerAsync

      Deletes 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.
      Specified by:
      deleteCertificateAsync in interface AWSCertificateManagerAsync
      asyncHandler - 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.
      Returns:
      A Java Future containing the result of the DeleteCertificate operation returned by the service.
    • describeCertificateAsync

      public Future<DescribeCertificateResult> describeCertificateAsync(DescribeCertificateRequest request)
      Description copied from interface: AWSCertificateManagerAsync

      Returns 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).

      Specified by:
      describeCertificateAsync in interface AWSCertificateManagerAsync
      Returns:
      A Java Future containing the result of the DescribeCertificate operation returned by the service.
    • describeCertificateAsync

      Description copied from interface: AWSCertificateManagerAsync

      Returns 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).

      Specified by:
      describeCertificateAsync in interface AWSCertificateManagerAsync
      asyncHandler - 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.
      Returns:
      A Java Future containing the result of the DescribeCertificate operation returned by the service.
    • getCertificateAsync

      public Future<GetCertificateResult> getCertificateAsync(GetCertificateRequest request)
      Description copied from interface: AWSCertificateManagerAsync

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

      Currently, ACM Certificates can be used only with Elastic Load Balancing and Amazon CloudFront.
      Specified by:
      getCertificateAsync in interface AWSCertificateManagerAsync
      Returns:
      A Java Future containing the result of the GetCertificate operation returned by the service.
    • getCertificateAsync

      Description copied from interface: AWSCertificateManagerAsync

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

      Currently, ACM Certificates can be used only with Elastic Load Balancing and Amazon CloudFront.
      Specified by:
      getCertificateAsync in interface AWSCertificateManagerAsync
      asyncHandler - 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.
      Returns:
      A Java Future containing the result of the GetCertificate operation returned by the service.
    • listCertificatesAsync

      public Future<ListCertificatesResult> listCertificatesAsync(ListCertificatesRequest request)
      Description copied from interface: 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.

      Specified by:
      listCertificatesAsync in interface AWSCertificateManagerAsync
      Returns:
      A Java Future containing the result of the ListCertificates operation returned by the service.
    • listCertificatesAsync

      Description copied from interface: 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.

      Specified by:
      listCertificatesAsync in interface AWSCertificateManagerAsync
      asyncHandler - 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.
      Returns:
      A Java Future containing the result of the ListCertificates operation returned by the service.
    • listTagsForCertificateAsync

      public Future<ListTagsForCertificateResult> listTagsForCertificateAsync(ListTagsForCertificateRequest request)
      Description copied from interface: AWSCertificateManagerAsync

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

      Specified by:
      listTagsForCertificateAsync in interface AWSCertificateManagerAsync
      Returns:
      A Java Future containing the result of the ListTagsForCertificate operation returned by the service.
    • listTagsForCertificateAsync

      Description copied from interface: AWSCertificateManagerAsync

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

      Specified by:
      listTagsForCertificateAsync in interface AWSCertificateManagerAsync
      asyncHandler - 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.
      Returns:
      A Java Future containing the result of the ListTagsForCertificate operation returned by the service.
    • removeTagsFromCertificateAsync

      public Future<RemoveTagsFromCertificateResult> removeTagsFromCertificateAsync(RemoveTagsFromCertificateRequest request)
      Description copied from interface: AWSCertificateManagerAsync

      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.

      Specified by:
      removeTagsFromCertificateAsync in interface AWSCertificateManagerAsync
      Returns:
      A Java Future containing the result of the RemoveTagsFromCertificate operation returned by the service.
    • removeTagsFromCertificateAsync

      Description copied from interface: AWSCertificateManagerAsync

      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.

      Specified by:
      removeTagsFromCertificateAsync in interface AWSCertificateManagerAsync
      asyncHandler - 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.
      Returns:
      A Java Future containing the result of the RemoveTagsFromCertificate operation returned by the service.
    • requestCertificateAsync

      public Future<RequestCertificateResult> requestCertificateAsync(RequestCertificateRequest request)
      Description copied from interface: 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. 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 .

      Specified by:
      requestCertificateAsync in interface AWSCertificateManagerAsync
      Returns:
      A Java Future containing the result of the RequestCertificate operation returned by the service.
    • requestCertificateAsync

      Description copied from interface: 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. 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 .

      Specified by:
      requestCertificateAsync in interface AWSCertificateManagerAsync
      asyncHandler - 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.
      Returns:
      A Java Future containing the result of the RequestCertificate operation returned by the service.
    • resendValidationEmailAsync

      public Future<ResendValidationEmailResult> resendValidationEmailAsync(ResendValidationEmailRequest request)
      Description copied from interface: AWSCertificateManagerAsync

      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.

      Specified by:
      resendValidationEmailAsync in interface AWSCertificateManagerAsync
      Returns:
      A Java Future containing the result of the ResendValidationEmail operation returned by the service.
    • resendValidationEmailAsync

      Description copied from interface: AWSCertificateManagerAsync

      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.

      Specified by:
      resendValidationEmailAsync in interface AWSCertificateManagerAsync
      asyncHandler - 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.
      Returns:
      A Java Future containing the result of the ResendValidationEmail operation returned by the service.
    • shutdown

      public void shutdown()
      Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.
      Specified by:
      shutdown in interface AWSCertificateManager
      Overrides:
      shutdown in class AmazonWebServiceClient