Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

# Supprimer l'image
<a name="delete-image"></a>

Lancez la suppression de l' AWS ParallelCluster image personnalisée.

**Topics**
+ [Syntaxe de demande](#delete-image-request)
+ [Corps de la requête](#delete-image-request-body)
+ [Syntaxe de réponse](#delete-image-response)
+ [Corps de la réponse](#delete-image-response-body)
+ [Exemple](#delete-image-example)

## Syntaxe de demande
<a name="delete-image-request"></a>

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

## Corps de la requête
<a name="delete-image-request-body"></a>

**imageId**  
L'ID de l'image.  
Type : chaîne  
Obligatoire : oui

**force**  
Si ce paramètre est défini sur`true`, forcez la suppression de l'AMI. Utilisez ce paramètre si certaines instances utilisent l'AMI ou si celle-ci est partagée. La valeur par défaut est `false`.  
Type : valeur booléenne  
Obligatoire : non

**region**  
L' Région AWS endroit dans lequel l'image a été créée.  
Type : chaîne  
Obligatoire : non

## Syntaxe de réponse
<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"
  }
}
```

## Corps de la réponse
<a name="delete-image-response-body"></a>

**image**    
**formation des nuages StackArn**  
Le nom de ressource Amazon (ARN) de la CloudFormation pile principale.  
Type : chaîne  
**formation des nuages StackStatus**  
L'état de la CloudFormation pile.  
Type : chaîne  
Valeurs valides : `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**    
**ID AMI**  
L'ID AMI Amazon EC2.  
Type : chaîne  
**image BuildStatus**  
État de création de l'image.  
Type : chaîne  
Valeurs valides : `BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE`  
**imageId**  
L'ID de l'image.  
Type : chaîne  
**region**  
L' Région AWS endroit dans lequel l'image est créée.  
Type : chaîne  
**version**  
 AWS ParallelCluster Version utilisée pour créer l'image.  
Type : chaîne

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

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

**Demande**

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

**Réponse 200 **

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

------