View a markdown version of this page

deleteClusterInstances - Amazon ParallelCluster
Request syntaxRequest bodyResponse bodyExample
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).

This documentation references Amazon ParallelCluster. For running HPC and AI workloads, we recommend Amazon Parallel Computing Service (Amazon PCS), our managed Slurm service that lets you focus on running your workloads rather than managing infrastructure.

deleteClusterInstances

Initiate the forced termination of all cluster compute nodes. This action doesn't support Amazon Batch clusters.

Request syntax

DELETE /v3/clusters/{clusterName}/instances
{
  "force": boolean,
  "region": "string"
}

Request body

clusterName

The name of the cluster.

Type: string

Required: Yes

force

If set to true, force the deletion when the cluster with the given name isn't found. The default is false.

Type: boolean

Required: No

region

The Amazon Web Services Region that the cluster is in.

Type: string

Required: No

Response body

None

Example

Python

Request

$ delete_cluster_instances(cluster_name_3x)

200 Response

None