Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . iotanalytics ]

describe-channel

Description

Retrieves information about a channel.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-channel
--channel-name <value>
[--include-statistics | --no-include-statistics]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--channel-name (string)

The name of the channel whose information is retrieved.

--include-statistics | --no-include-statistics (boolean)

If true, include statistics about the channel in the response.

--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

channel -> (structure)

An object that contains information about the channel.

name -> (string)

The name of the channel.

arn -> (string)

The ARN of the channel.

status -> (string)

The status of the channel.

retentionPeriod -> (structure)

How long, in days, message data is kept for the channel.

unlimited -> (boolean)

If true, message data is kept indefinitely.

numberOfDays -> (integer)

The number of days that message data is kept. The "unlimited" parameter must be false.

creationTime -> (timestamp)

When the channel was created.

lastUpdateTime -> (timestamp)

When the channel was last updated.

statistics -> (structure)

Statistics about the channel. Included if the 'includeStatistics' parameter is set to true in the request.

size -> (structure)

The estimated size of the channel.

estimatedSizeInBytes -> (double)

The estimated size of the resource in bytes.

estimatedOn -> (timestamp)

The time when the estimate of the size of the resource was made.