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

Class: Aws::IoTAnalytics::Types::DescribeChannelRequest

Inherits:

Struct

Object
Struct
Aws::IoTAnalytics::Types::DescribeChannelRequest

show all

Defined in:: (unknown)

Overview

Note:

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

{
  channel_name: "ChannelName", # required
  include_statistics: false,
}

Instance Attribute Summary collapse

#channel_name ⇒ String
The name of the channel whose information is retrieved.
#include_statistics ⇒ Boolean
If true, additional statistical information about the channel is included in the response.

Instance Attribute Details

#channel_name ⇒ `String`

The name of the channel whose information is retrieved.

Returns:

(String) —
The name of the channel whose information is retrieved.

#include_statistics ⇒ `Boolean`

If true, additional statistical information about the channel is included in the response. This feature cannot be used with a channel whose S3 storage is customer-managed.