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

Inherits:
Struct
  • Object
show all
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 collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#destination_nameString

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

Returns:

  • (String)


3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
# 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_idString

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

Returns:

  • (String)


3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
# 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_idString

The ID of a FUOTA task.

Returns:

  • (String)


3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
# 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_resultsInteger

The maximum number of results to return in this operation.

Returns:

  • (Integer)


3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
# 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_idString

The ID of the multicast group.

Returns:

  • (String)


3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
# 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_tokenString

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)


3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
# 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_idString

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

Returns:

  • (String)


3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
# 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_typeString

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

Returns:

  • (String)


3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
# 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