DescribeLimitsCommand

Suggest an Edit

Describes the shard limits and usage for the account.

If you update your account limits, the old limits might be returned for a few minutes.

This operation has a limit of one transaction per second per account.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { KinesisClient, DescribeLimitsCommand } from "@aws-sdk/client-kinesis"; // ES Modules import
// const { KinesisClient, DescribeLimitsCommand } = require("@aws-sdk/client-kinesis"); // CommonJS import
const client = new KinesisClient(config);
const input = {};
const command = new DescribeLimitsCommand(input);
const response = await client.send(command);
// { // DescribeLimitsOutput
//   ShardLimit: Number("int"), // required
//   OpenShardCount: Number("int"), // required
//   OnDemandStreamCount: Number("int"), // required
//   OnDemandStreamCountLimit: Number("int"), // required
// };

DescribeLimitsCommand Input

See DescribeLimitsCommandInput for more details
DescribeLimitsCommandInput extends DescribeLimitsInput

DescribeLimitsCommand Output

See DescribeLimitsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
OnDemandStreamCount
Required
number | undefined

Indicates the number of data streams with the on-demand capacity mode.

OnDemandStreamCountLimit
Required
number | undefined

The maximum number of data streams with the on-demand capacity mode.

OpenShardCount
Required
number | undefined

The number of open shards.

ShardLimit
Required
number | undefined

The maximum number of shards.

Throws

Name
Fault
Details
LimitExceededException
client

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

KinesisServiceException
Base exception class for all service exceptions from Kinesis service.