com.amazonaws.services.cloudhsm

Interface AWSCloudHSM

All Known Subinterfaces:

AWSCloudHSMAsync

All Known Implementing Classes:

AWSCloudHSMAsyncClient, AWSCloudHSMClient

public interface AWSCloudHSM

Interface for accessing AWSCloudHSM. AWS CloudHSM Service

Method Summary

Methods

Modifier and Type	Method and Description
CreateHapgResult	createHapg(CreateHapgRequest createHapgRequest) Creates a high-availability partition group.
CreateHsmResult	createHsm(CreateHsmRequest createHsmRequest) Creates an uninitialized HSM instance.
CreateLunaClientResult	createLunaClient(CreateLunaClientRequest createLunaClientRequest) Creates an HSM client.
DeleteHapgResult	deleteHapg(DeleteHapgRequest deleteHapgRequest) Deletes a high-availability partition group.
DeleteHsmResult	deleteHsm(DeleteHsmRequest deleteHsmRequest) Deletes an HSM.
DeleteLunaClientResult	deleteLunaClient(DeleteLunaClientRequest deleteLunaClientRequest) Deletes a client.
DescribeHapgResult	describeHapg(DescribeHapgRequest describeHapgRequest) Retrieves information about a high-availability partition group.
DescribeHsmResult	describeHsm() Retrieves information about an HSM.
DescribeHsmResult	describeHsm(DescribeHsmRequest describeHsmRequest) Retrieves information about an HSM.
DescribeLunaClientResult	describeLunaClient() Retrieves information about an HSM client.
DescribeLunaClientResult	describeLunaClient(DescribeLunaClientRequest describeLunaClientRequest) Retrieves information about an HSM client.
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) Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.
ListAvailableZonesResult	listAvailableZones() Lists the Availability Zones that have available AWS CloudHSM capacity.
ListAvailableZonesResult	listAvailableZones(ListAvailableZonesRequest listAvailableZonesRequest) Lists the Availability Zones that have available AWS CloudHSM capacity.
ListHapgsResult	listHapgs() Lists the high-availability partition groups for the account.
ListHapgsResult	listHapgs(ListHapgsRequest listHapgsRequest) Lists the high-availability partition groups for the account.
ListHsmsResult	listHsms() Retrieves the identifiers of all of the HSMs provisioned for the current customer.
ListHsmsResult	listHsms(ListHsmsRequest listHsmsRequest) Retrieves the identifiers of all of the HSMs provisioned for the current customer.
ListLunaClientsResult	listLunaClients() Lists all of the clients.
ListLunaClientsResult	listLunaClients(ListLunaClientsRequest listLunaClientsRequest) Lists all of the clients.
ModifyHapgResult	modifyHapg(ModifyHapgRequest modifyHapgRequest) Modifies an existing high-availability partition group.
ModifyHsmResult	modifyHsm(ModifyHsmRequest modifyHsmRequest) Modifies an HSM.
ModifyLunaClientResult	modifyLunaClient(ModifyLunaClientRequest modifyLunaClientRequest) Modifies the certificate used by the client.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://cloudhsm.us-east-1.amazonaws.com/").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
                 throws IllegalArgumentException

Overrides the default endpoint for this client ("https://cloudhsm.us-east-1.amazonaws.com/"). Callers can use this method to control which AWS region they want to work with.

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: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

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.

Parameters:

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.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
               throws IllegalArgumentException

An alternative to 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.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

getConfig

GetConfigResult getConfig(GetConfigRequest getConfigRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

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

Parameters:

getConfigRequest - Container for the necessary parameters to execute the GetConfig service method on AWSCloudHSM.

Returns:

The response from the GetConfig service method, as returned by AWSCloudHSM.

Throws:

InvalidRequestException

CloudHsmInternalException

CloudHsmServiceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.

createHapg

CreateHapgResult createHapg(CreateHapgRequest createHapgRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

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

Parameters:

createHapgRequest - Container for the necessary parameters to execute the CreateHapg service method on AWSCloudHSM.

Returns:

The response from the CreateHapg service method, as returned by AWSCloudHSM.

Throws:

InvalidRequestException

CloudHsmInternalException

CloudHsmServiceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.

describeHapg

DescribeHapgResult describeHapg(DescribeHapgRequest describeHapgRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

Retrieves information about a high-availability partition group.

Parameters:

describeHapgRequest - Container for the necessary parameters to execute the DescribeHapg service method on AWSCloudHSM.

Returns:

The response from the DescribeHapg service method, as returned by AWSCloudHSM.

Throws:

InvalidRequestException

CloudHsmInternalException

CloudHsmServiceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.

listAvailableZones

ListAvailableZonesResult listAvailableZones(ListAvailableZonesRequest listAvailableZonesRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

Lists the Availability Zones that have available AWS CloudHSM capacity.

Parameters:

listAvailableZonesRequest - Container for the necessary parameters to execute the ListAvailableZones service method on AWSCloudHSM.

Returns:

The response from the ListAvailableZones service method, as returned by AWSCloudHSM.

Throws:

InvalidRequestException

CloudHsmInternalException

CloudHsmServiceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.

modifyHsm

ModifyHsmResult modifyHsm(ModifyHsmRequest modifyHsmRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

Modifies an HSM.

Parameters:

modifyHsmRequest - Container for the necessary parameters to execute the ModifyHsm service method on AWSCloudHSM.

Returns:

The response from the ModifyHsm service method, as returned by AWSCloudHSM.

Throws:

InvalidRequestException

CloudHsmInternalException

CloudHsmServiceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.

listLunaClients

ListLunaClientsResult listLunaClients(ListLunaClientsRequest listLunaClientsRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

Lists all of the clients.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListLunaClients to retrieve the next set of items.

Parameters:

listLunaClientsRequest - Container for the necessary parameters to execute the ListLunaClients service method on AWSCloudHSM.

Returns:

The response from the ListLunaClients service method, as returned by AWSCloudHSM.

Throws:

InvalidRequestException

CloudHsmInternalException

CloudHsmServiceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.

listHapgs

ListHapgsResult listHapgs(ListHapgsRequest listHapgsRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

Lists the high-availability partition groups for the account.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHapgs to retrieve the next set of items.

Parameters:

listHapgsRequest - Container for the necessary parameters to execute the ListHapgs service method on AWSCloudHSM.

Returns:

The response from the ListHapgs service method, as returned by AWSCloudHSM.

Throws:

InvalidRequestException

CloudHsmInternalException

CloudHsmServiceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.

deleteHsm

DeleteHsmResult deleteHsm(DeleteHsmRequest deleteHsmRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

Deletes an HSM. Once complete, this operation cannot be undone and your key material cannot be recovered.

Parameters:

deleteHsmRequest - Container for the necessary parameters to execute the DeleteHsm service method on AWSCloudHSM.

Returns:

The response from the DeleteHsm service method, as returned by AWSCloudHSM.

Throws:

InvalidRequestException

CloudHsmInternalException

CloudHsmServiceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.

createHsm

CreateHsmResult createHsm(CreateHsmRequest createHsmRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

Creates an uninitialized HSM instance. Running this command provisions an HSM appliance and will result in charges to your AWS account for the HSM.

Parameters:

createHsmRequest - Container for the necessary parameters to execute the CreateHsm service method on AWSCloudHSM.

Returns:

The response from the CreateHsm service method, as returned by AWSCloudHSM.

Throws:

InvalidRequestException

CloudHsmInternalException

CloudHsmServiceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.

listHsms

ListHsmsResult listHsms(ListHsmsRequest listHsmsRequest)
                        throws AmazonServiceException,
                               AmazonClientException

Retrieves the identifiers of all of the HSMs provisioned for the current customer.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHsms to retrieve the next set of items.

Parameters:

listHsmsRequest - Container for the necessary parameters to execute the ListHsms service method on AWSCloudHSM.

Returns:

The response from the ListHsms service method, as returned by AWSCloudHSM.

Throws:

InvalidRequestException

CloudHsmInternalException

CloudHsmServiceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.

describeHsm

DescribeHsmResult describeHsm(DescribeHsmRequest describeHsmRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

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

Parameters:

describeHsmRequest - Container for the necessary parameters to execute the DescribeHsm service method on AWSCloudHSM.

Returns:

The response from the DescribeHsm service method, as returned by AWSCloudHSM.

Throws:

InvalidRequestException

CloudHsmInternalException

CloudHsmServiceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.

deleteHapg

DeleteHapgResult deleteHapg(DeleteHapgRequest deleteHapgRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Deletes a high-availability partition group.

Parameters:

deleteHapgRequest - Container for the necessary parameters to execute the DeleteHapg service method on AWSCloudHSM.

Returns:

The response from the DeleteHapg service method, as returned by AWSCloudHSM.

Throws:

InvalidRequestException

CloudHsmInternalException

CloudHsmServiceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.

modifyHapg

ModifyHapgResult modifyHapg(ModifyHapgRequest modifyHapgRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Modifies an existing high-availability partition group.

Parameters:

modifyHapgRequest - Container for the necessary parameters to execute the ModifyHapg service method on AWSCloudHSM.

Returns:

The response from the ModifyHapg service method, as returned by AWSCloudHSM.

Throws:

InvalidRequestException

CloudHsmInternalException

CloudHsmServiceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.

createLunaClient

CreateLunaClientResult createLunaClient(CreateLunaClientRequest createLunaClientRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Creates an HSM client.

Parameters:

createLunaClientRequest - Container for the necessary parameters to execute the CreateLunaClient service method on AWSCloudHSM.

Returns:

The response from the CreateLunaClient service method, as returned by AWSCloudHSM.

Throws:

InvalidRequestException

CloudHsmInternalException

CloudHsmServiceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.

deleteLunaClient

DeleteLunaClientResult deleteLunaClient(DeleteLunaClientRequest deleteLunaClientRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Deletes a client.

Parameters:

deleteLunaClientRequest - Container for the necessary parameters to execute the DeleteLunaClient service method on AWSCloudHSM.

Returns:

The response from the DeleteLunaClient service method, as returned by AWSCloudHSM.

Throws:

InvalidRequestException

CloudHsmInternalException

CloudHsmServiceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.

modifyLunaClient

ModifyLunaClientResult modifyLunaClient(ModifyLunaClientRequest modifyLunaClientRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Modifies the certificate used by the client.

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

Parameters:

modifyLunaClientRequest - Container for the necessary parameters to execute the ModifyLunaClient service method on AWSCloudHSM.

Returns:

The response from the ModifyLunaClient service method, as returned by AWSCloudHSM.

Throws:

CloudHsmServiceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.

describeLunaClient

DescribeLunaClientResult describeLunaClient(DescribeLunaClientRequest describeLunaClientRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

Retrieves information about an HSM client.

Parameters:

describeLunaClientRequest - Container for the necessary parameters to execute the DescribeLunaClient service method on AWSCloudHSM.

Returns:

The response from the DescribeLunaClient service method, as returned by AWSCloudHSM.

Throws:

InvalidRequestException

CloudHsmInternalException

CloudHsmServiceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.

listAvailableZones

ListAvailableZonesResult listAvailableZones()
                                            throws AmazonServiceException,
                                                   AmazonClientException

Lists the Availability Zones that have available AWS CloudHSM capacity.

Returns:

The response from the ListAvailableZones service method, as returned by AWSCloudHSM.

Throws:

InvalidRequestException

CloudHsmInternalException

CloudHsmServiceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.

listLunaClients

ListLunaClientsResult listLunaClients()
                                      throws AmazonServiceException,
                                             AmazonClientException

Lists all of the clients.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListLunaClients to retrieve the next set of items.

Returns:

The response from the ListLunaClients service method, as returned by AWSCloudHSM.

Throws:

InvalidRequestException

CloudHsmInternalException

CloudHsmServiceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.

listHapgs

ListHapgsResult listHapgs()
                          throws AmazonServiceException,
                                 AmazonClientException

Lists the high-availability partition groups for the account.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHapgs to retrieve the next set of items.

Returns:

The response from the ListHapgs service method, as returned by AWSCloudHSM.

Throws:

InvalidRequestException

CloudHsmInternalException

CloudHsmServiceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.

listHsms

ListHsmsResult listHsms()
                        throws AmazonServiceException,
                               AmazonClientException

Retrieves the identifiers of all of the HSMs provisioned for the current customer.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHsms to retrieve the next set of items.

Returns:

The response from the ListHsms service method, as returned by AWSCloudHSM.

Throws:

InvalidRequestException

CloudHsmInternalException

CloudHsmServiceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.

describeHsm

DescribeHsmResult describeHsm()
                              throws AmazonServiceException,
                                     AmazonClientException

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

Returns:

The response from the DescribeHsm service method, as returned by AWSCloudHSM.

Throws:

InvalidRequestException

CloudHsmInternalException

CloudHsmServiceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.

describeLunaClient

DescribeLunaClientResult describeLunaClient()
                                            throws AmazonServiceException,
                                                   AmazonClientException

Retrieves information about an HSM client.

Returns:

The response from the DescribeLunaClient service method, as returned by AWSCloudHSM.

Throws:

InvalidRequestException

CloudHsmInternalException

CloudHsmServiceException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AWSCloudHSM indicating either a problem with the data in the request, or a server side issue.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.