| 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.CreateUsagePlan
Description
Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.
Synopsis
- data CreateUsagePlan = CreateUsagePlan' {}
- newCreateUsagePlan :: Text -> CreateUsagePlan
- createUsagePlan_apiStages :: Lens' CreateUsagePlan (Maybe [ApiStage])
- createUsagePlan_throttle :: Lens' CreateUsagePlan (Maybe ThrottleSettings)
- createUsagePlan_quota :: Lens' CreateUsagePlan (Maybe QuotaSettings)
- createUsagePlan_description :: Lens' CreateUsagePlan (Maybe Text)
- createUsagePlan_tags :: Lens' CreateUsagePlan (Maybe (HashMap Text Text))
- createUsagePlan_name :: Lens' CreateUsagePlan Text
- data UsagePlan = UsagePlan' {}
- newUsagePlan :: UsagePlan
- usagePlan_apiStages :: Lens' UsagePlan (Maybe [ApiStage])
- usagePlan_name :: Lens' UsagePlan (Maybe Text)
- usagePlan_id :: Lens' UsagePlan (Maybe Text)
- usagePlan_throttle :: Lens' UsagePlan (Maybe ThrottleSettings)
- usagePlan_quota :: Lens' UsagePlan (Maybe QuotaSettings)
- usagePlan_description :: Lens' UsagePlan (Maybe Text)
- usagePlan_productCode :: Lens' UsagePlan (Maybe Text)
- usagePlan_tags :: Lens' UsagePlan (Maybe (HashMap Text Text))
Creating a Request
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: newCreateUsagePlan smart constructor.
Constructors
| CreateUsagePlan' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> CreateUsagePlan |
Create a value of CreateUsagePlan 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:apiStages:CreateUsagePlan', createUsagePlan_apiStages - The associated API stages of the usage plan.
$sel:throttle:CreateUsagePlan', createUsagePlan_throttle - The throttling limits of the usage plan.
$sel:quota:CreateUsagePlan', createUsagePlan_quota - The quota of the usage plan.
$sel:description:CreateUsagePlan', createUsagePlan_description - The description of the usage plan.
$sel:tags:CreateUsagePlan', createUsagePlan_tags - The key-value map of strings. The valid character set is
[a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not
start with aws:. The tag value can be up to 256 characters.
$sel:name:CreateUsagePlan', createUsagePlan_name - [Required] The name of the usage plan.
Request Lenses
createUsagePlan_apiStages :: Lens' CreateUsagePlan (Maybe [ApiStage]) Source #
The associated API stages of the usage plan.
createUsagePlan_throttle :: Lens' CreateUsagePlan (Maybe ThrottleSettings) Source #
The throttling limits of the usage plan.
createUsagePlan_quota :: Lens' CreateUsagePlan (Maybe QuotaSettings) Source #
The quota of the usage plan.
createUsagePlan_description :: Lens' CreateUsagePlan (Maybe Text) Source #
The description of the usage plan.
createUsagePlan_tags :: Lens' CreateUsagePlan (Maybe (HashMap Text Text)) Source #
The key-value map of strings. The valid character set is
[a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not
start with aws:. The tag value can be up to 256 characters.
createUsagePlan_name :: Lens' CreateUsagePlan Text Source #
- Required
- The name of the usage plan.
Destructuring the Response
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: newUsagePlan smart constructor.
Constructors
| UsagePlan' | |
Fields
| |
Instances
newUsagePlan :: UsagePlan Source #
Create a value of UsagePlan 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:apiStages:UsagePlan', usagePlan_apiStages - The associated API stages of a usage plan.
$sel:name:UsagePlan', usagePlan_name - The name of a usage plan.
$sel:id:UsagePlan', usagePlan_id - The identifier of a UsagePlan resource.
$sel:throttle:UsagePlan', usagePlan_throttle - The request throttle limits of a usage plan.
$sel:quota:UsagePlan', usagePlan_quota - The maximum number of permitted requests per a given unit time interval.
$sel:description:UsagePlan', usagePlan_description - The description of a usage plan.
$sel:productCode:UsagePlan', usagePlan_productCode - The AWS Markeplace product identifier to associate with the usage plan
as a SaaS product on AWS Marketplace.
$sel:tags:UsagePlan', usagePlan_tags - The collection of tags. Each tag element is associated with a given
resource.
Response Lenses
usagePlan_apiStages :: Lens' UsagePlan (Maybe [ApiStage]) Source #
The associated API stages of a usage plan.
usagePlan_throttle :: Lens' UsagePlan (Maybe ThrottleSettings) Source #
The request throttle limits of a usage plan.
usagePlan_quota :: Lens' UsagePlan (Maybe QuotaSettings) Source #
The maximum number of permitted requests per a given unit time interval.