Skip to content

DescribeLimits

Source: src/AWS/Kinesis/DescribeLimits.ts

Runtime binding for kinesis:DescribeLimits.

An account-level operation (no stream argument) that reports shard quotas and current usage for the region. Provide the implementation with Effect.provide(AWS.Kinesis.DescribeLimitsHttp).

// init — account-level binding takes no resource
const describeLimits = yield* AWS.Kinesis.DescribeLimits();
// runtime
const limits = yield* describeLimits();
const headroom = (limits.ShardLimit ?? 0) - (limits.OpenShardCount ?? 0);