DescribeStream

Source: src/AWS/Kinesis/DescribeStream.ts

Runtime binding for kinesis:DescribeStream.

Bind this operation to a Stream to read its full description, including the shard map — the stream name is injected automatically. For status and counts without the shard list, prefer AWS.Kinesis.DescribeStreamSummary. Provide the implementation with Effect.provide(AWS.Kinesis.DescribeStreamHttp).

Inspecting Streams

// init
const describeStream = yield* AWS.Kinesis.DescribeStream(stream);

// runtime
const result = yield* describeStream();
const status = result.StreamDescription.StreamStatus;
const shards = result.StreamDescription.Shards;