Class: Aws::IoT::Types::DescribeThingResponse

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::DescribeThingResponse

Defined in:

gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Overview

The output from the DescribeThing operation.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #attributes ⇒ Hash<String,String>

  The thing attributes.

• #billing_group_name ⇒ String

  The name of the billing group the thing belongs to.

• #default_client_id ⇒ String

  The default MQTT client ID.

• #thing_arn ⇒ String

  The ARN of the thing to describe.

• #thing_id ⇒ String

  The ID of the thing to describe.

• #thing_name ⇒ String

  The name of the thing.

• #thing_type_name ⇒ String

  The thing type name.

• #version ⇒ Integer

  The current version of the thing record in the registry.

Instance Attribute Details

#attributes ⇒ Hash<String,String>

The thing attributes.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7308

class DescribeThingResponse < Struct.new(
  :default_client_id,
  :thing_name,
  :thing_id,
  :thing_arn,
  :thing_type_name,
  :attributes,
  :version,
  :billing_group_name)
  SENSITIVE = []
  include Aws::Structure
end

#billing_group_name ⇒ String

The name of the billing group the thing belongs to.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7308

class DescribeThingResponse < Struct.new(
  :default_client_id,
  :thing_name,
  :thing_id,
  :thing_arn,
  :thing_type_name,
  :attributes,
  :version,
  :billing_group_name)
  SENSITIVE = []
  include Aws::Structure
end

#default_client_id ⇒ String

The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.

This lets you better organize your IoT fleet without removing the flexibility of the underlying device certificate model or shadows.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7308

class DescribeThingResponse < Struct.new(
  :default_client_id,
  :thing_name,
  :thing_id,
  :thing_arn,
  :thing_type_name,
  :attributes,
  :version,
  :billing_group_name)
  SENSITIVE = []
  include Aws::Structure
end

#thing_arn ⇒ String

The ARN of the thing to describe.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7308

class DescribeThingResponse < Struct.new(
  :default_client_id,
  :thing_name,
  :thing_id,
  :thing_arn,
  :thing_type_name,
  :attributes,
  :version,
  :billing_group_name)
  SENSITIVE = []
  include Aws::Structure
end

#thing_id ⇒ String

The ID of the thing to describe.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7308

class DescribeThingResponse < Struct.new(
  :default_client_id,
  :thing_name,
  :thing_id,
  :thing_arn,
  :thing_type_name,
  :attributes,
  :version,
  :billing_group_name)
  SENSITIVE = []
  include Aws::Structure
end

#thing_name ⇒ String

The name of the thing.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7308

class DescribeThingResponse < Struct.new(
  :default_client_id,
  :thing_name,
  :thing_id,
  :thing_arn,
  :thing_type_name,
  :attributes,
  :version,
  :billing_group_name)
  SENSITIVE = []
  include Aws::Structure
end

#thing_type_name ⇒ String

The thing type name.

Returns:

• (String)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7308

class DescribeThingResponse < Struct.new(
  :default_client_id,
  :thing_name,
  :thing_id,
  :thing_arn,
  :thing_type_name,
  :attributes,
  :version,
  :billing_group_name)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ Integer

The current version of the thing record in the registry.

To avoid unintentional changes to the information in the registry, you can pass the version information in the expectedVersion parameter of the UpdateThing and DeleteThing calls.

Returns:

• (Integer)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 7308

class DescribeThingResponse < Struct.new(
  :default_client_id,
  :thing_name,
  :thing_id,
  :thing_arn,
  :thing_type_name,
  :attributes,
  :version,
  :billing_group_name)
  SENSITIVE = []
  include Aws::Structure
end