Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

SampleChannelData

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

Important

The SampleChannelData operation in AWS IoT Analytics is no longer available to new customers. Existing customers of AWS IoT Analytics can continue to use the service as normal. Learn more

Request Syntax


GET /channels/channelName/sample?endTime=endTime&maxMessages=maxMessages&startTime=startTime HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

channelName

The name of the channel whose message samples are retrieved.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: (^(?!_{2}))(^[a-zA-Z0-9_]+$)

Required: Yes

endTime

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

maxMessages

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

Valid Range: Minimum value of 1. Maximum value of 10.

startTime

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

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "payloads": [ blob ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

payloads

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

Type: Array of Base64-encoded binary data objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalFailureException

There was an internal failure.

HTTP Status Code: 500

InvalidRequestException

The request was not valid.

HTTP Status Code: 400

ResourceNotFoundException

A resource with the specified name could not be found.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400