| Copyright | (c) 2013-2018 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 |
| Language | Haskell2010 |
Network.AWS.APIGateway.GetUsage
Description
Gets the usage data of a usage plan in a specified time interval.
This operation returns paginated results.
Synopsis
- getUsage :: Text -> Text -> Text -> GetUsage
- data GetUsage
- guKeyId :: Lens' GetUsage (Maybe Text)
- guLimit :: Lens' GetUsage (Maybe Int)
- guPosition :: Lens' GetUsage (Maybe Text)
- guUsagePlanId :: Lens' GetUsage Text
- guStartDate :: Lens' GetUsage Text
- guEndDate :: Lens' GetUsage Text
- usage :: Usage
- data Usage
- uUsagePlanId :: Lens' Usage (Maybe Text)
- uEndDate :: Lens' Usage (Maybe Text)
- uItems :: Lens' Usage (HashMap Text [[Integer]])
- uStartDate :: Lens' Usage (Maybe Text)
- uPosition :: Lens' Usage (Maybe Text)
Creating a Request
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 returned results per page. The default value is 25 and the maximum value is 500.guPosition- The current pagination position in the paged result set.guUsagePlanId- [Required] The Id of the usage plan associated with the usage data.guStartDate- [Required] The starting date (e.g., 2016-01-01) of the usage data.guEndDate- [Required] The ending date (e.g., 2016-12-31) of the usage data.
The GET request to get the usage data of a usage plan in a specified time interval.
See: getUsage smart constructor.
Instances
Request Lenses
guKeyId :: Lens' GetUsage (Maybe Text) Source #
The Id of the API key associated with the resultant usage data.
guLimit :: Lens' GetUsage (Maybe Int) Source #
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
guPosition :: Lens' GetUsage (Maybe Text) Source #
The current pagination position in the paged result set.
guUsagePlanId :: Lens' GetUsage Text Source #
- Required
- The Id of the usage plan associated with the usage data.
guStartDate :: Lens' GetUsage Text Source #
- Required
- The starting date (e.g., 2016-01-01) of the usage data.
guEndDate :: Lens' GetUsage Text Source #
- Required
- The ending date (e.g., 2016-12-31) of the usage data.
Destructuring the Response
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.
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 Source # | |
| Data Usage Source # | |
Defined in Network.AWS.APIGateway.Types.Product 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 # 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 Source # | |
| Show Usage Source # | |
| Generic Usage Source # | |
| Hashable Usage Source # | |
Defined in Network.AWS.APIGateway.Types.Product | |
| FromJSON Usage Source # | |
| NFData Usage Source # | |
Defined in Network.AWS.APIGateway.Types.Product | |
| type Rep Usage Source # | |
Defined in Network.AWS.APIGateway.Types.Product type Rep Usage = D1 (MetaData "Usage" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.6.1-BCCM2RP3l9Q2ENgHvKrj59" False) (C1 (MetaCons "Usage'" PrefixI True) ((S1 (MetaSel (Just "_uUsagePlanId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_uEndDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_uItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text [[Integer]]))) :*: (S1 (MetaSel (Just "_uStartDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_uPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) | |
Response Lenses
uItems :: Lens' Usage (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] .