Skip to main content

Amazon DynamoDB Component

Create, update, fetch, or delete items in an Amazon (AWS) DynamoDB database

Component key: aws-dynamodb

Changelog ↓

Description​

Amazon DynamoDB is a key-value and document database from Amazon Web Services. The Amazon DynamoDB component allows you to create, read, update, or delete objects (items) within an Amazon DynamoDB database.

Connections​

DynamoDB Access Key and Secret​

An AWS IAM access key pair is required to interact with Amazon DynamoDB. Make sure that the key pair you generate in AWS has proper permissions to the DynamoDB resources you want to access. Read more about DynamoDB IAM actions in the AWS docs.

InputNotesExample
Access Key ID

An AWS IAM Access Key ID

AKIAIOSFODNN7EXAMPLE
Secret Access Key

An AWS IAM Secret Access Key

wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

AWS Role ARN​

To enable the IAM role authentication begin by logging into the AWS Console and navigate to Identity and Access Management (IAM).

To create an ARN user and generate credentials:

  1. Navigate to Users and select Create User.
  • Provide a User name and check the box providing them user access to the AWS Management Console if needed.
  • Once completed with the User creation, copy the ARN provided in the summary for a later step.
  1. To obtain the ARN for an existing User, click on the designated username from the Users page and the ARN will be provided in the summary section.
  2. From the summary section, select Create access key
  • Select Third-party service as the access key type and select next.
  • Set a description and select create access key.
  • Copy the Access Key and Secret access key and enter those into the connection configuration of your integration along with the ARN.

To create and assign a user a role:

  1. Navigate to Roles and select Create Role.
  • Select Custom Trust Policy for the Trusted entity types
  • Copy the following statement into the statement console. Making sure to replace the ARN with the user's actual ARN from the previous section
{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Principal": {
        "AWS": "ARN"
      },
      "Action": "sts:AssumeRole"
    }
  ]
}
  • When adding permissions provide the AmazonDynamoDBFullAccess permission
  • Complete remaining steps and select Create Role
InputNotesExample
Access Key ID

An AWS IAM Access Key ID

AKIAIOSFODNN7EXAMPLE
External ID

Provides enhanced security measures to the connection. Optional, but recommended. Please check AWS docs for more information.

shared-common-secret
Role ARN

An AWS IAM Role ARN

arn:aws:iam::OtherAccount-ID:role/assumed-role-name
Secret Access Key

An AWS IAM Secret Access Key

wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

Data Sources​

Select AWS Region​

Select an AWS region | key: selectRegion | type: picklist

Select Table​

Select a table from the list of tables | key: selectTable | type: picklist

InputNotesExample
Connection
AWS Region

AWS provides services in multiple regions, like us-west-2 or eu-west-1.

us-east-1

Actions​

Create Table​

Create a new DynamoDB Table | key: createTable

InputNotesExample
Attribute Definition

For each list item, provide a javascript object containing an attribute name, and an attribute type. The attribute type must be in the format that DynamoDB uses: N = number, S = string, L = Array etc...

Connection
AWS Region

AWS provides services in multiple regions, like us-west-2 or eu-west-1.

us-east-1
Billing Mode

Select the item that represents your desired billing mode.

PROVISIONED
Key Schema

For each list item, provide a javascript object containing an attribute name, and a key type. The key type can either be a HASH or a RANGE key.

Read Capacity Units

One read capacity unit represents one strongly consistent read per second, or two eventually consistent reads per second, for an item up to 4 KB in size.

6000
Table Name

Provide the name of the table you would like to interact with.

Customers
Write Capacity Units

One write capacity unit represents one write per second for an item up to 1 KB in size. If you need to write an item that is larger than 1 KB, DynamoDB must consume additional write capacity units.

6000

{
  "data": {
    "$metadata": {},
    "TableDescription": {
      "KeySchema": [],
      "ItemCount": 0,
      "TableName": "example",
      "TableArn": "example",
      "TableSizeBytes": 0,
      "TableStatus": "CREATING"
    }
  }
}

Delete Item​

Delete an item from a DynamoDB database | key: deleteItem

InputNotesExample
Connection
AWS Region

AWS provides services in multiple regions, like us-west-2 or eu-west-1.

us-east-1
Condition ExpressionPrice > :limit
Expression Attribute Values

Expression attribute values in Amazon DynamoDB are substitutes for the actual values that you want to compare—values that you might not know until runtime. An expression attribute value must begin with a colon (:) and be followed by one or more alphanumeric characters.

Expression Attribute Value Types

The DynamoDB data type for each query param. You must specify a type for each Expression Attribute Value you provided.

Range / Sort Key Value

The value of the optional range key (sort key) to match. This is required if your table has a range key.

Acme Inc
Table Name

Provide the name of the table you would like to interact with.

Customers
Hash / Primary Key Value

The value of the hash key (primary key) to match

cust_1234

Delete Table​

Delete an existing DynamoDB Table | key: deleteTable

InputNotesExample
Connection
AWS Region

AWS provides services in multiple regions, like us-west-2 or eu-west-1.

us-east-1
Table Name

Provide the name of the table you would like to interact with.

Customers

{
  "data": {
    "$metadata": {},
    "TableDescription": {
      "AttributeDefinitions": [],
      "KeySchema": [],
      "ItemCount": 0,
      "TableName": "example",
      "TableArn": "example",
      "TableSizeBytes": 0,
      "TableStatus": "DELETING"
    }
  }
}

Describe Table​

Fetch metadata about an existing DynamoDB Table | key: describeTable

InputNotesExample
Connection
AWS Region

AWS provides services in multiple regions, like us-west-2 or eu-west-1.

us-east-1
Table Name

Provide the name of the table you would like to interact with.

Customers

{
  "data": {
    "$metadata": {},
    "Table": {
      "AttributeDefinitions": [],
      "KeySchema": [],
      "ItemCount": 0,
      "TableName": "example",
      "TableArn": "example",
      "TableSizeBytes": 0,
      "TableStatus": "ACTIVE"
    }
  }
}

Get Item​

Retrieve an item from a DynamoDB database | key: getItem

InputNotesExample
Connection
AWS Region

AWS provides services in multiple regions, like us-west-2 or eu-west-1.

us-east-1
Range / Sort Key Value

The value of the optional range key (sort key) to match. This is required if your table has a range key.

Acme Inc
Table Name

Provide the name of the table you would like to interact with.

Customers
Hash / Primary Key Value

The value of the hash key (primary key) to match

cust_1234

{
  "data": {
    "result": {
      "$metadata": {},
      "Item": {}
    },
    "found": true
  }
}

List Tables​

List all DynamoDB Tables | key: listTables

InputNotesExample
Connection
AWS Region

AWS provides services in multiple regions, like us-west-2 or eu-west-1.

us-east-1

{
  "data": {
    "result": {
      "$metadata": {},
      "TableNames": [
        "Table1",
        "Table2"
      ]
    },
    "found": true
  }
}

Query Items​

Query a DynamoDB table | key: queryItems

InputNotesExample
Connection
AWS Region

AWS provides services in multiple regions, like us-west-2 or eu-west-1.

us-east-1
Debug

Enable debug mode to log additional information.

false
Expression Attribute Values

Expression attribute values in Amazon DynamoDB are substitutes for the actual values that you want to compare—values that you might not know until runtime. An expression attribute value must begin with a colon (:) and be followed by one or more alphanumeric characters.

Expression Attribute Value Types

The DynamoDB data type for each query param. You must specify a type for each Expression Attribute Value you provided.

Filter Expression

The filter expression for the query.

contains (Subtitle, :topic)
Key Condition Expression

The key condition expression for the query.

Season = :s and Episode > :e
Query Parameters

The DynamoDB data type for each query param. You must specify a type for each Expression Attribute Value you provided.

Table Name

Provide the name of the table you would like to interact with.

Customers

Raw Request​

Execute single PartiQL statements. | key: rawRequest

InputNotesExample
Connection
AWS Region

AWS provides services in multiple regions, like us-west-2 or eu-west-1.

us-east-1
Debug

Enable debug mode to log additional information.

false
Parameters

The parameters for the PartiQL statement, if any.

Query Parameters

The DynamoDB data type for each query param. You must specify a type for each Expression Attribute Value you provided.

Statement

The PartiQL statement representing the operation to run.

INSERT INTO Flowers value {'Name':?}

Update Item​

Update an existing item in a DynamoDB database | key: updateItem

InputNotesExample
Connection
AWS Region

AWS provides services in multiple regions, like us-west-2 or eu-west-1.

us-east-1
Condition ExpressionPrice > :limit
Update Expression

An update expression specifies how UpdateItem will modify the attributes of an item. For example, setting a scalar value or removing elements from a list or a map.

set Title = :t, Subtitle = :s'
Expression Attribute Values

Expression attribute values in Amazon DynamoDB are substitutes for the actual values that you want to compare—values that you might not know until runtime. An expression attribute value must begin with a colon (:) and be followed by one or more alphanumeric characters.

Expression Attribute Value Types

The DynamoDB data type for each query param. You must specify a type for each Expression Attribute Value you provided.

Range / Sort Key Value

The value of the optional range key (sort key) to match. This is required if your table has a range key.

Acme Inc
Table Name

Provide the name of the table you would like to interact with.

Customers
Hash / Primary Key Value

The value of the hash key (primary key) to match

cust_1234

Upsert Item​

Creates a new item, or replaces an existing item with a new item | key: createItem

InputNotesExample
Connection
AWS Region

AWS provides services in multiple regions, like us-west-2 or eu-west-1.

us-east-1
Condition ExpressionPrice > :limit
Expression Attribute Values

Expression attribute values in Amazon DynamoDB are substitutes for the actual values that you want to compare—values that you might not know until runtime. An expression attribute value must begin with a colon (:) and be followed by one or more alphanumeric characters.

Expression Attribute Value Types

The DynamoDB data type for each query param. You must specify a type for each Expression Attribute Value you provided.

Value

Provide a key value record to be inserted into the specified table.

Value Types

For each item in the list, provide the datatype corresponding to the input item.

N
Table Name

Provide the name of the table you would like to interact with.

Customers

You must specify a datatype alongside each property you insert. This action will attempt to coerce the inputs you provide to the correct type upon execution. You can specify the datatype of your input with the Value Type input on the create and update item actions. Be sure to pass the correct format into the input, below is a list of types that DynamoDB will expect. S = string, N = number, B = buffer, BOOL = boolean, M = map/object, L = array, SS = string set, NS = number set, BS = buffer set

Changelog​

2025-06-04​

Added inline data sources for table selection to enhance data management capabilities.