Kinesis / Client / describe_account_settings

describe_account_settings

Kinesis.Client.describe_account_settings()

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_account_settings()
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 current configuration of the minimum throughput billing commitment for your Amazon Web Services 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