Deletes a custom AppStream image.
Operation description
You can delete only custom images that belong to you.
For images associated with the AppStream Cloud Computer Pool, AppStream Cloud Application, or AppStream Workstation product lines, you must ensure that no AppStream instances are using the image before you can delete it.
If an AppStream Cloud Desktop template references an image, the template is also deleted when the image is deleted.
If an image is available in multiple regions, deleting the image removes it from all regions.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ImageId |
string |
No |
The AppStream image ID. |
img-bp13mu**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response structure. |
||
| Data |
boolean |
Indicates whether the deletion is successful. Valid values:
|
true |
| Success |
boolean |
Indicates whether the request is successful. |
true |
| Code |
string |
The status code:
|
200 |
| Message |
string |
The error message returned when an error occurs. |
successful |
| RequestId |
string |
The request ID. |
1CBAFFAB-B697-4049-A9B1-67E1FC5F**** |
Examples
Success response
JSON format
{
"Data": true,
"Success": true,
"Code": "200",
"Message": "successful",
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InternalError | Internal error. | |
| 400 | Image.NotExist | The image does not exist. | The image does not exist. |
| 400 | ImageDeleteFailed.NotAllow | The image is not allowed to be deleted. | The image is not allowed to be deleted. |
| 400 | ImageDeleteFailed.NotAllowCommunityParent | The parent image of a community image is not allowed to be deleted. | The parent image of a community image is not allowed to be deleted. |
| 400 | ImageDeleteFailed.NotAllowSharedImage | The shared image is not allowed to be deleted. | The shared image is not allowed to be deleted. |
| 400 | ImageNotAllowDelete | The image cannot be deleted, because shared cloud computers already exist. | The image cannot be deleted, because shared cloud computers already exist. |
| 400 | InvalidImageOperation.ImageIsCreating | Failed to operation the image, it is creating. | Failed to operation the image, it is creating. |
| 400 | DeleteTemplate.Failed | Delete template failed. | Failed to delete the template. |
| 400 | QueryTemplate.Failed | Query template failed. | Failed to query the template. |
| 400 | InvalidTemplate.NotFound | Template not found. | The template is not found. |
| 400 | ImageDeleteFailed.HasSharedImage | The shared image is not allowed to be deleted. | The shared image is not allowed to be deleted. |
| 500 | ServiceUnavailable | Service unavailable. Please try again later. | Service unavailable. Please try again later. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.