Skip to main content

Amazon DynamoDB Component

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

Component key: aws-dynamodb

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.

Authorization Methods#

Amazon DynamoDB requires one of the following authorization methods:

Auth TypeKeyDescriptionFields
API Key / Secretapi_key_secretAPI Key / Secret Combination

API Key |  api_key

API Secret |  api_secret

An AWS IAM access key pair is required to interact with Amazon DynamoDB. The AWS access_key_id serves as the API Key, and the secret_access_key serves as the API Secret. 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.

Actions#

Create Item#

Insert an item into a DynamoDB database | key: createItem

InputKeyDefaultNotesExample

AWS Region

string
/ Required
awsRegionus-east-1AWS provides services in multiple regions, like us-west-2 or eu-east-1. AWS region indicates the region in which your DynamoDb instance is hostedus-east-1

Value

string
/ Required
itemkey

Table Name

string
/ Required
tableNameCustomers

Output Example Payload#

{  "data": {    "Attributes": {},    "ConsumedCapacity": {      "Table": {        "CapacityUnits": 104,        "ReadCapacityUnits": 92,        "WriteCapacityUnits": 12      },      "TableName": "Example Table",      "CapacityUnits": 1,      "ReadCapacityUnits": 92,      "WriteCapacityUnits": 12,      "LocalSecondaryIndexes": {},      "GlobalSecondaryIndexes": {}    },    "ItemCollectionMetrics": {      "ItemCollectionKey": {}    }  }}

Delete Item#

Delete an item from a DynamoDB database | key: deleteItem

InputKeyDefaultNotesExample

AWS Region

string
/ Required
awsRegionus-east-1AWS provides services in multiple regions, like us-west-2 or eu-east-1. AWS region indicates the region in which your DynamoDb instance is hostedus-east-1

Item Key

string
/ Required
hashKeycustomerId

Table Name

string
/ Required
tableNameCustomers

Item value

string
/ Required
value126

Output Example Payload#

{  "data": {    "Attributes": {},    "ConsumedCapacity": {      "Table": {        "CapacityUnits": 104,        "ReadCapacityUnits": 92,        "WriteCapacityUnits": 12      },      "TableName": "Example Table",      "CapacityUnits": 1,      "ReadCapacityUnits": 92,      "WriteCapacityUnits": 12,      "LocalSecondaryIndexes": {},      "GlobalSecondaryIndexes": {}    },    "ItemCollectionMetrics": {}  }}

Get Item#

Retrieve an item from a DynamoDB database | key: getItem

InputKeyDefaultNotesExample

AWS Region

string
/ Required
awsRegionus-east-1AWS provides services in multiple regions, like us-west-2 or eu-east-1. AWS region indicates the region in which your DynamoDb instance is hostedus-east-1

Item Key

string
/ Required
hashKeycustomerId

Table Name

string
/ Required
tableNameCustomers

Item value

string
/ Required
value126

Output Example Payload#

{  "data": {    "Item": {},    "ConsumedCapacity": {      "Table": {        "CapacityUnits": 104,        "ReadCapacityUnits": 92,        "WriteCapacityUnits": 12      },      "TableName": "Example Table",      "CapacityUnits": 1,      "ReadCapacityUnits": 92,      "WriteCapacityUnits": 12,      "LocalSecondaryIndexes": {},      "GlobalSecondaryIndexes": {}    }  }}

Update Item#

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

InputKeyDefaultNotesExample

AWS Region

string
/ Required
awsRegionus-east-1AWS provides services in multiple regions, like us-west-2 or eu-east-1. AWS region indicates the region in which your DynamoDb instance is hostedus-east-1

Value

string
/ Required
itemkey

Query

string
/ Required
queryItem keyset customer_id = :id

Value

string
/ Required
queryParamskey[{key: ":id", value: "example customer id"}]

Table Name

string
/ Required
tableNameCustomers

Output Example Payload#

{  "data": {    "Attributes": {},    "ConsumedCapacity": {      "Table": {        "CapacityUnits": 104,        "ReadCapacityUnits": 92,        "WriteCapacityUnits": 12      },      "TableName": "Example Table",      "CapacityUnits": 1,      "ReadCapacityUnits": 92,      "WriteCapacityUnits": 12,      "LocalSecondaryIndexes": {},      "GlobalSecondaryIndexes": {}    },    "ItemCollectionMetrics": {      "ItemCollectionKey": {}    }  }}