As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

# deleteCluster
<a name="delete-cluster"></a>

Inicia a exclusão de um cluster.

**Topics**
+ [Sintaxe da solicitação](#delete-cluster-request)
+ [Corpo da solicitação](#delete-cluster-request-body)
+ [Sintaxe da resposta](#delete-cluster-response)
+ [Corpo da resposta](#delete-cluster-response-body)
+ [Exemplo](#delete-cluster-example)

## Sintaxe da solicitação
<a name="delete-cluster-request"></a>

```
DELETE /v3/clusters/{{{clusterName}}}
{
  "region": "string"
}
```

## Corpo da solicitação
<a name="delete-cluster-request-body"></a>

**clusterName**  
O nome do cluster.  
Tipo: string  
Obrigatório: Sim

**região**  
O Região da AWS em que o cluster é excluído.  
Tipo: string  
Obrigatório: Não

## Sintaxe da resposta
<a name="delete-cluster-response"></a>

```
{
   "cluster": {
       "clusterName": "string",
       "region": "string",
       "version": "string",
       "cloudformationStackArn": "string",
       "cloudformationStackStatus": "DELETE_IN_PROGRESS",
       "clusterStatus": "DELETE_IN_PROGRESS",
       "scheduler": {
           "type": "string",
           "metadata": {
               "name": "string",
               "version": "string"
           }
        }
    }
}
```

## Corpo da resposta
<a name="delete-cluster-response-body"></a>

**cluster**  
Uma lista de instâncias de cluster.    
**clusterName**  
Nome do cluster.  
Tipo: string  
**cloudformationStackArn**  
O Amazon Resource Name (ARN) da pilha principal CloudFormation .  
Tipo: string  
**cloudformationStackStatus**  
Tipo: string  
Valores válidos: `CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | ROLLBACK_IN_PROGRESS | ROLLBACK_FAILED | ROLLBACK_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE_CLEANUP_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_ROLLBACK_IN_PROGRESS | UPDATE_ROLLBACK_FAILED | UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS | UPDATE_ROLLBACK_COMPLETE`  
**clusterStatus**  
Tipo: string  
Valores válidos: `CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED`  
**região**  
O Região da AWS no qual o cluster é criado.  
Tipo: string  
**scheduler (programador)**    
**metadados**  
Os metadados do programador.    
**nome**  
O nome do programador.  
Tipo: string  
**version**  
A versão do programador.  
Tipo: string  
**type**  
O tipo de programador.  
Tipo: string  
**version**  
A AWS ParallelCluster versão usada para criar o cluster.  
Tipo: string

## Exemplo
<a name="delete-cluster-example"></a>

------
#### [ Python ]

**Solicitação**

```
$ delete_cluster({{cluster_name_3x}})
```

**Resposta 200**

```
{
  "cluster": {
    "cloudformation_stack_arn": "arn:aws:cloudformation:us-east-1:123456789012:stack/cluster_name_3x/16b49540-aee5-11ec-8e18-0ac1d712b241",
    "cloudformation_stack_status": "DELETE_IN_PROGRESS",
    "cluster_name": "cluster_name_3x",
    "cluster_status": "DELETE_IN_PROGRESS",
    "region": "us-east-1",
    "version": "3.2.1"
  }
}
```

------