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

Description

Synopsis

data QuotaSettings = QuotaSettings' {
- offset :: Maybe Int
- period :: Maybe QuotaPeriodType
- limit :: Maybe Int
}
newQuotaSettings :: QuotaSettings
quotaSettings_offset :: Lens' QuotaSettings (Maybe Int)
quotaSettings_period :: Lens' QuotaSettings (Maybe QuotaPeriodType)
quotaSettings_limit :: Lens' QuotaSettings (Maybe Int)

Documentation

data QuotaSettings Source #

Quotas configured for a usage plan.

See: newQuotaSettings smart constructor.

Constructors

QuotaSettings'
Fields offset :: Maybe Int The day that a time period starts. For example, with a time period of `WEEK`, an offset of `0` starts on Sunday, and an offset of `1` starts on Monday. period :: Maybe QuotaPeriodType The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH". limit :: Maybe Int The maximum number of requests that can be made in a given time period.

Instances

Instances details

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

newQuotaSettings :: QuotaSettings Source #

Create a value of QuotaSettings 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:offset:QuotaSettings', quotaSettings_offset - The day that a time period starts. For example, with a time period of WEEK, an offset of 0 starts on Sunday, and an offset of 1 starts on Monday.

$sel:period:QuotaSettings', quotaSettings_period - The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

$sel:limit:QuotaSettings', quotaSettings_limit - The maximum number of requests that can be made in a given time period.

quotaSettings_offset :: Lens' QuotaSettings (Maybe Int) Source #

The day that a time period starts. For example, with a time period of WEEK, an offset of 0 starts on Sunday, and an offset of 1 starts on Monday.

quotaSettings_period :: Lens' QuotaSettings (Maybe QuotaPeriodType) Source #

The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

quotaSettings_limit :: Lens' QuotaSettings (Maybe Int) Source #

The maximum number of requests that can be made in a given time period.