DescribeStreamSummary

Source: src/AWS/Kinesis/DescribeStreamSummary.ts

Runtime binding for kinesis:DescribeStreamSummary.

Bind this operation to a Stream to read its status, mode, retention, encryption, and open shard count without paginating the full shard map. Provide the implementation with Effect.provide(AWS.Kinesis.DescribeStreamSummaryHttp).

Inspecting Streams

// init
const describeStreamSummary = yield* AWS.Kinesis.DescribeStreamSummary(stream);

// runtime
const result = yield* describeStreamSummary();
const summary = result.StreamDescriptionSummary;
yield* Effect.log(`${summary.StreamStatus}: ${summary.OpenShardCount} shards`);