---
title: "GET /channels/{channelName}"
method: GET
path: "/channels/{channelName}"
---

# GET /channels/{channelName}

`GET /channels/{channelName}`

Retrieves information about a channel.

## Path parameters

- `channelName` string, required

## Query parameters

- `includeStatistics` boolean

## Response `200`

Success

- DescribeChannelResponse
  - `channel` object — An object that contains information about the channel.
    - `name` string — The name of the channel.
    - `storage` object — Where channel data is stored. You can choose one of <code>serviceManagedS3</code> or <code>customerManagedS3</code> storage. If not specified, the default is <code>serviceManagedS3</code>. You can't change this storage option after the channel is created.
      - `serviceManagedS3` object — Used to store channel data in an S3 bucket managed by IoT Analytics. You can't change the choice of S3 storage after the data store is created.
      - `customerManagedS3` object — Used to store channel data in an S3 bucket that you manage. If customer managed storage is selected, the <code>retentionPeriod</code> parameter is ignored. You can't change the choice of S3 storage after the data store is created.
        - `bucket` string, required — The name of the S3 bucket in which channel data is stored.
        - `keyPrefix` string — (Optional) The prefix used to create the keys of the channel data objects. Each object in an S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket has exactly one key. The prefix must end with a forward slash (/).
        - `roleArn` string, required — The ARN of the role that grants IoT Analytics permission to interact with your Amazon S3 resources.
    - `arn` string — The ARN of the channel.
    - `status` 'CREATING' | 'ACTIVE' | 'DELETING' — The status of the channel.
    - `retentionPeriod` object — 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 <code>unlimited</code> parameter must be false.
    - `creationTime` string, date-time — When the channel was created.
    - `lastUpdateTime` string, date-time — When the channel was last updated.
    - `lastMessageArrivalTime` string, date-time — <p>The last time when a new message arrived in the channel.</p> <p>IoT Analytics updates this value at most once per minute for one channel. Hence, the <code>lastMessageArrivalTime</code> value is an approximation.</p> <p>This feature only applies to messages that arrived in the data store after October 23, 2020. </p>
  - `statistics` object — Statistics about the channel. Included if the <code>includeStatistics</code> parameter is set to <code>true</code> in the request.
    - `size` object — The estimated size of the channel.
      - `estimatedSizeInBytes` number, double — The estimated size of the resource, in bytes.
      - `estimatedOn` string, date-time — The time when the estimate of the size of the resource was made.

## Other responses

- `480` — InvalidRequestException
- `481` — ResourceNotFoundException
- `482` — InternalFailureException
- `483` — ServiceUnavailableException
- `484` — ThrottlingException

---

[API](https://skmtc.net/aws/apis/iotanalytics.md) · [All operations](https://skmtc.net/aws/apis/iotanalytics/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/iotanalytics/versions/e78558b7408d/schema)