Awsdynamodbconnector v1.0

Version 1.0

Connector Overview: This page documents all 10 actions for the Awsdynamodbconnector v1.0.

General (10)

PUT Put Item

Put Item

Writes an item to the table. When an item with the same primary key already exists it is replaced as a whole, not merged, so the item has to carry every attribute it should keep and always the full primary key. An update condition turns the write into a conditional one that fails unless the existing item's attributes hold the expected values. Set Return Values to ALL_OLD to get back the item as it was before it was overwritten; Put Item accepts only NONE and ALL_OLD.

Parameters

Parameter Name

Description

Item

The whole item as a JSON object, including every primary key attribute: {"id": "42", "price": 19.9, "tags": {"SS": ["a", "b"]}}. Plain JSON strings, numbers, booleans, null, arrays and objects are stored as DynamoDB S, N, BOOL, NULL, L and M; write binary values and sets in DynamoDB JSON, such as {"B": ""}, {"SS": [...]} or {"NS": [...]}.

Update Condition

Conditions the existing item must meet for the write to happen, as a JSON object: {"version": 3} requires the attribute to equal 3, {"locked": {"Exists": false}} requires it to be absent, and {"stock": {"ComparisonOperator": "GE", "AttributeValueList": [1]}} compares it. The step fails when a condition is not met.

Return Values

What the response returns: NONE (the default), ALL_OLD, UPDATED_OLD, ALL_NEW or UPDATED_NEW. Put Item and Delete Item accept only NONE and ALL_OLD.

Table Name

The DynamoDB table this step works on.

GET Get Item

Get Item

Reads a single item by its full primary key and returns its attributes; when no item has that key the result is empty. Attribute Names limits the result to the listed attributes, otherwise every attribute is returned. Reads are eventually consistent unless Consistent Read is on, which returns the latest committed write at twice the read capacity cost.

Parameters

Parameter Name

Description

Key

The full primary key of the item, as a JSON object: {"id": "42"}, or with a sort key {"customerId": "c-1", "created": 20260105}. Values can also be written in DynamoDB JSON, such as {"id": {"S": "42"}}.

Attribute Names

The attributes to return, separated by commas (id, price) or as a JSON array (["id", "price"]). Every attribute is returned when left empty.

Consistent Read

Determines whether strong consistency should be enforced when data is read.

Table Name

The DynamoDB table this step works on.

PUT Update Item

Update Item

Changes attributes of the item identified by its full primary key, leaving the attributes that are not mentioned untouched. Each update value names an attribute and an action: PUT sets the value, ADD adds to a number or a set, DELETE removes the attribute or values from a set. When no item has that key a new one is created. An update condition makes the change conditional, and Return Values chooses what comes back: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW or UPDATED_NEW.

Parameters

Parameter Name

Description

Key

The full primary key of the item, as a JSON object: {"id": "42"}, or with a sort key {"customerId": "c-1", "created": 20260105}. Values can also be written in DynamoDB JSON, such as {"id": {"S": "42"}}.

Update Values

The attributes to change, as a JSON object. A plain value sets the attribute: {"status": "shipped"}. {"views": {"Action": "ADD", "Value": 1}} adds to a number or a set, {"note": {"Action": "DELETE"}} removes the attribute, and {"tags": {"Action": "DELETE", "Value": {"SS": ["old"]}}} removes values from a set.

Update Condition

Conditions the existing item must meet for the write to happen, as a JSON object: {"version": 3} requires the attribute to equal 3, {"locked": {"Exists": false}} requires it to be absent, and {"stock": {"ComparisonOperator": "GE", "AttributeValueList": [1]}} compares it. The step fails when a condition is not met.

Return Values

What the response returns: NONE (the default), ALL_OLD, UPDATED_OLD, ALL_NEW or UPDATED_NEW. Put Item and Delete Item accept only NONE and ALL_OLD.

Table Name

The DynamoDB table this step works on.

DELETE Delete Item

Delete Item

Deletes the item identified by its full primary key. Deleting a key that does not exist is not an error. An update condition makes the delete happen only when the item's attributes hold the expected values, and Return Values set to ALL_OLD returns the item as it was before it was deleted; Delete Item accepts only NONE and ALL_OLD.

Parameters

Parameter Name

Description

Key

The full primary key of the item, as a JSON object: {"id": "42"}, or with a sort key {"customerId": "c-1", "created": 20260105}. Values can also be written in DynamoDB JSON, such as {"id": {"S": "42"}}.

Update Condition

Conditions the existing item must meet for the write to happen, as a JSON object: {"version": 3} requires the attribute to equal 3, {"locked": {"Exists": false}} requires it to be absent, and {"stock": {"ComparisonOperator": "GE", "AttributeValueList": [1]}} compares it. The step fails when a condition is not met.

Return Values

What the response returns: NONE (the default), ALL_OLD, UPDATED_OLD, ALL_NEW or UPDATED_NEW. Put Item and Delete Item accept only NONE and ALL_OLD.

Table Name

The DynamoDB table this step works on.

GET Batch Get Items

Batch Get Items

Reads up to 100 items, at most 16 MB, from one or more tables in a single call. Batch Items maps each table name to the primary keys to read and, optionally, the attributes to return. The response holds the items found per table plus the unprocessed keys DynamoDB did not get to, for example when the size limit or the provisioned throughput was reached; send those keys again in a follow-up step. The tables read are the ones named in Batch Items; Table Name only has to be an existing table, which the step checks before it runs.

Parameters

Parameter Name

Description

Batch Items

The items to read, as a JSON object of table name to keys: {"orders": [{"id": "42"}, {"id": "43"}]}. A table can instead map to {"Keys": [...], "AttributesToGet": [...], "ConsistentRead": true}, which is also the shape the step output reports unprocessedKeys in, so they can be passed back as they are.

Table Name

The DynamoDB table this step works on.

GET Query

Query

Finds the items that share a partition key value, optionally narrowed by a condition on the sort key, in the table or in one of its secondary indexes. Key Conditions is required and must hold an EQ condition on the partition key. Results come back in sort key order, ascending unless Scan Index Forward is false, and Attribute Names limits which attributes are returned. One call reads at most 1 MB or Limit items; when Is Truncated comes back true, pass the returned Last Evaluated Key as Start Key in the next Query to continue. Filter and projection expressions are not offered here: the key conditions are sent in DynamoDB's legacy form, which it refuses to combine with expressions.

Parameters

Parameter Name

Description

Key Conditions

The key conditions, as a JSON object. A plain value means equal and is how the partition key is given: {"customerId": "c-1"}. The sort key can also be compared: {"customerId": "c-1", "created": {"ComparisonOperator": "BEGINS_WITH", "AttributeValueList": ["2026-"]}}, with EQ, LE, LT, GE, GT, BEGINS_WITH or BETWEEN.

Index Name

The name of a secondary index to read instead of the table itself.

Scan Index Forward

true (the default) returns items in ascending sort key order, false in descending order.

Attribute Names

The attributes to return, separated by commas (id, price) or as a JSON array (["id", "price"]). Every attribute is returned when left empty.

Limit

The maximum number of items to read in one call. Filters are applied afterwards, so fewer items may be returned.

Start Key

Where to continue an earlier Query or Scan: pass the lastEvaluatedKey from that step's output.

Consistent Read

Determines whether strong consistency should be enforced when data is read.

Table Name

The DynamoDB table this step works on.

GET Scan

Scan

Reads every item of the table, or of one of its secondary indexes, and returns the ones that pass the optional filter. A scan always reads the whole table page by page, so on large tables it is slow and uses read capacity for every item examined, also for the ones the filter drops; prefer Query when the partition key is known. Filter in one of two styles, never both in the same step: the expression style (Filter Expression with its attribute names and values, and Project Expression to choose the returned attributes) or the legacy style (Scan Filter, and Attribute Names to choose the returned attributes); DynamoDB rejects a request that mixes them. One call reads at most 1 MB or Limit items; when Is Truncated comes back true, pass the returned Last Evaluated Key as Start Key in the next Scan to continue.

Parameters

Parameter Name

Description

Index Name

The name of a secondary index to read instead of the table itself.

Attribute Names

The attributes to return, separated by commas (id, price) or as a JSON array (["id", "price"]). Every attribute is returned when left empty.

Project Expression

The attributes to return, as a projection expression such as id, price, #s. Do not combine with Attribute Names or Scan Filter.

Filter Expression

A filter expression such as #s = :open AND price > :min. Names starting with # are looked up in Filter Expression Attribute Names and values starting with : in Filter Expression Attribute Values.

Filter Expression Attribute Names

The # placeholders used in Filter Expression or Project Expression, as a JSON object: {"#s": "status"}. Needed for attribute names that are DynamoDB reserved words.

Filter Expression Attribute Values

The : placeholders used in Filter Expression, as a JSON object: {":open": "open", ":min": 100}.

Scan Filter

A filter in the legacy notation, as a JSON object: {"status": "open"} keeps items whose attribute equals the value, and {"price": {"ComparisonOperator": "GT", "AttributeValueList": [100]}} compares it (EQ, NE, LE, LT, GE, GT, NOT_NULL, NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH, IN, BETWEEN). Do not combine with Filter Expression.

Limit

The maximum number of items to read in one call. Filters are applied afterwards, so fewer items may be returned.

Start Key

Where to continue an earlier Query or Scan: pass the lastEvaluatedKey from that step's output.

Table Name

The DynamoDB table this step works on.

GET Describe Table

Describe Table

Returns the table's status, key schema, item count, size in bytes, creation time and provisioned read and write capacity. Item count and size are refreshed by DynamoDB only about every six hours. When the step's table does not exist yet it is created before it is described, with a single partition key named by Key Attribute Name, Key Attribute Type HASH, typed by Key Scalar Type (S, N or B), and provisioned with Read Capacity and Write Capacity; all five are needed for the table to be created. The step waits until the new table is active.

Parameters

Parameter Name

Description

Key Attribute Name

Attribute name when creating table

Key Attribute Type

Attribute type when creating table

Key Scalar Type

The key scalar type, it can be S (String), N (Number) and B (Bytes)

Read Capacity

The provisioned throughput to reserve for reading resources from your table

Write Capacity

The provisioned throughput to reserved for writing resources to your table

Table Name

The DynamoDB table this step works on.

PUT Update Table

Update Table

Changes the provisioned read and write capacity of the table; both values have to be given. Only tables in provisioned capacity mode can be changed this way, an on-demand table rejects the call. DynamoDB limits how often capacity can be decreased per day, and the table stays usable while the change is applied.

Parameters

Parameter Name

Description

Read Capacity

The provisioned throughput to reserve for reading resources from your table

Write Capacity

The provisioned throughput to reserved for writing resources to your table

Table Name

The DynamoDB table this step works on.

DELETE Delete Table

Delete Table

Deletes the step's table together with all of its items and indexes. This cannot be undone. The response reports the table as it was when the deletion started, with status DELETING.

Parameters

Parameter Name

Description

Table Name

The DynamoDB table this step works on.