Network.AWS.APIGateway.GetUsage

Gets the usage data of a usage plan in a specified time interval.

Creating a Request

getUsage

Arguments

:: Text

guUsagePlanId

-> Text

guStartDate

-> Text

guEndDate

-> GetUsage

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

Use one of the following lenses to modify other fields as desired:

• guKeyId - The Id of the API key associated with the resultant usage data.
• guLimit - The maximum number of results to be returned.
• guPosition - Position
• guUsagePlanId - The Id of the usage plan associated with the usage data.
• guStartDate - The starting date (e.g., 2016-01-01) of the usage data.
• guEndDate - The ending date (e.g., 2016-12-31) of the usage data.

data GetUsage

The GET request to get the usage data of a usage plan in a specified time interval.

See: getUsage smart constructor.

Instances

Eq GetUsage

Methods

(==) :: GetUsage -> GetUsage -> Bool

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

Data GetUsage

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetUsage -> c GetUsage

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetUsage

toConstr :: GetUsage -> Constr

dataTypeOf :: GetUsage -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetUsage)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetUsage)

gmapT :: (forall b. Data b => b -> b) -> GetUsage -> GetUsage

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetUsage -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetUsage -> r

gmapQ :: (forall d. Data d => d -> u) -> GetUsage -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetUsage -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetUsage -> m GetUsage

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetUsage -> m GetUsage

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetUsage -> m GetUsage

Read GetUsage

Methods

readsPrec :: Int -> ReadS GetUsage

readList :: ReadS [GetUsage]

readPrec :: ReadPrec GetUsage

readListPrec :: ReadPrec [GetUsage]

Show GetUsage

Methods

showsPrec :: Int -> GetUsage -> ShowS

show :: GetUsage -> String

showList :: [GetUsage] -> ShowS

Generic GetUsage

Associated Types

type Rep GetUsage :: * -> *

Methods

from :: GetUsage -> Rep GetUsage x

to :: Rep GetUsage x -> GetUsage

Hashable GetUsage

Methods

hashWithSalt :: Int -> GetUsage -> Int

hash :: GetUsage -> Int

NFData GetUsage

Methods

rnf :: GetUsage -> ()

AWSRequest GetUsage

Associated Types

type Rs GetUsage :: *

Methods

request :: GetUsage -> Request GetUsage

response :: MonadResource m => Logger -> Service -> Proxy * GetUsage -> ClientResponse -> m (Response GetUsage)

ToPath GetUsage

Methods

toPath :: GetUsage -> ByteString

ToHeaders GetUsage

Methods

toHeaders :: GetUsage -> [Header]

ToQuery GetUsage

Methods

toQuery :: GetUsage -> QueryString

type Rep GetUsage

type Rep GetUsage = D1 (MetaData "GetUsage" "Network.AWS.APIGateway.GetUsage" "amazonka-apigateway-1.4.5-BIK2fycuXdJFBbWQ9Hqf16" False) (C1 (MetaCons "GetUsage'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_guKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_guLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "_guPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_guUsagePlanId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_guStartDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_guEndDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))

type Rs GetUsage

type Rs GetUsage = Usage

Request Lenses

guKeyId :: Lens' GetUsage (Maybe Text)

The Id of the API key associated with the resultant usage data.

guLimit :: Lens' GetUsage (Maybe Int)

The maximum number of results to be returned.

guPosition :: Lens' GetUsage (Maybe Text)

Position

guUsagePlanId :: Lens' GetUsage Text

The Id of the usage plan associated with the usage data.

guStartDate :: Lens' GetUsage Text

The starting date (e.g., 2016-01-01) of the usage data.

guEndDate :: Lens' GetUsage Text

The ending date (e.g., 2016-12-31) of the usage data.

Destructuring the Response

usage :: Usage

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

Use one of the following lenses to modify other fields as desired:

• uUsagePlanId - The plan Id associated with this usage data.
• uEndDate - The ending date of the usage data.
• uItems - 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] .
• uStartDate - The starting date of the usage data.
• uPosition - Undocumented member.

data Usage

Represents the usage data of a usage plan.

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

See: usage smart constructor.

Instances

Eq Usage

Methods

(==) :: Usage -> Usage -> Bool

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

Data Usage

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Usage -> c Usage

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Usage

toConstr :: Usage -> Constr

dataTypeOf :: Usage -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Usage)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Usage)

gmapT :: (forall b. Data b => b -> b) -> Usage -> Usage

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Usage -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Usage -> r

gmapQ :: (forall d. Data d => d -> u) -> Usage -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Usage -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Usage -> m Usage

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Usage -> m Usage

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Usage -> m Usage

Read Usage

Methods

readsPrec :: Int -> ReadS Usage

readList :: ReadS [Usage]

readPrec :: ReadPrec Usage

readListPrec :: ReadPrec [Usage]

Show Usage

Methods

showsPrec :: Int -> Usage -> ShowS

show :: Usage -> String

showList :: [Usage] -> ShowS

Generic Usage

Associated Types

type Rep Usage :: * -> *

Methods

from :: Usage -> Rep Usage x

to :: Rep Usage x -> Usage

Hashable Usage

Methods

hashWithSalt :: Int -> Usage -> Int

hash :: Usage -> Int

FromJSON Usage

Methods

parseJSON :: Value -> Parser Usage

parseJSONList :: Value -> Parser [Usage]

NFData Usage

Methods

rnf :: Usage -> ()

type Rep Usage

type Rep Usage = D1 (MetaData "Usage" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.5-BIK2fycuXdJFBbWQ9Hqf16" False) (C1 (MetaCons "Usage'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_uUsagePlanId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_uEndDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_uItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text [[Integer]])))) ((:*:) (S1 (MetaSel (Just Symbol "_uStartDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_uPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

Response Lenses

uUsagePlanId :: Lens' Usage (Maybe Text)

The plan Id associated with this usage data.

uEndDate :: Lens' Usage (Maybe Text)

The ending date of the usage data.

uItems :: Lens' Usage (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] .

uStartDate :: Lens' Usage (Maybe Text)

The starting date of the usage data.

uPosition :: Lens' Usage (Maybe Text)

Undocumented member.