@Generated(value="software.amazon.awssdk:codegen") public interface CloudHsmV2Client extends SdkClient
builder() method.
For more information about AWS CloudHSM, see AWS CloudHSM and the AWS CloudHSM User Guide.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static CloudHsmV2ClientBuilder |
builder()
Create a builder that can be used to configure and create a
CloudHsmV2Client. |
default CopyBackupToRegionResponse |
copyBackupToRegion(Consumer<CopyBackupToRegionRequest.Builder> copyBackupToRegionRequest)
Copy an AWS CloudHSM cluster backup to a different region.
|
default CopyBackupToRegionResponse |
copyBackupToRegion(CopyBackupToRegionRequest copyBackupToRegionRequest)
Copy an AWS CloudHSM cluster backup to a different region.
|
static CloudHsmV2Client |
create()
Create a
CloudHsmV2Client with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateClusterResponse |
createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)
Creates a new AWS CloudHSM cluster.
|
default CreateClusterResponse |
createCluster(CreateClusterRequest createClusterRequest)
Creates a new AWS CloudHSM cluster.
|
default CreateHsmResponse |
createHsm(Consumer<CreateHsmRequest.Builder> createHsmRequest)
Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.
|
default CreateHsmResponse |
createHsm(CreateHsmRequest createHsmRequest)
Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.
|
default DeleteBackupResponse |
deleteBackup(Consumer<DeleteBackupRequest.Builder> deleteBackupRequest)
Deletes a specified AWS CloudHSM backup.
|
default DeleteBackupResponse |
deleteBackup(DeleteBackupRequest deleteBackupRequest)
Deletes a specified AWS CloudHSM backup.
|
default DeleteClusterResponse |
deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)
Deletes the specified AWS CloudHSM cluster.
|
default DeleteClusterResponse |
deleteCluster(DeleteClusterRequest deleteClusterRequest)
Deletes the specified AWS CloudHSM cluster.
|
default DeleteHsmResponse |
deleteHsm(Consumer<DeleteHsmRequest.Builder> deleteHsmRequest)
Deletes the specified HSM.
|
default DeleteHsmResponse |
deleteHsm(DeleteHsmRequest deleteHsmRequest)
Deletes the specified HSM.
|
default DescribeBackupsResponse |
describeBackups()
Gets information about backups of AWS CloudHSM clusters.
|
default DescribeBackupsResponse |
describeBackups(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest)
Gets information about backups of AWS CloudHSM clusters.
|
default DescribeBackupsResponse |
describeBackups(DescribeBackupsRequest describeBackupsRequest)
Gets information about backups of AWS CloudHSM clusters.
|
default DescribeBackupsIterable |
describeBackupsPaginator()
Gets information about backups of AWS CloudHSM clusters.
|
default DescribeBackupsIterable |
describeBackupsPaginator(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest)
Gets information about backups of AWS CloudHSM clusters.
|
default DescribeBackupsIterable |
describeBackupsPaginator(DescribeBackupsRequest describeBackupsRequest)
Gets information about backups of AWS CloudHSM clusters.
|
default DescribeClustersResponse |
describeClusters()
Gets information about AWS CloudHSM clusters.
|
default DescribeClustersResponse |
describeClusters(Consumer<DescribeClustersRequest.Builder> describeClustersRequest)
Gets information about AWS CloudHSM clusters.
|
default DescribeClustersResponse |
describeClusters(DescribeClustersRequest describeClustersRequest)
Gets information about AWS CloudHSM clusters.
|
default DescribeClustersIterable |
describeClustersPaginator()
Gets information about AWS CloudHSM clusters.
|
default DescribeClustersIterable |
describeClustersPaginator(Consumer<DescribeClustersRequest.Builder> describeClustersRequest)
Gets information about AWS CloudHSM clusters.
|
default DescribeClustersIterable |
describeClustersPaginator(DescribeClustersRequest describeClustersRequest)
Gets information about AWS CloudHSM clusters.
|
default 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.
|
default 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.
|
default ListTagsResponse |
listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)
Gets a list of tags for the specified AWS CloudHSM cluster.
|
default ListTagsResponse |
listTags(ListTagsRequest listTagsRequest)
Gets a list of tags for the specified AWS CloudHSM cluster.
|
default ListTagsIterable |
listTagsPaginator(Consumer<ListTagsRequest.Builder> listTagsRequest)
Gets a list of tags for the specified AWS CloudHSM cluster.
|
default ListTagsIterable |
listTagsPaginator(ListTagsRequest listTagsRequest)
Gets a list of tags for the specified AWS CloudHSM cluster.
|
default RestoreBackupResponse |
restoreBackup(Consumer<RestoreBackupRequest.Builder> restoreBackupRequest)
Restores a specified AWS CloudHSM backup that is in the
PENDING_DELETION state. |
default RestoreBackupResponse |
restoreBackup(RestoreBackupRequest restoreBackupRequest)
Restores a specified AWS CloudHSM backup that is in the
PENDING_DELETION state. |
static ServiceMetadata |
serviceMetadata() |
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes the specified tag or tags from the specified AWS CloudHSM cluster.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes the specified tag or tags from the specified AWS CloudHSM cluster.
|
serviceNameclosestatic final String SERVICE_NAME
static CloudHsmV2Client create()
CloudHsmV2Client with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static CloudHsmV2ClientBuilder builder()
CloudHsmV2Client.default CopyBackupToRegionResponse copyBackupToRegion(CopyBackupToRegionRequest copyBackupToRegionRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Copy an AWS CloudHSM cluster backup to a different region.
copyBackupToRegionRequest - 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.AwsServiceExceptiondefault CopyBackupToRegionResponse copyBackupToRegion(Consumer<CopyBackupToRegionRequest.Builder> copyBackupToRegionRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Copy an AWS CloudHSM cluster backup to a different region.
This is a convenience which creates an instance of the CopyBackupToRegionRequest.Builder avoiding the
need to create one manually via CopyBackupToRegionRequest.builder()
copyBackupToRegionRequest - A Consumer that will call methods on CopyBackupToRegionRequest.Builder to create a
request.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.AwsServiceExceptiondefault CreateClusterResponse createCluster(CreateClusterRequest createClusterRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Creates a new AWS CloudHSM cluster.
createClusterRequest - 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.AwsServiceExceptiondefault CreateClusterResponse createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Creates a new AWS CloudHSM cluster.
This is a convenience which creates an instance of the CreateClusterRequest.Builder avoiding the need to
create one manually via CreateClusterRequest.builder()
createClusterRequest - A Consumer that will call methods on CreateClusterRequest.Builder to create a request.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.AwsServiceExceptiondefault CreateHsmResponse createHsm(CreateHsmRequest createHsmRequest) throws CloudHsmInternalFailureException, CloudHsmServiceException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmAccessDeniedException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.
createHsmRequest - 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.AwsServiceExceptiondefault CreateHsmResponse createHsm(Consumer<CreateHsmRequest.Builder> createHsmRequest) throws CloudHsmInternalFailureException, CloudHsmServiceException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmAccessDeniedException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.
This is a convenience which creates an instance of the CreateHsmRequest.Builder avoiding the need to
create one manually via CreateHsmRequest.builder()
createHsmRequest - A Consumer that will call methods on CreateHsmRequest.Builder to create a request.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.AwsServiceExceptiondefault DeleteBackupResponse deleteBackup(DeleteBackupRequest deleteBackupRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, AwsServiceException, SdkClientException, CloudHsmV2Exception
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.
deleteBackupRequest - 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.AwsServiceExceptiondefault DeleteBackupResponse deleteBackup(Consumer<DeleteBackupRequest.Builder> deleteBackupRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see RestoreBackup.
This is a convenience which creates an instance of the DeleteBackupRequest.Builder avoiding the need to
create one manually via DeleteBackupRequest.builder()
deleteBackupRequest - A Consumer that will call methods on DeleteBackupRequest.Builder to create a request.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.AwsServiceExceptiondefault DeleteClusterResponse deleteCluster(DeleteClusterRequest deleteClusterRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception
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.
deleteClusterRequest - 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.AwsServiceExceptiondefault DeleteClusterResponse deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.
This is a convenience which creates an instance of the DeleteClusterRequest.Builder avoiding the need to
create one manually via DeleteClusterRequest.builder()
deleteClusterRequest - A Consumer that will call methods on DeleteClusterRequest.Builder to create a request.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.AwsServiceExceptiondefault DeleteHsmResponse deleteHsm(DeleteHsmRequest deleteHsmRequest) throws CloudHsmInternalFailureException, CloudHsmServiceException, CloudHsmResourceNotFoundException, CloudHsmInvalidRequestException, CloudHsmAccessDeniedException, AwsServiceException, SdkClientException, CloudHsmV2Exception
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.
deleteHsmRequest - 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.AwsServiceExceptiondefault DeleteHsmResponse deleteHsm(Consumer<DeleteHsmRequest.Builder> deleteHsmRequest) throws CloudHsmInternalFailureException, CloudHsmServiceException, CloudHsmResourceNotFoundException, CloudHsmInvalidRequestException, CloudHsmAccessDeniedException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters.
This is a convenience which creates an instance of the DeleteHsmRequest.Builder avoiding the need to
create one manually via DeleteHsmRequest.builder()
deleteHsmRequest - A Consumer that will call methods on DeleteHsmRequest.Builder to create a request.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.AwsServiceExceptiondefault DescribeBackupsResponse describeBackups() throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Gets information about backups of AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the backups.
When the response contains only a subset of backups, it includes a NextToken value. Use this value
in a subsequent DescribeBackups request to get more backups. When you receive a response with no
NextToken (or an empty or null value), that means there are no more backups to get.
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.AwsServiceExceptiondescribeBackups(DescribeBackupsRequest),
AWS API
Documentationdefault DescribeBackupsResponse describeBackups(DescribeBackupsRequest describeBackupsRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Gets information about backups of AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the backups.
When the response contains only a subset of backups, it includes a NextToken value. Use this value
in a subsequent DescribeBackups request to get more backups. When you receive a response with no
NextToken (or an empty or null value), that means there are no more backups to get.
describeBackupsRequest - 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.AwsServiceExceptiondefault DescribeBackupsResponse describeBackups(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Gets information about backups of AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the backups.
When the response contains only a subset of backups, it includes a NextToken value. Use this value
in a subsequent DescribeBackups request to get more backups. When you receive a response with no
NextToken (or an empty or null value), that means there are no more backups to get.
This is a convenience which creates an instance of the DescribeBackupsRequest.Builder avoiding the need
to create one manually via DescribeBackupsRequest.builder()
describeBackupsRequest - A Consumer that will call methods on DescribeBackupsRequest.Builder to create a request.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.AwsServiceExceptiondefault DescribeBackupsIterable describeBackupsPaginator() throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Gets information about backups of AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the backups.
When the response contains only a subset of backups, it includes a NextToken value. Use this value
in a subsequent DescribeBackups request to get more backups. When you receive a response with no
NextToken (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 iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsIterable responses = client
.describeBackupsPaginator(request);
for (software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
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.AwsServiceExceptiondescribeBackupsPaginator(DescribeBackupsRequest),
AWS API
Documentationdefault DescribeBackupsIterable describeBackupsPaginator(DescribeBackupsRequest describeBackupsRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Gets information about backups of AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the backups.
When the response contains only a subset of backups, it includes a NextToken value. Use this value
in a subsequent DescribeBackups request to get more backups. When you receive a response with no
NextToken (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 iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsIterable responses = client
.describeBackupsPaginator(request);
for (software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeBackupsRequest - 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.AwsServiceExceptiondefault DescribeBackupsIterable describeBackupsPaginator(Consumer<DescribeBackupsRequest.Builder> describeBackupsRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Gets information about backups of AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the backups.
When the response contains only a subset of backups, it includes a NextToken value. Use this value
in a subsequent DescribeBackups request to get more backups. When you receive a response with no
NextToken (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 iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsIterable responses = client
.describeBackupsPaginator(request);
for (software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeBackupsIterable responses = client.describeBackupsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeBackups(software.amazon.awssdk.services.cloudhsmv2.model.DescribeBackupsRequest) operation.
This is a convenience which creates an instance of the DescribeBackupsRequest.Builder avoiding the need
to create one manually via DescribeBackupsRequest.builder()
describeBackupsRequest - A Consumer that will call methods on DescribeBackupsRequest.Builder to create a request.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.AwsServiceExceptiondefault DescribeClustersResponse describeClusters() throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Gets information about AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the clusters.
When the response contains only a subset of clusters, it includes a NextToken value. Use this value
in a subsequent DescribeClusters request to get more clusters. When you receive a response with no
NextToken (or an empty or null value), that means there are no more clusters to get.
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.AwsServiceExceptiondescribeClusters(DescribeClustersRequest),
AWS
API Documentationdefault DescribeClustersResponse describeClusters(DescribeClustersRequest describeClustersRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Gets information about AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the clusters.
When the response contains only a subset of clusters, it includes a NextToken value. Use this value
in a subsequent DescribeClusters request to get more clusters. When you receive a response with no
NextToken (or an empty or null value), that means there are no more clusters to get.
describeClustersRequest - 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.AwsServiceExceptiondefault DescribeClustersResponse describeClusters(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Gets information about AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the clusters.
When the response contains only a subset of clusters, it includes a NextToken value. Use this value
in a subsequent DescribeClusters request to get more clusters. When you receive a response with no
NextToken (or an empty or null value), that means there are no more clusters to get.
This is a convenience which creates an instance of the DescribeClustersRequest.Builder avoiding the need
to create one manually via DescribeClustersRequest.builder()
describeClustersRequest - A Consumer that will call methods on DescribeClustersRequest.Builder to create a request.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.AwsServiceExceptiondefault DescribeClustersIterable describeClustersPaginator() throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Gets information about AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the clusters.
When the response contains only a subset of clusters, it includes a NextToken value. Use this value
in a subsequent DescribeClusters request to get more clusters. When you receive a response with no
NextToken (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 iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersIterable responses = client
.describeClustersPaginator(request);
for (software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request);
responses.iterator().forEachRemaining(....);
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.
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.AwsServiceExceptiondescribeClustersPaginator(DescribeClustersRequest),
AWS
API Documentationdefault DescribeClustersIterable describeClustersPaginator(DescribeClustersRequest describeClustersRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Gets information about AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the clusters.
When the response contains only a subset of clusters, it includes a NextToken value. Use this value
in a subsequent DescribeClusters request to get more clusters. When you receive a response with no
NextToken (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 iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersIterable responses = client
.describeClustersPaginator(request);
for (software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request);
responses.iterator().forEachRemaining(....);
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.
describeClustersRequest - 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.AwsServiceExceptiondefault DescribeClustersIterable describeClustersPaginator(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Gets information about AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the clusters.
When the response contains only a subset of clusters, it includes a NextToken value. Use this value
in a subsequent DescribeClusters request to get more clusters. When you receive a response with no
NextToken (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 iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersIterable responses = client
.describeClustersPaginator(request);
for (software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudhsmv2.paginators.DescribeClustersIterable responses = client.describeClustersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeClusters(software.amazon.awssdk.services.cloudhsmv2.model.DescribeClustersRequest)
operation.
This is a convenience which creates an instance of the DescribeClustersRequest.Builder avoiding the need
to create one manually via DescribeClustersRequest.builder()
describeClustersRequest - A Consumer that will call methods on DescribeClustersRequest.Builder to create a request.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.AwsServiceExceptiondefault InitializeClusterResponse initializeCluster(InitializeClusterRequest initializeClusterRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, AwsServiceException, SdkClientException, CloudHsmV2Exception
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.
initializeClusterRequest - 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.AwsServiceExceptiondefault InitializeClusterResponse initializeCluster(Consumer<InitializeClusterRequest.Builder> initializeClusterRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters.
This is a convenience which creates an instance of the InitializeClusterRequest.Builder avoiding the need
to create one manually via InitializeClusterRequest.builder()
initializeClusterRequest - A Consumer that will call methods on InitializeClusterRequest.Builder to create a request.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.AwsServiceExceptiondefault ListTagsResponse listTags(ListTagsRequest listTagsRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Gets a list of tags for the specified AWS CloudHSM cluster.
This is a paginated operation, which means that each response might contain only a subset of all the tags. When
the response contains only a subset of tags, it includes a NextToken value. Use this value in a
subsequent ListTags request to get more tags. When you receive a response with no
NextToken (or an empty or null value), that means there are no more tags to get.
listTagsRequest - 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.AwsServiceExceptiondefault ListTagsResponse listTags(Consumer<ListTagsRequest.Builder> listTagsRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Gets a list of tags for the specified AWS CloudHSM cluster.
This is a paginated operation, which means that each response might contain only a subset of all the tags. When
the response contains only a subset of tags, it includes a NextToken value. Use this value in a
subsequent ListTags request to get more tags. When you receive a response with no
NextToken (or an empty or null value), that means there are no more tags to get.
This is a convenience which creates an instance of the ListTagsRequest.Builder avoiding the need to
create one manually via ListTagsRequest.builder()
listTagsRequest - A Consumer that will call methods on ListTagsRequest.Builder to create a request.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.AwsServiceExceptiondefault ListTagsIterable listTagsPaginator(ListTagsRequest listTagsRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Gets a list of tags for the specified AWS CloudHSM cluster.
This is a paginated operation, which means that each response might contain only a subset of all the tags. When
the response contains only a subset of tags, it includes a NextToken value. Use this value in a
subsequent ListTags request to get more tags. When you receive a response with no
NextToken (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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudhsmv2.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudhsmv2.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
for (software.amazon.awssdk.services.cloudhsmv2.model.ListTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudhsmv2.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
responses.iterator().forEachRemaining(....);
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.
listTagsRequest - 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.AwsServiceExceptiondefault ListTagsIterable listTagsPaginator(Consumer<ListTagsRequest.Builder> listTagsRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Gets a list of tags for the specified AWS CloudHSM cluster.
This is a paginated operation, which means that each response might contain only a subset of all the tags. When
the response contains only a subset of tags, it includes a NextToken value. Use this value in a
subsequent ListTags request to get more tags. When you receive a response with no
NextToken (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 iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.cloudhsmv2.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.cloudhsmv2.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
for (software.amazon.awssdk.services.cloudhsmv2.model.ListTagsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.cloudhsmv2.paginators.ListTagsIterable responses = client.listTagsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTags(software.amazon.awssdk.services.cloudhsmv2.model.ListTagsRequest) operation.
This is a convenience which creates an instance of the ListTagsRequest.Builder avoiding the need to
create one manually via ListTagsRequest.builder()
listTagsRequest - A Consumer that will call methods on ListTagsRequest.Builder to create a request.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.AwsServiceExceptiondefault RestoreBackupResponse restoreBackup(RestoreBackupRequest restoreBackupRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state. For mor information
on deleting a backup, see DeleteBackup.
restoreBackupRequest - 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.AwsServiceExceptiondefault RestoreBackupResponse restoreBackup(Consumer<RestoreBackupRequest.Builder> restoreBackupRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state. For mor information
on deleting a backup, see DeleteBackup.
This is a convenience which creates an instance of the RestoreBackupRequest.Builder avoiding the need to
create one manually via RestoreBackupRequest.builder()
restoreBackupRequest - A Consumer that will call methods on RestoreBackupRequest.Builder to create a request.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.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
tagResourceRequest - 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.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.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.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Removes the specified tag or tags from the specified AWS CloudHSM cluster.
untagResourceRequest - 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.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws CloudHsmAccessDeniedException, CloudHsmInternalFailureException, CloudHsmInvalidRequestException, CloudHsmResourceNotFoundException, CloudHsmServiceException, CloudHsmTagException, AwsServiceException, SdkClientException, CloudHsmV2Exception
Removes the specified tag or tags from the specified AWS CloudHSM cluster.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.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.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2020 Amazon Web Services, Inc. All Rights Reserved.