Interface CloudHsmV2AsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder()
method.
For more information about AWS CloudHSM, see AWS CloudHSM and the AWS CloudHSM User Guide.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionstatic CloudHsmV2AsyncClientBuilderbuilder()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 CloudHsmV2AsyncClientcreate()Create aCloudHsmV2AsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand 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 DescribeBackupsPublisherGets information about backups of AWS CloudHSM clusters.default DescribeBackupsPublisherdescribeBackupsPaginator(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest) Gets information about backups of AWS CloudHSM clusters.default DescribeBackupsPublisherdescribeBackupsPaginator(DescribeBackupsRequest describeBackupsRequest) Gets information about backups of AWS CloudHSM clusters.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 DescribeClustersPublisherGets information about AWS CloudHSM clusters.default DescribeClustersPublisherdescribeClustersPaginator(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) Gets information about AWS CloudHSM clusters.default DescribeClustersPublisherdescribeClustersPaginator(DescribeClustersRequest describeClustersRequest) Gets information about AWS CloudHSM clusters.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 ListTagsPublisherlistTagsPaginator(Consumer<ListTagsRequest.Builder> listTagsRequest) Gets a list of tags for the specified AWS CloudHSM cluster.default ListTagsPublisherlistTagsPaginator(ListTagsRequest listTagsRequest) Gets a list of tags for the specified AWS CloudHSM cluster.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_DELETIONstate.default CompletableFuture<RestoreBackupResponse> restoreBackup(RestoreBackupRequest restoreBackupRequest) Restores a specified AWS CloudHSM backup that is in thePENDING_DELETIONstate.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
closeMethods 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.- 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.Builderavoiding the need to create one manually viaCopyBackupToRegionRequest.builder()- Parameters:
copyBackupToRegionRequest- AConsumerthat will call methods onCopyBackupToRegionRequest.Builderto 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.- 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.- 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.Builderavoiding the need to create one manually viaCreateClusterRequest.builder()- Parameters:
createClusterRequest- AConsumerthat will call methods onCreateClusterRequest.Builderto 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.- 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.- 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.Builderavoiding the need to create one manually viaCreateHsmRequest.builder()- Parameters:
createHsmRequest- AConsumerthat will call methods onCreateHsmRequest.Builderto 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.- 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.- 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.Builderavoiding the need to create one manually viaDeleteBackupRequest.builder()- Parameters:
deleteBackupRequest- AConsumerthat will call methods onDeleteBackupRequest.Builderto 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.- 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.- 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.Builderavoiding the need to create one manually viaDeleteClusterRequest.builder()- Parameters:
deleteClusterRequest- AConsumerthat will call methods onDeleteClusterRequest.Builderto 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.- 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.- 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.Builderavoiding the need to create one manually viaDeleteHsmRequest.builder()- Parameters:
deleteHsmRequest- AConsumerthat will call methods onDeleteHsmRequest.Builderto 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.- 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
NextTokenvalue. Use this value in a subsequentDescribeBackupsrequest 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.- 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
NextTokenvalue. Use this value in a subsequentDescribeBackupsrequest 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.Builderavoiding the need to create one manually viaDescribeBackupsRequest.builder()- Parameters:
describeBackupsRequest- AConsumerthat will call methods onDescribeBackupsRequest.Builderto 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.- 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
NextTokenvalue. Use this value in a subsequentDescribeBackupsrequest 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.- 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
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
NextTokenvalue. Use this value in a subsequentDescribeBackupsrequest 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 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsPublisher publisher = client.describeBackupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.- 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) 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
NextTokenvalue. Use this value in a subsequentDescribeBackupsrequest 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 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsPublisher publisher = client.describeBackupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.- 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) 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
NextTokenvalue. Use this value in a subsequentDescribeBackupsrequest 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 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsPublisher publisher = client.describeBackupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaDescribeBackupsRequest.builder()- Parameters:
describeBackupsRequest- AConsumerthat will call methods onDescribeBackupsRequest.Builderto 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.- 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
NextTokenvalue. Use this value in a subsequentDescribeClustersrequest 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.- 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
NextTokenvalue. Use this value in a subsequentDescribeClustersrequest 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.Builderavoiding the need to create one manually viaDescribeClustersRequest.builder()- Parameters:
describeClustersRequest- AConsumerthat will call methods onDescribeClustersRequest.Builderto 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.- 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
NextTokenvalue. Use this value in a subsequentDescribeClustersrequest 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.- 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
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
NextTokenvalue. Use this value in a subsequentDescribeClustersrequest 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 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.- 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) 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
NextTokenvalue. Use this value in a subsequentDescribeClustersrequest 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 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.- 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) 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
NextTokenvalue. Use this value in a subsequentDescribeClustersrequest 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 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersPublisher publisher = client.describeClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaDescribeClustersRequest.builder()- Parameters:
describeClustersRequest- AConsumerthat will call methods onDescribeClustersRequest.Builderto 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.- 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.- 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.Builderavoiding the need to create one manually viaInitializeClusterRequest.builder()- Parameters:
initializeClusterRequest- AConsumerthat will call methods onInitializeClusterRequest.Builderto 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.- 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
NextTokenvalue. Use this value in a subsequentListTagsrequest 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.- 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
NextTokenvalue. Use this value in a subsequentListTagsrequest 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.Builderavoiding the need to create one manually viaListTagsRequest.builder()- Parameters:
listTagsRequest- AConsumerthat will call methods onListTagsRequest.Builderto 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.- 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
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
NextTokenvalue. Use this value in a subsequentListTagsrequest 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 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudhsmv2.paginators.ListTagsPublisher publisher = client.listTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.- 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
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
NextTokenvalue. Use this value in a subsequentListTagsrequest 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 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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudhsmv2.paginators.ListTagsPublisher publisher = client.listTagsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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.Builderavoiding the need to create one manually viaListTagsRequest.builder()- Parameters:
listTagsRequest- AConsumerthat will call methods onListTagsRequest.Builderto 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.- 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.- 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.Builderavoiding the need to create one manually viaModifyBackupAttributesRequest.builder()- Parameters:
modifyBackupAttributesRequest- AConsumerthat will call methods onModifyBackupAttributesRequest.Builderto 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.- 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.- 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.Builderavoiding the need to create one manually viaModifyClusterRequest.builder()- Parameters:
modifyClusterRequest- AConsumerthat will call methods onModifyClusterRequest.Builderto 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.- 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_DELETIONstate. 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.- 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_DELETIONstate. For mor information on deleting a backup, see DeleteBackup.
This is a convenience which creates an instance of the
RestoreBackupRequest.Builderavoiding the need to create one manually viaRestoreBackupRequest.builder()- Parameters:
restoreBackupRequest- AConsumerthat will call methods onRestoreBackupRequest.Builderto 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.- 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.- 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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto 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.- 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.- 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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto 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.- 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:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aCloudHsmV2AsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aCloudHsmV2AsyncClient.
-