Class: Aws::IoTManagedIntegrations::Types::CreateManagedThingRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iotmanagedintegrations/types.rb

Constant Summary collapse

SENSITIVE = 
[:owner, :authentication_material, :serial_number, :brand, :model, :classification, :tags]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_material ⇒ String

The authentication material defining the device connectivity setup requests. The authentication materials used are the device bar code.

Returns:

  • (String) 


838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/aws-sdk-iotmanagedintegrations/types.rb', line 838

class CreateManagedThingRequest < Struct.new(
  :role,
  :owner,
  :credential_locker_id,
  :authentication_material,
  :authentication_material_type,
  :serial_number,
  :brand,
  :model,
  :name,
  :capability_report,
  :capability_schemas,
  :capabilities,
  :client_token,
  :classification,
  :tags,
  :meta_data)
  SENSITIVE = [:owner, :authentication_material, :serial_number, :brand, :model, :classification, :tags]
  include Aws::Structure
end

#authentication_material_type ⇒ String

The type of authentication material used for device connectivity setup requests.

Returns:

  • (String) 


838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/aws-sdk-iotmanagedintegrations/types.rb', line 838

class CreateManagedThingRequest < Struct.new(
  :role,
  :owner,
  :credential_locker_id,
  :authentication_material,
  :authentication_material_type,
  :serial_number,
  :brand,
  :model,
  :name,
  :capability_report,
  :capability_schemas,
  :capabilities,
  :client_token,
  :classification,
  :tags,
  :meta_data)
  SENSITIVE = [:owner, :authentication_material, :serial_number, :brand, :model, :classification, :tags]
  include Aws::Structure
end

#brand ⇒ String

The brand of the device.

Returns:

  • (String) 


838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/aws-sdk-iotmanagedintegrations/types.rb', line 838

class CreateManagedThingRequest < Struct.new(
  :role,
  :owner,
  :credential_locker_id,
  :authentication_material,
  :authentication_material_type,
  :serial_number,
  :brand,
  :model,
  :name,
  :capability_report,
  :capability_schemas,
  :capabilities,
  :client_token,
  :classification,
  :tags,
  :meta_data)
  SENSITIVE = [:owner, :authentication_material, :serial_number, :brand, :model, :classification, :tags]
  include Aws::Structure
end

#capabilities ⇒ String

The capabilities of the device such as light bulb.

Returns:

  • (String) 


838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/aws-sdk-iotmanagedintegrations/types.rb', line 838

class CreateManagedThingRequest < Struct.new(
  :role,
  :owner,
  :credential_locker_id,
  :authentication_material,
  :authentication_material_type,
  :serial_number,
  :brand,
  :model,
  :name,
  :capability_report,
  :capability_schemas,
  :capabilities,
  :client_token,
  :classification,
  :tags,
  :meta_data)
  SENSITIVE = [:owner, :authentication_material, :serial_number, :brand, :model, :classification, :tags]
  include Aws::Structure
end

#capability_report ⇒ Types::CapabilityReport

A report of the capabilities for the managed thing.

Returns:



838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/aws-sdk-iotmanagedintegrations/types.rb', line 838

class CreateManagedThingRequest < Struct.new(
  :role,
  :owner,
  :credential_locker_id,
  :authentication_material,
  :authentication_material_type,
  :serial_number,
  :brand,
  :model,
  :name,
  :capability_report,
  :capability_schemas,
  :capabilities,
  :client_token,
  :classification,
  :tags,
  :meta_data)
  SENSITIVE = [:owner, :authentication_material, :serial_number, :brand, :model, :classification, :tags]
  include Aws::Structure
end

#capability_schemas ⇒ Array<Types::CapabilitySchemaItem>

The capability schemas that define the functionality and features supported by the managed thing, including device capabilities and their associated properties.

Returns:



838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/aws-sdk-iotmanagedintegrations/types.rb', line 838

class CreateManagedThingRequest < Struct.new(
  :role,
  :owner,
  :credential_locker_id,
  :authentication_material,
  :authentication_material_type,
  :serial_number,
  :brand,
  :model,
  :name,
  :capability_report,
  :capability_schemas,
  :capabilities,
  :client_token,
  :classification,
  :tags,
  :meta_data)
  SENSITIVE = [:owner, :authentication_material, :serial_number, :brand, :model, :classification, :tags]
  include Aws::Structure
end

#classification ⇒ String

The classification of the managed thing such as light bulb or thermostat.

Returns:

  • (String) 


838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/aws-sdk-iotmanagedintegrations/types.rb', line 838

class CreateManagedThingRequest < Struct.new(
  :role,
  :owner,
  :credential_locker_id,
  :authentication_material,
  :authentication_material_type,
  :serial_number,
  :brand,
  :model,
  :name,
  :capability_report,
  :capability_schemas,
  :capabilities,
  :client_token,
  :classification,
  :tags,
  :meta_data)
  SENSITIVE = [:owner, :authentication_material, :serial_number, :brand, :model, :classification, :tags]
  include Aws::Structure
end

#client_token ⇒ String

An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String) 


838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/aws-sdk-iotmanagedintegrations/types.rb', line 838

class CreateManagedThingRequest < Struct.new(
  :role,
  :owner,
  :credential_locker_id,
  :authentication_material,
  :authentication_material_type,
  :serial_number,
  :brand,
  :model,
  :name,
  :capability_report,
  :capability_schemas,
  :capabilities,
  :client_token,
  :classification,
  :tags,
  :meta_data)
  SENSITIVE = [:owner, :authentication_material, :serial_number, :brand, :model, :classification, :tags]
  include Aws::Structure
end

#credential_locker_id ⇒ String

The identifier of the credential for the managed thing.

Returns:

  • (String) 


838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/aws-sdk-iotmanagedintegrations/types.rb', line 838

class CreateManagedThingRequest < Struct.new(
  :role,
  :owner,
  :credential_locker_id,
  :authentication_material,
  :authentication_material_type,
  :serial_number,
  :brand,
  :model,
  :name,
  :capability_report,
  :capability_schemas,
  :capabilities,
  :client_token,
  :classification,
  :tags,
  :meta_data)
  SENSITIVE = [:owner, :authentication_material, :serial_number, :brand, :model, :classification, :tags]
  include Aws::Structure
end

#meta_data ⇒ Hash<String,String>

The metadata for the managed thing.

<note markdown=“1”> The ‘managedThing` `metadata` parameter is used for associating attributes with a `managedThing` that can be used for grouping over-the-air (OTA) tasks. Name value pairs in `metadata` can be used in the `OtaTargetQueryString` parameter for the `CreateOtaTask` API operation.

</note>

Returns:

  • (Hash<String,String>) 


838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/aws-sdk-iotmanagedintegrations/types.rb', line 838

class CreateManagedThingRequest < Struct.new(
  :role,
  :owner,
  :credential_locker_id,
  :authentication_material,
  :authentication_material_type,
  :serial_number,
  :brand,
  :model,
  :name,
  :capability_report,
  :capability_schemas,
  :capabilities,
  :client_token,
  :classification,
  :tags,
  :meta_data)
  SENSITIVE = [:owner, :authentication_material, :serial_number, :brand, :model, :classification, :tags]
  include Aws::Structure
end

#model ⇒ String

The model of the device.

Returns:

  • (String) 


838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/aws-sdk-iotmanagedintegrations/types.rb', line 838

class CreateManagedThingRequest < Struct.new(
  :role,
  :owner,
  :credential_locker_id,
  :authentication_material,
  :authentication_material_type,
  :serial_number,
  :brand,
  :model,
  :name,
  :capability_report,
  :capability_schemas,
  :capabilities,
  :client_token,
  :classification,
  :tags,
  :meta_data)
  SENSITIVE = [:owner, :authentication_material, :serial_number, :brand, :model, :classification, :tags]
  include Aws::Structure
end

#name ⇒ String

The name of the managed thing representing the physical device.

Returns:

  • (String) 


838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/aws-sdk-iotmanagedintegrations/types.rb', line 838

class CreateManagedThingRequest < Struct.new(
  :role,
  :owner,
  :credential_locker_id,
  :authentication_material,
  :authentication_material_type,
  :serial_number,
  :brand,
  :model,
  :name,
  :capability_report,
  :capability_schemas,
  :capabilities,
  :client_token,
  :classification,
  :tags,
  :meta_data)
  SENSITIVE = [:owner, :authentication_material, :serial_number, :brand, :model, :classification, :tags]
  include Aws::Structure
end

#owner ⇒ String

Owner of the device, usually an indication of whom the device belongs to. This value should not contain personal identifiable information.

Returns:

  • (String) 


838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/aws-sdk-iotmanagedintegrations/types.rb', line 838

class CreateManagedThingRequest < Struct.new(
  :role,
  :owner,
  :credential_locker_id,
  :authentication_material,
  :authentication_material_type,
  :serial_number,
  :brand,
  :model,
  :name,
  :capability_report,
  :capability_schemas,
  :capabilities,
  :client_token,
  :classification,
  :tags,
  :meta_data)
  SENSITIVE = [:owner, :authentication_material, :serial_number, :brand, :model, :classification, :tags]
  include Aws::Structure
end

#role ⇒ String

The type of device used. This will be the hub controller, cloud device, or AWS IoT device.

Returns:

  • (String) 


838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/aws-sdk-iotmanagedintegrations/types.rb', line 838

class CreateManagedThingRequest < Struct.new(
  :role,
  :owner,
  :credential_locker_id,
  :authentication_material,
  :authentication_material_type,
  :serial_number,
  :brand,
  :model,
  :name,
  :capability_report,
  :capability_schemas,
  :capabilities,
  :client_token,
  :classification,
  :tags,
  :meta_data)
  SENSITIVE = [:owner, :authentication_material, :serial_number, :brand, :model, :classification, :tags]
  include Aws::Structure
end

#serial_number ⇒ String

The serial number of the device.

Returns:

  • (String) 


838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/aws-sdk-iotmanagedintegrations/types.rb', line 838

class CreateManagedThingRequest < Struct.new(
  :role,
  :owner,
  :credential_locker_id,
  :authentication_material,
  :authentication_material_type,
  :serial_number,
  :brand,
  :model,
  :name,
  :capability_report,
  :capability_schemas,
  :capabilities,
  :client_token,
  :classification,
  :tags,
  :meta_data)
  SENSITIVE = [:owner, :authentication_material, :serial_number, :brand, :model, :classification, :tags]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A set of key/value pairs that are used to manage the managed thing.

Returns:

  • (Hash<String,String>) 


838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/aws-sdk-iotmanagedintegrations/types.rb', line 838

class CreateManagedThingRequest < Struct.new(
  :role,
  :owner,
  :credential_locker_id,
  :authentication_material,
  :authentication_material_type,
  :serial_number,
  :brand,
  :model,
  :name,
  :capability_report,
  :capability_schemas,
  :capabilities,
  :client_token,
  :classification,
  :tags,
  :meta_data)
  SENSITIVE = [:owner, :authentication_material, :serial_number, :brand, :model, :classification, :tags]
  include Aws::Structure
end