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.

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

Inicie la eliminación de la AWS ParallelCluster imagen personalizada.

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

## Sintaxis de la solicitud
<a name="delete-image-request"></a>

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

## Cuerpo de la solicitud
<a name="delete-image-request-body"></a>

**imageId**  
El identificador de la imagen.  
Tipo: cadena  
Obligatorio: sí

**force**  
Si se establece en `true`, se fuerza la eliminación de la AMI. Utilice este parámetro si hay instancias que utilizan la AMI o si la AMI es compartida. El valor predeterminado es `false`.  
Tipo: booleano  
Obligatorio: no

**region**  
El Región de AWS lugar en el que se creó la imagen.  
Tipo: cadena  
Requerido: no

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

## Cuerpo de respuesta
<a name="delete-image-response-body"></a>

**imagen**    
**cloudformationStackArn**  
El nombre del 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**    
**amiId**  
El identificador de la EC2 AMI de Amazon.  
Tipo: cadena  
**imageBuildStatus**  
El estado de creación de la imagen.  
Tipo: cadena  
Valores válidos: `BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE`  
**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

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

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

**Solicitud**

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

**Respuesta 200**

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

------