Skip to content

describe_account_settings

Operation

describe_account_settings

describe_account_settings(request: DescribeAccountSettingsInput | DescribeAccountSettingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeAccountSettingsInputDict]) -> DescribeAccountSettingsOutput

Describes the account-level settings for Amazon Kinesis Data Streams. This operation returns information about the minimum throughput billing commitments and other account-level configurations.

This API has a call limit of 5 transactions per second (TPS) for each Amazon Web Services account. TPS over 5 will initiate the LimitExceededException.

Parameters:

Name Type Description Default
request DescribeAccountSettingsInput | DescribeAccountSettingsInputDict | 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[DescribeAccountSettingsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeAccountSettingsOutput

An instance of DescribeAccountSettingsOutput.

describe_account_settings async

describe_account_settings(request: DescribeAccountSettingsInput | DescribeAccountSettingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeAccountSettingsInputDict]) -> DescribeAccountSettingsOutput

Describes the account-level settings for Amazon Kinesis Data Streams. This operation returns information about the minimum throughput billing commitments and other account-level configurations.

This API has a call limit of 5 transactions per second (TPS) for each Amazon Web Services account. TPS over 5 will initiate the LimitExceededException.

Parameters:

Name Type Description Default
request DescribeAccountSettingsInput | DescribeAccountSettingsInputDict | 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[DescribeAccountSettingsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribeAccountSettingsOutput

An instance of DescribeAccountSettingsOutput.

Input

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

DescribeAccountSettingsInputDict

Bases: TypedDict

Dictionary form of DescribeAccountSettingsInput.

DescribeAccountSettingsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeAccountSettingsInput structure.

Output

DescribeAccountSettingsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeAccountSettingsOutput structure.

Attributes

minimum_throughput_billing_commitment class-attribute instance-attribute
minimum_throughput_billing_commitment: MinimumThroughputBillingCommitmentOutput | None = ...

The current configuration of the minimum throughput billing commitment for your Amazon Web Services account.

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.