amazonka-dynamodb-1.6.1: Amazon DynamoDB SDK.

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

Network.AWS.DynamoDB.DescribeLimits

Contents

Description

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

Synopsis

Creating a Request

describeLimits :: DescribeLimits Source #

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

data DescribeLimits Source #

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

See: describeLimits smart constructor.

Instances
Eq DescribeLimits Source # 
Instance details

Defined in Network.AWS.DynamoDB.DescribeLimits

Data DescribeLimits Source # 
Instance details

Defined in Network.AWS.DynamoDB.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 Source # 
Instance details

Defined in Network.AWS.DynamoDB.DescribeLimits

Show DescribeLimits Source # 
Instance details

Defined in Network.AWS.DynamoDB.DescribeLimits

Generic DescribeLimits Source # 
Instance details

Defined in Network.AWS.DynamoDB.DescribeLimits

Associated Types

type Rep DescribeLimits :: Type -> Type #

Hashable DescribeLimits Source # 
Instance details

Defined in Network.AWS.DynamoDB.DescribeLimits

ToJSON DescribeLimits Source # 
Instance details

Defined in Network.AWS.DynamoDB.DescribeLimits

AWSRequest DescribeLimits Source # 
Instance details

Defined in Network.AWS.DynamoDB.DescribeLimits

Associated Types

type Rs DescribeLimits :: Type #

ToHeaders DescribeLimits Source # 
Instance details

Defined in Network.AWS.DynamoDB.DescribeLimits

ToPath DescribeLimits Source # 
Instance details

Defined in Network.AWS.DynamoDB.DescribeLimits

ToQuery DescribeLimits Source # 
Instance details

Defined in Network.AWS.DynamoDB.DescribeLimits

NFData DescribeLimits Source # 
Instance details

Defined in Network.AWS.DynamoDB.DescribeLimits

Methods

rnf :: DescribeLimits -> () #

type Rep DescribeLimits Source # 
Instance details

Defined in Network.AWS.DynamoDB.DescribeLimits

type Rep DescribeLimits = D1 (MetaData "DescribeLimits" "Network.AWS.DynamoDB.DescribeLimits" "amazonka-dynamodb-1.6.1-FTtIhwsA5vX17zvPeEA8Mr" False) (C1 (MetaCons "DescribeLimits'" PrefixI False) (U1 :: Type -> Type))
type Rs DescribeLimits Source # 
Instance details

Defined in Network.AWS.DynamoDB.DescribeLimits

Destructuring the Response

describeLimitsResponse Source #

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 Source #

Represents the output of a DescribeLimits operation.

See: describeLimitsResponse smart constructor.

Instances
Eq DescribeLimitsResponse Source # 
Instance details

Defined in Network.AWS.DynamoDB.DescribeLimits

Data DescribeLimitsResponse Source # 
Instance details

Defined in Network.AWS.DynamoDB.DescribeLimits

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 Source # 
Instance details

Defined in Network.AWS.DynamoDB.DescribeLimits

Show DescribeLimitsResponse Source # 
Instance details

Defined in Network.AWS.DynamoDB.DescribeLimits

Generic DescribeLimitsResponse Source # 
Instance details

Defined in Network.AWS.DynamoDB.DescribeLimits

Associated Types

type Rep DescribeLimitsResponse :: Type -> Type #

NFData DescribeLimitsResponse Source # 
Instance details

Defined in Network.AWS.DynamoDB.DescribeLimits

Methods

rnf :: DescribeLimitsResponse -> () #

type Rep DescribeLimitsResponse Source # 
Instance details

Defined in Network.AWS.DynamoDB.DescribeLimits

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

Response Lenses

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

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

dlrsAccountMaxWriteCapacityUnits :: 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.

dlrsAccountMaxReadCapacityUnits :: 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.

dlrsResponseStatus :: Lens' DescribeLimitsResponse Int Source #

  • - | The response status code.