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

Class: Aws::IoT::Types::AttributePayload

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

Overview

Note:

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

{
  attributes: {
    "AttributeName" => "AttributeValue",
  },
  merge: false,
}

The attribute payload.

Instance Attribute Summary collapse

Instance Attribute Details

#attributesHash<String,String>

A JSON string containing up to three key-value pair in JSON format. For example:

\{"attributes":\{"string1":"string2"\}\}

Returns:

  • (Hash<String,String>)


392
393
394
395
396
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 392

class AttributePayload < Struct.new(
  :attributes,
  :merge)
  include Aws::Structure
end

#mergeBoolean

Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them.

To remove an attribute, call UpdateThing with an empty attribute value.

The merge attribute is only valid when calling UpdateThing.

Returns:

  • (Boolean)


392
393
394
395
396
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 392

class AttributePayload < Struct.new(
  :attributes,
  :merge)
  include Aws::Structure
end