software.amazon.awssdk.services.acm.AcmAsyncClient Maven / Gradle / Ivy
Show all versions of acm Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.acm;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.services.acm.model.AddTagsToCertificateRequest;
import software.amazon.awssdk.services.acm.model.AddTagsToCertificateResponse;
import software.amazon.awssdk.services.acm.model.DeleteCertificateRequest;
import software.amazon.awssdk.services.acm.model.DeleteCertificateResponse;
import software.amazon.awssdk.services.acm.model.DescribeCertificateRequest;
import software.amazon.awssdk.services.acm.model.DescribeCertificateResponse;
import software.amazon.awssdk.services.acm.model.ExportCertificateRequest;
import software.amazon.awssdk.services.acm.model.ExportCertificateResponse;
import software.amazon.awssdk.services.acm.model.GetAccountConfigurationRequest;
import software.amazon.awssdk.services.acm.model.GetAccountConfigurationResponse;
import software.amazon.awssdk.services.acm.model.GetCertificateRequest;
import software.amazon.awssdk.services.acm.model.GetCertificateResponse;
import software.amazon.awssdk.services.acm.model.ImportCertificateRequest;
import software.amazon.awssdk.services.acm.model.ImportCertificateResponse;
import software.amazon.awssdk.services.acm.model.ListCertificatesRequest;
import software.amazon.awssdk.services.acm.model.ListCertificatesResponse;
import software.amazon.awssdk.services.acm.model.ListTagsForCertificateRequest;
import software.amazon.awssdk.services.acm.model.ListTagsForCertificateResponse;
import software.amazon.awssdk.services.acm.model.PutAccountConfigurationRequest;
import software.amazon.awssdk.services.acm.model.PutAccountConfigurationResponse;
import software.amazon.awssdk.services.acm.model.RemoveTagsFromCertificateRequest;
import software.amazon.awssdk.services.acm.model.RemoveTagsFromCertificateResponse;
import software.amazon.awssdk.services.acm.model.RenewCertificateRequest;
import software.amazon.awssdk.services.acm.model.RenewCertificateResponse;
import software.amazon.awssdk.services.acm.model.RequestCertificateRequest;
import software.amazon.awssdk.services.acm.model.RequestCertificateResponse;
import software.amazon.awssdk.services.acm.model.ResendValidationEmailRequest;
import software.amazon.awssdk.services.acm.model.ResendValidationEmailResponse;
import software.amazon.awssdk.services.acm.model.UpdateCertificateOptionsRequest;
import software.amazon.awssdk.services.acm.model.UpdateCertificateOptionsResponse;
import software.amazon.awssdk.services.acm.paginators.ListCertificatesPublisher;
import software.amazon.awssdk.services.acm.waiters.AcmAsyncWaiter;
/**
* Service client for accessing ACM asynchronously. This can be created using the static {@link #builder()} method.
*
* Amazon Web Services Certificate Manager
*
* You can use Amazon Web Services 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 Amazon Web Services Certificate Manager User Guide.
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface AcmAsyncClient extends SdkClient {
String SERVICE_NAME = "acm";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "acm";
/**
* Create a {@link AcmAsyncClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static AcmAsyncClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link AcmAsyncClient}.
*/
static AcmAsyncClientBuilder builder() {
return new DefaultAcmAsyncClientBuilder();
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified certificate cannot be found in the caller's account or the
* caller's account cannot be found.
* - InvalidArnException The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* - InvalidTagException One or both of the values that make up the key-value pair is not valid. For
* example, you cannot specify a tag value that begins with
aws:
.
* - TooManyTagsException The request contains too many tags. Try the request again with fewer tags.
* - TagPolicyException A specified tag did not comply with an existing tag policy and was rejected.
* - InvalidParameterException An input parameter was invalid.
* - ThrottlingException The request was denied because it exceeded a quota.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.AddTagsToCertificate
* @see AWS API
* Documentation
*/
default CompletableFuture addTagsToCertificate(
AddTagsToCertificateRequest addTagsToCertificateRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link AddTagsToCertificateRequest.Builder} avoiding the
* need to create one manually via {@link AddTagsToCertificateRequest#builder()}
*
*
* @param addTagsToCertificateRequest
* A {@link Consumer} that will call methods on {@link AddTagsToCertificateRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the AddTagsToCertificate operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified certificate cannot be found in the caller's account or the
* caller's account cannot be found.
* - InvalidArnException The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* - InvalidTagException One or both of the values that make up the key-value pair is not valid. For
* example, you cannot specify a tag value that begins with
aws:
.
* - TooManyTagsException The request contains too many tags. Try the request again with fewer tags.
* - TagPolicyException A specified tag did not comply with an existing tag policy and was rejected.
* - InvalidParameterException An input parameter was invalid.
* - ThrottlingException The request was denied because it exceeded a quota.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.AddTagsToCertificate
* @see AWS API
* Documentation
*/
default CompletableFuture addTagsToCertificate(
Consumer addTagsToCertificateRequest) {
return addTagsToCertificate(AddTagsToCertificateRequest.builder().applyMutation(addTagsToCertificateRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified certificate cannot be found in the caller's account or the
* caller's account cannot be found.
* - ResourceInUseException The certificate is in use by another Amazon Web Services service in the
* caller's account. Remove the association and try again.
* - InvalidArnException The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.DeleteCertificate
* @see AWS API
* Documentation
*/
default CompletableFuture deleteCertificate(DeleteCertificateRequest deleteCertificateRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteCertificateRequest.Builder} avoiding the need
* to create one manually via {@link DeleteCertificateRequest#builder()}
*
*
* @param deleteCertificateRequest
* A {@link Consumer} that will call methods on {@link DeleteCertificateRequest.Builder} to create a request.
* @return A Java Future containing the result of the DeleteCertificate operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified certificate cannot be found in the caller's account or the
* caller's account cannot be found.
* - ResourceInUseException The certificate is in use by another Amazon Web Services service in the
* caller's account. Remove the association and try again.
* - InvalidArnException The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.DeleteCertificate
* @see AWS API
* Documentation
*/
default CompletableFuture deleteCertificate(
Consumer deleteCertificateRequest) {
return deleteCertificate(DeleteCertificateRequest.builder().applyMutation(deleteCertificateRequest).build());
}
/**
*
* Returns detailed metadata about the specified ACM certificate.
*
*
* @param describeCertificateRequest
* @return A Java Future containing the result of the DescribeCertificate operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified certificate cannot be found in the caller's account or the
* caller's account cannot be found.
* - InvalidArnException The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.DescribeCertificate
* @see AWS API
* Documentation
*/
default CompletableFuture describeCertificate(
DescribeCertificateRequest describeCertificateRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns detailed metadata about the specified ACM certificate.
*
*
*
* This is a convenience which creates an instance of the {@link DescribeCertificateRequest.Builder} avoiding the
* need to create one manually via {@link DescribeCertificateRequest#builder()}
*
*
* @param describeCertificateRequest
* A {@link Consumer} that will call methods on {@link DescribeCertificateRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DescribeCertificate operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified certificate cannot be found in the caller's account or the
* caller's account cannot be found.
* - InvalidArnException The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.DescribeCertificate
* @see AWS API
* Documentation
*/
default CompletableFuture describeCertificate(
Consumer describeCertificateRequest) {
return describeCertificate(DescribeCertificateRequest.builder().applyMutation(describeCertificateRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified certificate cannot be found in the caller's account or the
* caller's account cannot be found.
* - RequestInProgressException The certificate request is in process and the certificate in your account
* has not yet been issued.
* - InvalidArnException The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.ExportCertificate
* @see AWS API
* Documentation
*/
default CompletableFuture exportCertificate(ExportCertificateRequest exportCertificateRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link ExportCertificateRequest.Builder} avoiding the need
* to create one manually via {@link ExportCertificateRequest#builder()}
*
*
* @param exportCertificateRequest
* A {@link Consumer} that will call methods on {@link ExportCertificateRequest.Builder} to create a request.
* @return A Java Future containing the result of the ExportCertificate operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified certificate cannot be found in the caller's account or the
* caller's account cannot be found.
* - RequestInProgressException The certificate request is in process and the certificate in your account
* has not yet been issued.
* - InvalidArnException The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.ExportCertificate
* @see AWS API
* Documentation
*/
default CompletableFuture exportCertificate(
Consumer exportCertificateRequest) {
return exportCertificate(ExportCertificateRequest.builder().applyMutation(exportCertificateRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException You do not have access required to perform this action.
* - ThrottlingException The request was denied because it exceeded a quota.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.GetAccountConfiguration
* @see AWS
* API Documentation
*/
default CompletableFuture getAccountConfiguration(
GetAccountConfigurationRequest getAccountConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns the account configuration options associated with an Amazon Web Services account.
*
*
*
* This is a convenience which creates an instance of the {@link GetAccountConfigurationRequest.Builder} avoiding
* the need to create one manually via {@link GetAccountConfigurationRequest#builder()}
*
*
* @param getAccountConfigurationRequest
* A {@link Consumer} that will call methods on {@link GetAccountConfigurationRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the GetAccountConfiguration operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - AccessDeniedException You do not have access required to perform this action.
* - ThrottlingException The request was denied because it exceeded a quota.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.GetAccountConfiguration
* @see AWS
* API Documentation
*/
default CompletableFuture getAccountConfiguration(
Consumer getAccountConfigurationRequest) {
return getAccountConfiguration(GetAccountConfigurationRequest.builder().applyMutation(getAccountConfigurationRequest)
.build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified certificate cannot be found in the caller's account or the
* caller's account cannot be found.
* - RequestInProgressException The certificate request is in process and the certificate in your account
* has not yet been issued.
* - InvalidArnException The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.GetCertificate
* @see AWS API
* Documentation
*/
default CompletableFuture getCertificate(GetCertificateRequest getCertificateRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link GetCertificateRequest.Builder} avoiding the need to
* create one manually via {@link GetCertificateRequest#builder()}
*
*
* @param getCertificateRequest
* A {@link Consumer} that will call methods on {@link GetCertificateRequest.Builder} to create a request.
* @return A Java Future containing the result of the GetCertificate operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified certificate cannot be found in the caller's account or the
* caller's account cannot be found.
* - RequestInProgressException The certificate request is in process and the certificate in your account
* has not yet been issued.
* - InvalidArnException The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.GetCertificate
* @see AWS API
* Documentation
*/
default CompletableFuture getCertificate(Consumer getCertificateRequest) {
return getCertificate(GetCertificateRequest.builder().applyMutation(getCertificateRequest).build());
}
/**
*
* Imports a certificate into Amazon Web Services 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 Amazon Web Services 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified certificate cannot be found in the caller's account or the
* caller's account cannot be found.
* - LimitExceededException An ACM quota has been exceeded.
* - InvalidTagException One or both of the values that make up the key-value pair is not valid. For
* example, you cannot specify a tag value that begins with
aws:
.
* - TooManyTagsException The request contains too many tags. Try the request again with fewer tags.
* - TagPolicyException A specified tag did not comply with an existing tag policy and was rejected.
* - InvalidParameterException An input parameter was invalid.
* - InvalidArnException The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.ImportCertificate
* @see AWS API
* Documentation
*/
default CompletableFuture importCertificate(ImportCertificateRequest importCertificateRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Imports a certificate into Amazon Web Services 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 Amazon Web Services 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.
*
*
*
* This is a convenience which creates an instance of the {@link ImportCertificateRequest.Builder} avoiding the need
* to create one manually via {@link ImportCertificateRequest#builder()}
*
*
* @param importCertificateRequest
* A {@link Consumer} that will call methods on {@link ImportCertificateRequest.Builder} to create a request.
* @return A Java Future containing the result of the ImportCertificate operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified certificate cannot be found in the caller's account or the
* caller's account cannot be found.
* - LimitExceededException An ACM quota has been exceeded.
* - InvalidTagException One or both of the values that make up the key-value pair is not valid. For
* example, you cannot specify a tag value that begins with
aws:
.
* - TooManyTagsException The request contains too many tags. Try the request again with fewer tags.
* - TagPolicyException A specified tag did not comply with an existing tag policy and was rejected.
* - InvalidParameterException An input parameter was invalid.
* - InvalidArnException The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.ImportCertificate
* @see AWS API
* Documentation
*/
default CompletableFuture importCertificate(
Consumer importCertificateRequest) {
return importCertificate(ImportCertificateRequest.builder().applyMutation(importCertificateRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidArgsException One or more of of request parameters specified is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.ListCertificates
* @see AWS API
* Documentation
*/
default CompletableFuture listCertificates(ListCertificatesRequest listCertificatesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link ListCertificatesRequest.Builder} avoiding the need
* to create one manually via {@link ListCertificatesRequest#builder()}
*
*
* @param listCertificatesRequest
* A {@link Consumer} that will call methods on {@link ListCertificatesRequest.Builder} to create a request.
* @return A Java Future containing the result of the ListCertificates operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidArgsException One or more of of request parameters specified is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.ListCertificates
* @see AWS API
* Documentation
*/
default CompletableFuture listCertificates(
Consumer listCertificatesRequest) {
return listCertificates(ListCertificatesRequest.builder().applyMutation(listCertificatesRequest).build());
}
/**
*
* 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.
*
*
* @return A Java Future containing the result of the ListCertificates operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidArgsException One or more of of request parameters specified is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.ListCertificates
* @see AWS API
* Documentation
*/
default CompletableFuture listCertificates() {
return listCertificates(ListCertificatesRequest.builder().build());
}
/**
*
* 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.
*
*
*
* This is a variant of {@link #listCertificates(software.amazon.awssdk.services.acm.model.ListCertificatesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.acm.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.acm.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.acm.model.ListCertificatesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listCertificates(software.amazon.awssdk.services.acm.model.ListCertificatesRequest)} operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidArgsException One or more of of request parameters specified is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.ListCertificates
* @see AWS API
* Documentation
*/
default ListCertificatesPublisher listCertificatesPaginator() {
return listCertificatesPaginator(ListCertificatesRequest.builder().build());
}
/**
*
* 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.
*
*
*
* This is a variant of {@link #listCertificates(software.amazon.awssdk.services.acm.model.ListCertificatesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.acm.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.acm.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.acm.model.ListCertificatesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listCertificates(software.amazon.awssdk.services.acm.model.ListCertificatesRequest)} operation.
*
*
* @param listCertificatesRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidArgsException One or more of of request parameters specified is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.ListCertificates
* @see AWS API
* Documentation
*/
default ListCertificatesPublisher listCertificatesPaginator(ListCertificatesRequest listCertificatesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a variant of {@link #listCertificates(software.amazon.awssdk.services.acm.model.ListCertificatesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.acm.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.acm.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.acm.model.ListCertificatesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listCertificates(software.amazon.awssdk.services.acm.model.ListCertificatesRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link ListCertificatesRequest.Builder} avoiding the need
* to create one manually via {@link ListCertificatesRequest#builder()}
*
*
* @param listCertificatesRequest
* A {@link Consumer} that will call methods on {@link ListCertificatesRequest.Builder} to create a request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - InvalidArgsException One or more of of request parameters specified is not valid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.ListCertificates
* @see AWS API
* Documentation
*/
default ListCertificatesPublisher listCertificatesPaginator(Consumer listCertificatesRequest) {
return listCertificatesPaginator(ListCertificatesRequest.builder().applyMutation(listCertificatesRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified certificate cannot be found in the caller's account or the
* caller's account cannot be found.
* - InvalidArnException The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.ListTagsForCertificate
* @see AWS
* API Documentation
*/
default CompletableFuture listTagsForCertificate(
ListTagsForCertificateRequest listTagsForCertificateRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link ListTagsForCertificateRequest.Builder} avoiding the
* need to create one manually via {@link ListTagsForCertificateRequest#builder()}
*
*
* @param listTagsForCertificateRequest
* A {@link Consumer} that will call methods on {@link ListTagsForCertificateRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListTagsForCertificate operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified certificate cannot be found in the caller's account or the
* caller's account cannot be found.
* - InvalidArnException The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.ListTagsForCertificate
* @see AWS
* API Documentation
*/
default CompletableFuture listTagsForCertificate(
Consumer listTagsForCertificateRequest) {
return listTagsForCertificate(ListTagsForCertificateRequest.builder().applyMutation(listTagsForCertificateRequest)
.build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ValidationException The supplied input failed to satisfy constraints of an Amazon Web Services
* service.
* - ThrottlingException The request was denied because it exceeded a quota.
* - AccessDeniedException You do not have access required to perform this action.
* - ConflictException You are trying to update a resource or configuration that is already being created
* or updated. Wait for the previous operation to finish and try again.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.PutAccountConfiguration
* @see AWS
* API Documentation
*/
default CompletableFuture putAccountConfiguration(
PutAccountConfigurationRequest putAccountConfigurationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link PutAccountConfigurationRequest.Builder} avoiding
* the need to create one manually via {@link PutAccountConfigurationRequest#builder()}
*
*
* @param putAccountConfigurationRequest
* A {@link Consumer} that will call methods on {@link PutAccountConfigurationRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the PutAccountConfiguration operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ValidationException The supplied input failed to satisfy constraints of an Amazon Web Services
* service.
* - ThrottlingException The request was denied because it exceeded a quota.
* - AccessDeniedException You do not have access required to perform this action.
* - ConflictException You are trying to update a resource or configuration that is already being created
* or updated. Wait for the previous operation to finish and try again.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.PutAccountConfiguration
* @see AWS
* API Documentation
*/
default CompletableFuture putAccountConfiguration(
Consumer putAccountConfigurationRequest) {
return putAccountConfiguration(PutAccountConfigurationRequest.builder().applyMutation(putAccountConfigurationRequest)
.build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified certificate cannot be found in the caller's account or the
* caller's account cannot be found.
* - InvalidArnException The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* - InvalidTagException One or both of the values that make up the key-value pair is not valid. For
* example, you cannot specify a tag value that begins with
aws:
.
* - TagPolicyException A specified tag did not comply with an existing tag policy and was rejected.
* - InvalidParameterException An input parameter was invalid.
* - ThrottlingException The request was denied because it exceeded a quota.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.RemoveTagsFromCertificate
* @see AWS
* API Documentation
*/
default CompletableFuture removeTagsFromCertificate(
RemoveTagsFromCertificateRequest removeTagsFromCertificateRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link RemoveTagsFromCertificateRequest.Builder} avoiding
* the need to create one manually via {@link RemoveTagsFromCertificateRequest#builder()}
*
*
* @param removeTagsFromCertificateRequest
* A {@link Consumer} that will call methods on {@link RemoveTagsFromCertificateRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the RemoveTagsFromCertificate operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified certificate cannot be found in the caller's account or the
* caller's account cannot be found.
* - InvalidArnException The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* - InvalidTagException One or both of the values that make up the key-value pair is not valid. For
* example, you cannot specify a tag value that begins with
aws:
.
* - TagPolicyException A specified tag did not comply with an existing tag policy and was rejected.
* - InvalidParameterException An input parameter was invalid.
* - ThrottlingException The request was denied because it exceeded a quota.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.RemoveTagsFromCertificate
* @see AWS
* API Documentation
*/
default CompletableFuture removeTagsFromCertificate(
Consumer removeTagsFromCertificateRequest) {
return removeTagsFromCertificate(RemoveTagsFromCertificateRequest.builder()
.applyMutation(removeTagsFromCertificateRequest).build());
}
/**
*
* Renews an eligible ACM certificate. At this time, only exported private certificates can be renewed with this
* operation. In order to renew your ACM PCA certificates with ACM, you must first grant the ACM service principal
* permission to do so. For more information, see Testing Managed Renewal in the
* ACM User Guide.
*
*
* @param renewCertificateRequest
* @return A Java Future containing the result of the RenewCertificate operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified certificate cannot be found in the caller's account or the
* caller's account cannot be found.
* - InvalidArnException The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.RenewCertificate
* @see AWS API
* Documentation
*/
default CompletableFuture renewCertificate(RenewCertificateRequest renewCertificateRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Renews an eligible ACM certificate. At this time, only exported private certificates can be renewed with this
* operation. In order to renew your ACM PCA certificates with ACM, you must first grant the ACM service principal
* permission to do so. For more information, see Testing Managed Renewal in the
* ACM User Guide.
*
*
*
* This is a convenience which creates an instance of the {@link RenewCertificateRequest.Builder} avoiding the need
* to create one manually via {@link RenewCertificateRequest#builder()}
*
*
* @param renewCertificateRequest
* A {@link Consumer} that will call methods on {@link RenewCertificateRequest.Builder} to create a request.
* @return A Java Future containing the result of the RenewCertificate operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified certificate cannot be found in the caller's account or the
* caller's account cannot be found.
* - InvalidArnException The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.RenewCertificate
* @see AWS API
* Documentation
*/
default CompletableFuture renewCertificate(
Consumer renewCertificateRequest) {
return renewCertificate(RenewCertificateRequest.builder().applyMutation(renewCertificateRequest).build());
}
/**
*
* 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 https://tools.ietf.org/html/rfc6125#appendix-B.2RFC
* 6125 specification of the certificate validation process. first checks for a subject alternative name, and, if it
* finds one, ignores the common name (CN)
*
*
*
* @param requestCertificateRequest
* @return A Java Future containing the result of the RequestCertificate operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - LimitExceededException An ACM quota has been exceeded.
* - InvalidDomainValidationOptionsException One or more values in the DomainValidationOption
* structure is incorrect.
* - InvalidArnException The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* - InvalidTagException One or both of the values that make up the key-value pair is not valid. For
* example, you cannot specify a tag value that begins with
aws:
.
* - TooManyTagsException The request contains too many tags. Try the request again with fewer tags.
* - TagPolicyException A specified tag did not comply with an existing tag policy and was rejected.
* - InvalidParameterException An input parameter was invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.RequestCertificate
* @see AWS API
* Documentation
*/
default CompletableFuture requestCertificate(RequestCertificateRequest requestCertificateRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 https://tools.ietf.org/html/rfc6125#appendix-B.2RFC
* 6125 specification of the certificate validation process. first checks for a subject alternative name, and, if it
* finds one, ignores the common name (CN)
*
*
*
* This is a convenience which creates an instance of the {@link RequestCertificateRequest.Builder} avoiding the
* need to create one manually via {@link RequestCertificateRequest#builder()}
*
*
* @param requestCertificateRequest
* A {@link Consumer} that will call methods on {@link RequestCertificateRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the RequestCertificate operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - LimitExceededException An ACM quota has been exceeded.
* - InvalidDomainValidationOptionsException One or more values in the DomainValidationOption
* structure is incorrect.
* - InvalidArnException The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* - InvalidTagException One or both of the values that make up the key-value pair is not valid. For
* example, you cannot specify a tag value that begins with
aws:
.
* - TooManyTagsException The request contains too many tags. Try the request again with fewer tags.
* - TagPolicyException A specified tag did not comply with an existing tag policy and was rejected.
* - InvalidParameterException An input parameter was invalid.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.RequestCertificate
* @see AWS API
* Documentation
*/
default CompletableFuture requestCertificate(
Consumer requestCertificateRequest) {
return requestCertificate(RequestCertificateRequest.builder().applyMutation(requestCertificateRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified certificate cannot be found in the caller's account or the
* caller's account cannot be found.
* - InvalidStateException Processing has reached an invalid state.
* - InvalidArnException The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* - InvalidDomainValidationOptionsException One or more values in the DomainValidationOption
* structure is incorrect.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.ResendValidationEmail
* @see AWS API
* Documentation
*/
default CompletableFuture resendValidationEmail(
ResendValidationEmailRequest resendValidationEmailRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link ResendValidationEmailRequest.Builder} avoiding the
* need to create one manually via {@link ResendValidationEmailRequest#builder()}
*
*
* @param resendValidationEmailRequest
* A {@link Consumer} that will call methods on {@link ResendValidationEmailRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ResendValidationEmail operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified certificate cannot be found in the caller's account or the
* caller's account cannot be found.
* - InvalidStateException Processing has reached an invalid state.
* - InvalidArnException The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* - InvalidDomainValidationOptionsException One or more values in the DomainValidationOption
* structure is incorrect.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.ResendValidationEmail
* @see AWS API
* Documentation
*/
default CompletableFuture resendValidationEmail(
Consumer resendValidationEmailRequest) {
return resendValidationEmail(ResendValidationEmailRequest.builder().applyMutation(resendValidationEmailRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified certificate cannot be found in the caller's account or the
* caller's account cannot be found.
* - LimitExceededException An ACM quota has been exceeded.
* - InvalidStateException Processing has reached an invalid state.
* - InvalidArnException The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.UpdateCertificateOptions
* @see AWS
* API Documentation
*/
default CompletableFuture updateCertificateOptions(
UpdateCertificateOptionsRequest updateCertificateOptionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateCertificateOptionsRequest.Builder} avoiding
* the need to create one manually via {@link UpdateCertificateOptionsRequest#builder()}
*
*
* @param updateCertificateOptionsRequest
* A {@link Consumer} that will call methods on {@link UpdateCertificateOptionsRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the UpdateCertificateOptions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions.
*
* - ResourceNotFoundException The specified certificate cannot be found in the caller's account or the
* caller's account cannot be found.
* - LimitExceededException An ACM quota has been exceeded.
* - InvalidStateException Processing has reached an invalid state.
* - InvalidArnException The requested Amazon Resource Name (ARN) does not refer to an existing resource.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - AcmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance
* of this type.
*
* @sample AcmAsyncClient.UpdateCertificateOptions
* @see AWS
* API Documentation
*/
default CompletableFuture updateCertificateOptions(
Consumer updateCertificateOptionsRequest) {
return updateCertificateOptions(UpdateCertificateOptionsRequest.builder().applyMutation(updateCertificateOptionsRequest)
.build());
}
/**
* Create an instance of {@link AcmAsyncWaiter} using this client.
*
* Waiters created via this method are managed by the SDK and resources will be released when the service client is
* closed.
*
* @return an instance of {@link AcmAsyncWaiter}
*/
default AcmAsyncWaiter waiter() {
throw new UnsupportedOperationException();
}
}