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

Class: Aws::IoT1ClickProjects::Types::AssociateDeviceWithPlacementRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/types.rb

Overview

Note:

When making an API call, you may pass AssociateDeviceWithPlacementRequest data as a hash:

{
  project_name: "ProjectName", # required
  placement_name: "PlacementName", # required
  device_id: "DeviceId", # required
  device_template_name: "DeviceTemplateName", # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#device_idString

The ID of the physical device to be associated with the given placement in the project. Note that a mandatory 4 character prefix is required for all deviceId values.

Returns:

  • (String)


40
41
42
43
44
45
46
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/types.rb', line 40

class AssociateDeviceWithPlacementRequest < Struct.new(
  :project_name,
  :placement_name,
  :device_id,
  :device_template_name)
  include Aws::Structure
end

#device_template_nameString

The device template name to associate with the device ID.

Returns:

  • (String)


40
41
42
43
44
45
46
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/types.rb', line 40

class AssociateDeviceWithPlacementRequest < Struct.new(
  :project_name,
  :placement_name,
  :device_id,
  :device_template_name)
  include Aws::Structure
end

#placement_nameString

The name of the placement in which to associate the device.

Returns:

  • (String)


40
41
42
43
44
45
46
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/types.rb', line 40

class AssociateDeviceWithPlacementRequest < Struct.new(
  :project_name,
  :placement_name,
  :device_id,
  :device_template_name)
  include Aws::Structure
end

#project_nameString

The name of the project containing the placement in which to associate the device.

Returns:

  • (String)


40
41
42
43
44
45
46
# File 'gems/aws-sdk-iot1clickprojects/lib/aws-sdk-iot1clickprojects/types.rb', line 40

class AssociateDeviceWithPlacementRequest < Struct.new(
  :project_name,
  :placement_name,
  :device_id,
  :device_template_name)
  include Aws::Structure
end