Network.AWS.APIGateway.GetUsagePlan

Gets a usage plan of a given plan identifier.

Creating a Request

getUsagePlan

Arguments

:: Text

gupUsagePlanId

-> GetUsagePlan

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

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

• gupUsagePlanId - [Required] The identifier of the UsagePlan resource to be retrieved.

data GetUsagePlan

The GET request to get a usage plan of a given plan identifier.

See: getUsagePlan smart constructor.

Instances

Eq GetUsagePlan

Defined in Network.AWS.APIGateway.GetUsagePlan

Methods

(==) :: GetUsagePlan -> GetUsagePlan -> Bool

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

Data GetUsagePlan

Defined in Network.AWS.APIGateway.GetUsagePlan

Methods

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

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

toConstr :: GetUsagePlan -> Constr

dataTypeOf :: GetUsagePlan -> DataType

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

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

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

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

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

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

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

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

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

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

Read GetUsagePlan

Defined in Network.AWS.APIGateway.GetUsagePlan

Methods

readsPrec :: Int -> ReadS GetUsagePlan

readList :: ReadS [GetUsagePlan]

readPrec :: ReadPrec GetUsagePlan

readListPrec :: ReadPrec [GetUsagePlan]

Show GetUsagePlan

Defined in Network.AWS.APIGateway.GetUsagePlan

Methods

showsPrec :: Int -> GetUsagePlan -> ShowS

show :: GetUsagePlan -> String

showList :: [GetUsagePlan] -> ShowS

Generic GetUsagePlan

Defined in Network.AWS.APIGateway.GetUsagePlan

Associated Types

type Rep GetUsagePlan :: Type -> Type

Methods

from :: GetUsagePlan -> Rep GetUsagePlan x

to :: Rep GetUsagePlan x -> GetUsagePlan

Hashable GetUsagePlan

Defined in Network.AWS.APIGateway.GetUsagePlan

Methods

hashWithSalt :: Int -> GetUsagePlan -> Int

hash :: GetUsagePlan -> Int

AWSRequest GetUsagePlan

Defined in Network.AWS.APIGateway.GetUsagePlan

Associated Types

type Rs GetUsagePlan :: Type

Methods

request :: GetUsagePlan -> Request GetUsagePlan

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

ToHeaders GetUsagePlan

Defined in Network.AWS.APIGateway.GetUsagePlan

Methods

toHeaders :: GetUsagePlan -> [Header]

ToPath GetUsagePlan

Defined in Network.AWS.APIGateway.GetUsagePlan

Methods

toPath :: GetUsagePlan -> ByteString

ToQuery GetUsagePlan

Defined in Network.AWS.APIGateway.GetUsagePlan

Methods

toQuery :: GetUsagePlan -> QueryString

NFData GetUsagePlan

Defined in Network.AWS.APIGateway.GetUsagePlan

Methods

rnf :: GetUsagePlan -> ()

type Rep GetUsagePlan

Defined in Network.AWS.APIGateway.GetUsagePlan

type Rep GetUsagePlan = D1 (MetaData "GetUsagePlan" "Network.AWS.APIGateway.GetUsagePlan" "amazonka-apigateway-1.6.1-BCCM2RP3l9Q2ENgHvKrj59" True) (C1 (MetaCons "GetUsagePlan'" PrefixI True) (S1 (MetaSel (Just "_gupUsagePlanId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

type Rs GetUsagePlan

Defined in Network.AWS.APIGateway.GetUsagePlan

type Rs GetUsagePlan = UsagePlan

Request Lenses

gupUsagePlanId :: Lens' GetUsagePlan Text

Required

The identifier of the UsagePlan resource to be retrieved.

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.