Slurm REST API in AWS PCS - AWS PCS
Common use casesRequirements and limitations

Slurm REST API in AWS PCS

AWS PCS provides managed support for Slurm's native REST API through slurmrestd, delivering an HTTP interface for programmatic cluster interaction. You can submit jobs, monitor cluster status, and manage resources through standard HTTP requests without requiring direct shell access to your cluster.

Common use cases

The Slurm REST API supports various integration scenarios:

  • Web Application Integration: Build custom frontends and web applications that submit and manage jobs directly.

  • Jupyter Notebook Integration: Allows researchers to submit jobs from notebook environments without leaving their development workflow.

  • Partner Solution Integration: Connect third-party HPC tools and workflow managers to your AWS PCS clusters.

  • Programmatic Cluster Management: Automate job submission, monitoring, and resource management workflows.

  • Research Computing Workflows: Support academic and enterprise research enviornments that require API-driven job management.

Requirements and limitations

Before using the Slurm REST API, review these details:

  • Your cluster must use Slurm version 25.05 or higher.

  • The API endpoint will only be accessible via private IP address within your cluster's VPC.

  • Your cluster security group must allow HTTP traffic on port 6820.

  • Authentication requires JWT tokens with specific user identity claims.

Current limitations include:

  • Tokens generated by scontrol token are not supported.

  • X-SLURM-USER-NAME header impersonation is not available.

  • Some functionality requires Slurm accounting to be enabled.

  • Not compatible with the Slurm CLI filter plugin mechanism.

  • Connections to the REST API endpoint are not encrypted with TLS.

Topics