---
title: "POST /ListStreams"
method: POST
path: "/ListStreams"
---

# POST /ListStreams

`POST /ListStreams`

Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.

## Query parameters

- `maxResults` string
- `nextToken` string

## Request body

- object
  - `filterBy` object — Object specifying the stream attribute on which to filter.
    - `health` 'HEALTHY' | 'STARVING' | 'UNKNOWN' — The stream’s health.
  - `maxResults` integer — Maximum number of streams to return. Default: 100.
  - `nextToken` string — The first stream to retrieve. This is used for pagination; see the <code>nextToken</code> response field.

## Response `200`

Success

- ListStreamsResponse
  - `nextToken` string — If there are more streams than <code>maxResults</code>, use <code>nextToken</code> in the request to get the next set.
  - `streams` StreamSummary[], required — List of streams.
    - `channelArn` string — Channel ARN for the stream.
    - `health` 'HEALTHY' | 'STARVING' | 'UNKNOWN' — The stream’s health.
    - `startTime` string, date-time — Time of the stream’s start. This is an ISO 8601 timestamp; <i>note that this is returned as a string</i>.
    - `state` 'LIVE' | 'OFFLINE' — The stream’s state. Do not rely on the <code>OFFLINE</code> state, as the API may not return it; instead, a "NotBroadcasting" error will indicate that the stream is not live.
    - `streamId` string — Unique identifier for a live or previously live stream in the specified channel.
    - `viewerCount` integer — A count of concurrent views of the stream. Typically, a new view appears in <code>viewerCount</code> within 15 seconds of when video playback starts and a view is removed from <code>viewerCount</code> within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.

## Other responses

- `480` — AccessDeniedException
- `481` — ValidationException

---

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