You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

  • Object
show all
Defined in:



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:

Instance Attribute Summary collapse

Instance Attribute Details


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.


  • (String)

    The content of the payload.


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

Possible values:

  • JSON


  • (String)

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