libZSservicesZSamazonka-iotevents-dataZSamazonka-iotevents-data
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoTEventsData.BatchPutMessage

Description

Sends a set of messages to the AWS IoT Events system. Each message payload is transformed into the input you specify ("inputName") and ingested into any detectors that monitor that input. If multiple messages are sent, the order in which the messages are processed isn't guaranteed. To guarantee ordering, you must send messages one at a time and wait for a successful response.

Synopsis

Creating a Request

data BatchPutMessage Source #

See: newBatchPutMessage smart constructor.

Constructors

BatchPutMessage' 

Fields

  • messages :: NonEmpty Message

    The list of messages to send. Each message has the following format: '{ "messageId": "string", "inputName": "string", "payload": "string"}'

Instances

Instances details
Eq BatchPutMessage Source # 
Instance details

Defined in Amazonka.IoTEventsData.BatchPutMessage

Methods

(==) :: BatchPutMessage -> BatchPutMessage -> Bool #

(/=) :: BatchPutMessage -> BatchPutMessage -> Bool #

Read BatchPutMessage Source # 
Instance details

Defined in Amazonka.IoTEventsData.BatchPutMessage

Methods

readsPrec :: Int -> ReadS BatchPutMessage #

readList :: ReadS [BatchPutMessage] #

readPrec :: ReadPrec BatchPutMessage #

readListPrec :: ReadPrec [BatchPutMessage] #

Show BatchPutMessage Source # 
Instance details

Defined in Amazonka.IoTEventsData.BatchPutMessage

Methods

showsPrec :: Int -> BatchPutMessage -> ShowS #

show :: BatchPutMessage -> String #

showList :: [BatchPutMessage] -> ShowS #

Generic BatchPutMessage Source # 
Instance details

Defined in Amazonka.IoTEventsData.BatchPutMessage

Associated Types

type Rep BatchPutMessage :: Type -> Type #

Methods

from :: BatchPutMessage -> Rep BatchPutMessage x #

to :: Rep BatchPutMessage x -> BatchPutMessage #

NFData BatchPutMessage Source # 
Instance details

Defined in Amazonka.IoTEventsData.BatchPutMessage

Methods

rnf :: BatchPutMessage -> () #

Hashable BatchPutMessage Source # 
Instance details

Defined in Amazonka.IoTEventsData.BatchPutMessage

Methods

hashWithSalt :: Int -> BatchPutMessage -> Int #

hash :: BatchPutMessage -> Int #

ToJSON BatchPutMessage Source # 
Instance details

Defined in Amazonka.IoTEventsData.BatchPutMessage

Methods

toJSON :: BatchPutMessage -> Value #

toEncoding :: BatchPutMessage -> Encoding #

toJSONList :: [BatchPutMessage] -> Value #

toEncodingList :: [BatchPutMessage] -> Encoding #

AWSRequest BatchPutMessage Source # 
Instance details

Defined in Amazonka.IoTEventsData.BatchPutMessage

Associated Types

type AWSResponse BatchPutMessage #

Methods

request :: BatchPutMessage -> Request BatchPutMessage #

response :: MonadResource m => Logger -> Service -> Proxy BatchPutMessage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse BatchPutMessage))) #

ToHeaders BatchPutMessage Source # 
Instance details

Defined in Amazonka.IoTEventsData.BatchPutMessage

Methods

toHeaders :: BatchPutMessage -> [Header] #

ToPath BatchPutMessage Source # 
Instance details

Defined in Amazonka.IoTEventsData.BatchPutMessage

Methods

toPath :: BatchPutMessage -> ByteString #

ToQuery BatchPutMessage Source # 
Instance details

Defined in Amazonka.IoTEventsData.BatchPutMessage

Methods

toQuery :: BatchPutMessage -> QueryString #

type Rep BatchPutMessage Source # 
Instance details

Defined in Amazonka.IoTEventsData.BatchPutMessage

type Rep BatchPutMessage = D1 ('MetaData "BatchPutMessage" "Amazonka.IoTEventsData.BatchPutMessage" "libZSservicesZSamazonka-iotevents-dataZSamazonka-iotevents-data" 'False) (C1 ('MetaCons "BatchPutMessage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "messages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Message))))
type AWSResponse BatchPutMessage Source # 
Instance details

Defined in Amazonka.IoTEventsData.BatchPutMessage

type AWSResponse BatchPutMessage = BatchPutMessageResponse

newBatchPutMessage Source #

Arguments

:: NonEmpty Message

$sel:messages:BatchPutMessage'

-> BatchPutMessage 

Create a value of BatchPutMessage 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:messages:BatchPutMessage', batchPutMessage_messages - The list of messages to send. Each message has the following format: '{ "messageId": "string", "inputName": "string", "payload": "string"}'

Request Lenses

batchPutMessage_messages :: Lens' BatchPutMessage (NonEmpty Message) Source #

The list of messages to send. Each message has the following format: '{ "messageId": "string", "inputName": "string", "payload": "string"}'

Destructuring the Response

data BatchPutMessageResponse Source #

See: newBatchPutMessageResponse smart constructor.

Constructors

BatchPutMessageResponse' 

Fields

Instances

Instances details
Eq BatchPutMessageResponse Source # 
Instance details

Defined in Amazonka.IoTEventsData.BatchPutMessage

Methods

(==) :: BatchPutMessageResponse -> BatchPutMessageResponse -> Bool #

(/=) :: BatchPutMessageResponse -> BatchPutMessageResponse -> Bool #

Read BatchPutMessageResponse Source # 
Instance details

Defined in Amazonka.IoTEventsData.BatchPutMessage

Methods

readsPrec :: Int -> ReadS BatchPutMessageResponse #

readList :: ReadS [BatchPutMessageResponse] #

readPrec :: ReadPrec BatchPutMessageResponse #

readListPrec :: ReadPrec [BatchPutMessageResponse] #

Show BatchPutMessageResponse Source # 
Instance details

Defined in Amazonka.IoTEventsData.BatchPutMessage

Methods

showsPrec :: Int -> BatchPutMessageResponse -> ShowS #

show :: BatchPutMessageResponse -> String #

showList :: [BatchPutMessageResponse] -> ShowS #

Generic BatchPutMessageResponse Source # 
Instance details

Defined in Amazonka.IoTEventsData.BatchPutMessage

Associated Types

type Rep BatchPutMessageResponse :: Type -> Type #

Methods

from :: BatchPutMessageResponse -> Rep BatchPutMessageResponse x #

to :: Rep BatchPutMessageResponse x -> BatchPutMessageResponse #

NFData BatchPutMessageResponse Source # 
Instance details

Defined in Amazonka.IoTEventsData.BatchPutMessage

Methods

rnf :: BatchPutMessageResponse -> () #

type Rep BatchPutMessageResponse Source # 
Instance details

Defined in Amazonka.IoTEventsData.BatchPutMessage

type Rep BatchPutMessageResponse = D1 ('MetaData "BatchPutMessageResponse" "Amazonka.IoTEventsData.BatchPutMessage" "libZSservicesZSamazonka-iotevents-dataZSamazonka-iotevents-data" 'False) (C1 ('MetaCons "BatchPutMessageResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "batchPutMessageErrorEntries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BatchPutMessageErrorEntry])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newBatchPutMessageResponse Source #

Arguments

:: Int

$sel:httpStatus:BatchPutMessageResponse'

-> BatchPutMessageResponse 

Create a value of BatchPutMessageResponse 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:batchPutMessageErrorEntries:BatchPutMessageResponse', batchPutMessageResponse_batchPutMessageErrorEntries - A list of any errors encountered when sending the messages.

$sel:httpStatus:BatchPutMessageResponse', batchPutMessageResponse_httpStatus - The response's http status code.

Response Lenses

batchPutMessageResponse_batchPutMessageErrorEntries :: Lens' BatchPutMessageResponse (Maybe [BatchPutMessageErrorEntry]) Source #

A list of any errors encountered when sending the messages.

batchPutMessageResponse_httpStatus :: Lens' BatchPutMessageResponse Int Source #

The response's http status code.