documentation.help

DeregisterImage

From Amazon Elastic Compute Cloud: 2009-10-31

previous page next page

DeregisterImage

Description

Deregisters the specified AMI. Once deregistered, the AMI cannot be used to launch new instances.

[Note]Note

This command does not delete the AMI.

Request Parameters

NameDescriptionRequired

ImageId

Unique ID of the AMI which was assigned during registration. To register an AMI, use RegisterImage. To view the AMI IDs of AMIs that belong to your account. use DescribeImages.

Type: String

Default: None

Yes

Response Elements

NameDescription

DeregisterImageResponseType

DeregisterImageResponseType element.

Type:

DeregisterImageResponseType

Ancestor: None

Children: requestId, return

requestId

The ID of the request.

Type: xsd:string

Ancestor: DeregisterImageResponseType

Children: None

return

Returns true if deregistration succeeded. Otherwise, returns an error.

Type: xsd:boolean

Ancestor: DeregisterImageResponseType

Children: None

Examples

Example Request

This example deregisters the ami-4fa54026 AMI.

https://ec2.amazonaws.com/?Action=DeregisterImage&ImageId=ami-4fa54026&AuthParams

Example Response

<DeregisterImageResponse xmlns="http://ec2.amazonaws.com/doc/2009-10-31/">
  <return>true</return>
</DeregisterImageResponse>
previous page start next page