/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::IoTEvents::DynamoDBAction

NAME

Paws::IoTEvents::DynamoDBAction

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::IoTEvents::DynamoDBAction object:

$service_obj->Method(Att1 => { HashKeyField => $value, ..., TableName => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::IoTEvents::DynamoDBAction object:

$result = $service_obj->Method(...);
$result->Att1->HashKeyField

DESCRIPTION

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 (https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html). 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 literal values, the expressions must contain single quotes. For example, the value for the hashKeyType parameter can be 'STRING'.

  • For references, you must specify either variables or input values. For example, the value for the hashKeyField parameter can be $input.GreenhouseInput.name.

  • For a substitution template, you must use ${}, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.

    In the following example, the value for the hashKeyValue parameter uses a substitution template.

    '${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'

  • For a string concatenation, you must use +. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.

    In the following example, the value for the tableName parameter uses a string concatenation.

    'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date

For more information, see Expressions (https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) 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.

ATTRIBUTES

REQUIRED HashKeyField => Str

The name of the hash key (also called the partition key). The hashKeyField value must match the partition key of the target DynamoDB table.

HashKeyType => Str

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'.

REQUIRED HashKeyValue => Str

The value of the hash key (also called the partition key).

Operation => Str

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.

Payload => Paws::IoTEvents::Payload

PayloadField => Str

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.

RangeKeyField => Str

The name of the range key (also called the sort key). The rangeKeyField value must match the sort key of the target DynamoDB table.

RangeKeyType => Str

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'.

RangeKeyValue => Str

The value of the range key (also called the sort key).

REQUIRED TableName => Str

The name of the DynamoDB table. The tableName value must match the table name of the target DynamoDB table.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::IoTEvents

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues