amazonka-apigateway-1.4.5: Amazon API Gateway SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.APIGateway.CreateUsagePlan

Contents

Description

Creates a usage plan with the throttle and quota limits, as well as the associated API stages, specified in the payload.

Synopsis

Creating a Request

createUsagePlan #

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:

data CreateUsagePlan #

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.

Instances

Eq CreateUsagePlan # 
Data CreateUsagePlan # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateUsagePlan -> c CreateUsagePlan #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateUsagePlan #

toConstr :: CreateUsagePlan -> Constr #

dataTypeOf :: CreateUsagePlan -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateUsagePlan) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateUsagePlan) #

gmapT :: (forall b. Data b => b -> b) -> CreateUsagePlan -> CreateUsagePlan #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateUsagePlan -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateUsagePlan -> r #

gmapQ :: (forall d. Data d => d -> u) -> CreateUsagePlan -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateUsagePlan -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateUsagePlan -> m CreateUsagePlan #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateUsagePlan -> m CreateUsagePlan #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateUsagePlan -> m CreateUsagePlan #

Read CreateUsagePlan # 
Show CreateUsagePlan # 
Generic CreateUsagePlan # 
Hashable CreateUsagePlan # 
ToJSON CreateUsagePlan # 
NFData CreateUsagePlan # 

Methods

rnf :: CreateUsagePlan -> () #

AWSRequest CreateUsagePlan # 
ToQuery CreateUsagePlan # 
ToPath CreateUsagePlan # 
ToHeaders CreateUsagePlan # 
type Rep CreateUsagePlan # 
type Rep CreateUsagePlan = D1 (MetaData "CreateUsagePlan" "Network.AWS.APIGateway.CreateUsagePlan" "amazonka-apigateway-1.4.5-5OCToOwmZjEH3FMiU9Yogu" False) (C1 (MetaCons "CreateUsagePlan'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cupApiStages") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [APIStage]))) (S1 (MetaSel (Just Symbol "_cupThrottle") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ThrottleSettings)))) ((:*:) (S1 (MetaSel (Just Symbol "_cupQuota") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe QuotaSettings))) ((:*:) (S1 (MetaSel (Just Symbol "_cupDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))
type Rs CreateUsagePlan # 

Request Lenses

cupApiStages :: Lens' CreateUsagePlan [APIStage] #

The associated API stages of the usage plan.

cupThrottle :: Lens' CreateUsagePlan (Maybe ThrottleSettings) #

The throttling limits of the usage plan.

cupQuota :: Lens' CreateUsagePlan (Maybe QuotaSettings) #

The quota of the usage plan.

cupDescription :: Lens' CreateUsagePlan (Maybe Text) #

The description of the usage plan.

cupName :: Lens' CreateUsagePlan Text #

The name of the usage plan.

Destructuring the Response

usagePlan :: UsagePlan #

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 a UsagePlan 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.

data UsagePlan #

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.

Create and Use Usage Plans

See: usagePlan smart constructor.

Instances

Eq UsagePlan # 
Data UsagePlan # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UsagePlan -> c UsagePlan #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UsagePlan #

toConstr :: UsagePlan -> Constr #

dataTypeOf :: UsagePlan -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UsagePlan) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UsagePlan) #

gmapT :: (forall b. Data b => b -> b) -> UsagePlan -> UsagePlan #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UsagePlan -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UsagePlan -> r #

gmapQ :: (forall d. Data d => d -> u) -> UsagePlan -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> UsagePlan -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UsagePlan -> m UsagePlan #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UsagePlan -> m UsagePlan #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UsagePlan -> m UsagePlan #

Read UsagePlan # 
Show UsagePlan # 
Generic UsagePlan # 

Associated Types

type Rep UsagePlan :: * -> * #

Hashable UsagePlan # 
FromJSON UsagePlan # 
NFData UsagePlan # 

Methods

rnf :: UsagePlan -> () #

type Rep UsagePlan # 

Response Lenses

upApiStages :: Lens' UsagePlan [APIStage] #

The associated API stages of a usage plan.

upName :: Lens' UsagePlan (Maybe Text) #

The name of a usage plan.

upId :: Lens' UsagePlan (Maybe Text) #

The identifier of a UsagePlan resource.

upThrottle :: Lens' UsagePlan (Maybe ThrottleSettings) #

The request throttle limits of a usage plan.

upQuota :: Lens' UsagePlan (Maybe QuotaSettings) #

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

upDescription :: Lens' UsagePlan (Maybe Text) #

The description of a usage plan.

upProductCode :: Lens' UsagePlan (Maybe Text) #

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