com.amazonaws.services.cloudhsm

Class AWSCloudHSMClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.cloudhsm.AWSCloudHSMClient

All Implemented Interfaces:

AWSCloudHSM

Direct Known Subclasses:

AWSCloudHSMAsyncClient

public class AWSCloudHSMClient
extends AmazonWebServiceClient
implements AWSCloudHSM

Client for accessing AWSCloudHSM. All service calls made using this client are blocking, and will not return until the service call completes.

AWS CloudHSM Service

Field Summary

Fields

Modifier and Type	Field and Description
protected List<com.amazonaws.transform.JsonErrorUnmarshaller>	jsonErrorUnmarshallers List of exception unmarshallers for all AWSCloudHSM exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AWSCloudHSMClient() Constructs a new client to invoke service methods on AWSCloudHSM.
AWSCloudHSMClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AWSCloudHSM using the specified AWS account credentials.
AWSCloudHSMClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSCloudHSM using the specified AWS account credentials and client configuration options.
AWSCloudHSMClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AWSCloudHSM using the specified AWS account credentials provider.
AWSCloudHSMClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSCloudHSM using the specified AWS account credentials provider and client configuration options.
AWSCloudHSMClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on AWSCloudHSM using the specified AWS account credentials provider, client configuration options and request metric collector.
AWSCloudHSMClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSCloudHSM.

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.
void	setEndpoint(String endpoint, String serviceName, String regionId) An internal method that is not expected to be normally called except for AWS internal development purposes.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setRegion, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.cloudhsm.AWSCloudHSM

setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

protected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers

List of exception unmarshallers for all AWSCloudHSM exceptions.

Constructor Detail

AWSCloudHSMClient

public AWSCloudHSMClient()

Constructs a new client to invoke service methods on AWSCloudHSM. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AWSCloudHSMClient

public AWSCloudHSMClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSCloudHSM. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AWSCloudHSM (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSCloudHSMClient

public AWSCloudHSMClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AWSCloudHSM using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AWSCloudHSMClient

public AWSCloudHSMClient(AWSCredentials awsCredentials,
                 ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSCloudHSM using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWSCloudHSM (ex: proxy settings, retry counts, etc.).

AWSCloudHSMClient

public AWSCloudHSMClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AWSCloudHSM using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AWSCloudHSMClient

public AWSCloudHSMClient(AWSCredentialsProvider awsCredentialsProvider,
                 ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSCloudHSM using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWSCloudHSM (ex: proxy settings, retry counts, etc.).

AWSCloudHSMClient

public AWSCloudHSMClient(AWSCredentialsProvider awsCredentialsProvider,
                 ClientConfiguration clientConfiguration,
                 RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on AWSCloudHSM using the specified AWS account credentials provider, client configuration options and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWSCloudHSM (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

getConfig

public GetConfigResult getConfig(GetConfigRequest getConfigRequest)

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

Specified by:

getConfig in interface AWSCloudHSM

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

public CreateHapgResult createHapg(CreateHapgRequest createHapgRequest)

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

Specified by:

createHapg in interface AWSCloudHSM

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

public DescribeHapgResult describeHapg(DescribeHapgRequest describeHapgRequest)

Retrieves information about a high-availability partition group.

Specified by:

describeHapg in interface AWSCloudHSM

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

public ListAvailableZonesResult listAvailableZones(ListAvailableZonesRequest listAvailableZonesRequest)

Lists the Availability Zones that have available AWS CloudHSM capacity.

Specified by:

listAvailableZones in interface AWSCloudHSM

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

public ModifyHsmResult modifyHsm(ModifyHsmRequest modifyHsmRequest)

Modifies an HSM.

Specified by:

modifyHsm in interface AWSCloudHSM

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

public ListLunaClientsResult listLunaClients(ListLunaClientsRequest listLunaClientsRequest)

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.

Specified by:

listLunaClients in interface AWSCloudHSM

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

public ListHapgsResult listHapgs(ListHapgsRequest listHapgsRequest)

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.

Specified by:

listHapgs in interface AWSCloudHSM

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

public DeleteHsmResult deleteHsm(DeleteHsmRequest deleteHsmRequest)

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

Specified by:

deleteHsm in interface AWSCloudHSM

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

public CreateHsmResult createHsm(CreateHsmRequest createHsmRequest)

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

Specified by:

createHsm in interface AWSCloudHSM

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

public ListHsmsResult listHsms(ListHsmsRequest listHsmsRequest)

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.

Specified by:

listHsms in interface AWSCloudHSM

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

public DescribeHsmResult describeHsm(DescribeHsmRequest describeHsmRequest)

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

Specified by:

describeHsm in interface AWSCloudHSM

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

public DeleteHapgResult deleteHapg(DeleteHapgRequest deleteHapgRequest)

Deletes a high-availability partition group.

Specified by:

deleteHapg in interface AWSCloudHSM

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

public ModifyHapgResult modifyHapg(ModifyHapgRequest modifyHapgRequest)

Modifies an existing high-availability partition group.

Specified by:

modifyHapg in interface AWSCloudHSM

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

public CreateLunaClientResult createLunaClient(CreateLunaClientRequest createLunaClientRequest)

Creates an HSM client.

Specified by:

createLunaClient in interface AWSCloudHSM

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

public DeleteLunaClientResult deleteLunaClient(DeleteLunaClientRequest deleteLunaClientRequest)

Deletes a client.

Specified by:

deleteLunaClient in interface AWSCloudHSM

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

public ModifyLunaClientResult modifyLunaClient(ModifyLunaClientRequest modifyLunaClientRequest)

Modifies the certificate used by the client.

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

Specified by:

modifyLunaClient in interface AWSCloudHSM

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

public DescribeLunaClientResult describeLunaClient(DescribeLunaClientRequest describeLunaClientRequest)

Retrieves information about an HSM client.

Specified by:

describeLunaClient in interface AWSCloudHSM

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

public ListAvailableZonesResult listAvailableZones()
                                            throws AmazonServiceException,
                                                   AmazonClientException

Lists the Availability Zones that have available AWS CloudHSM capacity.

Specified by:

listAvailableZones in interface 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.

listLunaClients

public 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.

Specified by:

listLunaClients in interface 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

public 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.

Specified by:

listHapgs in interface 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.

listHsms

public 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.

Specified by:

listHsms in interface 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

public DescribeHsmResult describeHsm()
                              throws AmazonServiceException,
                                     AmazonClientException

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

Specified by:

describeHsm in interface 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.

describeLunaClient

public DescribeLunaClientResult describeLunaClient()
                                            throws AmazonServiceException,
                                                   AmazonClientException

Retrieves information about an HSM client.

Specified by:

describeLunaClient in interface 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.

setEndpoint

public void setEndpoint(String endpoint)

Description copied from class: AmazonWebServiceClient

Overrides the default endpoint for this client. Callers can use this method to control which AWS region they want to work with.

This method is not threadsafe. Endpoints 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.

Callers can pass in just the endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.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

Specified by:

setEndpoint in interface AWSCloudHSM

Overrides:

setEndpoint in class AmazonWebServiceClient

Parameters:

endpoint - The endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setEndpoint

public void setEndpoint(String endpoint,
               String serviceName,
               String regionId)
                 throws IllegalArgumentException

Description copied from class: AmazonWebServiceClient

An internal method that is not expected to be normally called except for AWS internal development purposes.

Overrides the default endpoint for this client ("http://dynamodb.us-east-1.amazonaws.com/") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests. In almost all cases, this region ID and service name are automatically determined from the endpoint, and callers should use the simpler one-argument form of setEndpoint instead of this method.

Callers can pass in just the endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "http://dynamodb.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

Overrides:

setEndpoint in class AmazonWebServiceClient

Parameters:

endpoint - The endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "http://dynamodb.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.

serviceName - This parameter is ignored.

regionId - The ID of the region in which this service resides AND the overriding region for signing purposes.

Throws:

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSCloudHSM

Parameters:

request - The originally executed request

Returns:

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