DynamoDBAction - Amazon IoT
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

DynamoDBAction

Describes an action to write to a DynamoDB table.

The tableName, hashKeyField, and rangeKeyField values must match the values used when you created the table.

The hashKeyValue and rangeKeyvalue fields use a substitution template syntax. These templates provide data at runtime. The syntax is as follows: ${sql-expression}.

You can specify any valid expression in a WHERE or SELECT clause, including JSON properties, comparisons, calculations, and functions. For example, the following field uses the third level of the topic:

"hashKeyValue": "${topic(3)}"

The following field uses the timestamp:

"rangeKeyValue": "${timestamp()}"

Contents

hashKeyField

The hash key name.

Type: String

Required: Yes

hashKeyType

The hash key type. Valid values are "STRING" or "NUMBER"

Type: String

Valid Values: STRING | NUMBER

Required: No

hashKeyValue

The hash key value.

Type: String

Required: Yes

operation

The type of operation to be performed. This follows the substitution template, so it can be ${operation}, but the substitution must result in one of the following: INSERT, UPDATE, or DELETE.

Type: String

Required: No

payloadField

The action payload. This name can be customized.

Type: String

Required: No

rangeKeyField

The range key name.

Type: String

Required: No

rangeKeyType

The range key type. Valid values are "STRING" or "NUMBER"

Type: String

Valid Values: STRING | NUMBER

Required: No

rangeKeyValue

The range key value.

Type: String

Required: No

roleArn

The ARN of the IAM role that grants access to the DynamoDB table.

Type: String

Required: Yes

tableName

The name of the DynamoDB table.

Type: String

Required: Yes

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: