Package software.amazon.awssdk.services.cloudhsm

Interface CloudHSMAsyncClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface CloudHSMAsyncClient
extends AutoCloseable

Service client for accessing CloudHSM asynchronously. This can be created using the static builder() method. AWS CloudHSM Service

Method Summary

Modifier and Type	Method	Description
default CompletableFuture<AddTagsToResourceResponse>	addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)	Adds or overwrites one or more tags for the specified AWS CloudHSM resource.
static CloudHSMAsyncClientBuilder	builder()	Create a builder that can be used to configure and create a CloudHSMAsyncClient.
static CloudHSMAsyncClient	create()	Create a CloudHSMAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateHapgResponse>	createHapg(CreateHapgRequest createHapgRequest)	Creates a high-availability partition group.
default CompletableFuture<CreateHsmResponse>	createHsm(CreateHsmRequest createHsmRequest)	Creates an uninitialized HSM instance.
default CompletableFuture<CreateLunaClientResponse>	createLunaClient(CreateLunaClientRequest createLunaClientRequest)	Creates an HSM client.
default CompletableFuture<DeleteHapgResponse>	deleteHapg(DeleteHapgRequest deleteHapgRequest)	Deletes a high-availability partition group.
default CompletableFuture<DeleteHsmResponse>	deleteHsm(DeleteHsmRequest deleteHsmRequest)	Deletes an HSM.
default CompletableFuture<DeleteLunaClientResponse>	deleteLunaClient(DeleteLunaClientRequest deleteLunaClientRequest)	Deletes a client.
default CompletableFuture<DescribeHapgResponse>	describeHapg(DescribeHapgRequest describeHapgRequest)	Retrieves information about a high-availability partition group.
default CompletableFuture<DescribeHsmResponse>	describeHsm(DescribeHsmRequest describeHsmRequest)	Retrieves information about an HSM.
default CompletableFuture<DescribeLunaClientResponse>	describeLunaClient(DescribeLunaClientRequest describeLunaClientRequest)	Retrieves information about an HSM client.
default CompletableFuture<GetConfigResponse>	getConfig(GetConfigRequest getConfigRequest)	Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.
default CompletableFuture<ListAvailableZonesResponse>	listAvailableZones(ListAvailableZonesRequest listAvailableZonesRequest)	Lists the Availability Zones that have available AWS CloudHSM capacity.
default CompletableFuture<ListHapgsResponse>	listHapgs(ListHapgsRequest listHapgsRequest)	Lists the high-availability partition groups for the account.
default CompletableFuture<ListHsmsResponse>	listHsms(ListHsmsRequest listHsmsRequest)	Retrieves the identifiers of all of the HSMs provisioned for the current customer.
default CompletableFuture<ListLunaClientsResponse>	listLunaClients(ListLunaClientsRequest listLunaClientsRequest)	Lists all of the clients.
default CompletableFuture<ListTagsForResourceResponse>	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Returns a list of all tags for the specified AWS CloudHSM resource.
default CompletableFuture<ModifyHapgResponse>	modifyHapg(ModifyHapgRequest modifyHapgRequest)	Modifies an existing high-availability partition group.
default CompletableFuture<ModifyHsmResponse>	modifyHsm(ModifyHsmRequest modifyHsmRequest)	Modifies an HSM.
default CompletableFuture<ModifyLunaClientResponse>	modifyLunaClient(ModifyLunaClientRequest modifyLunaClientRequest)	Modifies the certificate used by the client.
default CompletableFuture<RemoveTagsFromResourceResponse>	removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)	Removes one or more tags from the specified AWS CloudHSM resource.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

create

static CloudHSMAsyncClient create()

Create a CloudHSMAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static CloudHSMAsyncClientBuilder builder()

Create a builder that can be used to configure and create a CloudHSMAsyncClient.

addTagsToResource

default CompletableFuture<AddTagsToResourceResponse> addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)

Adds or overwrites one or more tags for the specified AWS CloudHSM resource.

Each tag consists of a key and a value. Tag keys must be unique to each resource.

Parameters:

addTagsToResourceRequest -

Returns:

A Java Future containing the result of the AddTagsToResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• CloudHsmServiceException Indicates that an exception occurred in the AWS CloudHSM service.
• CloudHsmInternalException Indicates that an internal error occurred.
• InvalidRequestException Indicates that one or more of the request parameters are not valid.
• SdkBaseException 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
• CloudHSMException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createHapg

default CompletableFuture<CreateHapgResponse> createHapg(CreateHapgRequest createHapgRequest)

Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.

Parameters:

createHapgRequest - Contains the inputs for the CreateHapgRequest action.

Returns:

A Java Future containing the result of the CreateHapg operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• CloudHsmServiceException Indicates that an exception occurred in the AWS CloudHSM service.
• CloudHsmInternalException Indicates that an internal error occurred.
• InvalidRequestException Indicates that one or more of the request parameters are not valid.
• SdkBaseException 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
• CloudHSMException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createHsm

default CompletableFuture<CreateHsmResponse> createHsm(CreateHsmRequest createHsmRequest)

Creates an uninitialized HSM instance.

There is an upfront fee charged for each HSM instance that you create with the CreateHsm operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the DeleteHsm operation, go to the AWS Support Center, create a new case, and select Account and Billing Support.

It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the DescribeHsm operation. The HSM is ready to be initialized when the status changes to RUNNING.

Parameters:

createHsmRequest - Contains the inputs for the CreateHsm operation.

Returns:

A Java Future containing the result of the CreateHsm operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• CloudHsmServiceException Indicates that an exception occurred in the AWS CloudHSM service.
• CloudHsmInternalException Indicates that an internal error occurred.
• InvalidRequestException Indicates that one or more of the request parameters are not valid.
• SdkBaseException 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
• CloudHSMException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createLunaClient

default CompletableFuture<CreateLunaClientResponse> createLunaClient(CreateLunaClientRequest createLunaClientRequest)

Creates an HSM client.

Parameters:

createLunaClientRequest - Contains the inputs for the CreateLunaClient action.

Returns:

A Java Future containing the result of the CreateLunaClient operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• CloudHsmServiceException Indicates that an exception occurred in the AWS CloudHSM service.
• CloudHsmInternalException Indicates that an internal error occurred.
• InvalidRequestException Indicates that one or more of the request parameters are not valid.
• SdkBaseException 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
• CloudHSMException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteHapg

default CompletableFuture<DeleteHapgResponse> deleteHapg(DeleteHapgRequest deleteHapgRequest)

Deletes a high-availability partition group.

Parameters:

deleteHapgRequest - Contains the inputs for the DeleteHapg action.

Returns:

A Java Future containing the result of the DeleteHapg operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• CloudHsmServiceException Indicates that an exception occurred in the AWS CloudHSM service.
• CloudHsmInternalException Indicates that an internal error occurred.
• InvalidRequestException Indicates that one or more of the request parameters are not valid.
• SdkBaseException 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
• CloudHSMException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteHsm

default CompletableFuture<DeleteHsmResponse> deleteHsm(DeleteHsmRequest deleteHsmRequest)

Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.

Parameters:

deleteHsmRequest - Contains the inputs for the DeleteHsm operation.

Returns:

A Java Future containing the result of the DeleteHsm operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• CloudHsmServiceException Indicates that an exception occurred in the AWS CloudHSM service.
• CloudHsmInternalException Indicates that an internal error occurred.
• InvalidRequestException Indicates that one or more of the request parameters are not valid.
• SdkBaseException 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
• CloudHSMException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteLunaClient

default CompletableFuture<DeleteLunaClientResponse> deleteLunaClient(DeleteLunaClientRequest deleteLunaClientRequest)

Deletes a client.

Parameters:

deleteLunaClientRequest -

Returns:

A Java Future containing the result of the DeleteLunaClient operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• CloudHsmServiceException Indicates that an exception occurred in the AWS CloudHSM service.
• CloudHsmInternalException Indicates that an internal error occurred.
• InvalidRequestException Indicates that one or more of the request parameters are not valid.
• SdkBaseException 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
• CloudHSMException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeHapg

default CompletableFuture<DescribeHapgResponse> describeHapg(DescribeHapgRequest describeHapgRequest)

Retrieves information about a high-availability partition group.

Parameters:

describeHapgRequest - Contains the inputs for the DescribeHapg action.

Returns:

A Java Future containing the result of the DescribeHapg operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• CloudHsmServiceException Indicates that an exception occurred in the AWS CloudHSM service.
• CloudHsmInternalException Indicates that an internal error occurred.
• InvalidRequestException Indicates that one or more of the request parameters are not valid.
• SdkBaseException 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
• CloudHSMException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeHsm

default CompletableFuture<DescribeHsmResponse> describeHsm(DescribeHsmRequest describeHsmRequest)

Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.

Parameters:

describeHsmRequest - Contains the inputs for the DescribeHsm operation.

Returns:

A Java Future containing the result of the DescribeHsm operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• CloudHsmServiceException Indicates that an exception occurred in the AWS CloudHSM service.
• CloudHsmInternalException Indicates that an internal error occurred.
• InvalidRequestException Indicates that one or more of the request parameters are not valid.
• SdkBaseException 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
• CloudHSMException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeLunaClient

default CompletableFuture<DescribeLunaClientResponse> describeLunaClient(DescribeLunaClientRequest describeLunaClientRequest)

Retrieves information about an HSM client.

Parameters:

describeLunaClientRequest -

Returns:

A Java Future containing the result of the DescribeLunaClient operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• CloudHsmServiceException Indicates that an exception occurred in the AWS CloudHSM service.
• CloudHsmInternalException Indicates that an internal error occurred.
• InvalidRequestException Indicates that one or more of the request parameters are not valid.
• SdkBaseException 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
• CloudHSMException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

getConfig

default CompletableFuture<GetConfigResponse> getConfig(GetConfigRequest getConfigRequest)

Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.

Parameters:

getConfigRequest -

Returns:

A Java Future containing the result of the GetConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• CloudHsmServiceException Indicates that an exception occurred in the AWS CloudHSM service.
• CloudHsmInternalException Indicates that an internal error occurred.
• InvalidRequestException Indicates that one or more of the request parameters are not valid.
• SdkBaseException 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
• CloudHSMException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listAvailableZones

default CompletableFuture<ListAvailableZonesResponse> listAvailableZones(ListAvailableZonesRequest listAvailableZonesRequest)

Lists the Availability Zones that have available AWS CloudHSM capacity.

Parameters:

listAvailableZonesRequest - Contains the inputs for the ListAvailableZones action.

Returns:

A Java Future containing the result of the ListAvailableZones operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• CloudHsmServiceException Indicates that an exception occurred in the AWS CloudHSM service.
• CloudHsmInternalException Indicates that an internal error occurred.
• InvalidRequestException Indicates that one or more of the request parameters are not valid.
• SdkBaseException 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
• CloudHSMException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listHapgs

default CompletableFuture<ListHapgsResponse> listHapgs(ListHapgsRequest listHapgsRequest)

Lists the high-availability partition groups for the account.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHapgs to retrieve the next set of items.

Parameters:

listHapgsRequest -

Returns:

A Java Future containing the result of the ListHapgs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• CloudHsmServiceException Indicates that an exception occurred in the AWS CloudHSM service.
• CloudHsmInternalException Indicates that an internal error occurred.
• InvalidRequestException Indicates that one or more of the request parameters are not valid.
• SdkBaseException 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
• CloudHSMException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listHsms

default CompletableFuture<ListHsmsResponse> listHsms(ListHsmsRequest listHsmsRequest)

Retrieves the identifiers of all of the HSMs provisioned for the current customer.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHsms to retrieve the next set of items.

Parameters:

listHsmsRequest -

Returns:

A Java Future containing the result of the ListHsms operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• CloudHsmServiceException Indicates that an exception occurred in the AWS CloudHSM service.
• CloudHsmInternalException Indicates that an internal error occurred.
• InvalidRequestException Indicates that one or more of the request parameters are not valid.
• SdkBaseException 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
• CloudHSMException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listLunaClients

default CompletableFuture<ListLunaClientsResponse> listLunaClients(ListLunaClientsRequest listLunaClientsRequest)

Lists all of the clients.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListLunaClients to retrieve the next set of items.

Parameters:

listLunaClientsRequest -

Returns:

A Java Future containing the result of the ListLunaClients operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• CloudHsmServiceException Indicates that an exception occurred in the AWS CloudHSM service.
• CloudHsmInternalException Indicates that an internal error occurred.
• InvalidRequestException Indicates that one or more of the request parameters are not valid.
• SdkBaseException 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
• CloudHSMException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listTagsForResource

default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Returns a list of all tags for the specified AWS CloudHSM resource.

Parameters:

listTagsForResourceRequest -

Returns:

A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• CloudHsmServiceException Indicates that an exception occurred in the AWS CloudHSM service.
• CloudHsmInternalException Indicates that an internal error occurred.
• InvalidRequestException Indicates that one or more of the request parameters are not valid.
• SdkBaseException 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
• CloudHSMException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

modifyHapg

default CompletableFuture<ModifyHapgResponse> modifyHapg(ModifyHapgRequest modifyHapgRequest)

Modifies an existing high-availability partition group.

Parameters:

modifyHapgRequest -

Returns:

A Java Future containing the result of the ModifyHapg operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• CloudHsmServiceException Indicates that an exception occurred in the AWS CloudHSM service.
• CloudHsmInternalException Indicates that an internal error occurred.
• InvalidRequestException Indicates that one or more of the request parameters are not valid.
• SdkBaseException 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
• CloudHSMException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

modifyHsm

default CompletableFuture<ModifyHsmResponse> modifyHsm(ModifyHsmRequest modifyHsmRequest)

Modifies an HSM.

This operation can result in the HSM being offline for up to 15 minutes while the AWS CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure that your AWS CloudHSM service is configured for high availability, and consider executing this operation during a maintenance window.

Parameters:

modifyHsmRequest - Contains the inputs for the ModifyHsm operation.

Returns:

A Java Future containing the result of the ModifyHsm operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• CloudHsmServiceException Indicates that an exception occurred in the AWS CloudHSM service.
• CloudHsmInternalException Indicates that an internal error occurred.
• InvalidRequestException Indicates that one or more of the request parameters are not valid.
• SdkBaseException 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
• CloudHSMException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

modifyLunaClient

default CompletableFuture<ModifyLunaClientResponse> modifyLunaClient(ModifyLunaClientRequest modifyLunaClientRequest)

Modifies the certificate used by the client.

This action can potentially start a workflow to install the new certificate on the client's HSMs.

Parameters:

modifyLunaClientRequest -

Returns:

A Java Future containing the result of the ModifyLunaClient operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• CloudHsmServiceException Indicates that an exception occurred in the AWS CloudHSM service.
• SdkBaseException 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
• CloudHSMException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

removeTagsFromResource

default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)

Removes one or more tags from the specified AWS CloudHSM resource.

To remove a tag, specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource.

Parameters:

removeTagsFromResourceRequest -

Returns:

A Java Future containing the result of the RemoveTagsFromResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• CloudHsmServiceException Indicates that an exception occurred in the AWS CloudHSM service.
• CloudHsmInternalException Indicates that an internal error occurred.
• InvalidRequestException Indicates that one or more of the request parameters are not valid.
• SdkBaseException 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
• CloudHSMException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation