Deregister Image operation for the Amazon EC2 REST adapter


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

<access-key>

Specifies the Amazon Web Services (AWS) access key

You need to generate the AWS access key by going to the Security Credentials tab in the AWS console.

Conditional;

  • You must specify the Access Key and theSecret Key together in the configuration or the adapter request.
  • If you specify both the keys in the adapter request and in the adapter configuration, the key values in the request override the values in the configuration.
  • If only the Access Key is specified, the adapter ignores the value.
<secret-key>

Specifies the AWS secret access key

You need to generate the AWS secret access key by going to the Security Credentials tab in the AWS console.

Conditional;

  • You must specify the Access Key and theSecret Key together in the configuration or the adapter request.
  • If you specify both the keys in the adapter request and in the adapter configuration, the key values in the request override the values in the configuration.
  • If only the Secret Access Key is specified, the adapter ignores the value.

<session-token>

Specifies the temporary session token generated using the AWS APIs.

Conditional;

You must specify the Access Key and Secret Key as well in the configuration or the adapter request, else the <session-token> value is ignored.

<region>

Specifies the region with which you want the adapter to communicate

Amazon EC2 is hosted in multiple locations world-wide. You must specify the region in which you want the adapter to perform the actions.

Valid values:

  • us-east-1
  • us-west-2 (default)
  • us-west-1
  • eu-west-1
  • ap-southeast-1
  • ap-northeast-1
  • ap-southeast-2
  • sa-east-1

No

<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-rest-request>
   <operation-name>deregister-image</operation-name>
   <parameters>
     <image-id>ami-98ec84a8</image-id>
   </parameters>
</amazon-ec2-rest-request>

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

Sample adapter response for the Deregister Image operation

 <amazon-ec2-rest-response>
 <metadata>
   <status>success</status>
 </metadata>
 <DeregisterImageResponse>
   <return>true</return>
 </DeregisterImageResponse>
</amazon-ec2-rest-response>

 

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