Amazon SimpleDB - Get attribute(s)

 

Declaration

<AMAWSSIMPLEDB ACTIVITY="get_attributes" DOMAIN="text" ITEM="text" CONSISTENTREAD="Yes/No" RESULTDATASET="text" />

Related Topics   

Description

Returns the attribute(s) and value(s) associated with an item and populates a dataset with the results. Optionally, the attributes returned can be limited to one or more specified attribute name parameters. A Loop Dataset step can be used to loop through each row of data populated by the specified dataset in order to perform specific operations on them.

IMPORTANT: AutoMate's SimpleDB activities use Amazon's SimpleDB engine to perform their work, therefore, launching and operating Amazon SimplDB through AutoMate requires a valid Access Key ID and Secret Access Key.

Practical Usage

Used to get attributes of an item.

Parameters

connection

Property

Type

Required

Default

Markup

Description

Connection

       

Indicates where AWS user credentials and preferences should originate from. This is a design mode parameter used only during task construction and configuration, thus, comprises no markup. The available options are:

  • Host (default) - Specifies that user credentials and/or advanced preferences are configured individually for this activity. This option is normally chosen if only a single activity is required to complete an operation.

  • Session - Specifies that user credentials and/or advanced preferences are obtained from a pre-configured session created in an earlier step with the use of the SimpelDB - Create session activity. This option is normally chosen if a combination of related activities are required to complete an operation. Linking several activities to a single session eliminates redundancy. Additionally, a single task supports construction and simultaneous execution of multiple sessions, improving efficiency.

Session

Text

Yes if connection is session-based

SQSSession1

SESSION="SimpleDBSession1"

The name of an existing session to attach this activity to. This parameter is active only if the Connection parameter is set to Session. The default session name is 'SimpleDBSession1'.

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. This parameter is active only if the Connection parameter is set to Host.

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 SQS uses to confirm a valid user's identity. This parameter is active only if the Connection parameter is set to Host.

User agent

Text

No

AutoMate

USERAGENT="AutoMate"

The name of the client or application initiating requests to AWS, which in this case, is AutoMate. This parameter's default value is 'AutoMate'. 

Service URL

Text

No

(Empty)

SERVICEURL=

"https://sdb.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://sdb.us-west-1.amazonaws.com points to US West (Northern California) region. A complete list of SQS regions, along with their associated endpoints and valid protocols can be found below under SimpleDB Endpoints and Regions.

Maximum retry on error

Number

No

(Empty)

MAXERRORRETRY="4"

The total amount of times this activity should retry its request to the server 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"

The host name (i.e. server.domain.com) or IP address (i.e. xxx.xxx.xxx.xxx) 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.

Proxy username

Text

No

(Empty)

PROXYUSER="username"

The username that should be used to authenticate connection with the proxy server (if required).

Proxy password

Text

No

(Empty)

PROXYPWD="encrypted"

The password that should be used to authenticate connection with the proxy server (if required).

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. Acceptable 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.

Data

Property

Type

Required

Default

Attributes

Description

Domain Name

Text

Yes

(Empty)

DOMAIN="myDomain"

The name of the domain in which to perform the operation.

Item Name

Text

Yes

(Empty)

ITEM="records"

The item to retrieve attributes from.

Attribute(s)

Text

No

(Empty)

ATTR="January"

The name of the attribute to retrieve.

Consistent Read

Yes/No

No

No

CONSISTENTREAD="yes"

If set to YES, ensures that the most recent data is returned. Set to NO by default.

Create and populate dataset with SimpleDB attribute information.

Text

No

(Empty)

RESULTDATASET="theDatase"

The name of the dataset to create and populate with attribute value(s).

 

Description

Error Causes

On Error

additional notes

SimpleDB Endpoints and Regions

This table contains a complete list of Amazon Simple Queue Service endpoints, along with their corresponding regions and supported protocols.

Endpoint

Region

Protocol

sdb.amazonaws.com US East (Northern Virginia) Region HTTP and HTTPS
sdb.us-west-2.amazonaws.com US West (Oregon) Region HTTP and HTTPS
sdb.us-west-1.amazonaws.com US West (Northern California) Region HTTP and HTTPS
sdb.eu-west-1.amazonaws.com EU (Ireland) Region HTTP and HTTPS
sdb.ap-southeast-1.amazonaws.com Asia Pacific (Singapore) Region HTTP and HTTPS
sdb.ap-southeast-2.amazonaws.com Asia Pacific (Sydney) Region HTTP and HTTPS
sdb.ap-northeast-1.amazonaws.com Asia Pacific (Tokyo) Region HTTP and HTTPS
sdb.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: Get January attribute(s) from "Records" item in domain "theDomain" and store it into Dataset "theData". Return most recently written data. Use default SimpleDB session.

 

<AMAWSSIMPLEDB ACTIVITY="get_attributes" DOMAIN="theDomain" ITEM="Records" ATTR="January" CONSISTENTREAD="yes" RESULTDATASET="theData" />