[ aws . iotanalytics ]

sample-channel-data

Description

Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10 messages can be retrieved.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  sample-channel-data
--channel-name <value>
[--max-messages <value>]
[--start-time <value>]
[--end-time <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--channel-name (string)

The name of the channel whose message samples are retrieved.

--max-messages (integer)

The number of sample messages to be retrieved. The limit is 10. The default is also 10.

--start-time (timestamp)

The start of the time window from which sample messages are retrieved.

--end-time (timestamp)

The end of the time window from which sample messages are retrieved.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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.

Examples

To retrieve sample messages from a channel

The following sample-channel-data example retrieves a sample of messages from the specified channel ingested during the specified timeframe. You can retrieve up to 10 messages.

aws iotanalytics sample-channel-data \
    --channel-name mychannel

Output:

{
    "payloads": [
        "eyAidGVtcGVyYXR1cmUiOiAyMCB9",
        "eyAiZm9vIjogImJhciIgfQ=="
    ]
}

For more information, see SampleChannelData in the AWS IoT Analytics API Reference.

Output

payloads -> (list)

The list of message samples. Each sample message is returned as a base64-encoded string.

(blob)