Skip to content

Kinesis  >  Operations  >  update_account_settings

update_account_settings

Operation

update_account_settings async

update_account_settings(request: UpdateAccountSettingsInput | UpdateAccountSettingsInputDict, /, *, plugins: list[Plugin] | None = None) -> UpdateAccountSettingsOutput
update_account_settings(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateAccountSettingsInputDict]) -> UpdateAccountSettingsOutput

Updates the account-level settings for Amazon Kinesis Data Streams.

Updating account settings is a synchronous operation. Upon receiving the request, Kinesis Data Streams will return immediately with your account's updated settings.

API limits

  • Certain account configurations have minimum commitment windows. Attempting to update your settings prior to the end of the minimum commitment window might have certain restrictions.

  • 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
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

Returns:

Type Description
UpdateAccountSettingsOutput

An instance of UpdateAccountSettingsOutput.

Input

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

Model

UpdateAccountSettingsInput dataclass

Bases: _SerdeShape

Dataclass for UpdateAccountSettingsInput structure.

Attributes
minimum_throughput_billing_commitment class-attribute instance-attribute
minimum_throughput_billing_commitment: MinimumThroughputBillingCommitmentInput | None = ...

Specifies the minimum throughput billing commitment configuration for your account.

Dictionaries

UpdateAccountSettingsInputDict

Bases: TypedDict

Dictionary form of UpdateAccountSettingsInput.

Attributes
minimum_throughput_billing_commitment instance-attribute

Specifies the minimum throughput billing commitment configuration for your account.

Output

UpdateAccountSettingsOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateAccountSettingsOutput structure.

Attributes

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

The updated configuration of the minimum throughput billing commitment for your 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.