Amazon DynamoDB Connector Reference | MuleSoft Documentation
# Amazon DynamoDB Connector Reference
Amazon DynamoDB Connector v1.4
Release Notes: Amazon DynamoDB Connector Release Notes
## Configurations
### Default Configuration
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
The name for this configuration. Connectors reference the configuration with this name.  
**Connection** |  The connection types to provide to this configuration.  
**Expiration Policy** |  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
###### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Session Token** |  The session token provided by Amazon STS.  
**Connection Timeout** |  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.  
**Connection Timeout Unit** |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  Time unit for the **Connection Timeout** field.  
**Max Connections** |  Sets the maximum number of allowed open HTTP connections.  
**Socket Timeout** |  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.  
**Socket Timeout Unit** |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  Time unit for the **Socket Timeout** field.  
**Access Key** |  The access key provided by Amazon.  
**Secret Key** |  The secret key provided by Amazon.  
**Try Default AWSCredentials Provider Chain** |  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`  
**Custom Service Endpoint** |  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** |  Set the topic region endpoint.  
**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  
The optional proxy host.  
The optional proxy port.  
The optional proxy username.  
The optional proxy password.  
The optional proxy domain.  
**Workstation** |  The optional proxy workstation.  
###### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
The Role ARN unique identifies role to assume to gain cross account access.  
**Custom STS Endpoint** |  Sets a custom service endpoint. Useful when a non-standard service endpoint is required, such as a VPC endpoint.  
**Connection Timeout** |  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.  
**Connection Timeout Unit** |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  Time unit for the **Connection Timeout** field.  
**Max Connections** |  Sets the maximum number of allowed open HTTP connections.  
**Socket Timeout** |  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.  
**Socket Timeout Unit** |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  Time unit for the **Socket Timeout** field.  
**Access Key** |  The access key provided by Amazon.  
**Secret Key** |  The secret key provided by Amazon.  
**Try Default AWSCredentials Provider Chain** |  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`  
**Custom Service Endpoint** |  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** |  Set the topic region endpoint.  
**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  
The optional proxy host.  
The optional proxy port.  
The optional proxy username.  
The optional proxy password.  
The optional proxy domain.  
**Workstation** |  The optional proxy workstation.  
### Streams Configuration
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
The name for this configuration. Connectors reference the configuration with this name.  
**Connection** |  The connection types to provide to this configuration.  
**Expiration Policy** |  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
  *   * Get Shard Iterator
  * 

###### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Session Token** |  The session token provided by Amazon STS.  
**Connection Timeout** |  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.  
**Connection Timeout Unit** |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  Time unit for the **Connection Timeout** field.  
**Max Connections** |  Sets the maximum number of allowed open HTTP connections.  
**Socket Timeout** |  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.  
**Socket Timeout Unit** |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  Time unit for the **Socket Timeout** field.  
**Access Key** |  The access key provided by Amazon.  
**Secret Key** |  The secret key provided by Amazon.  
**Try Default AWSCredentials Provider Chain** |  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`  
**Custom Service Endpoint** |  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** |  Set the topic region endpoint.  
**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  
The optional proxy host.  
The optional proxy port.  
The optional proxy username.  
The optional proxy password.  
The optional proxy domain.  
**Workstation** |  The optional proxy workstation.  
## Operations
  * Batch Delete Item
  * Batch Get Item
  * Batch Put Item
  *   *   *   * Describe Table
  *   * Paginated Query
  *   * 

### Batch Delete Item
`<dynamodb:batch-delete-item>`
The Batch Delete Item operation deletes multiple items in one or more tables.
For information, see the Amazon DynamoDB API Reference for this operation.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Request Delete Items** |  One or more items to delete from the table.  
**Target Variable** |  The name of a variable to store the operation’s output.  
**Target Value** |  An expression to evaluate against the operation’s output and store the expression outcome in the target variable  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
Batch Write Item Result  
---  
Attributes Type |  Request ID Attribute  
### For Configurations
  * Default Configuration
### Batch Delete Item
`<dynamodb:batch-delete-item>`
The Batch Delete Item operation deletes multiple items in one or more tables.
For information, see the Amazon DynamoDB API Reference for this operation.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Request Delete Items** |  One or more items to delete from the table.  
**Target Variable** |  The name of a variable to store the operation’s output.  
**Target Value** |  An expression to evaluate against the operation’s output and store the expression outcome in the target variable  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
Batch Write Item Result  
---  
Attributes Type |  Request ID Attribute  
### For Configurations
  * Default Configuration


#### Throws
  * DYNAMODB:ACCESS_DENIED_EXCEPTION
  * DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION
  * DYNAMODB:CONNECTIVITY
  * DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION
  * DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION
  * DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION
  * DYNAMODB:RESOURCE_IN_USE_EXCEPTION
  * DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION
  * DYNAMODB:RETRY_EXHAUSTED
  * DYNAMODB:THROTTLING_EXCEPTION
  * DYNAMODB:UNKNOWN
  * DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION
  * DYNAMODB:VALIDATION_EXCEPTION


### Batch Get Item
`<dynamodb:batch-get-item>`
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 for this operation.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Request Items** |  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.  
**Return Consumed Capacity** |  Enumeration, one of:
  * INDEXES
  * TOTAL

|  Determines the level of detail about provisioned throughput consumption that is returned in the response.  
**Target Variable** |  The name of a variable to store the operation’s output.  
**Target Value** |  An expression to evaluate against the operation’s output and store the expression outcome in the target variable  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
Batch Get Item Result  
---  
Attributes Type |  Request ID Attribute  
### For Configurations
  * Default Configuration


#### Throws
  * DYNAMODB:ACCESS_DENIED_EXCEPTION
  * DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION
  * DYNAMODB:CONNECTIVITY
  * DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION
  * DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION
  * DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION
  * DYNAMODB:RESOURCE_IN_USE_EXCEPTION
  * DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION
  * DYNAMODB:RETRY_EXHAUSTED
  * DYNAMODB:THROTTLING_EXCEPTION
  * DYNAMODB:UNKNOWN
  * DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION
  * DYNAMODB:VALIDATION_EXCEPTION


### Batch Put Item
`<dynamodb:batch-put-item>`
The Batch Put Item operation puts multiple items in one or more tables.
For information, see the Amazon DynamoDB API Reference for this operation.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Request Put Items** |  One or more items to insert into table.  
**Target Variable** |  The name of a variable to store the operation’s output.  
**Target Value** |  An expression to evaluate against the operation’s output and store the expression outcome in the target variable  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
Batch Write Item Result  
---  
Attributes Type |  Request ID Attribute  
### For Configurations
  * Default Configuration


#### Throws
  * DYNAMODB:ACCESS_DENIED_EXCEPTION
  * DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION
  * DYNAMODB:CONNECTIVITY
  * DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION
  * DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION
  * DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION
  * DYNAMODB:RESOURCE_IN_USE_EXCEPTION
  * DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION
  * DYNAMODB:RETRY_EXHAUSTED
  * DYNAMODB:THROTTLING_EXCEPTION
  * DYNAMODB:UNKNOWN
  * DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION
  * DYNAMODB:VALIDATION_EXCEPTION


### Create Table
`<dynamodb:create-table>`
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 for this operation.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Table Name** |  The name of the table to create.  
**Attribute Definitions** |  Array of Attribute Definition |  An array of attributes that describe the key schema for the table and indexes.  
**Key Schemas** |  Array of Key Schema Element |  Specifies the attributes that make up the primary key for a table or an index.  
**Read Capacity Units** |  The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.  
**Write Capacity Units** |  The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.  
**Global Secondary Indexes** |  Array of Global Secondary Index |  One or more global secondary indexes (the maximum is five) to be created on the table.  
**Local Secondary Indexes** |  Array of Local Secondary Index |  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** |  Indicates whether to enable Streams (true) or disable Streams (false).  
**Target Variable** |  The name of a variable to store the operation’s output.  
**Target Value** |  An expression to evaluate against the operation’s output and store the expression outcome in the target variable  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
Table Description  
---  
Attributes Type |  Request ID Attribute  
### For Configurations
  * Default Configuration


#### Throws
  * DYNAMODB:ACCESS_DENIED_EXCEPTION
  * DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION
  * DYNAMODB:CONNECTIVITY
  * DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION
  * DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION
  * DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION
  * DYNAMODB:RESOURCE_IN_USE_EXCEPTION
  * DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION
  * DYNAMODB:RETRY_EXHAUSTED
  * DYNAMODB:THROTTLING_EXCEPTION
  * DYNAMODB:UNKNOWN
  * DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION
  * DYNAMODB:VALIDATION_EXCEPTION


### Delete Item
`<dynamodb:delete-item>`
This operation deletes a single item in a table by primary key.
For information, see the Amazon DynamoDB API Reference for this operation.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Table Name** |  Table name.  
**Primarykey** |  Primary key name and value map.  
**Target Variable** |  The name of a variable to store the operation’s output.  
**Target Value** |  An expression to evaluate against the operation’s output and store the expression outcome in the target variable  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
Delete Item Result  
---  
Attributes Type |  Request ID Attribute  
### For Configurations
  * Default Configuration
### Delete Item
`<dynamodb:delete-item>`
This operation deletes a single item in a table by primary key.
For information, see the Amazon DynamoDB API Reference for this operation.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Table Name** |  Table name.  
**Primarykey** |  Primary key name and value map.  
**Target Variable** |  The name of a variable to store the operation’s output.  
**Target Value** |  An expression to evaluate against the operation’s output and store the expression outcome in the target variable  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
Delete Item Result  
---  
Attributes Type |  Request ID Attribute  
### For Configurations
  * Default Configuration


#### Throws
  * DYNAMODB:ACCESS_DENIED_EXCEPTION
  * DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION
  * DYNAMODB:CONNECTIVITY
  * DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION
  * DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION
  * DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION
  * DYNAMODB:RESOURCE_IN_USE_EXCEPTION
  * DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION
  * DYNAMODB:RETRY_EXHAUSTED
  * DYNAMODB:THROTTLING_EXCEPTION
  * DYNAMODB:UNKNOWN
  * DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION
  * DYNAMODB:VALIDATION_EXCEPTION


### Delete Table
`<dynamodb:delete-table>`
The Delete Table operation deletes a table and all of its items.
For information, see the Amazon DynamoDB API Reference for this operation.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Table Name** |  The name of the table to delete.  
**Target Variable** |  The name of a variable to store the operation’s output.  
**Target Value** |  An expression to evaluate against the operation’s output and store the expression outcome in the target variable  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
Table Description  
---  
Attributes Type |  Request ID Attribute  
### For Configurations
  * Default Configuration


#### Throws
  * DYNAMODB:ACCESS_DENIED_EXCEPTION
  * DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION
  * DYNAMODB:CONNECTIVITY
  * DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION
  * DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION
  * DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION
  * DYNAMODB:RESOURCE_IN_USE_EXCEPTION
  * DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION
  * DYNAMODB:RETRY_EXHAUSTED
  * DYNAMODB:THROTTLING_EXCEPTION
  * DYNAMODB:UNKNOWN
  * DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION
  * DYNAMODB:VALIDATION_EXCEPTION


### Describe Table
`<dynamodb:describe-table>`
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 for this operation.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Table Name** |  The name of the table to describe.  
**Target Variable** |  The name of a variable to store the operation’s output.  
**Target Value** |  An expression to evaluate against the operation’s output and store the expression outcome in the target variable  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
Table Description  
---  
Attributes Type |  Request ID Attribute  
### For Configurations
  * Default Configuration


#### Throws
  * DYNAMODB:ACCESS_DENIED_EXCEPTION
  * DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION
  * DYNAMODB:CONNECTIVITY
  * DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION
  * DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION
  * DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION
  * DYNAMODB:RESOURCE_IN_USE_EXCEPTION
  * DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION
  * DYNAMODB:RETRY_EXHAUSTED
  * DYNAMODB:THROTTLING_EXCEPTION
  * DYNAMODB:UNKNOWN
  * DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION
  * DYNAMODB:VALIDATION_EXCEPTION


### Get Item
`<dynamodb:get-item>`
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 for this operation.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Table Name** |  The name of the table containing the requested item.  
A map of attribute names to AttributeValue objects, representing the primary key of the item to retrieve.  
**Attributes To Gets** |  Array of String |  This is a legacy parameter. Use ProjectionExpression instead.  
**Consistent Read** |  Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.  
**Expression Attribute Names** |  One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:  
**Projection Expression** |  A string that identifies one or more attributes to retrieve from the table.  
**Return Consumed Capacity** |  Enumeration, one of:
  * INDEXES
  * TOTAL

|  Determines the level of detail about provisioned throughput consumption returned in the response.  
**Target Variable** |  The name of a variable to store the operation’s output.  
**Target Value** |  An expression to evaluate against the operation’s output and store the expression outcome in the target variable  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
Get Item Result  
---  
Attributes Type |  Request ID Attribute  
### For Configurations
  * Default Configuration


#### Throws
  * DYNAMODB:ACCESS_DENIED_EXCEPTION
  * DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION
  * DYNAMODB:CONNECTIVITY
  * DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION
  * DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION
  * DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION
  * DYNAMODB:RESOURCE_IN_USE_EXCEPTION
  * DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION
  * DYNAMODB:RETRY_EXHAUSTED
  * DYNAMODB:THROTTLING_EXCEPTION
  * DYNAMODB:UNKNOWN
  * DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION
  * DYNAMODB:VALIDATION_EXCEPTION


### List Tables
`<dynamodb:list-tables>`
This operation returns an array of table names associated with the current account and endpoint.
For information, see the Amazon DynamoDB API Reference for this operation.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Exclusive Start Table Name** |  The first table name that this operation will evaluate. Use the value that was returned for LastEvaluatedTableName in a previous operation.  
A maximum number of table names to return. If this parameter is not specified, the limit is 100.  
**Target Variable** |  The name of a variable to store the operation’s output.  
**Target Value** |  An expression to evaluate against the operation’s output and store the expression outcome in the target variable  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
List Tables Result  
---  
Attributes Type |  Request ID Attribute  
### For Configurations
  * Default Configuration
### List Tables
`<dynamodb: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 for this operation.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Exclusive Start Table Name** |  The first table name that this operation will evaluate. Use the value that was returned for LastEvaluatedTableName in a previous operation.  
A maximum number of table names to return. If this parameter is not specified, the limit is 100.  
**Target Variable** |  The name of a variable to store the operation’s output.  
**Target Value** |  An expression to evaluate against the operation’s output and store the expression outcome in the target variable  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
List Tables Result  
---  
Attributes Type |  Request ID Attribute  
### For Configurations
  * Default Configuration


#### 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
`<dynamodb: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
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Key Condition Expression** |  The condition that specifies the key values for items to retrieve by the **Query** operation.  
**Key Conditions** |  This is a legacy parameter. Use **Key Condition Expression** instead.  
**Scan Index Forward** |  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.  
Enumeration, one of:
  * ALL_ATTRIBUTES
  * ALL_PROJECTED_ATTRIBUTES
  * SPECIFIC_ATTRIBUTES
  * COUNT

|  The attributes to return in the result.  
**Attribute Names** |  One or more substitution tokens for attribute names in an expression.  
**Attribute Values** |  One or more values to substitute in an expression.  
**Table Name** |  Name of the table containing the requested item.  
**Attributes To Gets** |  Array of String |  This is a legacy parameter. Use the **Projection Expression** field instead.  
**Conditional Operator** |  Enumeration, one of: |  A logical operator to apply to the conditions.  
**Consistent Read** |  Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.  
**Exclusive Start Key** |  The primary key of the first item that this operation evaluates.  
**Filter Expression** |  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** |  The name of a secondary index to scan. This index can be any local secondary index or global secondary index.  
The maximum number of items to evaluate (not necessarily the number of matching items).  
**Projection Expression** |  A string that identifies one or more attributes to retrieve from the table.  
**Condition Filter** |  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

|  The level of detail of the provisioned throughput consumption returned in the response.  
**Target Variable** |  Name of the variable that stores the operation’s output.  
**Target Value** |  An expression to evaluate against the operation’s output and store the expression outcome in the target variable  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
Array of Message of Array of Object payload and Request ID Attribute attributes  
---  
### For Configurations
  * Default Configuration


#### 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
`<dynamodb: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 for this operation.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Table Name** |  Table name.  
Item to be inserted.  
**Target Variable** |  The name of a variable to store the operation’s output.  
**Target Value** |  An expression to evaluate against the operation’s output and store the expression outcome in the target variable  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
Put Item Result  
---  
Attributes Type |  Request ID Attribute  
### For Configurations
  * Default Configuration


#### Throws
  * DYNAMODB:ACCESS_DENIED_EXCEPTION
  * DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION
  * DYNAMODB:CONNECTIVITY
  * DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION
  * DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION
  * DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION
  * DYNAMODB:RESOURCE_IN_USE_EXCEPTION
  * DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION
  * DYNAMODB:RETRY_EXHAUSTED
  * DYNAMODB:THROTTLING_EXCEPTION
  * DYNAMODB:UNKNOWN
  * DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION
  * DYNAMODB:VALIDATION_EXCEPTION


### Query
`<dynamodb:query>`
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 for this operation.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Key Condition Expression** |  The condition that specifies the key values for items to be retrieved by the Query action.  
**Key Conditions** |  This is a legacy parameter. Use KeyConditionExpression instead.  
**Scan Index Forward** |  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.  
Enumeration, one of:
  * ALL_ATTRIBUTES
  * ALL_PROJECTED_ATTRIBUTES
  * SPECIFIC_ATTRIBUTES
  * COUNT
### Query
`<dynamodb:query>`
The Query operation finds items based on primary key values. You can query any table or secondary index that has a composite primary key (a partition key and a sort key).
For information, see the Amazon DynamoDB API Reference for this operation.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Key Condition Expression** |  The condition that specifies the key values for items to be retrieved by the Query action.  
**Key Conditions** |  This is a legacy parameter. Use KeyConditionExpression instead.  
**Scan Index Forward** |  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.  
Enumeration, one of:
  * ALL_ATTRIBUTES
  * ALL_PROJECTED_ATTRIBUTES
  * SPECIFIC_ATTRIBUTES
  * COUNT

|  The attributes to be returned in the result.  
**Attribute Names** |  One or more substitution tokens for attribute names in an expression.  
**Attribute Values** |  One or more values to substitute in an expression.  
**Table Name** |  Name of the table containing the requested item.  
**Attributes To Gets** |  Array of String |  This is a legacy parameter. Use the Projection Expression field instead.  
**Conditional Operator** |  Enumeration, one of: |  A logical operator to apply to the conditions.  
**Consistent Read** |  Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.  
**Exclusive Start Key** |  The primary key of the first item that this operation evaluates.  
**Filter Expression** |  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** |  The name of a secondary index to scan. This index can be any local secondary index or global secondary index.  
The maximum number of items to evaluate (not necessarily the number of matching items).  
**Projection Expression** |  A string that identifies one or more attributes to retrieve from the table.  
**Condition Filter** |  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

|  The level of detail of the provisioned throughput consumption returned in the response.  
**Target Variable** |  The name of a variable to store the operation’s output.  
**Target Value** |  An expression to evaluate against the operation’s output and store the expression outcome in the target variable  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output  
---  
Attributes Type |  Request ID Attribute  
### For Configurations
  * Default Configuration


#### Throws
  * DYNAMODB:ACCESS_DENIED_EXCEPTION
  * DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION
  * DYNAMODB:CONNECTIVITY
  * DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION
  * DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION
  * DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION
  * DYNAMODB:RESOURCE_IN_USE_EXCEPTION
  * DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION
  * DYNAMODB:RETRY_EXHAUSTED
  * DYNAMODB:THROTTLING_EXCEPTION
  * DYNAMODB:UNKNOWN
  * DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION
  * DYNAMODB:VALIDATION_EXCEPTION


### Scan
`<dynamodb:scan>`
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 for this operation.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.  
Enumeration, one of:
  * ALL_ATTRIBUTES
  * ALL_PROJECTED_ATTRIBUTES
  * SPECIFIC_ATTRIBUTES
  * COUNT

|  The attributes to be returned in the result.  
**Total Segments** |  For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation is divided.  
**Attribute Names** |  One or more substitution tokens for attribute names in an expression.  
**Attribute Values** |  One or more values to substitute in an expression.  
**Table Name** |  Name of the table containing the requested item.  
**Attributes To Gets** |  Array of String |  This is a legacy field. Use the Projection Expression field instead.  
**Conditional Operator** |  Enumeration, one of: |  A logical operator to apply to the conditions.  
**Consistent Read** |  Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.  
**Exclusive Start Key** |  The primary key of the first item that this operation evaluates.  
**Filter Expression** |  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** |  The name of a secondary index to scan. This index can be any local secondary index or global secondary index.  
The maximum number of items to evaluate (not necessarily the number of matching items).  
**Projection Expression** |  A string that identifies one or more attributes to retrieve from the table.  
**Condition Filter** |  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

|  The level of detail of the provisioned throughput consumption returned in the response..  
**Target Variable** |  The name of a variable to store the operation’s output.  
**Target Value** |  An expression to evaluate against the operation’s output and store the expression outcome in the target variable  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output  
---  
Attributes Type |  Request ID Attribute  
### For Configurations
  * Default Configuration


#### Throws
  * DYNAMODB:ACCESS_DENIED_EXCEPTION
  * DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION
  * DYNAMODB:CONNECTIVITY
  * DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION
  * DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION
  * DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION
  * DYNAMODB:RESOURCE_IN_USE_EXCEPTION
  * DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION
  * DYNAMODB:RETRY_EXHAUSTED
  * DYNAMODB:THROTTLING_EXCEPTION
  * DYNAMODB:UNKNOWN
  * DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION
  * DYNAMODB:VALIDATION_EXCEPTION


### Update Item
`<dynamodb:update-item>`
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 for this operation.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Table Name** |  Table name.  
Primary key.  
**Return Consumed Capacity** |  Enumeration, one of:
  * INDEXES
  * TOTAL

|  Determines the level of detail about provisioned throughput consumption that is returned in the response.  
**Return Item Collection Metrics** |  Enumeration, one of: |  Determines whether item collection metrics are returned.  
**Return Values** |  Enumeration, one of:
  * 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** |  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** |  This is a legacy parameter. Use updateExpression instead.  
This is a legacy parameter. Use conditionExpression instead.  
**Conditional Operator** |  Enumeration, one of:  
**Condition Expression**  
**Attribute Names**  
**Attribute Values**  
**Target Variable** |  The name of a variable to store the operation’s output.  
**Target Value** |  An expression to evaluate against the operation’s output and store the expression outcome in the target variable  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
Update Item Result  
---  
Attributes Type |  Request ID Attribute  
### For Configurations
  * Default Configuration
|  Determines the level of detail about provisioned throughput consumption that is returned in the response.  
**Return Item Collection Metrics** |  Enumeration, one of: |  Determines whether item collection metrics are returned.  
**Return Values** |  Enumeration, one of:
  * 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** |  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** |  This is a legacy parameter. Use updateExpression instead.  
This is a legacy parameter. Use conditionExpression instead.  
**Conditional Operator** |  Enumeration, one of:  
**Condition Expression**  
**Attribute Names**  
**Attribute Values**  
**Target Variable** |  The name of a variable to store the operation’s output.  
**Target Value** |  An expression to evaluate against the operation’s output and store the expression outcome in the target variable  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
Update Item Result  
---  
Attributes Type |  Request ID Attribute  
### For Configurations
  * Default Configuration


#### Throws
  * DYNAMODB:ACCESS_DENIED_EXCEPTION
  * DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION
  * DYNAMODB:CONNECTIVITY
  * DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION
  * DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION
  * DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION
  * DYNAMODB:RESOURCE_IN_USE_EXCEPTION
  * DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION
  * DYNAMODB:RETRY_EXHAUSTED
  * DYNAMODB:THROTTLING_EXCEPTION
  * DYNAMODB:UNKNOWN
  * DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION
  * DYNAMODB:VALIDATION_EXCEPTION


### Update Table
`<dynamodb:update-table>`
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 for this operation.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Table Name** |  The name of the table to update.  
**Attribute Definitions** |  Array of Attribute Definition |  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** |  The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.  
**Write Capacity Units** |  The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.  
**Global Secondary Index Updates** |  Array of Global Secondary Index Update |  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** |  Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.  
**Target Variable** |  The name of a variable to store the operation’s output.  
**Target Value** |  An expression to evaluate against the operation’s output and store the expression outcome in the target variable  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
Table Description  
---  
Attributes Type |  Request ID Attribute  
### For Configurations
  * Default Configuration


#### Throws
  * DYNAMODB:ACCESS_DENIED_EXCEPTION
  * DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION
  * DYNAMODB:CONNECTIVITY
  * DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION
  * DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION
  * DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION
  * DYNAMODB:RESOURCE_IN_USE_EXCEPTION
  * DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION
  * DYNAMODB:RETRY_EXHAUSTED
  * DYNAMODB:THROTTLING_EXCEPTION
  * DYNAMODB:UNKNOWN
  * DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION
  * DYNAMODB:VALIDATION_EXCEPTION


### Describe Stream
`<dynamodb:describe-stream>`
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Stream ARN**  
**Target Variable** |  The name of a variable to store the operation’s output.  
**Target Value** |  An expression to evaluate against the operation’s output and store the expression outcome in the target variable  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
Stream Description  
---  
Attributes Type |  Request ID Attribute  
### For Configurations
  * Streams Configuration


#### Throws
  * DYNAMODB:ACCESS_DENIED_EXCEPTION
  * DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION
  * DYNAMODB:CONNECTIVITY
  * DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION
  * DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION
  * DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION
  * DYNAMODB:RESOURCE_IN_USE_EXCEPTION
  * DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION
  * DYNAMODB:RETRY_EXHAUSTED
  * DYNAMODB:THROTTLING_EXCEPTION
  * DYNAMODB:UNKNOWN
  * DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION
  * DYNAMODB:VALIDATION_EXCEPTION


### Get Records
`<dynamodb:get-records>`
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Shard Iterator**  
**Streaming Strategy** | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

|  Configure to use repeatable streams.  
**Target Variable** |  The name of a variable to store the operation’s output.  
**Target Value** |  An expression to evaluate against the operation’s output and store the expression outcome in the target variable  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
Array of Message of Record payload and Request ID Attribute attributes  
---  
### For Configurations
  * Streams Configuration


#### Throws
  * DYNAMODB:ACCESS_DENIED_EXCEPTION
  * DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION
  * DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION
  * DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION
  * DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION
  * DYNAMODB:RESOURCE_IN_USE_EXCEPTION
  * DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION
  * DYNAMODB:THROTTLING_EXCEPTION
  * DYNAMODB:UNKNOWN
  * DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION
  * DYNAMODB:VALIDATION_EXCEPTION


### Get Shard Iterator
`<dynamodb:get-shard-iterator>`
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Shard Iterator Type**  
**Starting Sequence Number**  
**Stream ARN**  
**Target Variable** |  The name of a variable to store the operation’s output.  
**Target Value** |  An expression to evaluate against the operation’s output and store the expression outcome in the target variable  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
Attributes Type |  Request ID Attribute  
---|---  
### For Configurations
  * Streams Configuration
### Get Shard Iterator
`<dynamodb:get-shard-iterator>`
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Shard Iterator Type**  
**Starting Sequence Number**  
**Stream ARN**  
**Target Variable** |  The name of a variable to store the operation’s output.  
**Target Value** |  An expression to evaluate against the operation’s output and store the expression outcome in the target variable  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
Attributes Type |  Request ID Attribute  
---|---  
### For Configurations
  * Streams Configuration


#### Throws
  * DYNAMODB:ACCESS_DENIED_EXCEPTION
  * DYNAMODB:CONDITIONAL_CHECK_FAILED_EXCEPTION
  * DYNAMODB:CONNECTIVITY
  * DYNAMODB:INCOMPLETE_SIGNATURE_EXCEPTION
  * DYNAMODB:ITEM_COLLECTION_SIZE_LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:LIMIT_EXCEEDED_EXCEPTION
  * DYNAMODB:MISSING_AUTHENTICATION_TOKEN_EXCEPTION
  * DYNAMODB:PROVISIONED_THROUGHPUT_EXCEEDED_EXCEPTION
  * DYNAMODB:RESOURCE_IN_USE_EXCEPTION
  * DYNAMODB:RESOURCE_NOT_FOUND_EXCEPTION
  * DYNAMODB:RETRY_EXHAUSTED
  * DYNAMODB:THROTTLING_EXCEPTION
  * DYNAMODB:UNKNOWN
  * DYNAMODB:UNRECOGNIZED_CLIENT_EXCEPTION
  * DYNAMODB:VALIDATION_EXCEPTION


### List Streams
`<dynamodb:list-streams>`
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
**Configuration** |  The name of the configuration to use.  
**Streaming Strategy** | 
  * Repeatable In Memory Iterable
  * Repeatable File Store Iterable
  * non-repeatable-iterable

|  Configure to use repeatable streams.  
**Target Variable** |  The name of a variable to store the operation’s output.  
**Target Value** |  An expression to evaluate against the operation’s output and store the expression outcome in the target variable  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  A retry strategy in case of connectivity errors.  
#### Output
Array of Message of [Stream] payload and Request ID Attribute attributes  
---  
### For Configurations
  * Streams Configuration


#### 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
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Enabled Protocols** |  A comma-separated list of protocols enabled for this context.  
**Enabled Cipher Suites** |  A comma separated list of cipher suites enabled for this context.  
**Trust Store**  
**Revocation Check** | 
  * Standard Revocation Check
  * Custom OCSP Responder

  
### Trust Store
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.  
The password used to protect the trust store.  
The type of store used.  
The algorithm used by the trust store.  
If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.  
### Key Store
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.  
The type of store used.  
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** |  The password used to protect the private key.  
The password used to protect the key store.  
The algorithm used by the key store.  
### Standard Revocation Check
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Only End Entities** |  Only verify the last element of the certificate chain.  
**Prefer Crls** |  Try CRL instead of OCSP first.  
**No Fallback** |  Do not use the secondary checking method (the one not selected before).  
Avoid verification failure when the revocation server can not be reached or is busy.  
### Custom OCSP Responder
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The URL of the OCSP responder.  
**Cert Alias** |  Alias of the signing certificate for the OCSP response (must be in the trust store), if present.  
### CRL File
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The path to the CRL file.  
### Reconnection
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Fails Deployment** |  When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.  
**Reconnection Strategy** | 
  *   * Reconnect Forever

|  The reconnection strategy to use.  
### Reconnect
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
How often to reconnect (in milliseconds)  
The number of reconnection attempts to make  
If false, the reconnection strategy runs in a separate, non-blocking thread  
### Reconnect Forever
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
How often in milliseconds to reconnect  
If false, the reconnection strategy runs in a separate, non-blocking thread  
### Expiration Policy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Max Idle Time** |  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  
Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

|  A time unit that qualifies the maxIdleTime attribute  
### Batch Write Item Result
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Consumed Capacity** |  Array of Consumed Capacity  
**Item Collection Metrics**  
**Unprocessed Items**  
### Consumed Capacity
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Capacity Units**  
**Global Secondary Indexes**  
**Local Secondary Indexes**  
### Request ID Attribute
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
### Batch Get Item Result
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Consumed Capacity** |  Array of Consumed Capacity  
**Unprocessed Keys**  
### Table Description
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Attribute Definitions** |  Array of Attribute Definition  
**Creation Date Time**  
**Global Secondary Indexes** |  Array of Global Secondary Index Description  
**Key Schema** |  Array of Key Schema Element  
**Latest Stream Arn**  
**Latest Stream Label**  
**Local Secondary Indexes** |  Array of Local Secondary Index Description  
**Provisioned Throughput** |  Provisioned Throughput Description  
**Stream Specification** |  Stream Specification  
**Table Size Bytes**  
**Table Status**  
### Attribute Definition
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Attribute Name**  
**Attribute Type** |  Enumeration, one of:
  * STRING
  * NUMBER
  * BINARY

  
### Global Secondary Index Description
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Backfilling**  
**Index Size Bytes**  
**Index Status** |  Enumeration, one of:
  * CREATING
  * UPDATING
  * DELETING
  * ACTIVE
### Global Secondary Index Description
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Backfilling**  
**Index Size Bytes**  
**Index Status** |  Enumeration, one of:
  * CREATING
  * UPDATING
  * DELETING
  * ACTIVE

  
**Key Schema** |  Array of Key Schema Element  
**Projection**  
**Provisioned Throughput** |  Provisioned Throughput Description  
### Key Schema Element
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Attribute Name**  
Enumeration, one of:  
### Projection
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Non Key Attributes** |  Array of String  
**Projection Type** |  Enumeration, one of:
  * KEYS_ONLY
  * INCLUDE

  
### Provisioned Throughput Description
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Last Decrease Date Time**  
**Last Increase Date Time**  
**Number Of Decreases Today**  
**Read Capacity Units**  
**Write Capacity Units**  
### Local Secondary Index Description
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Index Size Bytes**  
**Key Schema** |  Array of Key Schema Element  
**Projection**  
### Stream Specification
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Stream Enabled**  
**Stream View Type** |  Enumeration, one of:
  * NEW_IMAGE
  * OLD_IMAGE
  * NEW_AND_OLD_IMAGES
  * KEYS_ONLY

  
### Global Secondary Index
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Key Schema** |  Array of Key Schema Element  
**Projection**  
**Provisioned Throughput** |  Provisioned Throughput  
### Provisioned Throughput
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Read Capacity Units**  
**Write Capacity Units**  
### Local Secondary Index
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Key Schema** |  Array of Key Schema Element  
**Projection**  
### Delete Item Result
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Consumed Capacity** |  Consumed Capacity  
**Item Collection Metrics** |  Item Collection Metrics  
### Item Collection Metrics
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Item Collection Key**  
**Size Estimate Range GB** |  Array of Number  
### Get Item Result
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Consumed Capacity** |  Consumed Capacity  
### List Tables Result
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Last Evaluated Table Name**  
**Table Names** |  Array of String  
### Put Item Result
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Consumed Capacity** |  Consumed Capacity  
**Item Collection Metrics** |  Item Collection Metrics  
### Query Result
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Consumed Capacity** |  Consumed Capacity  
Array of Object  
**Last Evaluated Key**  
**Scanned Count**  
### Scan Result
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Consumed Capacity** |  Consumed Capacity  
Array of Object  
**Last Evaluated Key**  
**Scanned Count**  
### Update Item Result
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Consumed Capacity** |  Consumed Capacity  
**Item Collection Metrics** |  Item Collection Metrics  
### Global Secondary Index Update
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Create Global Secondary Index Action  
Update Global Secondary Index Action  
### Create Global Secondary Index Action
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Key Schema** |  Array of Key Schema Element  
**Projection**  
**Provisioned Throughput** |  Provisioned Throughput  
### Update Global Secondary Index Action
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Provisioned Throughput** |  Provisioned Throughput  
### Stream Description
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Creation Request Date Time**  
**Key Schema** |  Array of Key Schema Element  
**Last Evaluated Shard Id**  
Array of Shard  
**Stream Label**  
**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

  
### Shard
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Parent Shard Id**  
**Sequence Number Range** |  Sequence Number Range  
### Sequence Number Range
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Ending Sequence Number**  
**Starting Sequence Number**  
### Record
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Event Name** |  Enumeration, one of:
  * INSERT
  * MODIFY
  * REMOVE

  
**Event Source**  
**Event Version**  
**User Identity**  
### Stream Record
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Approximate Creation Date Time**  
**Sequence Number**  
**Stream View Type** |  Enumeration, one of:
  * NEW_IMAGE
  * OLD_IMAGE
  * NEW_AND_OLD_IMAGES
  * KEYS_ONLY

  
### Identity
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Principal Id**  
### Repeatable In Memory Iterable
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Initial Buffer Size** |  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** |  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** |  The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.  
### Repeatable File Store Iterable
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Max In Memory Size** |  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: |  The unit in which maxInMemorySize is expressed  
### Stream
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
**Stream Label**  
## See Also
MuleSoft Help Center