libZSservicesZSamazonka-iot-analyticsZSamazonka-iot-analytics
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.IoTAnalytics.BatchPutMessage

Description

Sends messages to a channel.

Synopsis

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
Eq BatchPutMessage Source # 
Instance details

Defined in Amazonka.IoTAnalytics.BatchPutMessage

Read BatchPutMessage Source # 
Instance details

Defined in Amazonka.IoTAnalytics.BatchPutMessage

Show BatchPutMessage Source # 
Instance details

Defined in Amazonka.IoTAnalytics.BatchPutMessage

Generic BatchPutMessage Source # 
Instance details

Defined in Amazonka.IoTAnalytics.BatchPutMessage

Associated Types

type Rep BatchPutMessage :: Type -> Type #

NFData BatchPutMessage Source # 
Instance details

Defined in Amazonka.IoTAnalytics.BatchPutMessage

Methods

rnf :: BatchPutMessage -> () #

Hashable BatchPutMessage Source # 
Instance details

Defined in Amazonka.IoTAnalytics.BatchPutMessage

ToJSON BatchPutMessage Source # 
Instance details

Defined in Amazonka.IoTAnalytics.BatchPutMessage

AWSRequest BatchPutMessage Source # 
Instance details

Defined in Amazonka.IoTAnalytics.BatchPutMessage

Associated Types

type AWSResponse BatchPutMessage #

ToHeaders BatchPutMessage Source # 
Instance details

Defined in Amazonka.IoTAnalytics.BatchPutMessage

ToPath BatchPutMessage Source # 
Instance details

Defined in Amazonka.IoTAnalytics.BatchPutMessage

ToQuery BatchPutMessage Source # 
Instance details

Defined in Amazonka.IoTAnalytics.BatchPutMessage

type Rep BatchPutMessage Source # 
Instance details

Defined in Amazonka.IoTAnalytics.BatchPutMessage

type Rep BatchPutMessage = D1 ('MetaData "BatchPutMessage" "Amazonka.IoTAnalytics.BatchPutMessage" "libZSservicesZSamazonka-iot-analyticsZSamazonka-iot-analytics" 'False) (C1 ('MetaCons "BatchPutMessage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "channelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "messages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Message])))
type AWSResponse BatchPutMessage Source # 
Instance details

Defined in Amazonka.IoTAnalytics.BatchPutMessage

newBatchPutMessage Source #

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:channelName: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

Instances

Instances details
Eq BatchPutMessageResponse Source # 
Instance details

Defined in Amazonka.IoTAnalytics.BatchPutMessage

Read BatchPutMessageResponse Source # 
Instance details

Defined in Amazonka.IoTAnalytics.BatchPutMessage

Show BatchPutMessageResponse Source # 
Instance details

Defined in Amazonka.IoTAnalytics.BatchPutMessage

Generic BatchPutMessageResponse Source # 
Instance details

Defined in Amazonka.IoTAnalytics.BatchPutMessage

Associated Types

type Rep BatchPutMessageResponse :: Type -> Type #

NFData BatchPutMessageResponse Source # 
Instance details

Defined in Amazonka.IoTAnalytics.BatchPutMessage

Methods

rnf :: BatchPutMessageResponse -> () #

type Rep BatchPutMessageResponse Source # 
Instance details

Defined in Amazonka.IoTAnalytics.BatchPutMessage

type Rep BatchPutMessageResponse = D1 ('MetaData "BatchPutMessageResponse" "Amazonka.IoTAnalytics.BatchPutMessage" "libZSservicesZSamazonka-iot-analyticsZSamazonka-iot-analytics" '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 #

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.