You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoTAnalytics::Types::BatchPutMessageRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing BatchPutMessageRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  channel_name: "ChannelName", # required
  messages: [ # required
    {
      message_id: "MessageId", # required
      payload: "data", # required
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#channel_nameString

The name of the channel where the messages are sent.

Returns:

  • (String)

    The name of the channel where the messages are sent.

#messagesArray<Types::Message>

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

Note that the field names of message payloads (data) that you send to AWS 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 greater than 255 characters.

  • Are case-insensitive. (Fields named \"foo\" and \"FOO\" in the same payload are considered duplicates.)

For example, 29 or 29 are valid, but 29, 29 or 29 are invalid in message payloads.

Returns: