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

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

Inherits:

Struct

Object
Struct
Aws::IoT::Types::AttributePayload

show all

Defined in:: (unknown)

Overview

Note:

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

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

The attribute payload.

Returned by:

Instance Attribute Summary collapse

#attributes ⇒ Hash<String,String>
A JSON string containing up to three key-value pair in JSON format.
#merge ⇒ Boolean
Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them.

Instance Attribute Details

#attributes ⇒ `Hash<String,String>`

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

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

Returns:

(Hash<String,String>) —
A JSON string containing up to three key-value pair in JSON format.

#merge ⇒ `Boolean`

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 or UpdateThingGroup.