libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DynamoDB.DescribeLimits

Description

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 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 AWS SDKs to do the following:

  1. Call DescribeLimits for a particular Region to obtain your current account quotas on provisioned capacity there.
  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. Call ListTables to obtain a list of all your DynamoDB tables.
  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. 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.

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.

Synopsis

Creating a Request

data DescribeLimits Source #

Represents the input of a DescribeLimits operation. Has no content.

See: newDescribeLimits smart constructor.

Constructors

DescribeLimits' 

Instances

Instances details
Eq DescribeLimits Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeLimits

Read DescribeLimits Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeLimits

Show DescribeLimits Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeLimits

Generic DescribeLimits Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeLimits

Associated Types

type Rep DescribeLimits :: Type -> Type #

NFData DescribeLimits Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeLimits

Methods

rnf :: DescribeLimits -> () #

Hashable DescribeLimits Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeLimits

ToJSON DescribeLimits Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeLimits

AWSRequest DescribeLimits Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeLimits

Associated Types

type AWSResponse DescribeLimits #

ToHeaders DescribeLimits Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeLimits

ToPath DescribeLimits Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeLimits

ToQuery DescribeLimits Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeLimits

type Rep DescribeLimits Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeLimits

type Rep DescribeLimits = D1 ('MetaData "DescribeLimits" "Amazonka.DynamoDB.DescribeLimits" "libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb" 'False) (C1 ('MetaCons "DescribeLimits'" 'PrefixI 'False) (U1 :: Type -> Type))
type AWSResponse DescribeLimits Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeLimits

newDescribeLimits :: DescribeLimits Source #

Create a value of DescribeLimits with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

Destructuring the Response

data DescribeLimitsResponse Source #

Represents the output of a DescribeLimits operation.

See: newDescribeLimitsResponse smart constructor.

Constructors

DescribeLimitsResponse' 

Fields

  • tableMaxWriteCapacityUnits :: Maybe Natural

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

  • tableMaxReadCapacityUnits :: Maybe Natural

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

  • accountMaxWriteCapacityUnits :: Maybe Natural

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

  • accountMaxReadCapacityUnits :: Maybe Natural

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DescribeLimitsResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeLimits

Read DescribeLimitsResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeLimits

Show DescribeLimitsResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeLimits

Generic DescribeLimitsResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeLimits

Associated Types

type Rep DescribeLimitsResponse :: Type -> Type #

NFData DescribeLimitsResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeLimits

Methods

rnf :: DescribeLimitsResponse -> () #

type Rep DescribeLimitsResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.DescribeLimits

type Rep DescribeLimitsResponse = D1 ('MetaData "DescribeLimitsResponse" "Amazonka.DynamoDB.DescribeLimits" "libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb" 'False) (C1 ('MetaCons "DescribeLimitsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tableMaxWriteCapacityUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "tableMaxReadCapacityUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "accountMaxWriteCapacityUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "accountMaxReadCapacityUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeLimitsResponse Source #

Create a value of DescribeLimitsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:tableMaxWriteCapacityUnits:DescribeLimitsResponse', describeLimitsResponse_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).

$sel:tableMaxReadCapacityUnits:DescribeLimitsResponse', describeLimitsResponse_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).

$sel:accountMaxWriteCapacityUnits:DescribeLimitsResponse', describeLimitsResponse_accountMaxWriteCapacityUnits - The maximum total write capacity units that your account allows you to provision across all of your tables in this Region.

$sel:accountMaxReadCapacityUnits:DescribeLimitsResponse', describeLimitsResponse_accountMaxReadCapacityUnits - The maximum total read capacity units that your account allows you to provision across all of your tables in this Region.

$sel:httpStatus:DescribeLimitsResponse', describeLimitsResponse_httpStatus - The response's http status code.

Response Lenses

describeLimitsResponse_tableMaxWriteCapacityUnits :: Lens' DescribeLimitsResponse (Maybe Natural) Source #

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

describeLimitsResponse_tableMaxReadCapacityUnits :: Lens' DescribeLimitsResponse (Maybe Natural) Source #

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

describeLimitsResponse_accountMaxWriteCapacityUnits :: Lens' DescribeLimitsResponse (Maybe Natural) Source #

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

describeLimitsResponse_accountMaxReadCapacityUnits :: Lens' DescribeLimitsResponse (Maybe Natural) Source #

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