# mulesoft Amazon DynamoDB Connector - Full Documentation --- product: Amazon DynamoDB Connector version: 1.5 --- # Amazon DynamoDB Connector > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Amazon DynamoDB Connector v1.4 Anypoint Connector for Amazon DynamoDB (Amazon DynamoDB Connector) provides connectivity to the Amazon DynamoDB API. Amazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. For compatibility information and fixed issues, see the [Amazon DynamoDB Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/amazon-dynamodb-connector-release-notes-mule-4) ## Common Use Cases for the Connector Amazon DynamoDB Connector enables you to interact with Amazon DynamoDB to create a database table that can: - Store and retrieve any amount of data - Serve any level of request traffic - Automatically distribute the data and traffic for the table over a sufficient number of servers to manage the request capacity and the amount of data stored. Amazon Dynamo DB Connector does this while maintaining consistent, fast performance. ## Before You Begin To use this information, you must be familiar with: - The Amazon DynamoDB API - Anypoint Connectors - Mule runtime engine (Mule) - Elements in a Mule flow - Global elements - How to create a Mule app using Anypoint Studio Before creating an app, you must have access to: - Amazon DynamoDB - AWS Identity and Access Management (IAM) user account credentials - Anypoint Studio version 7.0 or later ## Audience - Starting user To create your Mule app, see [Using Anypoint Studio to Configure Amazon DynamoDB Connector](https://docs.mulesoft.com/amazon-dynamodb-connector/1.5/amazon-dynamodb-connector-studio). The [Examples](https://docs.mulesoft.com/amazon-dynamodb-connector/1.5/amazon-dynamodb-connector-examples) topic provides one or more use cases for the connector. - Power user Read the [XML and Maven Support](https://docs.mulesoft.com/amazon-dynamodb-connector/1.5/amazon-dynamodb-connector-xml-maven) and [Examples](https://docs.mulesoft.com/amazon-dynamodb-connector/1.5/amazon-dynamodb-connector-examples) topics. ## Authentication Types Amazon DynamoDB Connector supports the Basic and Role authentication types. For information about configuring these authentication types, see [Using Anypoint Studio to Configure Amazon DynamoDB Connector](https://docs.mulesoft.com/amazon-dynamodb-connector/1.5/amazon-dynamodb-connector-studio). ## Next Step After you complete the prerequisites and finish experimenting with templates and examples, you are ready to create a new app using Anypoint Studio. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Using Anypoint Studio to Configure Amazon DynamoDB Connector](https://docs.mulesoft.com/amazon-dynamodb-connector/1.5/amazon-dynamodb-connector-studio) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon DynamoDB Connector version: 1.6 is-latest-version: true --- # Amazon DynamoDB Connector > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Amazon DynamoDB Connector v1.4 Anypoint Connector for Amazon DynamoDB (Amazon DynamoDB Connector) provides connectivity to the Amazon DynamoDB API. Amazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. For compatibility information and fixed issues, see the [Amazon DynamoDB Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/amazon-dynamodb-connector-release-notes-mule-4) ## Common Use Cases for the Connector Amazon DynamoDB Connector enables you to interact with Amazon DynamoDB to create a database table that can: - Store and retrieve any amount of data - Serve any level of request traffic - Automatically distribute the data and traffic for the table over a sufficient number of servers to manage the request capacity and the amount of data stored. Amazon Dynamo DB Connector does this while maintaining consistent, fast performance. ## Before You Begin To use this information, you must be familiar with: - The Amazon DynamoDB API - Anypoint Connectors - Mule runtime engine (Mule) - Elements in a Mule flow - Global elements - How to create a Mule app using Anypoint Studio Before creating an app, you must have access to: - Amazon DynamoDB - AWS Identity and Access Management (IAM) user account credentials - Anypoint Studio version 7.0 or later ## Audience - Starting user To create your Mule app, see [Using Anypoint Studio to Configure Amazon DynamoDB Connector](https://docs.mulesoft.com/amazon-dynamodb-connector/latest/amazon-dynamodb-connector-studio). The [Examples](https://docs.mulesoft.com/amazon-dynamodb-connector/latest/amazon-dynamodb-connector-examples) topic provides one or more use cases for the connector. - Power user Read the [XML and Maven Support](https://docs.mulesoft.com/amazon-dynamodb-connector/latest/amazon-dynamodb-connector-xml-maven) and [Examples](https://docs.mulesoft.com/amazon-dynamodb-connector/latest/amazon-dynamodb-connector-examples) topics. ## Authentication Types Amazon DynamoDB Connector supports the Basic and Role authentication types. For information about configuring these authentication types, see [Using Anypoint Studio to Configure Amazon DynamoDB Connector](https://docs.mulesoft.com/amazon-dynamodb-connector/latest/amazon-dynamodb-connector-studio). ## Next Step After you complete the prerequisites and finish experimenting with templates and examples, you are ready to create a new app using Anypoint Studio. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Using Anypoint Studio to Configure Amazon DynamoDB Connector](https://docs.mulesoft.com/amazon-dynamodb-connector/latest/amazon-dynamodb-connector-studio) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon DynamoDB Connector version: 1.5 --- # Amazon DynamoDB Connector 1.5 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Release Notes: [Amazon DynamoDB Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/amazon-dynamodb-connector-release-notes-mule-4) ## Configurations --- ### Default Configuration #### Parameters
NameTypeDescriptionDefault ValueRequired

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 Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

#### Connection Types ##### Basic ###### Parameters
NameTypeDescriptionDefault ValueRequired

Session Token

String

The session token provided by Amazon STS.

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 infinity and is not recommended.

50000

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Max Connections

Number

Sets the maximum number of allowed open HTTP connections.

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 infinity and is not recommended.

50000

Socket Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Socket Timeout field.

SECONDS

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

Custom Service Endpoint

String

Sets a custom service endpoint. Useful when a non-standard service endpoint is required, such as a VPC endpoint. For local connections, set this field to http://localhost:8000/.

Region Endpoint

String

Set the topic region endpoint.

US_EAST_1

TLS Configuration

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
NameTypeDescriptionDefault ValueRequired

Role ARN

String

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

x

Custom STS Endpoint

String

Sets a custom service endpoint. Useful when a non-standard service endpoint is required, such as a VPC endpoint. The custom STS endpoint might not work if DefaultAWSCredentialsProviderChain is used. Instead, use AWS environment variables such as AWS_STS_REGIONAL_ENDPOINTS, AWS_REGION, and AWS_ENDPOINT_URL.

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 infinity and is not recommended.

50000

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Max Connections

Number

Sets the maximum number of allowed open HTTP connections.

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 infinity and is not recommended.

50000

Socket Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Socket Timeout field.

SECONDS

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

Custom Service Endpoint

String

Sets a custom service endpoint. Useful when a non-standard service endpoint is required, such as a VPC endpoint. For local connections, set this field to http://localhost:8000/.

Region Endpoint

String

Set the topic region endpoint.

US_EAST_1

TLS Configuration

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.

### Streams Configuration #### Parameters
NameTypeDescriptionDefault ValueRequired

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 Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

#### Connection Types ##### Streams ###### Supported Operations - [Describe Stream](#describeStream) - [Get Records](#getRecords) - [Get Shard Iterator](#getShardIterator) - [List Streams](#listStreams) ###### Parameters
NameTypeDescriptionDefault ValueRequired

Session Token

String

The session token provided by Amazon STS.

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 infinity and is not recommended.

50000

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Max Connections

Number

Sets the maximum number of allowed open HTTP connections.

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 infinity and is not recommended.

50000

Socket Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Socket Timeout field.

SECONDS

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

Custom Service Endpoint

String

Sets a custom service endpoint. Useful when a non-standard service endpoint is required, such as a VPC endpoint. For local connections, set this field to http://localhost:8000/.

Region Endpoint

String

Set the topic region endpoint.

US_EAST_1

TLS Configuration

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](#batchDeleteItem) - [Batch Get Item](#batchGetItem) - [Batch Put Item](#batchPutItem) - [Create Table](#createTable) - [Delete Item](#deleteItem) - [Delete Table](#deleteTable) - [Describe Table](#describeTable) - [Get Item](#getItem) - [List Tables](#listTables) - [Paginated Query](#paginatedQuery) - [Put Item](#putItem) - [Query](#query) - [Scan](#scan) - [Update Item](#updateItem) - [Update Table](#updateTable) ### Batch Delete Item `` The Batch Delete Item operation deletes multiple items in one or more tables. For information, see the [Amazon DynamoDB API Reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BatchWriteItem.html) for this operation. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Batch Write Item Result

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` The Batch Get Item operation returns 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](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BatchGetItem.html) for this operation. #### Parameters
NameTypeDescriptionDefault ValueRequired

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 to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Batch Get Item Result

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` The Batch Put Item operation puts multiple items in one or more tables. For information, see the [Amazon DynamoDB API Reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BatchWriteItem.html) for this operation. #### Parameters
NameTypeDescriptionDefault ValueRequired

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 to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Batch Write Item Result

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` The Create Table operation adds 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](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html) for this operation. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Table Description

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` This operation deletes a single item in a table by primary key. For information, see the [Amazon DynamoDB API Reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DeleteItem.html) for this operation. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Delete Item Result

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` The Delete Table operation deletes a table and all of its items. For information, see the [Amazon DynamoDB API Reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DeleteTable.html) for this operation. #### Parameters
NameTypeDescriptionDefault ValueRequired

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 to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Table Description

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` This operation 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. For information, see the [Amazon DynamoDB API Reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeTable.html) for this operation. #### Parameters
NameTypeDescriptionDefault ValueRequired

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 to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Table Description

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` The Get Item operation returns a set of attributes for the item with the given primary key. For information, see the [Amazon DynamoDB API Reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html) for this operation. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Get Item Result

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` This operation returns an array of table names associated with the current account and endpoint. For information, see the [Amazon DynamoDB API Reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ListTables.html) for this operation. #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Exclusive Start Table Name

String

The first table name that this operation will 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

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

List Tables Result

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 ### Paginated Query `` The **Paginated 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. The operation returns pages with a limit specified in the **Limit** field or the maximum amount of 1MB data. This behavior differentiates from the existing **Query** operation that truncates the response ignoring the DynamoDB value of the **Last Evaluated Key** field, which indicates that the query has more matching items. #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Key Condition Expression

String

The condition that specifies the key values for items to retrieve by the Query operation.

Key Conditions

Object

This is a legacy parameter. Use Key Condition Expression 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 return in the result.

Attribute Names

Object

One or more substitution tokens for attribute names in an expression.

Attribute Values

Object

One or more values to substitute in an expression.

Table Name

String

Name of the table containing the requested item.

x

Attributes To Gets

Array of String

This is a legacy parameter. Use the Projection Expression field instead.

Conditional Operator

Enumeration, one of:

  • AND

  • OR

A logical operator to apply to the conditions.

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

Exclusive Start Key

Object

The primary key of the first item that this operation evaluates.

Filter Expression

String

A string that contains conditions that DynamoDB applies after the operation, but before the data is returned to you. Items that do not satisfy the criteria are not returned.

Index Name

String

The name of a secondary index to scan. This index can be any local secondary index or global secondary index.

Limit

Number

The maximum number of items to evaluate (not necessarily the number of matching items).

Projection Expression

String

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

Condition Filter

Object

The condition that evaluates the query results after the items are read and returns only the desired values.

Return Consumed Capacity

Enumeration, one of:

  • INDEXES

  • TOTAL

  • NONE

The level of detail of the provisioned throughput consumption returned in the response.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of Array of Object payload and Request ID Attribute attributes

### For Configurations - [Default Configuration](#config) #### Throws - DYNAMODB:THROTTLING\_EXCEPTION - DYNAMODB:UNRECOGNIZED\_CLIENT\_EXCEPTION - DYNAMODB:RESOURCE\_IN\_USE\_EXCEPTION - DYNAMODB:ITEM\_COLLECTION\_SIZE\_LIMIT\_EXCEEDED\_EXCEPTION - DYNAMODB:PROVISIONED\_THROUGHPUT\_EXCEEDED\_EXCEPTION - DYNAMODB:INCOMPLETE\_SIGNATURE\_EXCEPTION - DYNAMODB:LIMIT\_EXCEEDED\_EXCEPTION - DYNAMODB:UNKNOWN - DYNAMODB:RESOURCE\_NOT\_FOUND\_EXCEPTION - DYNAMODB:CONDITIONAL\_CHECK\_FAILED\_EXCEPTION - DYNAMODB:VALIDATION\_EXCEPTION - DYNAMODB:MISSING\_AUTHENTICATION\_TOKEN\_EXCEPTION - DYNAMODB:ACCESS\_DENIED\_EXCEPTION ### Put Item `` This operation creates a new item, or replaces 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](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html) for this operation. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Put Item Result

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` 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). For information, see the [Amazon DynamoDB API Reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Query.html) for this operation. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

One or more substitution tokens for attribute names in an expression.

Attribute Values

Object

One or more values to substitute in an expression.

Table Name

String

Name of the table containing the requested item.

x

Attributes To Gets

Array of String

This is a legacy parameter. Use the Projection Expression field instead.

Conditional Operator

Enumeration, one of:

  • AND

  • OR

A logical operator to apply to the conditions.

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

Exclusive Start Key

Object

The primary key of the first item that this operation evaluates.

Filter Expression

String

A string that contains conditions that DynamoDB applies after the operation, but before the data is returned to you. Items that do not satisfy the criteria are not returned.

Index Name

String

The name of a secondary index to scan. This index can be any local secondary index or global secondary index.

Limit

Number

The maximum number of items to evaluate (not necessarily the number of matching items).

Projection Expression

String

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

Condition Filter

Object

The condition that evaluates the query results after the items are read and returns only the desired values.

Return Consumed Capacity

Enumeration, one of:

  • INDEXES

  • TOTAL

  • NONE

The level of detail of the provisioned throughput consumption returned in the response.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Query Result

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` The Scan operation returns one or more items and item attributes by accessing every item in a table or secondary index. To have DynamoDB return fewer items, you can provide a Filter Expression operation. For information, see the [Amazon DynamoDB API Reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Scan.html) for this operation. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

One or more substitution tokens for attribute names in an expression.

Attribute Values

Object

One or more values to substitute in an expression.

Table Name

String

Name of the table containing the requested item.

x

Attributes To Gets

Array of String

This is a legacy field. Use the Projection Expression field instead.

Conditional Operator

Enumeration, one of:

  • AND

  • OR

A logical operator to apply to the conditions.

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

Exclusive Start Key

Object

The primary key of the first item that this operation evaluates.

Filter Expression

String

A string that contains conditions that DynamoDB applies after the operation, but before the data is returned to you. Items that do not satisfy the criteria are not returned.

Index Name

String

The name of a secondary index to scan. This index can be any local secondary index or global secondary index.

Limit

Number

The maximum number of items to evaluate (not necessarily the number of matching items).

Projection Expression

String

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

Condition Filter

Object

The condition that evaluates the query results after the items are read and returns only the desired values.

Return Consumed Capacity

Enumeration, one of:

  • INDEXES

  • TOTAL

  • NONE

The level of detail of the provisioned throughput consumption returned in the response..

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Scan Result

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` This operation edits an existing item’s attributes, or adds a new item to the table if it does not already exist. For information, see the [Amazon DynamoDB API Reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateItem.html) for this operation. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Update Item Result

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` This operation modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table. For information, see the [Amazon DynamoDB API Reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateTable.html) for this operation. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Table Description

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 `` #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Stream ARN

String

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Stream Description

Attributes Type

### For Configurations - [Streams Configuration](#streams-config) #### 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 `` #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Shard Iterator

String

x

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[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 - [Streams Configuration](#streams-config) #### 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 `` #### Parameters
NameTypeDescriptionDefault ValueRequired

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 to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

### For Configurations - [Streams Configuration](#streams-config) #### 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 `` #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Table Name

String

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[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 - [Streams Configuration](#streams-config) #### 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 ### TLS
FieldTypeDescriptionDefault ValueRequired

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma separated list of cipher suites enabled for this context.

Trust Store

Key Store

Revocation Check

### Trust Store
FieldTypeDescriptionDefault ValueRequired

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

### Key Store
FieldTypeDescriptionDefault ValueRequired

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.

Type

String

The type of store used.

Alias

String

When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the key store.

Algorithm

String

The algorithm used by the key store.

### Standard Revocation Check
FieldTypeDescriptionDefault ValueRequired

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

### Custom OCSP Responder
FieldTypeDescriptionDefault ValueRequired

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

### CRL File
FieldTypeDescriptionDefault ValueRequired

Path

String

The path to the CRL file.

### Reconnection
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

Consumed Capacity

Item Collection Metrics

Object

Unprocessed Items

Object

### Consumed Capacity
FieldTypeDescriptionDefault ValueRequired

Capacity Units

Number

Global Secondary Indexes

Object

Local Secondary Indexes

Object

Table

Number

Table Name

String

### Request ID Attribute
FieldTypeDescriptionDefault ValueRequired

Request Id

String

### Batch Get Item Result
FieldTypeDescriptionDefault ValueRequired

Consumed Capacity

Responses

Object

Unprocessed Keys

Object

### Table Description
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

Attribute Name

String

Attribute Type

Enumeration, one of:

  • STRING

  • NUMBER

  • BINARY

### Global Secondary Index Description
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

Attribute Name

String

Key Type

Enumeration, one of:

  • HASH

  • RANGE

### Projection
FieldTypeDescriptionDefault ValueRequired

Non Key Attributes

Array of String

Projection Type

Enumeration, one of:

  • ALL

  • KEYS_ONLY

  • INCLUDE

### Provisioned Throughput Description
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

Index Arn

String

Index Name

String

Index Size Bytes

Number

Item Count

Number

Key Schema

Projection

### Stream Specification
FieldTypeDescriptionDefault ValueRequired

Stream Enabled

Boolean

Stream View Type

Enumeration, one of:

  • NEW_IMAGE

  • OLD_IMAGE

  • NEW_AND_OLD_IMAGES

  • KEYS_ONLY

### Global Secondary Index
FieldTypeDescriptionDefault ValueRequired

Index Name

String

Key Schema

Projection

Provisioned Throughput

### Provisioned Throughput
FieldTypeDescriptionDefault ValueRequired

Read Capacity Units

Number

Write Capacity Units

Number

### Local Secondary Index
FieldTypeDescriptionDefault ValueRequired

Index Name

String

Key Schema

Projection

### Delete Item Result
FieldTypeDescriptionDefault ValueRequired

Attributes

Object

Consumed Capacity

Item Collection Metrics

### Item Collection Metrics
FieldTypeDescriptionDefault ValueRequired

Item Collection Key

Object

Size Estimate Range GB

Array of Number

### Get Item Result
FieldTypeDescriptionDefault ValueRequired

Consumed Capacity

Item

Object

### List Tables Result
FieldTypeDescriptionDefault ValueRequired

Last Evaluated Table Name

String

Table Names

Array of String

### Put Item Result
FieldTypeDescriptionDefault ValueRequired

Attributes

Object

Consumed Capacity

Item Collection Metrics

### Query Result
FieldTypeDescriptionDefault ValueRequired

Consumed Capacity

Count

Number

Items

Array of Object

Last Evaluated Key

Object

Scanned Count

Number

### Scan Result
FieldTypeDescriptionDefault ValueRequired

Consumed Capacity

Count

Number

Items

Array of Object

Last Evaluated Key

Object

Scanned Count

Number

### Update Item Result
FieldTypeDescriptionDefault ValueRequired

Attributes

Object

Consumed Capacity

Item Collection Metrics

### Global Secondary Index Update
FieldTypeDescriptionDefault ValueRequired

Create

Delete

String

Update

### Create Global Secondary Index Action
FieldTypeDescriptionDefault ValueRequired

Index Name

String

Key Schema

Projection

Provisioned Throughput

### Update Global Secondary Index Action
FieldTypeDescriptionDefault ValueRequired

Index Name

String

Provisioned Throughput

### Stream Description
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

Parent Shard Id

String

Sequence Number Range

Shard Id

String

### Sequence Number Range
FieldTypeDescriptionDefault ValueRequired

Ending Sequence Number

String

Starting Sequence Number

String

### Record
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

Principal Id

String

Type

String

### Repeatable In Memory Iterable
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

Max In Memory Size

Number

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

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

### Stream
FieldTypeDescriptionDefault ValueRequired

Stream Arn

String

Stream Label

String

Table Name

String

## See Also [Salesforce Help](https://help.salesforce.com) --- product: Amazon DynamoDB Connector version: 1.6 is-latest-version: true --- # Amazon DynamoDB Connector 1.6 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Release Notes: [Amazon DynamoDB Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/amazon-dynamodb-connector-release-notes-mule-4) ## Configurations --- ### Default Configuration #### Parameters
NameTypeDescriptionDefault ValueRequired

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 Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

#### Connection Types ##### Basic ###### Parameters
NameTypeDescriptionDefault ValueRequired

Session Token

String

The session token provided by Amazon STS.

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 infinity and is not recommended.

50

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Max Connections

Number

Sets the maximum number of allowed open HTTP connections.

50

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 infinity and is not recommended.

50

Socket Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Socket Timeout field.

SECONDS

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

Custom Service Endpoint

String

Sets a custom service endpoint. Useful when a non-standard service endpoint is required, such as a VPC endpoint. For local connections, set this field to http://localhost:8000/.

Region Endpoint

String

Set the topic region endpoint.

US_EAST_1

TLS Configuration

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
NameTypeDescriptionDefault ValueRequired

Role ARN

String

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

x

Custom STS Endpoint

String

Sets a custom service endpoint. Useful when a non-standard service endpoint is required, such as a VPC endpoint. The custom STS endpoint might not work if DefaultAWSCredentialsProviderChain is used. Instead, use AWS environment variables such as AWS_STS_REGIONAL_ENDPOINTS, AWS_REGION, and AWS_ENDPOINT_URL.

External ID

String

A unique identifier used when assuming an IAM role in an external account. Provide the value specified by the administrator of the target account for added security.

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 infinity and is not recommended.

50

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Max Connections

Number

Sets the maximum number of allowed open HTTP connections.

50

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 infinity and is not recommended.

50

Socket Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Socket Timeout field.

SECONDS

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

Custom Service Endpoint

String

Sets a custom service endpoint. Useful when a non-standard service endpoint is required, such as a VPC endpoint. For local connections, set this field to http://localhost:8000/.

Region Endpoint

String

Set the topic region endpoint.

US_EAST_1

TLS Configuration

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.

### Streams Configuration #### Parameters
NameTypeDescriptionDefault ValueRequired

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 Mule considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

#### Connection Types ##### Streams ###### Supported Operations - [Describe Stream](#describeStream) - [Get Records](#getRecords) - [Get Shard Iterator](#getShardIterator) - [List Streams](#listStreams) ###### Parameters
NameTypeDescriptionDefault ValueRequired

Session Token

String

The session token provided by Amazon STS.

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 infinity and is not recommended.

50

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Max Connections

Number

Sets the maximum number of allowed open HTTP connections.

50

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 infinity and is not recommended.

50

Socket Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Socket Timeout field.

SECONDS

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

Custom Service Endpoint

String

Sets a custom service endpoint. Useful when a non-standard service endpoint is required, such as a VPC endpoint. For local connections, set this field to http://localhost:8000/.

Region Endpoint

String

Set the topic region endpoint.

US_EAST_1

TLS Configuration

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](#batchDeleteItem) - [Batch Get Item](#batchGetItem) - [Batch Put Item](#batchPutItem) - [Create Table](#createTable) - [Delete Item](#deleteItem) - [Delete Table](#deleteTable) - [Describe Table](#describeTable) - [Get Item](#getItem) - [List Tables](#listTables) - [Paginated Query](#paginatedQuery) - [Put Item](#putItem) - [Query](#query) - [Scan](#scan) - [Update Item](#updateItem) - [Update Table](#updateTable) ### Batch Delete Item `` The Batch Delete Item operation deletes multiple items in one or more tables. For information, see the [Amazon DynamoDB API Reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BatchWriteItem.html) for this operation. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Batch Write Item Result

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 - DYNAMODB:AUTHORIZATION\_NOT\_FOUND ### Batch Get Item `` The Batch Get Item operation returns 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](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BatchGetItem.html) for this operation. #### Parameters
NameTypeDescriptionDefault ValueRequired

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 to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Batch Get Item Result

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 - DYNAMODB:AUTHORIZATION\_NOT\_FOUND ### Batch Put Item `` The Batch Put Item operation puts multiple items in one or more tables. For information, see the [Amazon DynamoDB API Reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BatchWriteItem.html) for this operation. #### Parameters
NameTypeDescriptionDefault ValueRequired

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 to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Batch Write Item Result

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 - DYNAMODB:AUTHORIZATION\_NOT\_FOUND ### Create Table `` The Create Table operation adds 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](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_CreateTable.html) for this operation. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

Specifies the information that a database stream captures and writes when you modify an item in the table.

Stream Enabled

Boolean

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

false

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Table Description

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 - DYNAMODB:AUTHORIZATION\_NOT\_FOUND ### Delete Item `` This operation deletes a single item in a table by primary key. For information, see the [Amazon DynamoDB API Reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DeleteItem.html) for this operation. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Delete Item Result

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 - DYNAMODB:AUTHORIZATION\_NOT\_FOUND ### Delete Table `` The Delete Table operation deletes a table and all of its items. For information, see the [Amazon DynamoDB API Reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DeleteTable.html) for this operation. #### Parameters
NameTypeDescriptionDefault ValueRequired

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 to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Table Description

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 - DYNAMODB:AUTHORIZATION\_NOT\_FOUND ### Describe Table `` This operation 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. For information, see the [Amazon DynamoDB API Reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeTable.html) for this operation. #### Parameters
NameTypeDescriptionDefault ValueRequired

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 to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Table Description

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 - DYNAMODB:AUTHORIZATION\_NOT\_FOUND ### Get Item `` The Get Item operation returns a set of attributes for the item with the given primary key. For information, see the [Amazon DynamoDB API Reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html) for this operation. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Get Item Result

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 - DYNAMODB:AUTHORIZATION\_NOT\_FOUND ### List Tables `` This operation returns an array of table names associated with the current account and endpoint. For information, see the [Amazon DynamoDB API Reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ListTables.html) for this operation. #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Exclusive Start Table Name

String

The first table name that this operation will 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

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

List Tables Result

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 - DYNAMODB:AUTHORIZATION\_NOT\_FOUND ### Paginated Query `` The **Paginated 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. The operation returns pages with a limit specified in the **Limit** field or the maximum amount of 1MB data. This behavior differentiates from the existing **Query** operation that truncates the response ignoring the DynamoDB value of the **Last Evaluated Key** field, which indicates that the query has more matching items. #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Key Condition Expression

String

The condition that specifies the key values for items to retrieve by the Query operation.

Key Conditions

Object

This is a legacy parameter. Use Key Condition Expression 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 return in the result.

Streaming Strategy

Configure to use repeatable streams.

Attribute Names

Object

One or more substitution tokens for attribute names in an expression.

Attribute Values

Object

One or more values to substitute in an expression.

Table Name

String

Name of the table containing the requested item.

x

Attributes To Gets

Array of String

This is a legacy parameter. Use the Projection Expression field instead.

Conditional Operator

Enumeration, one of:

  • AND

  • OR

A logical operator to apply to the conditions.

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

Exclusive Start Key

Object

The primary key of the first item that this operation evaluates.

Filter Expression

String

A string that contains conditions that DynamoDB applies after the operation, but before the data is returned to you. Items that do not satisfy the criteria are not returned.

Index Name

String

The name of a secondary index to scan. This index can be any local secondary index or global secondary index.

Limit

Number

The maximum number of items to evaluate (not necessarily the number of matching items).

Projection Expression

String

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

Condition Filter

Object

The condition that evaluates the query results after the items are read and returns only the desired values.

Return Consumed Capacity

Enumeration, one of:

  • INDEXES

  • TOTAL

  • NONE

The level of detail of the provisioned throughput consumption returned in the response.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Array of Message of Array of Object payload and Request ID Attribute attributes

### For Configurations - [Default Configuration](#config) #### Throws - DYNAMODB:THROTTLING\_EXCEPTION - DYNAMODB:UNRECOGNIZED\_CLIENT\_EXCEPTION - DYNAMODB:RESOURCE\_IN\_USE\_EXCEPTION - DYNAMODB:ITEM\_COLLECTION\_SIZE\_LIMIT\_EXCEEDED\_EXCEPTION - DYNAMODB:PROVISIONED\_THROUGHPUT\_EXCEEDED\_EXCEPTION - DYNAMODB:INCOMPLETE\_SIGNATURE\_EXCEPTION - DYNAMODB:LIMIT\_EXCEEDED\_EXCEPTION - DYNAMODB:UNKNOWN - DYNAMODB:RESOURCE\_NOT\_FOUND\_EXCEPTION - DYNAMODB:CONDITIONAL\_CHECK\_FAILED\_EXCEPTION - DYNAMODB:VALIDATION\_EXCEPTION - DYNAMODB:MISSING\_AUTHENTICATION\_TOKEN\_EXCEPTION - DYNAMODB:ACCESS\_DENIED\_EXCEPTION - DYNAMODB:AUTHORIZATION\_NOT\_FOUND - DYNAMODB:CONNECTIVITY ### Put Item `` This operation creates a new item, or replaces 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](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_PutItem.html) for this operation. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Put Item Result

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 - DYNAMODB:AUTHORIZATION\_NOT\_FOUND ### 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). For information, see the [Amazon DynamoDB API Reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Query.html) for this operation. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

One or more substitution tokens for attribute names in an expression.

Attribute Values

Object

One or more values to substitute in an expression.

Table Name

String

Name of the table containing the requested item.

x

Attributes To Gets

Array of String

This is a legacy parameter. Use the Projection Expression field instead.

Conditional Operator

Enumeration, one of:

  • AND

  • OR

A logical operator to apply to the conditions.

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

Exclusive Start Key

Object

The primary key of the first item that this operation evaluates.

Filter Expression

String

A string that contains conditions that DynamoDB applies after the operation, but before the data is returned to you. Items that do not satisfy the criteria are not returned.

Index Name

String

The name of a secondary index to scan. This index can be any local secondary index or global secondary index.

Limit

Number

The maximum number of items to evaluate (not necessarily the number of matching items).

Projection Expression

String

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

Condition Filter

Object

The condition that evaluates the query results after the items are read and returns only the desired values.

Return Consumed Capacity

Enumeration, one of:

  • INDEXES

  • TOTAL

  • NONE

The level of detail of the provisioned throughput consumption returned in the response.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Query Result

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 - DYNAMODB:AUTHORIZATION\_NOT\_FOUND ### Scan `` The Scan operation returns one or more items and item attributes by accessing every item in a table or secondary index. To have DynamoDB return fewer items, you can provide a Filter Expression operation. For information, see the [Amazon DynamoDB API Reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Scan.html) for this operation. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

One or more substitution tokens for attribute names in an expression.

Attribute Values

Object

One or more values to substitute in an expression.

Table Name

String

Name of the table containing the requested item.

x

Attributes To Gets

Array of String

This is a legacy field. Use the Projection Expression field instead.

Conditional Operator

Enumeration, one of:

  • AND

  • OR

A logical operator to apply to the conditions.

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

Exclusive Start Key

Object

The primary key of the first item that this operation evaluates.

Filter Expression

String

A string that contains conditions that DynamoDB applies after the operation, but before the data is returned to you. Items that do not satisfy the criteria are not returned.

Index Name

String

The name of a secondary index to scan. This index can be any local secondary index or global secondary index.

Limit

Number

The maximum number of items to evaluate (not necessarily the number of matching items).

Projection Expression

String

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

Condition Filter

Object

The condition that evaluates the query results after the items are read and returns only the desired values.

Return Consumed Capacity

Enumeration, one of:

  • INDEXES

  • TOTAL

  • NONE

The level of detail of the provisioned throughput consumption returned in the response..

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Scan Result

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 - DYNAMODB:AUTHORIZATION\_NOT\_FOUND ### Update Item `` This operation edits an existing item’s attributes, or adds a new item to the table if it does not already exist. For information, see the [Amazon DynamoDB API Reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateItem.html) for this operation. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

A logical operator to apply to the conditions.

Condition Expression

String

Attribute Names

Object

One or more substitution tokens for attribute names in an expression.

Attribute Values

Object

One or more values to substitute in an expression.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Update Item Result

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 - DYNAMODB:AUTHORIZATION\_NOT\_FOUND ### Update Table `` This operation modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table. For information, see the [Amazon DynamoDB API Reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateTable.html) for this operation. #### Parameters
NameTypeDescriptionDefault ValueRequired

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

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Table Description

Attributes Type

### For Configurations - [Default Configuration](#config) #### 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 - DYNAMODB:AUTHORIZATION\_NOT\_FOUND ### Describe Stream `` #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Stream ARN

String

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

Stream Description

Attributes Type

### For Configurations - [Streams Configuration](#streams-config) #### 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 - DYNAMODB:AUTHORIZATION\_NOT\_FOUND ### Get Records `` #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Shard Iterator

String

A shard iterator that was retrieved from a previous Get Shard Iterator operation.

x

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[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 - [Streams Configuration](#streams-config) #### 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 - DYNAMODB:AUTHORIZATION\_NOT\_FOUND - DYNAMODB:CONNECTIVITY ### Get Shard Iterator `` #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Shard Id

String

x

Shard Iterator Type

String

Specifies how to use the shard iterator.

x

Starting Sequence Number

String

Stream ARN

String

x

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

#### Output

Type

String

Attributes Type

### For Configurations - [Streams Configuration](#streams-config) #### 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 - DYNAMODB:AUTHORIZATION\_NOT\_FOUND ### List Streams `` #### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

The name of the configuration to use.

x

Table Name

String

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[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 - [Streams Configuration](#streams-config) #### 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 - DYNAMODB:AUTHORIZATION\_NOT\_FOUND - DYNAMODB:CONNECTIVITY ## Types ### TLS
FieldTypeDescriptionDefault ValueRequired

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma separated list of cipher suites enabled for this context.

Trust Store

Key Store

Revocation Check

### Trust Store
FieldTypeDescriptionDefault ValueRequired

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

### Key Store
FieldTypeDescriptionDefault ValueRequired

Path

String

The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.

Type

String

The type of store used.

Alias

String

When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the key store.

Algorithm

String

The algorithm used by the key store.

### Standard Revocation Check
FieldTypeDescriptionDefault ValueRequired

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not be reached or is busy.

### Custom OCSP Responder
FieldTypeDescriptionDefault ValueRequired

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

### CRL File
FieldTypeDescriptionDefault ValueRequired

Path

String

The path to the CRL file.

### Reconnection
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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 Max Idle Time attribute.

### Batch Write Item Result
FieldTypeDescriptionDefault ValueRequired

Consumed Capacity

Item Collection Metrics

Object

Unprocessed Items

Object

### Consumed Capacity
FieldTypeDescriptionDefault ValueRequired

Capacity Units

Number

Global Secondary Indexes

Object

Local Secondary Indexes

Object

Table

Number

Table Name

String

### Request ID Attribute
FieldTypeDescriptionDefault ValueRequired

Request Id

String

### Batch Get Item Result
FieldTypeDescriptionDefault ValueRequired

Consumed Capacity

Responses

Object

Unprocessed Keys

Object

### Table Description
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

Attribute Name

String

Attribute Type

Enumeration, one of:

  • STRING

  • NUMBER

  • BINARY

### Global Secondary Index Description
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

Attribute Name

String

Key Type

Enumeration, one of:

  • HASH

  • RANGE

### Projection
FieldTypeDescriptionDefault ValueRequired

Non Key Attributes

Array of String

Projection Type

Enumeration, one of:

  • ALL

  • KEYS_ONLY

  • INCLUDE

### Provisioned Throughput Description
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

Index Arn

String

Index Name

String

Index Size Bytes

Number

Item Count

Number

Key Schema

Projection

### Stream Specification
FieldTypeDescriptionDefault ValueRequired

Stream Enabled

Boolean

Stream View Type

Enumeration, one of:

  • NEW_IMAGE

  • OLD_IMAGE

  • NEW_AND_OLD_IMAGES

  • KEYS_ONLY

### Global Secondary Index
FieldTypeDescriptionDefault ValueRequired

Index Name

String

Key Schema

Projection

Provisioned Throughput

### Provisioned Throughput
FieldTypeDescriptionDefault ValueRequired

Read Capacity Units

Number

Write Capacity Units

Number

### Local Secondary Index
FieldTypeDescriptionDefault ValueRequired

Index Name

String

Key Schema

Projection

### Delete Item Result
FieldTypeDescriptionDefault ValueRequired

Attributes

Object

Consumed Capacity

Item Collection Metrics

### Item Collection Metrics
FieldTypeDescriptionDefault ValueRequired

Item Collection Key

Object

Size Estimate Range GB

Array of Number

### Get Item Result
FieldTypeDescriptionDefault ValueRequired

Consumed Capacity

Item

Object

### List Tables Result
FieldTypeDescriptionDefault ValueRequired

Last Evaluated Table Name

String

Table Names

Array of String

### Put Item Result
FieldTypeDescriptionDefault ValueRequired

Attributes

Object

Consumed Capacity

Item Collection Metrics

### Query Result
FieldTypeDescriptionDefault ValueRequired

Consumed Capacity

Count

Number

Items

Array of Object

Last Evaluated Key

Object

Scanned Count

Number

### Scan Result
FieldTypeDescriptionDefault ValueRequired

Consumed Capacity

Count

Number

Items

Array of Object

Last Evaluated Key

Object

Scanned Count

Number

### Update Item Result
FieldTypeDescriptionDefault ValueRequired

Attributes

Object

Consumed Capacity

Item Collection Metrics

### Global Secondary Index Update
FieldTypeDescriptionDefault ValueRequired

Create

Delete

String

Update

### Create Global Secondary Index Action
FieldTypeDescriptionDefault ValueRequired

Index Name

String

Key Schema

Projection

Provisioned Throughput

### Update Global Secondary Index Action
FieldTypeDescriptionDefault ValueRequired

Index Name

String

Provisioned Throughput

### Stream Description
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

Parent Shard Id

String

Sequence Number Range

Shard Id

String

### Sequence Number Range
FieldTypeDescriptionDefault ValueRequired

Ending Sequence Number

String

Starting Sequence Number

String

### Record
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

Principal Id

String

Type

String

### Repeatable In Memory Iterable
FieldTypeDescriptionDefault ValueRequired

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
FieldTypeDescriptionDefault ValueRequired

Max In Memory Size

Number

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

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

### Stream
FieldTypeDescriptionDefault ValueRequired

Stream Arn

String

Stream Label

String

Table Name

String

## See Also [Salesforce Help](https://help.salesforce.com) --- product: Amazon DynamoDB Connector version: 1.5 --- # Amazon DynamoDB Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The following are common use cases for Amazon DynamoDB Connector: - Creating an Amazon DynamoDB table - Deleting an Amazon DynamoDB table - Performing an Amazon DynamoDB table scan ## Create an Amazon DynamoDB Table This example shows how to use Amazon DynamoDB connector to create an Amazon DynamoDB table. ### Flow for Creating an Amazon DynamoDB Table The following screenshot shows an Anypoint Studio flow for creating an Amazon DynamoDB table: ![Studio flow for creating an Amazon DynamoDB table](/mulesoft/current/en-us/amazon-dynamodb-connector/1.5/_images/amazon-dynamodb-create-table-flow.png) Figure 1. Use this sample flow to create an Amazon DynamoDB table. ### Preliminary Steps Follow these steps to start creating an Amazon DynamoDB table: 1. Create a new Mule project in Studio. 2. Add the following properties to the `mule-artifact.properties` file to store your Amazon DynamoDB credentials: ```text config.accesskey= config.secretkey= ``` 3. Place the `mule-artifact.properties` file in the project’s `src/main/resources` directory. ### Configure HTTP Listener Configure `HTTP Listener` to listen for HTTP requests on the `/createtable` path: 1. In the **Mule Palette** view, search for `http` and select the **Listener** operation. 2. Drag the **Listener** operation onto the Studio canvas. 3. On the **Listener** tab, click the plus sign (+) next to the **Connector configuration** field to access the global element configuration fields for `HTTP Listener`. 4. In the **Host** field, select `localhost`: ![HTTP Listener global element](/mulesoft/current/en-us/amazon-dynamodb-connector/1.5/_images/amazon-dynamodb-http-global-element.png) Figure 2. Select `localhost` in the **Host** field to listen for HTTP requests on your local computer. 5. Click **OK**. 6. In the **Path** field on the **Listener** tab, enter `/createtable`: ![HTTP Listener tab](/mulesoft/current/en-us/amazon-dynamodb-connector/1.5/_images/amazon-dynamodb-http-prop.png) Figure 3. Enter `/createtable` in the **Path** field to listen for HTTP requests on the `/createtable` path. ### Configure the Create Table Operation Configure the `Create Table` operation to create a table named `Issues`: 1. In the **Mule Palette** view, click **Search in Exchange** and search for `amazon dynamodb`. 2. Select **Amazon DynamoDB Connector**, click **Add>**, and then click **Finish**. 3. Drag the **Create Table** operation to the right of **Listener** on the Studio canvas. 4. Click the **Global Elements** link below the flow. 5. Add the properties file you created earlier to the **Configuration properties** field, as described in [Use Property Placeholders for Property Values](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview#property-placeholders). 6. Click **Create**. 7. Expand **Connector Configuration**. 8. Select **Amazon DynamoDB Configuration** and click **OK**. 9. Complete the following fields:
ParameterDescriptionValue

Name

Configuration name

create-table-flow

Access Key

Alphanumeric text string that uniquely identifies the user who owns the account

${config.accesskey}

Secret Key

Key that acts as a password

${config.secretkey}

Region Endpoint

Region for the Amazon DynamoDB client

us-east-1

The following screenshot shows an example of configuring a global element for Amazon DynamoDB Connector: ![Amazon DynamoDB global element](/mulesoft/current/en-us/amazon-dynamodb-connector/1.5/_images/amazon-dynamodb-global-element.png) Figure 4. Configure the credentials needed to access Amazon DynamoDB in the **Connection** section of the global element. 10. Click **Test Connection** to confirm that Mule can connect with the Amazon DynamoDB instance: - If the connection is successful, click **OK** to save the configuration. - If the connection is unsuccessful, review or correct any incorrect parameters, and then test again. 11. Click **OK**. 12. On the **Create table** tab, configure the following fields:
FieldDescriptionUser Action

Table name

The name of the table

Enter Issues.

Attribute definitions

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

Select Edit inline, click the green plus sign (+), and add the following attributes:

  • IssueId as type STRING

  • Title as type STRING

  • CreateDate as type STRING

  • DueDate as type STRING

Key schemas

The attributes that make up the primary key for the table or one of its indexes

Select Edit inline, click the green plus sign (+), add the following attributes:

  • IssueId as key type HASH

  • Title as key type RANGE

Read capacity units

The maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a throttling exception

Enter 5.

Write capacity units

The maximum number of writes consumed per second before Amazon DynamoDB returns a throttling exception

Enter 5.

Global secondary indexes

An optional, additional key structure for the table

Enter #[vars.secondary] to create a variable for the secondary index, and then add the secondary index to the XML code, as described in Add a Secondary Index to the Issues Table.

The following screenshot shows an example of configuring the `Create table` operation: ![Create table operation fields](/mulesoft/current/en-us/amazon-dynamodb-connector/1.5/_images/amazon-dynamodb-create-table-props.png) Figure 5. Enter values for the `Create table` operation fields. In this screenshot: - The first item specifies the name of the component that represents the `Create table` operation in the flow. - The second item specifies the name of the table to create. - The third item defines the attributes of the new table. - The fourth item defines the key schemas of the new table. - The fifth item specifies the maximum number of strongly consistent reads consumed per second and strongly consistent writes consumed per second before Amazon DynamoDB returns a throttling exception. - The sixth item specifies a variable for the secondary index. The XML flow for the create table example looks like this after you configure the `HTTP Listener` and `Create table` operations: ```xml ``` ### Add a Secondary Index to the Issues Table To add a global secondary index to the `Issues` table, add a variable before the `` element in the XML. The following example adds three secondary indexes to the `Issues` table: - `CreateDateIndex`, with the `CreateDate` partition key and the `IssueId` sort key - `TitleIndex` with the `Title` partition key and the `IssueId` sort key - `DueDateIndex` with the `DueDate` partition key You must include these elements in the XML: - ``, which specifies the attributes to copy from the table into the index. In this example, the value `ALL` means that all attributes are copied. The primary key attributes and index key attributes are automatically copied, no matter what value you set for the `` element. - `ProvisionedThroughput` provisions throughput for read and write activity. - `KeySchema` specifies the key schema for the index. ```xml ``` ### Configure a Logger Component Configure a `Logger` component to print to the Mule console the response generated by the `Create Table` operation: 1. In the **Mule Palette** view, search for `logger`. 2. Drag the **Logger** component to the right of **Create Table** on the Studio canvas. 3. Enter `#[payload]` in the **Message** field on the **Logger** tab. ![Logger tab](/mulesoft/current/en-us/amazon-dynamodb-connector/1.5/_images/amazon-dynamodb-logger-props.png) Figure 6. Enter `#[payload]` in the **Message** field to print the operation’s response to the Mule console. ### XML for the Complete Create Table Example The XML for the complete create table example looks like this: ```xml ``` ### Run the Project Save and run the project as a Mule app: 1. In **Package Explorer**, right-click the project name and click **Run As** > **Mule Application**. 2. Open a browser and check the response after you enter the `http://localhost:8081/createtable` URL. You see the generated response from the `Create table` operation in the Mule console. ## Delete an Amazon DynamoDB Table This example shows how to use Amazon DynamoDB connector to delete an Amazon DynamoDB table. ### Flow for Deleting a DynamoDB Table The following screenshot shows an Anypoint Studio flow for deleting an Amazon DynamoDB table: ![Studio flow for deleting an Amazon DynamoDB table](/mulesoft/current/en-us/amazon-dynamodb-connector/1.5/_images/amazon-dynamodb-delete-table-flow.png) Figure 7. Use this sample flow to delete an Amazon DynamoDB table. ### Preliminary Steps Follow these steps to start deleting an Amazon DynamoDB table: 1. Create a new Mule project in Studio. 2. Add the following properties to the `mule-artifact.properties` file to hold your Amazon DynamoDB credentials: ```text config.accesskey= config.secretkey= ``` 3. Place the `mule-artifact.properties` file in the project’s `src/main/resources` directory. ### Configure HTTP Listener Configure `HTTP Listener` to listen for HTTP requests on the `/deletetable` path: 1. In the **Mule Palette** view, search for `http` and select the **Listener** operation. 2. Drag the **Listener** operation onto the Studio canvas. 3. On the **Listener** tab, click the plus sign (+) next to the **Connector configuration** field to access the global element configuration fields for `HTTP Listener`. 4. In the **Host** field, select `localhost` and click **OK**. 5. In the **Path** field on the **Listener** tab, enter `/deletetable`. ### Configure the Delete Table Operation Configure the `Delete table` operation to delete the `Issues` table. 1. In the **Mule Palette** view, click **Search in Exchange** and search for `amazon dynamodb`. 2. Select **Amazon DynamoDB Connector**, click **Add>**, and then click **Finish**. 3. Drag the **Delete Table** operation to the right of **Listener** on the Studio canvas. 4. Click the **Global Elements** link below the flow. 5. Add the properties file you created earlier to the **Configuration properties** field, as described in [Use Property Placeholders for Property Values](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview#property-placeholders). 6. Click **Create**. 7. Expand **Connector Configuration**. 8. Select **Amazon DynamoDB Configuration** and click **OK**. 9. Complete the following fields:
ParameterDescriptionValue

Name

Configuration name

delete-table-flow

Access Key

Alphanumeric text string that uniquely identifies the user who owns the account

${config.accesskey}

Secret Key

Key that acts as a password

${config.secretkey}

Region Endpoint

Region for the Amazon DynamoDB client

us-east-1

The corresponding XML configuration looks like this: ```xml ``` 10. Click **Test Connection** to confirm that Mule can connect with the Amazon DynamoDB instance: - If the connection is successful, click **OK** to save the configuration. - If the connection is unsuccessful, review or correct any incorrect parameters, and then test again. 11. Click **OK**. 12. On the **Delete table** tab, set the value of `Table name` to `Issues`. ### Configure a Logger Component Configure a `Logger` component to print to the Mule console the response generated by the `Delete table` operation: 1. In the **Mule Palette** view, search for `logger`. 2. Drag the **Logger** component to the right of **Delete Table** on the Studio canvas. 3. On the **Logger** tab, enter `#[payload]` in the **Message** field. ### XML for the Delete Table Example The XML for the delete table example looks like this: ```xml ``` ### Run the Project Save and run the project as a Mule app: 1. In **Package Explorer**, right-click the project name and click **Run As** > **Mule Application**. 2. Open a browser and check the response after you enter the `http://localhost:8081/deletetable` URL. You see the generated response from the `Delete table` operation in the Mule console. ## Scan an Amazon DynamoDB Table This example shows how to use Amazon DynamoDB Connector to scan an Amazon DynamoDB table. The following considerations apply to performing a scan using Amazon DynamoDB Connector: - The DynamoDB AWS SDK paginates results by dividing them into specific pages. A 1-MB limit applies to returned results. When this limit is exceeded, you must perform another scan to receive the rest of the data. - To perform subsequent scans, apply the value of the `LastEvaluatedKey` field in the JSON response to the `Exclusive start keys` field in the Studio configuration of the `Scan` operation. When the operation has returned all pages of data, the `LastEvaluatedKey` value in the JSON response is null. ### Flow for Scanning a Table The following screenshot shows an Anypoint Studio flow for scanning an Amazon DynamoDB table: ![Studio flow for scanning an Amazon DynamoDB table](/mulesoft/current/en-us/amazon-dynamodb-connector/1.5/_images/amazon-dynamodb-scan-flow.png) Figure 8. Use this sample flow to scan an Amazon DynamoDB table. ### Preliminary Steps Follow these steps to start scanning an Amazon DynamoDB table: 1. Create a new Mule project in Studio. 2. Add the following properties to the `mule-artifact.properties` file to hold your Amazon DynamoDB credentials: ```text config.accesskey= config.secretkey= ``` 3. Place the `mule-artifact.properties` file in the project’s `src/main/resources` directory. ### Configure HTTP Listener Configure `HTTP Listener` to listen for HTTP requests on the `/scantable` path: 1. In the **Mule Palette** view, search for `http` and select the **Listener** operation. 2. Drag the **Listener** operation onto the Studio canvas. 3. On the **Listener** tab, click the plus sign (+) next to the **Connector configuration** field to access the global element configuration fields for `HTTP Listener`. 4. In the **Host** field, select `localhost` and click **OK**. 5. In the **Path** field on the **Listener** tab, enter `/scantable`. ### Configure the Scan Operation 1. In the **Mule Palette** view, click **Search in Exchange** and search for `amazon dynamodb`. 2. Select **Amazon DynamoDB Connector**, click **Add>**, and then click **Finish**. 3. Drag the **Scan** operation to the right of **Listener** on the Studio canvas. 4. Click the **Global Elements** link below the flow. 5. Add the properties file you created earlier to the **Configuration properties** field, as described in [Use Property Placeholders for Property Values](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview#property-placeholders). 6. Click **Create**. 7. Expand **Connector Configuration**. 8. Select **Amazon DynamoDB Configuration** and click **OK**. 9. Complete the following fields:
ParameterDescriptionValue

Name

Configuration name

scan-table-flow

Access Key

Alphanumeric text string that uniquely identifies the user who owns the account

${config.accesskey}

Secret Key

Key that acts as a password

${config.secretkey}

Region Endpoint

Region for the Amazon DynamoDB client

us-east-1

10. Click **Test Connection** to confirm that Mule can connect with the Amazon DynamoDB instance: - If the connection is successful, click **OK** to save the configuration. - If the connection is unsuccessful, review or correct any incorrect parameters, and then test again. 11. Click **OK**. 12. On the **Scan** tab, set the value of `Table name` to `Issues`. ### Configure a Transform Message Component Configure a `Transform Message` component to change the `Scan` operation output from Java to JSON: 1. In the **Mule Palette** view, search for `transform`. 2. Drag the **Transform Message** component to the right of **Scan** on the Studio canvas. 3. In the **Output** section of the **Scan** operation, change `output/application/java` to `output/application/json`. ### Configure a Logger Component Configure a `Logger` component to print to the Mule console the response generated by the `Scan` operation: 1. In the **Mule Palette** view, search for `Logger`. 2. Drag the **Logger** component to the right of **Transform** on the Studio canvas. 3. Enter `#[payload]` in the **Message** field on the **Logger** tab. ### XML for the Scan Table Example The XML for the scan table example looks like this: ```text ``` ### Response to the Scan Table Example The response to a `Scan` operation might look like this (with other sections of the response omitted for brevity): ```xml { "scannedCount": 2, "lastEvaluatedKey": null, "count": 2, "consumedCapacity": null, "items": [ { "studentID": { "ss": null, "nullvalue": null, "b": null, "bool": null, "ns": null, "l": null, "m": null, "n": null, "bs": null, "s": "102" }, ... ] } ``` ### Run the Project Save and run the project as a Mule app: 1. In **Package Explorer**, right-click the project name and click **Run As** > **Mule Application**. 2. Open a browser and check the response after you enter the `http://localhost:8081/scantable` URL. You see the generated response from the `Scan` operation in the Mule console. ## See Also - [Amazon API documentation](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/Welcome.html) - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon DynamoDB Connector version: 1.6 is-latest-version: true --- # Amazon DynamoDB Examples > For the full documentation index, see: https://docs.mulesoft.com/llms.txt The following are common use cases for Amazon DynamoDB Connector: - Creating an Amazon DynamoDB table - Deleting an Amazon DynamoDB table - Performing an Amazon DynamoDB table scan ## Create an Amazon DynamoDB Table This example shows how to use Amazon DynamoDB connector to create an Amazon DynamoDB table. ### Flow for Creating an Amazon DynamoDB Table The following screenshot shows an Anypoint Studio flow for creating an Amazon DynamoDB table: ![Studio flow for creating an Amazon DynamoDB table](/mulesoft/current/en-us/amazon-dynamodb-connector/latest/_images/amazon-dynamodb-create-table-flow.png) Figure 1. Use this sample flow to create an Amazon DynamoDB table. ### Preliminary Steps Follow these steps to start creating an Amazon DynamoDB table: 1. Create a new Mule project in Studio. 2. Add the following properties to the `mule-artifact.properties` file to store your Amazon DynamoDB credentials: ```text config.accesskey= config.secretkey= ``` 3. Place the `mule-artifact.properties` file in the project’s `src/main/resources` directory. ### Configure HTTP Listener Configure `HTTP Listener` to listen for HTTP requests on the `/createtable` path: 1. In the **Mule Palette** view, search for `http` and select the **Listener** operation. 2. Drag the **Listener** operation onto the Studio canvas. 3. On the **Listener** tab, click the plus sign (+) next to the **Connector configuration** field to access the global element configuration fields for `HTTP Listener`. 4. In the **Host** field, select `localhost`: ![HTTP Listener global element](/mulesoft/current/en-us/amazon-dynamodb-connector/latest/_images/amazon-dynamodb-http-global-element.png) Figure 2. Select `localhost` in the **Host** field to listen for HTTP requests on your local computer. 5. Click **OK**. 6. In the **Path** field on the **Listener** tab, enter `/createtable`: ![HTTP Listener tab](/mulesoft/current/en-us/amazon-dynamodb-connector/latest/_images/amazon-dynamodb-http-prop.png) Figure 3. Enter `/createtable` in the **Path** field to listen for HTTP requests on the `/createtable` path. ### Configure the Create Table Operation Configure the `Create Table` operation to create a table named `Issues`: 1. In the **Mule Palette** view, click **Search in Exchange** and search for `amazon dynamodb`. 2. Select **Amazon DynamoDB Connector**, click **Add>**, and then click **Finish**. 3. Drag the **Create Table** operation to the right of **Listener** on the Studio canvas. 4. Click the **Global Elements** link below the flow. 5. Add the properties file you created earlier to the **Configuration properties** field, as described in [Use Property Placeholders for Property Values](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview#property-placeholders). 6. Click **Create**. 7. Expand **Connector Configuration**. 8. Select **Amazon DynamoDB Configuration** and click **OK**. 9. Complete the following fields:
ParameterDescriptionValue

Name

Configuration name

create-table-flow

Access Key

Alphanumeric text string that uniquely identifies the user who owns the account

${config.accesskey}

Secret Key

Key that acts as a password

${config.secretkey}

Region Endpoint

Region for the Amazon DynamoDB client

us-east-1

The following screenshot shows an example of configuring a global element for Amazon DynamoDB Connector: ![Amazon DynamoDB global element](/mulesoft/current/en-us/amazon-dynamodb-connector/latest/_images/amazon-dynamodb-global-element.png) Figure 4. Configure the credentials needed to access Amazon DynamoDB in the **Connection** section of the global element. 10. Click **Test Connection** to confirm that Mule can connect with the Amazon DynamoDB instance: - If the connection is successful, click **OK** to save the configuration. - If the connection is unsuccessful, review or correct any incorrect parameters, and then test again. 11. Click **OK**. 12. On the **Create table** tab, configure the following fields:
FieldDescriptionUser Action

Table name

The name of the table

Enter Issues.

Attribute definitions

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

Select Edit inline, click the green plus sign (+), and add the following attributes:

  • IssueId as type STRING

  • Title as type STRING

  • CreateDate as type STRING

  • DueDate as type STRING

Key schemas

The attributes that make up the primary key for the table or one of its indexes

Select Edit inline, click the green plus sign (+), add the following attributes:

  • IssueId as key type HASH

  • Title as key type RANGE

Read capacity units

The maximum number of strongly consistent reads consumed per second before Amazon DynamoDB returns a throttling exception

Enter 5.

Write capacity units

The maximum number of writes consumed per second before Amazon DynamoDB returns a throttling exception

Enter 5.

Global secondary indexes

An optional, additional key structure for the table

Enter #[vars.secondary] to create a variable for the secondary index, and then add the secondary index to the XML code, as described in Add a Secondary Index to the Issues Table.

The following screenshot shows an example of configuring the `Create table` operation: ![Create table operation fields](/mulesoft/current/en-us/amazon-dynamodb-connector/latest/_images/amazon-dynamodb-create-table-props.png) Figure 5. Enter values for the `Create table` operation fields. In this screenshot: - The first item specifies the name of the component that represents the `Create table` operation in the flow. - The second item specifies the name of the table to create. - The third item defines the attributes of the new table. - The fourth item defines the key schemas of the new table. - The fifth item specifies the maximum number of strongly consistent reads consumed per second and strongly consistent writes consumed per second before Amazon DynamoDB returns a throttling exception. - The sixth item specifies a variable for the secondary index. The XML flow for the create table example looks like this after you configure the `HTTP Listener` and `Create table` operations: ```xml ``` ### Add a Secondary Index to the Issues Table To add a global secondary index to the `Issues` table, add a variable before the `` element in the XML. The following example adds three secondary indexes to the `Issues` table: - `CreateDateIndex`, with the `CreateDate` partition key and the `IssueId` sort key - `TitleIndex` with the `Title` partition key and the `IssueId` sort key - `DueDateIndex` with the `DueDate` partition key You must include these elements in the XML: - ``, which specifies the attributes to copy from the table into the index. In this example, the value `ALL` means that all attributes are copied. The primary key attributes and index key attributes are automatically copied, no matter what value you set for the `` element. - `ProvisionedThroughput` provisions throughput for read and write activity. - `KeySchema` specifies the key schema for the index. ```xml ``` ### Configure a Logger Component Configure a `Logger` component to print to the Mule console the response generated by the `Create Table` operation: 1. In the **Mule Palette** view, search for `logger`. 2. Drag the **Logger** component to the right of **Create Table** on the Studio canvas. 3. Enter `#[payload]` in the **Message** field on the **Logger** tab. ![Logger tab](/mulesoft/current/en-us/amazon-dynamodb-connector/latest/_images/amazon-dynamodb-logger-props.png) Figure 6. Enter `#[payload]` in the **Message** field to print the operation’s response to the Mule console. ### XML for the Complete Create Table Example The XML for the complete create table example looks like this: ```xml ``` ### Run the Project Save and run the project as a Mule app: 1. In **Package Explorer**, right-click the project name and click **Run As** > **Mule Application**. 2. Open a browser and check the response after you enter the `http://localhost:8081/createtable` URL. You see the generated response from the `Create table` operation in the Mule console. ## Delete an Amazon DynamoDB Table This example shows how to use Amazon DynamoDB connector to delete an Amazon DynamoDB table. ### Flow for Deleting a DynamoDB Table The following screenshot shows an Anypoint Studio flow for deleting an Amazon DynamoDB table: ![Studio flow for deleting an Amazon DynamoDB table](/mulesoft/current/en-us/amazon-dynamodb-connector/latest/_images/amazon-dynamodb-delete-table-flow.png) Figure 7. Use this sample flow to delete an Amazon DynamoDB table. ### Preliminary Steps Follow these steps to start deleting an Amazon DynamoDB table: 1. Create a new Mule project in Studio. 2. Add the following properties to the `mule-artifact.properties` file to hold your Amazon DynamoDB credentials: ```text config.accesskey= config.secretkey= ``` 3. Place the `mule-artifact.properties` file in the project’s `src/main/resources` directory. ### Configure HTTP Listener Configure `HTTP Listener` to listen for HTTP requests on the `/deletetable` path: 1. In the **Mule Palette** view, search for `http` and select the **Listener** operation. 2. Drag the **Listener** operation onto the Studio canvas. 3. On the **Listener** tab, click the plus sign (+) next to the **Connector configuration** field to access the global element configuration fields for `HTTP Listener`. 4. In the **Host** field, select `localhost` and click **OK**. 5. In the **Path** field on the **Listener** tab, enter `/deletetable`. ### Configure the Delete Table Operation Configure the `Delete table` operation to delete the `Issues` table. 1. In the **Mule Palette** view, click **Search in Exchange** and search for `amazon dynamodb`. 2. Select **Amazon DynamoDB Connector**, click **Add>**, and then click **Finish**. 3. Drag the **Delete Table** operation to the right of **Listener** on the Studio canvas. 4. Click the **Global Elements** link below the flow. 5. Add the properties file you created earlier to the **Configuration properties** field, as described in [Use Property Placeholders for Property Values](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview#property-placeholders). 6. Click **Create**. 7. Expand **Connector Configuration**. 8. Select **Amazon DynamoDB Configuration** and click **OK**. 9. Complete the following fields:
ParameterDescriptionValue

Name

Configuration name

delete-table-flow

Access Key

Alphanumeric text string that uniquely identifies the user who owns the account

${config.accesskey}

Secret Key

Key that acts as a password

${config.secretkey}

Region Endpoint

Region for the Amazon DynamoDB client

us-east-1

The corresponding XML configuration looks like this: ```xml ``` 10. Click **Test Connection** to confirm that Mule can connect with the Amazon DynamoDB instance: - If the connection is successful, click **OK** to save the configuration. - If the connection is unsuccessful, review or correct any incorrect parameters, and then test again. 11. Click **OK**. 12. On the **Delete table** tab, set the value of `Table name` to `Issues`. ### Configure a Logger Component Configure a `Logger` component to print to the Mule console the response generated by the `Delete table` operation: 1. In the **Mule Palette** view, search for `logger`. 2. Drag the **Logger** component to the right of **Delete Table** on the Studio canvas. 3. On the **Logger** tab, enter `#[payload]` in the **Message** field. ### XML for the Delete Table Example The XML for the delete table example looks like this: ```xml ``` ### Run the Project Save and run the project as a Mule app: 1. In **Package Explorer**, right-click the project name and click **Run As** > **Mule Application**. 2. Open a browser and check the response after you enter the `http://localhost:8081/deletetable` URL. You see the generated response from the `Delete table` operation in the Mule console. ## Scan an Amazon DynamoDB Table This example shows how to use Amazon DynamoDB Connector to scan an Amazon DynamoDB table. The following considerations apply to performing a scan using Amazon DynamoDB Connector: - The DynamoDB AWS SDK paginates results by dividing them into specific pages. A 1-MB limit applies to returned results. When this limit is exceeded, you must perform another scan to receive the rest of the data. - To perform subsequent scans, apply the value of the `LastEvaluatedKey` field in the JSON response to the `Exclusive start keys` field in the Studio configuration of the `Scan` operation. When the operation has returned all pages of data, the `LastEvaluatedKey` value in the JSON response is null. ### Flow for Scanning a Table The following screenshot shows an Anypoint Studio flow for scanning an Amazon DynamoDB table: ![Studio flow for scanning an Amazon DynamoDB table](/mulesoft/current/en-us/amazon-dynamodb-connector/latest/_images/amazon-dynamodb-scan-flow.png) Figure 8. Use this sample flow to scan an Amazon DynamoDB table. ### Preliminary Steps Follow these steps to start scanning an Amazon DynamoDB table: 1. Create a new Mule project in Studio. 2. Add the following properties to the `mule-artifact.properties` file to hold your Amazon DynamoDB credentials: ```text config.accesskey= config.secretkey= ``` 3. Place the `mule-artifact.properties` file in the project’s `src/main/resources` directory. ### Configure HTTP Listener Configure `HTTP Listener` to listen for HTTP requests on the `/scantable` path: 1. In the **Mule Palette** view, search for `http` and select the **Listener** operation. 2. Drag the **Listener** operation onto the Studio canvas. 3. On the **Listener** tab, click the plus sign (+) next to the **Connector configuration** field to access the global element configuration fields for `HTTP Listener`. 4. In the **Host** field, select `localhost` and click **OK**. 5. In the **Path** field on the **Listener** tab, enter `/scantable`. ### Configure the Scan Operation 1. In the **Mule Palette** view, click **Search in Exchange** and search for `amazon dynamodb`. 2. Select **Amazon DynamoDB Connector**, click **Add>**, and then click **Finish**. 3. Drag the **Scan** operation to the right of **Listener** on the Studio canvas. 4. Click the **Global Elements** link below the flow. 5. Add the properties file you created earlier to the **Configuration properties** field, as described in [Use Property Placeholders for Property Values](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview#property-placeholders). 6. Click **Create**. 7. Expand **Connector Configuration**. 8. Select **Amazon DynamoDB Configuration** and click **OK**. 9. Complete the following fields:
ParameterDescriptionValue

Name

Configuration name

scan-table-flow

Access Key

Alphanumeric text string that uniquely identifies the user who owns the account

${config.accesskey}

Secret Key

Key that acts as a password

${config.secretkey}

Region Endpoint

Region for the Amazon DynamoDB client

us-east-1

10. Click **Test Connection** to confirm that Mule can connect with the Amazon DynamoDB instance: - If the connection is successful, click **OK** to save the configuration. - If the connection is unsuccessful, review or correct any incorrect parameters, and then test again. 11. Click **OK**. 12. On the **Scan** tab, set the value of `Table name` to `Issues`. ### Configure a Transform Message Component Configure a `Transform Message` component to change the `Scan` operation output from Java to JSON: 1. In the **Mule Palette** view, search for `transform`. 2. Drag the **Transform Message** component to the right of **Scan** on the Studio canvas. 3. In the **Output** section of the **Scan** operation, change `output/application/java` to `output/application/json`. ### Configure a Logger Component Configure a `Logger` component to print to the Mule console the response generated by the `Scan` operation: 1. In the **Mule Palette** view, search for `Logger`. 2. Drag the **Logger** component to the right of **Transform** on the Studio canvas. 3. Enter `#[payload]` in the **Message** field on the **Logger** tab. ### XML for the Scan Table Example The XML for the scan table example looks like this: ```text ``` ### Response to the Scan Table Example The response to a `Scan` operation might look like this (with other sections of the response omitted for brevity): ```xml { "scannedCount": 2, "lastEvaluatedKey": null, "count": 2, "consumedCapacity": null, "items": [ { "studentID": { "ss": null, "nullvalue": null, "b": null, "bool": null, "ns": null, "l": null, "m": null, "n": null, "bs": null, "s": "102" }, ... ] } ``` ### Run the Project Save and run the project as a Mule app: 1. In **Package Explorer**, right-click the project name and click **Run As** > **Mule Application**. 2. Open a browser and check the response after you enter the `http://localhost:8081/scantable` URL. You see the generated response from the `Scan` operation in the Mule console. ## See Also - [Amazon API documentation](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/Welcome.html) - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon DynamoDB Connector version: 1.5 --- # Amazon DynamoDB XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Studio XML editor or from a text editor, you can get access to the connector in your app by adding reference statements to both your XML Mule flow and the Apache Maven `pom.xml` file. You can avoid this manual process by using Studio. When you install the connector in Studio, Studio automatically populates the XML code with the connector’s namespace and schema location. It also adds a dependency to the `pom.xml` file. ## Add a Namespace for the Connector Paste the following code inside the `` tag of the header of your configuration XML: ```xml http://www.mulesoft.org/schema/mule/dynamodb http://www.mulesoft.org/schema/mule/dynamodb/current/mule-dynamodb.xsd ``` This example shows how the namespace statements are placed in the `` XML block: ```xml ``` ## Add a POM File Dependency The Apache Maven `pom.xml` file generated by Studio contains dependencies for a Mule app. When you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to this connector: ```xml com.mulesoft.connectors mule-amazon-dynamodb-connector n.n.n mule-plugin ``` Replace `n.n.n` with the version that corresponds to the connector you are using. To obtain the most up-to-date `pom.xml` file information: 1. Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/). 2. In Exchange, click **Login** and supply your Anypoint Platform username and password. 3. In Exchange, search for `amazon dynamodb`. 4. Select the connector. 5. Click **Dependency Snippets** near the upper right of the screen. ## Next Step After creating your namespace and `pom.xml` file, you can try the [Examples](https://docs.mulesoft.com/amazon-dynamodb-connector/1.5/amazon-dynamodb-connector-examples). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon DynamoDB Connector version: 1.6 is-latest-version: true --- # Amazon DynamoDB XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt If you manually code a Mule runtime engine (Mule) app in XML, either from the Anypoint Studio XML editor or from a text editor, you can get access to the connector in your app by adding reference statements to both your XML Mule flow and the Apache Maven `pom.xml` file. You can avoid this manual process by using Studio. When you install the connector in Studio, Studio automatically populates the XML code with the connector’s namespace and schema location. It also adds a dependency to the `pom.xml` file. ## Add a Namespace for the Connector Paste the following code inside the `` tag of the header of your configuration XML: ```xml http://www.mulesoft.org/schema/mule/dynamodb http://www.mulesoft.org/schema/mule/dynamodb/current/mule-dynamodb.xsd ``` This example shows how the namespace statements are placed in the `` XML block: ```xml ``` ## Add a POM File Dependency The Apache Maven `pom.xml` file generated by Studio contains dependencies for a Mule app. When you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to this connector: ```xml com.mulesoft.connectors mule-amazon-dynamodb-connector n.n.n mule-plugin ``` Replace `n.n.n` with the version that corresponds to the connector you are using. To obtain the most up-to-date `pom.xml` file information: 1. Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/). 2. In Exchange, click **Login** and supply your Anypoint Platform username and password. 3. In Exchange, search for `amazon dynamodb`. 4. Select the connector. 5. Click **Dependency Snippets** near the upper right of the screen. ## Next Step After creating your namespace and `pom.xml` file, you can try the [Examples](https://docs.mulesoft.com/amazon-dynamodb-connector/latest/amazon-dynamodb-connector-examples). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon DynamoDB Connector version: 1.5 --- # Using Anypoint Studio to Configure Amazon DynamoDB Connector > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. To add and configure a connector in Studio: 1. [Create a Mule project](#create-mule-project). 2. [Add the connector to your Mule project](#add-connector-to-project). 3. [Configure an input source for the connector’s flow](#configure-input-source). 4. [Add a connector operation to the flow](#add-connector-operation). 5. [Configure a global element for the connector](#configure-global-element). 6. [Configure the other connector fields](#configure-other-fields). If you are new to configuring connectors in Studio, see [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio). If, after reading this topic, you need additional information about the connector fields, see the [Amazon DynamoDB Connector Reference](https://docs.mulesoft.com/amazon-dynamodb-connector/1.5/amazon-dynamodb-connector-reference). ## Create a Mule Project In Studio, create a new Mule project in which to add and configure the connector: 1. In Anypoint Studio, select **File > New > Mule Project**. 2. Enter a name for your Mule project and click **Finish**. ## Add the Connector to Your Mule Project Add Amazon DynamoDB Connector to your Mule project to automatically populate the XML code with the connector’s namespace and schema location, as well as to add the required dependencies to the project’s `pom.xml` file: 1. In the **Mule Palette** view, click **(X) Search in Exchange**. 2. In **Add Modules to Project**, type `amazon dynamodb` in the search field. 3. Click **Amazon DynamoDB** in **Available modules**. 4. Click **Add**. 5. Click **Finish**. Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace. ## Configure an Input Source An input source initiates a flow when a specified condition is met. You can configure one of these input sources to use with Amazon DynamoDB Connector: - `HTTP Listener`, which initiates a flow each time it receives a request on the configured host and port - `Scheduler`, which initiates a flow when a time-based condition is met For example, to configure `HTTP Listener`, follow these steps: 1. In the **Mule Palette** view, select **HTTP** > **Listener**. 2. Drag **Listener** to the Studio canvas. 3. On the **Listener** tab, optionally change the value of the **Display Name** field. 4. Specify a value for the **Path** field. 5. Click the plus sign (+) next to the **Connector configuration** field to configure a global element that can be used by all instances of `HTTP Listener` in the app. 6. On the **General** tab, specify connection information. 7. On the **TLS** tab, optionally specify TLS information. 8. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 9. Click **Test Connection** to confirm that Mule can connect with the specific server. 10. Click **OK**. ## Add a Connector Operation to the Flow When you add a connector operation to your flow, you immediately define a specific operation for that connector to perform. To add an operation for Amazon DynamoDB Connector, follow these steps: 1. In the **Mule Palette** view, select **Amazon DynamoDB** and then select the desired operation. 2. Drag the operation onto the Studio canvas to the right of the input source. ## Configure a Global Element for the Connector When you configure a connector, it is best to configure a global element that can be used by all instances of that connector in the app. Configuring a global element requires you to provide the authentication credentials the connector uses to access the target Amazon DynamoDB system. Amazon DynamoDB Connector supports both Basic authentication and Role authentication. To configure the global element for Amazon DynamoDB Connector, follow these steps: 1. Select the connector in the Studio canvas. 2. In the configuration screen for the operation, click the plus sign (+) next to the `Connector configuration` field to access the global element configuration fields. 3. On the **General** tab, configure Basic authentication or Role authentication, as described in the [Basic Authentication](#basic-authentication) and [Role Authentication](#role-authentication) sections. You can reference a configuration file that contains ANT-style property placeholders (recommended), or you can enter your authorization credentials in the global configuration properties. For more information about using ANT-style property holders, see [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview). 4. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 5. Click **Test Connection** to confirm that Mule can connect with the specified server. 6. Click **OK**. ### Basic Authentication Enter the following information on the **General** tab of the **Global Element Properties** screen to configure Basic authentication:
FieldUser Action

Name

Enter the configuration name.

Connection

Select Basic.

Session Token

Optionally enter the session token provided by Amazon Security Token Service (STS).

Access Key

Enter the access key provided by Amazon.

Secret Key

Enter the secret key provided by Amazon.

Try Default AWS Credentials Provider Chain

Set to true to obtain credentials from the AWS environment.

Region Endpoint

Select the region endpoint for the service.

The following screenshot shows an example of configuring Basic authentication: ![Basic option selected in the Connection field](/mulesoft/current/en-us/amazon-dynamodb-connector/1.5/_images/amazon-dynamodb-basic-authentication.png) Figure 1. Basic authentication fields The first item shows where to specify that the connector will use Basic authentication. The second item shows the **General tab**, which contains fields related to Basic authentication. ### Role Authentication Enter the following information on the **General** tab of the global element configuration screen to configure Role authentication:
FieldUser Action

Name

Enter the configuration name.

Connection

Select Role.

Role ARN

Enter the role to assume to gain cross-account access.

Access Key

Enter the access key provided by Amazon.

Secret Key

Enter the secret key provided by Amazon.

Try Default AWS Credentials Provider Chain

Set to true to obtain credentials from the AWS environment.

Region Endpoint

Select the region endpoint for the service.

The following screenshot shows an example of configuring Role authentication: ![Role option selected in the Connection field](/mulesoft/current/en-us/amazon-dynamodb-connector/1.5/_images/amazon-dynamodb-role-authentication.png) Figure 2. Role authentication fields The first item shows where to specify that the connector will use Role authentication. The second item shows the **General tab**, which contains fields related to Role authentication. ## Configure the Other Connector Fields After you configure a global element for Amazon DynamoDB connector, configure the other required fields for the connector:
FieldDescription

Table name

Name of the table to create

Attribute definitions

Attributes that describe the key schema for the table and its indexes

Key schemas

Attributes that compose the primary key for a table or index

## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio) - [Amazon DynamoDB Connector Reference](https://docs.mulesoft.com/amazon-dynamodb-connector/1.5/amazon-dynamodb-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: Amazon DynamoDB Connector version: 1.6 is-latest-version: true --- # Using Anypoint Studio to Configure Amazon DynamoDB Connector > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. To add and configure a connector in Studio: 1. [Create a Mule project](#create-mule-project). 2. [Add the connector to your Mule project](#add-connector-to-project). 3. [Configure an input source for the connector’s flow](#configure-input-source). 4. [Add a connector operation to the flow](#add-connector-operation). 5. [Configure a global element for the connector](#configure-global-element). 6. [Configure the other connector fields](#configure-other-fields). If you are new to configuring connectors in Studio, see [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio). If, after reading this topic, you need additional information about the connector fields, see the [Amazon DynamoDB Connector Reference](https://docs.mulesoft.com/amazon-dynamodb-connector/latest/amazon-dynamodb-connector-reference). ## Create a Mule Project In Studio, create a new Mule project in which to add and configure the connector: 1. In Anypoint Studio, select **File > New > Mule Project**. 2. Enter a name for your Mule project and click **Finish**. ## Add the Connector to Your Mule Project Add Amazon DynamoDB Connector to your Mule project to automatically populate the XML code with the connector’s namespace and schema location, as well as to add the required dependencies to the project’s `pom.xml` file: 1. In the **Mule Palette** view, click **(X) Search in Exchange**. 2. In **Add Modules to Project**, type `amazon dynamodb` in the search field. 3. Click **Amazon DynamoDB** in **Available modules**. 4. Click **Add**. 5. Click **Finish**. Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace. ## Configure an Input Source An input source initiates a flow when a specified condition is met. You can configure one of these input sources to use with Amazon DynamoDB Connector: - `HTTP Listener`, which initiates a flow each time it receives a request on the configured host and port - `Scheduler`, which initiates a flow when a time-based condition is met For example, to configure `HTTP Listener`, follow these steps: 1. In the **Mule Palette** view, select **HTTP** > **Listener**. 2. Drag **Listener** to the Studio canvas. 3. On the **Listener** tab, optionally change the value of the **Display Name** field. 4. Specify a value for the **Path** field. 5. Click the plus sign (+) next to the **Connector configuration** field to configure a global element that can be used by all instances of `HTTP Listener` in the app. 6. On the **General** tab, specify connection information. 7. On the **TLS** tab, optionally specify TLS information. 8. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 9. Click **Test Connection** to confirm that Mule can connect with the specific server. 10. Click **OK**. ## Add a Connector Operation to the Flow When you add a connector operation to your flow, you immediately define a specific operation for that connector to perform. To add an operation for Amazon DynamoDB Connector, follow these steps: 1. In the **Mule Palette** view, select **Amazon DynamoDB** and then select the desired operation. 2. Drag the operation onto the Studio canvas to the right of the input source. ## Configure a Global Element for the Connector When you configure a connector, it is best to configure a global element that can be used by all instances of that connector in the app. Configuring a global element requires you to provide the authentication credentials the connector uses to access the target Amazon DynamoDB system. Amazon DynamoDB Connector supports both Basic authentication and Role authentication. To configure the global element for Amazon DynamoDB Connector, follow these steps: 1. Select the connector in the Studio canvas. 2. In the configuration screen for the operation, click the plus sign (+) next to the `Connector configuration` field to access the global element configuration fields. 3. On the **General** tab, configure Basic authentication or Role authentication, as described in the [Basic Authentication](#basic-authentication) and [Role Authentication](#role-authentication) sections. You can reference a configuration file that contains ANT-style property placeholders (recommended), or you can enter your authorization credentials in the global configuration properties. For more information about using ANT-style property holders, see [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview). 4. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 5. Click **Test Connection** to confirm that Mule can connect with the specified server. 6. Click **OK**. ### Basic Authentication Enter the following information on the **General** tab of the **Global Element Properties** screen to configure Basic authentication:
FieldUser Action

Name

Enter the configuration name.

Connection

Select Basic.

Session Token

Optionally enter the session token provided by Amazon Security Token Service (STS).

Access Key

Enter the access key provided by Amazon.

Secret Key

Enter the secret key provided by Amazon.

Try Default AWS Credentials Provider Chain

Set to true to obtain credentials from the AWS environment.

Region Endpoint

Select the region endpoint for the service.

The following screenshot shows an example of configuring Basic authentication: ![Basic option selected in the Connection field](/mulesoft/current/en-us/amazon-dynamodb-connector/latest/_images/amazon-dynamodb-basic-authentication.png) Figure 1. Basic authentication fields The first item shows where to specify that the connector will use Basic authentication. The second item shows the **General tab**, which contains fields related to Basic authentication. ### Role Authentication Enter the following information on the **General** tab of the global element configuration screen to configure Role authentication:
FieldUser Action

Name

Enter the configuration name.

Connection

Select Role.

Role ARN

Enter the role to assume to gain cross-account access.

Access Key

Enter the access key provided by Amazon.

Secret Key

Enter the secret key provided by Amazon.

Region Endpoint

Select the region endpoint for the service.

The following screenshot shows an example of configuring Role authentication: ![Role option selected in the Connection field](/mulesoft/current/en-us/amazon-dynamodb-connector/latest/_images/amazon-dynamodb-role-authentication.png) Figure 2. Role authentication fields The first item shows where to specify that the connector will use Role authentication. The second item shows the **General tab**, which contains fields related to Role authentication. ## Configure the Other Connector Fields After you configure a global element for Amazon DynamoDB connector, configure the other required fields for the connector:
FieldDescription

Table name

Name of the table to create

Attribute definitions

Attributes that describe the key schema for the table and its indexes

Key schemas

Attributes that compose the primary key for a table or index

## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio) - [Amazon DynamoDB Connector Reference](https://docs.mulesoft.com/amazon-dynamodb-connector/latest/amazon-dynamodb-connector-reference) - [Salesforce Help](https://help.salesforce.com)