S3 - Create Session

Declaration

<AMAWSS3 ACTIVITY="create_session" SESSION="text" ACCESSKEY="text" SECRETKEY="text-encrypted" />

See Also

Description

Creates a unique session which can be used to associate subsequent S3 steps. This provides a single task the ability to execute numerous S3 operations simultaneously.

NOTE: To end a session, use the End Session activity.  

IMPORTANT: The S3 activities in AutoMate use the Amazon S3 engine to perform their work. Because of this, you must have a valid Amazon S3 service account to use these activities.

Practical Usage

Ideally used to create a session to correlate subsequent S3 activities to. Numerous sessions can be created for a single task.   

Parameters

Credentials Properties

Property

Type

Required

Default

Markup

Description

Access Key

Text

Yes

(Empty)

ACCESSKEY="MyAccessKey"

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

Secret Access Key

Text

Yes

(Empty)

 

SECRETKEY="SecretKey"

A 40-character string that serves the role as Password to access S3 (i.e. kWcrlUX5JEDGM/LtmEENI/aVmYvHNif5zB+d9+ct).

Protocol

Text

Yes

HTTP

MARKUP: PROTOCOL = "HTTPS"

Specifies the protocol that should be used to make requests to the S3 service.

The available options are:

  • HTTP (Default)

  • HTTPS

User Agent

Text

Yes

AutoMate

USERAGENT="AutoMate"

Sometimes it's necessary for a web site to understand how it is being viewed, so most user agents identify themselves by sending a User Agent string to the web site. The User-Agent request-header field contains information about the user agent originating the request. This is for statistical purposes, the tracing of protocol violations, and automated recognition of user agents for the sake of tailoring responses to avoid particular user agent limitations. The default value is AutoMate.

Service URL

Text

No

(Empty)

SERVICEURL=

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

The Service URL used to make requests to the S3 service. The Service URL provides the service endpoint.

Maximum retry on error

Number

No

(Empty)

MAXERRORRETRY="4"

Indicates how many times the Amazon S3 Engine should retry the request before generating an error.

Proxy Host

Text

No

(Empty)

PROXYHOST="proxy.host.com"

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

Proxy Port

Number

No

(Empty)

PROXYPORT="1028"

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

Session Name

Text

Yes

S3Session

SESSION="mySession"

Specifies the session name to create for this activity. Subsequent S3 activities can be linked to this  session allowing several S3 operations (that may contain multiple activities) to be performed within a single task. The default session name is S3Session.

NOTE: Make sure to use an End Session activity to end a particular session.

 

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 properties allows you to instruct a task step to react only to specific errors or ignore certain errors that should cause it to fail.

More on Error Causes properties

On Error Properties

The On Error tab properties lets you determine what the task should do if a particular step encounters an error as defined in the Error Causes properties.

More about On Error properties

Notes

Expressions, Variables and Functions

All text fields allow the use of expressions such as variables, functions or AutoMate extended functions, which can be entered by surrounding the expression in percentage signs (example: %FileDateTime(myVar)% or %myVar%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by clicking the Insert Expression (%) button or by pressing F2.

More on expressions

More on variables

More on function

More on extended functions
More on expression builder

Example

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

 

 

<AMAWSS3 ACTIVITY="create_session" SESSION="Session1" ACCESSKEY="AKIAJU2LHLMG6BA6BZTA" SECRETKEY="AM16I/ZtyZm558AL2TgY91IsZnSDzz65wmtOwlMZLej+8pN1hV0oiGZSCt+I7tngk5orkPqaJSCcLwvSPKP/3oLxyMBvuAhu25tgGI/cJAyVBWXvqzpvsHQxQ==aME" />

 

↑ Top of Page