@aws-sdk/client-dynamodb
Version:
AWS SDK for JavaScript Dynamodb Client for Node.js, Browser and React Native
118 lines • 6.41 kB
JavaScript
import { __extends } from "tslib";
import { DescribeLimitsInput, DescribeLimitsOutput } from "../models/models_0";
import { deserializeAws_json1_0DescribeLimitsCommand, serializeAws_json1_0DescribeLimitsCommand, } from "../protocols/Aws_json1_0";
import { getSerdePlugin } from "@aws-sdk/middleware-serde";
import { Command as $Command } from "@aws-sdk/smithy-client";
/**
* <p>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.</p>
* <p>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 <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Service, Account, and Table
* Quotas</a> page in the <i>Amazon DynamoDB Developer
* Guide</i>.</p>
*
* <p>Although you can increase these quotas by filing a case at <a href="https://console.aws.amazon.com/support/home#/">AWS Support Center</a>, obtaining the increase is not
* instantaneous. The <code>DescribeLimits</code> 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.</p>
*
* <p>For example, you could use one of the AWS SDKs to do the following:</p>
*
* <ol>
* <li>
* <p>Call <code>DescribeLimits</code> for a particular Region to obtain your current
* account quotas on provisioned capacity there.</p>
* </li>
* <li>
* <p>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.</p>
* </li>
* <li>
* <p>Call <code>ListTables</code> to obtain a list of all your DynamoDB tables.</p>
* </li>
* <li>
* <p>For each table name listed by <code>ListTables</code>, do the following:</p>
* <ul>
* <li>
* <p>Call <code>DescribeTable</code> with the table name.</p>
* </li>
* <li>
* <p>Use the data returned by <code>DescribeTable</code> to add the read capacity units and write capacity
* units provisioned for the table itself to your variables.</p>
* </li>
* <li>
* <p>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.</p>
* </li>
* </ul>
* </li>
* <li>
* <p>Report the account quotas for that Region returned by <code>DescribeLimits</code>, along with
* the total current provisioned capacity levels you have calculated.</p>
* </li>
* </ol>
*
* <p>This will let you see whether you are getting close to your account-level quotas.</p>
* <p>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.</p>
* <p>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.</p>
* <note>
* <p>
* <code>DescribeLimits</code> should only be called periodically. You can expect throttling
* errors if you call it more than once in a minute.</p>
* </note>
* <p>The <code>DescribeLimits</code> Request element has no content.</p>
*/
var DescribeLimitsCommand = /** @class */ (function (_super) {
__extends(DescribeLimitsCommand, _super);
// Start section: command_properties
// End section: command_properties
function DescribeLimitsCommand(input) {
var _this =
// Start section: command_constructor
_super.call(this) || this;
_this.input = input;
_this.resolved = false;
return _this;
// End section: command_constructor
}
/**
* @internal
*/
DescribeLimitsCommand.prototype.resolveMiddleware = function (clientStack, configuration, options) {
if (!this.resolved) {
this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
this.resolved = true;
}
var stack = clientStack.concat(this.middlewareStack);
var logger = configuration.logger;
var clientName = "DynamoDBClient";
var commandName = "DescribeLimitsCommand";
var handlerExecutionContext = {
logger: logger,
clientName: clientName,
commandName: commandName,
inputFilterSensitiveLog: DescribeLimitsInput.filterSensitiveLog,
outputFilterSensitiveLog: DescribeLimitsOutput.filterSensitiveLog,
};
var requestHandler = configuration.requestHandler;
return stack.resolve(function (request) {
return requestHandler.handle(request.request, options || {});
}, handlerExecutionContext);
};
DescribeLimitsCommand.prototype.serialize = function (input, context) {
return serializeAws_json1_0DescribeLimitsCommand(input, context);
};
DescribeLimitsCommand.prototype.deserialize = function (output, context) {
return deserializeAws_json1_0DescribeLimitsCommand(output, context);
};
return DescribeLimitsCommand;
}($Command));
export { DescribeLimitsCommand };
//# sourceMappingURL=DescribeLimitsCommand.js.map