Amazonka.APIGateway.Types.QuotaSettings

Documentation

data QuotaSettings

Quotas configured for a usage plan.

See: newQuotaSettings smart constructor.

Constructors

QuotaSettings'

Fields

• limit :: Maybe Int

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

• offset :: Maybe Int

  The number of requests subtracted from the given limit in the initial time period.

• period :: Maybe QuotaPeriodType

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

Instances

FromJSON QuotaSettings

Defined in Amazonka.APIGateway.Types.QuotaSettings

Methods

parseJSON :: Value -> Parser QuotaSettings

parseJSONList :: Value -> Parser [QuotaSettings]

ToJSON QuotaSettings

Defined in Amazonka.APIGateway.Types.QuotaSettings

Methods

toJSON :: QuotaSettings -> Value

toEncoding :: QuotaSettings -> Encoding

toJSONList :: [QuotaSettings] -> Value

toEncodingList :: [QuotaSettings] -> Encoding

Generic QuotaSettings

Defined in Amazonka.APIGateway.Types.QuotaSettings

Associated Types

type Rep QuotaSettings :: Type -> Type

Methods

from :: QuotaSettings -> Rep QuotaSettings x

to :: Rep QuotaSettings x -> QuotaSettings

Read QuotaSettings

Defined in Amazonka.APIGateway.Types.QuotaSettings

Methods

readsPrec :: Int -> ReadS QuotaSettings

readList :: ReadS [QuotaSettings]

readPrec :: ReadPrec QuotaSettings

readListPrec :: ReadPrec [QuotaSettings]

Show QuotaSettings

Defined in Amazonka.APIGateway.Types.QuotaSettings

Methods

showsPrec :: Int -> QuotaSettings -> ShowS

show :: QuotaSettings -> String

showList :: [QuotaSettings] -> ShowS

NFData QuotaSettings

Defined in Amazonka.APIGateway.Types.QuotaSettings

Methods

rnf :: QuotaSettings -> ()

Eq QuotaSettings

Defined in Amazonka.APIGateway.Types.QuotaSettings

Methods

(==) :: QuotaSettings -> QuotaSettings -> Bool

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

Hashable QuotaSettings

Defined in Amazonka.APIGateway.Types.QuotaSettings

Methods

hashWithSalt :: Int -> QuotaSettings -> Int

hash :: QuotaSettings -> Int

type Rep QuotaSettings

Defined in Amazonka.APIGateway.Types.QuotaSettings

type Rep QuotaSettings = D1 ('MetaData "QuotaSettings" "Amazonka.APIGateway.Types.QuotaSettings" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "QuotaSettings'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "offset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "period") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QuotaPeriodType)))))

newQuotaSettings :: QuotaSettings

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:limit:QuotaSettings', quotaSettings_limit - The target maximum number of requests that can be made in a given time period.

$sel:offset:QuotaSettings', quotaSettings_offset - The number of requests subtracted from the given limit in the initial time period.

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

quotaSettings_limit :: Lens' QuotaSettings (Maybe Int)

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

quotaSettings_offset :: Lens' QuotaSettings (Maybe Int)

The number of requests subtracted from the given limit in the initial time period.

quotaSettings_period :: Lens' QuotaSettings (Maybe QuotaPeriodType)

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