import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DynamoDBClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../DynamoDBClient"; import type { DescribeLimitsInput, DescribeLimitsOutput } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribeLimitsCommand}. */ export interface DescribeLimitsCommandInput extends DescribeLimitsInput { } /** * @public * * The output of {@link DescribeLimitsCommand}. */ export interface DescribeLimitsCommandOutput extends DescribeLimitsOutput, __MetadataBearer { } declare const DescribeLimitsCommand_base: { new (input: DescribeLimitsCommandInput): import("@smithy/smithy-client").CommandImpl; new (...[input]: [] | [DescribeLimitsCommandInput]): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

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:

*
    *
  1. *

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

    *
    2. *
  2. *

    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.

    *
    3. *
  3. *

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

    *
    4. *
  4. *

    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.

      *
      • *
    *
    5. *
  5. *

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

    *
    6. *
*

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.

* *

* 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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { DynamoDBClient, DescribeLimitsCommand } from "@aws-sdk/client-dynamodb"; // ES Modules import * // const { DynamoDBClient, DescribeLimitsCommand } = require("@aws-sdk/client-dynamodb"); // CommonJS import * // import type { DynamoDBClientConfig } from "@aws-sdk/client-dynamodb"; * const config = {}; // type is DynamoDBClientConfig * const client = new DynamoDBClient(config); * const input = {}; * const command = new DescribeLimitsCommand(input); * const response = await client.send(command); * // { // DescribeLimitsOutput * // AccountMaxReadCapacityUnits: Number("long"), * // AccountMaxWriteCapacityUnits: Number("long"), * // TableMaxReadCapacityUnits: Number("long"), * // TableMaxWriteCapacityUnits: Number("long"), * // }; * * ``` * * @param DescribeLimitsCommandInput - {@link DescribeLimitsCommandInput} * @returns {@link DescribeLimitsCommandOutput} * @see {@link DescribeLimitsCommandInput} for command's `input` shape. * @see {@link DescribeLimitsCommandOutput} for command's `response` shape. * @see {@link DynamoDBClientResolvedConfig | config} for DynamoDBClient's `config` shape. * * @throws {@link InternalServerError} (server fault) *

An error occurred on the server side.

* * @throws {@link InvalidEndpointException} (client fault) * * @throws {@link DynamoDBServiceException} *

Base exception class for all service exceptions from DynamoDB service.

* * * @example To determine capacity limits per table and account, in the current AWS region * ```javascript * // The following example returns the maximum read and write capacity units per table, and for the AWS account, in the current AWS region. * const input = { /* empty *\/ }; * const command = new DescribeLimitsCommand(input); * const response = await client.send(command); * /* response is * { * AccountMaxReadCapacityUnits: 20000, * AccountMaxWriteCapacityUnits: 20000, * TableMaxReadCapacityUnits: 10000, * TableMaxWriteCapacityUnits: 10000 * } * *\/ * ``` * * @public */ export declare class DescribeLimitsCommand extends DescribeLimitsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: {}; output: DescribeLimitsOutput; }; sdk: { input: DescribeLimitsCommandInput; output: DescribeLimitsCommandOutput; }; }; }