amazonka-apigateway-2.0: Amazon API Gateway SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.APIGateway.Types.UsagePlan

Description

 
Synopsis

Documentation

data UsagePlan Source #

Represents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using Amazon Web Services Budgets to monitor costs and WAF to manage API requests.

See: newUsagePlan smart constructor.

Constructors

UsagePlan' 

Fields

Instances

Instances details
FromJSON UsagePlan Source # 
Instance details

Defined in Amazonka.APIGateway.Types.UsagePlan

Generic UsagePlan Source # 
Instance details

Defined in Amazonka.APIGateway.Types.UsagePlan

Associated Types

type Rep UsagePlan :: Type -> Type #

Read UsagePlan Source # 
Instance details

Defined in Amazonka.APIGateway.Types.UsagePlan

Show UsagePlan Source # 
Instance details

Defined in Amazonka.APIGateway.Types.UsagePlan

NFData UsagePlan Source # 
Instance details

Defined in Amazonka.APIGateway.Types.UsagePlan

Methods

rnf :: UsagePlan -> () #

Eq UsagePlan Source # 
Instance details

Defined in Amazonka.APIGateway.Types.UsagePlan

Hashable UsagePlan Source # 
Instance details

Defined in Amazonka.APIGateway.Types.UsagePlan

type Rep UsagePlan Source # 
Instance details

Defined in Amazonka.APIGateway.Types.UsagePlan

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:description:UsagePlan', usagePlan_description - The description of a usage plan.

$sel:id:UsagePlan', usagePlan_id - The identifier of a UsagePlan resource.

$sel:name:UsagePlan', usagePlan_name - The name 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:quota:UsagePlan', usagePlan_quota - The target maximum number of permitted requests per a given unit time interval.

$sel:tags:UsagePlan', usagePlan_tags - The collection of tags. Each tag element is associated with a given resource.

UsagePlan, usagePlan_throttle - A map containing method level throttling information for API stage in a usage plan.

usagePlan_apiStages :: Lens' UsagePlan (Maybe [ApiStage]) Source #

The associated API stages of a usage plan.

usagePlan_description :: Lens' UsagePlan (Maybe Text) Source #

The description of a usage plan.

usagePlan_id :: Lens' UsagePlan (Maybe Text) Source #

The identifier of a UsagePlan resource.

usagePlan_name :: Lens' UsagePlan (Maybe Text) Source #

The name of a usage plan.

usagePlan_productCode :: Lens' UsagePlan (Maybe Text) Source #

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

usagePlan_quota :: Lens' UsagePlan (Maybe QuotaSettings) Source #

The target maximum number of permitted requests per a given unit time interval.

usagePlan_tags :: Lens' UsagePlan (Maybe (HashMap Text Text)) Source #

The collection of tags. Each tag element is associated with a given resource.

usagePlan_throttle :: Lens' UsagePlan (Maybe ThrottleSettings) Source #

A map containing method level throttling information for API stage in a usage plan.