DescribeLimits - Amazon Kinesis Data Streams Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

DescribeLimits

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.

Response Syntax

{ "OnDemandStreamCount": number, "OnDemandStreamCountLimit": number, "OpenShardCount": number, "ShardLimit": number }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

OnDemandStreamCount

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

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 1000000.

OnDemandStreamCountLimit

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

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 1000000.

OpenShardCount

The number of open shards.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 1000000.

ShardLimit

The maximum number of shards.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 1000000.

Errors

For information about the errors that are common to all actions, see Common Errors.

LimitExceededException

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

HTTP Status Code: 400

Examples

To display the shard limits for the account

The following example displays the shard limits for the account.

Sample Request

POST / HTTP/1.1 Host: kinesis.<region>.<domain> Content-Length: <PayloadSizeBytes> User-Agent: <UserAgentString> Content-Type: application/x-amz-json-1.1 Authorization: <AuthParams> Connection: Keep-Alive X-Amz-Date: <Date> X-Amz-Target: Kinesis_20131202.DescribeLimits

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: <RequestId> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Date: <Date> { "OpenShardCount": 20, "ShardLimit": 70 }

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: