[ aws . iotanalytics ]

batch-put-message

Description

Sends messages to a channel.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  batch-put-message
--channel-name <value>
--messages <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--channel-name (string)

The name of the channel where the messages are sent.

--messages (list)

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

Shorthand Syntax:

messageId=string,payload=blob ...

JSON Syntax:

[
  {
    "messageId": "string",
    "payload": blob
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

batchPutMessageErrorEntries -> (list)

A list of any errors encountered when sending the messages to the channel.

(structure)

Contains informations about errors.

messageId -> (string)

The ID of the message that caused the error. (See the value corresponding to the "messageId" key in the message object.)

errorCode -> (string)

The code associated with the error.

errorMessage -> (string)

The message associated with the error.