Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.APIGateway.GetUsagePlans

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets all the usage plans of the caller's account.

This operation returns paginated results.

Synopsis

Creating a Request

data GetUsagePlans Source #

The GET request to get all the usage plans of the caller's account.

See: newGetUsagePlans smart constructor.

Constructors

GetUsagePlans'
Fields keyId :: Maybe Text The identifier of the API key associated with the usage plans. limit :: Maybe Int The maximum number of returned results per page. The default value is 25 and the maximum value is 500. position :: Maybe Text The current pagination position in the paged result set.

Instances

Instances details

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

newGetUsagePlans :: GetUsagePlans Source #

Create a value of GetUsagePlans 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:keyId:GetUsagePlans', getUsagePlans_keyId - The identifier of the API key associated with the usage plans.

$sel:limit:GetUsagePlans', getUsagePlans_limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

$sel:position:GetUsagePlans', getUsagePlans_position - The current pagination position in the paged result set.

Request Lenses

getUsagePlans_keyId :: Lens' GetUsagePlans (Maybe Text) Source #

The identifier of the API key associated with the usage plans.

getUsagePlans_limit :: Lens' GetUsagePlans (Maybe Int) Source #

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

getUsagePlans_position :: Lens' GetUsagePlans (Maybe Text) Source #

The current pagination position in the paged result set.

Destructuring the Response

data GetUsagePlansResponse Source #

Represents a collection of usage plans for an AWS account.

Create and Use Usage Plans

See: newGetUsagePlansResponse smart constructor.

Constructors

GetUsagePlansResponse'
Fields items :: Maybe [UsagePlan] The current page of elements from this collection. position :: Maybe Text httpStatus :: Int The response's http status code.

Instances

Instances details

Eq GetUsagePlansResponse Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlans Methods (==) :: GetUsagePlansResponse -> GetUsagePlansResponse -> Bool # (/=) :: GetUsagePlansResponse -> GetUsagePlansResponse -> Bool #
Read GetUsagePlansResponse Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlans Methods readsPrec :: Int -> ReadS GetUsagePlansResponse # readList :: ReadS [GetUsagePlansResponse] # readPrec :: ReadPrec GetUsagePlansResponse # readListPrec :: ReadPrec [GetUsagePlansResponse] #
Show GetUsagePlansResponse Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlans Methods showsPrec :: Int -> GetUsagePlansResponse -> ShowS # show :: GetUsagePlansResponse -> String # showList :: [GetUsagePlansResponse] -> ShowS #
Generic GetUsagePlansResponse Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlans Associated Types type Rep GetUsagePlansResponse :: Type -> Type # Methods from :: GetUsagePlansResponse -> Rep GetUsagePlansResponse x # to :: Rep GetUsagePlansResponse x -> GetUsagePlansResponse #
NFData GetUsagePlansResponse Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlans Methods rnf :: GetUsagePlansResponse -> () #
type Rep GetUsagePlansResponse Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlans type Rep GetUsagePlansResponse = D1 ('MetaData "GetUsagePlansResponse" "Amazonka.APIGateway.GetUsagePlans" "libZSservicesZSamazonka-apigatewayZSamazonka-apigateway" 'False) (C1 ('MetaCons "GetUsagePlansResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UsagePlan])) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetUsagePlansResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetUsagePlansResponse'`
-> GetUsagePlansResponse

Create a value of GetUsagePlansResponse 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:items:GetUsagePlansResponse', getUsagePlansResponse_items - The current page of elements from this collection.

$sel:position:GetUsagePlans', getUsagePlansResponse_position - Undocumented member.

$sel:httpStatus:GetUsagePlansResponse', getUsagePlansResponse_httpStatus - The response's http status code.

Response Lenses

getUsagePlansResponse_items :: Lens' GetUsagePlansResponse (Maybe [UsagePlan]) Source #

The current page of elements from this collection.

getUsagePlansResponse_position :: Lens' GetUsagePlansResponse (Maybe Text) Source #

Undocumented member.

getUsagePlansResponse_httpStatus :: Lens' GetUsagePlansResponse Int Source #

The response's http status code.