Digibee Documentation
Request documentationBook a demo
English
English
  • Quick start
  • Highlights
    • Release notes
      • Release notes 2025
        • May
        • April
        • March
        • February
        • January
      • Release notes 2024
        • December
        • November
        • October
        • September
        • August
          • Connectors release 08/20/2024
        • July
        • June
        • May
        • April
        • March
        • February
        • January
      • Release notes 2023
        • December
        • November
        • October
        • September
        • August
        • July
        • June
        • May
        • April
        • March
        • February
        • January
      • Release notes 2022
        • December
        • November
        • October
        • September
        • August
        • July
        • June
        • May
        • April
        • March
        • February
        • January
      • Release notes 2021
      • Release notes 2020
    • AI Pair Programmer
    • Digibeectl
      • Getting started
        • How to install Digibeectl on Windows
      • Digibeectl syntax
      • Digibeectl operations
  • Digibee in action
    • Use Cases in Action
      • Improving integration performance with API pagination
      • Automating file storage with Digibee
      • Reprocessing strategy in event-driven integrations
      • Key practices for securing sensitive information in pipelines with Digibee
      • OAuth2 for secure API access
      • Secure your APIs with JWT in Digibee
      • Integration best practices for developers on the Digibee Integration Platform
      • How to use Event-driven architecture on the Digibee Integration Platform
      • Dynamic file download with Digibee
      • Microservices: Circuit Breaker pattern for improving resilience
      • Error handling strategy in event-driven integrations
    • Troubleshooting
      • Integration guidance
        • How to resolve common pipeline issues
        • How to resolve Error 409: “You cannot update a pipeline that is not on draft mode”
        • How to resolve the "Pipeline execution was aborted" error
        • Integrated authentication with Microsoft Entra ID
        • How to resolve the "Failed to initialize pool: ONS configuration failed" error
        • How to perform IP address mapping with Progress database
        • How to build integration flows that send error notifications
        • How to send logs to external services
        • How JSONPath differs in connectors and the Execution panel
        • Using JSONPath to validate numbers with specific initial digits
        • How to analyze the "Network error: Failed to fetch" in the Execution panel
        • How to handle request payloads larger than 5MB
        • How to configure Microsoft Entra ID to display groups on the Digibee Integration Platform
        • How to build an HL7 message
      • Connectors behavior and configuration
        • Timeout in the Pipeline Executor connector
        • How to use DISTINCT and COUNT in the Object Store
        • Understanding @@DGB_TRUNCATED@@ on the Digibee Integration Platform
        • How to resolve names without a DNS - REST, SOAP, SAP (web protocols)
        • How to read and write files inside a folder
        • AuthToken Reuse for Salesforce connector
        • How to resolve the "Invalid payload" error in API Integration
        • Supported databases
          • Functions and uses for databases
      • Connectors implementation and usage examples
        • Google Storage: Usage scenarios
        • DB V2: Usage scenarios
        • For Each: Usage example
        • Template and its uses
        • Digibee JWT implementation
        • Email V1: Usage example (Deprecated)
      • JOLT applications
        • Transformer: Getting to know JOLT
        • Transformer: Transformations with JOLT
        • Transformer: Add values to list elements
        • Transformer: Operations overview
        • Transformer: Date formatting using split and concat
        • Transformer: Simple IF-ELSE logic with JOLT
      • Platform access and performance tips
        • How to solve login problems on the Digibee Integration Platform
        • How to receive updates from Digibee Status Page
        • How to clean the Digibee Integration Platform cache
      • Governance troubleshooting guidance
        • How to consume Internal API pipelines using ZTNA
        • How to use Internal API with and without a VPN
        • How to generate, convert, and register SSH Keys
        • mTLS authentication
          • How to configure mTLS on the Digibee Integration Platform
          • FAQs: Certificates in mTLS
        • How to connect Digibee to Oracle RAC
        • How to connect Digibee to SAP
        • How to connect Digibee to MongoDB Atlas using VPN
        • How to manage IPs on the Digibee Integration Platform
        • Configuring the Dropbox account
        • How to use your Gmail account with the Digibee email component (SMTP)
        • How to use the CORS policy on the Digibee Integration Platform
      • Deployment scenarios
        • Solving the “Out of memory” errors in deployment
        • Warning of route conflicts
    • Best practices
      • Best practices for building a pipeline
      • Best practices on validating messages in a consumer pipeline
      • Avoiding loops and maximizing pipeline efficiency
      • Naming: Global, Accounts, and API Keys
      • Pagination tutorial
        • Pagination tutorial - part 1
        • Pagination tutorial - part 2
        • Pagination tutorial - part 3
        • Pagination tutorial - part 4
      • Pagination example
      • Event-driven architecture
      • Notification model in event-driven integrations
      • OAuth2 integration model with Digibee
      • Best practices for error handling in pipelines
    • Digibee Academy
      • Integration Developer Bootcamp
  • Reference guides
    • Connectors
      • AWS
        • S3 Storage
        • SQS
        • AWS Secrets Manager
        • AWS Athena
        • AWS CloudWatch
        • AWS Elastic Container Service (ECS)
        • AWS Eventbridge
        • AWS Identity and Access Management (IAM)
        • AWS Kinesis
        • AWS Kinesis Firehose
        • AWS Key Management Service (KMS)
        • AWS Lambda
        • AWS MQ
        • AWS Simple Email Service (SES)
        • AWS Simple Notification System (SNS)
        • AWS Security Token Service (STS)
        • AWS Translate
      • Azure
        • Azure CosmosDB
        • Azure Event Hubs
        • Azure Key Vault
        • Azure ServiceBus
        • Azure Storage DataLake Service
        • Azure Storage Queue Service
      • Enterprise applications
        • SAP
        • Salesforce
        • Braintree
        • Facebook
        • GitHub
        • Jira
        • ServiceNow
        • Slack
        • Telegram
        • Twilio
        • WhatsApp
        • Wordpress
        • Workday
        • Zendesk
      • File storage
        • Blob Storage (Azure)
        • Digibee Storage
        • Dropbox
        • FTP
        • Google Drive
        • Google Storage
        • OneDrive
        • SFTP
        • WebDav V2
        • WebDav (Deprecated)
      • Files
        • Append Files
        • Avro File Reader
        • Avro File Writer
        • CSV to Excel
        • Excel
        • File Reader
        • File Writer
        • GZIP V2
        • GZIP V1 (Deprecated)
        • Parquet File Reader
        • Parquet File Writer
        • Stream Avro File Reader
        • Stream Excel
        • Stream File Reader
        • Stream File Reader Pattern
        • Stream JSON File Reader
        • Stream Parquet File Reader
        • Stream XML File Reader
        • XML Schema Validator
        • ZIP File
        • NFS
      • Flow
        • Delayer
      • Google/GCP
        • Google BigQuery
        • Google BigQuery Standard SQL
        • Google Calendar
        • Google Cloud Functions
        • Google Mail
        • Google PubSub
        • Google Secret Manager
        • Google Sheets
      • Industry solutions
        • FHIR (Beta)
        • Gupy Public API
        • HL7
        • HubSpot: Sales and CMS
        • Mailgun API
        • Oracle NetSuite (Beta)
        • Orderful
        • Protheus: Billing and Inventory of Cost
      • Logic
        • Block Execution
        • Choice
        • Do While
        • For Each
        • Retry
        • Parallel Execution
      • Queues and messaging
        • Event Publisher
        • JMS
        • Kafka
        • RabbitMQ
      • Security
        • AES Cryptography
        • Asymmetric Cryptography
        • CMS
        • Digital Signature
        • JWT (Deprecated)
        • JWT V2
        • Google IAP Token
        • Hash
        • Digibee JWT (Generate and Decode)
        • LDAP
        • PBE Cryptography
        • PGP
        • RSA Cryptography
        • Symmetric Cryptography
      • Structured data
        • CassandraDB
        • DB V2
        • DB V1 (Deprecated)
        • DynamoDB
        • Google Big Table
        • Memcached
        • MongoDB
        • Object Store
        • Relationship
        • Session Management
        • Stored Procedure
        • Stream DB V3
        • Stream DB V1 (Deprecated)
        • ArangoDb
        • Caffeine Cache
        • Caffeine LoadCache
        • Couchbase
        • CouchDB
        • Ehcache
        • InfluxDB
      • Tools
        • Assert V2
        • Assert V1 (Deprecated)
        • Base64
        • CSV to JSON V2
        • CSV to JSON V1 (Deprecated)
        • HL7 Message Transformer (Beta)
        • HTML to PDF
        • Transformer (JOLT) V2
        • JSLT
        • JSON String to JSON Transformer
        • JSON to JSON String Transformer
        • JSON to XML Transformer
        • JSON to CSV V2
        • JSON to CSV Transformer (Deprecated)
        • JSON Path Transformer V2
        • JSON Path Transformer
        • JSON Transformer
        • Log
        • Pipeline Executor
        • QuickFix (Beta)
        • SSH Remote Command
        • Script (JavaScript)
        • Secure PDF
        • Store Account
        • Template Transformer
        • Throw Error
        • Transformer (JOLT)
        • Validator V1 (Deprecated)
        • Validator V2
        • XML to JSON Transformer
        • XML Transformer
        • JSON Generator (Mock)
      • Web protocols
        • Email V2
        • Email V1 (Deprecated)
        • REST V2
        • REST V1 (Deprecated)
        • SOAP V1 (Deprecated)
        • SOAP V2
        • SOAP V3
        • WGet (Download HTTP)
        • gRPC
    • Triggers
      • Web Protocols
        • API Trigger
        • Email Trigger
        • Email Trigger V2
        • HTTP Trigger
        • HTTP File Trigger
          • HTTP File Trigger - Downloads
          • HTTP File Trigger - Uploads
        • REST Trigger
      • Scheduling
        • Scheduler Trigger
      • Messaging and Events
        • Event Trigger
        • JMS Trigger
        • Kafka Trigger
        • RabbitMQ Trigger
      • Others
        • DynamoDB Streams Trigger
        • HL7 Trigger
        • Salesforce Trigger - Events
    • Double Braces
      • How to reference data using Double Braces
      • Double Braces functions
        • Math functions
        • Utilities functions
        • Numerical functions
        • String functions
        • JSON functions
        • Date functions
        • Comparison functions
        • File functions
        • Conditional functions
      • Double Braces autocomplete
  • Development cycle
    • Build
      • Canvas
        • AI Assistant
        • Smart Connector User Experience
        • Execution panel
        • Design and Inspect Mode
        • Linter: Canvas building validation
        • Connector Mocking
      • Pipeline
        • How to create a pipeline
        • How to scaffold a pipeline using an OpenAPI specification
        • How to create a project
        • Pipeline version history
        • Pipeline versioning
        • Messages processing
        • Subpipelines
      • Capsules
        • How to use Capsules
          • How to create a Capsule collection
            • Capsule header dimensions
          • How to create a Capsule group
          • How to configure a Capsule
          • How to build a Capsule
          • How to test a Capsule
          • How to save a Capsule
          • How to publish a Capsule
          • How to change a Capsule collection or group
          • How to archive and restore a Capsule
        • Capsules versioning
        • Public capsules
          • SAP
          • Digibee Tools
          • Google Sheets
          • Gupy
          • Send notifications via email
          • Totvs Live
          • Canvas LMS
        • AI Assistant for Capsules Docs Generation
    • Run
      • Run concepts
        • Autoscalling
      • Deployment
        • Deploying a pipeline
        • How to redeploy a pipeline
        • How to promote pipelines across environments
        • How to check the pipeline deployment History
        • How to rollback to a previous deployment version
        • Using deployment history advanced functions
        • Pipeline deployment status
      • How warnings work on pipelines in Run
    • Monitor
      • Monitor Insights (Beta)
      • Completed executions
        • Pipeline execution logs download
      • Pipeline logs
      • Pipeline Metrics
        • Pipeline Metrics API
          • How to set up Digibee API metrics with Datadog
          • How to set up Digibee API metrics with Prometheus
        • Connector Latency
      • Alerts
        • How to create an alert
        • How to edit an alert
        • How to activate, deactivate or duplicate an alert
        • How to delete an alert
        • How to configure alerts on Slack
        • How to configure alerts on Telegram
        • How to configure alerts through a webhook
        • Available metrics
        • Best practices about alerts
        • Use cases for alerts
      • VPN connections monitoring
        • Alerts for VPN metrics
  • Connectivity management
    • Connectivity
    • Zero Trust Network Access (ZTNA)
      • Prerequisites for using ZTNA
      • How to view connections (Edge Routers)
      • How to view the Network Mappings associated with an Edge Router
      • How to add new ZTNA connections (Edge Routers)
      • How to delete connections (Edge Routers)
      • How to view routes (Network Mapping)
      • How to add new routes (Network Mapping)
      • How to add routes in batch for ZTNA
      • How to edit routes (Network Mapping)
      • How to delete routes (Network Mapping)
      • How to generate new keys (Edge Router)
      • How to change the environment of Edge routers
      • ZTNA Inverse Flow
      • ZTNA Groups
    • Virtual Private Network (VPN)
  • Platform administration
    • Administration
      • Audit
      • Access control
        • Users
        • Groups
        • Roles
          • List of permissions by service
          • Roles and responsibilities: Governance and key stakeholder identification
      • Identity provider integration
        • How to integrate an identity provider
        • Authentication rules
        • Integration of IdP groups with Digibee groups
          • How to create a group integration
          • How to test a group integration
          • How to enable group integrations
          • How to edit a group integration
          • How to delete a group integration
      • User authentication and authorization
        • How to activate and deactivate two-factor authentication
        • Login flow
      • Organization groups
    • Settings
      • Globals
        • How to create Globals
        • How to edit or delete Globals
        • How to use Globals
      • Accounts
        • Configuring each account type
        • Monitor changes to account settings in deployed pipelines
        • OAuth2 Architecture
          • Registration of new OAuth providers
      • Consumers (API Keys)
      • Relationship model
      • Multi-Instance
        • Deploying a multi-instance pipeline
      • Log Streaming
        • How to use Log Streaming with Datadog
    • Governance
      • Policies
        • Security
          • Internal API access policy
          • External API access policy
          • Sensitive fields policy
        • Transformation
          • Custom HTTP header
          • CORS HTTP header
        • Limit of Replicas policy
    • Licensing
      • Licensing models
        • Consumption Based model
      • Capacity and quotas
      • License consumption
    • Digibee APIs
      • How to create API credentials
  • Digibee concepts
    • Pipeline Engine
      • Digibee Integration Platform Pipeline Engine v2
      • Support Dynamic Accounts (Restricted Beta)
    • Digibee Integration Platform Dedicated SaaS
      • Digibee Integration Platform architecture on Dedicated Saas model
      • Requirements for Digibee Dedicated Saas model
      • Site-to-Site VPN for dedicated SaaS customer support
      • Dedicated Saas customer responsibilities
      • Custom Images of Kubernetes Nodes
      • Digibee Dedicated SaaS installation on AWS
        • How to install requirements before installing Digibee Integration Platform on EKS
        • Permissions to use Digibee Integration Platform on EKS
        • How to create custom nodes for EKS (Golden Images)
    • Introduction to ZTNA
  • Help & FAQ
    • Digibee Customer Support
    • Request documentation, suggest features, or send feedback
    • Beta Program
    • Security and compliance
    • About Digibee
Powered by GitBook
On this page
  • Parameters
  • General Tab
  • Authentication tab
  • Operation Settings tab
  • Output
  • GetItem example
  • Query and Scan additional details
  • Conditional expressions
  • Double Braces in conditional expressions
  • Paginated results

Was this helpful?

  1. Reference guides
  2. Connectors
  3. Structured data

DynamoDB

Discover more about the DynamoDB connector and how to use it on the Digibee Integration Platform.

PreviousDB V1 (Deprecated)NextGoogle Big Table

Last updated 3 months ago

Was this helpful?

The DynamoDB connector allows pipelines to execute operations against DynamoDB tables in AWS. The following operations are currently available:

  • PutItem: creates or replaces an item in a DynamoDB table.

  • GetItem: fetches attributes from an existing item in a DynamoDB table by primary key.

  • UpdateItem: edits an existing item's attributes or adds a new item to a DynamoDB table.

  • DeleteItem: deletes a single item in a table by primary key

  • Query: fetches all items with the same partition key from a table or from an index (Local secondary index, or global secondary index).

  • Scan: fetches all items from a table or from an index (local secondary index, or global secondary index). A filter expression may be applied to limit the number of returned items.

Parameters

The available parameters are divided into four tabs and may vary according to the chosen operation. Parameters supported by are marked with (DB).

General Tab

Parameter
Description
Default value
Data type

Fail On Error

If the option is activated, the pipeline's execution with an error will be interrupted. Otherwise, the pipeline execution proceeds, but the result will show a false value for the "success" property.

False

Boolean

Authentication tab

Parameter
Description
Default value
Data type

Account Type

Defines the account type of the main account used for the connection. Supported types: AWS V4 and Basic.

Basic

String

Use Dynamic Account

When active, the connector will use the account dynamically. Otherwise, it will use the account statically.

False

Boolean

Scoped

When active, the stored account is isolated from other subprocesses. In this case, the subprocesses see their own version of the stored account data.

It is only available if the Use Dynamic Account parameter is active.

False

Boolean

Account

The account used to connect the connector to the target DynamoDB table.

It is only available if the Use Dynamic Account parameter is inactive.

Null

BASIC, AWS-V4

Account Name (DB)

It is only available if the Use Dynamic Account parameter is active.

Empty

String

AWS Region

The AWS region where the target table is available.

It is used only when the account type is set to Basic.

us-east-1

String

Use Assume Role

When active, it allows the use of an AWS Role account to be assumed by the Account.

It can only be used if the account type is set to AWS V4.

False

Boolean

AWS Role Account

The account used to delegate temporary permissions to the Account through the Assume Role operation.

NULL

AWS-ROLE

AWS Role Account Name (DB)

The name of the dynamic account used to delegate temporary permissions to the account referenced in the Account Name field through the Assume Role operation.

It is only available if the Use Dynamic Account parameter is active.

Empty

String

Operation Settings tab

Parameter
Description
Default value
Data type

Operation

The operation to be executed.

PutItem

String

Table Name

Name of the table against which the operation is being executed.

NULL

String

PutItem operation parameters

Parameter
Description
Default value
Data type

Upsert

When active, it completely replaces an existing item with the same primary key. Otherwise, the operation will fail when an item with the specified primary key already exists.

True

Boolean

Body (DB)

JSON object to be used by the operation.

JSON arrays, and other valid JSON definitions are not allowed.

{{ message.$ }}

JSON

GetItem operation parameters

Parameter
Description
Default value
Data type

Partition Key Value (DB)

Value of the target item's partition key. This parameter is mandatory.

NULL

String

Sort Key Value (DB)

Value of the target item's sort key. Only needed when the target table uses a composite primary key (partition key + sort key).

NULL

String

Attributes to Return (DB)

Comma-separated list of attributes names to be returned by the operation.

NULL

String

Consistent Read

This parameter overrides DynamoDB's default eventually consistent behavior when active.

False

Boolean

UpdateItem operation parameters

Parameter
Description
Default value
Data type

Partition Key Value (DB)

Value of the target item's partition key. This parameter is mandatory.

NULL

String

Sort Key Value (DB)

Value of the target item's sort key. Only needed when the target table uses a composite primary key (partition key + sort key).

NULL

String

Return Values

List of options on how to get the attributes' values, before or after the update operation is performed.

Options are: ALL NEW (Return all values as they are, after the update), ALL OLD (All values as they were before the update), NONE (Nothing is returned), UPDATED NEW (Only updated values are returned as they are after the update), and UPDATED OLD (Only updated values as they were before the update).

NONE

String

Body (DB)

JSON object to be used by the operation.

JSON arrays, and other valid JSON definitions are not allowed.

{{ message.$ }}

JSON

DeleteItem operation parameters

Parameter
Description
Default value
Data type

Partition Key Value (DB)

Value of the target item's partition key. This parameter is mandatory.

NULL

String

Sort Key Value (DB)

Value of the target item's sort key. Only needed when the target table uses a composite primary key (partition key + sort key).

NULL

String

Query operation parameters

Parameter
Description
Default value
Data type

Index Name

Name of the index to be used in this operation. The index must belong to the table specified in the Table Name field.

NULL

String

Partition Key Value (DB)

Value of the target item's partition key. This will refer to an Index Partition Key, if the field Index Name is specified. This parameter is mandatory.

NULL

String

Sort Key Expression (DB)

A condition expression to be applied on the Sort Key attribute. This will refer to an Index Sort Key, if the field Index Name is specified.

NULL

String

Attributes to Return (DB)

List of attribute names to be returned by the operation.

NULL

String

Consistent Read

When active, this parameter overrides DynamoDB's default eventually consistent behavior. It cannot be used when the query operation is used against a Global Secondary Index (GSI).

False

Boolean

Filter Expression (DB)

A string that contains conditions that DynamoDB applies after the Query operation, but before the data is returned to you.

NULL

String

Exclusive Start Partition Key Value (DB)

The partition key of the first item that this operation will evaluate. This attribute is mandatory only when fetching paginated results.

NULL

String

Exclusive Start Sort Key Value (DB)

The sort key of the first item that this operation will evaluate. This attribute is mandatory only when fetching paginated results.

NULL

String

Exclusive Start Index Partition Key Value (DB)

The index partition key of the first item that this operation will evaluate. This attribute is mandatory only when fetching paginated results from an Index.

NULL

String

Exclusive Start Index Sort Key Value (DB)

The index sort key of the first item that this operation will evaluate. This attribute is mandatory only when fetching paginated results from an Index.

NULL

String

Limit

Maximum number of items to be returned by the operation. Minimum allowed is 1 and maximum allowed is 1000.

1000

Integer

Automatic Pagination

If active, this parameter will automatically fetch all pages when DynamoDB returns paginated responses.

False

Boolean

Scan Forward

If active, this parameter returns the result in its original ordering (based on the sort key). Otherwise, the order is inverted.

True

Boolean

Expression Attribute Values (DB)

A list of attribute values used in the conditional expression fields (Sort Key Expression and Filter Expression). Each attribute value must specify the Placeholder used, the Type of the data, and the Value to replace the placeholder.

Empty

List of Attribute Values

Scan operation parameters

Parameter
Description
Default value
Data type

Index Name

Name of the index to be used in this operation. The index must belong to the table specified in the Table Name field.

NULL

String

Attributes to Return (DB)

List of attribute names to be returned by the operation.

NULL

String

Consistent Read

When active, this parameter overrides DynamoDB's default eventually consistent behavior. It cannot be used when the scan operation is used against a Global Secondary Index (GSI).

False

Boolean

Filter Expression (DB)

A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you.

NULL

String

Exclusive Start Partition Key Value (DB)

The partition key of the first item that this operation will evaluate. This attribute is mandatory only when fetching paginated results.

NULL

String

Exclusive Start Sort Key Value (DB)

The sort key of the first item that this operation will evaluate. This attribute is mandatory only when fetching paginated results.

NULL

String

Exclusive Start Index Partition Key Value (DB)

The index partition key of the first item that this operation will evaluate. This attribute is mandatory only when fetching paginated results from an Index.

NULL

String

Exclusive Start Index Sort Key Value (DB)

The index sort key of the first item that this operation will evaluate. This attribute is mandatory only when fetching paginated results from an Index.

NULL

String

Limit

Maximum number of items to be returned by the operation. Minimum allowed is 1 and maximum allowed is 1000.

1000

Integer

Automatic Pagination

If active, this parameter will automatically fetch all pages when DynamoDB returns paginated responses.

False

Boolean

Scan Forward

If active, this parameter returns the result in its original ordering (based on the sort key). Otherwise, the order is inverted.

True

Boolean

Expression Attribute Values (DB)

A list of attribute values used in the conditional expression fields (Filter Expression). Each attribute value must specify the Placeholder used, the Type of the data, and the Value to replace the placeholder.

Empty

List of Attribute Values

Output

Every operation returns:

  • A "success" boolean attribute to indicate if the operation was performed successfully (true), or if it failed (false).

  • A counter attribute, indicating how many items were affected by the operation. This parameter is named after the operation in the following format: <operation's name>+"Count".

  • A "data" attribute containing an array of returned item records. This is restricted to operations that return something.

GetItem example

{
	"success": true,
	"getItemCount": 1,
	"data": [
		{
	"Age": 8,
	"Colors": [
		"White", 
		"Brown",
		"Black"
],
"Name": "Fido",
"Vaccinations": {
	"Rabies": [
		"2009-03-17",
		"2011-09-21",
		"2014-07-08"
	],
	"Distemper": "2015-10-13"
},
"Breed": "Beagle",
"AnimalType": "Dog"
}
	]
}

Query and Scan additional details

Conditional expressions

When using the Query and Scan operations, the developer can use conditional expressions to filter the returned items. Conditional expressions can be defined in the fields Sort Key Expression (available only in the Query operation), and Filter Expression (available in the Query and Scan operations).

These expressions are similar to filtering options in a SQL query as it can be seen in the following examples:

Notice that the actual values to be used in the conditions cannot be placed in the expressions directly. Instead, a placeholder in the format "colon + name" must be used, and the value is then passed via the Expression Attribute Values field. In the example above, the following attribute values would have to be specified:

Notice that the Placeholder field value must match exactly the names used in the conditional expressions, including the colon.

Double Braces in conditional expressions

When using Double Braces expressions embedded in conditional expressions, there is no need to specify the corresponding values through the Expression Attribute Values field. The same example above could have been specified like this:

In this case, the connector infers the data types and values from the JSON input message. The placeholders are automatically generated by the connector using sequential numbers. Notice that in this situation a message like the following would be expected as input:

{
	"skMinValue": 8965,
	"skMaxValue": 9165,
	"createdAtBottom": "2024-03-25T16:11:22Z",
	"deletedVal": false
}

Paginated results

DynamoDB may paginate the results of a Query or Scan operation in two situations:

  • The number of fetched items is bigger than the number established in the Limit parameter.

  • The total size of the response exceeds 1MB.

In situations where a paginated response is returned, an extra lastEvaluatedKey field will be added to the output, containing the primary keys of the last item returned. These returned keys can then be used in a subsequent Query or Scan operation passing them in the Exclusive Start Key fields.

The following is an example of a paginated output:

{
	"success": true,
       	"data":[
		{...},
		{...},
		{...},
		...
	],
	"queryCount": 1000,
	"lastEvaluatedKey": {
		"partitionKeyName": 12,
		"sortKeyName" "abc",
		"indexPartitionKeyName": 123,
		"indexSortKeyName": "index-abc"
	}
}

Notice that in this case, we have a map between the key fields names and their respective values. Index key fields are omitted if the operation doesn’t have the field Index Name specified.

This is how the Exclusive Start Key fields would have to be specified for the following page iteration:

The name of the dynamic account used to connect the connector to the DynamoDB target table. This account must have been previously configured in a connector in the pipeline for this process to take effect.

.

Double Braces expressions
See the AWS documentation for further reference on conditional expressions
Store Account
Conditional expression example 1
Conditional expression example 2
Conditional expression example 3
Conditional expression example 4 - Placeholder detail
Conditional expression example 5 - Sort Key Expression
Conditional expression example 6 - Filter Expression
Conditional expression example 7 - Exclusive Start Key