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

Description

Synopsis

data Usage = Usage' {
- usagePlanId :: Maybe Text
- endDate :: Maybe Text
- items :: Maybe (HashMap Text [[Integer]])
- startDate :: Maybe Text
- position :: Maybe Text
}
newUsage :: Usage
usage_usagePlanId :: Lens' Usage (Maybe Text)
usage_endDate :: Lens' Usage (Maybe Text)
usage_items :: Lens' Usage (Maybe (HashMap Text [[Integer]]))
usage_startDate :: Lens' Usage (Maybe Text)
usage_position :: Lens' Usage (Maybe Text)

Documentation

data Usage Source #

Represents the usage data of a usage plan.

Create and Use Usage Plans, Manage Usage in a Usage Plan

See: newUsage smart constructor.

Constructors

Usage'

Fields

usagePlanId :: Maybe Text
The plan Id associated with this usage data.
endDate :: Maybe Text
The ending date of the usage data.
items :: Maybe (HashMap Text [[Integer]])
The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].
startDate :: Maybe Text
The starting date of the usage data.
position :: Maybe Text

Instances

Instances details

Eq Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage Methods (==) :: Usage -> Usage -> Bool # (/=) :: Usage -> Usage -> Bool #
Read Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage Methods readsPrec :: Int -> ReadS Usage # readList :: ReadS [Usage] # readPrec :: ReadPrec Usage # readListPrec :: ReadPrec [Usage] #
Show Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage Methods showsPrec :: Int -> Usage -> ShowS # show :: Usage -> String # showList :: [Usage] -> ShowS #
Generic Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage Associated Types type Rep Usage :: Type -> Type # Methods from :: Usage -> Rep Usage x # to :: Rep Usage x -> Usage #
NFData Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage Methods rnf :: Usage -> () #
Hashable Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage Methods hashWithSalt :: Int -> Usage -> Int # hash :: Usage -> Int #
FromJSON Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage Methods parseJSON :: Value -> Parser Usage # parseJSONList :: Value -> Parser [Usage] #
type Rep Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage type Rep Usage = D1 ('MetaData "Usage" "Amazonka.APIGateway.Types.Usage" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "Usage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "usagePlanId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "endDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [[Integer]]))) :: (S1 ('MetaSel ('Just "startDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newUsage :: Usage Source #

Create a value of Usage 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:usagePlanId:Usage', usage_usagePlanId - The plan Id associated with this usage data.

$sel:endDate:Usage', usage_endDate - The ending date of the usage data.

$sel:items:Usage', usage_items - The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].

$sel:startDate:Usage', usage_startDate - The starting date of the usage data.

$sel:position:Usage', usage_position - Undocumented member.

usage_usagePlanId :: Lens' Usage (Maybe Text) Source #

The plan Id associated with this usage data.

usage_endDate :: Lens' Usage (Maybe Text) Source #

The ending date of the usage data.

usage_items :: Lens' Usage (Maybe (HashMap Text [[Integer]])) Source #

The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].

usage_startDate :: Lens' Usage (Maybe Text) Source #

The starting date of the usage data.

usage_position :: Lens' Usage (Maybe Text) Source #

Undocumented member.