# AWS PCS API Reference

> AWS Parallel Computing Service (AWS 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 AWS using Slurm. For more information, see the AWS Parallel Computing Service User Guide.

- [Welcome](https://docs.aws.amazon.com/pcs/latest/APIReference/Welcome.md)
- [Common Parameters](https://docs.aws.amazon.com/pcs/latest/APIReference/CommonParameters.md)
- [Common Error Types](https://docs.aws.amazon.com/pcs/latest/APIReference/CommonErrors.md)

## [Actions](https://docs.aws.amazon.com/pcs/latest/APIReference/API_Operations.md)

- [CreateCluster](https://docs.aws.amazon.com/pcs/latest/APIReference/API_CreateCluster.md): Creates a cluster in your account.
- [CreateComputeNodeGroup](https://docs.aws.amazon.com/pcs/latest/APIReference/API_CreateComputeNodeGroup.md): Creates a managed set of compute nodes.
- [CreateQueue](https://docs.aws.amazon.com/pcs/latest/APIReference/API_CreateQueue.md): Creates a job queue.
- [DeleteCluster](https://docs.aws.amazon.com/pcs/latest/APIReference/API_DeleteCluster.md): Deletes a cluster and all its linked resources.
- [DeleteComputeNodeGroup](https://docs.aws.amazon.com/pcs/latest/APIReference/API_DeleteComputeNodeGroup.md): Deletes a compute node group.
- [DeleteQueue](https://docs.aws.amazon.com/pcs/latest/APIReference/API_DeleteQueue.md): Deletes a job queue.
- [GetCluster](https://docs.aws.amazon.com/pcs/latest/APIReference/API_GetCluster.md): Returns detailed information about a running cluster in your account.
- [GetComputeNodeGroup](https://docs.aws.amazon.com/pcs/latest/APIReference/API_GetComputeNodeGroup.md): Returns detailed information about a compute node group.
- [GetQueue](https://docs.aws.amazon.com/pcs/latest/APIReference/API_GetQueue.md): Returns detailed information about a queue.
- [ListClusters](https://docs.aws.amazon.com/pcs/latest/APIReference/API_ListClusters.md): Returns a list of running clusters in your account.
- [ListComputeNodeGroups](https://docs.aws.amazon.com/pcs/latest/APIReference/API_ListComputeNodeGroups.md): Returns a list of all compute node groups associated with a cluster.
- [ListQueues](https://docs.aws.amazon.com/pcs/latest/APIReference/API_ListQueues.md): Returns a list of all queues associated with a cluster.
- [ListTagsForResource](https://docs.aws.amazon.com/pcs/latest/APIReference/API_ListTagsForResource.md): Returns a list of all tags on an AWS PCS resource.
- [RegisterComputeNodeGroupInstance](https://docs.aws.amazon.com/pcs/latest/APIReference/API_RegisterComputeNodeGroupInstance.md)
- [TagResource](https://docs.aws.amazon.com/pcs/latest/APIReference/API_TagResource.md): Adds or edits tags on an AWS PCS resource.
- [UntagResource](https://docs.aws.amazon.com/pcs/latest/APIReference/API_UntagResource.md): Deletes tags from an AWS PCS resource.
- [UpdateCluster](https://docs.aws.amazon.com/pcs/latest/APIReference/API_UpdateCluster.md): Updates a cluster configuration.
- [UpdateComputeNodeGroup](https://docs.aws.amazon.com/pcs/latest/APIReference/API_UpdateComputeNodeGroup.md): Updates a compute node group.
- [UpdateQueue](https://docs.aws.amazon.com/pcs/latest/APIReference/API_UpdateQueue.md): Updates the compute node group configuration of a queue.


## [Data Types](https://docs.aws.amazon.com/pcs/latest/APIReference/API_Types.md)

- [Accounting](https://docs.aws.amazon.com/pcs/latest/APIReference/API_Accounting.md): The accounting configuration includes configurable settings for Slurm accounting.
- [AccountingRequest](https://docs.aws.amazon.com/pcs/latest/APIReference/API_AccountingRequest.md): The accounting configuration includes configurable settings for Slurm accounting.
- [CgroupCustomSetting](https://docs.aws.amazon.com/pcs/latest/APIReference/API_CgroupCustomSetting.md): Additional settings that directly map to Cgroup settings.
- [Cluster](https://docs.aws.amazon.com/pcs/latest/APIReference/API_Cluster.md): The cluster resource and configuration.
- [ClusterSlurmConfiguration](https://docs.aws.amazon.com/pcs/latest/APIReference/API_ClusterSlurmConfiguration.md): Additional options related to the Slurm scheduler.
- [ClusterSlurmConfigurationRequest](https://docs.aws.amazon.com/pcs/latest/APIReference/API_ClusterSlurmConfigurationRequest.md): Additional options related to the Slurm scheduler.
- [ClusterSummary](https://docs.aws.amazon.com/pcs/latest/APIReference/API_ClusterSummary.md): The object returned by the ListClusters API action.
- [ComputeNodeGroup](https://docs.aws.amazon.com/pcs/latest/APIReference/API_ComputeNodeGroup.md): A compute node group associated with a cluster.
- [ComputeNodeGroupConfiguration](https://docs.aws.amazon.com/pcs/latest/APIReference/API_ComputeNodeGroupConfiguration.md): The compute node group configuration for a queue.
- [ComputeNodeGroupSlurmConfiguration](https://docs.aws.amazon.com/pcs/latest/APIReference/API_ComputeNodeGroupSlurmConfiguration.md): Additional options related to the Slurm scheduler.
- [ComputeNodeGroupSlurmConfigurationRequest](https://docs.aws.amazon.com/pcs/latest/APIReference/API_ComputeNodeGroupSlurmConfigurationRequest.md): Additional options related to the Slurm scheduler.
- [ComputeNodeGroupSummary](https://docs.aws.amazon.com/pcs/latest/APIReference/API_ComputeNodeGroupSummary.md): The object returned by the ListComputeNodeGroups API action.
- [CustomLaunchTemplate](https://docs.aws.amazon.com/pcs/latest/APIReference/API_CustomLaunchTemplate.md): An Amazon EC2 launch template AWS PCS uses to launch compute nodes.
- [Endpoint](https://docs.aws.amazon.com/pcs/latest/APIReference/API_Endpoint.md): An endpoint available for interaction with the scheduler.
- [ErrorInfo](https://docs.aws.amazon.com/pcs/latest/APIReference/API_ErrorInfo.md): An error that occurred during resource creation.
- [InstanceConfig](https://docs.aws.amazon.com/pcs/latest/APIReference/API_InstanceConfig.md): An EC2 instance configuration AWS PCS uses to launch compute nodes.
- [JwtAuth](https://docs.aws.amazon.com/pcs/latest/APIReference/API_JwtAuth.md): The JWT authentication configuration for Slurm REST API access.
- [JwtKey](https://docs.aws.amazon.com/pcs/latest/APIReference/API_JwtKey.md): The JWT key stored in AWS Secrets Manager for Slurm REST API authentication.
- [Networking](https://docs.aws.amazon.com/pcs/latest/APIReference/API_Networking.md): The networking configuration for the cluster's control plane.
- [NetworkingRequest](https://docs.aws.amazon.com/pcs/latest/APIReference/API_NetworkingRequest.md): The networking configuration for the cluster's control plane.
- [NodeLifecycleActions](https://docs.aws.amazon.com/pcs/latest/APIReference/API_NodeLifecycleActions.md): The lifecycle actions configured on a compute node group.
- [NodeLifecycleActionsRequest](https://docs.aws.amazon.com/pcs/latest/APIReference/API_NodeLifecycleActionsRequest.md): The lifecycle actions to configure on a compute node group when you create it.
- [NodeLifecycleScript](https://docs.aws.amazon.com/pcs/latest/APIReference/API_NodeLifecycleScript.md): A script to run during a compute node lifecycle stage.
- [NodeLifecycleStages](https://docs.aws.amazon.com/pcs/latest/APIReference/API_NodeLifecycleStages.md): The stages of a compute node's lifecycle where you can configure scripts to run.
- [Queue](https://docs.aws.amazon.com/pcs/latest/APIReference/API_Queue.md): A queue resource.
- [QueueSlurmConfiguration](https://docs.aws.amazon.com/pcs/latest/APIReference/API_QueueSlurmConfiguration.md): Additional options related to the Slurm scheduler.
- [QueueSlurmConfigurationRequest](https://docs.aws.amazon.com/pcs/latest/APIReference/API_QueueSlurmConfigurationRequest.md): Additional options related to the Slurm scheduler.
- [QueueSummary](https://docs.aws.amazon.com/pcs/latest/APIReference/API_QueueSummary.md): The object returned by the ListQueues API action.
- [ScalingConfiguration](https://docs.aws.amazon.com/pcs/latest/APIReference/API_ScalingConfiguration.md): Specifies the boundaries of the compute node group auto scaling.
- [ScalingConfigurationRequest](https://docs.aws.amazon.com/pcs/latest/APIReference/API_ScalingConfigurationRequest.md): Specifies the boundaries of the compute node group auto scaling.
- [Scheduler](https://docs.aws.amazon.com/pcs/latest/APIReference/API_Scheduler.md): The cluster management and job scheduling software associated with the cluster.
- [SchedulerRequest](https://docs.aws.amazon.com/pcs/latest/APIReference/API_SchedulerRequest.md): The cluster management and job scheduling software associated with the cluster.
- [ScriptSource](https://docs.aws.amazon.com/pcs/latest/APIReference/API_ScriptSource.md): The source location and integrity information for a node lifecycle script.
- [SlurmAuthKey](https://docs.aws.amazon.com/pcs/latest/APIReference/API_SlurmAuthKey.md): The shared Slurm key for authentication, also known as the cluster secret.
- [SlurmCustomSetting](https://docs.aws.amazon.com/pcs/latest/APIReference/API_SlurmCustomSetting.md): Additional settings that directly map to Slurm settings.
- [SlurmdbdCustomSetting](https://docs.aws.amazon.com/pcs/latest/APIReference/API_SlurmdbdCustomSetting.md): Additional settings that directly map to SlurmDBD settings.
- [SlurmRest](https://docs.aws.amazon.com/pcs/latest/APIReference/API_SlurmRest.md): The Slurm REST API configuration includes settings for enabling and configuring the Slurm REST API.
- [SlurmRestRequest](https://docs.aws.amazon.com/pcs/latest/APIReference/API_SlurmRestRequest.md): The Slurm REST API configuration includes settings for enabling and configuring the Slurm REST API.
- [SpotOptions](https://docs.aws.amazon.com/pcs/latest/APIReference/API_SpotOptions.md): Additional configuration when you specify SPOT as the purchaseOption for the CreateComputeNodeGroup API action.
- [UpdateAccountingRequest](https://docs.aws.amazon.com/pcs/latest/APIReference/API_UpdateAccountingRequest.md): The accounting configuration includes configurable settings for Slurm accounting.
- [UpdateClusterSlurmConfigurationRequest](https://docs.aws.amazon.com/pcs/latest/APIReference/API_UpdateClusterSlurmConfigurationRequest.md): Additional options related to the Slurm scheduler.
- [UpdateComputeNodeGroupSlurmConfigurationRequest](https://docs.aws.amazon.com/pcs/latest/APIReference/API_UpdateComputeNodeGroupSlurmConfigurationRequest.md): Additional options related to the Slurm scheduler.
- [UpdateNodeLifecycleActionsRequest](https://docs.aws.amazon.com/pcs/latest/APIReference/API_UpdateNodeLifecycleActionsRequest.md): The lifecycle actions to configure on a compute node group when you update it.
- [UpdateQueueSlurmConfigurationRequest](https://docs.aws.amazon.com/pcs/latest/APIReference/API_UpdateQueueSlurmConfigurationRequest.md): Additional options related to the Slurm scheduler.
- [UpdateSchedulerRequest](https://docs.aws.amazon.com/pcs/latest/APIReference/API_UpdateSchedulerRequest.md): The scheduler configuration for updating a cluster.
- [UpdateSlurmRestRequest](https://docs.aws.amazon.com/pcs/latest/APIReference/API_UpdateSlurmRestRequest.md): The Slurm REST API configuration includes settings for enabling and configuring the Slurm REST API.
- [ValidationExceptionField](https://docs.aws.amazon.com/pcs/latest/APIReference/API_ValidationExceptionField.md): Stores information about a field in a request that caused an exception.


## Full content

The entire guide is also available as a single markdown file, useful for feeding the full guide to an LLM in one pass:

- [Complete guide (single file)](https://docs.aws.amazon.com/pcs/latest/APIReference/full.md)