翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# 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>

**画像**    
**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"
  }
}
```

------