Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Gets a usage plan of a given plan identifier.
- getUsagePlan :: Text -> GetUsagePlan
- data GetUsagePlan
- gupUsagePlanId :: Lens' GetUsagePlan Text
- usagePlan :: UsagePlan
- data UsagePlan
- upApiStages :: Lens' UsagePlan [APIStage]
- upName :: Lens' UsagePlan (Maybe Text)
- upId :: Lens' UsagePlan (Maybe Text)
- upThrottle :: Lens' UsagePlan (Maybe ThrottleSettings)
- upQuota :: Lens' UsagePlan (Maybe QuotaSettings)
- upDescription :: Lens' UsagePlan (Maybe Text)
Creating a Request
Creates a value of GetUsagePlan
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data GetUsagePlan Source #
The GET request to get a usage plan of a given plan identifier.
See: getUsagePlan
smart constructor.
Request Lenses
gupUsagePlanId :: Lens' GetUsagePlan Text Source #
The identifier of the UsagePlan resource to be retrieved.
Destructuring the Response
usagePlan :: UsagePlan Source #
Creates a value of UsagePlan
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Represents a usage plan than can specify who can assess associated API stages with specified request limits and quotas.
In a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan.
See: usagePlan
smart constructor.
Response Lenses
upThrottle :: Lens' UsagePlan (Maybe ThrottleSettings) Source #
The request throttle limits of a usage plan.