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.GetUsagePlan

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a usage plan of a given plan identifier.

Synopsis

data GetUsagePlan = GetUsagePlan' {
- usagePlanId :: Text
}
newGetUsagePlan :: Text -> GetUsagePlan
getUsagePlan_usagePlanId :: Lens' GetUsagePlan 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 GetUsagePlan Source #

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

See: newGetUsagePlan smart constructor.

Constructors

GetUsagePlan'
Fields usagePlanId :: Text The identifier of the UsagePlan resource to be retrieved.

Instances

Instances details

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

newGetUsagePlan Source #

Arguments

:: Text	`GetUsagePlan`
-> GetUsagePlan

Create a value of GetUsagePlan 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:

GetUsagePlan, getUsagePlan_usagePlanId - The identifier of the UsagePlan resource to be retrieved.

Request Lenses

getUsagePlan_usagePlanId :: Lens' GetUsagePlan Text Source #

The identifier of the UsagePlan resource to be retrieved.

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.