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 CloudHSM. 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.JsonErrorUnmarshallerV2>	jsonErrorUnmarshallers List of exception unmarshallers for all CloudHSM 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 CloudHSM.
AWSCloudHSMClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on CloudHSM using the specified AWS account credentials.
AWSCloudHSMClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on CloudHSM using the specified AWS account credentials and client configuration options.
AWSCloudHSMClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on CloudHSM using the specified AWS account credentials provider.
AWSCloudHSMClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on CloudHSM 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 CloudHSM 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 CloudHSM.

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() Simplified method form for invoking the DescribeHsm operation.
DescribeHsmResult	describeHsm(DescribeHsmRequest describeHsmRequest) Retrieves information about an HSM.
DescribeLunaClientResult	describeLunaClient() Simplified method form for invoking the DescribeLunaClient operation.
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() Simplified method form for invoking the ListAvailableZones operation.
ListAvailableZonesResult	listAvailableZones(ListAvailableZonesRequest listAvailableZonesRequest) Lists the Availability Zones that have available AWS CloudHSM capacity.
ListHapgsResult	listHapgs() Simplified method form for invoking the ListHapgs operation.
ListHapgsResult	listHapgs(ListHapgsRequest listHapgsRequest) Lists the high-availability partition groups for the account.
ListHsmsResult	listHsms() Simplified method form for invoking the ListHsms operation.
ListHsmsResult	listHsms(ListHsmsRequest listHsmsRequest) Retrieves the identifiers of all of the HSMs provisioned for the current customer.
ListLunaClientsResult	listLunaClients() Simplified method form for invoking the ListLunaClients operation.
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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, 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

setEndpoint, setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

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

List of exception unmarshallers for all CloudHSM exceptions.

Constructor Detail

AWSCloudHSMClient

public AWSCloudHSMClient()

Constructs a new client to invoke service methods on CloudHSM. 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 CloudHSM. 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 CloudHSM (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSCloudHSMClient

public AWSCloudHSMClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on CloudHSM 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 CloudHSM 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 CloudHSM (ex: proxy settings, retry counts, etc.).

AWSCloudHSMClient

public AWSCloudHSMClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on CloudHSM 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 CloudHSM 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 CloudHSM (ex: proxy settings, retry counts, etc.).

AWSCloudHSMClient

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

Constructs a new client to invoke service methods on CloudHSM 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 CloudHSM (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

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 - Contains the inputs for the CreateHapgRequest action.

Returns:

Result of the CreateHapg operation returned by the service.

Throws:

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.

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 - Contains the inputs for the CreateHsm action.

Returns:

Result of the CreateHsm operation returned by the service.

Throws:

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.

createLunaClient

public CreateLunaClientResult createLunaClient(CreateLunaClientRequest createLunaClientRequest)

Creates an HSM client.

Specified by:

createLunaClient in interface AWSCloudHSM

Parameters:

createLunaClientRequest - Contains the inputs for the CreateLunaClient action.

Returns:

Result of the CreateLunaClient operation returned by the service.

Throws:

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.

deleteHapg

public DeleteHapgResult deleteHapg(DeleteHapgRequest deleteHapgRequest)

Deletes a high-availability partition group.

Specified by:

deleteHapg in interface AWSCloudHSM

Parameters:

deleteHapgRequest - Contains the inputs for the DeleteHapg action.

Returns:

Result of the DeleteHapg operation returned by the service.

Throws:

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.

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 - Contains the inputs for the DeleteHsm action.

Returns:

Result of the DeleteHsm operation returned by the service.

Throws:

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.

deleteLunaClient

public DeleteLunaClientResult deleteLunaClient(DeleteLunaClientRequest deleteLunaClientRequest)

Deletes a client.

Specified by:

deleteLunaClient in interface AWSCloudHSM

Parameters:

deleteLunaClientRequest -

Returns:

Result of the DeleteLunaClient operation returned by the service.

Throws:

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.

describeHapg

public DescribeHapgResult describeHapg(DescribeHapgRequest describeHapgRequest)

Retrieves information about a high-availability partition group.

Specified by:

describeHapg in interface AWSCloudHSM

Parameters:

describeHapgRequest - Contains the inputs for the DescribeHapg action.

Returns:

Result of the DescribeHapg operation returned by the service.

Throws:

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.

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 - Contains the inputs for the DescribeHsm action.

Returns:

Result of the DescribeHsm operation returned by the service.

Throws:

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.

describeHsm

public DescribeHsmResult describeHsm()

Description copied from interface: AWSCloudHSM

Simplified method form for invoking the DescribeHsm operation.

Specified by:

describeHsm in interface AWSCloudHSM

See Also:

AWSCloudHSM.describeHsm(DescribeHsmRequest)

describeLunaClient

public DescribeLunaClientResult describeLunaClient(DescribeLunaClientRequest describeLunaClientRequest)

Retrieves information about an HSM client.

Specified by:

describeLunaClient in interface AWSCloudHSM

Parameters:

describeLunaClientRequest -

Returns:

Result of the DescribeLunaClient operation returned by the service.

Throws:

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.

describeLunaClient

public DescribeLunaClientResult describeLunaClient()

Description copied from interface: AWSCloudHSM

Simplified method form for invoking the DescribeLunaClient operation.

Specified by:

describeLunaClient in interface AWSCloudHSM

See Also:

AWSCloudHSM.describeLunaClient(DescribeLunaClientRequest)

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 -

Returns:

Result of the GetConfig operation returned by the service.

Throws:

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.

listAvailableZones

public ListAvailableZonesResult listAvailableZones(ListAvailableZonesRequest listAvailableZonesRequest)

Lists the Availability Zones that have available AWS CloudHSM capacity.

Specified by:

listAvailableZones in interface AWSCloudHSM

Parameters:

listAvailableZonesRequest - Contains the inputs for the ListAvailableZones action.

Returns:

Result of the ListAvailableZones operation returned by the service.

Throws:

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.

listAvailableZones

public ListAvailableZonesResult listAvailableZones()

Description copied from interface: AWSCloudHSM

Simplified method form for invoking the ListAvailableZones operation.

Specified by:

listAvailableZones in interface AWSCloudHSM

See Also:

AWSCloudHSM.listAvailableZones(ListAvailableZonesRequest)

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 -

Returns:

Result of the ListHapgs operation returned by the service.

Throws:

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.

listHapgs

public ListHapgsResult listHapgs()

Description copied from interface: AWSCloudHSM

Simplified method form for invoking the ListHapgs operation.

Specified by:

listHapgs in interface AWSCloudHSM

See Also:

AWSCloudHSM.listHapgs(ListHapgsRequest)

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 -

Returns:

Result of the ListHsms operation returned by the service.

Throws:

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.

listHsms

public ListHsmsResult listHsms()

Description copied from interface: AWSCloudHSM

Simplified method form for invoking the ListHsms operation.

Specified by:

listHsms in interface AWSCloudHSM

See Also:

AWSCloudHSM.listHsms(ListHsmsRequest)

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 -

Returns:

Result of the ListLunaClients operation returned by the service.

Throws:

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.

listLunaClients

public ListLunaClientsResult listLunaClients()

Description copied from interface: AWSCloudHSM

Simplified method form for invoking the ListLunaClients operation.

Specified by:

listLunaClients in interface AWSCloudHSM

See Also:

AWSCloudHSM.listLunaClients(ListLunaClientsRequest)

modifyHapg

public ModifyHapgResult modifyHapg(ModifyHapgRequest modifyHapgRequest)

Modifies an existing high-availability partition group.

Specified by:

modifyHapg in interface AWSCloudHSM

Parameters:

modifyHapgRequest -

Returns:

Result of the ModifyHapg operation returned by the service.

Throws:

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.

modifyHsm

public ModifyHsmResult modifyHsm(ModifyHsmRequest modifyHsmRequest)

Modifies an HSM.

Specified by:

modifyHsm in interface AWSCloudHSM

Parameters:

modifyHsmRequest - Contains the inputs for the ModifyHsm action.

Returns:

Result of the ModifyHsm operation returned by the service.

Throws:

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.

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 -

Returns:

Result of the ModifyLunaClient operation returned by the service.

Throws:

CloudHsmServiceException - Indicates that an exception occurred in the AWS CloudHSM service.

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.