Amazon SimpleDB - Get domain metadata

Amazon SimpleDB - Get Domain Metadata

Declaration

Description:

Returns information about the domain, including when the domain was created, the number of items and attributes, and the size of attribute names and values. The results are populated into a dataset.

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

Practical Usage

Allows developers to retrieve system statistics about the data contained within a specified domain. The dataset displays the current statistics for the specified domain at the time the activity was executed.

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 (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

Property	Type	Required	Default	Markup	Description
Domain Name	Text	Yes	(Empty)	DOMAIN="myDomain"	The name of the domain in which to gather metadata information from.
Create and populate dataset with metadata information	Text	Yes	(Empty)	RESULTDATASET="theDataset"	The name of the dataset to create and populate with metadata information. More on the specific fields that this dataset creates are detailed below under Datasets.

Description

Error Causes

On Error

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

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 was theDataset).

Name	Type	Return Value
theDataset.AttributeNameCount	Number	The number of unique attribute names in the domain.
theDataset.AttributeNamesSizeBytes	Number	The total size of all unique attribute names, in bytes.
theDataset.AttributeValueCount	Number	The number of all attribute name/value pairs in the domain.
theDataset.AttributeValuesSizeBytes	Number	The total size of all attribute values, in bytes.
theDataset.ItemCount	Number	The number of all items in the domain.
theDataset.ItemNamesSizeBytes	Number	The total size of all item names in the domain, in bytes.
theDataset.TimeStamp	Number	The data and time when the metadata was calculated in Epoch (UNIX) time. Unix time is a system for describing points in time, defined as the number of seconds elapsed since midnight proleptic Coordinated Universal Time (UTC) of January 1, 1970, not counting leap seconds. For example, on February 13, 2009, at exactly 23:31:30 (UTC) the decimal representation of Unix time was equal to '1234567890'.

Example

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

Description: Get "Domain.Name" domain's metadata and store it into dataset "theDataset". Use default SimpleDB session.

This help file is for the Advanced Workflow Engine v10. For other versions, please refer to http://help.globalscape.com/help/index.html

(If the Index and Contents are hidden, click the icon in the top left corner.)

If this help topic did not help you, try searching the Knowledgebase.
For the most up-to-date information, to view version history, updates, and activation instructions, visit the Support Center at http://www.globalscape.com/support-home.
For information about Globalscape, visit www.globalscape.com.

Last modified: 28-Jun-19 at 14:01:31