Package software.amazon.awssdk.services.cloudhsm

Interface CloudHsmAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface CloudHsmAsyncClient extends AwsClient
Service client for accessing CloudHSM asynchronously. This can be created using the static 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. AWS CloudHSM Service

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

  • Field Details

  • Method Details

    • addTagsToResource

      @Deprecated default CompletableFuture<AddTagsToResourceResponse> addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • addTagsToResource

      @Deprecated default CompletableFuture<AddTagsToResourceResponse> addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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.


      This is a convenience which creates an instance of the AddTagsToResourceRequest.Builder avoiding the need to create one manually via AddTagsToResourceRequest.builder()

      Parameters:
      addTagsToResourceRequest - A Consumer that will call methods on AddTagsToResourceRequest.Builder to create a request.
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createHapg

      @Deprecated default CompletableFuture<CreateHapgResponse> createHapg(CreateHapgRequest createHapgRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createHapg

      @Deprecated default CompletableFuture<CreateHapgResponse> createHapg(Consumer<CreateHapgRequest.Builder> createHapgRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

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


      This is a convenience which creates an instance of the CreateHapgRequest.Builder avoiding the need to create one manually via CreateHapgRequest.builder()

      Parameters:
      createHapgRequest - A Consumer that will call methods on CreateHapgRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createHsm

      @Deprecated default CompletableFuture<CreateHsmResponse> createHsm(CreateHsmRequest createHsmRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createHsm

      @Deprecated default CompletableFuture<CreateHsmResponse> createHsm(Consumer<CreateHsmRequest.Builder> createHsmRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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.


      This is a convenience which creates an instance of the CreateHsmRequest.Builder avoiding the need to create one manually via CreateHsmRequest.builder()

      Parameters:
      createHsmRequest - A Consumer that will call methods on CreateHsmRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLunaClient

      @Deprecated default CompletableFuture<CreateLunaClientResponse> createLunaClient(CreateLunaClientRequest createLunaClientRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createLunaClient

      @Deprecated default CompletableFuture<CreateLunaClientResponse> createLunaClient(Consumer<CreateLunaClientRequest.Builder> createLunaClientRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      Creates an HSM client.


      This is a convenience which creates an instance of the CreateLunaClientRequest.Builder avoiding the need to create one manually via CreateLunaClientRequest.builder()

      Parameters:
      createLunaClientRequest - A Consumer that will call methods on CreateLunaClientRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteHapg

      @Deprecated default CompletableFuture<DeleteHapgResponse> deleteHapg(DeleteHapgRequest deleteHapgRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteHapg

      @Deprecated default CompletableFuture<DeleteHapgResponse> deleteHapg(Consumer<DeleteHapgRequest.Builder> deleteHapgRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      Deletes a high-availability partition group.


      This is a convenience which creates an instance of the DeleteHapgRequest.Builder avoiding the need to create one manually via DeleteHapgRequest.builder()

      Parameters:
      deleteHapgRequest - A Consumer that will call methods on DeleteHapgRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteHsm

      @Deprecated default CompletableFuture<DeleteHsmResponse> deleteHsm(DeleteHsmRequest deleteHsmRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteHsm

      @Deprecated default CompletableFuture<DeleteHsmResponse> deleteHsm(Consumer<DeleteHsmRequest.Builder> deleteHsmRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

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


      This is a convenience which creates an instance of the DeleteHsmRequest.Builder avoiding the need to create one manually via DeleteHsmRequest.builder()

      Parameters:
      deleteHsmRequest - A Consumer that will call methods on DeleteHsmRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteLunaClient

      @Deprecated default CompletableFuture<DeleteLunaClientResponse> deleteLunaClient(DeleteLunaClientRequest deleteLunaClientRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteLunaClient

      @Deprecated default CompletableFuture<DeleteLunaClientResponse> deleteLunaClient(Consumer<DeleteLunaClientRequest.Builder> deleteLunaClientRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      Deletes a client.


      This is a convenience which creates an instance of the DeleteLunaClientRequest.Builder avoiding the need to create one manually via DeleteLunaClientRequest.builder()

      Parameters:
      deleteLunaClientRequest - A Consumer that will call methods on DeleteLunaClientRequest.Builder to create a request.
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeHapg

      @Deprecated default CompletableFuture<DescribeHapgResponse> describeHapg(DescribeHapgRequest describeHapgRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeHapg

      @Deprecated default CompletableFuture<DescribeHapgResponse> describeHapg(Consumer<DescribeHapgRequest.Builder> describeHapgRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      Retrieves information about a high-availability partition group.


      This is a convenience which creates an instance of the DescribeHapgRequest.Builder avoiding the need to create one manually via DescribeHapgRequest.builder()

      Parameters:
      describeHapgRequest - A Consumer that will call methods on DescribeHapgRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeHsm

      @Deprecated default CompletableFuture<DescribeHsmResponse> describeHsm(DescribeHsmRequest describeHsmRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeHsm

      @Deprecated default CompletableFuture<DescribeHsmResponse> describeHsm(Consumer<DescribeHsmRequest.Builder> describeHsmRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

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


      This is a convenience which creates an instance of the DescribeHsmRequest.Builder avoiding the need to create one manually via DescribeHsmRequest.builder()

      Parameters:
      describeHsmRequest - A Consumer that will call methods on DescribeHsmRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLunaClient

      @Deprecated default CompletableFuture<DescribeLunaClientResponse> describeLunaClient(DescribeLunaClientRequest describeLunaClientRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeLunaClient

      @Deprecated default CompletableFuture<DescribeLunaClientResponse> describeLunaClient(Consumer<DescribeLunaClientRequest.Builder> describeLunaClientRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      Retrieves information about an HSM client.


      This is a convenience which creates an instance of the DescribeLunaClientRequest.Builder avoiding the need to create one manually via DescribeLunaClientRequest.builder()

      Parameters:
      describeLunaClientRequest - A Consumer that will call methods on DescribeLunaClientRequest.Builder to create a request.
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getConfig

      @Deprecated default CompletableFuture<GetConfigResponse> getConfig(GetConfigRequest getConfigRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getConfig

      @Deprecated default CompletableFuture<GetConfigResponse> getConfig(Consumer<GetConfigRequest.Builder> getConfigRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

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


      This is a convenience which creates an instance of the GetConfigRequest.Builder avoiding the need to create one manually via GetConfigRequest.builder()

      Parameters:
      getConfigRequest - A Consumer that will call methods on GetConfigRequest.Builder to create a request.
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAvailableZones

      @Deprecated default CompletableFuture<ListAvailableZonesResponse> listAvailableZones(ListAvailableZonesRequest listAvailableZonesRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAvailableZones

      @Deprecated default CompletableFuture<ListAvailableZonesResponse> listAvailableZones(Consumer<ListAvailableZonesRequest.Builder> listAvailableZonesRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      Lists the Availability Zones that have available AWS CloudHSM capacity.


      This is a convenience which creates an instance of the ListAvailableZonesRequest.Builder avoiding the need to create one manually via ListAvailableZonesRequest.builder()

      Parameters:
      listAvailableZonesRequest - A Consumer that will call methods on ListAvailableZonesRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAvailableZones

      @Deprecated default CompletableFuture<ListAvailableZonesResponse> listAvailableZones()
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      Lists the Availability Zones that have available AWS CloudHSM capacity.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHapgs

      @Deprecated default CompletableFuture<ListHapgsResponse> listHapgs(ListHapgsRequest listHapgsRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHapgs

      @Deprecated default CompletableFuture<ListHapgsResponse> listHapgs(Consumer<ListHapgsRequest.Builder> listHapgsRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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.


      This is a convenience which creates an instance of the ListHapgsRequest.Builder avoiding the need to create one manually via ListHapgsRequest.builder()

      Parameters:
      listHapgsRequest - A Consumer that will call methods on ListHapgsRequest.Builder to create a request.
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHapgs

      @Deprecated default CompletableFuture<ListHapgsResponse> listHapgs()
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHsms

      @Deprecated default CompletableFuture<ListHsmsResponse> listHsms(ListHsmsRequest listHsmsRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHsms

      @Deprecated default CompletableFuture<ListHsmsResponse> listHsms(Consumer<ListHsmsRequest.Builder> listHsmsRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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.


      This is a convenience which creates an instance of the ListHsmsRequest.Builder avoiding the need to create one manually via ListHsmsRequest.builder()

      Parameters:
      listHsmsRequest - A Consumer that will call methods on ListHsmsRequest.Builder to create a request.
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listHsms

      @Deprecated default CompletableFuture<ListHsmsResponse> listHsms()
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLunaClients

      @Deprecated default CompletableFuture<ListLunaClientsResponse> listLunaClients(ListLunaClientsRequest listLunaClientsRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLunaClients

      @Deprecated default CompletableFuture<ListLunaClientsResponse> listLunaClients(Consumer<ListLunaClientsRequest.Builder> listLunaClientsRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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.


      This is a convenience which creates an instance of the ListLunaClientsRequest.Builder avoiding the need to create one manually via ListLunaClientsRequest.builder()

      Parameters:
      listLunaClientsRequest - A Consumer that will call methods on ListLunaClientsRequest.Builder to create a request.
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listLunaClients

      @Deprecated default CompletableFuture<ListLunaClientsResponse> listLunaClients()
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      @Deprecated default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      @Deprecated default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

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


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • modifyHapg

      @Deprecated default CompletableFuture<ModifyHapgResponse> modifyHapg(ModifyHapgRequest modifyHapgRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • modifyHapg

      @Deprecated default CompletableFuture<ModifyHapgResponse> modifyHapg(Consumer<ModifyHapgRequest.Builder> modifyHapgRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      Modifies an existing high-availability partition group.


      This is a convenience which creates an instance of the ModifyHapgRequest.Builder avoiding the need to create one manually via ModifyHapgRequest.builder()

      Parameters:
      modifyHapgRequest - A Consumer that will call methods on ModifyHapgRequest.Builder to create a request.
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • modifyHsm

      @Deprecated default CompletableFuture<ModifyHsmResponse> modifyHsm(ModifyHsmRequest modifyHsmRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • modifyHsm

      @Deprecated default CompletableFuture<ModifyHsmResponse> modifyHsm(Consumer<ModifyHsmRequest.Builder> modifyHsmRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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.


      This is a convenience which creates an instance of the ModifyHsmRequest.Builder avoiding the need to create one manually via ModifyHsmRequest.builder()

      Parameters:
      modifyHsmRequest - A Consumer that will call methods on ModifyHsmRequest.Builder to create a request. 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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • modifyLunaClient

      @Deprecated default CompletableFuture<ModifyLunaClientResponse> modifyLunaClient(ModifyLunaClientRequest modifyLunaClientRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • CloudHsmServiceException Indicates that an exception occurred in the AWS CloudHSM 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • modifyLunaClient

      @Deprecated default CompletableFuture<ModifyLunaClientResponse> modifyLunaClient(Consumer<ModifyLunaClientRequest.Builder> modifyLunaClientRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      Modifies the certificate used by the client.

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


      This is a convenience which creates an instance of the ModifyLunaClientRequest.Builder avoiding the need to create one manually via ModifyLunaClientRequest.builder()

      Parameters:
      modifyLunaClientRequest - A Consumer that will call methods on ModifyLunaClientRequest.Builder to create a request.
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • CloudHsmServiceException Indicates that an exception occurred in the AWS CloudHSM 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • removeTagsFromResource

      @Deprecated default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • removeTagsFromResource

      @Deprecated default CompletableFuture<RemoveTagsFromResourceResponse> removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest)
      Deprecated.
      This API is deprecated.

      This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

      For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

      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.


      This is a convenience which creates an instance of the RemoveTagsFromResourceRequest.Builder avoiding the need to create one manually via RemoveTagsFromResourceRequest.builder()

      Parameters:
      removeTagsFromResourceRequest - A Consumer that will call methods on RemoveTagsFromResourceRequest.Builder to create a request.
      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. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • 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.
      • CloudHsmException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default CloudHsmServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

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