Kinesis / Client / update_account_settings

update_account_settings

Kinesis.Client.update_account_settings(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.update_account_settings(
    MinimumThroughputBillingCommitment={
        'Status': 'ENABLED'|'DISABLED'
    }
)
Parameters:

MinimumThroughputBillingCommitment (dict) –

[REQUIRED]

Specifies the minimum throughput billing commitment configuration for your account.

  • Status (string) – [REQUIRED]

    The desired status of the minimum throughput billing commitment.

Return type:

dict

Returns:

Response Syntax

{
    'MinimumThroughputBillingCommitment': {
        'Status': 'ENABLED'|'DISABLED'|'ENABLED_UNTIL_EARLIEST_ALLOWED_END',
        'StartedAt': datetime(2015, 1, 1),
        'EndedAt': datetime(2015, 1, 1),
        'EarliestAllowedEndAt': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • MinimumThroughputBillingCommitment (dict) –

      The updated configuration of the minimum throughput billing commitment for your account.

      • Status (string) –

        The current status of the minimum throughput billing commitment.

      • StartedAt (datetime) –

        The timestamp when the commitment was started.

      • EndedAt (datetime) –

        The timestamp when the commitment was ended.

      • EarliestAllowedEndAt (datetime) –

        The earliest timestamp when the commitment can be ended.

Exceptions