Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.APIGateway.Types.ThrottleSettings

Description

Synopsis

Documentation

data ThrottleSettings Source #

The API request rate limits.

See: newThrottleSettings smart constructor.

Constructors

ThrottleSettings'
Fields burstLimit :: Maybe Int The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity. rateLimit :: Maybe Double The API request steady-state rate limit.

Instances

Instances details

Eq ThrottleSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.ThrottleSettings Methods (==) :: ThrottleSettings -> ThrottleSettings -> Bool # (/=) :: ThrottleSettings -> ThrottleSettings -> Bool #
Read ThrottleSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.ThrottleSettings Methods readsPrec :: Int -> ReadS ThrottleSettings # readList :: ReadS [ThrottleSettings] # readPrec :: ReadPrec ThrottleSettings # readListPrec :: ReadPrec [ThrottleSettings] #
Show ThrottleSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.ThrottleSettings Methods showsPrec :: Int -> ThrottleSettings -> ShowS # show :: ThrottleSettings -> String # showList :: [ThrottleSettings] -> ShowS #
Generic ThrottleSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.ThrottleSettings Associated Types type Rep ThrottleSettings :: Type -> Type # Methods from :: ThrottleSettings -> Rep ThrottleSettings x # to :: Rep ThrottleSettings x -> ThrottleSettings #
NFData ThrottleSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.ThrottleSettings Methods rnf :: ThrottleSettings -> () #
Hashable ThrottleSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.ThrottleSettings Methods hashWithSalt :: Int -> ThrottleSettings -> Int # hash :: ThrottleSettings -> Int #
ToJSON ThrottleSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.ThrottleSettings Methods toJSON :: ThrottleSettings -> Value # toEncoding :: ThrottleSettings -> Encoding # toJSONList :: [ThrottleSettings] -> Value # toEncodingList :: [ThrottleSettings] -> Encoding #
FromJSON ThrottleSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.ThrottleSettings Methods parseJSON :: Value -> Parser ThrottleSettings # parseJSONList :: Value -> Parser [ThrottleSettings] #
type Rep ThrottleSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.ThrottleSettings type Rep ThrottleSettings = D1 ('MetaData "ThrottleSettings" "Amazonka.APIGateway.Types.ThrottleSettings" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "ThrottleSettings'" 'PrefixI 'True) (S1 ('MetaSel ('Just "burstLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "rateLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))

newThrottleSettings :: ThrottleSettings Source #

Create a value of ThrottleSettings 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:burstLimit:ThrottleSettings', throttleSettings_burstLimit - The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.

$sel:rateLimit:ThrottleSettings', throttleSettings_rateLimit - The API request steady-state rate limit.

throttleSettings_burstLimit :: Lens' ThrottleSettings (Maybe Int) Source #

The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.

throttleSettings_rateLimit :: Lens' ThrottleSettings (Maybe Double) Source #

The API request steady-state rate limit.