Interface CloudHsmV2AsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
For more information about AWS CloudHSM, see AWS CloudHSM and the AWS CloudHSM User Guide.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic CloudHsmV2AsyncClientBuilder
builder()
Create a builder that can be used to configure and create aCloudHsmV2AsyncClient
.copyBackupToRegion
(Consumer<CopyBackupToRegionRequest.Builder> copyBackupToRegionRequest) Copy an AWS CloudHSM cluster backup to a different region.copyBackupToRegion
(CopyBackupToRegionRequest copyBackupToRegionRequest) Copy an AWS CloudHSM cluster backup to a different region.static CloudHsmV2AsyncClient
create()
Create aCloudHsmV2AsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CompletableFuture
<CreateClusterResponse> createCluster
(Consumer<CreateClusterRequest.Builder> createClusterRequest) Creates a new AWS CloudHSM cluster.default CompletableFuture
<CreateClusterResponse> createCluster
(CreateClusterRequest createClusterRequest) Creates a new AWS CloudHSM cluster.default CompletableFuture
<CreateHsmResponse> createHsm
(Consumer<CreateHsmRequest.Builder> createHsmRequest) Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.default CompletableFuture
<CreateHsmResponse> createHsm
(CreateHsmRequest createHsmRequest) Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.default CompletableFuture
<DeleteBackupResponse> deleteBackup
(Consumer<DeleteBackupRequest.Builder> deleteBackupRequest) Deletes a specified AWS CloudHSM backup.default CompletableFuture
<DeleteBackupResponse> deleteBackup
(DeleteBackupRequest deleteBackupRequest) Deletes a specified AWS CloudHSM backup.default CompletableFuture
<DeleteClusterResponse> deleteCluster
(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest) Deletes the specified AWS CloudHSM cluster.default CompletableFuture
<DeleteClusterResponse> deleteCluster
(DeleteClusterRequest deleteClusterRequest) Deletes the specified AWS CloudHSM cluster.default CompletableFuture
<DeleteHsmResponse> deleteHsm
(Consumer<DeleteHsmRequest.Builder> deleteHsmRequest) Deletes the specified HSM.default CompletableFuture
<DeleteHsmResponse> deleteHsm
(DeleteHsmRequest deleteHsmRequest) Deletes the specified HSM.default CompletableFuture
<DescribeBackupsResponse> Gets information about backups of AWS CloudHSM clusters.default CompletableFuture
<DescribeBackupsResponse> describeBackups
(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest) Gets information about backups of AWS CloudHSM clusters.default CompletableFuture
<DescribeBackupsResponse> describeBackups
(DescribeBackupsRequest describeBackupsRequest) Gets information about backups of AWS CloudHSM clusters.default DescribeBackupsPublisher
This is a variant ofdescribeBackups(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsRequest)
operation.default DescribeBackupsPublisher
describeBackupsPaginator
(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest) This is a variant ofdescribeBackups(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsRequest)
operation.default DescribeBackupsPublisher
describeBackupsPaginator
(DescribeBackupsRequest describeBackupsRequest) This is a variant ofdescribeBackups(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsRequest)
operation.Gets information about AWS CloudHSM clusters.describeClusters
(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) Gets information about AWS CloudHSM clusters.describeClusters
(DescribeClustersRequest describeClustersRequest) Gets information about AWS CloudHSM clusters.default DescribeClustersPublisher
This is a variant ofdescribeClusters(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest)
operation.default DescribeClustersPublisher
describeClustersPaginator
(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) This is a variant ofdescribeClusters(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest)
operation.default DescribeClustersPublisher
describeClustersPaginator
(DescribeClustersRequest describeClustersRequest) This is a variant ofdescribeClusters(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest)
operation.initializeCluster
(Consumer<InitializeClusterRequest.Builder> initializeClusterRequest) Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate.initializeCluster
(InitializeClusterRequest initializeClusterRequest) Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate.default CompletableFuture
<ListTagsResponse> listTags
(Consumer<ListTagsRequest.Builder> listTagsRequest) Gets a list of tags for the specified AWS CloudHSM cluster.default CompletableFuture
<ListTagsResponse> listTags
(ListTagsRequest listTagsRequest) Gets a list of tags for the specified AWS CloudHSM cluster.default ListTagsPublisher
listTagsPaginator
(Consumer<ListTagsRequest.Builder> listTagsRequest) This is a variant oflistTags(software.amazon.awssdk.services.cloudhsmv2.model.ListTagsRequest)
operation.default ListTagsPublisher
listTagsPaginator
(ListTagsRequest listTagsRequest) This is a variant oflistTags(software.amazon.awssdk.services.cloudhsmv2.model.ListTagsRequest)
operation.modifyBackupAttributes
(Consumer<ModifyBackupAttributesRequest.Builder> modifyBackupAttributesRequest) Modifies attributes for AWS CloudHSM backup.modifyBackupAttributes
(ModifyBackupAttributesRequest modifyBackupAttributesRequest) Modifies attributes for AWS CloudHSM backup.default CompletableFuture
<ModifyClusterResponse> modifyCluster
(Consumer<ModifyClusterRequest.Builder> modifyClusterRequest) Modifies AWS CloudHSM cluster.default CompletableFuture
<ModifyClusterResponse> modifyCluster
(ModifyClusterRequest modifyClusterRequest) Modifies AWS CloudHSM cluster.default CompletableFuture
<RestoreBackupResponse> restoreBackup
(Consumer<RestoreBackupRequest.Builder> restoreBackupRequest) Restores a specified AWS CloudHSM backup that is in thePENDING_DELETION
state.default CompletableFuture
<RestoreBackupResponse> restoreBackup
(RestoreBackupRequest restoreBackupRequest) Restores a specified AWS CloudHSM backup that is in thePENDING_DELETION
state.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the specified tag or tags from the specified AWS CloudHSM cluster.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes the specified tag or tags from the specified AWS CloudHSM cluster.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
copyBackupToRegion
default CompletableFuture<CopyBackupToRegionResponse> copyBackupToRegion(CopyBackupToRegionRequest copyBackupToRegionRequest) Copy an AWS CloudHSM cluster backup to a different region.
- Parameters:
copyBackupToRegionRequest
-- Returns:
- A Java Future containing the result of the CopyBackupToRegion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
copyBackupToRegion
default CompletableFuture<CopyBackupToRegionResponse> copyBackupToRegion(Consumer<CopyBackupToRegionRequest.Builder> copyBackupToRegionRequest) Copy an AWS CloudHSM cluster backup to a different region.
This is a convenience which creates an instance of the
CopyBackupToRegionRequest.Builder
avoiding the need to create one manually viaCopyBackupToRegionRequest.builder()
- Parameters:
copyBackupToRegionRequest
- AConsumer
that will call methods onCopyBackupToRegionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CopyBackupToRegion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCluster
default CompletableFuture<CreateClusterResponse> createCluster(CreateClusterRequest createClusterRequest) Creates a new AWS CloudHSM cluster.
- Parameters:
createClusterRequest
-- Returns:
- A Java Future containing the result of the CreateCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createCluster
default CompletableFuture<CreateClusterResponse> createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest) Creates a new AWS CloudHSM cluster.
This is a convenience which creates an instance of the
CreateClusterRequest.Builder
avoiding the need to create one manually viaCreateClusterRequest.builder()
- Parameters:
createClusterRequest
- AConsumer
that will call methods onCreateClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createHsm
Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.
- Parameters:
createHsmRequest
-- Returns:
- A Java Future containing the result of the CreateHsm operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createHsm
default CompletableFuture<CreateHsmResponse> createHsm(Consumer<CreateHsmRequest.Builder> createHsmRequest) Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.
This is a convenience which creates an instance of the
CreateHsmRequest.Builder
avoiding the need to create one manually viaCreateHsmRequest.builder()
- Parameters:
createHsmRequest
- AConsumer
that will call methods onCreateHsmRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateHsm operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteBackup
default CompletableFuture<DeleteBackupResponse> deleteBackup(DeleteBackupRequest deleteBackupRequest) Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see RestoreBackup.
- Parameters:
deleteBackupRequest
-- Returns:
- A Java Future containing the result of the DeleteBackup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteBackup
default CompletableFuture<DeleteBackupResponse> deleteBackup(Consumer<DeleteBackupRequest.Builder> deleteBackupRequest) Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see RestoreBackup.
This is a convenience which creates an instance of the
DeleteBackupRequest.Builder
avoiding the need to create one manually viaDeleteBackupRequest.builder()
- Parameters:
deleteBackupRequest
- AConsumer
that will call methods onDeleteBackupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteBackup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCluster
default CompletableFuture<DeleteClusterResponse> deleteCluster(DeleteClusterRequest deleteClusterRequest) Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.
- Parameters:
deleteClusterRequest
-- Returns:
- A Java Future containing the result of the DeleteCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteCluster
default CompletableFuture<DeleteClusterResponse> deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest) Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.
This is a convenience which creates an instance of the
DeleteClusterRequest.Builder
avoiding the need to create one manually viaDeleteClusterRequest.builder()
- Parameters:
deleteClusterRequest
- AConsumer
that will call methods onDeleteClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteHsm
Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters.
- Parameters:
deleteHsmRequest
-- Returns:
- A Java Future containing the result of the DeleteHsm operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteHsm
default CompletableFuture<DeleteHsmResponse> deleteHsm(Consumer<DeleteHsmRequest.Builder> deleteHsmRequest) Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters.
This is a convenience which creates an instance of the
DeleteHsmRequest.Builder
avoiding the need to create one manually viaDeleteHsmRequest.builder()
- Parameters:
deleteHsmRequest
- AConsumer
that will call methods onDeleteHsmRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteHsm operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeBackups
default CompletableFuture<DescribeBackupsResponse> describeBackups(DescribeBackupsRequest describeBackupsRequest) Gets information about backups of AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a
NextToken
value. Use this value in a subsequentDescribeBackups
request to get more backups. When you receive a response with noNextToken
(or an empty or null value), that means there are no more backups to get.- Parameters:
describeBackupsRequest
-- Returns:
- A Java Future containing the result of the DescribeBackups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeBackups
default CompletableFuture<DescribeBackupsResponse> describeBackups(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest) Gets information about backups of AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a
NextToken
value. Use this value in a subsequentDescribeBackups
request to get more backups. When you receive a response with noNextToken
(or an empty or null value), that means there are no more backups to get.
This is a convenience which creates an instance of the
DescribeBackupsRequest.Builder
avoiding the need to create one manually viaDescribeBackupsRequest.builder()
- Parameters:
describeBackupsRequest
- AConsumer
that will call methods onDescribeBackupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeBackups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeBackups
Gets information about backups of AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a
NextToken
value. Use this value in a subsequentDescribeBackups
request to get more backups. When you receive a response with noNextToken
(or an empty or null value), that means there are no more backups to get.- Returns:
- A Java Future containing the result of the DescribeBackups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeBackupsPaginator
This is a variant of
describeBackups(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsPublisher publisher = client.describeBackupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsPublisher publisher = client.describeBackupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeBackups(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeBackupsPaginator
default DescribeBackupsPublisher describeBackupsPaginator(DescribeBackupsRequest describeBackupsRequest) This is a variant of
describeBackups(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsPublisher publisher = client.describeBackupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsPublisher publisher = client.describeBackupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeBackups(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsRequest)
operation.- Parameters:
describeBackupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeBackupsPaginator
default DescribeBackupsPublisher describeBackupsPaginator(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest) This is a variant of
describeBackups(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsPublisher publisher = client.describeBackupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsPublisher publisher = client.describeBackupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeBackups(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsRequest)
operation.
This is a convenience which creates an instance of the
DescribeBackupsRequest.Builder
avoiding the need to create one manually viaDescribeBackupsRequest.builder()
- Parameters:
describeBackupsRequest
- AConsumer
that will call methods onDescribeBackupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusters
default CompletableFuture<DescribeClustersResponse> describeClusters(DescribeClustersRequest describeClustersRequest) Gets information about AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a
NextToken
value. Use this value in a subsequentDescribeClusters
request to get more clusters. When you receive a response with noNextToken
(or an empty or null value), that means there are no more clusters to get.- Parameters:
describeClustersRequest
-- Returns:
- A Java Future containing the result of the DescribeClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusters
default CompletableFuture<DescribeClustersResponse> describeClusters(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) Gets information about AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a
NextToken
value. Use this value in a subsequentDescribeClusters
request to get more clusters. When you receive a response with noNextToken
(or an empty or null value), that means there are no more clusters to get.
This is a convenience which creates an instance of the
DescribeClustersRequest.Builder
avoiding the need to create one manually viaDescribeClustersRequest.builder()
- Parameters:
describeClustersRequest
- AConsumer
that will call methods onDescribeClustersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClusters
Gets information about AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a
NextToken
value. Use this value in a subsequentDescribeClusters
request to get more clusters. When you receive a response with noNextToken
(or an empty or null value), that means there are no more clusters to get.- Returns:
- A Java Future containing the result of the DescribeClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClustersPaginator
This is a variant of
describeClusters(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusters(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClustersPaginator
default DescribeClustersPublisher describeClustersPaginator(DescribeClustersRequest describeClustersRequest) This is a variant of
describeClusters(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusters(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest)
operation.- Parameters:
describeClustersRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeClustersPaginator
default DescribeClustersPublisher describeClustersPaginator(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) This is a variant of
describeClusters(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusters(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest)
operation.
This is a convenience which creates an instance of the
DescribeClustersRequest.Builder
avoiding the need to create one manually viaDescribeClustersRequest.builder()
- Parameters:
describeClustersRequest
- AConsumer
that will call methods onDescribeClustersRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
initializeCluster
default CompletableFuture<InitializeClusterResponse> initializeCluster(InitializeClusterRequest initializeClusterRequest) Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters.
- Parameters:
initializeClusterRequest
-- Returns:
- A Java Future containing the result of the InitializeCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
initializeCluster
default CompletableFuture<InitializeClusterResponse> initializeCluster(Consumer<InitializeClusterRequest.Builder> initializeClusterRequest) Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters.
This is a convenience which creates an instance of the
InitializeClusterRequest.Builder
avoiding the need to create one manually viaInitializeClusterRequest.builder()
- Parameters:
initializeClusterRequest
- AConsumer
that will call methods onInitializeClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the InitializeCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTags
Gets a list of tags for the specified AWS CloudHSM cluster.
This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a
NextToken
value. Use this value in a subsequentListTags
request to get more tags. When you receive a response with noNextToken
(or an empty or null value), that means there are no more tags to get.- Parameters:
listTagsRequest
-- Returns:
- A Java Future containing the result of the ListTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTags
default CompletableFuture<ListTagsResponse> listTags(Consumer<ListTagsRequest.Builder> listTagsRequest) Gets a list of tags for the specified AWS CloudHSM cluster.
This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a
NextToken
value. Use this value in a subsequentListTags
request to get more tags. When you receive a response with noNextToken
(or an empty or null value), that means there are no more tags to get.
This is a convenience which creates an instance of the
ListTagsRequest.Builder
avoiding the need to create one manually viaListTagsRequest.builder()
- Parameters:
listTagsRequest
- AConsumer
that will call methods onListTagsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsPaginator
This is a variant of
listTags(software.amazon.awssdk.services.cloudhsmv2.model.ListTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudhsmv2.paginators.ListTagsPublisher publisher = client.listTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudhsmv2.paginators.ListTagsPublisher publisher = client.listTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudhsmv2.model.ListTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudhsmv2.model.ListTagsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTags(software.amazon.awssdk.services.cloudhsmv2.model.ListTagsRequest)
operation.- Parameters:
listTagsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsPaginator
This is a variant of
listTags(software.amazon.awssdk.services.cloudhsmv2.model.ListTagsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.cloudhsmv2.paginators.ListTagsPublisher publisher = client.listTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.cloudhsmv2.paginators.ListTagsPublisher publisher = client.listTagsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudhsmv2.model.ListTagsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudhsmv2.model.ListTagsResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTags(software.amazon.awssdk.services.cloudhsmv2.model.ListTagsRequest)
operation.
This is a convenience which creates an instance of the
ListTagsRequest.Builder
avoiding the need to create one manually viaListTagsRequest.builder()
- Parameters:
listTagsRequest
- AConsumer
that will call methods onListTagsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyBackupAttributes
default CompletableFuture<ModifyBackupAttributesResponse> modifyBackupAttributes(ModifyBackupAttributesRequest modifyBackupAttributesRequest) Modifies attributes for AWS CloudHSM backup.
- Parameters:
modifyBackupAttributesRequest
-- Returns:
- A Java Future containing the result of the ModifyBackupAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyBackupAttributes
default CompletableFuture<ModifyBackupAttributesResponse> modifyBackupAttributes(Consumer<ModifyBackupAttributesRequest.Builder> modifyBackupAttributesRequest) Modifies attributes for AWS CloudHSM backup.
This is a convenience which creates an instance of the
ModifyBackupAttributesRequest.Builder
avoiding the need to create one manually viaModifyBackupAttributesRequest.builder()
- Parameters:
modifyBackupAttributesRequest
- AConsumer
that will call methods onModifyBackupAttributesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyBackupAttributes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyCluster
default CompletableFuture<ModifyClusterResponse> modifyCluster(ModifyClusterRequest modifyClusterRequest) Modifies AWS CloudHSM cluster.
- Parameters:
modifyClusterRequest
-- Returns:
- A Java Future containing the result of the ModifyCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
modifyCluster
default CompletableFuture<ModifyClusterResponse> modifyCluster(Consumer<ModifyClusterRequest.Builder> modifyClusterRequest) Modifies AWS CloudHSM cluster.
This is a convenience which creates an instance of the
ModifyClusterRequest.Builder
avoiding the need to create one manually viaModifyClusterRequest.builder()
- Parameters:
modifyClusterRequest
- AConsumer
that will call methods onModifyClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ModifyCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
restoreBackup
default CompletableFuture<RestoreBackupResponse> restoreBackup(RestoreBackupRequest restoreBackupRequest) Restores a specified AWS CloudHSM backup that is in the
PENDING_DELETION
state. For mor information on deleting a backup, see DeleteBackup.- Parameters:
restoreBackupRequest
-- Returns:
- A Java Future containing the result of the RestoreBackup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
restoreBackup
default CompletableFuture<RestoreBackupResponse> restoreBackup(Consumer<RestoreBackupRequest.Builder> restoreBackupRequest) Restores a specified AWS CloudHSM backup that is in the
PENDING_DELETION
state. For mor information on deleting a backup, see DeleteBackup.
This is a convenience which creates an instance of the
RestoreBackupRequest.Builder
avoiding the need to create one manually viaRestoreBackupRequest.builder()
- Parameters:
restoreBackupRequest
- AConsumer
that will call methods onRestoreBackupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the RestoreBackup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes the specified tag or tags from the specified AWS CloudHSM cluster.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the specified tag or tags from the specified AWS CloudHSM cluster.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
- CloudHsmInternalFailureException The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
- CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
- CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
- CloudHsmServiceException The request was rejected because an error occurred.
- CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CloudHsmV2Exception Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aCloudHsmV2AsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aCloudHsmV2AsyncClient
.
-