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

Class: Aws::IoTAnalytics::Types::SampleChannelDataRequest

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

Overview

Note:

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

{
  channel_name: "ChannelName", # required
  max_messages: 1,
  start_time: Time.now,
  end_time: Time.now,
}

Instance Attribute Summary collapse

Instance Attribute Details

#channel_name ⇒ String

The name of the channel whose message samples are retrieved.

Returns:

  • (String) —

    The name of the channel whose message samples are retrieved.

#end_time ⇒ Time

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

Returns:

  • (Time) —

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

#max_messages ⇒ Integer

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

Returns:

  • (Integer) —

    The number of sample messages to be retrieved.

#start_time ⇒ Time

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

Returns:

  • (Time) —

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