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

Inherits:

Struct

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

Defined in:

gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb

Overview

Note:

When making an API call, you may pass Payload data as a 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.

Constant Summary

SENSITIVE =

[]

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)

# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 5088

class Payload < Struct.new(
  :content_expression,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 5088

class Payload < Struct.new(
  :content_expression,
  :type)
  SENSITIVE = []
  include Aws::Structure
end