Network.AWS.APIGateway.UpdateUsagePlan

Updates a usage plan of a given plan Id.

Creating a Request

updateUsagePlan

Arguments

:: Text

uupUsagePlanId

-> UpdateUsagePlan

Creates a value of UpdateUsagePlan with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• uupPatchOperations - A list of update operations to be applied to the specified resource and in the order specified in this list.
• uupUsagePlanId - [Required] The Id of the to-be-updated usage plan.

data UpdateUsagePlan

The PATCH request to update a usage plan of a given plan Id.

See: updateUsagePlan smart constructor.

Instances

Eq UpdateUsagePlan

Defined in Network.AWS.APIGateway.UpdateUsagePlan

Methods

(==) :: UpdateUsagePlan -> UpdateUsagePlan -> Bool

(/=) :: UpdateUsagePlan -> UpdateUsagePlan -> Bool

Data UpdateUsagePlan

Defined in Network.AWS.APIGateway.UpdateUsagePlan

Methods

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

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

toConstr :: UpdateUsagePlan -> Constr

dataTypeOf :: UpdateUsagePlan -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UpdateUsagePlan)

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

gmapT :: (forall b. Data b => b -> b) -> UpdateUsagePlan -> UpdateUsagePlan

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

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

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

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

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

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

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

Read UpdateUsagePlan

Defined in Network.AWS.APIGateway.UpdateUsagePlan

Methods

readsPrec :: Int -> ReadS UpdateUsagePlan

readList :: ReadS [UpdateUsagePlan]

readPrec :: ReadPrec UpdateUsagePlan

readListPrec :: ReadPrec [UpdateUsagePlan]

Show UpdateUsagePlan

Defined in Network.AWS.APIGateway.UpdateUsagePlan

Methods

showsPrec :: Int -> UpdateUsagePlan -> ShowS

show :: UpdateUsagePlan -> String

showList :: [UpdateUsagePlan] -> ShowS

Generic UpdateUsagePlan

Defined in Network.AWS.APIGateway.UpdateUsagePlan

Associated Types

type Rep UpdateUsagePlan :: Type -> Type

Methods

from :: UpdateUsagePlan -> Rep UpdateUsagePlan x

to :: Rep UpdateUsagePlan x -> UpdateUsagePlan

Hashable UpdateUsagePlan

Defined in Network.AWS.APIGateway.UpdateUsagePlan

Methods

hashWithSalt :: Int -> UpdateUsagePlan -> Int

hash :: UpdateUsagePlan -> Int

ToJSON UpdateUsagePlan

Defined in Network.AWS.APIGateway.UpdateUsagePlan

Methods

toJSON :: UpdateUsagePlan -> Value

toEncoding :: UpdateUsagePlan -> Encoding

toJSONList :: [UpdateUsagePlan] -> Value

toEncodingList :: [UpdateUsagePlan] -> Encoding

AWSRequest UpdateUsagePlan

Defined in Network.AWS.APIGateway.UpdateUsagePlan

Associated Types

type Rs UpdateUsagePlan :: Type

Methods

request :: UpdateUsagePlan -> Request UpdateUsagePlan

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy UpdateUsagePlan -> ClientResponse -> m (Response UpdateUsagePlan)

ToHeaders UpdateUsagePlan

Defined in Network.AWS.APIGateway.UpdateUsagePlan

Methods

toHeaders :: UpdateUsagePlan -> [Header]

ToPath UpdateUsagePlan

Defined in Network.AWS.APIGateway.UpdateUsagePlan

Methods

toPath :: UpdateUsagePlan -> ByteString

ToQuery UpdateUsagePlan

Defined in Network.AWS.APIGateway.UpdateUsagePlan

Methods

toQuery :: UpdateUsagePlan -> QueryString

NFData UpdateUsagePlan

Defined in Network.AWS.APIGateway.UpdateUsagePlan

Methods

rnf :: UpdateUsagePlan -> ()

type Rep UpdateUsagePlan

Defined in Network.AWS.APIGateway.UpdateUsagePlan

type Rep UpdateUsagePlan = D1 (MetaData "UpdateUsagePlan" "Network.AWS.APIGateway.UpdateUsagePlan" "amazonka-apigateway-1.6.1-BCCM2RP3l9Q2ENgHvKrj59" False) (C1 (MetaCons "UpdateUsagePlan'" PrefixI True) (S1 (MetaSel (Just "_uupPatchOperations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [PatchOperation])) :*: S1 (MetaSel (Just "_uupUsagePlanId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))

type Rs UpdateUsagePlan

Defined in Network.AWS.APIGateway.UpdateUsagePlan

type Rs UpdateUsagePlan = UsagePlan

Request Lenses

uupPatchOperations :: Lens' UpdateUsagePlan [PatchOperation]

A list of update operations to be applied to the specified resource and in the order specified in this list.

uupUsagePlanId :: Lens' UpdateUsagePlan Text

Required

The Id of the to-be-updated 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

Defined in Network.AWS.APIGateway.Types.Product

Methods

(==) :: UsagePlan -> UsagePlan -> Bool

(/=) :: UsagePlan -> UsagePlan -> Bool

Data UsagePlan

Defined in Network.AWS.APIGateway.Types.Product

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

Defined in Network.AWS.APIGateway.Types.Product

Methods

readsPrec :: Int -> ReadS UsagePlan

readList :: ReadS [UsagePlan]

readPrec :: ReadPrec UsagePlan

readListPrec :: ReadPrec [UsagePlan]

Show UsagePlan

Defined in Network.AWS.APIGateway.Types.Product

Methods

showsPrec :: Int -> UsagePlan -> ShowS

show :: UsagePlan -> String

showList :: [UsagePlan] -> ShowS

Generic UsagePlan

Defined in Network.AWS.APIGateway.Types.Product

Associated Types

type Rep UsagePlan :: Type -> Type

Methods

from :: UsagePlan -> Rep UsagePlan x

to :: Rep UsagePlan x -> UsagePlan

Hashable UsagePlan

Defined in Network.AWS.APIGateway.Types.Product

Methods

hashWithSalt :: Int -> UsagePlan -> Int

hash :: UsagePlan -> Int

FromJSON UsagePlan

Defined in Network.AWS.APIGateway.Types.Product

Methods

parseJSON :: Value -> Parser UsagePlan

parseJSONList :: Value -> Parser [UsagePlan]

NFData UsagePlan

Defined in Network.AWS.APIGateway.Types.Product

Methods

rnf :: UsagePlan -> ()

type Rep UsagePlan

Defined in Network.AWS.APIGateway.Types.Product

type Rep UsagePlan = D1 (MetaData "UsagePlan" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.6.1-BCCM2RP3l9Q2ENgHvKrj59" False) (C1 (MetaCons "UsagePlan'" PrefixI True) ((S1 (MetaSel (Just "_upApiStages") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [APIStage])) :*: (S1 (MetaSel (Just "_upName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_upId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_upThrottle") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ThrottleSettings)) :*: S1 (MetaSel (Just "_upQuota") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe QuotaSettings))) :*: (S1 (MetaSel (Just "_upDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_upProductCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

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.