@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSCloudHSM
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSCloudHSM
instead.
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 |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
AddTagsToResourceResult |
addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
Deprecated.
|
CreateHapgResult |
createHapg(CreateHapgRequest createHapgRequest)
Deprecated.
|
CreateHsmResult |
createHsm(CreateHsmRequest createHsmRequest)
Deprecated.
|
CreateLunaClientResult |
createLunaClient(CreateLunaClientRequest createLunaClientRequest)
Deprecated.
|
DeleteHapgResult |
deleteHapg(DeleteHapgRequest deleteHapgRequest)
Deprecated.
|
DeleteHsmResult |
deleteHsm(DeleteHsmRequest deleteHsmRequest)
Deprecated.
|
DeleteLunaClientResult |
deleteLunaClient(DeleteLunaClientRequest deleteLunaClientRequest)
Deprecated.
|
DescribeHapgResult |
describeHapg(DescribeHapgRequest describeHapgRequest)
Deprecated.
|
DescribeHsmResult |
describeHsm()
Deprecated.
|
DescribeHsmResult |
describeHsm(DescribeHsmRequest describeHsmRequest)
Deprecated.
|
DescribeLunaClientResult |
describeLunaClient()
Deprecated.
|
DescribeLunaClientResult |
describeLunaClient(DescribeLunaClientRequest describeLunaClientRequest)
Deprecated.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetConfigResult |
getConfig(GetConfigRequest getConfigRequest)
Deprecated.
|
ListAvailableZonesResult |
listAvailableZones()
Deprecated.
|
ListAvailableZonesResult |
listAvailableZones(ListAvailableZonesRequest listAvailableZonesRequest)
Deprecated.
|
ListHapgsResult |
listHapgs()
Deprecated.
|
ListHapgsResult |
listHapgs(ListHapgsRequest listHapgsRequest)
Deprecated.
|
ListHsmsResult |
listHsms()
Deprecated.
|
ListHsmsResult |
listHsms(ListHsmsRequest listHsmsRequest)
Deprecated.
|
ListLunaClientsResult |
listLunaClients()
Deprecated.
|
ListLunaClientsResult |
listLunaClients(ListLunaClientsRequest listLunaClientsRequest)
Deprecated.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Deprecated.
|
ModifyHapgResult |
modifyHapg(ModifyHapgRequest modifyHapgRequest)
Deprecated.
|
ModifyHsmResult |
modifyHsm(ModifyHsmRequest modifyHsmRequest)
Deprecated.
|
ModifyLunaClientResult |
modifyLunaClient(ModifyLunaClientRequest modifyLunaClientRequest)
Deprecated.
|
RemoveTagsFromResourceResult |
removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Deprecated.
|
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)
for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
Callers can pass in just the endpoint (ex: "cloudhsm.us-east-1.amazonaws.com/") or a full URL, including the
protocol (ex: "https://cloudhsm.us-east-1.amazonaws.com/"). If the protocol is not specified here, the default
protocol from this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint
- The endpoint (ex: "cloudhsm.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex:
"https://cloudhsm.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will
communicate with.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)
setEndpoint(String)
, sets the regional endpoint for this client's service
calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
@Deprecated AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)
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.@Deprecated CreateHapgResult createHapg(CreateHapgRequest createHapgRequest)
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.@Deprecated CreateHsmResult createHsm(CreateHsmRequest createHsmRequest)
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.@Deprecated CreateLunaClientResult createLunaClient(CreateLunaClientRequest createLunaClientRequest)
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.@Deprecated DeleteHapgResult deleteHapg(DeleteHapgRequest deleteHapgRequest)
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.@Deprecated DeleteHsmResult deleteHsm(DeleteHsmRequest deleteHsmRequest)
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.@Deprecated DeleteLunaClientResult deleteLunaClient(DeleteLunaClientRequest deleteLunaClientRequest)
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.@Deprecated DescribeHapgResult describeHapg(DescribeHapgRequest describeHapgRequest)
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.@Deprecated DescribeHsmResult describeHsm(DescribeHsmRequest describeHsmRequest)
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.@Deprecated DescribeHsmResult describeHsm()
describeHsm(DescribeHsmRequest)
@Deprecated DescribeLunaClientResult describeLunaClient(DescribeLunaClientRequest describeLunaClientRequest)
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.@Deprecated DescribeLunaClientResult describeLunaClient()
@Deprecated GetConfigResult getConfig(GetConfigRequest getConfigRequest)
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.@Deprecated ListAvailableZonesResult listAvailableZones(ListAvailableZonesRequest listAvailableZonesRequest)
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.@Deprecated ListAvailableZonesResult listAvailableZones()
@Deprecated ListHapgsResult listHapgs(ListHapgsRequest listHapgsRequest)
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.@Deprecated ListHapgsResult listHapgs()
listHapgs(ListHapgsRequest)
@Deprecated ListHsmsResult listHsms(ListHsmsRequest listHsmsRequest)
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.@Deprecated ListHsmsResult listHsms()
listHsms(ListHsmsRequest)
@Deprecated ListLunaClientsResult listLunaClients(ListLunaClientsRequest listLunaClientsRequest)
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.@Deprecated ListLunaClientsResult listLunaClients()
listLunaClients(ListLunaClientsRequest)
@Deprecated ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
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.@Deprecated ModifyHapgResult modifyHapg(ModifyHapgRequest modifyHapgRequest)
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.@Deprecated ModifyHsmResult modifyHsm(ModifyHsmRequest modifyHsmRequest)
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.@Deprecated ModifyLunaClientResult modifyLunaClient(ModifyLunaClientRequest modifyLunaClientRequest)
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.@Deprecated RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.