@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSCloudHSMClient extends AmazonWebServiceClient implements AWSCloudHSM
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Constructor and Description |
---|
AWSCloudHSMClient()
Deprecated.
|
AWSCloudHSMClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSCloudHSMClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSCloudHSMClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSCloudHSMClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSCloudHSMClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSCloudHSMClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSCloudHSMClient(ClientConfiguration clientConfiguration)
Deprecated.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion
@Deprecated public AWSCloudHSMClient()
AWSCloudHSMClientBuilder.defaultClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated public AWSCloudHSMClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client connects to CloudHSM (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain
@Deprecated public AWSCloudHSMClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
for example:
AWSCloudHSMClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AWSCloudHSMClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).@Deprecated public AWSCloudHSMClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AWSCloudHSMClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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.).@Deprecated public AWSCloudHSMClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
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 collectorpublic static AWSCloudHSMClientBuilder builder()
@Deprecated 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.
addTagsToResource
in interface AWSCloudHSM
addTagsToResourceRequest
- CloudHsmServiceException
- Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException
- Indicates that an internal error occurred.InvalidRequestException
- Indicates that one or more of the request parameters are not valid.@Deprecated 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.
createHapg
in interface AWSCloudHSM
createHapgRequest
- Contains the inputs for the CreateHapgRequest action.CloudHsmServiceException
- Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException
- Indicates that an internal error occurred.InvalidRequestException
- Indicates that one or more of the request parameters are not valid.@Deprecated 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
.
createHsm
in interface AWSCloudHSM
createHsmRequest
- Contains the inputs for the CreateHsm
operation.CloudHsmServiceException
- Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException
- Indicates that an internal error occurred.InvalidRequestException
- Indicates that one or more of the request parameters are not valid.@Deprecated 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.
createLunaClient
in interface AWSCloudHSM
createLunaClientRequest
- Contains the inputs for the CreateLunaClient action.CloudHsmServiceException
- Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException
- Indicates that an internal error occurred.InvalidRequestException
- Indicates that one or more of the request parameters are not valid.@Deprecated 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.
deleteHapg
in interface AWSCloudHSM
deleteHapgRequest
- Contains the inputs for the DeleteHapg action.CloudHsmServiceException
- Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException
- Indicates that an internal error occurred.InvalidRequestException
- Indicates that one or more of the request parameters are not valid.@Deprecated 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.
deleteHsm
in interface AWSCloudHSM
deleteHsmRequest
- Contains the inputs for the DeleteHsm operation.CloudHsmServiceException
- Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException
- Indicates that an internal error occurred.InvalidRequestException
- Indicates that one or more of the request parameters are not valid.@Deprecated 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.
deleteLunaClient
in interface AWSCloudHSM
deleteLunaClientRequest
- CloudHsmServiceException
- Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException
- Indicates that an internal error occurred.InvalidRequestException
- Indicates that one or more of the request parameters are not valid.@Deprecated 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.
describeHapg
in interface AWSCloudHSM
describeHapgRequest
- Contains the inputs for the DescribeHapg action.CloudHsmServiceException
- Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException
- Indicates that an internal error occurred.InvalidRequestException
- Indicates that one or more of the request parameters are not valid.@Deprecated 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.
describeHsm
in interface AWSCloudHSM
describeHsmRequest
- Contains the inputs for the DescribeHsm operation.CloudHsmServiceException
- Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException
- Indicates that an internal error occurred.InvalidRequestException
- Indicates that one or more of the request parameters are not valid.@Deprecated public DescribeHsmResult describeHsm()
AWSCloudHSM
describeHsm
in interface AWSCloudHSM
AWSCloudHSM.describeHsm(DescribeHsmRequest)
@Deprecated 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.
describeLunaClient
in interface AWSCloudHSM
describeLunaClientRequest
- CloudHsmServiceException
- Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException
- Indicates that an internal error occurred.InvalidRequestException
- Indicates that one or more of the request parameters are not valid.@Deprecated public DescribeLunaClientResult describeLunaClient()
AWSCloudHSM
describeLunaClient
in interface AWSCloudHSM
AWSCloudHSM.describeLunaClient(DescribeLunaClientRequest)
@Deprecated 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.
getConfig
in interface AWSCloudHSM
getConfigRequest
- CloudHsmServiceException
- Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException
- Indicates that an internal error occurred.InvalidRequestException
- Indicates that one or more of the request parameters are not valid.@Deprecated 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.
listAvailableZones
in interface AWSCloudHSM
listAvailableZonesRequest
- Contains the inputs for the ListAvailableZones action.CloudHsmServiceException
- Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException
- Indicates that an internal error occurred.InvalidRequestException
- Indicates that one or more of the request parameters are not valid.@Deprecated public ListAvailableZonesResult listAvailableZones()
AWSCloudHSM
listAvailableZones
in interface AWSCloudHSM
AWSCloudHSM.listAvailableZones(ListAvailableZonesRequest)
@Deprecated 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.
listHapgs
in interface AWSCloudHSM
listHapgsRequest
- CloudHsmServiceException
- Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException
- Indicates that an internal error occurred.InvalidRequestException
- Indicates that one or more of the request parameters are not valid.@Deprecated public ListHapgsResult listHapgs()
AWSCloudHSM
listHapgs
in interface AWSCloudHSM
AWSCloudHSM.listHapgs(ListHapgsRequest)
@Deprecated 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.
listHsms
in interface AWSCloudHSM
listHsmsRequest
- CloudHsmServiceException
- Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException
- Indicates that an internal error occurred.InvalidRequestException
- Indicates that one or more of the request parameters are not valid.@Deprecated public ListHsmsResult listHsms()
AWSCloudHSM
listHsms
in interface AWSCloudHSM
AWSCloudHSM.listHsms(ListHsmsRequest)
@Deprecated 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.
listLunaClients
in interface AWSCloudHSM
listLunaClientsRequest
- CloudHsmServiceException
- Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException
- Indicates that an internal error occurred.InvalidRequestException
- Indicates that one or more of the request parameters are not valid.@Deprecated public ListLunaClientsResult listLunaClients()
AWSCloudHSM
listLunaClients
in interface AWSCloudHSM
AWSCloudHSM.listLunaClients(ListLunaClientsRequest)
@Deprecated 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.
listTagsForResource
in interface AWSCloudHSM
listTagsForResourceRequest
- CloudHsmServiceException
- Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException
- Indicates that an internal error occurred.InvalidRequestException
- Indicates that one or more of the request parameters are not valid.@Deprecated 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.
modifyHapg
in interface AWSCloudHSM
modifyHapgRequest
- CloudHsmServiceException
- Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException
- Indicates that an internal error occurred.InvalidRequestException
- Indicates that one or more of the request parameters are not valid.@Deprecated 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.
modifyHsm
in interface AWSCloudHSM
modifyHsmRequest
- Contains the inputs for the ModifyHsm operation.CloudHsmServiceException
- Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException
- Indicates that an internal error occurred.InvalidRequestException
- Indicates that one or more of the request parameters are not valid.@Deprecated 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.
modifyLunaClient
in interface AWSCloudHSM
modifyLunaClientRequest
- CloudHsmServiceException
- Indicates that an exception occurred in the AWS CloudHSM service.@Deprecated 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.
removeTagsFromResource
in interface AWSCloudHSM
removeTagsFromResourceRequest
- CloudHsmServiceException
- Indicates that an exception occurred in the AWS CloudHSM service.CloudHsmInternalException
- Indicates that an internal error occurred.InvalidRequestException
- Indicates that one or more of the request parameters are not valid.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AWSCloudHSM
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSCloudHSM
shutdown
in class AmazonWebServiceClient