Skip to content

DescribeStreamConsumer

Source: src/AWS/Kinesis/DescribeStreamConsumer.ts

Runtime binding for kinesis:DescribeStreamConsumer.

Bind this operation to a StreamConsumer to read the enhanced fan-out consumer’s status and ARN — the consumer ARN is injected automatically. Provide the implementation with Effect.provide(AWS.Kinesis.DescribeStreamConsumerHttp).

const consumer = yield* AWS.Kinesis.StreamConsumer("Analytics", {
streamArn: stream.streamArn,
});
// init
const describeStreamConsumer =
yield* AWS.Kinesis.DescribeStreamConsumer(consumer);
// runtime
const result = yield* describeStreamConsumer();
const status = result.ConsumerDescription.ConsumerStatus;