Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

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

Memulai penghapusan gambar kustom. AWS ParallelCluster 

**Topics**
+ [Sintaksis Permintaan](#delete-image-request)
+ [Bodi permintaan](#delete-image-request-body)
+ [Sintaksis Respons](#delete-image-response)
+ [Isi respons](#delete-image-response-body)
+ [Contoh](#delete-image-example)

## Sintaksis Permintaan
<a name="delete-image-request"></a>

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

## Bodi permintaan
<a name="delete-image-request-body"></a>

**imageId**  
ID gambar.  
Jenis: string  
Diperlukan: Ya

**kekuatan**  
Jika disetel ke`true`, paksa penghapusan AMI. Gunakan parameter ini jika ada instance yang menggunakan AMI atau jika AMI dibagikan. Defaultnya adalah `false`.  
Jenis: boolean  
Wajib: Tidak

**region**  
 Wilayah AWS Di mana gambar itu dibuat.  
Jenis: string  
Wajib: Tidak

## Sintaksis Respons
<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"
  }
}
```

## Isi respons
<a name="delete-image-response-body"></a>

**gambar**    
**cloudformationStackArn**  
Nama sumber daya Amazon (ARN) dari tumpukan utama CloudFormation .  
Jenis: string  
**cloudformationStackStatus**  
Status CloudFormation tumpukan.  
Jenis: string  
Nilai yang valid: `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**  
ID EC2 AMI Amazon.  
Jenis: string  
**imageBuildStatus**  
Status pembuatan gambar.  
Jenis: string  
Nilai yang valid: `BUILD_IN_PROGRESS | BUILD_FAILED | BUILD_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE`  
**imageId**  
ID gambar.  
Jenis: string  
**region**  
 Wilayah AWS Di mana gambar dibuat.  
Jenis: string  
**versi**  
 AWS ParallelCluster Versi yang digunakan untuk membangun gambar.  
Jenis: string

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

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

**Permintaan**

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

**200 Respon**

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

------