Describe Images operation for the Amazon EC2 REST adapter

The Describe Images operation returns information about Amazon Machine Images (AMIs), Available Kernel Images (AKIs), and Amazon Ram Disk Images (ARIs). The retrieved information includes image type, product codes, architecture, kernel IDs, and RAM disk IDs.

You can use the Describe Images operation only with images available to you. Images available to you, which include:

Public images
Private images that you own
Private images owned by other users for which you have explicit launch permissions

The following figure shows a sample <items> XML element for the Describe Images operation:
Sample <items> XML element for the Describe Images operation
<items>
   <item>
       <parameters>
           
           <executable-by-set>
               
               <item>
                   <user></user>
               </item>
           </executable-by-set>
           <images-set>
               
               <item>
                   <image-id></image-id>
               </item>
           </images-set>
           
           <owners-set>
               
               <item>
                   <owner></owner>
               </item>
           </owners-set>
       </parameters>
   </item>
</items>
The following table describes the elements for this adapter request:

Adapter request elements for the Describe Images operation
The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.
The following figure shows a sample adapter request for the Describe Images operation:
Sample adapter request for the Describe Images operation
<amazon-ec2-rest-request>
   <operation-name>describe-images</operation-name>
   <parameters>
     <images-set>
       <item>
         <image-id>ami-98ec84a8</image-id>
       </item>
     </images-set>
   </parameters>
</amazon-ec2-rest-request>
The following figure shows the response for the sample Describe Images operation:
Sample adapter response for the Describe Images operation
<amazon-ec2-rest-response>
<metadata>
   <status>success</status>
</metadata>
<DescribeImagesResponse>
   <ImageInfo>
     <item>
       <imageId>ami-98ec84a8</imageId>
       <imageName>test image</imageName>
       <imageLocation>246495073671/test image</imageLocation>
       <imageType>machine</imageType>
       <imageState>available</imageState>
       <imageDescription></imageDescription>
       <imageOwner>246495073671</imageOwner>
       <ownerAlias />
       <architecture>x86_64</architecture>
       <kernelId>aki-fc8f11cc</kernelId>
       <platform />
       <Hypervisor>xen</Hypervisor>
       <isPublic>false</isPublic>
       <ramdiskId />
       <rootDeviceName>/dev/sda1</rootDeviceName>
       <rootDeviceType>ebs</rootDeviceType>
       <virtualizationType>paravirtual</virtualizationType>
       <imageTags />
       <blockDeviceMappings>
         <blockDeviceMapping>
           <deviceName>/dev/sda1</deviceName>
           <noDevice />
           <virtualName />
           <ebsBlockDevice>
             <snapshotId>snap-86306176</snapshotId>
             <iops />
             <isDeleteOnTermination>true</isDeleteOnTermination>
             <volumeSize>8</volumeSize>
             <volumeType>standard</volumeType>
           </ebsBlockDevice>
         </blockDeviceMapping>
       </blockDeviceMappings>
     </item>
   </ImageInfo>
</DescribeImagesResponse>
</amazon-ec2-rest-response>

Describe Images operation for the Amazon EC2 REST adapter

On this page