Interface PcsAsyncClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface PcsAsyncClient extends AwsClient
Service client for accessing AWS Parallel Computing Service asynchronously. This can be created using the staticbuilder()method.The asynchronous client performs non-blocking I/O when configured with anySdkAsyncHttpClientsupported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.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 StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
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 theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
createCluster
default CompletableFuture<CreateClusterResponse> createCluster(CreateClusterRequest createClusterRequest)
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
Creatingstate until it is ready to use. There can only be 1 cluster in aCreatingstate per Amazon Web Services Region per Amazon Web Services account.CreateClusterfails with aServiceQuotaExceededExceptionif there is already a cluster in aCreatingstate.- Parameters:
createClusterRequest-- Returns:
- A Java Future containing the result of the CreateCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as
limits, are the maximum number of service resources or operations for your Amazon Web Services account.
To learn how to increase your service quota, see Requesting
a quota increase in the Service Quotas User Guide
Examples
-
The max number of clusters or queues has been reached for the account.
-
The max number of compute node groups has been reached for the associated cluster.
-
The total of
maxInstancesacross all compute node groups has been reached for associated cluster.
-
- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as
limits, are the maximum number of service resources or operations for your Amazon Web Services account.
To learn how to increase your service quota, see Requesting
a quota increase in the Service Quotas User Guide
- See Also:
- AWS API Documentation
-
createCluster
default CompletableFuture<CreateClusterResponse> createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)
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
Creatingstate until it is ready to use. There can only be 1 cluster in aCreatingstate per Amazon Web Services Region per Amazon Web Services account.CreateClusterfails with aServiceQuotaExceededExceptionif there is already a cluster in aCreatingstate.
This is a convenience which creates an instance of the
CreateClusterRequest.Builderavoiding the need to create one manually viaCreateClusterRequest.builder()- Parameters:
createClusterRequest- AConsumerthat will call methods onCreateClusterRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as
limits, are the maximum number of service resources or operations for your Amazon Web Services account.
To learn how to increase your service quota, see Requesting
a quota increase in the Service Quotas User Guide
Examples
-
The max number of clusters or queues has been reached for the account.
-
The max number of compute node groups has been reached for the associated cluster.
-
The total of
maxInstancesacross all compute node groups has been reached for associated cluster.
-
- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as
limits, are the maximum number of service resources or operations for your Amazon Web Services account.
To learn how to increase your service quota, see Requesting
a quota increase in the Service Quotas User Guide
- See Also:
- AWS API Documentation
-
createComputeNodeGroup
default CompletableFuture<CreateComputeNodeGroupResponse> createComputeNodeGroup(CreateComputeNodeGroupRequest createComputeNodeGroupRequest)
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:
- A Java Future containing the result of the CreateComputeNodeGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as
limits, are the maximum number of service resources or operations for your Amazon Web Services account.
To learn how to increase your service quota, see Requesting
a quota increase in the Service Quotas User Guide
Examples
-
The max number of clusters or queues has been reached for the account.
-
The max number of compute node groups has been reached for the associated cluster.
-
The total of
maxInstancesacross all compute node groups has been reached for associated cluster.
-
- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as
limits, are the maximum number of service resources or operations for your Amazon Web Services account.
To learn how to increase your service quota, see Requesting
a quota increase in the Service Quotas User Guide
- See Also:
- AWS API Documentation
-
createComputeNodeGroup
default CompletableFuture<CreateComputeNodeGroupResponse> createComputeNodeGroup(Consumer<CreateComputeNodeGroupRequest.Builder> createComputeNodeGroupRequest)
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.Builderavoiding the need to create one manually viaCreateComputeNodeGroupRequest.builder()- Parameters:
createComputeNodeGroupRequest- AConsumerthat will call methods onCreateComputeNodeGroupRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateComputeNodeGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as
limits, are the maximum number of service resources or operations for your Amazon Web Services account.
To learn how to increase your service quota, see Requesting
a quota increase in the Service Quotas User Guide
Examples
-
The max number of clusters or queues has been reached for the account.
-
The max number of compute node groups has been reached for the associated cluster.
-
The total of
maxInstancesacross all compute node groups has been reached for associated cluster.
-
- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as
limits, are the maximum number of service resources or operations for your Amazon Web Services account.
To learn how to increase your service quota, see Requesting
a quota increase in the Service Quotas User Guide
- See Also:
- AWS API Documentation
-
createQueue
default CompletableFuture<CreateQueueResponse> createQueue(CreateQueueRequest createQueueRequest)
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:
- A Java Future containing the result of the CreateQueue operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as
limits, are the maximum number of service resources or operations for your Amazon Web Services account.
To learn how to increase your service quota, see Requesting
a quota increase in the Service Quotas User Guide
Examples
-
The max number of clusters or queues has been reached for the account.
-
The max number of compute node groups has been reached for the associated cluster.
-
The total of
maxInstancesacross all compute node groups has been reached for associated cluster.
-
- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as
limits, are the maximum number of service resources or operations for your Amazon Web Services account.
To learn how to increase your service quota, see Requesting
a quota increase in the Service Quotas User Guide
- See Also:
- AWS API Documentation
-
createQueue
default CompletableFuture<CreateQueueResponse> createQueue(Consumer<CreateQueueRequest.Builder> createQueueRequest)
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.Builderavoiding the need to create one manually viaCreateQueueRequest.builder()- Parameters:
createQueueRequest- AConsumerthat will call methods onCreateQueueRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateQueue operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as
limits, are the maximum number of service resources or operations for your Amazon Web Services account.
To learn how to increase your service quota, see Requesting
a quota increase in the Service Quotas User Guide
Examples
-
The max number of clusters or queues has been reached for the account.
-
The max number of compute node groups has been reached for the associated cluster.
-
The total of
maxInstancesacross all compute node groups has been reached for associated cluster.
-
- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as
limits, are the maximum number of service resources or operations for your Amazon Web Services account.
To learn how to increase your service quota, see Requesting
a quota increase in the Service Quotas User Guide
- See Also:
- AWS API Documentation
-
deleteCluster
default CompletableFuture<DeleteClusterResponse> deleteCluster(DeleteClusterRequest deleteClusterRequest)
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:
- A Java Future containing the result of the DeleteCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteCluster
default CompletableFuture<DeleteClusterResponse> deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)
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.Builderavoiding the need to create one manually viaDeleteClusterRequest.builder()- Parameters:
deleteClusterRequest- AConsumerthat will call methods onDeleteClusterRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteComputeNodeGroup
default CompletableFuture<DeleteComputeNodeGroupResponse> deleteComputeNodeGroup(DeleteComputeNodeGroupRequest deleteComputeNodeGroupRequest)
Deletes a compute node group. You must delete all queues associated with the compute node group first.
- Parameters:
deleteComputeNodeGroupRequest-- Returns:
- A Java Future containing the result of the DeleteComputeNodeGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteComputeNodeGroup
default CompletableFuture<DeleteComputeNodeGroupResponse> deleteComputeNodeGroup(Consumer<DeleteComputeNodeGroupRequest.Builder> deleteComputeNodeGroupRequest)
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.Builderavoiding the need to create one manually viaDeleteComputeNodeGroupRequest.builder()- Parameters:
deleteComputeNodeGroupRequest- AConsumerthat will call methods onDeleteComputeNodeGroupRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteComputeNodeGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteQueue
default CompletableFuture<DeleteQueueResponse> deleteQueue(DeleteQueueRequest deleteQueueRequest)
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:
- A Java Future containing the result of the DeleteQueue operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteQueue
default CompletableFuture<DeleteQueueResponse> deleteQueue(Consumer<DeleteQueueRequest.Builder> deleteQueueRequest)
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.Builderavoiding the need to create one manually viaDeleteQueueRequest.builder()- Parameters:
deleteQueueRequest- AConsumerthat will call methods onDeleteQueueRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteQueue operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getCluster
default CompletableFuture<GetClusterResponse> getCluster(GetClusterRequest getClusterRequest)
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:
- A Java Future containing the result of the GetCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getCluster
default CompletableFuture<GetClusterResponse> getCluster(Consumer<GetClusterRequest.Builder> getClusterRequest)
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.Builderavoiding the need to create one manually viaGetClusterRequest.builder()- Parameters:
getClusterRequest- AConsumerthat will call methods onGetClusterRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getComputeNodeGroup
default CompletableFuture<GetComputeNodeGroupResponse> getComputeNodeGroup(GetComputeNodeGroupRequest getComputeNodeGroupRequest)
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:
- A Java Future containing the result of the GetComputeNodeGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getComputeNodeGroup
default CompletableFuture<GetComputeNodeGroupResponse> getComputeNodeGroup(Consumer<GetComputeNodeGroupRequest.Builder> getComputeNodeGroupRequest)
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.Builderavoiding the need to create one manually viaGetComputeNodeGroupRequest.builder()- Parameters:
getComputeNodeGroupRequest- AConsumerthat will call methods onGetComputeNodeGroupRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetComputeNodeGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getQueue
default CompletableFuture<GetQueueResponse> getQueue(GetQueueRequest getQueueRequest)
Returns detailed information about a queue. The information includes the compute node groups that the queue uses to schedule jobs.
- Parameters:
getQueueRequest-- Returns:
- A Java Future containing the result of the GetQueue operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getQueue
default CompletableFuture<GetQueueResponse> getQueue(Consumer<GetQueueRequest.Builder> getQueueRequest)
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.Builderavoiding the need to create one manually viaGetQueueRequest.builder()- Parameters:
getQueueRequest- AConsumerthat will call methods onGetQueueRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetQueue operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listClusters
default CompletableFuture<ListClustersResponse> listClusters(ListClustersRequest listClustersRequest)
Returns a list of running clusters in your account.
- Parameters:
listClustersRequest-- Returns:
- A Java Future containing the result of the ListClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listClusters
default CompletableFuture<ListClustersResponse> listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)
Returns a list of running clusters in your account.
This is a convenience which creates an instance of the
ListClustersRequest.Builderavoiding the need to create one manually viaListClustersRequest.builder()- Parameters:
listClustersRequest- AConsumerthat will call methods onListClustersRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listClustersPaginator
default ListClustersPublisher listClustersPaginator(ListClustersRequest listClustersRequest)
This is a variant of
listClusters(software.amazon.awssdk.services.pcs.model.ListClustersRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.pcs.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.pcs.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pcs.model.ListClustersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pcs.model.ListClustersResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listClusters(software.amazon.awssdk.services.pcs.model.ListClustersRequest)operation.- Parameters:
listClustersRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listClustersPaginator
default ListClustersPublisher listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest)
This is a variant of
listClusters(software.amazon.awssdk.services.pcs.model.ListClustersRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.pcs.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.pcs.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pcs.model.ListClustersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pcs.model.ListClustersResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listClusters(software.amazon.awssdk.services.pcs.model.ListClustersRequest)operation.
This is a convenience which creates an instance of the
ListClustersRequest.Builderavoiding the need to create one manually viaListClustersRequest.builder()- Parameters:
listClustersRequest- AConsumerthat will call methods onListClustersRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listComputeNodeGroups
default CompletableFuture<ListComputeNodeGroupsResponse> listComputeNodeGroups(ListComputeNodeGroupsRequest listComputeNodeGroupsRequest)
Returns a list of all compute node groups associated with a cluster.
- Parameters:
listComputeNodeGroupsRequest-- Returns:
- A Java Future containing the result of the ListComputeNodeGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listComputeNodeGroups
default CompletableFuture<ListComputeNodeGroupsResponse> listComputeNodeGroups(Consumer<ListComputeNodeGroupsRequest.Builder> listComputeNodeGroupsRequest)
Returns a list of all compute node groups associated with a cluster.
This is a convenience which creates an instance of the
ListComputeNodeGroupsRequest.Builderavoiding the need to create one manually viaListComputeNodeGroupsRequest.builder()- Parameters:
listComputeNodeGroupsRequest- AConsumerthat will call methods onListComputeNodeGroupsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListComputeNodeGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listComputeNodeGroupsPaginator
default ListComputeNodeGroupsPublisher listComputeNodeGroupsPaginator(ListComputeNodeGroupsRequest listComputeNodeGroupsRequest)
This is a variant of
listComputeNodeGroups(software.amazon.awssdk.services.pcs.model.ListComputeNodeGroupsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.pcs.paginators.ListComputeNodeGroupsPublisher publisher = client.listComputeNodeGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.pcs.paginators.ListComputeNodeGroupsPublisher publisher = client.listComputeNodeGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pcs.model.ListComputeNodeGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pcs.model.ListComputeNodeGroupsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listComputeNodeGroups(software.amazon.awssdk.services.pcs.model.ListComputeNodeGroupsRequest)operation.- Parameters:
listComputeNodeGroupsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listComputeNodeGroupsPaginator
default ListComputeNodeGroupsPublisher listComputeNodeGroupsPaginator(Consumer<ListComputeNodeGroupsRequest.Builder> listComputeNodeGroupsRequest)
This is a variant of
listComputeNodeGroups(software.amazon.awssdk.services.pcs.model.ListComputeNodeGroupsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.pcs.paginators.ListComputeNodeGroupsPublisher publisher = client.listComputeNodeGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.pcs.paginators.ListComputeNodeGroupsPublisher publisher = client.listComputeNodeGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pcs.model.ListComputeNodeGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pcs.model.ListComputeNodeGroupsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listComputeNodeGroups(software.amazon.awssdk.services.pcs.model.ListComputeNodeGroupsRequest)operation.
This is a convenience which creates an instance of the
ListComputeNodeGroupsRequest.Builderavoiding the need to create one manually viaListComputeNodeGroupsRequest.builder()- Parameters:
listComputeNodeGroupsRequest- AConsumerthat will call methods onListComputeNodeGroupsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listQueues
default CompletableFuture<ListQueuesResponse> listQueues(ListQueuesRequest listQueuesRequest)
Returns a list of all queues associated with a cluster.
- Parameters:
listQueuesRequest-- Returns:
- A Java Future containing the result of the ListQueues operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listQueues
default CompletableFuture<ListQueuesResponse> listQueues(Consumer<ListQueuesRequest.Builder> listQueuesRequest)
Returns a list of all queues associated with a cluster.
This is a convenience which creates an instance of the
ListQueuesRequest.Builderavoiding the need to create one manually viaListQueuesRequest.builder()- Parameters:
listQueuesRequest- AConsumerthat will call methods onListQueuesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListQueues operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listQueuesPaginator
default ListQueuesPublisher listQueuesPaginator(ListQueuesRequest listQueuesRequest)
This is a variant of
listQueues(software.amazon.awssdk.services.pcs.model.ListQueuesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.pcs.paginators.ListQueuesPublisher publisher = client.listQueuesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.pcs.paginators.ListQueuesPublisher publisher = client.listQueuesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pcs.model.ListQueuesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pcs.model.ListQueuesResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQueues(software.amazon.awssdk.services.pcs.model.ListQueuesRequest)operation.- Parameters:
listQueuesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listQueuesPaginator
default ListQueuesPublisher listQueuesPaginator(Consumer<ListQueuesRequest.Builder> listQueuesRequest)
This is a variant of
listQueues(software.amazon.awssdk.services.pcs.model.ListQueuesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.pcs.paginators.ListQueuesPublisher publisher = client.listQueuesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.pcs.paginators.ListQueuesPublisher publisher = client.listQueuesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pcs.model.ListQueuesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.pcs.model.ListQueuesResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listQueues(software.amazon.awssdk.services.pcs.model.ListQueuesRequest)operation.
This is a convenience which creates an instance of the
ListQueuesRequest.Builderavoiding the need to create one manually viaListQueuesRequest.builder()- Parameters:
listQueuesRequest- AConsumerthat will call methods onListQueuesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of all tags on an Amazon Web Services PCS resource.
- Parameters:
listTagsForResourceRequest-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
- See Also:
- AWS API Documentation
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns a list of all tags on an Amazon Web Services PCS resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
- See Also:
- AWS API Documentation
-
registerComputeNodeGroupInstance
default CompletableFuture<RegisterComputeNodeGroupInstanceResponse> registerComputeNodeGroupInstance(RegisterComputeNodeGroupInstanceRequest registerComputeNodeGroupInstanceRequest)
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:
- A Java Future containing the result of the RegisterComputeNodeGroupInstance operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
registerComputeNodeGroupInstance
default CompletableFuture<RegisterComputeNodeGroupInstanceResponse> registerComputeNodeGroupInstance(Consumer<RegisterComputeNodeGroupInstanceRequest.Builder> registerComputeNodeGroupInstanceRequest)
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.Builderavoiding the need to create one manually viaRegisterComputeNodeGroupInstanceRequest.builder()- Parameters:
registerComputeNodeGroupInstanceRequest- AConsumerthat will call methods onRegisterComputeNodeGroupInstanceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the RegisterComputeNodeGroupInstance operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
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:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
- See Also:
- AWS API Documentation
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
- See Also:
- AWS API Documentation
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
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:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
- See Also:
- AWS API Documentation
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
- See Also:
- AWS API Documentation
-
updateComputeNodeGroup
default CompletableFuture<UpdateComputeNodeGroupResponse> updateComputeNodeGroup(UpdateComputeNodeGroupRequest updateComputeNodeGroupRequest)
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:
- A Java Future containing the result of the UpdateComputeNodeGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as
limits, are the maximum number of service resources or operations for your Amazon Web Services account.
To learn how to increase your service quota, see Requesting
a quota increase in the Service Quotas User Guide
Examples
-
The max number of clusters or queues has been reached for the account.
-
The max number of compute node groups has been reached for the associated cluster.
-
The total of
maxInstancesacross all compute node groups has been reached for associated cluster.
-
- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as
limits, are the maximum number of service resources or operations for your Amazon Web Services account.
To learn how to increase your service quota, see Requesting
a quota increase in the Service Quotas User Guide
- See Also:
- AWS API Documentation
-
updateComputeNodeGroup
default CompletableFuture<UpdateComputeNodeGroupResponse> updateComputeNodeGroup(Consumer<UpdateComputeNodeGroupRequest.Builder> updateComputeNodeGroupRequest)
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.Builderavoiding the need to create one manually viaUpdateComputeNodeGroupRequest.builder()- Parameters:
updateComputeNodeGroupRequest- AConsumerthat will call methods onUpdateComputeNodeGroupRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateComputeNodeGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as
limits, are the maximum number of service resources or operations for your Amazon Web Services account.
To learn how to increase your service quota, see Requesting
a quota increase in the Service Quotas User Guide
Examples
-
The max number of clusters or queues has been reached for the account.
-
The max number of compute node groups has been reached for the associated cluster.
-
The total of
maxInstancesacross all compute node groups has been reached for associated cluster.
-
- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as
limits, are the maximum number of service resources or operations for your Amazon Web Services account.
To learn how to increase your service quota, see Requesting
a quota increase in the Service Quotas User Guide
- See Also:
- AWS API Documentation
-
updateQueue
default CompletableFuture<UpdateQueueResponse> updateQueue(UpdateQueueRequest updateQueueRequest)
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:
- A Java Future containing the result of the UpdateQueue operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as
limits, are the maximum number of service resources or operations for your Amazon Web Services account.
To learn how to increase your service quota, see Requesting
a quota increase in the Service Quotas User Guide
Examples
-
The max number of clusters or queues has been reached for the account.
-
The max number of compute node groups has been reached for the associated cluster.
-
The total of
maxInstancesacross all compute node groups has been reached for associated cluster.
-
- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as
limits, are the maximum number of service resources or operations for your Amazon Web Services account.
To learn how to increase your service quota, see Requesting
a quota increase in the Service Quotas User Guide
- See Also:
- AWS API Documentation
-
updateQueue
default CompletableFuture<UpdateQueueResponse> updateQueue(Consumer<UpdateQueueRequest.Builder> updateQueueRequest)
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.Builderavoiding the need to create one manually viaUpdateQueueRequest.builder()- Parameters:
updateQueueRequest- AConsumerthat will call methods onUpdateQueueRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateQueue operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as
limits, are the maximum number of service resources or operations for your Amazon Web Services account.
To learn how to increase your service quota, see Requesting
a quota increase in the Service Quotas User Guide
Examples
-
The max number of clusters or queues has been reached for the account.
-
The max number of compute node groups has been reached for the associated cluster.
-
The total of
maxInstancesacross all compute node groups has been reached for associated cluster.
-
- ThrottlingException Your request exceeded a request rate quota. Check the resource's request rate quota and try again.
- ValidationException The request isn't valid.
Examples
-
Your request contains malformed JSON or unsupported characters.
-
The scheduler version isn't supported.
-
There are networking related errors, such as network validation failure.
-
AMI type is
CUSTOMand the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.
-
- ConflictException Your request has conflicting operations. This can occur if you're trying to perform
more than 1 operation on the same resource at the same time.
Examples
-
A cluster with the same name already exists.
-
A cluster isn't in
ACTIVEstatus. -
A cluster to delete is in an unstable state. For example, because it still has
ACTIVEnode groups or queues. -
A queue already exists in a cluster.
-
- ResourceNotFoundException The requested resource can't be found. The cluster, node group, or queue
you're attempting to get, update, list, or delete doesn't exist.
Examples
- InternalServerException Amazon Web Services PCS can't process your request right now. Try again later.
- AccessDeniedException You don't have permission to perform the action.
Examples
-
The launch template instance profile doesn't pass
iam:PassRoleverification. -
There is a mismatch between the account ID and cluster ID.
-
The cluster ID doesn't exist.
-
The EC2 instance isn't present.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PcsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ServiceQuotaExceededException You exceeded your service quota. Service quotas, also referred to as
limits, are the maximum number of service resources or operations for your Amazon Web Services account.
To learn how to increase your service quota, see Requesting
a quota increase in the Service Quotas User Guide
- See Also:
- AWS API Documentation
-
serviceClientConfiguration
default PcsServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
create
static PcsAsyncClient create()
Create aPcsAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static PcsAsyncClientBuilder builder()
Create a builder that can be used to configure and create aPcsAsyncClient.
-
-