Contact Free trial Login

Amazon DynamoDB Connector Reference - Mule 4

Support Version: Select

Amazon DynamoDB Connector Version 1.3

Configurations


Default Configuration

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

The connection types to provide to this configuration.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the Mule runtime considers it eligible for expiration. To optimize resources, Mule expires instances that are not in use without impacting performance or resource utilization.

Connection Types

Basic
Parameters
Name Type Description Default Value Required

Connection Timeout

Number

The amount of time to wait (in milliseconds) when initially establishing a connection before the connector times out. A value of 0 means infinite, and is not recommended.

50000

Socket Timeout

Number

The amount of time to wait (in milliseconds) for data to transfer over an established open connection before the connection times out. A value of 0 means infinite, and is not recommended.

50000

Access Key

String

The access key provided by Amazon.

x

Secret Key

String

The secret key provided by Amazon.

x

Try Default AWSCredentials Provider Chain

Boolean

Set this field to true to obtain credentials from the AWS environment, See https://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/credentials.html

false

Max Connections

Number

Sets the maximum number of allowed open HTTP connections.

Region Endpoint

String

Set the topic region endpoint.

US_EAST_1

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

The optional proxy host.

Port

Number

The optional proxy port.

Username

String

The optional proxy username.

Password

String

The optional proxy password.

Domain

String

The optional proxy domain.

Workstation

String

The optional proxy workstation.

Role
Parameters
Name Type Description Default Value Required

Role ARN

String

The Role ARN unique identifies role to assume to gain cross account access.

x

Connection Timeout

Number

The amount of time to wait (in milliseconds) when initially establishing a connection before the connector gives up and times out. A value of 0 means infinite, and is not recommended.

50000

Socket Timeout

Number

The amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection times out. A value of 0 means infinite, and is not recommended.

50000

Access Key

String

The access key provided by Amazon.

x

Secret Key

String

The secret key provided by Amazon.

x

Try Default AWSCredentials Provider Chain

Boolean

Set this field to true to obtain credentials from the AWS environment, See: https://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/credentials.html

false

Max Connections

Number

Sets the maximum number of allowed open HTTP connections.

Region Endpoint

String

Set the topic region endpoint.

US_EAST_1

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

The optional proxy host.

Port

Number

The optional proxy port.

Username

String

The optional proxy username.

Password

String

The optional proxy password.

Domain

String

The optional proxy domain.

Workstation

String

The optional proxy workstation.

Supported Operations


StreamsConfiguration

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

The connection types to provide to this configuration.

x

Expiration Policy

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 purges the instances as appropriate.

Connection Types

Streams
Parameters
Name Type Description Default Value Required

Connection Timeout

Number

The amount of time to wait (in milliseconds) when initially establishing a connection before the connector gives up and times out. A value of 0 means infinite, and is not recommended.

50000

Socket Timeout

Number

The amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection times out. A value of 0 means infinite, and is not recommended.

50000

Access Key

String

The access key provided by Amazon.

x

Secret Key

String

The secret key provided by Amazon.

x

Try Default AWSCredentials Provider Chain

Boolean

Set this field to true to obtain credentials from the AWS environment, See: https://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/credentials.html

false

Max Connections

Number

Sets the maximum number of allowed open HTTP connections.

Region Endpoint

String

Set the topic region endpoint.

US_EAST_1

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

The optional proxy host.

Port

Number

The optional proxy port.

Username

String

The optional proxy username.

Password

String

The optional proxy password.

Domain

String

The optional proxy domain.

Workstation

String

The optional proxy workstation.

Operations

Batch Delete Item

<dynamodb:batch-delete-item>

Delete multiple items in one or more tables. For information, see the Amazon DynamoDB API Reference.

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 the table.

x

Target Variable

String

A variable that stores the output of an expression.

Target Value

String

An expression to evaluate against the operation’s output. The output of the expression is stored in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Batch Write Item Result

Attributes Type

For Configurations

Throws

  • DYNAMODB:ACCESS_DENIED_EXCEPTION

  • DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION

  • DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION

  • DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION

  • DYNAMODB:RESOURCE_IN_USE_EXCEPTION

  • DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:THROTTLING_EXCEPTION

  • DYNAMODB:UNKNOWN

  • DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION

  • DYNAMODB:VALIDATION_EXCEPTION

Batch Get Item

<dynamodb:batch-get-item>

Return the attributes of one or more items from one or more tables. You identify requested items by primary key. For information, see the Amazon DynamoDB API Reference.

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

A variable that stores the output of an expression.

Target Value

String

An expression to evaluate against the operation’s output. The output of the expression is stored in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Batch Get Item Result

Attributes Type

For Configurations

Throws

  • DYNAMODB:ACCESS_DENIED_EXCEPTION

  • DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION

  • DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION

  • DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION

  • DYNAMODB:RESOURCE_IN_USE_EXCEPTION

  • DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:THROTTLING_EXCEPTION

  • DYNAMODB:UNKNOWN

  • DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION

  • DYNAMODB:VALIDATION_EXCEPTION

Batch Put Item

<dynamodb:batch-put-item>

Put multiple items in one or more tables. For information, see the Amazon DynamoDB API Reference.

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

A variable that stores the output of an expression.

Target Value

String

An expression to evaluate against the operation’s output. The output of the expression is stored in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Batch Write Item Result

Attributes Type

For Configurations

Throws

  • DYNAMODB:ACCESS_DENIED_EXCEPTION

  • DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION

  • DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION

  • DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION

  • DYNAMODB:RESOURCE_IN_USE_EXCEPTION

  • DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:THROTTLING_EXCEPTION

  • DYNAMODB:UNKNOWN

  • DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION

  • DYNAMODB:VALIDATION_EXCEPTION

Create Table

<dynamodb:create-table>

Add a new table to your account. In an AWS account, table names must be unique within each region. For information, see the Amazon DynamoDB API Reference.

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

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

x

Key Schemas

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

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

Local Secondary Indexes

One or more local secondary indexes (the maximum is five) to be created on 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 table’s stream.

Stream Enabled

Boolean

Indicates whether to enable Streams (true) or disable Streams (false).

false

Target Variable

String

A variable that stores the output of an expression.

Target Value

String

An expression to evaluate against the operation’s output. The output of the expression is stored in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Table Description

Attributes Type

For Configurations

Throws

  • DYNAMODB:ACCESS_DENIED_EXCEPTION

  • DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION

  • DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION

  • DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION

  • DYNAMODB:RESOURCE_IN_USE_EXCEPTION

  • DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:THROTTLING_EXCEPTION

  • DYNAMODB:UNKNOWN

  • DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION

  • DYNAMODB:VALIDATION_EXCEPTION

Delete Item

<dynamodb:delete-item>

Delete a single item in a table by primary key. For information, see the Amazon DynamoDB API Reference.

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 key name and value map.

#[payload]

Target Variable

String

A variable that stores the output of an expression.

Target Value

String

An expression to evaluate against the operation’s output. The output of the expression is stored in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Delete Item Result

Attributes Type

For Configurations

Throws

  • DYNAMODB:ACCESS_DENIED_EXCEPTION

  • DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION

  • DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION

  • DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION

  • DYNAMODB:RESOURCE_IN_USE_EXCEPTION

  • DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:THROTTLING_EXCEPTION

  • DYNAMODB:UNKNOWN

  • DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION

  • DYNAMODB:VALIDATION_EXCEPTION

Delete Table

<dynamodb:delete-table>

Delete a table and all of its items. For information, see the Amazon DynamoDB API Reference.

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

A variable that stores the output of an expression.

Target Value

String

An expression to evaluate against the operation’s output. The output of the expression is stored in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Table Description

Attributes Type

For Configurations

Throws

  • DYNAMODB:ACCESS_DENIED_EXCEPTION

  • DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION

  • DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION

  • DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION

  • DYNAMODB:RESOURCE_IN_USE_EXCEPTION

  • DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:THROTTLING_EXCEPTION

  • DYNAMODB:UNKNOWN

  • DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION

  • DYNAMODB:VALIDATION_EXCEPTION

Describe Table

<dynamodb:describe-table>

Return 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. For information, see the Amazon DynamoDB API Reference.

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

A variable that stores the output of an expression.

Target Value

String

An expression to evaluate against the operation’s output. The output of the expression is stored in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Table Description

Attributes Type

For Configurations

Throws

  • DYNAMODB:ACCESS_DENIED_EXCEPTION

  • DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION

  • DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION

  • DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION

  • DYNAMODB:RESOURCE_IN_USE_EXCEPTION

  • DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:THROTTLING_EXCEPTION

  • DYNAMODB:UNKNOWN

  • DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION

  • DYNAMODB:VALIDATION_EXCEPTION

Get Item

<dynamodb:get-item>

Return a set of attributes for the item with the given primary key. For information, see the Amazon DynamoDB API Reference.

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.

#[payload]

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 returned in the response.

NONE

Target Variable

String

A variable that stores the output of an expression.

Target Value

String

An expression to evaluate against the operation’s output. The output of the expression is stored in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Get Item Result

Attributes Type

For Configurations

Throws

  • DYNAMODB:ACCESS_DENIED_EXCEPTION

  • DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION

  • DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION

  • DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION

  • DYNAMODB:RESOURCE_IN_USE_EXCEPTION

  • DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:THROTTLING_EXCEPTION

  • DYNAMODB:UNKNOWN

  • DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION

  • DYNAMODB:VALIDATION_EXCEPTION

List Tables

<dynamodb:list-tables>

Return an array of table names associated with the current account and endpoint. For information, see the Amazon DynamoDB API Reference.

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 for this operation to evaluate. 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

A variable that stores the output of an expression.

Target Value

String

An expression to evaluate against the operation’s output. The output of the expression is stored in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

List Tables Result

Attributes Type

For Configurations

Throws

  • DYNAMODB:ACCESS_DENIED_EXCEPTION

  • DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION

  • DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION

  • DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION

  • DYNAMODB:RESOURCE_IN_USE_EXCEPTION

  • DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:THROTTLING_EXCEPTION

  • DYNAMODB:UNKNOWN

  • DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION

  • DYNAMODB:VALIDATION_EXCEPTION

Put Item

<dynamodb:put-item>

Create a new item, or replace an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item replaces the existing item. For information, see the Amazon DynamoDB API Reference.

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.

#[payload]

Target Variable

String

A variable that stores the output of an expression.

Target Value

String

An expression to evaluate against the operation’s output. The output of the expression is stored in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Put Item Result

Attributes Type

For Configurations

Throws

  • DYNAMODB:ACCESS_DENIED_EXCEPTION

  • DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION

  • DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION

  • DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION

  • DYNAMODB:RESOURCE_IN_USE_EXCEPTION

  • DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:THROTTLING_EXCEPTION

  • DYNAMODB:UNKNOWN

  • DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION

  • DYNAMODB:VALIDATION_EXCEPTION

Query

<dynamodb:query>

Find 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). For information, see the Amazon DynamoDB API Reference.

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 values 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

A variable that stores the output of an expression.

Target Value

String

An expression to evaluate against the operation’s output. The output of the expression is stored in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Query Result

Attributes Type

For Configurations

Throws

  • DYNAMODB:ACCESS_DENIED_EXCEPTION

  • DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION

  • DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION

  • DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION

  • DYNAMODB:RESOURCE_IN_USE_EXCEPTION

  • DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:THROTTLING_EXCEPTION

  • DYNAMODB:UNKNOWN

  • DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION

  • DYNAMODB:VALIDATION_EXCEPTION

Scan

<dynamodb:scan>

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 is divided.

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

A variable that stores the output of an expression.

Target Value

String

An expression to evaluate against the operation’s output. The output of the expression is stored in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Scan Result

Attributes Type

For Configurations

Throws

  • DYNAMODB:ACCESS_DENIED_EXCEPTION

  • DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION

  • DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION

  • DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION

  • DYNAMODB:RESOURCE_IN_USE_EXCEPTION

  • DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:THROTTLING_EXCEPTION

  • DYNAMODB:UNKNOWN

  • DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION

  • DYNAMODB:VALIDATION_EXCEPTION

Update Item

<dynamodb:update-item>

Edit an existing item’s attributes, or add a new item to the table if it does not already exist. For information, see the Amazon DynamoDB API Reference.

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.

#[payload]

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

A variable that stores the output of an expression.

Target Value

String

An expression to evaluate against the operation’s output. The output of the expression is stored in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Update Item Result

Attributes Type

For Configurations

Throws

  • DYNAMODB:ACCESS_DENIED_EXCEPTION

  • DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION

  • DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION

  • DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION

  • DYNAMODB:RESOURCE_IN_USE_EXCEPTION

  • DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:THROTTLING_EXCEPTION

  • DYNAMODB:UNKNOWN

  • DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION

  • DYNAMODB:VALIDATION_EXCEPTION

Update Table

<dynamodb:update-table>

Modify the provisioned throughput settings, global secondary indexes, or DynamoDB streams settings for a table. For information, see the Amazon DynamoDB API Reference.

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

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 elements 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

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

A variable that stores the output of an expression.

Target Value

String

An expression to evaluate against the operation’s output. The output of the expression is stored in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Table Description

Attributes Type

For Configurations

Throws

  • DYNAMODB:ACCESS_DENIED_EXCEPTION

  • DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION

  • DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION

  • DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION

  • DYNAMODB:RESOURCE_IN_USE_EXCEPTION

  • DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:THROTTLING_EXCEPTION

  • DYNAMODB:UNKNOWN

  • DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION

  • DYNAMODB:VALIDATION_EXCEPTION

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

A variable that stores the output of an expression.

Target Value

String

An expression to evaluate against the operation’s output. The output of the expression is stored in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Stream Description

Attributes Type

For Configurations

Throws

  • DYNAMODB:ACCESS_DENIED_EXCEPTION

  • DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION

  • DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION

  • DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION

  • DYNAMODB:RESOURCE_IN_USE_EXCEPTION

  • DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:THROTTLING_EXCEPTION

  • DYNAMODB:UNKNOWN

  • DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION

  • DYNAMODB:VALIDATION_EXCEPTION

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

Configure to use repeatable streams.

Target Variable

String

A variable that stores the output of an expression.

Target Value

String

An expression to evaluate against the operation’s output. The output of the expression is stored in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Message of [Record] payload and [Request ID Attribute] attributes

For Configurations

Throws

  • DYNAMODB:ACCESS_DENIED_EXCEPTION

  • DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION

  • DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION

  • DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION

  • DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION

  • DYNAMODB:RESOURCE_IN_USE_EXCEPTION

  • DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION

  • DYNAMODB:THROTTLING_EXCEPTION

  • DYNAMODB:UNKNOWN

  • DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION

  • DYNAMODB:VALIDATION_EXCEPTION

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

A variable that stores the output of an expression.

Target Value

String

An expression to evaluate against the operation’s output. The output of the expression is stored in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

String

Attributes Type

For Configurations

Throws

  • DYNAMODB:ACCESS_DENIED_EXCEPTION

  • DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION

  • DYNAMODB:CONNECTIVITY

  • DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION

  • DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION

  • DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION

  • DYNAMODB:RESOURCE_IN_USE_EXCEPTION

  • DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION

  • DYNAMODB:RETRY_EXHAUSTED

  • DYNAMODB:THROTTLING_EXCEPTION

  • DYNAMODB:UNKNOWN

  • DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION

  • DYNAMODB:VALIDATION_EXCEPTION

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

Configure to use repeatable streams.

Target Variable

String

A variable that stores the output of an expression.

Target Value

String

An expression to evaluate against the operation’s output. The output of the expression is stored in the Target Variable string.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Message of Stream payload and Request ID Attribute attributes.

For Configurations

Throws

  • DYNAMODB:ACCESS_DENIED_EXCEPTION

  • DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION

  • DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION

  • DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:LIMIT_EXCEEDED_EXCEPTION

  • DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION

  • DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION

  • DYNAMODB:RESOURCE_IN_USE_EXCEPTION

  • DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION

  • DYNAMODB:THROTTLING_EXCEPTION

  • DYNAMODB:UNKNOWN

  • DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION

  • DYNAMODB:VALIDATION_EXCEPTION

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

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often to reconnect (in milliseconds).

Count

Number

The number of reconnection attempts to make.

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

true

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

true

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

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

Number

Table Name

String

Request ID Attribute

Field Type Description Default Value Required

Request Id

String

Batch Get Item Result

Field Type Description Default Value Required

Consumed Capacity

Responses

Object

Unprocessed Keys

Object

Table Description

Field Type Description Default Value Required

Attribute Definitions

Creation Date Time

DateTime

Global Secondary Indexes

Item Count

Number

Key Schema

Latest Stream Arn

String

Latest Stream Label

String

Local Secondary Indexes

Provisioned Throughput

Stream Specification

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

Enumeration, one of:

  • STRING

  • NUMBER

  • BINARY

Global Secondary Index Description

Field Type Description Default Value Required

Backfilling

Boolean

Index Arn

String

Index Name

String

Index Size Bytes

Number

Index Status

Enumeration, one of:

  • CREATING

  • UPDATING

  • DELETING

  • ACTIVE

Item Count

Number

Key Schema

Projection

Provisioned Throughput

Key Schema Element

Field Type Description Default Value Required

Attribute Name

String

Key Type

Enumeration, one of:

  • HASH

  • RANGE

Projection

Field Type Description Default Value Required

Non Key Attributes

Array of String

Projection Type

Enumeration, one of:

  • ALL

  • KEYS_ONLY

  • INCLUDE

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

Projection

Stream Specification

Field Type Description Default Value Required

Stream Enabled

Boolean

Stream View Type

Enumeration, one of:

  • NEW_IMAGE

  • OLD_IMAGE

  • NEW_AND_OLD_IMAGES

  • KEYS_ONLY

Global Secondary Index

Field Type Description Default Value Required

Index Name

String

Key Schema

Projection

Provisioned Throughput

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

Projection

Delete Item Result

Field Type Description Default Value Required

Attributes

Object

Consumed Capacity

Item Collection Metrics

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

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

Item Collection Metrics

Query Result

Field Type Description Default Value Required

Consumed Capacity

Count

Number

Items

Array of Object

Last Evaluated Key

Object

Scanned Count

Number

Scan Result

Field Type Description Default Value Required

Consumed Capacity

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

Item Collection Metrics

Global Secondary Index Update

Field Type Description Default Value Required

Create

Delete

String

Update

Create Global Secondary Index Action

Field Type Description Default Value Required

Index Name

String

Key Schema

Projection

Provisioned Throughput

Update Global Secondary Index Action

Field Type Description Default Value Required

Index Name

String

Provisioned Throughput

Stream Description

Field Type Description Default Value Required

Creation Request Date Time

DateTime

Key Schema

Last Evaluated Shard Id

String

Shards

Array of Shard

Stream Arn

String

Stream Label

String

Stream Status

Enumeration, one of:

  • ENABLING

  • ENABLED

  • DISABLING

  • DISABLED

Stream View Type

Enumeration, one of:

  • NEW_IMAGE

  • OLD_IMAGE

  • NEW_AND_OLD_IMAGES

  • KEYS_ONLY

Table Name

String

Shard

Field Type Description Default Value Required

Parent Shard Id

String

Sequence Number Range

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

Event ID

String

Event Name

Enumeration, one of:

  • INSERT

  • MODIFY

  • REMOVE

Event Source

String

Event Version

String

User 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

Enumeration, one of:

  • NEW_IMAGE

  • OLD_IMAGE

  • NEW_AND_OLD_IMAGES

  • KEYS_ONLY

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

The amount of instances that is initially be 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 is raised when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

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 than or equal to zero means no limit.

Repeatable File Store Iterable

Field Type Description Default Value Required

Max In Memory Size

Number

The maximum amount of instances to keep in memory. If more are required, then the Mule runtime 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

We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used and to tailor advertising. You can read more and make your cookie choices here. By continuing to use this site you are giving us your consent to do this.