Amazon EC2 - Create session

Declaration

Description:

Creates a unique session which can be used to associate subsequent Amazon EC2 (Elastic Compute Cloud) steps. This provides a single task the ability to execute numerous EC2 operations associated to a specific session.

IMPORTANT: AWS EC2 activities are performed using Amazon's EC2 engine. They require a valid Amazon EC2 service account (via Access key and Secret access key) to ensure proper functionality.

Practical Usage

Ideally used to create a session to correlate subsequent Amazon EC2 activities to. Creating a session eliminates having to re-enter specific requirements for each activity.

Parameters

Credentials

Property	Type	Required	Default	Markup	Description
Access key	Text	Yes if connection is host-based	(Empty)	ACCESSKEY= "022QF06E7MXBSH9DHM02"	A 20-character alphanumeric string that uniquely identifies the owner of the AWS service account, similar to a username. This key along with a corresponding secret access key forms a secure information set that AWS uses to confirm a valid user's identity.
Secret Access key	Text	Yes if connection is host-based	(Empty)	SECRETKEY= "kWcrlUX5JEDGM/LtmEENI/ aVmYvHNif5zB+d9+ct"	A 40-character string that serves the role as password to access the AWS service account. This along with an associated access key forms a secure information set that EC2 uses to confirm a valid user's identity.
User agent	Text	No	AutoMate	USERAGENT="AutoMate"	The name of the client or application initiating requests to AWS. The default value is 'AutoMate'.
Service URL	Text	No	(Empty)	SERVICEURL= "https://ec2.eu-west-1.amazonaws.com"	The URL that provides the service endpoint. To make the service call to a different region, you can pass the region-specific endpoint URL. For example, entering https://ec2.us-west-1.amazonaws.com points to US West (Northern California) region. A complete list of EC2 regions, accompanying endpoints and valid protocols can be found below under EC2 Regions and Endpoints.
Maximum retry on error	Number	No	(Empty)	MAXERRORRETRY="4"	The total amount of instances this activity should retry the request before returning an error. Network components can generate errors anytime in the life of a request, thus, implementing retries can increase reliability.
Proxy host	Text	No	(Empty)	PROXYHOST="proxy.host.com" PROXYHOST="193.118.431.52"	The host name (e.g.,server.domain.com) or IP address (e.g.,xxx.xxx.xxx.xx) of the proxy server to use when connecting to AWS.
Proxy port	Number	No	(Empty)	PROXYPORT="1028"	The port that should be used to connect to the proxy server.
Signature method	Text	No	(Empty)	SIGNMETHOD="HmacSHA256"	The signature method to use for signing the request. This provides a valid hashing algorithm for signature calculation. Valid AWS signature methods are HmacSHA1 and HmacSHA256.
Signature version	Number	No	(Empty)	SIGNVERSION="2"	The signature version for signing the request. Valid AWS signature versions are 2 and 4. The difference with version 4 is that it allows you to sign your message using a key that is derived from your secret access key rather than using the secret access key itself.
Session Name	Text	Yes	EC2Session1	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 EC2Session1. NOTE: Use the End Session activity to end an EC2 session.

Description

Error Causes

On Error

EC2 Regions and Endpoints

This table contains a complete list of EC2 endpoints, accompanying regions and supported protocols.

Endpoint	Region	Protocol
ec2.us-east-1.amazonaws.com	US East (Northern Virginia) Region	HTTP and HTTPS
ec2.us-west-2.amazonaws.com	US West (Oregon) Region	HTTP and HTTPS
ec2.us-west-1.amazonaws.com	US West (Northern California) Region	HTTP and HTTPS
ec2.eu-west-1.amazonaws.com	EU (Ireland) Region	HTTP and HTTPS
ec2.ap-southeast-1.amazonaws.com	Asia Pacific (Singapore) Region	HTTP and HTTPS
ec2.ap-southeast-2.amazonaws.com	Asia Pacific (Sydney) Region	HTTP and HTTPS
ec2.ap-northeast-1.amazonaws.com	Asia Pacific (Tokyo) Region	HTTP and HTTPS
ec2.sa-east-1.amazonaws.com	South America (Sao Paulo) Region	HTTP and HTTPS

Example

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

Description: Create EC2 session "MyEC2Session". AWS access key is "AKIAJU2LHLMG6BA6BZTB".

This help file is for the Advanced Workflow Engine v10. For other versions, please refer to http://help.globalscape.com/help/index.html

(If the Index and Contents are hidden, click the icon in the top left corner.)

If this help topic did not help you, try searching the Knowledgebase.
For the most up-to-date information, to view version history, updates, and activation instructions, visit the Support Center at http://www.globalscape.com/support-home.
For information about Globalscape, visit www.globalscape.com.

Last modified: 28-Jun-19 at 14:01:39