Deregister Image operation


The Deregister Image operation enables you to deregister a specified Amazon Machine Image (AMI). After you deregister an AMI, you cannot use the AMI to launch new instances.

The following figure shows a sample <items> XML element for the Deregister Image operation:

Sample <items> XML element for the Deregister Image operation
<items>
 <item>
   <parameters>
     <image-id></image-id>
   </parameters>
</item>
</items>

The following table describes the elements for this adapter request:

Adapter request elements for the Deregister Image operation

Element

Definition

Required

<wsdl-location>

Specifies the target Web Service Description Language (WSDL) URL for Amazon EC2

Examples:

Conditional:

  • Required if not specified in the request
  • If specified in the configuration and request, the value in the request overrides the value in the configuration
<endpoint-address>

Specifies the web service endpoint for the adapter to use while performing operations on Amazon EC2 instances across different regions
Default value: US East region: http://us-east-1.ec2.amazonaws.com/

No

<signature-properties>

Specifies the mode for signing the adapter request

Conditional:

  • Required if not specified in the configuration
  • If <signature-properties mode = "key-files">, requires <private-key-file>
     and <certificate-file>
  • If <signature-properties mode = "key-data">, requires <private-key-data> and <certificate-data>
<operation-name>

Contains the name of the operation: deregister-image

Yes

<image-id>

Specifies the unique ID of the AMI assigned during registration

Yes

The following figure shows a sample adapter request for the Deregister Image operation:

Sample adapter request for the Deregister Image operation

<amazon-ec2-request>
   <wsdl-location>http://ec2.amazonaws.com/doc/2009-11-30/</wsdl-location>
   <endpoint-address>http://us-east-1.ec2.amazonaws.com/</endpoint-address>
   <signature-properties mode = "key-files">
       <private-key-file>C:\Security\
pk-MJ5GIUNLM2XJ3VRJSYTKOFDWILELDQHB.PEM</private-key-file>
       <certificate-file>C:\Security\
cert-MJ5GIUNLM2XJ3VRJSYTKOFDWILELDQHB.PEM</certificate-file>
   </signature-properties>
   <operation-name>deregister-image</operation-name>
   <parameters>
       <image-id>ami-8d618ee4</image-id>
   </parameters>
</amazon-ec2-request>

The following figure shows a sample adapter response for the Deregister Image operation:

Sample adapter response for the Deregister Image operation

<amazon-ec2-response>
   <metadata>
       <status>success</status>
   </metadata>
   <DeregisterImageResponse>
       <requestId>40d855a5-6eab-4c91-bed1-13e5c1d16c15</requestId>
       <return>true</return>
   </DeregisterImageResponse>
</amazon-ec2-response>

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*