Class: Aws::IoTWireless::Types::ListWirelessDevicesRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoTWireless::Types::ListWirelessDevicesRequest

Defined in:

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

Overview

Note:

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

{
  max_results: 1,
  next_token: "NextToken",
  destination_name: "DestinationName",
  device_profile_id: "DeviceProfileId",
  service_profile_id: "ServiceProfileId",
  wireless_device_type: "Sidewalk", # accepts Sidewalk, LoRaWAN
  fuota_task_id: "FuotaTaskId",
  multicast_group_id: "MulticastGroupId",
}

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #destination_name ⇒ String

  A filter to list only the wireless devices that use this destination.

• #device_profile_id ⇒ String

  A filter to list only the wireless devices that use this device profile.

• #fuota_task_id ⇒ String

  The ID of a FUOTA task.

• #max_results ⇒ Integer

  The maximum number of results to return in this operation.

• #multicast_group_id ⇒ String

  The ID of the multicast group.

• #next_token ⇒ String

  To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

• #service_profile_id ⇒ String

  A filter to list only the wireless devices that use this service profile.

• #wireless_device_type ⇒ String

  A filter to list only the wireless devices that use this wireless device type.

Instance Attribute Details

#destination_name ⇒ String

A filter to list only the wireless devices that use this destination.

Returns:

• (String)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 3375

class ListWirelessDevicesRequest < Struct.new(
  :max_results,
  :next_token,
  :destination_name,
  :device_profile_id,
  :service_profile_id,
  :wireless_device_type,
  :fuota_task_id,
  :multicast_group_id)
  SENSITIVE = []
  include Aws::Structure
end

#device_profile_id ⇒ String

A filter to list only the wireless devices that use this device profile.

Returns:

• (String)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 3375

class ListWirelessDevicesRequest < Struct.new(
  :max_results,
  :next_token,
  :destination_name,
  :device_profile_id,
  :service_profile_id,
  :wireless_device_type,
  :fuota_task_id,
  :multicast_group_id)
  SENSITIVE = []
  include Aws::Structure
end

#fuota_task_id ⇒ String

The ID of a FUOTA task.

Returns:

• (String)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 3375

class ListWirelessDevicesRequest < Struct.new(
  :max_results,
  :next_token,
  :destination_name,
  :device_profile_id,
  :service_profile_id,
  :wireless_device_type,
  :fuota_task_id,
  :multicast_group_id)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return in this operation.

Returns:

• (Integer)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 3375

class ListWirelessDevicesRequest < Struct.new(
  :max_results,
  :next_token,
  :destination_name,
  :device_profile_id,
  :service_profile_id,
  :wireless_device_type,
  :fuota_task_id,
  :multicast_group_id)
  SENSITIVE = []
  include Aws::Structure
end

#multicast_group_id ⇒ String

The ID of the multicast group.

Returns:

• (String)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 3375

class ListWirelessDevicesRequest < Struct.new(
  :max_results,
  :next_token,
  :destination_name,
  :device_profile_id,
  :service_profile_id,
  :wireless_device_type,
  :fuota_task_id,
  :multicast_group_id)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Returns:

• (String)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 3375

class ListWirelessDevicesRequest < Struct.new(
  :max_results,
  :next_token,
  :destination_name,
  :device_profile_id,
  :service_profile_id,
  :wireless_device_type,
  :fuota_task_id,
  :multicast_group_id)
  SENSITIVE = []
  include Aws::Structure
end

#service_profile_id ⇒ String

A filter to list only the wireless devices that use this service profile.

Returns:

• (String)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 3375

class ListWirelessDevicesRequest < Struct.new(
  :max_results,
  :next_token,
  :destination_name,
  :device_profile_id,
  :service_profile_id,
  :wireless_device_type,
  :fuota_task_id,
  :multicast_group_id)
  SENSITIVE = []
  include Aws::Structure
end

#wireless_device_type ⇒ String

A filter to list only the wireless devices that use this wireless device type.

Returns:

• (String)

# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 3375

class ListWirelessDevicesRequest < Struct.new(
  :max_results,
  :next_token,
  :destination_name,
  :device_profile_id,
  :service_profile_id,
  :wireless_device_type,
  :fuota_task_id,
  :multicast_group_id)
  SENSITIVE = []
  include Aws::Structure
end