Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Amazon ParallelCluster API

What is Amazon ParallelCluster API?

Amazon ParallelCluster API is a serverless application that, once deployed to your Amazon Web Services account, provides programmatic access to Amazon ParallelCluster features through an API.

Amazon ParallelCluster API is distributed as a self-contained Amazon CloudFormation template that includes an Amazon API Gateway endpoint, that exposes Amazon ParallelCluster features, and an Amazon Lambda function, that takes care of processing the invoked features.

The following image shows a high-level architecture diagram of the Amazon ParallelCluster API infrastructure.

Amazon ParallelCluster API Documentation

The OpenAPI specification file that describes the Amazon ParallelCluster API can be downloaded from:

https://<REGION>-aws-parallelcluster.s3.<REGION>.amazonaws.com/parallelcluster/<VERSION>/api/ParallelCluster.openapi.yaml

Starting from the OpenAPI specification file, you can use one of the many available tools such as Swagger UI or Redoc to generate documentation for the Amazon ParallelCluster API.

How to deploy Amazon ParallelCluster API

To deploy Amazon ParallelCluster API you need to be an Administrator of the Amazon Web Services account.

The template used to deploy the API is available at the following URL:

https://<REGION>-aws-parallelcluster.s3.<REGION>.amazonaws.com/parallelcluster/<VERSION>/api/parallelcluster-api.yaml

where <REGION> is the Amazon Web Services Region where the API needs to be deployed to and <VERSION> is the Amazon ParallelCluster version (e.g. 3.13.0).

Amazon Lambda uses a Lambda layer interface with the Amazon ParallelCluster Python library API to process the API invoked features.