Skip to main content
Kinetic Community

AWS EC2 Image Retrieve

Retrieves the properties of the image supplied

Downloads

By downloading this file, you acknowledge that you agree to our Terms of Service

aws_ec2_image_retrieve_v1.zip

Detailed Description

The describe_images function is the base AWS::EC2 gem call we are using for
this handler and returns a multi-level hash/array nest with a top level hash key
of "imagesSet".

The imagesSet has the following pseudo-xml form. Elements with the <item> 
tag are array members and are referenced by numerical index.

All others are hash members and are references by element/key name.

  <imagesSet>
    <item>
      <imageId/>
      <imageLocation/>
      <imageState/>
      <imageOwnerId/>
      <isPublic/>
      <architecture/>
      <imageType/>
      <kernelId/>
      <ramdiskId/>
      <imageOwnerAlias/>
      <name/>
      <description/>
      <rootDeviceType/>
      <rootDeviceName/>
      <blockDeviceMapping>
        <item>
          <deviceName/>
          <ebs>
            <snapshotId/>
            <volumeSize/>
            <deleteOnTermination/>
          </ebs>
        </item>
      </blockDeviceMapping>
      <virtualizationType/>
      <tagSet/>
      <hypervisor/>
    </item>
  </imagesSet>

To retrieve the imageId, for example, simply flatten the above structure by 
removing inapplicable items

  <imagesSet>
    <item>
      <imageId/>
    </item>
  </imagesSet>

Treat items as arrays and all other members as hash keys. Doing so, we can
reference imageId value in the following manner:

@base_aws_object.imagesSet.item[index].imageId

In this handler, we are returning just the more interesting properties for an
instance. Future versions may incorporate additional properties.

 

Parameters

Name Description
Image ID The image id of the EC2 image that this handler will retrieve details about

Sample Configuration

Parameter Example Configuration
Image ID <%= @answers['Image ID'] %>

Results

Name Description
Image Location The location of the AMI.
Image State Current state of the AMI. If the operation returns available, the image is successfully registered and available for launching.
Owner Id AWS account ID of the image owner.
Is Public
Architecture The architecture of the image.
Image Type The type of image (machine, kernel, or RAM disk).
Kernel Id The kernel associated with the image, if any. Only applicable for machine images.
Image Owner Alias The AWS account alias (e.g., amazon, self, etc.) or AWS account ID that owns the AMI.
Name The name of the AMI that was provided during image creation.
Description The description of the AMI that was provided during image creation.
Virtualization Type The type of virtualization of the AMI.
Tag Set Tags assigned to the resource. Each tag's information is wrapped in an item element.

Change Log

Version Date Description
1.1 2017-08-24 * Update the EC2 gem to AWS SDK 2.2.34.
* Change Info Values to be more consistent with the other AWS handlers.
* Internal tweaks to make execution similar to other AWS handlers.
1 2011-03-03 * Initial version. See README for details.