Copyright | (c) 2013-2017 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 |
Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
- createUsagePlan :: Text -> CreateUsagePlan
- data CreateUsagePlan
- cupApiStages :: Lens' CreateUsagePlan [APIStage]
- cupThrottle :: Lens' CreateUsagePlan (Maybe ThrottleSettings)
- cupQuota :: Lens' CreateUsagePlan (Maybe QuotaSettings)
- cupDescription :: Lens' CreateUsagePlan (Maybe Text)
- cupName :: Lens' CreateUsagePlan 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)
- upProductCode :: Lens' UsagePlan (Maybe Text)
Creating a Request
Creates a value of CreateUsagePlan
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cupApiStages
- The associated API stages of the usage plan.cupThrottle
- The throttling limits of the usage plan.cupQuota
- The quota of the usage plan.cupDescription
- The description of the usage plan.cupName
- The name of the usage plan.
data CreateUsagePlan Source #
The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.
See: createUsagePlan
smart constructor.
Request Lenses
cupApiStages :: Lens' CreateUsagePlan [APIStage] Source #
The associated API stages of the usage plan.
cupThrottle :: Lens' CreateUsagePlan (Maybe ThrottleSettings) Source #
The throttling limits of the usage plan.
cupQuota :: Lens' CreateUsagePlan (Maybe QuotaSettings) Source #
The quota of the usage plan.
cupDescription :: Lens' CreateUsagePlan (Maybe Text) Source #
The description of the usage plan.
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:
upApiStages
- The associated API stages of a usage plan.upName
- The name of a usage plan.upId
- The identifier of aUsagePlan
resource.upThrottle
- The request throttle limits of a usage plan.upQuota
- The maximum number of permitted requests per a given unit time interval.upDescription
- The description of a usage plan.upProductCode
- The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
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.