Skip to content

describe_limits

Operation

describe_limits

describe_limits(request: DescribeLimitsInput | DescribeLimitsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeLimitsInputDict]) -> DescribeLimitsOutput

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.

Parameters:

Name Type Description Default
request DescribeLimitsInput | DescribeLimitsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DescribeLimitsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeLimitsOutput

An instance of DescribeLimitsOutput.

describe_limits async

describe_limits(request: DescribeLimitsInput | DescribeLimitsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeLimitsInputDict]) -> DescribeLimitsOutput

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.

Parameters:

Name Type Description Default
request DescribeLimitsInput | DescribeLimitsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DescribeLimitsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeLimitsOutput

An instance of DescribeLimitsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DescribeLimitsInputDict

Bases: TypedDict

Dictionary form of DescribeLimitsInput.

DescribeLimitsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeLimitsInput structure.

Output

DescribeLimitsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeLimitsOutput structure.

Attributes

channel_count class-attribute instance-attribute
channel_count: int | None = ...

The number of channels in the account.

channel_count_limit class-attribute instance-attribute
channel_count_limit: int | None = ...

The maximum number of channels allowed in the account.

on_demand_stream_count instance-attribute
on_demand_stream_count: int

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

on_demand_stream_count_limit instance-attribute
on_demand_stream_count_limit: int

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

open_shard_count instance-attribute
open_shard_count: int

The number of open shards.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

shard_limit instance-attribute
shard_limit: int

The maximum number of shards.