SimpleDB - Get Domain Metadata

 

Declaration

<AMAWSSIMPLEDB ACTIVITY="get_domain_metadata" DOMAIN="text" RESULTDATASET="text (dataset name)"/>

See Also

SimpleDB - Create Domain | SimpleDB - Create Session | SimpleDB - Delete Attribute(s) | SimpleDB - Delete Domain | SimpleDB - End Session | SimpleDB - Get Attribute(s) | SimpleDB - Get Domain Metadata | SimpleDB - List Domains | SimpleDB - Put Attribute(s) | SimpleDB - Query

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: The SimpleDB activities use Amazon's SimpleDB engine to perform their work. Therefore, you must have a valid Amazon SimpleDB service account to perform these activities.

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

Domain Properties

Property

Type

Req'd

Default

Markup

Description

Domain Name

Text

Yes

(Empty)

DOMAIN="myDomain"

Specifies 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 be created and populated with the metadata information. More on the specific fields that this dataset creates are detailed below under Additional Notes.

Credentials Properties

The Credentials properties allows you to set or link specific parameters for this particular SimpleDB activity such as Access Key, Secret Access Key, Service URL, etc.

Property

Type

Req'd

Default

Markup

Description

Provide Credentials

 

 

 

 

Indicates where this activity's credentials should originate from. Different properties apply depending on the option selected. This is a design-time parameter used interactively during  construction mode, thus, contains no markups. The available options are:

  • Custom (Default) - Specifies that a custom set of credentials will be entered for this SimpleDB activity. Select this option if performing a single SimpleDB activity.

  • Session Based - Specifies that credentials should derive from a session created in a previous step with the use of the Create Session activity. This allows several SimpleDB activities to be linked to a specific session, eliminating redundancy.

Access Key

Text

Yes

(Empty)

ACCESSKEY="MyAccessKey"

A 20-character, alphanumeric string that uniquely identifies a user who owns a SimpleDB account. This along with a Secret Access Key forms a secure information set that SimpleDB uses to confirm a valid user's identity. This property is active only if Custom is selected under the Provide Credentials property.

Secret Access Key

Text

Yes

(Empty)

SECRETKEY="SecretKey"

A 40-character string that serves the role as Password to access SimpleDB. This along with an associated Access Key forms a secure information set that SimpleDB uses to confirm a valid user's identity. This property is active only if Custom is selected under the Provide Credentials property.

User Agent

Text

No

AutoMate

USERAGENT="AutoMate"

The User-Agent header name. The User-Agent request-header field contains information about the user agent originating the request such as time outs, proxies, name, etc. The default User Agent name is AutoMate. This property is active only if Custom is selected under the Provide Credentials property.

Service URL

Text

No

(Empty)

SERVICEURL=

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

The Service URL used to make requests to the SimpleDB service. The Service URL provides the service endpoint. For example, to make the service call to a different region, you can pass the region-specific endpoint, such as 'https://sdb.eu-west-1.amazonaws.com'. This property is active only if Custom is selected under the Provide Credentials property.

Maximum retry on error

Number

No

(Empty)

MAXERRORRETRY="4"

Signifies how many times the Amazon SimpleDB engine should retry the request before returning an error. This property is active only if Custom is selected under the Provide Credentials property.

Proxy Host

Text

No

(Empty)

PROXYHOST="proxy.host.com"

The host name (server.domain.com) or IP address (xxx.xxx.xxx.xxx) of the proxy server. This property is active only if Custom is selected under the Provide Credentials property.

Proxy Port

Number

No

(Empty)

PROXYPORT="1028"

The port that should be used to connect to the proxy server. This property is active only if Custom is selected under the Provide Credentials property.

Session Name

Text

Yes

(Empty)

SESSION="SessionName"

The session name that this activity should originate from. This allows several SimpleDB activities to be linked to a specific session. Numerous sessions can be used within a single task. This property is active only if Session Based is selected under the Provide Credentials property.

NOTE: Use the Create Session activity to create and name an SimpleDB session.

Custom Description

This action includes the Description tab for entering a custom step description.

More on setting custom step description

Standard Error Handling Options

This action also includes the standard Error Causes and On Error failure handling options/tabs.

More on Error Handling Options

Additional Notes

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'.

Variables and Expressions

All text fields allow the use of expressions, which can be entered by surrounding the expression in percentage signs (example: %MYVARIABLE%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by pressing F2.

More on variables
More on expressions

More on the expression builder

Example

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

 

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

 

<AMAWSSIMPLEDB ACTIVITY="get_domain_metadata" DOMAIN="Domain.Name" RESULTDATASET="theDataset"/>

 

↑ [Top of Page]