本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

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

啟動刪除自訂 AWS 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**  
建立映像 AWS 區域 的 。  
類型：字串  
必要：否

## 回應語法
<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 堆疊的 Amazon 資源名稱 (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`  
**ec2AmiInfo**    
**amiId**  
Amazon EC2 AMI ID。  
類型：字串  
**imageBuildStatus**  
映像建置狀態。  
類型：字串  
有效值：`BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE`  
**imageId**  
影像的 ID。  
類型：字串  
**region**  
建立映像 AWS 區域 的 。  
類型：字串  
**version**  
用來建置映像的 AWS 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"
  }
}
```

------