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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb

Overview

Note:

When making an API call, you may pass BatchPutMessageRequest data as a 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)


116
117
118
119
120
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 116

class BatchPutMessageRequest < Struct.new(
  :channel_name,
  :messages)
  include Aws::Structure
end

#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, {"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.

Returns:



116
117
118
119
120
# File 'gems/aws-sdk-iotanalytics/lib/aws-sdk-iotanalytics/types.rb', line 116

class BatchPutMessageRequest < Struct.new(
  :channel_name,
  :messages)
  include Aws::Structure
end