本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

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

开始删除自定义 Amazon ParallelCluster 镜像。

**Topics**
+ [请求语法](#delete-image-request)
+ [请求正文](#delete-image-request-body)
+ [响应语法](#delete-image-response)
+ [响应正文](#delete-image-response-body)
+ [示例](#delete-image-example)

## 请求语法
<a name="delete-image-request"></a>

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

## 请求正文
<a name="delete-image-request-body"></a>

**imageId**  
映像的 ID。  
类型：字符串。  
必需：是

**force**  
如果设置为 `true`，则强制删除 AMI。如果有使用 AMI 的实例或者共享了 AMI，则使用此参数。默认值为 `false`。  
类型：布尔值  
必需：否

**region**  
图像 Amazon Web Services 区域 是在其中创建的。  
类型：字符串  
必需：否

## 响应语法
<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"
  }
}
```

## 响应正文
<a name="delete-image-response-body"></a>

**image**    
**cloudformationStackArn**  
主 CloudFormation 堆栈的亚马逊资源名称 (ARN)。  
类型：字符串  
**cloudformationStackStatus**  
堆 CloudFormation 栈状态。  
类型：字符串  
有效值：`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**  
亚马逊 EC2 AMI ID。  
类型：字符串  
**imageBuildStatus**  
映像构建状态。  
类型：字符串  
有效值：`BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE`  
**imageId**  
映像的 ID。  
类型：字符串  
**区域**  
 Amazon Web Services 区域 在其中创建镜像。  
类型：字符串  
**version**  
用于构建镜像的 Amazon ParallelCluster 版本。  
类型：字符串

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

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

**请求**

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

**200 响应**

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

------