

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.

# listImages
<a name="list-images"></a>

Obtenga la lista de imágenes personalizadas existentes.

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

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

```
GET /images/custom
{
  "imageStatus": "string",
  "nextToken": "string",
  "region": "string"
}
```

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

**imageStatus**  
Filtre las imágenes según el estado proporcionado.  
Tipo: cadena  
Valores válidos: `AVAILABLE | PENDING | FAILED`  
Obligatorio: sí

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

**region**  
En Región de AWS qué están las imágenes.  
Tipo: cadena  
Requerido: no

## Sintaxis de la respuesta
<a name="list-images-response"></a>

```
{
  "nextToken": "string",
  "images": [
    {
      "imageId": "string",
      "ec2AmiInfo": {
        "amiId": "string"
      },
      "region": "string",
      "version": "string",
      "cloudformationStackArn": "string",
      "imageBuildStatus": "BUILD_IN_PROGRESS",
      "cloudformationStackStatus": "CREATE_IN_PROGRESS"
    }
  ]
}
```

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

**images**  
Una lista de imágenes.    
**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`  
**ec2 AmiInfo**    
**ami-id**  
El identificador de la EC2 AMI de Amazon.  
Tipo: cadena  
**imageBuildStatus**  
El estado de creación de la imagen.  
Valores válidos: `BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE`  
Tipo: cadena  
**imageId**  
El identificador de la imagen.  
Tipo: cadena  
**region**  
El Región de AWS lugar en el que se crea la imagen.  
Tipo: cadena  
**versión**  
La AWS ParallelCluster versión que se utiliza para crear la imagen.  
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-images-example"></a>

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

**Solicitud**

```
$ list_images("AVAILABLE")
```

**Respuesta 200**

```
{
  'images': [
    {
      'ec2_ami_info': {
        'ami_id': 'ami-abcdef01234567890'
      },
      'image_build_status': 'BUILD_COMPLETE',
      'image_id': 'custom-image',
      'region': 'us-east-1',
      'version': '3.2.1'
    }
  ]
}
```

------