Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

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

Obtenga una lista de los clústeres existentes.

**Topics**
+ [Sintaxis de la solicitud](#list-clusters-request)
+ [Cuerpo de la solicitud](#list-clusters-request-body)
+ [Sintaxis de la respuesta](#list-clusters-response)
+ [Cuerpo de respuesta](#list-clusters-response-body)
+ [Ejemplo](#list-clusters-example)

## Sintaxis de la solicitud
<a name="list-clusters-request"></a>

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

## Cuerpo de la solicitud
<a name="list-clusters-request-body"></a>

**clusterStatus**  
Filtra por estado de clúster. El valor predeterminado es todos los clústeres.  
Tipo: cadena  
Valores válidos: `CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED`  
Obligatorio: no

**nextToken**  
El token del conjunto siguiente de resultados.  
Tipo: cadena  
Requerido: no

**region**  
El Región de AWS de los clústeres.  
Tipo: cadena  
Requerido: no

## Sintaxis de la respuesta
<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"
        }
      }
    }
  ]
}
```

## Cuerpo de respuesta
<a name="list-clusters-response-body"></a>

**clústeres**    
**cloudformationStackArn**  
El nombre de recurso de Amazon (ARN) de la pila principal CloudFormation .  
Tipo: cadena  
**cloudformationStackStatus**  
El estado de la CloudFormation pila.  
Tipo: cadena  
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**  
El nombre del clúster.  
Tipo: cadena  
**clusterStatus**  
El estado del clúster.  
Tipo: cadena  
Valores válidos: `CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED`  
**programador**    
**metadatos**  
Los metadatos del programador.    
**nombre**  
El nombre del programador.  
Tipo: cadena  
**versión**  
La versión del programador.  
Tipo: cadena  
**type**  
El tipo de programador.  
Tipo: cadena  
**region**  
El Región de AWS lugar en el que se crea el clúster.  
Tipo: cadena  
**versión**  
La AWS ParallelCluster versión que se utiliza para crear el clúster.  
Tipo: cadena

**nextToken**  
Un token que se puede utilizar para recuperar el siguiente conjunto de resultados o `null` si no hay resultados adicionales.  
Tipo: cadena

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

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

**Solicitud**

```
$ list_clusters()
```

**Respuesta 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'
      },
      ...
   ]
}
```

------