DeregisterImage
Description
Deregisters the specified AMI. Once deregistered, the AMI cannot be used to launch new instances.
Note | |
---|---|
This command does not delete the AMI from Amazon S3. |
Request Parameters
Name | Description | Required |
---|---|---|
| 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
Name | Description |
---|---|
|
Type: |
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.
https://ec2.amazonaws.com/?Action=DeregisterImage&ImageId=ami-4fa54026&AuthParams
Example Response
<DeregisterImageResponse xmlns="http://ec2.amazonaws.com/doc/2009-07-15/"> <return>true</return> </DeregisterImageResponse>