DescribeLimits
Returns the current provisioned-capacity quotas for your AWS 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 AWS 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 AWS Support CenterDescribeLimits 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 AWS SDKs to do the following:
-
Call
DescribeLimitsfor 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
ListTablesto obtain a list of all your DynamoDB tables. -
For each table name listed by
ListTables, do the following:-
Call
DescribeTablewith the table name. -
Use the data returned by
DescribeTableto 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.
Response Syntax
{
"AccountMaxReadCapacityUnits": number,
"AccountMaxWriteCapacityUnits": number,
"TableMaxReadCapacityUnits": number,
"TableMaxWriteCapacityUnits": number
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- AccountMaxReadCapacityUnits
-
The maximum total read capacity units that your account allows you to provision across all of your tables in this Region.
Type: Long
Valid Range: Minimum value of 1.
- AccountMaxWriteCapacityUnits
-
The maximum total write capacity units that your account allows you to provision across all of your tables in this Region.
Type: Long
Valid Range: Minimum value of 1.
- TableMaxReadCapacityUnits
-
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).
Type: Long
Valid Range: Minimum value of 1.
- TableMaxWriteCapacityUnits
-
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).
Type: Long
Valid Range: Minimum value of 1.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerError
-
An error occurred on the server side.
HTTP Status Code: 500
Examples
DescribeLimits
This example illustrates one usage of DescribeLimits.
Sample Request
POST / HTTP/1.1
Host: dynamodb.<region>.<domain>;
Accept-Encoding: identity
Content-Length: <PayloadSizeBytes>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.0
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>
X-Amz-Date: <Date>
X-Amz-Target: DynamoDB_20120810.DescribeLimits
{ }Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
x-amz-crc32: <Checksum>
Content-Type: application/x-amz-json-1.0
Content-Length: <PayloadSizeBytes>
Date: <Date>
{
"AccountMaxReadCapacityUnits": 20000,
"AccountMaxWriteCapacityUnits": 20000,
"TableMaxReadCapacityUnits": 10000,
"TableMaxWriteCapacityUnits": 10000
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
