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

Class: Aws::IoTEvents::Types::Attribute

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb

Overview

Note:

When making an API call, you may pass Attribute data as a hash:

{
  json_path: "AttributeJsonPath", # required
}

The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the condition expressions used by detectors.

Instance Attribute Summary collapse

Instance Attribute Details

#json_pathString

An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to the AWS IoT Events system (BatchPutMessage). Each such message contains a JSON payload, and the attribute (and its paired value) specified here are available for use in the "condition" expressions used by detectors.

Syntax: <field-name>.<field-name>...

Returns:

  • (String)


138
139
140
141
# File 'gems/aws-sdk-iotevents/lib/aws-sdk-iotevents/types.rb', line 138

class Attribute < Struct.new(
  :json_path)
  include Aws::Structure
end