Class: Aws::IoTEvents::Types::Payload

Inherits:

Struct

• Object
• Struct
• Aws::IoTEvents::Types::Payload

Defined in:

(unknown)

Overview

Note:

When passing Payload as input to an Aws::Client method, you can use a vanilla Hash:

{
  content_expression: "ContentExpression", # required
  type: "STRING", # required, accepts STRING, JSON
}

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.

Returned by:

• DynamoDBAction#payload
• DynamoDBv2Action#payload
• FirehoseAction#payload
• IotEventsAction#payload
• IotTopicPublishAction#payload
• LambdaAction#payload
• SNSTopicPublishAction#payload
• SqsAction#payload

Instance Attribute Summary

• #content_expression ⇒ String

  The content of the payload.

• #type ⇒ String

  The value of the payload type can be either STRING or JSON.

Instance Attribute Details

#content_expression ⇒ String

The content of the payload. You can use a string expression that includes quoted strings ('<string>'), variables ($variable.<variable-name>), input values ($input.<input-name>.<path-to-datum>), string concatenations, and quoted strings that contain ${} as the content. The recommended maximum size of a content expression is 1 KB.

Returns:

• (String) —

  The content of the payload.

#type ⇒ String

The value of the payload type can be either STRING or JSON.

Possible values:

• STRING
• JSON

Returns:

• (String) —

  The value of the payload type can be either STRING or JSON.