Amazon
SimpleDB - Put attributes
Declaration
<AMAWSSIMPLEDB ACTIVITY="put_attributes" PROVIDER="text (options)" 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" DOMAIN="text" ITEM="text" ATTRNAME="text" ATTRVALUE="text"><ATTRIBUTE NAME="text" VALUE="text" REPLACE="TRUE/FALSE" /></AMAWSSIMPLEDB>
Description
Creates or replaces attributes in an item. You specify new attributes using a combination of the Attribute Name and Attribute Value parameters. Optionally, you can enable the Replace parameter for each individual attribute which causes the new attribute value to replace the existing attribute value.
IMPORTANT: Automate Desktop's
SimpleDB activities use Amazon's SimpleDB engine to perform their
work, therefore, launching and operating Amazon SimplDB through Automate Desktop requires a valid Access Key ID and Secret Access Key.
Practical usage
Useful for conducting conditional updates to ensure multiple processes do not overwrite each other. To prevent this from occurring, you can specify the expected attribute name and value. If they match, SimpleDB performs the update. Otherwise, the update does not occur.
Parameters
Connection
| Property | Type | Required | Default | Markup | Description |
|---|---|---|---|---|---|
| Connection | --- | --- | --- | --- | Indicates
where Automate Web Service WS 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 | Text | Yes, if the Connection parameter is set to Session | 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 the Connection parameter is set to Host | (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 the Connection parameter is set to Host | (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 Desktop. The default value is Automate. |
| Maximum number of retries 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. |
| 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. Refer to SimpleDB regions and endpoints for a complete list of SQS regions, along with their associated endpoints and valid protocols.. |
| Proxy host | Text | No | (Empty) | PROXYHOST="proxy.host.com" | The hostname (for example, server.domain.com) or IP address (for example, 192.168.0.100) 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 | Markup | 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="myItemName" | The name of the item in which to perform the operation. |
| Name (Attributes) | Text | Yes | (Empty) | NAME="attributeName" | The name of the attribute. This can be any positive integer or 0. Multiple attribute name/value items can be entered. To add a new attribute name/value, select Click here to add a new item. To delete an attribute name/value item, click "X". |
| Value (Attributes) | Text | Yes | (Empty) | VALUE="attribValue" | The value of the attribute. This can be any positive integer or 0. Multiple attribute name/value items can be entered. To add a new attribute name/value, select Click here to add a new item. To delete an attribute name/value item, click "X". |
| Replace (Attributes) | TRUE/FALSE | No | No | REPLACE="TRUE" | If selected, specifies that the selected attribute/value will be replaced. If disabled, a new attribute/value will be created. The default value is FALSE. |
| Update condition | --- | --- | --- | --- | If enabled, allows conditional updates to take place depending on whether the specified attribute name (or attribute name/value combination) entered in the Attribute Name/Attribute Value fields currently exists/does not exist. Other parameters become available if this parameter is enabled. This is a design time parameter, therefore contains no markups. |
| Attribute exists/Attribute does not exist | Yes/No | No | Yes | ATTREXISTS="no" | If selected, the specified attribute name (or attribute name/value combination) entered in the Attribute Name/Attribute Value fields must exist with the specified value in order for this update condition to be satisfied. If disabled, the specified attribute name (or attribute name/value combination) should not exist in order for this update condition to be satisfied. |
| Attribute Name | Text | No | (Empty) | ATTRNAME="NametoCheck" | The name of the conditional attribute that should be checked. |
| Attribute Value | Text | No | (Empty) | ATTRVALUE="ValuetoCheck" | The value of the conditional attribute that should be checked. |
Additional notes
SimpleDB regions and endpoints
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:
- 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 puts attributes in an item.
Copy
<AMAWSSIMPLEDB ACTIVITY="put_attributes" PROVIDER="session_based" SESSION="SimpleDBSession1" DOMAIN="TheDomain" ITEM="Records"><ATTRIBUTE NAME="April" VALUE="14241" REPLACE="False" /><ATTRIBUTE NAME="January" VALUE="14520" REPLACE="False" /><ATTRIBUTE NAME="February" VALUE="16522" REPLACE="False" /><ATTRIBUTE NAME="March" VALUE="14521" REPLACE="True" /></AMAWSSIMPLEDB>