@Generated(value="software.amazon.awssdk:codegen") public interface CloudHsmClient extends SdkClient
builder()
method.
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.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default AddTagsToResourceResponse |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
This is documentation for AWS CloudHSM Classic.
|
default AddTagsToResourceResponse |
addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest)
This is documentation for AWS CloudHSM Classic.
|
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)
This is documentation for AWS CloudHSM Classic.
|
default CreateHapgResponse |
createHapg(CreateHapgRequest createHapgRequest)
This is documentation for AWS CloudHSM Classic.
|
default CreateHsmResponse |
createHsm(Consumer<CreateHsmRequest.Builder> createHsmRequest)
This is documentation for AWS CloudHSM Classic.
|
default CreateHsmResponse |
createHsm(CreateHsmRequest createHsmRequest)
This is documentation for AWS CloudHSM Classic.
|
default CreateLunaClientResponse |
createLunaClient(Consumer<CreateLunaClientRequest.Builder> createLunaClientRequest)
This is documentation for AWS CloudHSM Classic.
|
default CreateLunaClientResponse |
createLunaClient(CreateLunaClientRequest createLunaClientRequest)
This is documentation for AWS CloudHSM Classic.
|
default DeleteHapgResponse |
deleteHapg(Consumer<DeleteHapgRequest.Builder> deleteHapgRequest)
This is documentation for AWS CloudHSM Classic.
|
default DeleteHapgResponse |
deleteHapg(DeleteHapgRequest deleteHapgRequest)
This is documentation for AWS CloudHSM Classic.
|
default DeleteHsmResponse |
deleteHsm(Consumer<DeleteHsmRequest.Builder> deleteHsmRequest)
This is documentation for AWS CloudHSM Classic.
|
default DeleteHsmResponse |
deleteHsm(DeleteHsmRequest deleteHsmRequest)
This is documentation for AWS CloudHSM Classic.
|
default DeleteLunaClientResponse |
deleteLunaClient(Consumer<DeleteLunaClientRequest.Builder> deleteLunaClientRequest)
This is documentation for AWS CloudHSM Classic.
|
default DeleteLunaClientResponse |
deleteLunaClient(DeleteLunaClientRequest deleteLunaClientRequest)
This is documentation for AWS CloudHSM Classic.
|
default DescribeHapgResponse |
describeHapg(Consumer<DescribeHapgRequest.Builder> describeHapgRequest)
This is documentation for AWS CloudHSM Classic.
|
default DescribeHapgResponse |
describeHapg(DescribeHapgRequest describeHapgRequest)
This is documentation for AWS CloudHSM Classic.
|
default DescribeHsmResponse |
describeHsm(Consumer<DescribeHsmRequest.Builder> describeHsmRequest)
This is documentation for AWS CloudHSM Classic.
|
default DescribeHsmResponse |
describeHsm(DescribeHsmRequest describeHsmRequest)
This is documentation for AWS CloudHSM Classic.
|
default DescribeLunaClientResponse |
describeLunaClient(Consumer<DescribeLunaClientRequest.Builder> describeLunaClientRequest)
This is documentation for AWS CloudHSM Classic.
|
default DescribeLunaClientResponse |
describeLunaClient(DescribeLunaClientRequest describeLunaClientRequest)
This is documentation for AWS CloudHSM Classic.
|
default GetConfigResponse |
getConfig(Consumer<GetConfigRequest.Builder> getConfigRequest)
This is documentation for AWS CloudHSM Classic.
|
default GetConfigResponse |
getConfig(GetConfigRequest getConfigRequest)
This is documentation for AWS CloudHSM Classic.
|
default ListAvailableZonesResponse |
listAvailableZones()
This is documentation for AWS CloudHSM Classic.
|
default ListAvailableZonesResponse |
listAvailableZones(Consumer<ListAvailableZonesRequest.Builder> listAvailableZonesRequest)
This is documentation for AWS CloudHSM Classic.
|
default ListAvailableZonesResponse |
listAvailableZones(ListAvailableZonesRequest listAvailableZonesRequest)
This is documentation for AWS CloudHSM Classic.
|
default ListHapgsResponse |
listHapgs()
This is documentation for AWS CloudHSM Classic.
|
default ListHapgsResponse |
listHapgs(Consumer<ListHapgsRequest.Builder> listHapgsRequest)
This is documentation for AWS CloudHSM Classic.
|
default ListHapgsResponse |
listHapgs(ListHapgsRequest listHapgsRequest)
This is documentation for AWS CloudHSM Classic.
|
default ListHsmsResponse |
listHsms()
This is documentation for AWS CloudHSM Classic.
|
default ListHsmsResponse |
listHsms(Consumer<ListHsmsRequest.Builder> listHsmsRequest)
This is documentation for AWS CloudHSM Classic.
|
default ListHsmsResponse |
listHsms(ListHsmsRequest listHsmsRequest)
This is documentation for AWS CloudHSM Classic.
|
default ListLunaClientsResponse |
listLunaClients()
This is documentation for AWS CloudHSM Classic.
|
default ListLunaClientsResponse |
listLunaClients(Consumer<ListLunaClientsRequest.Builder> listLunaClientsRequest)
This is documentation for AWS CloudHSM Classic.
|
default ListLunaClientsResponse |
listLunaClients(ListLunaClientsRequest listLunaClientsRequest)
This is documentation for AWS CloudHSM Classic.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
This is documentation for AWS CloudHSM Classic.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
This is documentation for AWS CloudHSM Classic.
|
default ModifyHapgResponse |
modifyHapg(Consumer<ModifyHapgRequest.Builder> modifyHapgRequest)
This is documentation for AWS CloudHSM Classic.
|
default ModifyHapgResponse |
modifyHapg(ModifyHapgRequest modifyHapgRequest)
This is documentation for AWS CloudHSM Classic.
|
default ModifyHsmResponse |
modifyHsm(Consumer<ModifyHsmRequest.Builder> modifyHsmRequest)
This is documentation for AWS CloudHSM Classic.
|
default ModifyHsmResponse |
modifyHsm(ModifyHsmRequest modifyHsmRequest)
This is documentation for AWS CloudHSM Classic.
|
default ModifyLunaClientResponse |
modifyLunaClient(Consumer<ModifyLunaClientRequest.Builder> modifyLunaClientRequest)
This is documentation for AWS CloudHSM Classic.
|
default ModifyLunaClientResponse |
modifyLunaClient(ModifyLunaClientRequest modifyLunaClientRequest)
This is documentation for AWS CloudHSM Classic.
|
default RemoveTagsFromResourceResponse |
removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest)
This is documentation for AWS CloudHSM Classic.
|
default RemoveTagsFromResourceResponse |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
This is documentation for AWS CloudHSM Classic.
|
static ServiceMetadata |
serviceMetadata() |
serviceName
close
static final String SERVICE_NAME
static CloudHsmClient create()
CloudHsmClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static CloudHsmClientBuilder builder()
CloudHsmClient
.default AddTagsToResourceResponse addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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.
addTagsToResourceRequest
- 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
default AddTagsToResourceResponse addTagsToResource(Consumer<AddTagsToResourceRequest.Builder> addTagsToResourceRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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()
addTagsToResourceRequest
- A Consumer
that will call methods on AddTagsToResourceRequest.Builder
to create a request.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
default CreateHapgResponse createHapg(CreateHapgRequest createHapgRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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.
createHapgRequest
- Contains the inputs for the CreateHapgRequest action.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
default CreateHapgResponse createHapg(Consumer<CreateHapgRequest.Builder> createHapgRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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()
createHapgRequest
- A Consumer
that will call methods on CreateHapgRequest.Builder
to create a request.
Contains the inputs for the CreateHapgRequest action.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
default CreateHsmResponse createHsm(CreateHsmRequest createHsmRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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
.
createHsmRequest
- Contains the inputs for the CreateHsm
operation.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
default CreateHsmResponse createHsm(Consumer<CreateHsmRequest.Builder> createHsmRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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()
createHsmRequest
- A Consumer
that will call methods on CreateHsmRequest.Builder
to create a request.
Contains the inputs for the CreateHsm
operation.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
default CreateLunaClientResponse createLunaClient(CreateLunaClientRequest createLunaClientRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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.
createLunaClientRequest
- Contains the inputs for the CreateLunaClient action.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
default CreateLunaClientResponse createLunaClient(Consumer<CreateLunaClientRequest.Builder> createLunaClientRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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()
createLunaClientRequest
- A Consumer
that will call methods on CreateLunaClientRequest.Builder
to create a request.
Contains the inputs for the CreateLunaClient action.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
default DeleteHapgResponse deleteHapg(DeleteHapgRequest deleteHapgRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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.
deleteHapgRequest
- Contains the inputs for the DeleteHapg action.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
default DeleteHapgResponse deleteHapg(Consumer<DeleteHapgRequest.Builder> deleteHapgRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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()
deleteHapgRequest
- A Consumer
that will call methods on DeleteHapgRequest.Builder
to create a request.
Contains the inputs for the DeleteHapg action.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
default DeleteHsmResponse deleteHsm(DeleteHsmRequest deleteHsmRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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.
deleteHsmRequest
- Contains the inputs for the DeleteHsm operation.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
default DeleteHsmResponse deleteHsm(Consumer<DeleteHsmRequest.Builder> deleteHsmRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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()
deleteHsmRequest
- A Consumer
that will call methods on DeleteHsmRequest.Builder
to create a request.
Contains the inputs for the DeleteHsm operation.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
default DeleteLunaClientResponse deleteLunaClient(DeleteLunaClientRequest deleteLunaClientRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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.
deleteLunaClientRequest
- 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
default DeleteLunaClientResponse deleteLunaClient(Consumer<DeleteLunaClientRequest.Builder> deleteLunaClientRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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()
deleteLunaClientRequest
- A Consumer
that will call methods on DeleteLunaClientRequest.Builder
to create a request.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
default DescribeHapgResponse describeHapg(DescribeHapgRequest describeHapgRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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.
describeHapgRequest
- Contains the inputs for the DescribeHapg action.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
default DescribeHapgResponse describeHapg(Consumer<DescribeHapgRequest.Builder> describeHapgRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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()
describeHapgRequest
- A Consumer
that will call methods on DescribeHapgRequest.Builder
to create a request.
Contains the inputs for the DescribeHapg action.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
default DescribeHsmResponse describeHsm(DescribeHsmRequest describeHsmRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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.
describeHsmRequest
- Contains the inputs for the DescribeHsm operation.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
default DescribeHsmResponse describeHsm(Consumer<DescribeHsmRequest.Builder> describeHsmRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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()
describeHsmRequest
- A Consumer
that will call methods on DescribeHsmRequest.Builder
to create a request.
Contains the inputs for the DescribeHsm operation.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
default DescribeLunaClientResponse describeLunaClient(DescribeLunaClientRequest describeLunaClientRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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.
describeLunaClientRequest
- 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
default DescribeLunaClientResponse describeLunaClient(Consumer<DescribeLunaClientRequest.Builder> describeLunaClientRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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()
describeLunaClientRequest
- A Consumer
that will call methods on DescribeLunaClientRequest.Builder
to create a
request.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
default GetConfigResponse getConfig(GetConfigRequest getConfigRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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.
getConfigRequest
- 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
default GetConfigResponse getConfig(Consumer<GetConfigRequest.Builder> getConfigRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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()
getConfigRequest
- A Consumer
that will call methods on GetConfigRequest.Builder
to create a request.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
default ListAvailableZonesResponse listAvailableZones() throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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.
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
listAvailableZones(ListAvailableZonesRequest)
,
AWS
API Documentationdefault ListAvailableZonesResponse listAvailableZones(ListAvailableZonesRequest listAvailableZonesRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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.
listAvailableZonesRequest
- Contains the inputs for the ListAvailableZones action.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
default ListAvailableZonesResponse listAvailableZones(Consumer<ListAvailableZonesRequest.Builder> listAvailableZonesRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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()
listAvailableZonesRequest
- A Consumer
that will call methods on ListAvailableZonesRequest.Builder
to create a
request. Contains the inputs for the ListAvailableZones action.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
default ListHapgsResponse listHapgs() throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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.
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
listHapgs(ListHapgsRequest)
,
AWS API
Documentationdefault ListHapgsResponse listHapgs(ListHapgsRequest listHapgsRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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.
listHapgsRequest
- 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
default ListHapgsResponse listHapgs(Consumer<ListHapgsRequest.Builder> listHapgsRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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()
listHapgsRequest
- A Consumer
that will call methods on ListHapgsRequest.Builder
to create a request.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
default ListHsmsResponse listHsms() throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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.
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
listHsms(ListHsmsRequest)
,
AWS API
Documentationdefault ListHsmsResponse listHsms(ListHsmsRequest listHsmsRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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.
listHsmsRequest
- 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
default ListHsmsResponse listHsms(Consumer<ListHsmsRequest.Builder> listHsmsRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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()
listHsmsRequest
- A Consumer
that will call methods on ListHsmsRequest.Builder
to create a request.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
default ListLunaClientsResponse listLunaClients() throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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.
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
listLunaClients(ListLunaClientsRequest)
,
AWS API
Documentationdefault ListLunaClientsResponse listLunaClients(ListLunaClientsRequest listLunaClientsRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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.
listLunaClientsRequest
- 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
default ListLunaClientsResponse listLunaClients(Consumer<ListLunaClientsRequest.Builder> listLunaClientsRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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()
listLunaClientsRequest
- A Consumer
that will call methods on ListLunaClientsRequest.Builder
to create a request.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
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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.
listTagsForResourceRequest
- 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
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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()
listTagsForResourceRequest
- A Consumer
that will call methods on ListTagsForResourceRequest.Builder
to create a
request.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
default ModifyHapgResponse modifyHapg(ModifyHapgRequest modifyHapgRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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.
modifyHapgRequest
- 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
default ModifyHapgResponse modifyHapg(Consumer<ModifyHapgRequest.Builder> modifyHapgRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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()
modifyHapgRequest
- A Consumer
that will call methods on ModifyHapgRequest.Builder
to create a request.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
default ModifyHsmResponse modifyHsm(ModifyHsmRequest modifyHsmRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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.
modifyHsmRequest
- Contains the inputs for the ModifyHsm operation.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
default ModifyHsmResponse modifyHsm(Consumer<ModifyHsmRequest.Builder> modifyHsmRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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()
modifyHsmRequest
- A Consumer
that will call methods on ModifyHsmRequest.Builder
to create a request.
Contains the inputs for the ModifyHsm operation.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
default ModifyLunaClientResponse modifyLunaClient(ModifyLunaClientRequest modifyLunaClientRequest) throws CloudHsmServiceException, AwsServiceException, SdkClientException, CloudHsmException
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.
modifyLunaClientRequest
- 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
default ModifyLunaClientResponse modifyLunaClient(Consumer<ModifyLunaClientRequest.Builder> modifyLunaClientRequest) throws CloudHsmServiceException, AwsServiceException, SdkClientException, CloudHsmException
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()
modifyLunaClientRequest
- A Consumer
that will call methods on ModifyLunaClientRequest.Builder
to create a request.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
default RemoveTagsFromResourceResponse removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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.
removeTagsFromResourceRequest
- 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
default RemoveTagsFromResourceResponse removeTagsFromResource(Consumer<RemoveTagsFromResourceRequest.Builder> removeTagsFromResourceRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, AwsServiceException, SdkClientException, CloudHsmException
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()
removeTagsFromResourceRequest
- A Consumer
that will call methods on RemoveTagsFromResourceRequest.Builder
to create a
request.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
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.