EC2 - List Images

Declaration

<AMAWSEC2 ACTIVITY="list_images" IMAGEID="text" OWNER="text" EXECUTEDBY="text" RESULTDATASET="text" />

See Also

EC2 - Main, EC2 - Allocate Address, EC2 - Associate Address, EC2 - Attach Volume, EC2 - Authorize Security Group, EC2 - Create Key Pair, EC2 - Create Security Group, EC2 - Create Session, EC2 - Create Snapshot, EC2 - Create Volume, EC2 - Delete Key Pair, EC2 - Delete Security Group, EC2 - Delete Snapshot, EC2 - Delete Volume, EC2 - Disassociate Address, EC2 - End Session, EC2 - Launch Instance, EC2 - List Addresses, EC2 - List Key Pairs, EC2 - List Running Instances, EC2 - List Security Groups, EC2 - List Snapshots, EC2 - List Volumes,  EC2 - Reboot Instance, EC2 - Release Address, EC2 - Revoke Security Group, EC2 - Start Instance, EC2 - Stop Instance, EC2 - Terminate Instance

Description

Returns information about AMIs (Amazon Machine Images) and populates a dataset with the results. This includes image type, product codes and architecture. Images available to you include public images, private images that you own, and private images owned by other users for which you have explicit launch permissions.

Launch permissions fall into three categories:

Permission Category

Description

Public

The owner of the AMI granted launch permissions for the AMI to the all group. All users have launch permissions for these AMIs.

Explicit

The owner of the AMI granted launch permissions to a specific user.

Implicit

A user has implicit launch permissions for all AMIs he or she owns.

 

NOTE: The list of AMIs returned can be modified by specifying AMI IDs, AMI owners, or users with launch permissions. If no options are specified, Amazon EC2 returns all AMIs for which the user has launch permissions.

 

IMPORTANT: The EC2 activities are performed using Amazon's EC2 engine. You must enter a valid Amazon EC2 service account in order for these activities to work properly.

Practical Usage

Used to get a list of AMIs. The information retrieved can be referenced in subsequent EC2 steps with the use of the Loop Dataset action.

Parameters

Image Properties

Property

Type

Required

Default

Markup

Description

Image ID (Optional)

Text

No

(Empty)

IMAGEID="ami-78a54011"

Specifies the ID of the Amazon Machine Image (AMI) to describe. Use this option to retrieve information about a specific AMI. If this field is left blank, information about all AMIs are returned.

Executable By (Optional)

Text

No

(Empty)

EXECUTEDBY="-x self"

Returns AMIs for which the specified user has explicit launch permissions. The user ID can be a user's account ID, self to return AMIs for which the sender of the request has explicit launch permissions, or all to return AMIs with public launch permissions.

Owner (Optional)

Text

No

(Empty)

OWNER="157SZTMZQT516NAZ7CR2"

Returns AMIs owned by the specified owner. Multiple owners can be specified. The IDs amazon, self, and explicit can be used to include AMIs owned by Amazon, AMIs owned by the user or AMIs for which the user has explicit launch permissions, respectively.

Create and populate dataset with Amazon Machine Image (AMI) information

Text

Yes

(Empty)

RESULTDATASET="mydataset"

The name of a dataset in which to create and populate information regarding the list of AMIs returned. More details regarding the fields that this dataset creates can be found below under Additional Notes.

 

Credentials Properties

These properties allow you to create a custom session for this activity or link this activity to an existing session.

Property

Type

Required

Default

Markup

Description

Provide Credentials

 

 

 

 

Indicates where this activity's credentials should originate from. Different properties apply depending on the option selected.

The available options are:

  • Custom (Default) - Specifies that a custom set of credentials will be entered for this EC2 activity. Select this option if performing a single EC2 activity.

  • Session Based - Specifies that credentials should derive from a session created in a previous step with the use of the Create Session activity. This allows several EC2 activities to be linked to a specific session.

Access Key

Text

Yes

(Empty)

ACCESSKEY="MyAccessKey"

A 20-character, alphanumeric string that uniquely identifies a user who owns a EC2 account (i.e. 022QF06E7MXBSH9DHM02). This along with a Secret Access Key forms a secure information set that EC2 uses to confirm a valid user's identity.

This property is active only if Custom is selected under the Provide Credentials property.

Secret Access Key

Text

Yes

(Empty)

SECRETKEY="SecretKey"

A 40-character string that serves the role as Password to access EC2 (i.e. kWcrlUX5JEDGM/LtmEENI/aVmYvHNif5zB+d9+ct). This along with an associated Access Key forms a secure information set that EC2 uses to confirm a valid user's identity.

This property is active only if Custom is selected under the Provide Credentials property.

User Agent

Text

No

AutoMate

USERAGENT="AutoMate"

The User-Agent header name. The User-Agent request-header field contains information about the user agent originating the request such as timeouts, proxies, name, etc. The default User Agent name is AutoMate.

This property is active only if Custom is selected under the Provide Credentials property.

Service URL

Text

No

(Empty)

SERVICEURL=

"https://sdb.eu-west-1.amazonaws.com"

The Service URL used to make requests to the EC2 service. The Service URL provides the service endpoint. For example, To make the service call to a different region, you can pass the region-specific endpoint, such as 'https://sdb.eu-west-1.amazonaws.com'.

This property is active only if Custom is selected under the Provide Credentials property.

Maximum retry on error

Number

No

(Empty)

MAXERRORRETRY="4"

Signifies how many times the Amazon EC2 engine should retry the request before returning an error.

This property is active only if Custom is selected under the Provide Credentials property.

Proxy Host

Text

No

(Empty)

PROXYHOST="proxy.host.com"

The host name (server.domain.com) or IP address (xxx.xxx.xxx.xxx) of the proxy server.

This property is active only if Custom is selected under the Provide Credentials property.

Proxy Port

Number

No

(Empty)

PROXYPORT="1028"

The port that should be used to connect to the proxy server.

This property is active only if Custom is selected under the Provide Credentials property.

Signature Method

Text

No

(Empty)

SIGNMETHOD="HmacSHA256"

The Signature Method for signing the request.

This property is active only if Custom is selected under the Provide Credentials property.

Signature Version

Number

No

(Empty)

SIGNVERSION="2"

The Signature Version for signing the request. The version refers to the particular algorithm for signing the request.

This property is active only if Custom is selected under the Provide Credentials property.

Session Name

Text

Yes

EC2Session

SESSION="EC2Session1"

The session name to be created. This allows several EC2 activities to be linked to this  session, eliminating redundancy. Numerous sessions can be used within a single task. The default value is EC2Session.

NOTE: Use the End Session activity to end an EC2 session.

This property is active only if Session Based is selected under the Provide Credentials property.

Description Properties

The Description tab allows you to customize the text description of any step as it appears in the Task Builder's Steps Pane.

More on setting custom step description

Error Causes Properties

The Error Causes tab allows you to select/omit specific errors that should cause a particular step to fail.

More on Error Causes properties

On Error Properties

The On Error tab allows you to determine what the task should do if a particular step encounters an error.

More about On Error properties

Additional Notes

Datasets

A dataset is a multiple column, multiple row container object. This activity creates and populates a dataset containing a specific set of fields in addition to the standard dataset fields. The table below describes these fields (assuming the dataset assigned is named theDataset).

Name

Type

Return Value

theDataset.Architecture

Text

Returns the image architecture (i.e. i386 or x86_64)

theDataset.Description

Text

Returns the description of the AMI.

theDataset.ImageId

Text

Returns the unique ID of the AMI.

theDataset.ImageLocation

Text

Returns the location of the AMI.

theDataset.ImageOwnerAlias

Text

Returns the AWS account alias (i.e. "amazon") or AWS account ID that owns the AMI.

theDataset.ImageState

Text

Returns the current state of the AMI.

theDataset.ImageType

Text

Returns the Image type (i.e. machine, kernel, or ramdisk)

theDataset.KernelId

Text

Returns the kernel associated with the image, if any.

NOTE: Only applicable for machine images.

theDataset.Name

Text

Returns the name of the AMI.

theDataset.OwnerId

Text

Returns the AWS Access Key ID of the image owner.

theDataset.Platform

Text

Returns the operating platform of the instance.

theDataset.ProductCode

Text

Returns the product codes, if any, that are attached to the instance.

theDataset.RamdiskId

Text

Returns the RAM disk associated with the image, if any.

NOTE: Only applicable for machine images.

theDataset.RootDeviceName

Text

Returns the root device name (i.e. /dev/sda1).

theDataset.RootDeviceType

Text

Returns the root device type used by the AMI. The AMI can use an Amazon EBS or instance store root device.

theDataset.StateReason

Text

Returns the reason for the state change.

theDataset.Visibility

Text

Returns the image visibility (i.e. public or private)

Variables and Expressions

All text fields allow the use of expressions, which can be entered by surrounding the expression in percentage signs (example: %MYVARIABLE%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by pressing F2.

More on variables
More on expressions

More on the expression builder

Example

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

 

Description: Get list of Amazon Machine Image(s) (AMI) and store it into dataset "results". Image id is "ami-78a54011". Image can be executed by "-x self". Image owner is "-o 157SZTMZQT516NAZ7CR2". Use default EC2 session.

 

<AMAWSEC2 ACTIVITY="list_images" IMAGEID="ami-78a54011" OWNER="-o 157SZTMZQT516NAZ7CR2" EXECUTEDBY="-x self" RESULTDATASET="results" />

 

↑ Top of Page