amazonka-iotwireless-2.0: Amazon IoT Wireless SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IoTWireless.DeleteQueuedMessages

Description

Remove queued messages from the downlink queue.

Synopsis

Creating a Request

data DeleteQueuedMessages Source #

See: newDeleteQueuedMessages smart constructor.

Constructors

DeleteQueuedMessages' 

Fields

  • wirelessDeviceType :: Maybe WirelessDeviceType

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

  • id :: Text

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

  • messageId :: Text

    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.

Instances

Instances details
ToHeaders DeleteQueuedMessages Source # 
Instance details

Defined in Amazonka.IoTWireless.DeleteQueuedMessages

ToPath DeleteQueuedMessages Source # 
Instance details

Defined in Amazonka.IoTWireless.DeleteQueuedMessages

ToQuery DeleteQueuedMessages Source # 
Instance details

Defined in Amazonka.IoTWireless.DeleteQueuedMessages

AWSRequest DeleteQueuedMessages Source # 
Instance details

Defined in Amazonka.IoTWireless.DeleteQueuedMessages

Associated Types

type AWSResponse DeleteQueuedMessages #

Generic DeleteQueuedMessages Source # 
Instance details

Defined in Amazonka.IoTWireless.DeleteQueuedMessages

Associated Types

type Rep DeleteQueuedMessages :: Type -> Type #

Read DeleteQueuedMessages Source # 
Instance details

Defined in Amazonka.IoTWireless.DeleteQueuedMessages

Show DeleteQueuedMessages Source # 
Instance details

Defined in Amazonka.IoTWireless.DeleteQueuedMessages

NFData DeleteQueuedMessages Source # 
Instance details

Defined in Amazonka.IoTWireless.DeleteQueuedMessages

Methods

rnf :: DeleteQueuedMessages -> () #

Eq DeleteQueuedMessages Source # 
Instance details

Defined in Amazonka.IoTWireless.DeleteQueuedMessages

Hashable DeleteQueuedMessages Source # 
Instance details

Defined in Amazonka.IoTWireless.DeleteQueuedMessages

type AWSResponse DeleteQueuedMessages Source # 
Instance details

Defined in Amazonka.IoTWireless.DeleteQueuedMessages

type Rep DeleteQueuedMessages Source # 
Instance details

Defined in Amazonka.IoTWireless.DeleteQueuedMessages

type Rep DeleteQueuedMessages = D1 ('MetaData "DeleteQueuedMessages" "Amazonka.IoTWireless.DeleteQueuedMessages" "amazonka-iotwireless-2.0-Dzx6Wen5AK9DyNP5TQU7zN" 'False) (C1 ('MetaCons "DeleteQueuedMessages'" 'PrefixI 'True) (S1 ('MetaSel ('Just "wirelessDeviceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WirelessDeviceType)) :*: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "messageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDeleteQueuedMessages Source #

Create a value of DeleteQueuedMessages with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:wirelessDeviceType:DeleteQueuedMessages', deleteQueuedMessages_wirelessDeviceType - The wireless device type, which can be either Sidewalk or LoRaWAN.

DeleteQueuedMessages, deleteQueuedMessages_id - The ID of a given wireless device for which downlink messages will be deleted.

DeleteQueuedMessages, deleteQueuedMessages_messageId - 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.

Request Lenses

deleteQueuedMessages_wirelessDeviceType :: Lens' DeleteQueuedMessages (Maybe WirelessDeviceType) Source #

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

deleteQueuedMessages_id :: Lens' DeleteQueuedMessages Text Source #

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

deleteQueuedMessages_messageId :: Lens' DeleteQueuedMessages Text Source #

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.

Destructuring the Response

data DeleteQueuedMessagesResponse Source #

See: newDeleteQueuedMessagesResponse smart constructor.

Constructors

DeleteQueuedMessagesResponse' 

Fields

Instances

Instances details
Generic DeleteQueuedMessagesResponse Source # 
Instance details

Defined in Amazonka.IoTWireless.DeleteQueuedMessages

Associated Types

type Rep DeleteQueuedMessagesResponse :: Type -> Type #

Read DeleteQueuedMessagesResponse Source # 
Instance details

Defined in Amazonka.IoTWireless.DeleteQueuedMessages

Show DeleteQueuedMessagesResponse Source # 
Instance details

Defined in Amazonka.IoTWireless.DeleteQueuedMessages

NFData DeleteQueuedMessagesResponse Source # 
Instance details

Defined in Amazonka.IoTWireless.DeleteQueuedMessages

Eq DeleteQueuedMessagesResponse Source # 
Instance details

Defined in Amazonka.IoTWireless.DeleteQueuedMessages

type Rep DeleteQueuedMessagesResponse Source # 
Instance details

Defined in Amazonka.IoTWireless.DeleteQueuedMessages

type Rep DeleteQueuedMessagesResponse = D1 ('MetaData "DeleteQueuedMessagesResponse" "Amazonka.IoTWireless.DeleteQueuedMessages" "amazonka-iotwireless-2.0-Dzx6Wen5AK9DyNP5TQU7zN" 'False) (C1 ('MetaCons "DeleteQueuedMessagesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteQueuedMessagesResponse Source #

Create a value of DeleteQueuedMessagesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DeleteQueuedMessagesResponse', deleteQueuedMessagesResponse_httpStatus - The response's http status code.

Response Lenses