EC2 - List Snapshots

Declaration

<AMAWSEC2 ACTIVITY="list_snapshots" SNAPSHOTID="text" OWNER="text" RESULTDATASET="text" />

See Also

EC2 - Create Session | EC2 - Create Snapshot | EC2 - Delete Snapshot | EC2 - End Session | EC2 - Launch Instance | EC2 - List Addresses | EC2 - List Images | 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

Retrieves the indicated snapshot or all snapshots and populates a dataset with the results. Snapshots available to the user include public snapshots available for any user to launch, private snapshots owned by the user making the request, and private snapshots owned by other users for which the user granted explicit create volume permissions.

Snapshots are differential backups which means that only the blocks on the device that have changed since your last snapshot will be incrementally saved. For instance, if you have a device with 100 GBs of data, but only 5 GBs of data has changed since your last snapshot, only the 5 additional GBs of snapshot data will be stored back to Amazon S3.

NOTE: The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or users with create volume permissions. If no options are specified, this activity returns all snapshots for which the user has create volume 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

Commonly used to retrieve information about EBS snapshots available to you. The information retrieved can be referenced in subsequent EC2 related steps such as Delete Snapshot.

Parameters

Snapshot Properties

Property

Type

Req'd

Default

Markup

Description

Snapshot ID (Optional)

Text

No

(Empty)

SNAPSHOTID="snap-78a54011"

The ID of the Amazon EBS snapshot. If this field is left blank, all snapshots for which the user has create volume permissions are returned.

Owner

Text

Yes

self

OWNER="218213537122"

Returns snapshots owned by the specified owner.

Restorable By (Optional)

Text

No

(Empty)

SNAPSHOTDESC="Backup"

Account ID of a user that can create volumes from the snapshot.

Create and populate dataset with EC2 snapshot information

Text

Yes

(Empty)

RESULTDATASET="myDataset"

The name of a dataset in which to create and populate information regarding the EC2 snapshot(s) being retrieved. 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

Req'd

Default

Markup

Description

Provide Credentials

 

 

 

 

Indicates where this activity's credentials should originate from. Different properties apply depending on the option selected. This is a design-time parameter used interactively during  construction mode, thus, contains no markups. 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 name assigned was theDataset).

Name

Type

Return Value

theDataset.Description

Text

Returns the description of the snapshot, if applicable.

theDataset.OwnerID

Text

Returns the ID of the owner. This is the AWS Access Key ID of the user who owns the snapshot.

theDataset.Progress

Date

The progress of the snapshot, in percentage.

theDataset.SnapshotId

Number

Returns the ID of the snapshot.

theDataset.StartTime

Text

Returns the time stamp when the snapshot was initiated.

theDataset.Status

Text

Returns the snapshot state (i.e. pending, completed, error).

theDataset.VolumeId

Text

Returns the ID of the volume from which the snapshot was created.

theDataset.VolumeSize

Number

Returns the size of the volume from which the snapshot was created.

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 EC2 snapshot(s) and store it into dataset "myDataset". Snapshot id is "snap-78a54011". Snapshot owner is "218213537122". Use default EC2 session.

 

<AMAWSEC2 ACTIVITY="list_snapshots" SNAPSHOTID="snap-78a54011" OWNER="218213537122" RESULTDATASET="myDataset" />

 

↑ [Top of Page]