Interface WorkspacesInstancesClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface WorkspacesInstancesClient
extends AwsClient

Service client for accessing Amazon Workspaces Instances. This can be created using the static builder() method.

Amazon WorkSpaces Instances provides an API framework for managing virtual workspace environments across multiple AWS regions, enabling programmatic creation and configuration of desktop infrastructure.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default AssociateVolumeResponse	associateVolume(Consumer<AssociateVolumeRequest.Builder> associateVolumeRequest)	Attaches a volume to a WorkSpace Instance.
default AssociateVolumeResponse	associateVolume(AssociateVolumeRequest associateVolumeRequest)	Attaches a volume to a WorkSpace Instance.
static WorkspacesInstancesClientBuilder	builder()	Create a builder that can be used to configure and create a WorkspacesInstancesClient.
static WorkspacesInstancesClient	create()	Create a WorkspacesInstancesClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateVolumeResponse	createVolume(Consumer<CreateVolumeRequest.Builder> createVolumeRequest)	Creates a new volume for WorkSpace Instances.
default CreateVolumeResponse	createVolume(CreateVolumeRequest createVolumeRequest)	Creates a new volume for WorkSpace Instances.
default CreateWorkspaceInstanceResponse	createWorkspaceInstance(Consumer<CreateWorkspaceInstanceRequest.Builder> createWorkspaceInstanceRequest)	Launches a new WorkSpace Instance with specified configuration parameters, enabling programmatic workspace deployment.
default CreateWorkspaceInstanceResponse	createWorkspaceInstance(CreateWorkspaceInstanceRequest createWorkspaceInstanceRequest)	Launches a new WorkSpace Instance with specified configuration parameters, enabling programmatic workspace deployment.
default DeleteVolumeResponse	deleteVolume(Consumer<DeleteVolumeRequest.Builder> deleteVolumeRequest)	Deletes a specified volume.
default DeleteVolumeResponse	deleteVolume(DeleteVolumeRequest deleteVolumeRequest)	Deletes a specified volume.
default DeleteWorkspaceInstanceResponse	deleteWorkspaceInstance(Consumer<DeleteWorkspaceInstanceRequest.Builder> deleteWorkspaceInstanceRequest)	Deletes the specified WorkSpace
default DeleteWorkspaceInstanceResponse	deleteWorkspaceInstance(DeleteWorkspaceInstanceRequest deleteWorkspaceInstanceRequest)	Deletes the specified WorkSpace
default DisassociateVolumeResponse	disassociateVolume(Consumer<DisassociateVolumeRequest.Builder> disassociateVolumeRequest)	Detaches a volume from a WorkSpace Instance.
default DisassociateVolumeResponse	disassociateVolume(DisassociateVolumeRequest disassociateVolumeRequest)	Detaches a volume from a WorkSpace Instance.
default GetWorkspaceInstanceResponse	getWorkspaceInstance(Consumer<GetWorkspaceInstanceRequest.Builder> getWorkspaceInstanceRequest)	Retrieves detailed information about a specific WorkSpace Instance.
default GetWorkspaceInstanceResponse	getWorkspaceInstance(GetWorkspaceInstanceRequest getWorkspaceInstanceRequest)	Retrieves detailed information about a specific WorkSpace Instance.
default ListInstanceTypesResponse	listInstanceTypes(Consumer<ListInstanceTypesRequest.Builder> listInstanceTypesRequest)	Retrieves a list of instance types supported by Amazon WorkSpaces Instances, enabling precise workspace infrastructure configuration.
default ListInstanceTypesResponse	listInstanceTypes(ListInstanceTypesRequest listInstanceTypesRequest)	Retrieves a list of instance types supported by Amazon WorkSpaces Instances, enabling precise workspace infrastructure configuration.
default ListInstanceTypesIterable	listInstanceTypesPaginator(Consumer<ListInstanceTypesRequest.Builder> listInstanceTypesRequest)	This is a variant of listInstanceTypes(software.amazon.awssdk.services.workspacesinstances.model.ListInstanceTypesRequest) operation.
default ListInstanceTypesIterable	listInstanceTypesPaginator(ListInstanceTypesRequest listInstanceTypesRequest)	This is a variant of listInstanceTypes(software.amazon.awssdk.services.workspacesinstances.model.ListInstanceTypesRequest) operation.
default ListRegionsResponse	listRegions(Consumer<ListRegionsRequest.Builder> listRegionsRequest)	Retrieves a list of AWS regions supported by Amazon WorkSpaces Instances, enabling region discovery for workspace deployments.
default ListRegionsResponse	listRegions(ListRegionsRequest listRegionsRequest)	Retrieves a list of AWS regions supported by Amazon WorkSpaces Instances, enabling region discovery for workspace deployments.
default ListRegionsIterable	listRegionsPaginator(Consumer<ListRegionsRequest.Builder> listRegionsRequest)	This is a variant of listRegions(software.amazon.awssdk.services.workspacesinstances.model.ListRegionsRequest) operation.
default ListRegionsIterable	listRegionsPaginator(ListRegionsRequest listRegionsRequest)	This is a variant of listRegions(software.amazon.awssdk.services.workspacesinstances.model.ListRegionsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Retrieves tags for a WorkSpace Instance.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Retrieves tags for a WorkSpace Instance.
default ListWorkspaceInstancesResponse	listWorkspaceInstances(Consumer<ListWorkspaceInstancesRequest.Builder> listWorkspaceInstancesRequest)	Retrieves a collection of WorkSpaces Instances based on specified filters.
default ListWorkspaceInstancesResponse	listWorkspaceInstances(ListWorkspaceInstancesRequest listWorkspaceInstancesRequest)	Retrieves a collection of WorkSpaces Instances based on specified filters.
default ListWorkspaceInstancesIterable	listWorkspaceInstancesPaginator(Consumer<ListWorkspaceInstancesRequest.Builder> listWorkspaceInstancesRequest)	This is a variant of listWorkspaceInstances(software.amazon.awssdk.services.workspacesinstances.model.ListWorkspaceInstancesRequest) operation.
default ListWorkspaceInstancesIterable	listWorkspaceInstancesPaginator(ListWorkspaceInstancesRequest listWorkspaceInstancesRequest)	This is a variant of listWorkspaceInstances(software.amazon.awssdk.services.workspacesinstances.model.ListWorkspaceInstancesRequest) operation.
default WorkspacesInstancesServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds tags to a WorkSpace Instance.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds tags to a WorkSpace Instance.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes tags from a WorkSpace Instance.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes tags from a WorkSpace Instance.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

associateVolume

default AssociateVolumeResponse associateVolume(AssociateVolumeRequest associateVolumeRequest)
                                         throws ValidationException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

Attaches a volume to a WorkSpace Instance.

Parameters:

associateVolumeRequest - Specifies volume attachment parameters.

Returns:

Result of the AssociateVolume operation returned by the service.

See Also:

• AWS API Documentation

associateVolume

default AssociateVolumeResponse associateVolume(Consumer<AssociateVolumeRequest.Builder> associateVolumeRequest)
                                         throws ValidationException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

Attaches a volume to a WorkSpace Instance.

This is a convenience which creates an instance of the AssociateVolumeRequest.Builder avoiding the need to create one manually via AssociateVolumeRequest.builder()

Parameters:

associateVolumeRequest - A Consumer that will call methods on AssociateVolumeRequest.Builder to create a request. Specifies volume attachment parameters.

Returns:

Result of the AssociateVolume operation returned by the service.

See Also:

• AWS API Documentation

createVolume

default CreateVolumeResponse createVolume(CreateVolumeRequest createVolumeRequest)
                                   throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
ServiceQuotaExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

Creates a new volume for WorkSpace Instances.

Parameters:

createVolumeRequest - Specifies volume creation parameters.

Returns:

Result of the CreateVolume operation returned by the service.

See Also:

• AWS API Documentation

createVolume

default CreateVolumeResponse createVolume(Consumer<CreateVolumeRequest.Builder> createVolumeRequest)
                                   throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
ServiceQuotaExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

Creates a new volume for WorkSpace Instances.

This is a convenience which creates an instance of the CreateVolumeRequest.Builder avoiding the need to create one manually via CreateVolumeRequest.builder()

Parameters:

createVolumeRequest - A Consumer that will call methods on CreateVolumeRequest.Builder to create a request. Specifies volume creation parameters.

Returns:

Result of the CreateVolume operation returned by the service.

See Also:

• AWS API Documentation

createWorkspaceInstance

default CreateWorkspaceInstanceResponse createWorkspaceInstance(CreateWorkspaceInstanceRequest createWorkspaceInstanceRequest)
                                                         throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
ServiceQuotaExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

Launches a new WorkSpace Instance with specified configuration parameters, enabling programmatic workspace deployment.

Parameters:

createWorkspaceInstanceRequest - Defines the configuration parameters for creating a new WorkSpaces Instance.

Returns:

Result of the CreateWorkspaceInstance operation returned by the service.

See Also:

• AWS API Documentation

createWorkspaceInstance

default CreateWorkspaceInstanceResponse createWorkspaceInstance(Consumer<CreateWorkspaceInstanceRequest.Builder> createWorkspaceInstanceRequest)
                                                         throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
ServiceQuotaExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

Launches a new WorkSpace Instance with specified configuration parameters, enabling programmatic workspace deployment.

This is a convenience which creates an instance of the CreateWorkspaceInstanceRequest.Builder avoiding the need to create one manually via CreateWorkspaceInstanceRequest.builder()

Parameters:

createWorkspaceInstanceRequest - A Consumer that will call methods on CreateWorkspaceInstanceRequest.Builder to create a request. Defines the configuration parameters for creating a new WorkSpaces Instance.

Returns:

Result of the CreateWorkspaceInstance operation returned by the service.

See Also:

• AWS API Documentation

deleteVolume

default DeleteVolumeResponse deleteVolume(DeleteVolumeRequest deleteVolumeRequest)
                                   throws ValidationException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

Deletes a specified volume.

Parameters:

deleteVolumeRequest - Specifies the volume to delete.

Returns:

Result of the DeleteVolume operation returned by the service.

See Also:

• AWS API Documentation

deleteVolume

default DeleteVolumeResponse deleteVolume(Consumer<DeleteVolumeRequest.Builder> deleteVolumeRequest)
                                   throws ValidationException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

Deletes a specified volume.

This is a convenience which creates an instance of the DeleteVolumeRequest.Builder avoiding the need to create one manually via DeleteVolumeRequest.builder()

Parameters:

deleteVolumeRequest - A Consumer that will call methods on DeleteVolumeRequest.Builder to create a request. Specifies the volume to delete.

Returns:

Result of the DeleteVolume operation returned by the service.

See Also:

• AWS API Documentation

deleteWorkspaceInstance

default DeleteWorkspaceInstanceResponse deleteWorkspaceInstance(DeleteWorkspaceInstanceRequest deleteWorkspaceInstanceRequest)
                                                         throws ValidationException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

Deletes the specified WorkSpace

Parameters:

deleteWorkspaceInstanceRequest - The WorkSpace to delete

Returns:

Result of the DeleteWorkspaceInstance operation returned by the service.

See Also:

• AWS API Documentation

deleteWorkspaceInstance

default DeleteWorkspaceInstanceResponse deleteWorkspaceInstance(Consumer<DeleteWorkspaceInstanceRequest.Builder> deleteWorkspaceInstanceRequest)
                                                         throws ValidationException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

Deletes the specified WorkSpace

This is a convenience which creates an instance of the DeleteWorkspaceInstanceRequest.Builder avoiding the need to create one manually via DeleteWorkspaceInstanceRequest.builder()

Parameters:

deleteWorkspaceInstanceRequest - A Consumer that will call methods on DeleteWorkspaceInstanceRequest.Builder to create a request. The WorkSpace to delete

Returns:

Result of the DeleteWorkspaceInstance operation returned by the service.

See Also:

• AWS API Documentation

disassociateVolume

default DisassociateVolumeResponse disassociateVolume(DisassociateVolumeRequest disassociateVolumeRequest)
                                               throws ValidationException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

Detaches a volume from a WorkSpace Instance.

Parameters:

disassociateVolumeRequest - Specifies volume detachment parameters.

Returns:

Result of the DisassociateVolume operation returned by the service.

See Also:

• AWS API Documentation

disassociateVolume

default DisassociateVolumeResponse disassociateVolume(Consumer<DisassociateVolumeRequest.Builder> disassociateVolumeRequest)
                                               throws ValidationException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
ConflictException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

Detaches a volume from a WorkSpace Instance.

This is a convenience which creates an instance of the DisassociateVolumeRequest.Builder avoiding the need to create one manually via DisassociateVolumeRequest.builder()

Parameters:

disassociateVolumeRequest - A Consumer that will call methods on DisassociateVolumeRequest.Builder to create a request. Specifies volume detachment parameters.

Returns:

Result of the DisassociateVolume operation returned by the service.

See Also:

• AWS API Documentation

getWorkspaceInstance

default GetWorkspaceInstanceResponse getWorkspaceInstance(GetWorkspaceInstanceRequest getWorkspaceInstanceRequest)
                                                   throws ValidationException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

Retrieves detailed information about a specific WorkSpace Instance.

Parameters:

getWorkspaceInstanceRequest - Identifies the WorkSpaces Instance to retrieve detailed information for.

Returns:

Result of the GetWorkspaceInstance operation returned by the service.

See Also:

• AWS API Documentation

getWorkspaceInstance

default GetWorkspaceInstanceResponse getWorkspaceInstance(Consumer<GetWorkspaceInstanceRequest.Builder> getWorkspaceInstanceRequest)
                                                   throws ValidationException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

Retrieves detailed information about a specific WorkSpace Instance.

This is a convenience which creates an instance of the GetWorkspaceInstanceRequest.Builder avoiding the need to create one manually via GetWorkspaceInstanceRequest.builder()

Parameters:

getWorkspaceInstanceRequest - A Consumer that will call methods on GetWorkspaceInstanceRequest.Builder to create a request. Identifies the WorkSpaces Instance to retrieve detailed information for.

Returns:

Result of the GetWorkspaceInstance operation returned by the service.

See Also:

• AWS API Documentation

listInstanceTypes

default ListInstanceTypesResponse listInstanceTypes(ListInstanceTypesRequest listInstanceTypesRequest)
                                             throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

Retrieves a list of instance types supported by Amazon WorkSpaces Instances, enabling precise workspace infrastructure configuration.

Parameters:

listInstanceTypesRequest - Defines input parameters for retrieving supported WorkSpaces Instances instance types.

Returns:

Result of the ListInstanceTypes operation returned by the service.

See Also:

• AWS API Documentation

listInstanceTypes

default ListInstanceTypesResponse listInstanceTypes(Consumer<ListInstanceTypesRequest.Builder> listInstanceTypesRequest)
                                             throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

Retrieves a list of instance types supported by Amazon WorkSpaces Instances, enabling precise workspace infrastructure configuration.

This is a convenience which creates an instance of the ListInstanceTypesRequest.Builder avoiding the need to create one manually via ListInstanceTypesRequest.builder()

Parameters:

listInstanceTypesRequest - A Consumer that will call methods on ListInstanceTypesRequest.Builder to create a request. Defines input parameters for retrieving supported WorkSpaces Instances instance types.

Returns:

Result of the ListInstanceTypes operation returned by the service.

See Also:

• AWS API Documentation

listInstanceTypesPaginator

default ListInstanceTypesIterable listInstanceTypesPaginator(ListInstanceTypesRequest listInstanceTypesRequest)
                                                      throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

This is a variant of listInstanceTypes(software.amazon.awssdk.services.workspacesinstances.model.ListInstanceTypesRequest) 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.workspacesinstances.paginators.ListInstanceTypesIterable responses = client.listInstanceTypesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.workspacesinstances.paginators.ListInstanceTypesIterable responses = client
             .listInstanceTypesPaginator(request);
     for (software.amazon.awssdk.services.workspacesinstances.model.ListInstanceTypesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.workspacesinstances.paginators.ListInstanceTypesIterable responses = client.listInstanceTypesPaginator(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 listInstanceTypes(software.amazon.awssdk.services.workspacesinstances.model.ListInstanceTypesRequest) operation.

Parameters:

listInstanceTypesRequest - Defines input parameters for retrieving supported WorkSpaces Instances instance types.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listInstanceTypesPaginator

default ListInstanceTypesIterable listInstanceTypesPaginator(Consumer<ListInstanceTypesRequest.Builder> listInstanceTypesRequest)
                                                      throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

This is a variant of listInstanceTypes(software.amazon.awssdk.services.workspacesinstances.model.ListInstanceTypesRequest) 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.workspacesinstances.paginators.ListInstanceTypesIterable responses = client.listInstanceTypesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.workspacesinstances.paginators.ListInstanceTypesIterable responses = client
             .listInstanceTypesPaginator(request);
     for (software.amazon.awssdk.services.workspacesinstances.model.ListInstanceTypesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.workspacesinstances.paginators.ListInstanceTypesIterable responses = client.listInstanceTypesPaginator(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 listInstanceTypes(software.amazon.awssdk.services.workspacesinstances.model.ListInstanceTypesRequest) operation.

This is a convenience which creates an instance of the ListInstanceTypesRequest.Builder avoiding the need to create one manually via ListInstanceTypesRequest.builder()

Parameters:

listInstanceTypesRequest - A Consumer that will call methods on ListInstanceTypesRequest.Builder to create a request. Defines input parameters for retrieving supported WorkSpaces Instances instance types.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listRegions

default ListRegionsResponse listRegions(ListRegionsRequest listRegionsRequest)
                                 throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

Retrieves a list of AWS regions supported by Amazon WorkSpaces Instances, enabling region discovery for workspace deployments.

Parameters:

listRegionsRequest - Defines input parameters for retrieving supported WorkSpaces Instances regions.

Returns:

Result of the ListRegions operation returned by the service.

See Also:

• AWS API Documentation

listRegions

default ListRegionsResponse listRegions(Consumer<ListRegionsRequest.Builder> listRegionsRequest)
                                 throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

Retrieves a list of AWS regions supported by Amazon WorkSpaces Instances, enabling region discovery for workspace deployments.

This is a convenience which creates an instance of the ListRegionsRequest.Builder avoiding the need to create one manually via ListRegionsRequest.builder()

Parameters:

listRegionsRequest - A Consumer that will call methods on ListRegionsRequest.Builder to create a request. Defines input parameters for retrieving supported WorkSpaces Instances regions.

Returns:

Result of the ListRegions operation returned by the service.

See Also:

• AWS API Documentation

listRegionsPaginator

default ListRegionsIterable listRegionsPaginator(ListRegionsRequest listRegionsRequest)
                                          throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

This is a variant of listRegions(software.amazon.awssdk.services.workspacesinstances.model.ListRegionsRequest) 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.workspacesinstances.paginators.ListRegionsIterable responses = client.listRegionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.workspacesinstances.paginators.ListRegionsIterable responses = client
             .listRegionsPaginator(request);
     for (software.amazon.awssdk.services.workspacesinstances.model.ListRegionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.workspacesinstances.paginators.ListRegionsIterable responses = client.listRegionsPaginator(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 listRegions(software.amazon.awssdk.services.workspacesinstances.model.ListRegionsRequest) operation.

Parameters:

listRegionsRequest - Defines input parameters for retrieving supported WorkSpaces Instances regions.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listRegionsPaginator

default ListRegionsIterable listRegionsPaginator(Consumer<ListRegionsRequest.Builder> listRegionsRequest)
                                          throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

This is a variant of listRegions(software.amazon.awssdk.services.workspacesinstances.model.ListRegionsRequest) 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.workspacesinstances.paginators.ListRegionsIterable responses = client.listRegionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.workspacesinstances.paginators.ListRegionsIterable responses = client
             .listRegionsPaginator(request);
     for (software.amazon.awssdk.services.workspacesinstances.model.ListRegionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.workspacesinstances.paginators.ListRegionsIterable responses = client.listRegionsPaginator(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 listRegions(software.amazon.awssdk.services.workspacesinstances.model.ListRegionsRequest) operation.

This is a convenience which creates an instance of the ListRegionsRequest.Builder avoiding the need to create one manually via ListRegionsRequest.builder()

Parameters:

listRegionsRequest - A Consumer that will call methods on ListRegionsRequest.Builder to create a request. Defines input parameters for retrieving supported WorkSpaces Instances regions.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

Retrieves tags for a WorkSpace Instance.

Parameters:

listTagsForResourceRequest - Specifies the WorkSpace Instance to retrieve tags for.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

Retrieves tags for a WorkSpace Instance.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request. Specifies the WorkSpace Instance to retrieve tags for.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listWorkspaceInstances

default ListWorkspaceInstancesResponse listWorkspaceInstances(ListWorkspaceInstancesRequest listWorkspaceInstancesRequest)
                                                       throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

Retrieves a collection of WorkSpaces Instances based on specified filters.

Parameters:

listWorkspaceInstancesRequest - Defines filters and pagination parameters for retrieving WorkSpaces Instances.

Returns:

Result of the ListWorkspaceInstances operation returned by the service.

See Also:

• AWS API Documentation

listWorkspaceInstances

default ListWorkspaceInstancesResponse listWorkspaceInstances(Consumer<ListWorkspaceInstancesRequest.Builder> listWorkspaceInstancesRequest)
                                                       throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

Retrieves a collection of WorkSpaces Instances based on specified filters.

This is a convenience which creates an instance of the ListWorkspaceInstancesRequest.Builder avoiding the need to create one manually via ListWorkspaceInstancesRequest.builder()

Parameters:

listWorkspaceInstancesRequest - A Consumer that will call methods on ListWorkspaceInstancesRequest.Builder to create a request. Defines filters and pagination parameters for retrieving WorkSpaces Instances.

Returns:

Result of the ListWorkspaceInstances operation returned by the service.

See Also:

• AWS API Documentation

listWorkspaceInstancesPaginator

default ListWorkspaceInstancesIterable listWorkspaceInstancesPaginator(ListWorkspaceInstancesRequest listWorkspaceInstancesRequest)
                                                                throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

This is a variant of listWorkspaceInstances(software.amazon.awssdk.services.workspacesinstances.model.ListWorkspaceInstancesRequest) 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.workspacesinstances.paginators.ListWorkspaceInstancesIterable responses = client.listWorkspaceInstancesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.workspacesinstances.paginators.ListWorkspaceInstancesIterable responses = client
             .listWorkspaceInstancesPaginator(request);
     for (software.amazon.awssdk.services.workspacesinstances.model.ListWorkspaceInstancesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.workspacesinstances.paginators.ListWorkspaceInstancesIterable responses = client.listWorkspaceInstancesPaginator(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 listWorkspaceInstances(software.amazon.awssdk.services.workspacesinstances.model.ListWorkspaceInstancesRequest) operation.

Parameters:

listWorkspaceInstancesRequest - Defines filters and pagination parameters for retrieving WorkSpaces Instances.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listWorkspaceInstancesPaginator

default ListWorkspaceInstancesIterable listWorkspaceInstancesPaginator(Consumer<ListWorkspaceInstancesRequest.Builder> listWorkspaceInstancesRequest)
                                                                throws ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

This is a variant of listWorkspaceInstances(software.amazon.awssdk.services.workspacesinstances.model.ListWorkspaceInstancesRequest) 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.workspacesinstances.paginators.ListWorkspaceInstancesIterable responses = client.listWorkspaceInstancesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.workspacesinstances.paginators.ListWorkspaceInstancesIterable responses = client
             .listWorkspaceInstancesPaginator(request);
     for (software.amazon.awssdk.services.workspacesinstances.model.ListWorkspaceInstancesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.workspacesinstances.paginators.ListWorkspaceInstancesIterable responses = client.listWorkspaceInstancesPaginator(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 listWorkspaceInstances(software.amazon.awssdk.services.workspacesinstances.model.ListWorkspaceInstancesRequest) operation.

This is a convenience which creates an instance of the ListWorkspaceInstancesRequest.Builder avoiding the need to create one manually via ListWorkspaceInstancesRequest.builder()

Parameters:

listWorkspaceInstancesRequest - A Consumer that will call methods on ListWorkspaceInstancesRequest.Builder to create a request. Defines filters and pagination parameters for retrieving WorkSpaces Instances.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

Adds tags to a WorkSpace Instance.

Parameters:

tagResourceRequest - Specifies tags to add to a WorkSpace Instance.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

Adds tags to a WorkSpace Instance.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request. Specifies tags to add to a WorkSpace Instance.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

Removes tags from a WorkSpace Instance.

Parameters:

untagResourceRequest - Specifies tags to remove from a WorkSpace Instance.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
WorkspacesInstancesException

Removes tags from a WorkSpace Instance.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request. Specifies tags to remove from a WorkSpace Instance.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

create

static WorkspacesInstancesClient create()

Create a WorkspacesInstancesClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static WorkspacesInstancesClientBuilder builder()

Create a builder that can be used to configure and create a WorkspacesInstancesClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default WorkspacesInstancesServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration