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

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
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

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.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

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

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AWSCloudHSMClient() Deprecated. use AWSCloudHSMClientBuilder.defaultClient()
AWSCloudHSMClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSCloudHSMClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AWSCloudHSMClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSCloudHSMClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AWSCloudHSMClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSCloudHSMClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AWSCloudHSMClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
AddTagsToResourceResult	addTagsToResource(AddTagsToResourceRequest request) This is documentation for AWS CloudHSM Classic.
static AWSCloudHSMClientBuilder	builder()
CreateHapgResult	createHapg(CreateHapgRequest request) This is documentation for AWS CloudHSM Classic.
CreateHsmResult	createHsm(CreateHsmRequest request) This is documentation for AWS CloudHSM Classic.
CreateLunaClientResult	createLunaClient(CreateLunaClientRequest request) This is documentation for AWS CloudHSM Classic.
DeleteHapgResult	deleteHapg(DeleteHapgRequest request) This is documentation for AWS CloudHSM Classic.
DeleteHsmResult	deleteHsm(DeleteHsmRequest request) This is documentation for AWS CloudHSM Classic.
DeleteLunaClientResult	deleteLunaClient(DeleteLunaClientRequest request) This is documentation for AWS CloudHSM Classic.
DescribeHapgResult	describeHapg(DescribeHapgRequest request) This is documentation for AWS CloudHSM Classic.
DescribeHsmResult	describeHsm() Simplified method form for invoking the DescribeHsm operation.
DescribeHsmResult	describeHsm(DescribeHsmRequest request) This is documentation for AWS CloudHSM Classic.
DescribeLunaClientResult	describeLunaClient() Simplified method form for invoking the DescribeLunaClient operation.
DescribeLunaClientResult	describeLunaClient(DescribeLunaClientRequest request) This is documentation for AWS CloudHSM Classic.
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 request) This is documentation for AWS CloudHSM Classic.
ListAvailableZonesResult	listAvailableZones() Simplified method form for invoking the ListAvailableZones operation.
ListAvailableZonesResult	listAvailableZones(ListAvailableZonesRequest request) This is documentation for AWS CloudHSM Classic.
ListHapgsResult	listHapgs() Simplified method form for invoking the ListHapgs operation.
ListHapgsResult	listHapgs(ListHapgsRequest request) This is documentation for AWS CloudHSM Classic.
ListHsmsResult	listHsms() Simplified method form for invoking the ListHsms operation.
ListHsmsResult	listHsms(ListHsmsRequest request) This is documentation for AWS CloudHSM Classic.
ListLunaClientsResult	listLunaClients() Simplified method form for invoking the ListLunaClients operation.
ListLunaClientsResult	listLunaClients(ListLunaClientsRequest request) This is documentation for AWS CloudHSM Classic.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) This is documentation for AWS CloudHSM Classic.
ModifyHapgResult	modifyHapg(ModifyHapgRequest request) This is documentation for AWS CloudHSM Classic.
ModifyHsmResult	modifyHsm(ModifyHsmRequest request) This is documentation for AWS CloudHSM Classic.
ModifyLunaClientResult	modifyLunaClient(ModifyLunaClientRequest request) This is documentation for AWS CloudHSM Classic.
RemoveTagsFromResourceResult	removeTagsFromResource(RemoveTagsFromResourceRequest request) This is documentation for AWS CloudHSM Classic.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

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

setEndpoint, setRegion, shutdown

Constructor Detail

AWSCloudHSMClient

@Deprecated
public AWSCloudHSMClient()

Deprecated. use AWSCloudHSMClientBuilder.defaultClient()

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

@Deprecated
public AWSCloudHSMClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(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

@Deprecated
public AWSCloudHSMClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSCloudHSMClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

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

@Deprecated
public AWSCloudHSMClient(AWSCredentials awsCredentials,
                                     ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(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

@Deprecated
public AWSCloudHSMClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(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

@Deprecated
public AWSCloudHSMClient(AWSCredentialsProvider awsCredentialsProvider,
                                     ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(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

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

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(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

builder

public static AWSCloudHSMClientBuilder builder()

addTagsToResource

public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest request)

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.

Specified by:

addTagsToResource in interface AWSCloudHSM

Parameters:

addTagsToResourceRequest -

Returns:

Result of the AddTagsToResource 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.

See Also:

AWS API Documentation

createHapg

public CreateHapgResult createHapg(CreateHapgRequest request)

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.

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.

See Also:

AWS API Documentation

createHsm

public CreateHsmResult createHsm(CreateHsmRequest request)

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.

Specified by:

createHsm in interface AWSCloudHSM

Parameters:

createHsmRequest - Contains the inputs for the CreateHsm operation.

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.

See Also:

AWS API Documentation

createLunaClient

public CreateLunaClientResult createLunaClient(CreateLunaClientRequest request)

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.

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.

See Also:

AWS API Documentation

deleteHapg

public DeleteHapgResult deleteHapg(DeleteHapgRequest request)

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.

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.

See Also:

AWS API Documentation

deleteHsm

public DeleteHsmResult deleteHsm(DeleteHsmRequest request)

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.

Specified by:

deleteHsm in interface AWSCloudHSM

Parameters:

deleteHsmRequest - Contains the inputs for the DeleteHsm operation.

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.

See Also:

AWS API Documentation

deleteLunaClient

public DeleteLunaClientResult deleteLunaClient(DeleteLunaClientRequest request)

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.

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.

See Also:

AWS API Documentation

describeHapg

public DescribeHapgResult describeHapg(DescribeHapgRequest request)

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.

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.

See Also:

AWS API Documentation

describeHsm

public DescribeHsmResult describeHsm(DescribeHsmRequest request)

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.

Specified by:

describeHsm in interface AWSCloudHSM

Parameters:

describeHsmRequest - Contains the inputs for the DescribeHsm operation.

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.

See Also:

AWS API Documentation

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 request)

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.

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.

See Also:

AWS API Documentation

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 request)

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.

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.

See Also:

AWS API Documentation

listAvailableZones

public ListAvailableZonesResult listAvailableZones(ListAvailableZonesRequest request)

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.

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.

See Also:

AWS API Documentation

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 request)

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.

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.

See Also:

AWS API Documentation

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 request)

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.

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.

See Also:

AWS API Documentation

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 request)

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.

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.

See Also:

AWS API Documentation

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)

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

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.

Specified by:

listTagsForResource in interface AWSCloudHSM

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource 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.

See Also:

AWS API Documentation

modifyHapg

public ModifyHapgResult modifyHapg(ModifyHapgRequest request)

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.

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.

See Also:

AWS API Documentation

modifyHsm

public ModifyHsmResult modifyHsm(ModifyHsmRequest request)

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.

Specified by:

modifyHsm in interface AWSCloudHSM

Parameters:

modifyHsmRequest - Contains the inputs for the ModifyHsm operation.

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.

See Also:

AWS API Documentation

modifyLunaClient

public ModifyLunaClientResult modifyLunaClient(ModifyLunaClientRequest request)

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.

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.

See Also:

AWS API Documentation

removeTagsFromResource

public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest request)

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.

Specified by:

removeTagsFromResource in interface AWSCloudHSM

Parameters:

removeTagsFromResourceRequest -

Returns:

Result of the RemoveTagsFromResource 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.

See Also:

AWS API Documentation

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.