class Aws::IoTEvents::Types::DynamoDBAction

Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the [payload]. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.

You must use expressions for all parameters in `DynamoDBAction`. The expressions accept literals, operators, functions, references, and substitution templates.

Examples

For more information, see [Expressions] in the *AWS IoT Events Developer Guide*.

If the defined payload type is a string, `DynamoDBAction` writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the `payloadField` parameter is `<payload-field>_raw`.

[1]: docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html [2]: docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html

@note When making an API call, you may pass DynamoDBAction

data as a hash:

    {
      hash_key_type: "DynamoKeyType",
      hash_key_field: "DynamoKeyField", # required
      hash_key_value: "DynamoKeyValue", # required
      range_key_type: "DynamoKeyType",
      range_key_field: "DynamoKeyField",
      range_key_value: "DynamoKeyValue",
      operation: "DynamoOperation",
      payload_field: "DynamoKeyField",
      table_name: "DynamoTableName", # required
      payload: {
        content_expression: "ContentExpression", # required
        type: "STRING", # required, accepts STRING, JSON
      },
    }

@!attribute [rw] hash_key_type

The data type for the hash key (also called the partition key). You
can specify the following values:

* `'STRING'` - The hash key is a string.

* `'NUMBER'` - The hash key is a number.

If you don't specify `hashKeyType`, the default value is
`'STRING'`.
@return [String]

@!attribute [rw] hash_key_field

The name of the hash key (also called the partition key). The
`hashKeyField` value must match the partition key of the target
DynamoDB table.
@return [String]

@!attribute [rw] hash_key_value

The value of the hash key (also called the partition key).
@return [String]

@!attribute [rw] range_key_type

The data type for the range key (also called the sort key), You can
specify the following values:

* `'STRING'` - The range key is a string.

* `'NUMBER'` - The range key is number.

If you don't specify `rangeKeyField`, the default value is
`'STRING'`.
@return [String]

@!attribute [rw] range_key_field

The name of the range key (also called the sort key). The
`rangeKeyField` value must match the sort key of the target DynamoDB
table.
@return [String]

@!attribute [rw] range_key_value

The value of the range key (also called the sort key).
@return [String]

@!attribute [rw] operation

The type of operation to perform. You can specify the following
values:

* `'INSERT'` - Insert data as a new item into the DynamoDB table.
  This item uses the specified hash key as a partition key. If you
  specified a range key, the item uses the range key as a sort key.

* `'UPDATE'` - Update an existing item of the DynamoDB table with
  new data. This item's partition key must match the specified hash
  key. If you specified a range key, the range key must match the
  item's sort key.

* `'DELETE'` - Delete an existing item of the DynamoDB table. This
  item's partition key must match the specified hash key. If you
  specified a range key, the range key must match the item's sort
  key.

If you don't specify this parameter, AWS IoT Events triggers the
`'INSERT'` operation.
@return [String]

@!attribute [rw] payload_field

The name of the DynamoDB column that receives the action payload.

If you don't specify this parameter, the name of the DynamoDB
column is `payload`.
@return [String]

@!attribute [rw] table_name

The name of the DynamoDB table. The `tableName` value must match the
table name of the target DynamoDB table.
@return [String]

@!attribute [rw] payload

Information needed to configure the payload.

By default, AWS IoT Events generates a standard payload in JSON for
any action. This action payload contains all attribute-value pairs
that have the information about the detector model instance and the
event triggered the action. To configure the action payload, you can
use `contentExpression`.
@return [Types::Payload]

Constants

SENSITIVE