Amazon DynamoDB - Get item

Declaration

<AMAWSDYNAMODB ACTIVITY="get_item" PROVIDER="session_based" SESSION="text" 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" HASH="text" HASHTYPE="text (options)" RANGE="text" RANGETYPE="text (options)" RESULTDATSET="text" />

Related Topics  

Description

Retrieves a set of attributes for an item that matches the supplied key and populates a dataset with results.

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

Practical usage

Used to retrieve information about a specific table item.

Parameters

Connection

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:
  • Host (default) - Specifies that user credentials and/or advanced preferences are configured individually for this activity. 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 Amazon 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. Multiple sessions can run simultaneously within a single task without interference.
Session Text Yes, if the connection is set to Session DynamoDBSession1 SESSION="myDynamoDBsession" The name of an existing session to associate with this activity. This parameter becomes active and is required if the Connection parameter is set to Session.
Access key Text Yes, if the connection is set to Host (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 the connection is set to Host (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 in order 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 number retries on error Number No (Empty) MAXERRORRETRY="7" The amount of times this activity should retry sending the request to the server 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 hostname (for example, server.domain.com) or IP address (for example, 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.

Item

Property Type Required Default Markup Description
Table Text Yes (Empty) TABLE="myTable" The name of the table that contains the item to retrieve information about.
Hash key Text Yes (Empty) HASH="theHash" The hash key of the item to get.
Hash type (unlabeled) Text (options) No String HASHTYPE="string" The hash key type. The available options are:
  • String - The hash key is a string type.
  • Number - The hash key is a number type.
Range key (optional) Text No (Empty) RANGE="theRange" The range key of the item to get.
Range type (unlabeled) Text (options) No String HASHTYPE="string" The range key type. The available options are:
  • String - The range key is a string type.
  • Number - The range key is a number type.
Create and populate dataset with table information Text (options) Yes (Empty) RESULTDATASET="mydata" The name of the dataset to create and populate with information about item. For more details, see Datasets below.

Description

Error Causes

On Error

Additional notes

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. Each attribute in an item is a name-value pair. An attribute can be single-valued or multi-valued set. For example, a book item can have title and authors attributes. Each book has one title but can have many authors. The table below displays a general layout of the dataset that this activity creates and populates.

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

Example

NOTE:
  • Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
  • To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.

Description

This sample task gets an item from a table.

Copy 
<AMAWSDYNAMODB ACTIVITY="get_item" ACCESSKEY="AKIAJ25JAKOPAC7GSQ7A" SECRETKEY="AM3i6P77pVEBOw=aME" TABLE="games" HASH="soccer" RANGE="2" RANGETYPE="number" RESULTDATSET="theDataset" />