AutoCloseable
@Generated("software.amazon.awssdk:codegen") public interface CloudHSMClient extends AutoCloseable
builder()
method.
Modifier and Type | Field | Description |
---|---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method | Description |
---|---|---|
default AddTagsToResourceResponse |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) |
Adds or overwrites one or more tags for the specified AWS CloudHSM resource.
|
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(CreateHapgRequest createHapgRequest) |
Creates a high-availability partition group.
|
default CreateHsmResponse |
createHsm(CreateHsmRequest createHsmRequest) |
Creates an uninitialized HSM instance.
|
default CreateLunaClientResponse |
createLunaClient(CreateLunaClientRequest createLunaClientRequest) |
Creates an HSM client.
|
default DeleteHapgResponse |
deleteHapg(DeleteHapgRequest deleteHapgRequest) |
Deletes a high-availability partition group.
|
default DeleteHsmResponse |
deleteHsm(DeleteHsmRequest deleteHsmRequest) |
Deletes an HSM.
|
default DeleteLunaClientResponse |
deleteLunaClient(DeleteLunaClientRequest deleteLunaClientRequest) |
Deletes a client.
|
default DescribeHapgResponse |
describeHapg(DescribeHapgRequest describeHapgRequest) |
Retrieves information about a high-availability partition group.
|
default DescribeHsmResponse |
describeHsm(DescribeHsmRequest describeHsmRequest) |
Retrieves information about an HSM.
|
default DescribeLunaClientResponse |
describeLunaClient(DescribeLunaClientRequest describeLunaClientRequest) |
Retrieves information about an HSM client.
|
default GetConfigResponse |
getConfig(GetConfigRequest getConfigRequest) |
Gets the configuration files necessary to connect to all high availability partition groups the client is
associated with.
|
default ListAvailableZonesResponse |
listAvailableZones(ListAvailableZonesRequest listAvailableZonesRequest) |
Lists the Availability Zones that have available AWS CloudHSM capacity.
|
default ListHapgsResponse |
listHapgs(ListHapgsRequest listHapgsRequest) |
Lists the high-availability partition groups for the account.
|
default ListHsmsResponse |
listHsms(ListHsmsRequest listHsmsRequest) |
Retrieves the identifiers of all of the HSMs provisioned for the current customer.
|
default ListLunaClientsResponse |
listLunaClients(ListLunaClientsRequest listLunaClientsRequest) |
Lists all of the clients.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) |
Returns a list of all tags for the specified AWS CloudHSM resource.
|
default ModifyHapgResponse |
modifyHapg(ModifyHapgRequest modifyHapgRequest) |
Modifies an existing high-availability partition group.
|
default ModifyHsmResponse |
modifyHsm(ModifyHsmRequest modifyHsmRequest) |
Modifies an HSM.
|
default ModifyLunaClientResponse |
modifyLunaClient(ModifyLunaClientRequest modifyLunaClientRequest) |
Modifies the certificate used by the client.
|
default RemoveTagsFromResourceResponse |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) |
Removes one or more tags from the specified AWS CloudHSM resource.
|
static ServiceMetadata |
serviceMetadata() |
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, SdkBaseException, SdkClientException, CloudHSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudHSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateHapgResponse createHapg(CreateHapgRequest createHapgRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, SdkBaseException, SdkClientException, CloudHSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudHSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateHsmResponse createHsm(CreateHsmRequest createHsmRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, SdkBaseException, SdkClientException, CloudHSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudHSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateLunaClientResponse createLunaClient(CreateLunaClientRequest createLunaClientRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, SdkBaseException, SdkClientException, CloudHSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudHSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteHapgResponse deleteHapg(DeleteHapgRequest deleteHapgRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, SdkBaseException, SdkClientException, CloudHSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudHSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteHsmResponse deleteHsm(DeleteHsmRequest deleteHsmRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, SdkBaseException, SdkClientException, CloudHSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudHSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteLunaClientResponse deleteLunaClient(DeleteLunaClientRequest deleteLunaClientRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, SdkBaseException, SdkClientException, CloudHSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudHSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeHapgResponse describeHapg(DescribeHapgRequest describeHapgRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, SdkBaseException, SdkClientException, CloudHSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudHSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeHsmResponse describeHsm(DescribeHsmRequest describeHsmRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, SdkBaseException, SdkClientException, CloudHSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudHSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeLunaClientResponse describeLunaClient(DescribeLunaClientRequest describeLunaClientRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, SdkBaseException, SdkClientException, CloudHSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudHSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault GetConfigResponse getConfig(GetConfigRequest getConfigRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, SdkBaseException, SdkClientException, CloudHSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudHSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListAvailableZonesResponse listAvailableZones(ListAvailableZonesRequest listAvailableZonesRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, SdkBaseException, SdkClientException, CloudHSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudHSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListHapgsResponse listHapgs(ListHapgsRequest listHapgsRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, SdkBaseException, SdkClientException, CloudHSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudHSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListHsmsResponse listHsms(ListHsmsRequest listHsmsRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, SdkBaseException, SdkClientException, CloudHSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudHSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListLunaClientsResponse listLunaClients(ListLunaClientsRequest listLunaClientsRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, SdkBaseException, SdkClientException, CloudHSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudHSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, SdkBaseException, SdkClientException, CloudHSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudHSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ModifyHapgResponse modifyHapg(ModifyHapgRequest modifyHapgRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, SdkBaseException, SdkClientException, CloudHSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudHSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ModifyHsmResponse modifyHsm(ModifyHsmRequest modifyHsmRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, SdkBaseException, SdkClientException, CloudHSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudHSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ModifyLunaClientResponse modifyLunaClient(ModifyLunaClientRequest modifyLunaClientRequest) throws CloudHsmServiceException, SdkBaseException, SdkClientException, CloudHSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudHSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RemoveTagsFromResourceResponse removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) throws CloudHsmServiceException, CloudHsmInternalException, InvalidRequestException, SdkBaseException, SdkClientException, CloudHSMException
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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)CloudHSMException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typestatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.