Free MuleSoft CONNECT Keynote & Expo Pass Available!

Register now+
Nav

Amazon DynamoDB Module Documentation Reference

Configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

  • config_basic, Basic

  • config_connection, Connection

The connection types that can be provided to this configuration.

x

Expiration Policy

ExpirationPolicy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime actually purges the instances when it sees fit.

Connection Types

Basic

Parameters

Name Type Description Default Value Required

Connection Timeout

Number

50000

Socket Timeout

Number

50000

Access Key

String

x

Secret Key

String

x

Try Default AWSCredentials Provider Chain

Boolean

false

Max Connections

Number

Region Endpoint

Enumeration, one of:

  • AP_NORTHEAST_1

  • AP_NORTHEAST_2

  • AP_SOUTH_1

  • AP_SOUTHEAST_1

  • AP_SOUTHEAST_2

  • CA_CENTRAL_1

  • CN_NORTH_1

  • EU_CENTRAL_1

  • EU_WEST_1

  • EU_WEST_2

  • SA_EAST_1

  • US_EAST_1

  • US_EAST_2

  • US_GOV_WEST_1

  • US_WEST_1

  • US_WEST_2

US_EAST_1

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Host

String

Port

Number

Username

String

Password

String

Domain

String

Workstation

String

Connection

Parameters

Name Type Description Default Value Required

Connection Timeout

Number

50000

Socket Timeout

Number

50000

Access Key

String

x

Secret Key

String

x

Try Default AWSCredentials Provider Chain

Boolean

false

Max Connections

Number

Region Endpoint

Enumeration, one of:

  • AP_NORTHEAST_1

  • AP_NORTHEAST_2

  • AP_SOUTH_1

  • AP_SOUTHEAST_1

  • AP_SOUTHEAST_2

  • CA_CENTRAL_1

  • CN_NORTH_1

  • EU_CENTRAL_1

  • EU_WEST_1

  • EU_WEST_2

  • SA_EAST_1

  • US_EAST_1

  • US_EAST_2

  • US_GOV_WEST_1

  • US_WEST_1

  • US_WEST_2

US_EAST_1

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy

Host

String

Port

Number

Username

String

Password

String

Domain

String

Workstation

String

Associated Operations

  • batchDeleteItem

  • batchGetItem

  • batchPutItem

  • createTable

  • deleteItem

  • deleteTable

  • describeTable

  • getItem

  • listTables

  • putItem

  • query

  • scan

  • updateItem

  • updateTable


StreamsConfiguration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

streams-config_streams

The connection types that can be provided to this configuration.

x

Expiration Policy

ExpirationPolicy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime actually purges the instances when it sees fit.

Connection Types

Streams

Parameters

Name Type Description Default Value Required

Connection Timeout

Number

50000

Socket Timeout

Number

50000

Access Key

String

x

Secret Key

String

x

Try Default AWSCredentials Provider Chain

Boolean

false

Max Connections

Number

Region Endpoint

Enumeration, one of:

  • AP_NORTHEAST_1

  • AP_NORTHEAST_2

  • AP_SOUTH_1

  • AP_SOUTHEAST_1

  • AP_SOUTHEAST_2

  • CA_CENTRAL_1

  • CN_NORTH_1

  • EU_CENTRAL_1

  • EU_WEST_1

  • EU_WEST_2

  • SA_EAST_1

  • US_EAST_1

  • US_EAST_2

  • US_GOV_WEST_1

  • US_WEST_1

  • US_WEST_2

US_EAST_1

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy

Host

String

Port

Number

Username

String

Password

String

Domain

String

Workstation

String

Associated Operations

  • describeStream

  • getRecords

  • getShardIterator

  • listStreams

Operations

Batch Delete Item

<dynamodb:batch-delete-item>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Request Delete Items

Object

One or more items to delete from table.

x

Target Variable

String

The name of a variable where the output of this operation is stored

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors

Output

Type

BatchWriteItemResult

Attributes Type

RequestIDAttribute

For Configurations

  • config

Throws

  • DYNAMODB:ConditionalCheckFailedException

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:InternalServerError

  • DYNAMODB:ItemCollectionSizeLimitExceededException

  • DYNAMODB:LimitExceededException

  • DYNAMODB:ProvisionedThroughputExceededException

  • DYNAMODB:ResourceInUseException

  • DYNAMODB:ResourceNotFoundException

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:Unknown

Batch Get Item

<dynamodb:batch-get-item>

The BatchGetItem operation returns the attributes of one or more items from one or more tables. You identify requested items by the primary key.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Request Items

Object

A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table.

x

Return Consumed Capacity

Enumeration, one of:

  • INDEXES

  • TOTAL

  • NONE

Determines the level of detail about provisioned throughput consumption that is returned in the response.

Target Variable

String

The name of a variable where the output of this operation is stored

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors

Output

Type

BatchGetItemResult

Attributes Type

RequestIDAttribute

For Configurations

  • config

Throws

  • DYNAMODB:ConditionalCheckFailedException

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:InternalServerError

  • DYNAMODB:ItemCollectionSizeLimitExceededException

  • DYNAMODB:LimitExceededException

  • DYNAMODB:ProvisionedThroughputExceededException

  • DYNAMODB:ResourceInUseException

  • DYNAMODB:ResourceNotFoundException

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:Unknown

Batch Put Item

<dynamodb:batch-put-item>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Request Put Items

Object

One or more items to insert into table.

x

Target Variable

String

The name of a variable where the output of this operation is stored

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors

Output

Type

BatchWriteItemResult

Attributes Type

RequestIDAttribute

For Configurations

  • config

Throws

  • DYNAMODB:ConditionalCheckFailedException

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:InternalServerError

  • DYNAMODB:ItemCollectionSizeLimitExceededException

  • DYNAMODB:LimitExceededException

  • DYNAMODB:ProvisionedThroughputExceededException

  • DYNAMODB:ResourceInUseException

  • DYNAMODB:ResourceNotFoundException

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:Unknown

Create Table

<dynamodb:create-table>

The CreateTable operation adds a new table to your account. In an AWS account, table names must be unique within each region.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Table Name

String

The name of the table to create.

x

Attribute Definitions

Array of AttributeDefinition

An array of attributes that describe the key schema for the table and indexes.

x

Key Schemas

Array of KeySchemaElement

Specifies the attributes that make up the primary key for a table or an index.

x

Read Capacity Units

Number

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

x

Write Capacity Units

Number

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

x

Global Secondary Indexes

Array of GlobalSecondaryIndex

One or more global secondary indexes (the maximum is five) to be created on the table.

Local Secondary Indexes

Array of LocalSecondaryIndex

One or more local secondary indexes (the maximum is five) to be created on the table.

Stream View Type

Enumeration, one of:

  • KEYS_ONLY

  • NEW_AND_OLD_IMAGES

  • NEW_IMAGE

  • OLD_IMAGE

When an item in the table is modified, StreamViewType determines what information is written to the table’s stream.

Stream Enabled

Boolean

Indicates whether Streams is to be enabled (true) or disabled (false).

false

Target Variable

String

The name of a variable where the output of this operation is stored

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors

Output

Type

TableDescription

Attributes Type

RequestIDAttribute

For Configurations

  • config

Throws

  • DYNAMODB:ConditionalCheckFailedException

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:InternalServerError

  • DYNAMODB:ItemCollectionSizeLimitExceededException

  • DYNAMODB:LimitExceededException

  • DYNAMODB:ProvisionedThroughputExceededException

  • DYNAMODB:ResourceInUseException

  • DYNAMODB:ResourceNotFoundException

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:Unknown

Delete Item

<dynamodb:delete-item>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Table Name

String

Table name

x

Primarykey

Object

Primary keyname and value map

x

Target Variable

String

The name of a variable where the output of this operation is stored

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors

Output

Type

DeleteItemResult

Attributes Type

RequestIDAttribute

For Configurations

  • config

Throws

  • DYNAMODB:ConditionalCheckFailedException

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:InternalServerError

  • DYNAMODB:ItemCollectionSizeLimitExceededException

  • DYNAMODB:LimitExceededException

  • DYNAMODB:ProvisionedThroughputExceededException

  • DYNAMODB:ResourceInUseException

  • DYNAMODB:ResourceNotFoundException

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:Unknown

Delete Table

<dynamodb:delete-table>

The DeleteTable operation deletes a table and all of its items.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Table Name

String

The name of the table to delete.

x

Target Variable

String

The name of a variable where the output of this operation is stored

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors

Output

Type

TableDescription

Attributes Type

RequestIDAttribute

For Configurations

  • config

Throws

  • DYNAMODB:ConditionalCheckFailedException

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:InternalServerError

  • DYNAMODB:ItemCollectionSizeLimitExceededException

  • DYNAMODB:LimitExceededException

  • DYNAMODB:ProvisionedThroughputExceededException

  • DYNAMODB:ResourceInUseException

  • DYNAMODB:ResourceNotFoundException

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:Unknown

Describe Table

<dynamodb:describe-table>

Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Table Name

String

The name of the table to describe.

x

Target Variable

String

The name of a variable where the output of this operation is stored

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors

Output

Type

TableDescription

Attributes Type

RequestIDAttribute

For Configurations

  • config

Throws

  • DYNAMODB:ConditionalCheckFailedException

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:InternalServerError

  • DYNAMODB:ItemCollectionSizeLimitExceededException

  • DYNAMODB:LimitExceededException

  • DYNAMODB:ProvisionedThroughputExceededException

  • DYNAMODB:ResourceInUseException

  • DYNAMODB:ResourceNotFoundException

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:Unknown

Get Item

<dynamodb:get-item>

The GetItem operation returns a set of attributes for the item with the given primary key.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Table Name

String

The name of the table containing the requested item.

x

Key

Object

A map of attribute names to AttributeValue objects, representing the primary key of the item to retrieve.

x

Attributes To Gets

Array of String

This is a legacy parameter. Use ProjectionExpression instead.

Consistent Read

Boolean

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

false

Expression Attribute Names

Object

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

Projection Expression

String

A string that identifies one or more attributes to retrieve from the table.

Return Consumed Capacity

Enumeration, one of:

  • INDEXES

  • TOTAL

  • NONE

Determines the level of detail about provisioned throughput consumption that is returned in the response.

Target Variable

String

The name of a variable where the output of this operation is stored

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors

Output

Type

GetItemResult

Attributes Type

RequestIDAttribute

For Configurations

  • config

Throws

  • DYNAMODB:ConditionalCheckFailedException

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:InternalServerError

  • DYNAMODB:ItemCollectionSizeLimitExceededException

  • DYNAMODB:LimitExceededException

  • DYNAMODB:ProvisionedThroughputExceededException

  • DYNAMODB:ResourceInUseException

  • DYNAMODB:ResourceNotFoundException

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:Unknown

List Tables

<dynamodb:list-tables>

Returns an array of table names associated with the current account and endpoint.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Exclusive Start Table Name

String

The first table name that this operation evaluates. Use the value that was returned for LastEvaluatedTableName in a previous operation.

Limit

Number

A maximum number of table names to return. If this parameter is not specified, the limit is 100.

Target Variable

String

The name of a variable where the output of this operation is stored

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors

Output

Type

ListTablesResult

Attributes Type

RequestIDAttribute

For Configurations

  • config

Throws

  • DYNAMODB:ConditionalCheckFailedException

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:InternalServerError

  • DYNAMODB:ItemCollectionSizeLimitExceededException

  • DYNAMODB:LimitExceededException

  • DYNAMODB:ProvisionedThroughputExceededException

  • DYNAMODB:ResourceInUseException

  • DYNAMODB:ResourceNotFoundException

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:Unknown

Put Item

<dynamodb:put-item>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Table Name

String

Table name

x

Item

Object

Item to be inserted

x

Target Variable

String

The name of a variable where the output of this operation is stored.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors

Output

Type

PutItemResult

Attributes Type

RequestIDAttribute

For Configurations

  • config

Throws

  • DYNAMODB:ConditionalCheckFailedException

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:InternalServerError

  • DYNAMODB:ItemCollectionSizeLimitExceededException

  • DYNAMODB:LimitExceededException

  • DYNAMODB:ProvisionedThroughputExceededException

  • DYNAMODB:ResourceInUseException

  • DYNAMODB:ResourceNotFoundException

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:Unknown

Query

<dynamodb:query>

The Query operation finds items based on primary key values. You can query any table or secondary index that has a composite primary key (a partition key and a sort key).

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Key Condition Expression

String

The condition that specifies the key value(s) for items to be retrieved by the Query action.

Key Conditions

Object

This is a legacy parameter. Use KeyConditionExpression instead.

Scan Index Forward

Boolean

Specifies the order for index traversal: If true (default), the traversal is performed in ascending order; if false, the traversal is performed in descending order.

false

Select

Enumeration, one of:

  • ALL_ATTRIBUTES

  • ALL_PROJECTED_ATTRIBUTES

  • SPECIFIC_ATTRIBUTES

  • COUNT

The attributes to be returned in the result.

Attribute Names

Object

Attribute Values

Object

Table Name

String

x

Attributes To Gets

Array of String

Conditional Operator

Enumeration, one of:

  • AND

  • OR

Consistent Read

Boolean

false

Exclusive Start Key

Object

Filter Expression

String

Index Name

String

Limit

Number

Projection Expression

String

Condition Filter

Object

Return Consumed Capacity

Enumeration, one of:

  • INDEXES

  • TOTAL

  • NONE

Target Variable

String

The name of a variable where the output of this operation is stored

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors

Output

Type

QueryResult

Attributes Type

RequestIDAttribute

For Configurations

  • config

Throws

  • DYNAMODB:ConditionalCheckFailedException

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:InternalServerError

  • DYNAMODB:ItemCollectionSizeLimitExceededException

  • DYNAMODB:LimitExceededException

  • DYNAMODB:ProvisionedThroughputExceededException

  • DYNAMODB:ResourceInUseException

  • DYNAMODB:ResourceNotFoundException

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:Unknown

Scan

<dynamodb:scan>

The Scan operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a FilterExpression operation.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Segment

Number

For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.

Select

Enumeration, one of:

  • ALL_ATTRIBUTES

  • ALL_PROJECTED_ATTRIBUTES

  • SPECIFIC_ATTRIBUTES

  • COUNT

The attributes to be returned in the result.

Total Segments

Number

For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation divides.

Attribute Names

Object

Attribute Values

Object

Table Name

String

x

Attributes To Gets

Array of String

Conditional Operator

Enumeration, one of:

  • AND

  • OR

Consistent Read

Boolean

false

Exclusive Start Key

Object

Filter Expression

String

Index Name

String

Limit

Number

Projection Expression

String

Condition Filter

Object

Return Consumed Capacity

Enumeration, one of:

  • INDEXES

  • TOTAL

  • NONE

Target Variable

String

The name of a variable where the output of this operation is stored

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors

Output

Type

ScanResult

Attributes Type

RequestIDAttribute

For Configurations

  • config

Throws

  • DYNAMODB:ConditionalCheckFailedException

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:InternalServerError

  • DYNAMODB:ItemCollectionSizeLimitExceededException

  • DYNAMODB:LimitExceededException

  • DYNAMODB:ProvisionedThroughputExceededException

  • DYNAMODB:ResourceInUseException

  • DYNAMODB:ResourceNotFoundException

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:Unknown

Update Item

<dynamodb:update-item>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Table Name

String

Table name

x

Key

Object

Primary key

x

Return Consumed Capacity

Enumeration, one of:

  • INDEXES

  • TOTAL

  • NONE

Determines the level of detail about provisioned throughput consumption that is returned in the response

Return Item Collection Metrics

Enumeration, one of:

  • SIZE

  • NONE

Determines whether item collection metrics are returned

Return Values

Enumeration, one of:

  • NONE

  • ALL_OLD

  • UPDATED_OLD

  • ALL_NEW

  • UPDATED_NEW

Use if you want to get the item attributes as they appear before or after they are updated.

Update Expression

String

An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.

Attribute Updates

Object

This is a legacy parameter. Use updateExpression instead.

Expected

Object

This is a legacy parameter. Use conditionExpression instead.

Conditional Operator

Enumeration, one of:

  • AND

  • OR

Condition Expression

String

Attribute Names

Object

Attribute Values

Object

Target Variable

String

The name of a variable where the output of this operation is stored

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors

Output

Type

UpdateItemResult

Attributes Type

RequestIDAttribute

For Configurations

  • config

Throws

  • DYNAMODB:ConditionalCheckFailedException

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:InternalServerError

  • DYNAMODB:ItemCollectionSizeLimitExceededException

  • DYNAMODB:LimitExceededException

  • DYNAMODB:ProvisionedThroughputExceededException

  • DYNAMODB:ResourceInUseException

  • DYNAMODB:ResourceNotFoundException

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:Unknown

Update Table

<dynamodb:update-table>

Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Table Name

String

The name of the table to update.

x

Attribute Definitions

Array of AttributeDefinition

An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.

Read Capacity Units

Number

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

Write Capacity Units

Number

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

Global Secondary Index Updates

Array of GlobalSecondaryIndexUpdate

An array of one or more global secondary indexes for the table.

Stream View Type

Enumeration, one of:

  • NEW_IMAGE

  • OLD_IMAGE

  • NEW_AND_OLD_IMAGES

  • KEYS_ONLY

When an item in the table is modified, StreamViewType determines what information is written to the stream for this table.

Stream Enabled

Boolean

Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

false

Target Variable

String

The name of a variable where the output of this operation is stored.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

TableDescription

Attributes Type

RequestIDAttribute

For Configurations

  • config

Throws

  • DYNAMODB:ConditionalCheckFailedException

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:InternalServerError

  • DYNAMODB:ItemCollectionSizeLimitExceededException

  • DYNAMODB:LimitExceededException

  • DYNAMODB:ProvisionedThroughputExceededException

  • DYNAMODB:ResourceInUseException

  • DYNAMODB:ResourceNotFoundException

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:Unknown

Describe Stream

<dynamodb:describe-stream>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Stream ARN

String

x

Target Variable

String

The name of a variable where the output of this operation is stored.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

StreamDescription

Attributes Type

RequestIDAttribute

For Configurations

  • streams-config

Throws

  • DYNAMODB:ConditionalCheckFailedException

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:InternalServerError

  • DYNAMODB:ItemCollectionSizeLimitExceededException

  • DYNAMODB:LimitExceededException

  • DYNAMODB:ProvisionedThroughputExceededException

  • DYNAMODB:ResourceInUseException

  • DYNAMODB:ResourceNotFoundException

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:Unknown

Get Records

<dynamodb:get-records>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Shard Iterator

String

x

Streaming Strategy

  • repeatable-in-memory-iterable

  • repeatable-file-store-iterable

  • non-repeatable-iterable

Configure if repeatable streams should be used and their behavior.

Target Variable

String

The name of a variable where the output of this operation is stored.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Array of Message of [Record] payload and [RequestIDAttribute] attributes

For Configurations

  • streams-config

Throws

  • DYNAMODB:ConditionalCheckFailedException

  • DYNAMODB:InternalServerError

  • DYNAMODB:ItemCollectionSizeLimitExceededException

  • DYNAMODB:LimitExceededException

  • DYNAMODB:ProvisionedThroughputExceededException

  • DYNAMODB:ResourceInUseException

  • DYNAMODB:ResourceNotFoundException

  • DYNAMODB:Unknown

Get Shard Iterator

<dynamodb:get-shard-iterator>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Shard Id

String

x

Shard Iterator Type

String

x

Starting Sequence Number

String

Stream ARN

String

x

Target Variable

String

The name of a variable where the output of this operation is stored.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

RequestIDAttribute

For Configurations

  • streams-config

Throws

  • DYNAMODB:ConditionalCheckFailedException

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:InternalServerError

  • DYNAMODB:ItemCollectionSizeLimitExceededException

  • DYNAMODB:LimitExceededException

  • DYNAMODB:ProvisionedThroughputExceededException

  • DYNAMODB:ResourceInUseException

  • DYNAMODB:ResourceNotFoundException

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:Unknown

List Streams

<dynamodb:list-streams>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Table Name

String

Streaming Strategy

  • repeatable-in-memory-iterable

  • repeatable-file-store-iterable

  • non-repeatable-iterable

Configure if repeatable streams should be used and their behavior.

Target Variable

String

The name of a variable where the output of this operation is stored.

Target Value

String

An expression to evaluate against the operation’s output and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Array of Message of [Stream] payload and [RequestIDAttribute] attributes.

For Configurations

  • streams-config

Throws

  • DYNAMODB:ConditionalCheckFailedException

  • DYNAMODB:InternalServerError

  • DYNAMODB:ItemCollectionSizeLimitExceededException

  • DYNAMODB:LimitExceededException

  • DYNAMODB:ProvisionedThroughputExceededException

  • DYNAMODB:ResourceInUseException

  • DYNAMODB:ResourceNotFoundException

  • DYNAMODB:Unknown

Types

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

  • reconnect

  • reconnect-forever

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often (in milliseconds) to reconnect.

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often (in milliseconds) to reconnect.

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute.

Batch Write Item Result

Field Type Description Default Value Required

Consumed Capacity

Array of ConsumedCapacity

Item Collection Metrics

Object

Unprocessed Items

Object

Consumed Capacity

Field Type Description Default Value Required

Capacity Units

Number

Global Secondary Indexes

Object

Local Secondary Indexes

Object

Table

Capacity

Table Name

String

Capacity

Field Type Description Default Value Required

Capacity Units

Number

Request ID Attribute

Field Type Description Default Value Required

Request Id

String

Batch Get Item Result

Field Type Description Default Value Required

Consumed Capacity

Array of ConsumedCapacity

Responses

Object

Unprocessed Keys

Object

Table Description

Field Type Description Default Value Required

Attribute Definitions

Array of AttributeDefinition

Creation Date Time

DateTime

Global Secondary Indexes

Array of GlobalSecondaryIndexDescription

Item Count

Number

Key Schema

Array of KeySchemaElement

Latest Stream Arn

String

Latest Stream Label

String

Local Secondary Indexes

Array of LocalSecondaryIndexDescription

Provisioned Throughput

ProvisionedThroughputDescription

Stream Specification

StreamSpecification

Table Arn

String

Table Name

String

Table Size Bytes

Number

Table Status

String

Attribute Definition

Field Type Description Default Value Required

Attribute Name

String

Attribute Type

String

Global Secondary Index Description

Field Type Description Default Value Required

Backfilling

Boolean

Index Arn

String

Index Name

String

Index Size Bytes

Number

Index Status

String

Item Count

Number

Key Schema

Array of KeySchemaElement

Projection

Projection

Provisioned Throughput

ProvisionedThroughputDescription

Key Schema Element

Field Type Description Default Value Required

Attribute Name

String

Key Type

String

Projection

Field Type Description Default Value Required

Non Key Attributes

Array of String

Projection Type

String

Provisioned Throughput Description

Field Type Description Default Value Required

Last Decrease Date Time

DateTime

Last Increase Date Time

DateTime

Number Of Decreases Today

Number

Read Capacity Units

Number

Write Capacity Units

Number

Local Secondary Index Description

Field Type Description Default Value Required

Index Arn

String

Index Name

String

Index Size Bytes

Number

Item Count

Number

Key Schema

Array of KeySchemaElement

Projection

Projection

Stream Specification

Field Type Description Default Value Required

Stream Enabled

Boolean

Stream View Type

String

Global Secondary Index

Field Type Description Default Value Required

Index Name

String

Key Schema

Array of KeySchemaElement

Projection

Projection

Provisioned Throughput

ProvisionedThroughput

Provisioned Throughput

Field Type Description Default Value Required

Read Capacity Units

Number

Write Capacity Units

Number

Local Secondary Index

Field Type Description Default Value Required

Index Name

String

Key Schema

Array of KeySchemaElement

Projection

Projection

Delete Item Result

Field Type Description Default Value Required

Attributes

Object

Consumed Capacity

ConsumedCapacity

Item Collection Metrics

ItemCollectionMetrics

Item Collection Metrics

Field Type Description Default Value Required

Item Collection Key

Object

Size Estimate Range GB

Array of Number

Get Item Result

Field Type Description Default Value Required

Consumed Capacity

ConsumedCapacity

Item

Object

List Tables Result

Field Type Description Default Value Required

Last Evaluated Table Name

String

Table Names

Array of String

Put Item Result

Field Type Description Default Value Required

Attributes

Object

Consumed Capacity

ConsumedCapacity

Item Collection Metrics

ItemCollectionMetrics

Query Result

Field Type Description Default Value Required

Consumed Capacity

ConsumedCapacity

Count

Number

Items

Array of Object

Last Evaluated Key

Object

Scanned Count

Number

Scan Result

Field Type Description Default Value Required

Consumed Capacity

ConsumedCapacity

Count

Number

Items

Array of Object

Last Evaluated Key

Object

Scanned Count

Number

Update Item Result

Field Type Description Default Value Required

Attributes

Object

Consumed Capacity

ConsumedCapacity

Item Collection Metrics

ItemCollectionMetrics

Global Secondary Index Update

Field Type Description Default Value Required

Create

CreateGlobalSecondaryIndexAction

Delete

String

Update

UpdateGlobalSecondaryIndexAction

Create Global Secondary Index Action

Field Type Description Default Value Required

Index Name

String

Key Schema

Array of KeySchemaElement

Projection

Projection

Provisioned Throughput

ProvisionedThroughput

Update Global Secondary Index Action

Field Type Description Default Value Required

Index Name

String

Provisioned Throughput

ProvisionedThroughput

Stream Description

Field Type Description Default Value Required

Creation Request Date Time

DateTime

Key Schema

Array of KeySchemaElement

Last Evaluated Shard Id

String

Shards

Array of Shard

Stream Arn

String

Stream Label

String

Stream Status

String

Stream View Type

String

Table Name

String

Shard

Field Type Description Default Value Required

Parent Shard Id

String

Sequence Number Range

SequenceNumberRange

Shard Id

String

Sequence Number Range

Field Type Description Default Value Required

Ending Sequence Number

String

Starting Sequence Number

String

Record

Field Type Description Default Value Required

Aws Region

String

Dynamodb

StreamRecord

Event ID

String

Event Name

String

Event Source

String

Event Version

String

User Identity

Identity

Stream Record

Field Type Description Default Value Required

Approximate Creation Date Time

DateTime

Keys

Object

New Image

Object

Old Image

Object

Sequence Number

String

Size Bytes

Number

Stream View Type

String

Identity

Field Type Description Default Value Required

Principal Id

String

Type

String

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

This is the amount of instances that’s initially allowed to be kept in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error ise raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

This is the maximum amount of memory to use. If more than that is used, then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower or equal to zero means no limit.

Repeatable File Store Iterable

Field Type Description Default Value Required

Max In Memory Size

Number

This is the maximum amount of instances to keep in memory. If more than that is required, then it starts to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed.

Stream

Field Type Description Default Value Required

Stream Arn

String

Stream Label

String

Table Name

String