All Products
Search
Document Center

App Streaming:DeleteImage

Last Updated:Dec 17, 2025

Delete a custom RDS image

Operation description

  • You can only delete custom images to which a user belongs.
  • If the product line is an image of the RDS cloud computer pool, RDS cloud application, and RDS workstation, make sure that no RDS instances use the image before you delete it.
  • The RDS CloudDesktop template references an image. When you delete an image, the template is also deleted.
  • If the image contains multiple regions, the images in all regions are deleted when the image is deleted.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
appstreaming:DeleteImagenone
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ImageIdstringNo

The ID of the RDS image.

img-bp13mu****

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

Databoolean

Whether the deletion is successful.

Enumerated values:

  • true:Deleted successfully.
  • false:Deletion failure.
true
Successboolean

Indicates whether the request was successful.

true
Codestring

Status code:

  • 200: Success.
  • 400: An error occurred.
200
Messagestring

The error message.

successful
RequestIdstring

The request ID.

1CBAFFAB-B697-4049-A9B1-67E1FC5F****

Examples

Sample success responses

JSONformat

{
  "Data": true,
  "Success": true,
  "Code": 200,
  "Message": "successful",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

Error codes

HTTP status codeError codeError messageDescription
400InternalErrorInternal error.-
400Image.NotExistThe image does not exist.The image does not exist.
400ImageDeleteFailed.NotAllowThe image is not allowed to be deleted.The image is not allowed to be deleted.
400ImageDeleteFailed.NotAllowCommunityParentThe 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.
400ImageDeleteFailed.NotAllowSharedImageThe shared image is not allowed to be deleted.The shared image is not allowed to be deleted.
400ImageNotAllowDeleteThe image cannot be deleted, because shared cloud computers already exist.The image cannot be deleted, because shared cloud computers already exist.
400InvalidImageOperation.ImageIsCreatingFailed to operation the image, it is creating.Failed to operation the image, it is creating.
400DeleteTemplate.FailedDelete template failed.Failed to delete the template.
400QueryTemplate.FailedQuery template failed.Failed to query the template.
400InvalidTemplate.NotFoundTemplate not found.The template is not found.
400ImageDeleteFailed.HasSharedImageThe shared image is not allowed to be deleted.The shared image is not allowed to be deleted.
500ServiceUnavailableService unavailable. Please try again later.Service unavailable. Please try again later.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2025-10-17Add OperationView Change Details