DynamoDB / Client / describe_limits

describe_limits#

DynamoDB.Client.describe_limits()#

Returns the current provisioned-capacity quotas for your Amazon Web Services account in a Region, both for the Region as a whole and for any one DynamoDB table that you create there.

When you establish an Amazon Web Services account, the account has initial quotas on the maximum read capacity units and write capacity units that you can provision across all of your DynamoDB tables in a given Region. Also, there are per-table quotas that apply when you create a table there. For more information, see Service, Account, and Table Quotas page in the Amazon DynamoDB Developer Guide.

Although you can increase these quotas by filing a case at Amazon Web Services Support Center, obtaining the increase is not instantaneous. The DescribeLimits action lets you write code to compare the capacity you are currently using to those quotas imposed by your account so that you have enough time to apply for an increase before you hit a quota.

For example, you could use one of the Amazon Web Services SDKs to do the following:

  • Call DescribeLimits for a particular Region to obtain your current account quotas on provisioned capacity there.

  • Create a variable to hold the aggregate read capacity units provisioned for all your tables in that Region, and one to hold the aggregate write capacity units. Zero them both.

  • Call ListTables to obtain a list of all your DynamoDB tables.

  • For each table name listed by ListTables, do the following:

    • Call DescribeTable with the table name.

    • Use the data returned by DescribeTable to add the read capacity units and write capacity units provisioned for the table itself to your variables.

    • If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well.

  • Report the account quotas for that Region returned by DescribeLimits, along with the total current provisioned capacity levels you have calculated.

This will let you see whether you are getting close to your account-level quotas.

The per-table quotas apply only when you are creating a new table. They restrict the sum of the provisioned capacity of the new table itself and all its global secondary indexes.

For existing tables and their GSIs, DynamoDB doesn’t let you increase provisioned capacity extremely rapidly, but the only quota that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account quotas.

Note

DescribeLimits should only be called periodically. You can expect throttling errors if you call it more than once in a minute.

The DescribeLimits Request element has no content.

See also: AWS API Documentation

Request Syntax

response = client.describe_limits()
Return type:

dict

Returns:

Response Syntax

{
    'AccountMaxReadCapacityUnits': 123,
    'AccountMaxWriteCapacityUnits': 123,
    'TableMaxReadCapacityUnits': 123,
    'TableMaxWriteCapacityUnits': 123
}

Response Structure

  • (dict) –

    Represents the output of a DescribeLimits operation.

    • AccountMaxReadCapacityUnits (integer) –

      The maximum total read capacity units that your account allows you to provision across all of your tables in this Region.

    • AccountMaxWriteCapacityUnits (integer) –

      The maximum total write capacity units that your account allows you to provision across all of your tables in this Region.

    • TableMaxReadCapacityUnits (integer) –

      The maximum read capacity units that your account allows you to provision for a new table that you are creating in this Region, including the read capacity units provisioned for its global secondary indexes (GSIs).

    • TableMaxWriteCapacityUnits (integer) –

      The maximum write capacity units that your account allows you to provision for a new table that you are creating in this Region, including the write capacity units provisioned for its global secondary indexes (GSIs).

Exceptions

  • DynamoDB.Client.exceptions.InternalServerError

Examples

The following example returns the maximum read and write capacity units per table, and for the AWS account, in the current AWS region.

response = client.describe_limits(
)

print(response)

Expected Output:

{
    'AccountMaxReadCapacityUnits': 20000,
    'AccountMaxWriteCapacityUnits': 20000,
    'TableMaxReadCapacityUnits': 10000,
    'TableMaxWriteCapacityUnits': 10000,
    'ResponseMetadata': {
        '...': '...',
    },
}