Skip to main content
Kinetic Community

AWS EC2 Instance List

Retrieves list of machine instances attached to the AWS credentials supplied

Downloads

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

aws_ec2_instance_list_v1.zip

Detailed Description

This handler will be used primarily in a loop to iterate over multiple EC2 image
instances. In order to be used by the Loop handler, a single value is returned
as an escaped XML string. called "Instance List".

The Instance List will have the following format:
<instances>
    <instance>i-01234567</instance>
    <instance>i-abcdefgh</instance>
    <instance>i-0123abcd</instance>
</instances>

To setup the Loop handler, refer to the Instance List from this handler for
'Data Source' and use '/instances/instance'as the 'Variable Path'.

The describe_instances 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 "reservationsSet".

The reservationSet 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.

<reservationsSet>
 <reservationId/)
  <requesterId/>,
 <item>
    <groupSet>
      <item">
        <groupId/>
      </item>
     </groupSet>
    <instancesSet>
      <item>
        <blockDeviceMapping>
          <item>
            <ebs>
               <attachTime/>,
               <status/>,
               <deleteOnTermination/>,
               <volumeId/>,
               <deviceName>
             </ebs>
           </item>
         <tagSet>
           <item>
             <value/>
             <key/>
            </item>
          </tagset>,
          <virtualizationType/>,
          <productCodes/>
          <ipAddress/>,
          <kernelId/>
          <amiLaunchIndex/>
          <clientToken/>,
          <privateIpAddress>,
          <keyName/>",
          <launchTime>,
          <instanceType/>,
          <imageId/>,
          <privateDnsName/>,
          <rootDeviceName/>,
          <rootDeviceType/>
          <monitoring/>",
          <reason/>,
          <placement/>
          <dnsName/>,
          <instanceId/>,
          <instanceState>
             <name/>
             <code/>
           </instanceState>
        </item>
      </instanceSet>
    </item>
  </reservationSet>,

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

<reservationsSet>
  <item>
     <instancesSet>
      <item>
          <imageId/>,
        </item>
      </instanceSet>
    </item>
  </reservationSet>

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.reservationSet.item[index].instancesSet.item[index].imageId

 

Parameters

This handler has no parameters

Sample Configuration

This handler has no sample configuration

Results

Name Description
Instance List An XML string representing a list of instances

Change Log

Version Date Description
1.1 2017-08-23 * 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.