Network.AWS.DynamoDB.DescribeLimits

Returns the current provisioned-capacity limits 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 limits 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 limits that apply when you create a table there. For more information, see Limits page in the Amazon DynamoDB Developer Guide .

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

For example, you could use one of the AWS SDKs to do the following:

• Call DescribeLimits for a particular region to obtain your current account limits 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 limits 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 limits.

The per-table limits 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 will not let you increase provisioned capacity extremely rapidly, but the only upper limit that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account limits.

The DescribeLimits Request element has no content.

Creating a Request

describeLimits :: DescribeLimits

Creates a value of DescribeLimits with the minimum fields required to make a request.

data DescribeLimits

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

See: describeLimits smart constructor.

Instances

Eq DescribeLimits

Methods

(==) :: DescribeLimits -> DescribeLimits -> Bool

(/=) :: DescribeLimits -> DescribeLimits -> Bool

Data DescribeLimits

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeLimits -> c DescribeLimits

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeLimits

toConstr :: DescribeLimits -> Constr

dataTypeOf :: DescribeLimits -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeLimits)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeLimits)

gmapT :: (forall b. Data b => b -> b) -> DescribeLimits -> DescribeLimits

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeLimits -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeLimits -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeLimits -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeLimits -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeLimits -> m DescribeLimits

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeLimits -> m DescribeLimits

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeLimits -> m DescribeLimits

Read DescribeLimits

Methods

readsPrec :: Int -> ReadS DescribeLimits

readList :: ReadS [DescribeLimits]

readPrec :: ReadPrec DescribeLimits

readListPrec :: ReadPrec [DescribeLimits]

Show DescribeLimits

Methods

showsPrec :: Int -> DescribeLimits -> ShowS

show :: DescribeLimits -> String

showList :: [DescribeLimits] -> ShowS

Generic DescribeLimits

Associated Types

type Rep DescribeLimits :: * -> *

Methods

from :: DescribeLimits -> Rep DescribeLimits x

to :: Rep DescribeLimits x -> DescribeLimits

Hashable DescribeLimits

Methods

hashWithSalt :: Int -> DescribeLimits -> Int

hash :: DescribeLimits -> Int

ToJSON DescribeLimits

Methods

toJSON :: DescribeLimits -> Value

toEncoding :: DescribeLimits -> Encoding

toJSONList :: [DescribeLimits] -> Value

toEncodingList :: [DescribeLimits] -> Encoding

NFData DescribeLimits

Methods

rnf :: DescribeLimits -> ()

AWSRequest DescribeLimits

Associated Types

type Rs DescribeLimits :: *

Methods

request :: DescribeLimits -> Request DescribeLimits

response :: MonadResource m => Logger -> Service -> Proxy * DescribeLimits -> ClientResponse -> m (Response DescribeLimits)

ToPath DescribeLimits

Methods

toPath :: DescribeLimits -> ByteString

ToHeaders DescribeLimits

Methods

toHeaders :: DescribeLimits -> [Header]

ToQuery DescribeLimits

Methods

toQuery :: DescribeLimits -> QueryString

type Rep DescribeLimits

type Rep DescribeLimits = D1 (MetaData "DescribeLimits" "Network.AWS.DynamoDB.DescribeLimits" "amazonka-dynamodb-1.4.5-9Gf0U64x7l0KacBmJaIMNw" False) (C1 (MetaCons "DescribeLimits'" PrefixI False) U1)

type Rs DescribeLimits

type Rs DescribeLimits = DescribeLimitsResponse

Destructuring the Response

describeLimitsResponse

Arguments

:: Int

dlrsResponseStatus

-> DescribeLimitsResponse

Creates a value of DescribeLimitsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dlrsTableMaxWriteCapacityUnits - 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).
• dlrsTableMaxReadCapacityUnits - 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).
• dlrsAccountMaxWriteCapacityUnits - The maximum total write capacity units that your account allows you to provision across all of your tables in this region.
• dlrsAccountMaxReadCapacityUnits - The maximum total read capacity units that your account allows you to provision across all of your tables in this region.
• dlrsResponseStatus - -- | The response status code.

data DescribeLimitsResponse

Represents the output of a DescribeLimits operation.

See: describeLimitsResponse smart constructor.

Instances

Eq DescribeLimitsResponse

Methods

(==) :: DescribeLimitsResponse -> DescribeLimitsResponse -> Bool

(/=) :: DescribeLimitsResponse -> DescribeLimitsResponse -> Bool

Data DescribeLimitsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeLimitsResponse -> c DescribeLimitsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeLimitsResponse

toConstr :: DescribeLimitsResponse -> Constr

dataTypeOf :: DescribeLimitsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeLimitsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeLimitsResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeLimitsResponse -> DescribeLimitsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeLimitsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeLimitsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeLimitsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeLimitsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeLimitsResponse -> m DescribeLimitsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeLimitsResponse -> m DescribeLimitsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeLimitsResponse -> m DescribeLimitsResponse

Read DescribeLimitsResponse

Methods

readsPrec :: Int -> ReadS DescribeLimitsResponse

readList :: ReadS [DescribeLimitsResponse]

readPrec :: ReadPrec DescribeLimitsResponse

readListPrec :: ReadPrec [DescribeLimitsResponse]

Show DescribeLimitsResponse

Methods

showsPrec :: Int -> DescribeLimitsResponse -> ShowS

show :: DescribeLimitsResponse -> String

showList :: [DescribeLimitsResponse] -> ShowS

Generic DescribeLimitsResponse

Associated Types

type Rep DescribeLimitsResponse :: * -> *

Methods

from :: DescribeLimitsResponse -> Rep DescribeLimitsResponse x

to :: Rep DescribeLimitsResponse x -> DescribeLimitsResponse

NFData DescribeLimitsResponse

Methods

rnf :: DescribeLimitsResponse -> ()

type Rep DescribeLimitsResponse

type Rep DescribeLimitsResponse = D1 (MetaData "DescribeLimitsResponse" "Network.AWS.DynamoDB.DescribeLimits" "amazonka-dynamodb-1.4.5-9Gf0U64x7l0KacBmJaIMNw" False) (C1 (MetaCons "DescribeLimitsResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dlrsTableMaxWriteCapacityUnits") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_dlrsTableMaxReadCapacityUnits") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)))) ((:*:) (S1 (MetaSel (Just Symbol "_dlrsAccountMaxWriteCapacityUnits") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) ((:*:) (S1 (MetaSel (Just Symbol "_dlrsAccountMaxReadCapacityUnits") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_dlrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))))

Response Lenses

dlrsTableMaxWriteCapacityUnits :: Lens' DescribeLimitsResponse (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).

dlrsTableMaxReadCapacityUnits :: Lens' DescribeLimitsResponse (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).

dlrsAccountMaxWriteCapacityUnits :: Lens' DescribeLimitsResponse (Maybe Natural)

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

dlrsAccountMaxReadCapacityUnits :: Lens' DescribeLimitsResponse (Maybe Natural)

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

dlrsResponseStatus :: Lens' DescribeLimitsResponse Int

• - | The response status code.