Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.APIGateway.CreateUsagePlan

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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' {
- apiStages :: Maybe [ApiStage]
- description :: Maybe Text
- quota :: Maybe QuotaSettings
- tags :: Maybe (HashMap Text Text)
- throttle :: Maybe ThrottleSettings
- name :: Text
}
newCreateUsagePlan :: Text -> CreateUsagePlan
createUsagePlan_apiStages :: Lens' CreateUsagePlan (Maybe [ApiStage])
createUsagePlan_description :: Lens' CreateUsagePlan (Maybe Text)
createUsagePlan_quota :: Lens' CreateUsagePlan (Maybe QuotaSettings)
createUsagePlan_tags :: Lens' CreateUsagePlan (Maybe (HashMap Text Text))
createUsagePlan_throttle :: Lens' CreateUsagePlan (Maybe ThrottleSettings)
createUsagePlan_name :: Lens' CreateUsagePlan Text
data UsagePlan = UsagePlan' {
- apiStages :: Maybe [ApiStage]
- description :: Maybe Text
- id :: Maybe Text
- name :: Maybe Text
- productCode :: Maybe Text
- quota :: Maybe QuotaSettings
- tags :: Maybe (HashMap Text Text)
- throttle :: Maybe ThrottleSettings
}
newUsagePlan :: UsagePlan
usagePlan_apiStages :: Lens' UsagePlan (Maybe [ApiStage])
usagePlan_description :: Lens' UsagePlan (Maybe Text)
usagePlan_id :: Lens' UsagePlan (Maybe Text)
usagePlan_name :: Lens' UsagePlan (Maybe Text)
usagePlan_productCode :: Lens' UsagePlan (Maybe Text)
usagePlan_quota :: Lens' UsagePlan (Maybe QuotaSettings)
usagePlan_tags :: Lens' UsagePlan (Maybe (HashMap Text Text))
usagePlan_throttle :: Lens' UsagePlan (Maybe ThrottleSettings)

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

apiStages :: Maybe [ApiStage]
The associated API stages of the usage plan.
description :: Maybe Text
The description of the usage plan.
quota :: Maybe QuotaSettings
The quota of the usage plan.
tags :: Maybe (HashMap Text Text)
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.
throttle :: Maybe ThrottleSettings
The throttling limits of the usage plan.
name :: Text
The name of the usage plan.

Instances

Instances details

ToJSON CreateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlan Methods toJSON :: CreateUsagePlan -> Value # toEncoding :: CreateUsagePlan -> Encoding # toJSONList :: [CreateUsagePlan] -> Value # toEncodingList :: [CreateUsagePlan] -> Encoding #
ToHeaders CreateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlan Methods toHeaders :: CreateUsagePlan -> [Header] #
ToPath CreateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlan Methods toPath :: CreateUsagePlan -> ByteString #
ToQuery CreateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlan Methods toQuery :: CreateUsagePlan -> QueryString #
AWSRequest CreateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlan Associated Types type AWSResponse CreateUsagePlan # Methods request :: (Service -> Service) -> CreateUsagePlan -> Request CreateUsagePlan # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateUsagePlan -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateUsagePlan))) #
Generic CreateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlan Associated Types type Rep CreateUsagePlan :: Type -> Type # Methods from :: CreateUsagePlan -> Rep CreateUsagePlan x # to :: Rep CreateUsagePlan x -> CreateUsagePlan #
Read CreateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlan Methods readsPrec :: Int -> ReadS CreateUsagePlan # readList :: ReadS [CreateUsagePlan] # readPrec :: ReadPrec CreateUsagePlan # readListPrec :: ReadPrec [CreateUsagePlan] #
Show CreateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlan Methods showsPrec :: Int -> CreateUsagePlan -> ShowS # show :: CreateUsagePlan -> String # showList :: [CreateUsagePlan] -> ShowS #
NFData CreateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlan Methods rnf :: CreateUsagePlan -> () #
Eq CreateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlan Methods (==) :: CreateUsagePlan -> CreateUsagePlan -> Bool # (/=) :: CreateUsagePlan -> CreateUsagePlan -> Bool #
Hashable CreateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlan Methods hashWithSalt :: Int -> CreateUsagePlan -> Int # hash :: CreateUsagePlan -> Int #
type AWSResponse CreateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlan type AWSResponse CreateUsagePlan = UsagePlan
type Rep CreateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlan type Rep CreateUsagePlan = D1 ('MetaData "CreateUsagePlan" "Amazonka.APIGateway.CreateUsagePlan" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "CreateUsagePlan'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "apiStages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ApiStage])) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "quota") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QuotaSettings)))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "throttle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThrottleSettings)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateUsagePlan Source #

Arguments

:: Text	`CreateUsagePlan`
-> 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:

CreateUsagePlan, createUsagePlan_apiStages - The associated API stages of the usage plan.

CreateUsagePlan, createUsagePlan_description - The description of the usage plan.

CreateUsagePlan, createUsagePlan_quota - The quota of the usage plan.

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.

CreateUsagePlan, createUsagePlan_throttle - The throttling limits of the usage plan.

CreateUsagePlan, createUsagePlan_name - The name of the usage plan.

Request Lenses

createUsagePlan_apiStages :: Lens' CreateUsagePlan (Maybe [ApiStage]) Source #

The associated API stages of the usage plan.

createUsagePlan_description :: Lens' CreateUsagePlan (Maybe Text) Source #

The description of the usage plan.

createUsagePlan_quota :: Lens' CreateUsagePlan (Maybe QuotaSettings) Source #

The quota 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_throttle :: Lens' CreateUsagePlan (Maybe ThrottleSettings) Source #

The throttling limits of the usage plan.

createUsagePlan_name :: Lens' CreateUsagePlan Text Source #

The name of the usage plan.

Destructuring the Response

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

apiStages :: Maybe [ApiStage]
The associated API stages of a usage plan.
description :: Maybe Text
The description of a usage plan.
id :: Maybe Text
The identifier of a UsagePlan resource.
name :: Maybe Text
The name of a usage plan.
productCode :: Maybe Text
The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
quota :: Maybe QuotaSettings
The target maximum number of permitted requests per a given unit time interval.
tags :: Maybe (HashMap Text Text)
The collection of tags. Each tag element is associated with a given resource.
throttle :: Maybe ThrottleSettings
A map containing method level throttling information for API stage in a usage plan.

Instances

Instances details

FromJSON UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods parseJSON :: Value -> Parser UsagePlan # parseJSONList :: Value -> Parser [UsagePlan] #
Generic UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Associated Types type Rep UsagePlan :: Type -> Type # Methods from :: UsagePlan -> Rep UsagePlan x # to :: Rep UsagePlan x -> UsagePlan #
Read UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods readsPrec :: Int -> ReadS UsagePlan # readList :: ReadS [UsagePlan] # readPrec :: ReadPrec UsagePlan # readListPrec :: ReadPrec [UsagePlan] #
Show UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods showsPrec :: Int -> UsagePlan -> ShowS # show :: UsagePlan -> String # showList :: [UsagePlan] -> ShowS #
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 Methods (==) :: UsagePlan -> UsagePlan -> Bool # (/=) :: UsagePlan -> UsagePlan -> Bool #
Hashable UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods hashWithSalt :: Int -> UsagePlan -> Int # hash :: UsagePlan -> Int #
type Rep UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan type Rep UsagePlan = D1 ('MetaData "UsagePlan" "Amazonka.APIGateway.Types.UsagePlan" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UsagePlan'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "apiStages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ApiStage])) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "productCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "quota") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QuotaSettings))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "throttle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThrottleSettings))))))

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.

Response Lenses

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.