DeregisterImage

Amazon Elastic Compute Cloud: 2009-07-15

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 from Amazon S3.

Request Parameters

NameDescriptionRequired

DeregisterImageType

DeregisterImageType element.

Type:

DeregisterImageType

Ancestor: None

Children: imageId

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: xsd:string

Default: None

Ancestor: DeregisterImageType

Children: None

Yes

Response Elements

Name Description

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 "false".

Type: xsd:boolean

Ancestor: DeregisterImageResponseType

Children: None

Examples

Example Request

This example deregisters the ami-4fa54026 AMI.

<DeregisterImage xmlns="http://ec2.amazonaws.com/doc/2009-07-15/">
    <imageId>ami-4fa54026</imageId>
</DeregisterImage>

Example Response

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