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

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

Recupera a lista de imagens personalizadas existentes.

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

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

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

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

**imageStatus**  
Filtra as imagens pelo status fornecido.  
Tipo: string  
Valores válidos: `AVAILABLE | PENDING | FAILED`  
Obrigatório: Sim

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

**região**  
Aquele em Região da AWS que as imagens estão.  
Tipo: string  
Obrigatório: Não

## Sintaxe da resposta
<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"
    }
  ]
}
```

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

**images**  
Uma lista de imagens.    
**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`  
**ec2 AmiInfo**    
**ami\$1id**  
O ID da Amazon EC2 AMI.  
Tipo: string  
**imageBuildStatus**  
O status de construção da imagem.  
Valores válidos: `BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE`  
Tipo: string  
**imageId**  
O ID da imagem.  
Tipo: string  
**região**  
O Região da AWS em que a imagem é criada.  
Tipo: string  
**version**  
A AWS ParallelCluster versão usada para criar a imagem.  
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-images-example"></a>

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

**Solicitação**

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

**Resposta 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'
    }
  ]
}
```

------