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

# POST /listStreams

`POST /listStreams`

Returns an array of <code>StreamInfo</code> objects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify a <code>StreamNameCondition</code>.

## Query parameters

- `MaxResults` string
- `NextToken` string

## Request body

- object
  - `MaxResults` integer — The maximum number of streams to return in the response. The default is 10,000.
  - `NextToken` string — If you specify this parameter, when the result of a <code>ListStreams</code> operation is truncated, the call returns the <code>NextToken</code> in the response. To get another batch of streams, provide this token in your next request.
  - `StreamNameCondition` object — Specifies the condition that streams must satisfy to be returned when you list streams (see the <code>ListStreams</code> API). A condition has a comparison operation and a value. Currently, you can specify only the <code>BEGINS_WITH</code> operator, which finds streams whose names start with a given prefix.
    - `ComparisonOperator` 'BEGINS_WITH' — A comparison operator. Currently, you can specify only the <code>BEGINS_WITH</code> operator, which finds streams whose names start with a given prefix.
    - `ComparisonValue` string — A value to compare.

## Response `200`

Success

- ListStreamsOutput
  - `StreamInfoList` StreamInfo[] — An array of <code>StreamInfo</code> objects.
    - `DeviceName` string — The name of the device that is associated with the stream.
    - `StreamName` string — The name of the stream.
    - `StreamARN` string — The Amazon Resource Name (ARN) of the stream.
    - `MediaType` string — The <code>MediaType</code> of the stream.
    - `KmsKeyId` string — The ID of the Key Management Service (KMS) key that Kinesis Video Streams uses to encrypt data on the stream.
    - `Version` string — The version of the stream.
    - `Status` 'CREATING' | 'ACTIVE' | 'UPDATING' | 'DELETING' — The status of the stream.
    - `CreationTime` string, date-time — A time stamp that indicates when the stream was created.
    - `DataRetentionInHours` integer — How long the stream retains data, in hours.
  - `NextToken` string — If the response is truncated, the call returns this element with a token. To get the next batch of streams, use this token in your next request.

## Other responses

- `480` — ClientLimitExceededException
- `481` — InvalidArgumentException

---

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