Class: Aws::IoT::Types::UpdateThingRequest

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 UpdateThingRequest data as a hash:

{
  thing_name: "ThingName", # required
  thing_type_name: "ThingTypeName",
  attribute_payload: {
    attributes: {
      "AttributeName" => "AttributeValue",
    },
    merge: false,
  },
  expected_version: 1,
  remove_thing_type: false,
}

The input for the UpdateThing operation.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_payloadTypes::AttributePayload

A list of thing attributes, a JSON string containing name-value pairs. For example:

\{"attributes":\{"name1":"value2"\}\}

This data is used to add new attributes or update existing attributes.



20134
20135
20136
20137
20138
20139
20140
20141
20142
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 20134

class UpdateThingRequest < Struct.new(
  :thing_name,
  :thing_type_name,
  :attribute_payload,
  :expected_version,
  :remove_thing_type)
  SENSITIVE = []
  include Aws::Structure
end

#expected_versionInteger

The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the UpdateThing request is rejected with a VersionConflictException.

Returns:

  • (Integer)


20134
20135
20136
20137
20138
20139
20140
20141
20142
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 20134

class UpdateThingRequest < Struct.new(
  :thing_name,
  :thing_type_name,
  :attribute_payload,
  :expected_version,
  :remove_thing_type)
  SENSITIVE = []
  include Aws::Structure
end

#remove_thing_typeBoolean

Remove a thing type association. If true, the association is removed.

Returns:

  • (Boolean)


20134
20135
20136
20137
20138
20139
20140
20141
20142
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 20134

class UpdateThingRequest < Struct.new(
  :thing_name,
  :thing_type_name,
  :attribute_payload,
  :expected_version,
  :remove_thing_type)
  SENSITIVE = []
  include Aws::Structure
end

#thing_nameString

The name of the thing to update.

You can't change a thing's name. To change a thing's name, you must create a new thing, give it the new name, and then delete the old thing.

Returns:

  • (String)


20134
20135
20136
20137
20138
20139
20140
20141
20142
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 20134

class UpdateThingRequest < Struct.new(
  :thing_name,
  :thing_type_name,
  :attribute_payload,
  :expected_version,
  :remove_thing_type)
  SENSITIVE = []
  include Aws::Structure
end

#thing_type_nameString

The name of the thing type.

Returns:

  • (String)


20134
20135
20136
20137
20138
20139
20140
20141
20142
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 20134

class UpdateThingRequest < Struct.new(
  :thing_name,
  :thing_type_name,
  :attribute_payload,
  :expected_version,
  :remove_thing_type)
  SENSITIVE = []
  include Aws::Structure
end