Amazon SimpleDB - List Domains
Declaration
<AMAWSSIMPLEDB ACTIVITY="list_domains" RESULTDATASET="text" />
Description: Retrieves a list of domain names and populates an dataset with the results.
Practical Usage
Used to populate a dataset with a list of domain names. A Loop Dataset action can be used as a subsequent step to loop through the populated list of domain names.
Connection Parameters
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:
|
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 (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 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. |
Domain Parameters
Property |
Type |
Required |
Default |
Markup |
Description |
---|---|---|---|---|---|
Maximum number of domains (max 100) |
Number |
Yes |
100 |
MAXDOMAIN="20" |
The maximum number of domain names you want returned. The range is 1 to 100. |
Next token (optional) |
Number |
No |
(Empty) |
NEXTTOKEN="[valid next token]" |
String that tells Amazon SimpleDB where to start the next list of domain names. |
Populate variable with returned next token |
Text |
No |
(Empty) |
RESULTVARIABLE="var1" |
The name of the variable in which to populate with the next token, an opaque token indicating that there are more domains than MaxNumberOfDomains domains still available. |
Create and populate dataset with domain information |
Text |
Yes |
(Empty)
|
RESULTDATASET="mydataset" |
The name of the dataset in which to create and populate with the list of domain names. More details can be found below under Datasets. |
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.)
SimpleDB Endpoints and Regions
For a complete list of Amazon Service endpoints, refer to the AWS documentation at https://docs.aws.amazon.com/general/latest/gr/rande.html.
Datasets
A dataset is a multiple column, multiple row container object. This activity creates and populates a dataset containing a specific set of fields in addition to the standard dataset fields. The table below describes these fields (assuming the dataset name assigned is theDataset).
Name |
Type |
Return Value |
---|---|---|
theDataset.DomainName |
Text |
Returns the Domain Name. |
Example
The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.
Description: Get list of SimpleDB domains and store it into dataset theDataset". Use default SimpleDB session.
<AMAWSSIMPLEDB ACTIVITY="list_domains" RESULTDATASET="theDataset" />