/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.certificatemanager; import javax.annotation.Generated; import com.amazonaws.services.certificatemanager.model.*; /** * Interface for accessing ACM asynchronously. Each asynchronous method will return a Java Future object representing * the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive notification when * an asynchronous operation completes. *

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.certificatemanager.AbstractAWSCertificateManagerAsync} instead. *

* Certificate Manager *

* You can use Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites and * applications. For more information about using ACM, see the Certificate Manager User Guide. *

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSCertificateManagerAsync extends AWSCertificateManager { /** *

* Adds one or more tags to an ACM certificate. Tags are labels that you can use to identify and organize your * Amazon Web Services 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. *

* * @param addTagsToCertificateRequest * @return A Java Future containing the result of the AddTagsToCertificate operation returned by the service. * @sample AWSCertificateManagerAsync.AddTagsToCertificate * @see AWS API * Documentation */ java.util.concurrent.Future addTagsToCertificateAsync(AddTagsToCertificateRequest addTagsToCertificateRequest); /** *

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

* * @param addTagsToCertificateRequest * @param 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. * @return A Java Future containing the result of the AddTagsToCertificate operation returned by the service. * @sample AWSCertificateManagerAsyncHandler.AddTagsToCertificate * @see AWS API * Documentation */ java.util.concurrent.Future addTagsToCertificateAsync(AddTagsToCertificateRequest addTagsToCertificateRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* 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 Amazon Web Services services * integrated with ACM. *

* *

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

* * * @param deleteCertificateRequest * @return A Java Future containing the result of the DeleteCertificate operation returned by the service. * @sample AWSCertificateManagerAsync.DeleteCertificate * @see AWS API * Documentation */ java.util.concurrent.Future deleteCertificateAsync(DeleteCertificateRequest deleteCertificateRequest); /** *

* *

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

* * * @param deleteCertificateRequest * @param 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. * @return A Java Future containing the result of the DeleteCertificate operation returned by the service. * @sample AWSCertificateManagerAsyncHandler.DeleteCertificate * @see AWS API * Documentation */ java.util.concurrent.Future deleteCertificateAsync(DeleteCertificateRequest deleteCertificateRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Returns detailed metadata about the specified ACM certificate. *

* If you have just created a certificate using the RequestCertificate action, there is a delay of * several seconds before you can retrieve information about it. *

* * @param describeCertificateRequest * @return A Java Future containing the result of the DescribeCertificate operation returned by the service. * @sample AWSCertificateManagerAsync.DescribeCertificate * @see AWS API * Documentation */ java.util.concurrent.Future describeCertificateAsync(DescribeCertificateRequest describeCertificateRequest); /** *

* Returns detailed metadata about the specified ACM certificate. *

* If you have just created a certificate using the RequestCertificate action, there is a delay of * several seconds before you can retrieve information about it. *

* * @param describeCertificateRequest * @param 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. * @return A Java Future containing the result of the DescribeCertificate operation returned by the service. * @sample AWSCertificateManagerAsyncHandler.DescribeCertificate * @see AWS API * Documentation */ java.util.concurrent.Future describeCertificateAsync(DescribeCertificateRequest describeCertificateRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param exportCertificateRequest * @return A Java Future containing the result of the ExportCertificate operation returned by the service. * @sample AWSCertificateManagerAsync.ExportCertificate * @see AWS API * Documentation */ java.util.concurrent.Future exportCertificateAsync(ExportCertificateRequest exportCertificateRequest); /** *

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

* * @param exportCertificateRequest * @param 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. * @return A Java Future containing the result of the ExportCertificate operation returned by the service. * @sample AWSCertificateManagerAsyncHandler.ExportCertificate * @see AWS API * Documentation */ java.util.concurrent.Future exportCertificateAsync(ExportCertificateRequest exportCertificateRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Returns the account configuration options associated with an Amazon Web Services account. *

* * @param getAccountConfigurationRequest * @return A Java Future containing the result of the GetAccountConfiguration operation returned by the service. * @sample AWSCertificateManagerAsync.GetAccountConfiguration * @see AWS * API Documentation */ java.util.concurrent.Future getAccountConfigurationAsync(GetAccountConfigurationRequest getAccountConfigurationRequest); /** *

* Returns the account configuration options associated with an Amazon Web Services account. *

* * @param getAccountConfigurationRequest * @param 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. * @return A Java Future containing the result of the GetAccountConfiguration operation returned by the service. * @sample AWSCertificateManagerAsyncHandler.GetAccountConfiguration * @see AWS * API Documentation */ java.util.concurrent.Future getAccountConfigurationAsync(GetAccountConfigurationRequest getAccountConfigurationRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param getCertificateRequest * @return A Java Future containing the result of the GetCertificate operation returned by the service. * @sample AWSCertificateManagerAsync.GetCertificate * @see AWS API * Documentation */ java.util.concurrent.Future getCertificateAsync(GetCertificateRequest getCertificateRequest); /** *

* * @param getCertificateRequest * @param 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. * @return A Java Future containing the result of the GetCertificate operation returned by the service. * @sample AWSCertificateManagerAsyncHandler.GetCertificate * @see AWS API * Documentation */ java.util.concurrent.Future getCertificateAsync(GetCertificateRequest getCertificateRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Imports a certificate into 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 * 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. *
*
*
* The private key must be no larger than 5 KB (5,120 bytes). *
*
*
* 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 certificate. *
*
*
* 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 fileb://. For example, you can specify a certificate * saved in the C:\temp folder as fileb://C:\temp\certificate_to_import.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. *

* * @param importCertificateRequest * @return A Java Future containing the result of the ImportCertificate operation returned by the service. * @sample AWSCertificateManagerAsync.ImportCertificate * @see AWS API * Documentation */ java.util.concurrent.Future importCertificateAsync(ImportCertificateRequest importCertificateRequest); /** *

* *

* 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. *
*
*
* The private key must be no larger than 5 KB (5,120 bytes). *
*
*
* 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 certificate. *
*
*
* 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 fileb://. For example, you can specify a certificate * saved in the C:\temp folder as fileb://C:\temp\certificate_to_import.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. *

* * @param importCertificateRequest * @param 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. * @return A Java Future containing the result of the ImportCertificate operation returned by the service. * @sample AWSCertificateManagerAsyncHandler.ImportCertificate * @see AWS API * Documentation */ java.util.concurrent.Future importCertificateAsync(ImportCertificateRequest importCertificateRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param listCertificatesRequest * @return A Java Future containing the result of the ListCertificates operation returned by the service. * @sample AWSCertificateManagerAsync.ListCertificates * @see AWS API * Documentation */ java.util.concurrent.Future listCertificatesAsync(ListCertificatesRequest listCertificatesRequest); /** *

* * @param listCertificatesRequest * @param 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. * @return A Java Future containing the result of the ListCertificates operation returned by the service. * @sample AWSCertificateManagerAsyncHandler.ListCertificates * @see AWS API * Documentation */ java.util.concurrent.Future listCertificatesAsync(ListCertificatesRequest listCertificatesRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param listTagsForCertificateRequest * @return A Java Future containing the result of the ListTagsForCertificate operation returned by the service. * @sample AWSCertificateManagerAsync.ListTagsForCertificate * @see AWS API * Documentation */ java.util.concurrent.Future listTagsForCertificateAsync(ListTagsForCertificateRequest listTagsForCertificateRequest); /** *

* * @param listTagsForCertificateRequest * @param 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. * @return A Java Future containing the result of the ListTagsForCertificate operation returned by the service. * @sample AWSCertificateManagerAsyncHandler.ListTagsForCertificate * @see AWS API * Documentation */ java.util.concurrent.Future listTagsForCertificateAsync(ListTagsForCertificateRequest listTagsForCertificateRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Adds or modifies account-level configurations in ACM. *

* The supported configuration option is DaysBeforeExpiry. This option specifies the number of days * prior to certificate expiration when ACM starts generating EventBridge events. ACM sends one event * per day per certificate until the certificate expires. By default, accounts receive events starting 45 days * before certificate expiration. *

* * @param putAccountConfigurationRequest * @return A Java Future containing the result of the PutAccountConfiguration operation returned by the service. * @sample AWSCertificateManagerAsync.PutAccountConfiguration * @see AWS * API Documentation */ java.util.concurrent.Future putAccountConfigurationAsync(PutAccountConfigurationRequest putAccountConfigurationRequest); /** *

* Adds or modifies account-level configurations in ACM. *

* * @param putAccountConfigurationRequest * @param 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. * @return A Java Future containing the result of the PutAccountConfiguration operation returned by the service. * @sample AWSCertificateManagerAsyncHandler.PutAccountConfiguration * @see AWS * API Documentation */ java.util.concurrent.Future putAccountConfigurationAsync(PutAccountConfigurationRequest putAccountConfigurationRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param removeTagsFromCertificateRequest * @return A Java Future containing the result of the RemoveTagsFromCertificate operation returned by the service. * @sample AWSCertificateManagerAsync.RemoveTagsFromCertificate * @see AWS * API Documentation */ java.util.concurrent.Future removeTagsFromCertificateAsync( RemoveTagsFromCertificateRequest removeTagsFromCertificateRequest); /** *

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

* * @param removeTagsFromCertificateRequest * @param 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. * @return A Java Future containing the result of the RemoveTagsFromCertificate operation returned by the service. * @sample AWSCertificateManagerAsyncHandler.RemoveTagsFromCertificate * @see AWS * API Documentation */ java.util.concurrent.Future removeTagsFromCertificateAsync( RemoveTagsFromCertificateRequest removeTagsFromCertificateRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Renews an eligible ACM certificate. At this time, only exported private certificates can be renewed with this * operation. In order to renew your Amazon Web Services Private CA 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. *

* * @param renewCertificateRequest * @return A Java Future containing the result of the RenewCertificate operation returned by the service. * @sample AWSCertificateManagerAsync.RenewCertificate * @see AWS API * Documentation */ java.util.concurrent.Future renewCertificateAsync(RenewCertificateRequest renewCertificateRequest); /** *

* * @param renewCertificateRequest * @param 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. * @return A Java Future containing the result of the RenewCertificate operation returned by the service. * @sample AWSCertificateManagerAsyncHandler.RenewCertificate * @see AWS API * Documentation */ java.util.concurrent.Future renewCertificateAsync(RenewCertificateRequest renewCertificateRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Requests an ACM certificate for use with other Amazon Web Services 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. *

* *

* ACM behavior differs from the RFC 6125 * specification of the certificate validation process. ACM first checks for a Subject Alternative Name, and, if it * finds one, ignores the common name (CN). *

* *

* After successful completion of the RequestCertificate action, there is a delay of several seconds * before you can retrieve information about the new certificate. *

* * @param requestCertificateRequest * @return A Java Future containing the result of the RequestCertificate operation returned by the service. * @sample AWSCertificateManagerAsync.RequestCertificate * @see AWS API * Documentation */ java.util.concurrent.Future requestCertificateAsync(RequestCertificateRequest requestCertificateRequest); /** *

* *

* After successful completion of the RequestCertificate action, there is a delay of several seconds * before you can retrieve information about the new certificate. *

* * @param requestCertificateRequest * @param 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. * @return A Java Future containing the result of the RequestCertificate operation returned by the service. * @sample AWSCertificateManagerAsyncHandler.RequestCertificate * @see AWS API * Documentation */ java.util.concurrent.Future requestCertificateAsync(RequestCertificateRequest requestCertificateRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param resendValidationEmailRequest * @return A Java Future containing the result of the ResendValidationEmail operation returned by the service. * @sample AWSCertificateManagerAsync.ResendValidationEmail * @see AWS API * Documentation */ java.util.concurrent.Future resendValidationEmailAsync(ResendValidationEmailRequest resendValidationEmailRequest); /** *

* * @param resendValidationEmailRequest * @param 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. * @return A Java Future containing the result of the ResendValidationEmail operation returned by the service. * @sample AWSCertificateManagerAsyncHandler.ResendValidationEmail * @see AWS API * Documentation */ java.util.concurrent.Future resendValidationEmailAsync(ResendValidationEmailRequest resendValidationEmailRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

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

* * @param updateCertificateOptionsRequest * @return A Java Future containing the result of the UpdateCertificateOptions operation returned by the service. * @sample AWSCertificateManagerAsync.UpdateCertificateOptions * @see AWS * API Documentation */ java.util.concurrent.Future updateCertificateOptionsAsync(UpdateCertificateOptionsRequest updateCertificateOptionsRequest); /** *

* * @param updateCertificateOptionsRequest * @param 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. * @return A Java Future containing the result of the UpdateCertificateOptions operation returned by the service. * @sample AWSCertificateManagerAsyncHandler.UpdateCertificateOptions * @see AWS * API Documentation */ java.util.concurrent.Future updateCertificateOptionsAsync(UpdateCertificateOptionsRequest updateCertificateOptionsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); }