Interface PcsClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

Service client for accessing AWS Parallel Computing Service. This can be created using the static builder() method.

Amazon Web Services Parallel Computing Service (Amazon Web Services PCS) is a managed service that makes it easier for you to run and scale your high performance computing (HPC) workloads, and build scientific and engineering models on Amazon Web Services using Slurm. For more information, see the Amazon Web Services Parallel Computing Service User Guide.

This reference describes the actions and data types of the service management API. You can use the Amazon Web Services SDKs to call the API actions in software, or use the Command Line Interface (CLI) to call the API actions manually. These API actions manage the service through an Amazon Web Services account.

The API actions operate on Amazon Web Services PCS resources. A resource is an entity in Amazon Web Services that you can work with. Amazon Web Services services create resources when you use the features of the service. Examples of Amazon Web Services PCS resources include clusters, compute node groups, and queues. For more information about resources in Amazon Web Services, see Resource in the Resource Explorer User Guide.

An Amazon Web Services PCS compute node is an Amazon EC2 instance. You don't launch compute nodes directly. Amazon Web Services PCS uses configuration information that you provide to launch compute nodes in your Amazon Web Services account. You receive billing charges for your running compute nodes. Amazon Web Services PCS automatically terminates your compute nodes when you delete the Amazon Web Services PCS resources related to those compute nodes.

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
static PcsClientBuilder	builder()	Create a builder that can be used to configure and create a PcsClient.
static PcsClient	create()	Create a PcsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateClusterResponse	createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)	Creates a cluster in your account.
default CreateClusterResponse	createCluster(CreateClusterRequest createClusterRequest)	Creates a cluster in your account.
default CreateComputeNodeGroupResponse	createComputeNodeGroup(Consumer<CreateComputeNodeGroupRequest.Builder> createComputeNodeGroupRequest)	Creates a managed set of compute nodes.
default CreateComputeNodeGroupResponse	createComputeNodeGroup(CreateComputeNodeGroupRequest createComputeNodeGroupRequest)	Creates a managed set of compute nodes.
default CreateQueueResponse	createQueue(Consumer<CreateQueueRequest.Builder> createQueueRequest)	Creates a job queue.
default CreateQueueResponse	createQueue(CreateQueueRequest createQueueRequest)	Creates a job queue.
default DeleteClusterResponse	deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)	Deletes a cluster and all its linked resources.
default DeleteClusterResponse	deleteCluster(DeleteClusterRequest deleteClusterRequest)	Deletes a cluster and all its linked resources.
default DeleteComputeNodeGroupResponse	deleteComputeNodeGroup(Consumer<DeleteComputeNodeGroupRequest.Builder> deleteComputeNodeGroupRequest)	Deletes a compute node group.
default DeleteComputeNodeGroupResponse	deleteComputeNodeGroup(DeleteComputeNodeGroupRequest deleteComputeNodeGroupRequest)	Deletes a compute node group.
default DeleteQueueResponse	deleteQueue(Consumer<DeleteQueueRequest.Builder> deleteQueueRequest)	Deletes a job queue.
default DeleteQueueResponse	deleteQueue(DeleteQueueRequest deleteQueueRequest)	Deletes a job queue.
default GetClusterResponse	getCluster(Consumer<GetClusterRequest.Builder> getClusterRequest)	Returns detailed information about a running cluster in your account.
default GetClusterResponse	getCluster(GetClusterRequest getClusterRequest)	Returns detailed information about a running cluster in your account.
default GetComputeNodeGroupResponse	getComputeNodeGroup(Consumer<GetComputeNodeGroupRequest.Builder> getComputeNodeGroupRequest)	Returns detailed information about a compute node group.
default GetComputeNodeGroupResponse	getComputeNodeGroup(GetComputeNodeGroupRequest getComputeNodeGroupRequest)	Returns detailed information about a compute node group.
default GetQueueResponse	getQueue(Consumer<GetQueueRequest.Builder> getQueueRequest)	Returns detailed information about a queue.
default GetQueueResponse	getQueue(GetQueueRequest getQueueRequest)	Returns detailed information about a queue.
default ListClustersResponse	listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)	Returns a list of running clusters in your account.
default ListClustersResponse	listClusters(ListClustersRequest listClustersRequest)	Returns a list of running clusters in your account.
default ListClustersIterable	listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest)	This is a variant of listClusters(software.amazon.awssdk.services.pcs.model.ListClustersRequest) operation.
default ListClustersIterable	listClustersPaginator(ListClustersRequest listClustersRequest)	This is a variant of listClusters(software.amazon.awssdk.services.pcs.model.ListClustersRequest) operation.
default ListComputeNodeGroupsResponse	listComputeNodeGroups(Consumer<ListComputeNodeGroupsRequest.Builder> listComputeNodeGroupsRequest)	Returns a list of all compute node groups associated with a cluster.
default ListComputeNodeGroupsResponse	listComputeNodeGroups(ListComputeNodeGroupsRequest listComputeNodeGroupsRequest)	Returns a list of all compute node groups associated with a cluster.
default ListComputeNodeGroupsIterable	listComputeNodeGroupsPaginator(Consumer<ListComputeNodeGroupsRequest.Builder> listComputeNodeGroupsRequest)	This is a variant of listComputeNodeGroups(software.amazon.awssdk.services.pcs.model.ListComputeNodeGroupsRequest) operation.
default ListComputeNodeGroupsIterable	listComputeNodeGroupsPaginator(ListComputeNodeGroupsRequest listComputeNodeGroupsRequest)	This is a variant of listComputeNodeGroups(software.amazon.awssdk.services.pcs.model.ListComputeNodeGroupsRequest) operation.
default ListQueuesResponse	listQueues(Consumer<ListQueuesRequest.Builder> listQueuesRequest)	Returns a list of all queues associated with a cluster.
default ListQueuesResponse	listQueues(ListQueuesRequest listQueuesRequest)	Returns a list of all queues associated with a cluster.
default ListQueuesIterable	listQueuesPaginator(Consumer<ListQueuesRequest.Builder> listQueuesRequest)	This is a variant of listQueues(software.amazon.awssdk.services.pcs.model.ListQueuesRequest) operation.
default ListQueuesIterable	listQueuesPaginator(ListQueuesRequest listQueuesRequest)	This is a variant of listQueues(software.amazon.awssdk.services.pcs.model.ListQueuesRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Returns a list of all tags on an Amazon Web Services PCS resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Returns a list of all tags on an Amazon Web Services PCS resource.
default RegisterComputeNodeGroupInstanceResponse	registerComputeNodeGroupInstance(Consumer<RegisterComputeNodeGroupInstanceRequest.Builder> registerComputeNodeGroupInstanceRequest)
default RegisterComputeNodeGroupInstanceResponse	registerComputeNodeGroupInstance(RegisterComputeNodeGroupInstanceRequest registerComputeNodeGroupInstanceRequest)
default PcsServiceClientConfiguration	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 or edits tags on an Amazon Web Services PCS resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds or edits tags on an Amazon Web Services PCS resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Deletes tags from an Amazon Web Services PCS resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Deletes tags from an Amazon Web Services PCS resource.
default UpdateComputeNodeGroupResponse	updateComputeNodeGroup(Consumer<UpdateComputeNodeGroupRequest.Builder> updateComputeNodeGroupRequest)	Updates a compute node group.
default UpdateComputeNodeGroupResponse	updateComputeNodeGroup(UpdateComputeNodeGroupRequest updateComputeNodeGroupRequest)	Updates a compute node group.
default UpdateQueueResponse	updateQueue(Consumer<UpdateQueueRequest.Builder> updateQueueRequest)	Updates the compute node group configuration of a queue.
default UpdateQueueResponse	updateQueue(UpdateQueueRequest updateQueueRequest)	Updates the compute node group configuration of a queue.

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

createCluster

default CreateClusterResponse createCluster(CreateClusterRequest createClusterRequest)
                                     throws ServiceQuotaExceededException,
ThrottlingException,
ValidationException,
ConflictException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

Creates a cluster in your account. Amazon Web Services PCS creates the cluster controller in a service-owned account. The cluster controller communicates with the cluster resources in your account. The subnets and security groups for the cluster must already exist before you use this API action.

It takes time for Amazon Web Services PCS to create the cluster. The cluster is in a Creating state until it is ready to use. There can only be 1 cluster in a Creating state per Amazon Web Services Region per Amazon Web Services account. CreateCluster fails with a ServiceQuotaExceededException if there is already a cluster in a Creating state.

Parameters:

createClusterRequest -

Returns:

Result of the CreateCluster operation returned by the service.

See Also:

• AWS API Documentation

createCluster

default CreateClusterResponse createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)
                                     throws ServiceQuotaExceededException,
ThrottlingException,
ValidationException,
ConflictException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

Creates a cluster in your account. Amazon Web Services PCS creates the cluster controller in a service-owned account. The cluster controller communicates with the cluster resources in your account. The subnets and security groups for the cluster must already exist before you use this API action.

It takes time for Amazon Web Services PCS to create the cluster. The cluster is in a Creating state until it is ready to use. There can only be 1 cluster in a Creating state per Amazon Web Services Region per Amazon Web Services account. CreateCluster fails with a ServiceQuotaExceededException if there is already a cluster in a Creating state.

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

Parameters:

createClusterRequest - A Consumer that will call methods on CreateClusterRequest.Builder to create a request.

Returns:

Result of the CreateCluster operation returned by the service.

See Also:

• AWS API Documentation

createComputeNodeGroup

default CreateComputeNodeGroupResponse createComputeNodeGroup(CreateComputeNodeGroupRequest createComputeNodeGroupRequest)
                                                       throws ServiceQuotaExceededException,
ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

Creates a managed set of compute nodes. You associate a compute node group with a cluster through 1 or more Amazon Web Services PCS queues or as part of the login fleet. A compute node group includes the definition of the compute properties and lifecycle management. Amazon Web Services PCS uses the information you provide to this API action to launch compute nodes in your account. You can only specify subnets in the same Amazon VPC as your cluster. You receive billing charges for the compute nodes that Amazon Web Services PCS launches in your account. You must already have a launch template before you call this API. For more information, see Launch an instance from a launch template in the Amazon Elastic Compute Cloud User Guide for Linux Instances.

Parameters:

createComputeNodeGroupRequest -

Returns:

Result of the CreateComputeNodeGroup operation returned by the service.

See Also:

• AWS API Documentation

createComputeNodeGroup

default CreateComputeNodeGroupResponse createComputeNodeGroup(Consumer<CreateComputeNodeGroupRequest.Builder> createComputeNodeGroupRequest)
                                                       throws ServiceQuotaExceededException,
ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

Creates a managed set of compute nodes. You associate a compute node group with a cluster through 1 or more Amazon Web Services PCS queues or as part of the login fleet. A compute node group includes the definition of the compute properties and lifecycle management. Amazon Web Services PCS uses the information you provide to this API action to launch compute nodes in your account. You can only specify subnets in the same Amazon VPC as your cluster. You receive billing charges for the compute nodes that Amazon Web Services PCS launches in your account. You must already have a launch template before you call this API. For more information, see Launch an instance from a launch template in the Amazon Elastic Compute Cloud User Guide for Linux Instances.

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

Parameters:

createComputeNodeGroupRequest - A Consumer that will call methods on CreateComputeNodeGroupRequest.Builder to create a request.

Returns:

Result of the CreateComputeNodeGroup operation returned by the service.

See Also:

• AWS API Documentation

createQueue

default CreateQueueResponse createQueue(CreateQueueRequest createQueueRequest)
                                 throws ServiceQuotaExceededException,
ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

Creates a job queue. You must associate 1 or more compute node groups with the queue. You can associate 1 compute node group with multiple queues.

Parameters:

createQueueRequest -

Returns:

Result of the CreateQueue operation returned by the service.

See Also:

• AWS API Documentation

createQueue

default CreateQueueResponse createQueue(Consumer<CreateQueueRequest.Builder> createQueueRequest)
                                 throws ServiceQuotaExceededException,
ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

Creates a job queue. You must associate 1 or more compute node groups with the queue. You can associate 1 compute node group with multiple queues.

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

Parameters:

createQueueRequest - A Consumer that will call methods on CreateQueueRequest.Builder to create a request.

Returns:

Result of the CreateQueue operation returned by the service.

See Also:

• AWS API Documentation

deleteCluster

default DeleteClusterResponse deleteCluster(DeleteClusterRequest deleteClusterRequest)
                                     throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

Deletes a cluster and all its linked resources. You must delete all queues and compute node groups associated with the cluster before you can delete the cluster.

Parameters:

deleteClusterRequest -

Returns:

Result of the DeleteCluster operation returned by the service.

See Also:

• AWS API Documentation

deleteCluster

default DeleteClusterResponse deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)
                                     throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

Deletes a cluster and all its linked resources. You must delete all queues and compute node groups associated with the cluster before you can delete the cluster.

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

Parameters:

deleteClusterRequest - A Consumer that will call methods on DeleteClusterRequest.Builder to create a request.

Returns:

Result of the DeleteCluster operation returned by the service.

See Also:

• AWS API Documentation

deleteComputeNodeGroup

default DeleteComputeNodeGroupResponse deleteComputeNodeGroup(DeleteComputeNodeGroupRequest deleteComputeNodeGroupRequest)
                                                       throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

Deletes a compute node group. You must delete all queues associated with the compute node group first.

Parameters:

deleteComputeNodeGroupRequest -

Returns:

Result of the DeleteComputeNodeGroup operation returned by the service.

See Also:

• AWS API Documentation

deleteComputeNodeGroup

default DeleteComputeNodeGroupResponse deleteComputeNodeGroup(Consumer<DeleteComputeNodeGroupRequest.Builder> deleteComputeNodeGroupRequest)
                                                       throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

Deletes a compute node group. You must delete all queues associated with the compute node group first.

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

Parameters:

deleteComputeNodeGroupRequest - A Consumer that will call methods on DeleteComputeNodeGroupRequest.Builder to create a request.

Returns:

Result of the DeleteComputeNodeGroup operation returned by the service.

See Also:

• AWS API Documentation

deleteQueue

default DeleteQueueResponse deleteQueue(DeleteQueueRequest deleteQueueRequest)
                                 throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

Deletes a job queue. If the compute node group associated with this queue isn't associated with any other queues, Amazon Web Services PCS terminates all the compute nodes for this queue.

Parameters:

deleteQueueRequest -

Returns:

Result of the DeleteQueue operation returned by the service.

See Also:

• AWS API Documentation

deleteQueue

default DeleteQueueResponse deleteQueue(Consumer<DeleteQueueRequest.Builder> deleteQueueRequest)
                                 throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

Deletes a job queue. If the compute node group associated with this queue isn't associated with any other queues, Amazon Web Services PCS terminates all the compute nodes for this queue.

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

Parameters:

deleteQueueRequest - A Consumer that will call methods on DeleteQueueRequest.Builder to create a request.

Returns:

Result of the DeleteQueue operation returned by the service.

See Also:

• AWS API Documentation

getCluster

default GetClusterResponse getCluster(GetClusterRequest getClusterRequest)
                               throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

Returns detailed information about a running cluster in your account. This API action provides networking information, endpoint information for communication with the scheduler, and provisioning status.

Parameters:

getClusterRequest -

Returns:

Result of the GetCluster operation returned by the service.

See Also:

• AWS API Documentation

getCluster

default GetClusterResponse getCluster(Consumer<GetClusterRequest.Builder> getClusterRequest)
                               throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

Returns detailed information about a running cluster in your account. This API action provides networking information, endpoint information for communication with the scheduler, and provisioning status.

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

Parameters:

getClusterRequest - A Consumer that will call methods on GetClusterRequest.Builder to create a request.

Returns:

Result of the GetCluster operation returned by the service.

See Also:

• AWS API Documentation

getComputeNodeGroup

default GetComputeNodeGroupResponse getComputeNodeGroup(GetComputeNodeGroupRequest getComputeNodeGroupRequest)
                                                 throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

Returns detailed information about a compute node group. This API action provides networking information, EC2 instance type, compute node group status, and scheduler (such as Slurm) configuration.

Parameters:

getComputeNodeGroupRequest -

Returns:

Result of the GetComputeNodeGroup operation returned by the service.

See Also:

• AWS API Documentation

getComputeNodeGroup

default GetComputeNodeGroupResponse getComputeNodeGroup(Consumer<GetComputeNodeGroupRequest.Builder> getComputeNodeGroupRequest)
                                                 throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

Returns detailed information about a compute node group. This API action provides networking information, EC2 instance type, compute node group status, and scheduler (such as Slurm) configuration.

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

Parameters:

getComputeNodeGroupRequest - A Consumer that will call methods on GetComputeNodeGroupRequest.Builder to create a request.

Returns:

Result of the GetComputeNodeGroup operation returned by the service.

See Also:

• AWS API Documentation

getQueue

default GetQueueResponse getQueue(GetQueueRequest getQueueRequest)
                           throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

Returns detailed information about a queue. The information includes the compute node groups that the queue uses to schedule jobs.

Parameters:

getQueueRequest -

Returns:

Result of the GetQueue operation returned by the service.

See Also:

• AWS API Documentation

getQueue

default GetQueueResponse getQueue(Consumer<GetQueueRequest.Builder> getQueueRequest)
                           throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

Returns detailed information about a queue. The information includes the compute node groups that the queue uses to schedule jobs.

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

Parameters:

getQueueRequest - A Consumer that will call methods on GetQueueRequest.Builder to create a request.

Returns:

Result of the GetQueue operation returned by the service.

See Also:

• AWS API Documentation

listClusters

default ListClustersResponse listClusters(ListClustersRequest listClustersRequest)
                                   throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

Returns a list of running clusters in your account.

Parameters:

listClustersRequest -

Returns:

Result of the ListClusters operation returned by the service.

See Also:

• AWS API Documentation

listClusters

default ListClustersResponse listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)
                                   throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

Returns a list of running clusters in your account.

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

Parameters:

listClustersRequest - A Consumer that will call methods on ListClustersRequest.Builder to create a request.

Returns:

Result of the ListClusters operation returned by the service.

See Also:

• AWS API Documentation

listClustersPaginator

default ListClustersIterable listClustersPaginator(ListClustersRequest listClustersRequest)
                                            throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

This is a variant of listClusters(software.amazon.awssdk.services.pcs.model.ListClustersRequest) 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.pcs.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.pcs.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
     for (software.amazon.awssdk.services.pcs.model.ListClustersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.pcs.paginators.ListClustersIterable responses = client.listClustersPaginator(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 listClusters(software.amazon.awssdk.services.pcs.model.ListClustersRequest) operation.

Parameters:

listClustersRequest -

Returns:

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

See Also:

• AWS API Documentation

listClustersPaginator

default ListClustersIterable listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest)
                                            throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

This is a variant of listClusters(software.amazon.awssdk.services.pcs.model.ListClustersRequest) 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.pcs.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.pcs.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
     for (software.amazon.awssdk.services.pcs.model.ListClustersResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.pcs.paginators.ListClustersIterable responses = client.listClustersPaginator(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 listClusters(software.amazon.awssdk.services.pcs.model.ListClustersRequest) operation.

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

Parameters:

listClustersRequest - A Consumer that will call methods on ListClustersRequest.Builder to create a request.

Returns:

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

See Also:

• AWS API Documentation

listComputeNodeGroups

default ListComputeNodeGroupsResponse listComputeNodeGroups(ListComputeNodeGroupsRequest listComputeNodeGroupsRequest)
                                                     throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

Returns a list of all compute node groups associated with a cluster.

Parameters:

listComputeNodeGroupsRequest -

Returns:

Result of the ListComputeNodeGroups operation returned by the service.

See Also:

• AWS API Documentation

listComputeNodeGroups

default ListComputeNodeGroupsResponse listComputeNodeGroups(Consumer<ListComputeNodeGroupsRequest.Builder> listComputeNodeGroupsRequest)
                                                     throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

Returns a list of all compute node groups associated with a cluster.

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

Parameters:

listComputeNodeGroupsRequest - A Consumer that will call methods on ListComputeNodeGroupsRequest.Builder to create a request.

Returns:

Result of the ListComputeNodeGroups operation returned by the service.

See Also:

• AWS API Documentation

listComputeNodeGroupsPaginator

default ListComputeNodeGroupsIterable listComputeNodeGroupsPaginator(ListComputeNodeGroupsRequest listComputeNodeGroupsRequest)
                                                              throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

This is a variant of listComputeNodeGroups(software.amazon.awssdk.services.pcs.model.ListComputeNodeGroupsRequest) 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.pcs.paginators.ListComputeNodeGroupsIterable responses = client.listComputeNodeGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.pcs.paginators.ListComputeNodeGroupsIterable responses = client
             .listComputeNodeGroupsPaginator(request);
     for (software.amazon.awssdk.services.pcs.model.ListComputeNodeGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.pcs.paginators.ListComputeNodeGroupsIterable responses = client.listComputeNodeGroupsPaginator(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 listComputeNodeGroups(software.amazon.awssdk.services.pcs.model.ListComputeNodeGroupsRequest) operation.

Parameters:

listComputeNodeGroupsRequest -

Returns:

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

See Also:

• AWS API Documentation

listComputeNodeGroupsPaginator

default ListComputeNodeGroupsIterable listComputeNodeGroupsPaginator(Consumer<ListComputeNodeGroupsRequest.Builder> listComputeNodeGroupsRequest)
                                                              throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

This is a variant of listComputeNodeGroups(software.amazon.awssdk.services.pcs.model.ListComputeNodeGroupsRequest) 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.pcs.paginators.ListComputeNodeGroupsIterable responses = client.listComputeNodeGroupsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.pcs.paginators.ListComputeNodeGroupsIterable responses = client
             .listComputeNodeGroupsPaginator(request);
     for (software.amazon.awssdk.services.pcs.model.ListComputeNodeGroupsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.pcs.paginators.ListComputeNodeGroupsIterable responses = client.listComputeNodeGroupsPaginator(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 listComputeNodeGroups(software.amazon.awssdk.services.pcs.model.ListComputeNodeGroupsRequest) operation.

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

Parameters:

listComputeNodeGroupsRequest - A Consumer that will call methods on ListComputeNodeGroupsRequest.Builder to create a request.

Returns:

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

See Also:

• AWS API Documentation

listQueues

default ListQueuesResponse listQueues(ListQueuesRequest listQueuesRequest)
                               throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

Returns a list of all queues associated with a cluster.

Parameters:

listQueuesRequest -

Returns:

Result of the ListQueues operation returned by the service.

See Also:

• AWS API Documentation

listQueues

default ListQueuesResponse listQueues(Consumer<ListQueuesRequest.Builder> listQueuesRequest)
                               throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

Returns a list of all queues associated with a cluster.

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

Parameters:

listQueuesRequest - A Consumer that will call methods on ListQueuesRequest.Builder to create a request.

Returns:

Result of the ListQueues operation returned by the service.

See Also:

• AWS API Documentation

listQueuesPaginator

default ListQueuesIterable listQueuesPaginator(ListQueuesRequest listQueuesRequest)
                                        throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

This is a variant of listQueues(software.amazon.awssdk.services.pcs.model.ListQueuesRequest) 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.pcs.paginators.ListQueuesIterable responses = client.listQueuesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.pcs.paginators.ListQueuesIterable responses = client.listQueuesPaginator(request);
     for (software.amazon.awssdk.services.pcs.model.ListQueuesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.pcs.paginators.ListQueuesIterable responses = client.listQueuesPaginator(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 listQueues(software.amazon.awssdk.services.pcs.model.ListQueuesRequest) operation.

Parameters:

listQueuesRequest -

Returns:

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

See Also:

• AWS API Documentation

listQueuesPaginator

default ListQueuesIterable listQueuesPaginator(Consumer<ListQueuesRequest.Builder> listQueuesRequest)
                                        throws ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

This is a variant of listQueues(software.amazon.awssdk.services.pcs.model.ListQueuesRequest) 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.pcs.paginators.ListQueuesIterable responses = client.listQueuesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.pcs.paginators.ListQueuesIterable responses = client.listQueuesPaginator(request);
     for (software.amazon.awssdk.services.pcs.model.ListQueuesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.pcs.paginators.ListQueuesIterable responses = client.listQueuesPaginator(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 listQueues(software.amazon.awssdk.services.pcs.model.ListQueuesRequest) operation.

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

Parameters:

listQueuesRequest - A Consumer that will call methods on ListQueuesRequest.Builder to create a request.

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 ResourceNotFoundException,
AwsServiceException,
SdkClientException,
PcsException

Returns a list of all tags on an Amazon Web Services PCS resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
AwsServiceException,
SdkClientException,
PcsException

Returns a list of all tags on an Amazon Web Services PCS resource.

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.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

registerComputeNodeGroupInstance

default RegisterComputeNodeGroupInstanceResponse registerComputeNodeGroupInstance(RegisterComputeNodeGroupInstanceRequest registerComputeNodeGroupInstanceRequest)
                                                                           throws InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

This API action isn't intended for you to use.

Amazon Web Services PCS uses this API action to register the compute nodes it launches in your account.

Parameters:

registerComputeNodeGroupInstanceRequest -

Returns:

Result of the RegisterComputeNodeGroupInstance operation returned by the service.

See Also:

• AWS API Documentation

registerComputeNodeGroupInstance

default RegisterComputeNodeGroupInstanceResponse registerComputeNodeGroupInstance(Consumer<RegisterComputeNodeGroupInstanceRequest.Builder> registerComputeNodeGroupInstanceRequest)
                                                                           throws InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

This API action isn't intended for you to use.

Amazon Web Services PCS uses this API action to register the compute nodes it launches in your account.

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

Parameters:

registerComputeNodeGroupInstanceRequest - A Consumer that will call methods on RegisterComputeNodeGroupInstanceRequest.Builder to create a request.

Returns:

Result of the RegisterComputeNodeGroupInstance operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ServiceQuotaExceededException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
PcsException

Adds or edits tags on an Amazon Web Services PCS resource. Each tag consists of a tag key and a tag value. The tag key and tag value are case-sensitive strings. The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ServiceQuotaExceededException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
PcsException

Adds or edits tags on an Amazon Web Services PCS resource. Each tag consists of a tag key and a tag value. The tag key and tag value are case-sensitive strings. The tag value can be an empty (null) string. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value.

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.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ResourceNotFoundException,
AwsServiceException,
SdkClientException,
PcsException

Deletes tags from an Amazon Web Services PCS resource. To delete a tag, specify the tag key and the Amazon Resource Name (ARN) of the Amazon Web Services PCS resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ResourceNotFoundException,
AwsServiceException,
SdkClientException,
PcsException

Deletes tags from an Amazon Web Services PCS resource. To delete a tag, specify the tag key and the Amazon Resource Name (ARN) of the Amazon Web Services PCS resource.

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.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateComputeNodeGroup

default UpdateComputeNodeGroupResponse updateComputeNodeGroup(UpdateComputeNodeGroupRequest updateComputeNodeGroupRequest)
                                                       throws ServiceQuotaExceededException,
ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

Updates a compute node group. You can update many of the fields related to your compute node group including the configurations for networking, compute nodes, and settings specific to your scheduler (such as Slurm).

Parameters:

updateComputeNodeGroupRequest -

Returns:

Result of the UpdateComputeNodeGroup operation returned by the service.

See Also:

• AWS API Documentation

updateComputeNodeGroup

default UpdateComputeNodeGroupResponse updateComputeNodeGroup(Consumer<UpdateComputeNodeGroupRequest.Builder> updateComputeNodeGroupRequest)
                                                       throws ServiceQuotaExceededException,
ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

Updates a compute node group. You can update many of the fields related to your compute node group including the configurations for networking, compute nodes, and settings specific to your scheduler (such as Slurm).

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

Parameters:

updateComputeNodeGroupRequest - A Consumer that will call methods on UpdateComputeNodeGroupRequest.Builder to create a request.

Returns:

Result of the UpdateComputeNodeGroup operation returned by the service.

See Also:

• AWS API Documentation

updateQueue

default UpdateQueueResponse updateQueue(UpdateQueueRequest updateQueueRequest)
                                 throws ServiceQuotaExceededException,
ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

Updates the compute node group configuration of a queue. Use this API to change the compute node groups that the queue can send jobs to.

Parameters:

updateQueueRequest -

Returns:

Result of the UpdateQueue operation returned by the service.

See Also:

• AWS API Documentation

updateQueue

default UpdateQueueResponse updateQueue(Consumer<UpdateQueueRequest.Builder> updateQueueRequest)
                                 throws ServiceQuotaExceededException,
ThrottlingException,
ValidationException,
ConflictException,
ResourceNotFoundException,
InternalServerException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
PcsException

Updates the compute node group configuration of a queue. Use this API to change the compute node groups that the queue can send jobs to.

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

Parameters:

updateQueueRequest - A Consumer that will call methods on UpdateQueueRequest.Builder to create a request.

Returns:

Result of the UpdateQueue operation returned by the service.

See Also:

• AWS API Documentation

create

static PcsClient create()

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

builder

static PcsClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default PcsServiceClientConfiguration 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