AWS.PCS — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.PCS

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using PCS

var pcs = new AWS.PCS();
pcs.createCluster(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the PCS object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var pcs = new AWS.PCS({apiVersion: '2023-02-10'});

You can also set the API version globally in AWS.config.apiVersions using the pcs service identifier:

AWS.config.apiVersions = {
  pcs: '2023-02-10',
  // other service API versions
};

var pcs = new AWS.PCS();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.PCS(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createCluster(params = {}, callback) ⇒ AWS.Request

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.

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

createComputeNodeGroup(params = {}, callback) ⇒ AWS.Request

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.

createQueue(params = {}, callback) ⇒ AWS.Request

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.

deleteCluster(params = {}, callback) ⇒ AWS.Request

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.

deleteComputeNodeGroup(params = {}, callback) ⇒ AWS.Request

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

deleteQueue(params = {}, callback) ⇒ AWS.Request

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.

getCluster(params = {}, callback) ⇒ AWS.Request

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.

getComputeNodeGroup(params = {}, callback) ⇒ AWS.Request

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.

getQueue(params = {}, callback) ⇒ AWS.Request

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

listClusters(params = {}, callback) ⇒ AWS.Request

Returns a list of running clusters in your account.

listComputeNodeGroups(params = {}, callback) ⇒ AWS.Request

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

listQueues(params = {}, callback) ⇒ AWS.Request

Returns a list of all queues associated with a cluster.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

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

registerComputeNodeGroupInstance(params = {}, callback) ⇒ AWS.Request

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.

tagResource(params = {}, callback) ⇒ AWS.Request

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.

untagResource(params = {}, callback) ⇒ AWS.Request

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.

updateComputeNodeGroup(params = {}, callback) ⇒ AWS.Request

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).

updateQueue(params = {}, callback) ⇒ AWS.Request

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.

waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given PCS resource. The final callback or'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.