Amazon Web Services, Inc.

AWS Parallel Computing Service

Parallel Computing Service (PCS) is a managed service that makes it easier for you to run and scale your high performance computing (HPC) workloads, and build…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Parallel Computing Service (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 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 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 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 PCS compute node is an Amazon EC2 instance. You don't launch compute nodes directly. 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. PCS automatically terminates your compute nodes when you delete the PCS resources related to those compute nodes.

Endpoints 19

Cluster

  • POSTCreate cluster/#X-Amz-Target=AWSParallelComputingService.CreateClusterCreates a cluster in your account. PCS creates the cluster controller in a service-owned account. The cluster controller communicates with the cluster…
  • POSTDelete cluster/#X-Amz-Target=AWSParallelComputingService.DeleteClusterDeletes 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…
  • POSTGet cluster/#X-Amz-Target=AWSParallelComputingService.GetClusterReturns detailed information about a running cluster in your account. This API action provides networking information, endpoint information for communication…
  • POSTList clusters/#X-Amz-Target=AWSParallelComputingService.ListClustersReturns a list of running clusters in your account.
  • POSTRegister compute node group instance/#X-Amz-Target=AWSParallelComputingService.RegisterComputeNodeGroupInstanceThis API action isn't intended for you to use. PCS uses this API action to register the compute nodes it launches in your account.
  • POSTUpdate cluster/#X-Amz-Target=AWSParallelComputingService.UpdateClusterUpdates a cluster configuration. You can update the scheduler version, modify scheduler settings, and update accounting configuration for an existing cluster.…

Compute node group

  • POSTCreate compute node group/#X-Amz-Target=AWSParallelComputingService.CreateComputeNodeGroupCreates a managed set of compute nodes. You associate a compute node group with a cluster through 1 or more PCS queues or as part of the login fleet. A…
  • POSTDelete compute node group/#X-Amz-Target=AWSParallelComputingService.DeleteComputeNodeGroupDeletes a compute node group. You must delete all queues associated with the compute node group first.
  • POSTGet compute node group/#X-Amz-Target=AWSParallelComputingService.GetComputeNodeGroupReturns detailed information about a compute node group. This API action provides networking information, EC2 instance type, compute node group status, and…
  • POSTList compute node groups/#X-Amz-Target=AWSParallelComputingService.ListComputeNodeGroupsReturns a list of all compute node groups associated with a cluster.
  • POSTUpdate compute node group/#X-Amz-Target=AWSParallelComputingService.UpdateComputeNodeGroupUpdates a compute node group. You can update many of the fields related to your compute node group including the configurations for networking, compute nodes,…

Queue

  • POSTCreate queue/#X-Amz-Target=AWSParallelComputingService.CreateQueueCreates 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.
  • POSTDelete queue/#X-Amz-Target=AWSParallelComputingService.DeleteQueueDeletes a job queue. If the compute node group associated with this queue isn't associated with any other queues, PCS terminates all the compute nodes for…
  • POSTGet queue/#X-Amz-Target=AWSParallelComputingService.GetQueueReturns detailed information about a queue. The information includes the compute node groups that the queue uses to schedule jobs.
  • POSTList queues/#X-Amz-Target=AWSParallelComputingService.ListQueuesReturns a list of all queues associated with a cluster.
  • POSTUpdate queue/#X-Amz-Target=AWSParallelComputingService.UpdateQueueUpdates the compute node group configuration of a queue. Use this API to change the compute node groups that the queue can send jobs to.
  • POSTList tags for resource/#X-Amz-Target=AWSParallelComputingService.ListTagsForResourceReturns a list of all tags on an PCS resource.
  • POSTTag resource/#X-Amz-Target=AWSParallelComputingService.TagResourceAdds or edits tags on an 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…
  • POSTUntag resource/#X-Amz-Target=AWSParallelComputingService.UntagResourceDeletes tags from an PCS resource. To delete a tag, specify the tag key and the Amazon Resource Name (ARN) of the PCS resource.

API details

Base URL
https://pcs.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
19 operations on 19 pathsPOST 19
Main resources
Cluster 6Compute node group 5Queue 5
Description format
AWS Smithy model, API version 2023-02-10

How to test the AWS Parallel Computing Service in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Parallel Computing Service collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create cluster” (POST /#X-Amz-Target=AWSParallelComputingService.CreateCluster), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS Parallel Computing Service?

Parallel Computing Service (PCS) is a managed service that makes it easier for you to run and scale your high performance computing (HPC) workloads, and build… It is listed under Developer tools and has 19 endpoints.

Who publishes the AWS Parallel Computing Service?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS Parallel Computing Service?

Requests go to https://pcs.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS Parallel Computing Service?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS Parallel Computing Service have?

19 operations on 19 paths (19 POST). The largest groups are Cluster, Compute node group, Queue.

Is forking the AWS Parallel Computing Service free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.