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

Inherits:

Struct

• Object
• Struct
• Aws::IoTManagedIntegrations::Types::StartDeviceDiscoveryRequest

Defined in:

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

Constant Summary

SENSITIVE =

[:authentication_material, :tags]

Instance Attribute Summary

• #account_association_id ⇒ String

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

• #authentication_material ⇒ String

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

• #authentication_material_type ⇒ String

  The type of authentication material used for device discovery jobs.

• #client_token ⇒ String

  An idempotency token.

• #connector_association_identifier ⇒ String

  The id of the connector association.

• #controller_identifier ⇒ String

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

• #custom_protocol_detail ⇒ Hash<String,String>

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

• #discovery_type ⇒ String

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

• #tags ⇒ Hash<String,String>

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

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)

# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 4590

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)
  SENSITIVE = [:authentication_material, :tags]
  include Aws::Structure
end

#authentication_material ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 4590

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)
  SENSITIVE = [:authentication_material, :tags]
  include Aws::Structure
end

#authentication_material_type ⇒ String

The type of authentication material used for device discovery jobs.

Returns:

• (String)

# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 4590

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)
  SENSITIVE = [:authentication_material, :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.

Returns:

• (String)

# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 4590

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)
  SENSITIVE = [:authentication_material, :tags]
  include Aws::Structure
end

#connector_association_identifier ⇒ String

The id of the connector association.

Returns:

• (String)

# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 4590

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)
  SENSITIVE = [:authentication_material, :tags]
  include Aws::Structure
end

#controller_identifier ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 4590

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)
  SENSITIVE = [:authentication_material, :tags]
  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>)

# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 4590

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)
  SENSITIVE = [:authentication_material, :tags]
  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)

# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 4590

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)
  SENSITIVE = [:authentication_material, :tags]
  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>)

# File 'gems/aws-sdk-iotmanagedintegrations/lib/aws-sdk-iotmanagedintegrations/types.rb', line 4590

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)
  SENSITIVE = [:authentication_material, :tags]
  include Aws::Structure
end