Class: Aws::IoTManagedIntegrations::Types::StartDeviceDiscoveryRequest

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

Constant Summary collapse

SENSITIVE = 
[:authentication_material, :tags, :connector_device_id_list]

Instance Attribute Summary collapse

Instance Attribute Details

#account_association_id ⇒ String

The identifier of the cloud-to-cloud account association to use for discovery of third-party devices.

Returns:

  • (String) 


4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 4752

class StartDeviceDiscoveryRequest < Struct.new(
  :discovery_type,
  :custom_protocol_detail,
  :controller_identifier,
  :connector_association_identifier,
  :account_association_id,
  :authentication_material,
  :authentication_material_type,
  :client_token,
  :tags,
  :connector_device_id_list,
  :protocol,
  :end_device_identifier)
  SENSITIVE = [:authentication_material, :tags, :connector_device_id_list]
  include Aws::Structure
end

#authentication_material ⇒ String

The authentication material required to start the local device discovery job request.

Returns:

  • (String) 


4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 4752

class StartDeviceDiscoveryRequest < Struct.new(
  :discovery_type,
  :custom_protocol_detail,
  :controller_identifier,
  :connector_association_identifier,
  :account_association_id,
  :authentication_material,
  :authentication_material_type,
  :client_token,
  :tags,
  :connector_device_id_list,
  :protocol,
  :end_device_identifier)
  SENSITIVE = [:authentication_material, :tags, :connector_device_id_list]
  include Aws::Structure
end

#authentication_material_type ⇒ String

The type of authentication material used for device discovery jobs.

Returns:

  • (String) 


4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 4752

class StartDeviceDiscoveryRequest < Struct.new(
  :discovery_type,
  :custom_protocol_detail,
  :controller_identifier,
  :connector_association_identifier,
  :account_association_id,
  :authentication_material,
  :authentication_material_type,
  :client_token,
  :tags,
  :connector_device_id_list,
  :protocol,
  :end_device_identifier)
  SENSITIVE = [:authentication_material, :tags, :connector_device_id_list]
  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.

Returns:

  • (String) 


4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 4752

class StartDeviceDiscoveryRequest < Struct.new(
  :discovery_type,
  :custom_protocol_detail,
  :controller_identifier,
  :connector_association_identifier,
  :account_association_id,
  :authentication_material,
  :authentication_material_type,
  :client_token,
  :tags,
  :connector_device_id_list,
  :protocol,
  :end_device_identifier)
  SENSITIVE = [:authentication_material, :tags, :connector_device_id_list]
  include Aws::Structure
end

#connector_association_identifier ⇒ String

The id of the connector association.

Returns:

  • (String) 


4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 4752

class StartDeviceDiscoveryRequest < Struct.new(
  :discovery_type,
  :custom_protocol_detail,
  :controller_identifier,
  :connector_association_identifier,
  :account_association_id,
  :authentication_material,
  :authentication_material_type,
  :client_token,
  :tags,
  :connector_device_id_list,
  :protocol,
  :end_device_identifier)
  SENSITIVE = [:authentication_material, :tags, :connector_device_id_list]
  include Aws::Structure
end

#connector_device_id_list ⇒ Array<String>

Used as a filter for PLA discoveries.

Returns:

  • (Array<String>) 


4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 4752

class StartDeviceDiscoveryRequest < Struct.new(
  :discovery_type,
  :custom_protocol_detail,
  :controller_identifier,
  :connector_association_identifier,
  :account_association_id,
  :authentication_material,
  :authentication_material_type,
  :client_token,
  :tags,
  :connector_device_id_list,
  :protocol,
  :end_device_identifier)
  SENSITIVE = [:authentication_material, :tags, :connector_device_id_list]
  include Aws::Structure
end

#controller_identifier ⇒ String

The id of the end-user's IoT hub.

Returns:

  • (String) 


4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 4752

class StartDeviceDiscoveryRequest < Struct.new(
  :discovery_type,
  :custom_protocol_detail,
  :controller_identifier,
  :connector_association_identifier,
  :account_association_id,
  :authentication_material,
  :authentication_material_type,
  :client_token,
  :tags,
  :connector_device_id_list,
  :protocol,
  :end_device_identifier)
  SENSITIVE = [:authentication_material, :tags, :connector_device_id_list]
  include Aws::Structure
end

#custom_protocol_detail ⇒ Hash<String,String>

Additional protocol-specific details required for device discovery, which vary based on the discovery type.

For a DiscoveryType of CUSTOM, the string-to-string map must have a key value of Name set to a non-empty-string.

Returns:

  • (Hash<String,String>) 


4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 4752

class StartDeviceDiscoveryRequest < Struct.new(
  :discovery_type,
  :custom_protocol_detail,
  :controller_identifier,
  :connector_association_identifier,
  :account_association_id,
  :authentication_material,
  :authentication_material_type,
  :client_token,
  :tags,
  :connector_device_id_list,
  :protocol,
  :end_device_identifier)
  SENSITIVE = [:authentication_material, :tags, :connector_device_id_list]
  include Aws::Structure
end

#discovery_type ⇒ String

The discovery type supporting the type of device to be discovered in the device discovery task request.

Returns:

  • (String) 


4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 4752

class StartDeviceDiscoveryRequest < Struct.new(
  :discovery_type,
  :custom_protocol_detail,
  :controller_identifier,
  :connector_association_identifier,
  :account_association_id,
  :authentication_material,
  :authentication_material_type,
  :client_token,
  :tags,
  :connector_device_id_list,
  :protocol,
  :end_device_identifier)
  SENSITIVE = [:authentication_material, :tags, :connector_device_id_list]
  include Aws::Structure
end

#end_device_identifier ⇒ String

The unique id of the end device for capability rediscovery.

This parameter is only available when the discovery type is CONTROLLER_CAPABILITY_REDISCOVERY.

Returns:

  • (String) 


4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 4752

class StartDeviceDiscoveryRequest < Struct.new(
  :discovery_type,
  :custom_protocol_detail,
  :controller_identifier,
  :connector_association_identifier,
  :account_association_id,
  :authentication_material,
  :authentication_material_type,
  :client_token,
  :tags,
  :connector_device_id_list,
  :protocol,
  :end_device_identifier)
  SENSITIVE = [:authentication_material, :tags, :connector_device_id_list]
  include Aws::Structure
end

#protocol ⇒ String

The protocol type for capability rediscovery (ZWAVE, ZIGBEE, or CUSTOM).

This parameter is only available when the discovery type is CONTROLLER_CAPABILITY_REDISCOVERY.

Returns:

  • (String) 


4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 4752

class StartDeviceDiscoveryRequest < Struct.new(
  :discovery_type,
  :custom_protocol_detail,
  :controller_identifier,
  :connector_association_identifier,
  :account_association_id,
  :authentication_material,
  :authentication_material_type,
  :client_token,
  :tags,
  :connector_device_id_list,
  :protocol,
  :end_device_identifier)
  SENSITIVE = [:authentication_material, :tags, :connector_device_id_list]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

A set of key/value pairs that are used to manage the device discovery request.

Returns:

  • (Hash<String,String>) 


4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
 
# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 4752

class StartDeviceDiscoveryRequest < Struct.new(
  :discovery_type,
  :custom_protocol_detail,
  :controller_identifier,
  :connector_association_identifier,
  :account_association_id,
  :authentication_material,
  :authentication_material_type,
  :client_token,
  :tags,
  :connector_device_id_list,
  :protocol,
  :end_device_identifier)
  SENSITIVE = [:authentication_material, :tags, :connector_device_id_list]
  include Aws::Structure
end