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á.

# listClusters
<a name="list-clusters"></a>

Retorna uma lista de clusters existentes.

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

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

```
GET /v3/clusters
{
  "clusterStatus": "string",
  "nextToken": "string",
  "region": "string"
}
```

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

**clusterStatus**  
Filtro por status do cluster. O padrão é todos os clusters.  
Tipo: string  
Valores válidos: `CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED`  
Obrigatório: não

**nextToken**  
O token para o próximo conjunto de resultados.  
Tipo: string  
Obrigatório: Não

**região**  
O Região da AWS dos clusters.  
Tipo: string  
Obrigatório: Não

## Sintaxe da resposta
<a name="list-clusters-response"></a>

```
{
  "nextToken": "string",
  "clusters": [
    {
      "clusterName": "string",
      "region": "string",
      "version": "string",
      "cloudformationStackArn": "string",
      "cloudformationStackStatus": "CREATE_IN_PROGRESS",
      "clusterStatus": "CREATE_IN_PROGRESS",
      "scheduler": {
        "type": "string",
        "metadata": {
          "name": "string",
          "version": "string"
        }
      }
    }
  ]
}
```

## Corpo da resposta
<a name="list-clusters-response-body"></a>

**clusters**    
**cloudformationStackArn**  
O Amazon Resource Name (ARN) da pilha principal CloudFormation .  
Tipo: string  
**cloudformationStackStatus**  
O status da CloudFormation pilha.  
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`  
**clusterName**  
O nome do cluster.  
Tipo: string  
**clusterStatus**  
Status do cluster.  
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`  
**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  
**região**  
O Região da AWS no qual o cluster é criado.  
Tipo: string  
**version**  
A AWS ParallelCluster versão usada para criar o cluster.  
Tipo: string

**nextToken**  
Um token que pode ser usado para recuperar o próximo conjunto de resultados ou `null` se não houver resultados adicionais.  
Tipo: string

## Exemplo
<a name="list-clusters-example"></a>

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

**Solicitação**

```
$ list_clusters()
```

**Resposta 200**

```
{
  'clusters': 
   [
      {
        'cloudformation_stack_arn': 'arn:aws:cloudformation:us-east-1:123456789012:stack/cluster_name_3x/16b49540-aee5-11ec-8e18-0ac1d712b241',
        'cloudformation_stack_status': 'CREATE_COMPLETE',
        'cluster_name': 'cluster_name_3x',
        'cluster_status': 'CREATE_COMPLETE',
        'region': 'us-east-1',
        'version': '3.2.1'
      },
      ...
   ]
}
```

------