describe-limits¶

Description¶

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.

Synopsis¶

  describe-limits
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To describe shard limits

The following describe-limits example displays the shard limits and usage for the current AWS account.

aws kinesis describe-limits

Output:

{
    "ShardLimit": 500,
    "OpenShardCount": 29
}

For more information, see Resharding a Stream in the Amazon Kinesis Data Streams Developer Guide.

Output¶

ShardLimit -> (integer)

The maximum number of shards.

OpenShardCount -> (integer)

The number of open shards.

OnDemandStreamCount -> (integer)

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

OnDemandStreamCountLimit -> (integer)

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

Table of Contents

Feedback

User Guide