DeleteImage
Deletes the specified image. You cannot delete an image when it is in use. After you delete an image, you cannot provision new capacity using the image.
Request Syntax
{
"Name": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Name
-
The name of the image.
Type: String
Pattern:
^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$Required: Yes
Response Syntax
{
"Image": {
"Applications": [
{
"AppBlockArn": "string",
"Arn": "string",
"CreatedTime": number,
"Description": "string",
"DisplayName": "string",
"Enabled": boolean,
"IconS3Location": {
"S3Bucket": "string",
"S3Key": "string"
},
"IconURL": "string",
"InstanceFamilies": [ "string" ],
"LaunchParameters": "string",
"LaunchPath": "string",
"Metadata": {
"string" : "string"
},
"Name": "string",
"Platforms": [ "string" ],
"WorkingDirectory": "string"
}
],
"AppstreamAgentVersion": "string",
"Arn": "string",
"BaseImageArn": "string",
"CreatedTime": number,
"Description": "string",
"DisplayName": "string",
"DynamicAppProvidersEnabled": "string",
"ImageBuilderName": "string",
"ImageBuilderSupported": boolean,
"ImageErrors": [
{
"ErrorCode": "string",
"ErrorMessage": "string",
"ErrorTimestamp": number
}
],
"ImagePermissions": {
"allowFleet": boolean,
"allowImageBuilder": boolean
},
"ImageSharedWithOthers": "string",
"LatestAppstreamAgentVersion": "string",
"Name": "string",
"Platform": "string",
"PublicBaseImageReleasedDate": number,
"State": "string",
"StateChangeReason": {
"Code": "string",
"Message": "string"
},
"SupportedInstanceFamilies": [ "string" ],
"Visibility": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConcurrentModificationException
-
An API error occurred. Wait a few minutes and try again.
HTTP Status Code: 400
- OperationNotPermittedException
-
The attempted operation is not permitted.
HTTP Status Code: 400
- ResourceInUseException
-
The specified resource is in use.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
