Interface AcmAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The
asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the
SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such
as credentials retrieval and endpoint discovery as part of the async API call.
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionaddTagsToCertificate
(Consumer<AddTagsToCertificateRequest.Builder> addTagsToCertificateRequest) Adds one or more tags to an ACM certificate.addTagsToCertificate
(AddTagsToCertificateRequest addTagsToCertificateRequest) Adds one or more tags to an ACM certificate.static AcmAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aAcmAsyncClient
.static AcmAsyncClient
create()
Create aAcmAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.deleteCertificate
(Consumer<DeleteCertificateRequest.Builder> deleteCertificateRequest) Deletes a certificate and its associated private key.deleteCertificate
(DeleteCertificateRequest deleteCertificateRequest) Deletes a certificate and its associated private key.describeCertificate
(Consumer<DescribeCertificateRequest.Builder> describeCertificateRequest) Returns detailed metadata about the specified ACM certificate.describeCertificate
(DescribeCertificateRequest describeCertificateRequest) Returns detailed metadata about the specified ACM certificate.exportCertificate
(Consumer<ExportCertificateRequest.Builder> exportCertificateRequest) Exports a private certificate issued by a private certificate authority (CA) for use anywhere.exportCertificate
(ExportCertificateRequest exportCertificateRequest) Exports a private certificate issued by a private certificate authority (CA) for use anywhere.getAccountConfiguration
(Consumer<GetAccountConfigurationRequest.Builder> getAccountConfigurationRequest) Returns the account configuration options associated with an Amazon Web Services account.getAccountConfiguration
(GetAccountConfigurationRequest getAccountConfigurationRequest) Returns the account configuration options associated with an Amazon Web Services account.default CompletableFuture
<GetCertificateResponse> getCertificate
(Consumer<GetCertificateRequest.Builder> getCertificateRequest) Retrieves an Amazon-issued certificate and its certificate chain.default CompletableFuture
<GetCertificateResponse> getCertificate
(GetCertificateRequest getCertificateRequest) Retrieves an Amazon-issued certificate and its certificate chain.importCertificate
(Consumer<ImportCertificateRequest.Builder> importCertificateRequest) Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with ACM.importCertificate
(ImportCertificateRequest importCertificateRequest) Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with ACM.Retrieves a list of certificate ARNs and domain names.listCertificates
(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest) Retrieves a list of certificate ARNs and domain names.listCertificates
(ListCertificatesRequest listCertificatesRequest) Retrieves a list of certificate ARNs and domain names.default ListCertificatesPublisher
This is a variant oflistCertificates(software.amazon.awssdk.services.acm.model.ListCertificatesRequest)
operation.default ListCertificatesPublisher
listCertificatesPaginator
(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest) This is a variant oflistCertificates(software.amazon.awssdk.services.acm.model.ListCertificatesRequest)
operation.default ListCertificatesPublisher
listCertificatesPaginator
(ListCertificatesRequest listCertificatesRequest) This is a variant oflistCertificates(software.amazon.awssdk.services.acm.model.ListCertificatesRequest)
operation.listTagsForCertificate
(Consumer<ListTagsForCertificateRequest.Builder> listTagsForCertificateRequest) Lists the tags that have been applied to the ACM certificate.listTagsForCertificate
(ListTagsForCertificateRequest listTagsForCertificateRequest) Lists the tags that have been applied to the ACM certificate.putAccountConfiguration
(Consumer<PutAccountConfigurationRequest.Builder> putAccountConfigurationRequest) Adds or modifies account-level configurations in ACM.putAccountConfiguration
(PutAccountConfigurationRequest putAccountConfigurationRequest) Adds or modifies account-level configurations in ACM.removeTagsFromCertificate
(Consumer<RemoveTagsFromCertificateRequest.Builder> removeTagsFromCertificateRequest) Remove one or more tags from an ACM certificate.removeTagsFromCertificate
(RemoveTagsFromCertificateRequest removeTagsFromCertificateRequest) Remove one or more tags from an ACM certificate.renewCertificate
(Consumer<RenewCertificateRequest.Builder> renewCertificateRequest) Renews an eligible ACM certificate.renewCertificate
(RenewCertificateRequest renewCertificateRequest) Renews an eligible ACM certificate.requestCertificate
(Consumer<RequestCertificateRequest.Builder> requestCertificateRequest) Requests an ACM certificate for use with other Amazon Web Services services.requestCertificate
(RequestCertificateRequest requestCertificateRequest) Requests an ACM certificate for use with other Amazon Web Services services.resendValidationEmail
(Consumer<ResendValidationEmailRequest.Builder> resendValidationEmailRequest) Resends the email that requests domain ownership validation.resendValidationEmail
(ResendValidationEmailRequest resendValidationEmailRequest) Resends the email that requests domain ownership validation.default AcmServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationupdateCertificateOptions
(Consumer<UpdateCertificateOptionsRequest.Builder> updateCertificateOptionsRequest) Updates a certificate.updateCertificateOptions
(UpdateCertificateOptionsRequest updateCertificateOptionsRequest) Updates a certificate.default AcmAsyncWaiter
waiter()
Create an instance ofAcmAsyncWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
addTagsToCertificate
default CompletableFuture<AddTagsToCertificateResponse> addTagsToCertificate(AddTagsToCertificateRequest addTagsToCertificateRequest) 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 optionalvalue
. 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.
- Parameters:
addTagsToCertificateRequest
-- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
addTagsToCertificate
default CompletableFuture<AddTagsToCertificateResponse> addTagsToCertificate(Consumer<AddTagsToCertificateRequest.Builder> addTagsToCertificateRequest) 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 optionalvalue
. 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
AddTagsToCertificateRequest.Builder
avoiding the need to create one manually viaAddTagsToCertificateRequest.builder()
- Parameters:
addTagsToCertificateRequest
- AConsumer
that will call methods onAddTagsToCertificateRequest.Builder
to create a request.- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
deleteCertificate
default CompletableFuture<DeleteCertificateResponse> deleteCertificate(DeleteCertificateRequest deleteCertificateRequest) 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.
- Parameters:
deleteCertificateRequest
-- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- AccessDeniedException You do not have access required to perform this action.
- ThrottlingException The request was denied because it exceeded a quota.
- 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.
- 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.
- See Also:
-
deleteCertificate
default CompletableFuture<DeleteCertificateResponse> deleteCertificate(Consumer<DeleteCertificateRequest.Builder> deleteCertificateRequest) 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
DeleteCertificateRequest.Builder
avoiding the need to create one manually viaDeleteCertificateRequest.builder()
- Parameters:
deleteCertificateRequest
- AConsumer
that will call methods onDeleteCertificateRequest.Builder
to create a request.- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- AccessDeniedException You do not have access required to perform this action.
- ThrottlingException The request was denied because it exceeded a quota.
- 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.
- 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.
- See Also:
-
describeCertificate
default CompletableFuture<DescribeCertificateResponse> describeCertificate(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.- Parameters:
describeCertificateRequest
-- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
describeCertificate
default CompletableFuture<DescribeCertificateResponse> describeCertificate(Consumer<DescribeCertificateRequest.Builder> 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.
This is a convenience which creates an instance of the
DescribeCertificateRequest.Builder
avoiding the need to create one manually viaDescribeCertificateRequest.builder()
- Parameters:
describeCertificateRequest
- AConsumer
that will call methods onDescribeCertificateRequest.Builder
to create a request.- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
exportCertificate
default CompletableFuture<ExportCertificateResponse> exportCertificate(ExportCertificateRequest exportCertificateRequest) 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.
- Parameters:
exportCertificateRequest
-- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
exportCertificate
default CompletableFuture<ExportCertificateResponse> exportCertificate(Consumer<ExportCertificateRequest.Builder> exportCertificateRequest) 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
ExportCertificateRequest.Builder
avoiding the need to create one manually viaExportCertificateRequest.builder()
- Parameters:
exportCertificateRequest
- AConsumer
that will call methods onExportCertificateRequest.Builder
to create a request.- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getAccountConfiguration
default CompletableFuture<GetAccountConfigurationResponse> getAccountConfiguration(GetAccountConfigurationRequest getAccountConfigurationRequest) Returns the account configuration options associated with an Amazon Web Services account.
- Parameters:
getAccountConfigurationRequest
-- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getAccountConfiguration
default CompletableFuture<GetAccountConfigurationResponse> getAccountConfiguration(Consumer<GetAccountConfigurationRequest.Builder> getAccountConfigurationRequest) Returns the account configuration options associated with an Amazon Web Services account.
This is a convenience which creates an instance of the
GetAccountConfigurationRequest.Builder
avoiding the need to create one manually viaGetAccountConfigurationRequest.builder()
- Parameters:
getAccountConfigurationRequest
- AConsumer
that will call methods onGetAccountConfigurationRequest.Builder
to create a request.- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getCertificate
default CompletableFuture<GetCertificateResponse> getCertificate(GetCertificateRequest getCertificateRequest) 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.
- Parameters:
getCertificateRequest
-- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
getCertificate
default CompletableFuture<GetCertificateResponse> getCertificate(Consumer<GetCertificateRequest.Builder> getCertificateRequest) 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
GetCertificateRequest.Builder
avoiding the need to create one manually viaGetCertificateRequest.builder()
- Parameters:
getCertificateRequest
- AConsumer
that will call methods onGetCertificateRequest.Builder
to create a request.- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
importCertificate
default CompletableFuture<ImportCertificateResponse> importCertificate(ImportCertificateRequest importCertificateRequest) 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
andNot 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 theC:\temp
folder asfileb://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.
- Parameters:
importCertificateRequest
-- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
importCertificate
default CompletableFuture<ImportCertificateResponse> importCertificate(Consumer<ImportCertificateRequest.Builder> importCertificateRequest) 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
andNot 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 theC:\temp
folder asfileb://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
ImportCertificateRequest.Builder
avoiding the need to create one manually viaImportCertificateRequest.builder()
- Parameters:
importCertificateRequest
- AConsumer
that will call methods onImportCertificateRequest.Builder
to create a request.- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
-
listCertificates
default CompletableFuture<ListCertificatesResponse> listCertificates(ListCertificatesRequest listCertificatesRequest) 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.- Parameters:
listCertificatesRequest
-- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArgsException One or more of of request parameters specified is not valid.
- ValidationException The supplied input failed to satisfy constraints of an Amazon Web Services service.
- 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.
- See Also:
-
listCertificates
default CompletableFuture<ListCertificatesResponse> listCertificates(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest) 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
ListCertificatesRequest.Builder
avoiding the need to create one manually viaListCertificatesRequest.builder()
- Parameters:
listCertificatesRequest
- AConsumer
that will call methods onListCertificatesRequest.Builder
to create a request.- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArgsException One or more of of request parameters specified is not valid.
- ValidationException The supplied input failed to satisfy constraints of an Amazon Web Services service.
- 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.
- See Also:
-
listCertificates
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.- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArgsException One or more of of request parameters specified is not valid.
- ValidationException The supplied input failed to satisfy constraints of an Amazon Web Services service.
- 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.
- See Also:
-
listCertificatesPaginator
This is a variant of
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
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
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 methodsoftware.amazon.awssdk.services.acm.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.acm.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.acm.model.ListCertificatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.acm.model.ListCertificatesResponse response) { //... }; });
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
listCertificates(software.amazon.awssdk.services.acm.model.ListCertificatesRequest)
operation.- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArgsException One or more of of request parameters specified is not valid.
- ValidationException The supplied input failed to satisfy constraints of an Amazon Web Services service.
- 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.
- See Also:
-
listCertificatesPaginator
default ListCertificatesPublisher listCertificatesPaginator(ListCertificatesRequest listCertificatesRequest) This is a variant of
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
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
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 methodsoftware.amazon.awssdk.services.acm.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.acm.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.acm.model.ListCertificatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.acm.model.ListCertificatesResponse response) { //... }; });
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
listCertificates(software.amazon.awssdk.services.acm.model.ListCertificatesRequest)
operation.- Parameters:
listCertificatesRequest
-- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArgsException One or more of of request parameters specified is not valid.
- ValidationException The supplied input failed to satisfy constraints of an Amazon Web Services service.
- 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.
- See Also:
-
listCertificatesPaginator
default ListCertificatesPublisher listCertificatesPaginator(Consumer<ListCertificatesRequest.Builder> listCertificatesRequest) This is a variant of
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
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
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 methodsoftware.amazon.awssdk.services.acm.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.acm.paginators.ListCertificatesPublisher publisher = client.listCertificatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.acm.model.ListCertificatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.acm.model.ListCertificatesResponse response) { //... }; });
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
listCertificates(software.amazon.awssdk.services.acm.model.ListCertificatesRequest)
operation.
This is a convenience which creates an instance of the
ListCertificatesRequest.Builder
avoiding the need to create one manually viaListCertificatesRequest.builder()
- Parameters:
listCertificatesRequest
- AConsumer
that will call methods onListCertificatesRequest.Builder
to create a request.- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidArgsException One or more of of request parameters specified is not valid.
- ValidationException The supplied input failed to satisfy constraints of an Amazon Web Services service.
- 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.
- See Also:
-
listTagsForCertificate
default CompletableFuture<ListTagsForCertificateResponse> listTagsForCertificate(ListTagsForCertificateRequest listTagsForCertificateRequest) 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.
- Parameters:
listTagsForCertificateRequest
-- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
listTagsForCertificate
default CompletableFuture<ListTagsForCertificateResponse> listTagsForCertificate(Consumer<ListTagsForCertificateRequest.Builder> listTagsForCertificateRequest) 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
ListTagsForCertificateRequest.Builder
avoiding the need to create one manually viaListTagsForCertificateRequest.builder()
- Parameters:
listTagsForCertificateRequest
- AConsumer
that will call methods onListTagsForCertificateRequest.Builder
to create a request.- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putAccountConfiguration
default CompletableFuture<PutAccountConfigurationResponse> putAccountConfiguration(PutAccountConfigurationRequest putAccountConfigurationRequest) 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 generatingEventBridge
events. ACM sends one event per day per certificate until the certificate expires. By default, accounts receive events starting 45 days before certificate expiration.- Parameters:
putAccountConfigurationRequest
-- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
putAccountConfiguration
default CompletableFuture<PutAccountConfigurationResponse> putAccountConfiguration(Consumer<PutAccountConfigurationRequest.Builder> putAccountConfigurationRequest) 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 generatingEventBridge
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
PutAccountConfigurationRequest.Builder
avoiding the need to create one manually viaPutAccountConfigurationRequest.builder()
- Parameters:
putAccountConfigurationRequest
- AConsumer
that will call methods onPutAccountConfigurationRequest.Builder
to create a request.- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
removeTagsFromCertificate
default CompletableFuture<RemoveTagsFromCertificateResponse> removeTagsFromCertificate(RemoveTagsFromCertificateRequest removeTagsFromCertificateRequest) 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.
- Parameters:
removeTagsFromCertificateRequest
-- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
removeTagsFromCertificate
default CompletableFuture<RemoveTagsFromCertificateResponse> removeTagsFromCertificate(Consumer<RemoveTagsFromCertificateRequest.Builder> removeTagsFromCertificateRequest) 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
RemoveTagsFromCertificateRequest.Builder
avoiding the need to create one manually viaRemoveTagsFromCertificateRequest.builder()
- Parameters:
removeTagsFromCertificateRequest
- AConsumer
that will call methods onRemoveTagsFromCertificateRequest.Builder
to create a request.- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
renewCertificate
default CompletableFuture<RenewCertificateResponse> renewCertificate(RenewCertificateRequest renewCertificateRequest) 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.
- Parameters:
renewCertificateRequest
-- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
renewCertificate
default CompletableFuture<RenewCertificateResponse> renewCertificate(Consumer<RenewCertificateRequest.Builder> renewCertificateRequest) 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.
This is a convenience which creates an instance of the
RenewCertificateRequest.Builder
avoiding the need to create one manually viaRenewCertificateRequest.builder()
- Parameters:
renewCertificateRequest
- AConsumer
that will call methods onRenewCertificateRequest.Builder
to create a request.- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
requestCertificate
default CompletableFuture<RequestCertificateResponse> requestCertificate(RequestCertificateRequest requestCertificateRequest) 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 theSubjectAlternativeNames
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.- Parameters:
requestCertificateRequest
-- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
requestCertificate
default CompletableFuture<RequestCertificateResponse> requestCertificate(Consumer<RequestCertificateRequest.Builder> requestCertificateRequest) 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 theSubjectAlternativeNames
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.
This is a convenience which creates an instance of the
RequestCertificateRequest.Builder
avoiding the need to create one manually viaRequestCertificateRequest.builder()
- Parameters:
requestCertificateRequest
- AConsumer
that will call methods onRequestCertificateRequest.Builder
to create a request.- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
resendValidationEmail
default CompletableFuture<ResendValidationEmailResponse> resendValidationEmail(ResendValidationEmailRequest resendValidationEmailRequest) 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.
- Parameters:
resendValidationEmailRequest
-- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
resendValidationEmail
default CompletableFuture<ResendValidationEmailResponse> resendValidationEmail(Consumer<ResendValidationEmailRequest.Builder> resendValidationEmailRequest) 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
ResendValidationEmailRequest.Builder
avoiding the need to create one manually viaResendValidationEmailRequest.builder()
- Parameters:
resendValidationEmailRequest
- AConsumer
that will call methods onResendValidationEmailRequest.Builder
to create a request.- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateCertificateOptions
default CompletableFuture<UpdateCertificateOptionsResponse> updateCertificateOptions(UpdateCertificateOptionsRequest updateCertificateOptionsRequest) 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.
- Parameters:
updateCertificateOptionsRequest
-- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
updateCertificateOptions
default CompletableFuture<UpdateCertificateOptionsResponse> updateCertificateOptions(Consumer<UpdateCertificateOptionsRequest.Builder> updateCertificateOptionsRequest) 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
UpdateCertificateOptionsRequest.Builder
avoiding the need to create one manually viaUpdateCertificateOptionsRequest.builder()
- Parameters:
updateCertificateOptionsRequest
- AConsumer
that will call methods onUpdateCertificateOptionsRequest.Builder
to create a request.- Returns:
- 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- See Also:
-
waiter
Create an instance ofAcmAsyncWaiter
using this client.Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
- Returns:
- an instance of
AcmAsyncWaiter
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aAcmAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aAcmAsyncClient
.
-