Skip to content

update_account_settings

update_account_settings(
    minimum_throughput_billing_commitment: MinimumThroughputBillingCommitmentInput,
    *,
    config_overrides: Optional[KinesisClientConfig] = None,
) -> 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:

Raises:

  • InvalidArgumentException –

    A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

  • LimitExceededException –

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

  • ValidationException –

    Specifies that you tried to invoke this API for a data stream with the on-demand capacity mode. This API is only supported for data streams with the provisioned capacity mode.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_kinesis/_services/kinesis.py
def update_account_settings(
    self,
    minimum_throughput_billing_commitment: "capo_kinesis.types.minimum_throughput_billing_commitment_input.MinimumThroughputBillingCommitmentInput",
    *,
    config_overrides: Optional[KinesisClientConfig] = None,
) -> (
    "capo_kinesis.types.update_account_settings_output.UpdateAccountSettingsOutput"
):
    """<p>Updates the account-level settings for Amazon Kinesis Data Streams.</p> <p>Updating account settings is a synchronous operation. Upon receiving the request, Kinesis Data Streams will return immediately with your account’s updated settings.</p> <p> <b>API limits</b> </p> <ul> <li> <p>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.</p> </li> <li> <p>This API has a call limit of 5 transactions per second (TPS) for each Amazon Web Services account. TPS over 5 will initiate the <code>LimitExceededException</code>.</p> </li> </ul>

    Args:
        minimum_throughput_billing_commitment: <p>Specifies the minimum throughput billing commitment configuration for your account.</p>

    Raises:
        capo_kinesis.errors.invalid_argument_exception.InvalidArgumentException: <p>A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.</p>
        capo_kinesis.errors.limit_exceeded_exception.LimitExceededException: <p>The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed. </p>
        capo_kinesis.errors.validation_exception.ValidationException: <p>Specifies that you tried to invoke this API for a data stream with the on-demand capacity mode. This API is only supported for data streams with the provisioned capacity mode. </p>
        capo_kinesis.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_kinesis.types.update_account_settings_input.UpdateAccountSettingsInput]",
    ) -> OperationResponse[
        "capo_kinesis.types.update_account_settings_output.UpdateAccountSettingsOutput"
    ]:
        import capo_kinesis._operations.kinesis_20131202.update_account_settings

        output, http_response = (
            capo_kinesis._operations.kinesis_20131202.update_account_settings.update_account_settings(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateAccountSettings")
    )
    input_: capo_kinesis.types.update_account_settings_input.UpdateAccountSettingsInput = {
        "minimum_throughput_billing_commitment": minimum_throughput_billing_commitment
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output