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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets all the usage plan keys representing the API keys added to a specified usage plan.

This operation returns paginated results.

Synopsis

data GetUsagePlanKeys = GetUsagePlanKeys' {
- nameQuery :: Maybe Text
- limit :: Maybe Int
- position :: Maybe Text
- usagePlanId :: Text
}
newGetUsagePlanKeys :: Text -> GetUsagePlanKeys
getUsagePlanKeys_nameQuery :: Lens' GetUsagePlanKeys (Maybe Text)
getUsagePlanKeys_limit :: Lens' GetUsagePlanKeys (Maybe Int)
getUsagePlanKeys_position :: Lens' GetUsagePlanKeys (Maybe Text)
getUsagePlanKeys_usagePlanId :: Lens' GetUsagePlanKeys Text
data GetUsagePlanKeysResponse = GetUsagePlanKeysResponse' {
- items :: Maybe [UsagePlanKey]
- position :: Maybe Text
- httpStatus :: Int
}
newGetUsagePlanKeysResponse :: Int -> GetUsagePlanKeysResponse
getUsagePlanKeysResponse_items :: Lens' GetUsagePlanKeysResponse (Maybe [UsagePlanKey])
getUsagePlanKeysResponse_position :: Lens' GetUsagePlanKeysResponse (Maybe Text)
getUsagePlanKeysResponse_httpStatus :: Lens' GetUsagePlanKeysResponse Int

Creating a Request

data GetUsagePlanKeys Source #

The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.

See: newGetUsagePlanKeys smart constructor.

Constructors

GetUsagePlanKeys'

Fields

nameQuery :: Maybe Text
A query parameter specifying the name of the to-be-returned usage plan keys.
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.
usagePlanId :: Text
Required
The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

Instances

Instances details

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

newGetUsagePlanKeys Source #

Arguments

:: Text	`$sel:usagePlanId:GetUsagePlanKeys'`
-> GetUsagePlanKeys

Create a value of GetUsagePlanKeys 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:nameQuery:GetUsagePlanKeys', getUsagePlanKeys_nameQuery - A query parameter specifying the name of the to-be-returned usage plan keys.

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

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

$sel:usagePlanId:GetUsagePlanKeys', getUsagePlanKeys_usagePlanId - [Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

Request Lenses

getUsagePlanKeys_nameQuery :: Lens' GetUsagePlanKeys (Maybe Text) Source #

A query parameter specifying the name of the to-be-returned usage plan keys.

getUsagePlanKeys_limit :: Lens' GetUsagePlanKeys (Maybe Int) Source #

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

getUsagePlanKeys_position :: Lens' GetUsagePlanKeys (Maybe Text) Source #

The current pagination position in the paged result set.

getUsagePlanKeys_usagePlanId :: Lens' GetUsagePlanKeys Text Source #

Required: The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

Destructuring the Response

data GetUsagePlanKeysResponse Source #

Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other types of keys.

Create and Use Usage Plans

See: newGetUsagePlanKeysResponse smart constructor.

Constructors

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

Instances

Instances details

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

newGetUsagePlanKeysResponse Source #

Arguments

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

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

$sel:position:GetUsagePlanKeys', getUsagePlanKeysResponse_position - Undocumented member.

$sel:httpStatus:GetUsagePlanKeysResponse', getUsagePlanKeysResponse_httpStatus - The response's http status code.

Response Lenses

getUsagePlanKeysResponse_items :: Lens' GetUsagePlanKeysResponse (Maybe [UsagePlanKey]) Source #

The current page of elements from this collection.

getUsagePlanKeysResponse_position :: Lens' GetUsagePlanKeysResponse (Maybe Text) Source #

Undocumented member.

getUsagePlanKeysResponse_httpStatus :: Lens' GetUsagePlanKeysResponse Int Source #

The response's http status code.