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

# deleteImage
<a name="delete-image"></a>

Inicie a exclusão da imagem personalizada AWS ParallelCluster .

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

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

```
DELETE /v3/images/custom/{{{imageId}}}
{
  "force": boolean,
  "region": "string"
}
```

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

**imageId**  
O ID da imagem.  
Tipo: string  
Obrigatório: Sim

**force**  
Se definido como `true`, força a exclusão da AMI. Use esse parâmetro se houver instâncias que usam a AMI ou se a AMI for compartilhada. O padrão é `false`.  
Tipo: booliano  
Obrigatório: não

**região**  
O Região da AWS em que a imagem foi criada.  
Tipo: string  
Obrigatório: Não

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

```
{
  "image": {
    "imageId": "string",
    "ec2AmiInfo": {
      "amiId": "string"
    },
    "region": "string",
    "version": "string",
    "cloudformationStackArn": "string",
    "imageBuildStatus": "DELETE_IN_PROGRESS",
    "cloudformationStackStatus": "DELETE_IN_PROGRESS"
  }
}
```

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

**image**    
**cloudformationStackArn**  
O nome do recurso Amazon (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**    
**amiId**  
O ID da Amazon EC2 AMI.  
Tipo: string  
**imageBuildStatus**  
O status de construção da imagem.  
Tipo: string  
Valores válidos: `BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE`  
**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

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

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

**Solicitação**

```
$ delete_image({{custom-image-id}})
```

**Resposta 200**

```
{
  "image": {
    "image_build_status": "DELETE_IN_PROGRESS",
    "image_id": "custom-image-id",
    "region": "us-east-1",
    "version": "3.2.1"
  }
}
```

------