Class: Aws::IoTWireless::Types::DeleteQueuedMessagesRequest

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 DeleteQueuedMessagesRequest data as a hash:

{
  id: "WirelessDeviceId", # required
  message_id: "MessageId", # required
  wireless_device_type: "Sidewalk", # accepts Sidewalk, LoRaWAN
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#idString

The ID of a given wireless device for which downlink messages will be deleted.

Returns:

  • (String)


1330
1331
1332
1333
1334
1335
1336
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 1330

class DeleteQueuedMessagesRequest < Struct.new(
  :id,
  :message_id,
  :wireless_device_type)
  SENSITIVE = []
  include Aws::Structure
end

#message_idString

If message ID is "*", it cleares the entire downlink queue for a given device, specified by the wireless device ID. Otherwise, the downlink message with the specified message ID will be deleted.

Returns:

  • (String)


1330
1331
1332
1333
1334
1335
1336
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 1330

class DeleteQueuedMessagesRequest < Struct.new(
  :id,
  :message_id,
  :wireless_device_type)
  SENSITIVE = []
  include Aws::Structure
end

#wireless_device_typeString

The wireless device type, which can be either Sidewalk or LoRaWAN.

Returns:

  • (String)


1330
1331
1332
1333
1334
1335
1336
# File 'gems/aws-sdk-iotwireless/lib/aws-sdk-iotwireless/types.rb', line 1330

class DeleteQueuedMessagesRequest < Struct.new(
  :id,
  :message_id,
  :wireless_device_type)
  SENSITIVE = []
  include Aws::Structure
end