DynamoDB Get

Retrieves a single item from a DynamoDB table by its exact primary key.

Inputs

payload.tableName string

Overrides the Table Name set in the node config.

payload.key object

Full primary key object — overrides all config PK/SK fields. Example: { id: "epic-A", sk: "token" }

payload.pkName / payload.pkValue string

Alternative to payload.key — set partition key name and value at runtime.

payload.skName / payload.skValue string

Sort key name and value at runtime (required if table has sort key).

Outputs

Output 1 — Success

payload.found boolean

true if the item exists, false if not found. Always goes to output 1 — not-found is never an error.

payload.item object | null

The retrieved item object, or null if not found.

dynamodb.operation string

"get"

dynamodb.tableName string

The table that was queried.

Output 2 — Error

payload.error string

Error message from AWS.

payload.errorType string

Human-readable error category (e.g. Table Not Found, Auth Error).

payload.solution string

Suggested fix for the error.

How to Use

1. Select an AWS config node (or create one with your AWS credentials).
2. Enter the Table Name.
3. Set the Partition Key name and value (e.g. name: id, value: epic-hospital-A).
4. If your table has a Sort Key, fill in the Sort Key name and value too — it is mandatory for composite-key tables.
5. Wire the output: Output 1 = success (check msg.payload.found), Output 2 = AWS error.

Primary Key

DynamoDB identifies items by their primary key. If your table was created with both a partition key (id) and a sort key (sk), you must supply both. Omitting the sort key from a composite-key table will result in a validation error.

You can override the key entirely at runtime by setting msg.payload.key to a full key object, e.g. { id: "epic-A", sk: "oauth_token" }.

ConnectHealth Example

Retrieve an Epic OAuth token stored in DynamoDB for a hospital integration:

// Set in the node config:
Partition Key Name:  id
Partition Key Value: epic-hospital-A
Sort Key Name:       sk
Sort Key Value:      oauth_token

// Or override at runtime:
msg.payload = {
  key: { id: "epic-hospital-A", sk: "oauth_token" }
};

// Output 1 when found:
msg.payload = {
  found: true,
  item: {
    id: "epic-hospital-A",
    sk: "oauth_token",
    accessToken: "eyJhbGci...",
    expiresAt: 1714000000
  }
}

Best Practices

• Enable Consistent Read when retrieving tokens before making an API call — ensures you always read the latest written value.
• Always check msg.payload.found before accessing msg.payload.item. If found is false, item is null.
• Use Output 2 to wire an error-handling branch (e.g. log the error and send a notification).
• For retrieving many items at once, use DynamoDB Batch (BatchGet) instead.