AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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
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

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>)

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

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

Returns:

  • (Boolean)

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