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

# POST /describeStream

`POST /describeStream`

Returns the most current information about the specified stream. You must specify either the <code>StreamName</code> or the <code>StreamARN</code>.

## Request body

- object
  - `StreamName` string — The name of the stream.
  - `StreamARN` string — The Amazon Resource Name (ARN) of the stream.

## Response `200`

Success

- DescribeStreamOutput
  - `StreamInfo` object — An object that describes the stream.
    - `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.

## Other responses

- `480` — InvalidArgumentException
- `481` — ResourceNotFoundException
- `482` — ClientLimitExceededException
- `483` — NotAuthorizedException

---

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