Amazon DynamoDB - Scan

<AMAWSDYNAMODB ACTIVITY="scan" 
ACCESSKEY="text" 
SECRETKEY="text (encrypted)" 
USERAGENT="text" 
MAXERRORRETRY="number" 	 
SERVICEURL="text" 
PROXYHOST="text" 
PROXYPORT="number" 
PROXYUSER="text" 
PROXYPWD="text (encrypted)" 	 
SIGNMETHOD="text" 
SIGNVERSION="number" 
TABLE="text" 
RESULTDATSET="text" />

Description: Performs a full scan of a table and populates a dataset with results.

IMPORTANT: : The AWS DynamoDB activities are performed using Amazon's DynamoDB engine, therefore, launching and managing DynamoDB requires a valid Access Key ID and Secret Access Key.

Practical Usage

Another method of retrieving item attributes that exist in a table.

Connection Parameters

Property

Type

Required

Default

Markup

Description

Connection

 

 

 

 

Indicates where 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:

  • 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 DynamoDB - Create session activity. Normally chosen if a combination of activities within the same action group are required. Linking several activities to a single session eliminates redundancy and improves efficiency. Several sessions can exist in a single task. Multiple sessions can run simultaneously without interference.

Session

Text

Yes if connection is session-based

DynamoDB

Session1

SESSION="myDynamoDBsession"

The name of an existing session to associate this activity with. The default value is DynamoDBSession1. This parameter is active only if the Connection parameter is set to Session.

Access key

Text

Yes if connection is host-based

(Empty)

ACCESSKEY="[accessKey]"

The ID that uniquely identifies the owner of the AWS service account (similar to a username). Together, the Access Key and Secret Access Key are the main credentials used to access and control basic AWS services through the API. 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="[SecretKey]"

The secret ID that corresponds with the Access Key (similar to a password). When a request is sent, AWS verifies that this key corresponds with the Access Key to authenticate the signature and confirm that the request sender is legitimate. 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. The default value is AutoMate. 

Maximum retries on error

Number

No

(Empty)

MAXERRORRETRY="7"

The amount of times this activity should retry sending the request to the sever before returning an error. Network components can generate errors anywhere in the life of a given request, therefore, implementing retries can increase reliability. 

Service URL

Text

No

(Empty)

SERVICEURL=

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

The URL that provides the service region endpoint. To make the service call to a different region, simply specify the region-specific endpoint. For example, entering https://dynamodb.us-east-1.amazonaws.com would point to US East (Northern Virginia) region. A complete list of DynamoDB regions and their associated endpoints  can be found below under DynamoDB Regions and Endpoints.  

Proxy host

Text

No

(Empty)

PROXYHOST="proxy.host.com"

The host name (e.g., server.domain.com) or IP address (e.g., xxx.xxx.xxx.xxx) of the proxy server to use when connecting to AWS.  

Proxy port

Number

No

(Empty)

PROXYPORT="1028"

The port number to use to connect to the proxy server. 

Proxy username

Text

No

(Empty)

PROXYUSERNAME="Username"

The username to authenticate with the proxy server.

Proxy password

Text

No

(Empty)

PROXYPWD="encrypted"

The password to authenticate with 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.

Table

Property

Type

Required

Default

Markup

Description

Table

Text

Yes

(Empty)

TABLE="myTable"

The name of the table containing the requested items.

Create and populate dataset with table information

Text (options)

Yes

(Empty)

RESULTDATASET="mydata"

The name of the dataset to create and populate with scan results. For more details, see Datasets below.

Description tab - A custom description can be provided on the Description tab to convey additional information or share special notes about a task step.

Error Causes tab - Specify how this step should behave upon the occurrence of an error. (Refer to Task Builder > Error Causes Tab for details.)

On Error tab - Specify what AWE should do if this step encounters an error as defined on the Error Causes tab. (Refer to Task Builder > On Error Tab for details.)

DynamoDB Regions and Endpoints

This table contains a complete list of DynamoDB endpoints, associated regions and supported protocols.

Endpoint

Region

Protocol

elasticmapreduce.us-east-1.amazonaws.com

US East (Northern Virginia) Region

HTTP and HTTPS

elasticmapreduce.us-west-2.amazonaws.com

US West (Oregon) Region

HTTP and HTTPS

elasticmapreduce.us-west-1.amazonaws.com

US West (Northern California) Region

HTTP and HTTPS

elasticmapreduce.eu-west-1.amazonaws.com

EU (Ireland) Region

HTTP and HTTPS

elasticmapreduce.ap-southeast-1.amazonaws.com

Asia Pacific (Singapore) Region

HTTP and HTTPS

elasticmapreduce.ap-southeast-2.amazonaws.com

Asia Pacific (Sydney) Region

HTTP and HTTPS

elasticmapreduce.ap-northeast-1.amazonaws.com

Asia Pacific (Tokyo) Region

HTTP and HTTPS

elasticmapreduce.sa-east-1.amazonaws.com

South America (Sao Paulo) Region

HTTP and HTTPS

Datasets

A dataset is a multi-column, multi-row object that contains a collection of information gathered during runtime and stored in memory. This activity creates and populates a dataset with the following fields (rows):

Name

Type

Return Value

theDataset.Attribute1[Name]

Text/Number

Attribute value

theDataset.Attribute2[Name]

Text/Number

Attribute value

theDataset.Attribute3[Name]

Text/Number

Attribute value

theDataset.Attribute4[Name]

Text/Number

Attribute value

Examples

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

Description: Scan table "games". Access key is "AKIAJ25JAKOPAC7GSQ7A".

<AMAWSDYNAMODB ACTIVITY="scan" ACCESSKEY="AKIAJ25JAKOPAC7GSQ7A" 
			SECRETKEY="AM3Z+vGklNJUiw=aME" TABLE="games" 
				RESULTDATSET="theDataset" />