Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IoTAnalytics.BatchPutMessage

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Sends messages to a channel.

Creating a Request

data BatchPutMessage Source #

See: newBatchPutMessage smart constructor.

Constructors

BatchPutMessage'

Fields

channelName :: Text
The name of the channel where the messages are sent.
messages :: [Message]
The list of messages to be sent. Each message has the format: { "messageId": "string", "payload": "string"}.
The field names of message payloads (data) that you send to IoT Analytics:
- Must contain only alphanumeric characters and undescores (_). No other special characters are allowed.
- Must begin with an alphabetic character or single underscore (_).
- Cannot contain hyphens (-).
- In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".
- Cannot be more than 255 characters.
- Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.)
For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01": 29} are invalid in message payloads.

Instances

Instances details

ToJSON BatchPutMessage Source #
Instance details Defined in Amazonka.IoTAnalytics.BatchPutMessage Methods toJSON :: BatchPutMessage -> Value # toEncoding :: BatchPutMessage -> Encoding # toJSONList :: [BatchPutMessage] -> Value # toEncodingList :: [BatchPutMessage] -> Encoding #
ToHeaders BatchPutMessage Source #
Instance details Defined in Amazonka.IoTAnalytics.BatchPutMessage Methods toHeaders :: BatchPutMessage -> [Header] #
ToPath BatchPutMessage Source #
Instance details Defined in Amazonka.IoTAnalytics.BatchPutMessage Methods toPath :: BatchPutMessage -> ByteString #
ToQuery BatchPutMessage Source #
Instance details Defined in Amazonka.IoTAnalytics.BatchPutMessage Methods toQuery :: BatchPutMessage -> QueryString #
AWSRequest BatchPutMessage Source #
Instance details Defined in Amazonka.IoTAnalytics.BatchPutMessage Associated Types type AWSResponse BatchPutMessage # Methods request :: (Service -> Service) -> BatchPutMessage -> Request BatchPutMessage # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy BatchPutMessage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse BatchPutMessage))) #
Generic BatchPutMessage Source #
Instance details Defined in Amazonka.IoTAnalytics.BatchPutMessage Associated Types type Rep BatchPutMessage :: Type -> Type # Methods from :: BatchPutMessage -> Rep BatchPutMessage x # to :: Rep BatchPutMessage x -> BatchPutMessage #
Read BatchPutMessage Source #
Instance details Defined in Amazonka.IoTAnalytics.BatchPutMessage Methods readsPrec :: Int -> ReadS BatchPutMessage # readList :: ReadS [BatchPutMessage] # readPrec :: ReadPrec BatchPutMessage # readListPrec :: ReadPrec [BatchPutMessage] #
Show BatchPutMessage Source #
Instance details Defined in Amazonka.IoTAnalytics.BatchPutMessage Methods showsPrec :: Int -> BatchPutMessage -> ShowS # show :: BatchPutMessage -> String # showList :: [BatchPutMessage] -> ShowS #
NFData BatchPutMessage Source #
Instance details Defined in Amazonka.IoTAnalytics.BatchPutMessage Methods rnf :: BatchPutMessage -> () #
Eq BatchPutMessage Source #
Instance details Defined in Amazonka.IoTAnalytics.BatchPutMessage Methods (==) :: BatchPutMessage -> BatchPutMessage -> Bool # (/=) :: BatchPutMessage -> BatchPutMessage -> Bool #
Hashable BatchPutMessage Source #
Instance details Defined in Amazonka.IoTAnalytics.BatchPutMessage Methods hashWithSalt :: Int -> BatchPutMessage -> Int # hash :: BatchPutMessage -> Int #
type AWSResponse BatchPutMessage Source #
Instance details Defined in Amazonka.IoTAnalytics.BatchPutMessage type AWSResponse BatchPutMessage = BatchPutMessageResponse
type Rep BatchPutMessage Source #
Instance details Defined in Amazonka.IoTAnalytics.BatchPutMessage type Rep BatchPutMessage = D1 ('MetaData "BatchPutMessage" "Amazonka.IoTAnalytics.BatchPutMessage" "amazonka-iot-analytics-2.0-2pxFb0PbSzA9ccOL4CofY4" 'False) (C1 ('MetaCons "BatchPutMessage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "messages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Message])))

newBatchPutMessage Source #

Arguments

:: Text	`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:

BatchPutMessage, batchPutMessage_channelName - The name of the channel where the messages are sent.

$sel:messages:BatchPutMessage', batchPutMessage_messages - The list of messages to be sent. Each message has the format: { "messageId": "string", "payload": "string"}.

The field names of message payloads (data) that you send to IoT Analytics:

Must contain only alphanumeric characters and undescores (_). No other special characters are allowed.
Must begin with an alphabetic character or single underscore (_).
Cannot contain hyphens (-).
In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".
Cannot be more than 255 characters.
Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.)

For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01": 29} are invalid in message payloads.

Request Lenses

batchPutMessage_channelName :: Lens' BatchPutMessage Text Source #

The name of the channel where the messages are sent.

batchPutMessage_messages :: Lens' BatchPutMessage [Message] Source #

The list of messages to be sent. Each message has the format: { "messageId": "string", "payload": "string"}.

The field names of message payloads (data) that you send to IoT Analytics:

Must contain only alphanumeric characters and undescores (_). No other special characters are allowed.
Must begin with an alphabetic character or single underscore (_).
Cannot contain hyphens (-).
In regular expression terms: "^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$".
Cannot be more than 255 characters.
Are case insensitive. (Fields named foo and FOO in the same payload are considered duplicates.)

For example, {"temp_01": 29} or {"_temp_01": 29} are valid, but {"temp-01": 29}, {"01_temp": 29} or {"__temp_01": 29} are invalid in message payloads.

Destructuring the Response

data BatchPutMessageResponse Source #

See: newBatchPutMessageResponse smart constructor.

Constructors

BatchPutMessageResponse'
Fields batchPutMessageErrorEntries :: Maybe [BatchPutMessageErrorEntry] A list of any errors encountered when sending the messages to the channel. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic BatchPutMessageResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.BatchPutMessage Associated Types type Rep BatchPutMessageResponse :: Type -> Type # Methods from :: BatchPutMessageResponse -> Rep BatchPutMessageResponse x # to :: Rep BatchPutMessageResponse x -> BatchPutMessageResponse #
Read BatchPutMessageResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.BatchPutMessage Methods readsPrec :: Int -> ReadS BatchPutMessageResponse # readList :: ReadS [BatchPutMessageResponse] # readPrec :: ReadPrec BatchPutMessageResponse # readListPrec :: ReadPrec [BatchPutMessageResponse] #
Show BatchPutMessageResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.BatchPutMessage Methods showsPrec :: Int -> BatchPutMessageResponse -> ShowS # show :: BatchPutMessageResponse -> String # showList :: [BatchPutMessageResponse] -> ShowS #
NFData BatchPutMessageResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.BatchPutMessage Methods rnf :: BatchPutMessageResponse -> () #
Eq BatchPutMessageResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.BatchPutMessage Methods (==) :: BatchPutMessageResponse -> BatchPutMessageResponse -> Bool # (/=) :: BatchPutMessageResponse -> BatchPutMessageResponse -> Bool #
type Rep BatchPutMessageResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.BatchPutMessage type Rep BatchPutMessageResponse = D1 ('MetaData "BatchPutMessageResponse" "Amazonka.IoTAnalytics.BatchPutMessage" "amazonka-iot-analytics-2.0-2pxFb0PbSzA9ccOL4CofY4" '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 to the channel.

$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 to the channel.

batchPutMessageResponse_httpStatus :: Lens' BatchPutMessageResponse Int Source #

The response's http status code.