Package software.amazon.awssdk.services.cloudhsm

Interface CloudHsmClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface CloudHsmClient
extends AwsClient

Service client for accessing CloudHSM. This can be created using the static builder() method. 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 Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default AddTagsToResourceResponse	addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)	Deprecated. This API is deprecated.
default AddTagsToResourceResponse	addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)	Deprecated. This API is deprecated.
static CloudHsmClientBuilder	builder()	Create a builder that can be used to configure and create a CloudHsmClient.
static CloudHsmClient	create()	Create a CloudHsmClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateHapgResponse	createHapg(Consumer<CreateHapgRequest.Builder> createHapgRequest)	Deprecated. This API is deprecated.
default CreateHapgResponse	createHapg(CreateHapgRequest createHapgRequest)	Deprecated. This API is deprecated.
default CreateHsmResponse	createHsm(Consumer<CreateHsmRequest.Builder> createHsmRequest)	Deprecated. This API is deprecated.
default CreateHsmResponse	createHsm(CreateHsmRequest createHsmRequest)	Deprecated. This API is deprecated.
default CreateLunaClientResponse	createLunaClient(Consumer<CreateLunaClientRequest.Builder> createLunaClientRequest)	Deprecated. This API is deprecated.
default CreateLunaClientResponse	createLunaClient(CreateLunaClientRequest createLunaClientRequest)	Deprecated. This API is deprecated.
default DeleteHapgResponse	deleteHapg(Consumer<DeleteHapgRequest.Builder> deleteHapgRequest)	Deprecated. This API is deprecated.
default DeleteHapgResponse	deleteHapg(DeleteHapgRequest deleteHapgRequest)	Deprecated. This API is deprecated.
default DeleteHsmResponse	deleteHsm(Consumer<DeleteHsmRequest.Builder> deleteHsmRequest)	Deprecated. This API is deprecated.
default DeleteHsmResponse	deleteHsm(DeleteHsmRequest deleteHsmRequest)	Deprecated. This API is deprecated.
default DeleteLunaClientResponse	deleteLunaClient(Consumer<DeleteLunaClientRequest.Builder> deleteLunaClientRequest)	Deprecated. This API is deprecated.
default DeleteLunaClientResponse	deleteLunaClient(DeleteLunaClientRequest deleteLunaClientRequest)	Deprecated. This API is deprecated.
default DescribeHapgResponse	describeHapg(Consumer<DescribeHapgRequest.Builder> describeHapgRequest)	Deprecated. This API is deprecated.
default DescribeHapgResponse	describeHapg(DescribeHapgRequest describeHapgRequest)	Deprecated. This API is deprecated.
default DescribeHsmResponse	describeHsm(Consumer<DescribeHsmRequest.Builder> describeHsmRequest)	Deprecated. This API is deprecated.
default DescribeHsmResponse	describeHsm(DescribeHsmRequest describeHsmRequest)	Deprecated. This API is deprecated.
default DescribeLunaClientResponse	describeLunaClient(Consumer<DescribeLunaClientRequest.Builder> describeLunaClientRequest)	Deprecated. This API is deprecated.
default DescribeLunaClientResponse	describeLunaClient(DescribeLunaClientRequest describeLunaClientRequest)	Deprecated. This API is deprecated.
default GetConfigResponse	getConfig(Consumer<GetConfigRequest.Builder> getConfigRequest)	Deprecated. This API is deprecated.
default GetConfigResponse	getConfig(GetConfigRequest getConfigRequest)	Deprecated. This API is deprecated.
default ListAvailableZonesResponse	listAvailableZones()	Deprecated. This API is deprecated.
default ListAvailableZonesResponse	listAvailableZones(Consumer<ListAvailableZonesRequest.Builder> listAvailableZonesRequest)	Deprecated. This API is deprecated.
default ListAvailableZonesResponse	listAvailableZones(ListAvailableZonesRequest listAvailableZonesRequest)	Deprecated. This API is deprecated.
default ListHapgsResponse	listHapgs()	Deprecated. This API is deprecated.
default ListHapgsResponse	listHapgs(Consumer<ListHapgsRequest.Builder> listHapgsRequest)	Deprecated. This API is deprecated.
default ListHapgsResponse	listHapgs(ListHapgsRequest listHapgsRequest)	Deprecated. This API is deprecated.
default ListHsmsResponse	listHsms()	Deprecated. This API is deprecated.
default ListHsmsResponse	listHsms(Consumer<ListHsmsRequest.Builder> listHsmsRequest)	Deprecated. This API is deprecated.
default ListHsmsResponse	listHsms(ListHsmsRequest listHsmsRequest)	Deprecated. This API is deprecated.
default ListLunaClientsResponse	listLunaClients()	Deprecated. This API is deprecated.
default ListLunaClientsResponse	listLunaClients(Consumer<ListLunaClientsRequest.Builder> listLunaClientsRequest)	Deprecated. This API is deprecated.
default ListLunaClientsResponse	listLunaClients(ListLunaClientsRequest listLunaClientsRequest)	Deprecated. This API is deprecated.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Deprecated. This API is deprecated.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Deprecated. This API is deprecated.
default ModifyHapgResponse	modifyHapg(Consumer<ModifyHapgRequest.Builder> modifyHapgRequest)	Deprecated. This API is deprecated.
default ModifyHapgResponse	modifyHapg(ModifyHapgRequest modifyHapgRequest)	Deprecated. This API is deprecated.
default ModifyHsmResponse	modifyHsm(Consumer<ModifyHsmRequest.Builder> modifyHsmRequest)	Deprecated. This API is deprecated.
default ModifyHsmResponse	modifyHsm(ModifyHsmRequest modifyHsmRequest)	Deprecated. This API is deprecated.
default ModifyLunaClientResponse	modifyLunaClient(Consumer<ModifyLunaClientRequest.Builder> modifyLunaClientRequest)	Deprecated. This API is deprecated.
default ModifyLunaClientResponse	modifyLunaClient(ModifyLunaClientRequest modifyLunaClientRequest)	Deprecated. This API is deprecated.
default RemoveTagsFromResourceResponse	removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest)	Deprecated. This API is deprecated.
default RemoveTagsFromResourceResponse	removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)	Deprecated. This API is deprecated.
default CloudHsmServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

addTagsToResource

@Deprecated
default AddTagsToResourceResponse addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
                                             throws CloudHsmServiceException,
                                                    CloudHsmInternalException,
                                                    InvalidRequestException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    CloudHsmException

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:

Result of the AddTagsToResource operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

addTagsToResource

@Deprecated
default AddTagsToResourceResponse addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)
                                             throws CloudHsmServiceException,
                                                    CloudHsmInternalException,
                                                    InvalidRequestException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    CloudHsmException

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:

Result of the AddTagsToResource operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

createHapg

@Deprecated
default CreateHapgResponse createHapg(CreateHapgRequest createHapgRequest)
                               throws CloudHsmServiceException,
                                      CloudHsmInternalException,
                                      InvalidRequestException,
                                      AwsServiceException,
                                      SdkClientException,
                                      CloudHsmException

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:

Result of the CreateHapg operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

createHapg

@Deprecated
default CreateHapgResponse createHapg(Consumer<CreateHapgRequest.Builder> createHapgRequest)
                               throws CloudHsmServiceException,
                                      CloudHsmInternalException,
                                      InvalidRequestException,
                                      AwsServiceException,
                                      SdkClientException,
                                      CloudHsmException

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:

Result of the CreateHapg operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

createHsm

@Deprecated
default CreateHsmResponse createHsm(CreateHsmRequest createHsmRequest)
                             throws CloudHsmServiceException,
                                    CloudHsmInternalException,
                                    InvalidRequestException,
                                    AwsServiceException,
                                    SdkClientException,
                                    CloudHsmException

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:

Result of the CreateHsm operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

createHsm

@Deprecated
default CreateHsmResponse createHsm(Consumer<CreateHsmRequest.Builder> createHsmRequest)
                             throws CloudHsmServiceException,
                                    CloudHsmInternalException,
                                    InvalidRequestException,
                                    AwsServiceException,
                                    SdkClientException,
                                    CloudHsmException

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:

Result of the CreateHsm operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

createLunaClient

@Deprecated
default CreateLunaClientResponse createLunaClient(CreateLunaClientRequest createLunaClientRequest)
                                           throws CloudHsmServiceException,
                                                  CloudHsmInternalException,
                                                  InvalidRequestException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  CloudHsmException

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:

Result of the CreateLunaClient operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

createLunaClient

@Deprecated
default CreateLunaClientResponse createLunaClient(Consumer<CreateLunaClientRequest.Builder> createLunaClientRequest)
                                           throws CloudHsmServiceException,
                                                  CloudHsmInternalException,
                                                  InvalidRequestException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  CloudHsmException

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:

Result of the CreateLunaClient operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

deleteHapg

@Deprecated
default DeleteHapgResponse deleteHapg(DeleteHapgRequest deleteHapgRequest)
                               throws CloudHsmServiceException,
                                      CloudHsmInternalException,
                                      InvalidRequestException,
                                      AwsServiceException,
                                      SdkClientException,
                                      CloudHsmException

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:

Result of the DeleteHapg operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

deleteHapg

@Deprecated
default DeleteHapgResponse deleteHapg(Consumer<DeleteHapgRequest.Builder> deleteHapgRequest)
                               throws CloudHsmServiceException,
                                      CloudHsmInternalException,
                                      InvalidRequestException,
                                      AwsServiceException,
                                      SdkClientException,
                                      CloudHsmException

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:

Result of the DeleteHapg operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

deleteHsm

@Deprecated
default DeleteHsmResponse deleteHsm(DeleteHsmRequest deleteHsmRequest)
                             throws CloudHsmServiceException,
                                    CloudHsmInternalException,
                                    InvalidRequestException,
                                    AwsServiceException,
                                    SdkClientException,
                                    CloudHsmException

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:

Result of the DeleteHsm operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

deleteHsm

@Deprecated
default DeleteHsmResponse deleteHsm(Consumer<DeleteHsmRequest.Builder> deleteHsmRequest)
                             throws CloudHsmServiceException,
                                    CloudHsmInternalException,
                                    InvalidRequestException,
                                    AwsServiceException,
                                    SdkClientException,
                                    CloudHsmException

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:

Result of the DeleteHsm operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

deleteLunaClient

@Deprecated
default DeleteLunaClientResponse deleteLunaClient(DeleteLunaClientRequest deleteLunaClientRequest)
                                           throws CloudHsmServiceException,
                                                  CloudHsmInternalException,
                                                  InvalidRequestException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  CloudHsmException

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:

Result of the DeleteLunaClient operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

deleteLunaClient

@Deprecated
default DeleteLunaClientResponse deleteLunaClient(Consumer<DeleteLunaClientRequest.Builder> deleteLunaClientRequest)
                                           throws CloudHsmServiceException,
                                                  CloudHsmInternalException,
                                                  InvalidRequestException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  CloudHsmException

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:

Result of the DeleteLunaClient operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

describeHapg

@Deprecated
default DescribeHapgResponse describeHapg(DescribeHapgRequest describeHapgRequest)
                                   throws CloudHsmServiceException,
                                          CloudHsmInternalException,
                                          InvalidRequestException,
                                          AwsServiceException,
                                          SdkClientException,
                                          CloudHsmException

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:

Result of the DescribeHapg operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

describeHapg

@Deprecated
default DescribeHapgResponse describeHapg(Consumer<DescribeHapgRequest.Builder> describeHapgRequest)
                                   throws CloudHsmServiceException,
                                          CloudHsmInternalException,
                                          InvalidRequestException,
                                          AwsServiceException,
                                          SdkClientException,
                                          CloudHsmException

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:

Result of the DescribeHapg operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

describeHsm

@Deprecated
default DescribeHsmResponse describeHsm(DescribeHsmRequest describeHsmRequest)
                                 throws CloudHsmServiceException,
                                        CloudHsmInternalException,
                                        InvalidRequestException,
                                        AwsServiceException,
                                        SdkClientException,
                                        CloudHsmException

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:

Result of the DescribeHsm operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

describeHsm

@Deprecated
default DescribeHsmResponse describeHsm(Consumer<DescribeHsmRequest.Builder> describeHsmRequest)
                                 throws CloudHsmServiceException,
                                        CloudHsmInternalException,
                                        InvalidRequestException,
                                        AwsServiceException,
                                        SdkClientException,
                                        CloudHsmException

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:

Result of the DescribeHsm operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

describeLunaClient

@Deprecated
default DescribeLunaClientResponse describeLunaClient(DescribeLunaClientRequest describeLunaClientRequest)
                                               throws CloudHsmServiceException,
                                                      CloudHsmInternalException,
                                                      InvalidRequestException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      CloudHsmException

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:

Result of the DescribeLunaClient operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

describeLunaClient

@Deprecated
default DescribeLunaClientResponse describeLunaClient(Consumer<DescribeLunaClientRequest.Builder> describeLunaClientRequest)
                                               throws CloudHsmServiceException,
                                                      CloudHsmInternalException,
                                                      InvalidRequestException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      CloudHsmException

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:

Result of the DescribeLunaClient operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

getConfig

@Deprecated
default GetConfigResponse getConfig(GetConfigRequest getConfigRequest)
                             throws CloudHsmServiceException,
                                    CloudHsmInternalException,
                                    InvalidRequestException,
                                    AwsServiceException,
                                    SdkClientException,
                                    CloudHsmException

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:

Result of the GetConfig operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

getConfig

@Deprecated
default GetConfigResponse getConfig(Consumer<GetConfigRequest.Builder> getConfigRequest)
                             throws CloudHsmServiceException,
                                    CloudHsmInternalException,
                                    InvalidRequestException,
                                    AwsServiceException,
                                    SdkClientException,
                                    CloudHsmException

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:

Result of the GetConfig operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listAvailableZones

@Deprecated
default ListAvailableZonesResponse listAvailableZones(ListAvailableZonesRequest listAvailableZonesRequest)
                                               throws CloudHsmServiceException,
                                                      CloudHsmInternalException,
                                                      InvalidRequestException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      CloudHsmException

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:

Result of the ListAvailableZones operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listAvailableZones

@Deprecated
default ListAvailableZonesResponse listAvailableZones(Consumer<ListAvailableZonesRequest.Builder> listAvailableZonesRequest)
                                               throws CloudHsmServiceException,
                                                      CloudHsmInternalException,
                                                      InvalidRequestException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      CloudHsmException

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:

Result of the ListAvailableZones operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listAvailableZones

@Deprecated
default ListAvailableZonesResponse listAvailableZones()
                                               throws CloudHsmServiceException,
                                                      CloudHsmInternalException,
                                                      InvalidRequestException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      CloudHsmException

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:

Result of the ListAvailableZones operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

listAvailableZones(ListAvailableZonesRequest), AWS API Documentation

listHapgs

@Deprecated
default ListHapgsResponse listHapgs(ListHapgsRequest listHapgsRequest)
                             throws CloudHsmServiceException,
                                    CloudHsmInternalException,
                                    InvalidRequestException,
                                    AwsServiceException,
                                    SdkClientException,
                                    CloudHsmException

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:

Result of the ListHapgs operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listHapgs

@Deprecated
default ListHapgsResponse listHapgs(Consumer<ListHapgsRequest.Builder> listHapgsRequest)
                             throws CloudHsmServiceException,
                                    CloudHsmInternalException,
                                    InvalidRequestException,
                                    AwsServiceException,
                                    SdkClientException,
                                    CloudHsmException

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:

Result of the ListHapgs operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listHapgs

@Deprecated
default ListHapgsResponse listHapgs()
                             throws CloudHsmServiceException,
                                    CloudHsmInternalException,
                                    InvalidRequestException,
                                    AwsServiceException,
                                    SdkClientException,
                                    CloudHsmException

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:

Result of the ListHapgs operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

listHapgs(ListHapgsRequest), AWS API Documentation

listHsms

@Deprecated
default ListHsmsResponse listHsms(ListHsmsRequest listHsmsRequest)
                           throws CloudHsmServiceException,
                                  CloudHsmInternalException,
                                  InvalidRequestException,
                                  AwsServiceException,
                                  SdkClientException,
                                  CloudHsmException

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:

Result of the ListHsms operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listHsms

@Deprecated
default ListHsmsResponse listHsms(Consumer<ListHsmsRequest.Builder> listHsmsRequest)
                           throws CloudHsmServiceException,
                                  CloudHsmInternalException,
                                  InvalidRequestException,
                                  AwsServiceException,
                                  SdkClientException,
                                  CloudHsmException

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:

Result of the ListHsms operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listHsms

@Deprecated
default ListHsmsResponse listHsms()
                           throws CloudHsmServiceException,
                                  CloudHsmInternalException,
                                  InvalidRequestException,
                                  AwsServiceException,
                                  SdkClientException,
                                  CloudHsmException

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:

Result of the ListHsms operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

listHsms(ListHsmsRequest), AWS API Documentation

listLunaClients

@Deprecated
default ListLunaClientsResponse listLunaClients(ListLunaClientsRequest listLunaClientsRequest)
                                         throws CloudHsmServiceException,
                                                CloudHsmInternalException,
                                                InvalidRequestException,
                                                AwsServiceException,
                                                SdkClientException,
                                                CloudHsmException

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:

Result of the ListLunaClients operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listLunaClients

@Deprecated
default ListLunaClientsResponse listLunaClients(Consumer<ListLunaClientsRequest.Builder> listLunaClientsRequest)
                                         throws CloudHsmServiceException,
                                                CloudHsmInternalException,
                                                InvalidRequestException,
                                                AwsServiceException,
                                                SdkClientException,
                                                CloudHsmException

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:

Result of the ListLunaClients operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listLunaClients

@Deprecated
default ListLunaClientsResponse listLunaClients()
                                         throws CloudHsmServiceException,
                                                CloudHsmInternalException,
                                                InvalidRequestException,
                                                AwsServiceException,
                                                SdkClientException,
                                                CloudHsmException

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:

Result of the ListLunaClients operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

listLunaClients(ListLunaClientsRequest), AWS API Documentation

listTagsForResource

@Deprecated
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws CloudHsmServiceException,
                                                        CloudHsmInternalException,
                                                        InvalidRequestException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        CloudHsmException

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:

Result of the ListTagsForResource operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

@Deprecated
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws CloudHsmServiceException,
                                                        CloudHsmInternalException,
                                                        InvalidRequestException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        CloudHsmException

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:

Result of the ListTagsForResource operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

modifyHapg

@Deprecated
default ModifyHapgResponse modifyHapg(ModifyHapgRequest modifyHapgRequest)
                               throws CloudHsmServiceException,
                                      CloudHsmInternalException,
                                      InvalidRequestException,
                                      AwsServiceException,
                                      SdkClientException,
                                      CloudHsmException

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:

Result of the ModifyHapg operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

modifyHapg

@Deprecated
default ModifyHapgResponse modifyHapg(Consumer<ModifyHapgRequest.Builder> modifyHapgRequest)
                               throws CloudHsmServiceException,
                                      CloudHsmInternalException,
                                      InvalidRequestException,
                                      AwsServiceException,
                                      SdkClientException,
                                      CloudHsmException

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:

Result of the ModifyHapg operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

modifyHsm

@Deprecated
default ModifyHsmResponse modifyHsm(ModifyHsmRequest modifyHsmRequest)
                             throws CloudHsmServiceException,
                                    CloudHsmInternalException,
                                    InvalidRequestException,
                                    AwsServiceException,
                                    SdkClientException,
                                    CloudHsmException

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:

Result of the ModifyHsm operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

modifyHsm

@Deprecated
default ModifyHsmResponse modifyHsm(Consumer<ModifyHsmRequest.Builder> modifyHsmRequest)
                             throws CloudHsmServiceException,
                                    CloudHsmInternalException,
                                    InvalidRequestException,
                                    AwsServiceException,
                                    SdkClientException,
                                    CloudHsmException

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:

Result of the ModifyHsm operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

modifyLunaClient

@Deprecated
default ModifyLunaClientResponse modifyLunaClient(ModifyLunaClientRequest modifyLunaClientRequest)
                                           throws CloudHsmServiceException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  CloudHsmException

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:

Result of the ModifyLunaClient operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

modifyLunaClient

@Deprecated
default ModifyLunaClientResponse modifyLunaClient(Consumer<ModifyLunaClientRequest.Builder> modifyLunaClientRequest)
                                           throws CloudHsmServiceException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  CloudHsmException

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:

Result of the ModifyLunaClient operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

removeTagsFromResource

@Deprecated
default RemoveTagsFromResourceResponse removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
                                                       throws CloudHsmServiceException,
                                                              CloudHsmInternalException,
                                                              InvalidRequestException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              CloudHsmException

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:

Result of the RemoveTagsFromResource operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

removeTagsFromResource

@Deprecated
default RemoveTagsFromResourceResponse removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest)
                                                       throws CloudHsmServiceException,
                                                              CloudHsmInternalException,
                                                              InvalidRequestException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              CloudHsmException

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:

Result of the RemoveTagsFromResource operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

create

static CloudHsmClient create()

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

builder

static CloudHsmClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default CloudHsmServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient