Copyright | (c) 2013-2017 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 |
Language | Haskell2010 |
Gets all the usage plan keys representing the API keys added to a specified usage plan.
This operation returns paginated results.
- getUsagePlanKeys :: Text -> GetUsagePlanKeys
- data GetUsagePlanKeys
- gupkNameQuery :: Lens' GetUsagePlanKeys (Maybe Text)
- gupkLimit :: Lens' GetUsagePlanKeys (Maybe Int)
- gupkPosition :: Lens' GetUsagePlanKeys (Maybe Text)
- gupkUsagePlanId :: Lens' GetUsagePlanKeys Text
- getUsagePlanKeysResponse :: Int -> GetUsagePlanKeysResponse
- data GetUsagePlanKeysResponse
- gupkrsItems :: Lens' GetUsagePlanKeysResponse [UsagePlanKey]
- gupkrsPosition :: Lens' GetUsagePlanKeysResponse (Maybe Text)
- gupkrsResponseStatus :: Lens' GetUsagePlanKeysResponse Int
Creating a Request
Creates a value of GetUsagePlanKeys
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gupkNameQuery
- A query parameter specifying the name of the to-be-returned usage plan keys.gupkLimit
- The maximum number of returned results per page.gupkPosition
- The current pagination position in the paged result set.gupkUsagePlanId
- The Id of theUsagePlan
resource representing the usage plan containing the to-be-retrievedUsagePlanKey
resource representing a plan customer.
data GetUsagePlanKeys Source #
The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.
See: getUsagePlanKeys
smart constructor.
Request Lenses
gupkNameQuery :: Lens' GetUsagePlanKeys (Maybe Text) Source #
A query parameter specifying the name of the to-be-returned usage plan keys.
gupkLimit :: Lens' GetUsagePlanKeys (Maybe Int) Source #
The maximum number of returned results per page.
gupkPosition :: Lens' GetUsagePlanKeys (Maybe Text) Source #
The current pagination position in the paged result set.
gupkUsagePlanId :: Lens' GetUsagePlanKeys Text Source #
The Id of the UsagePlan
resource representing the usage plan containing the to-be-retrieved UsagePlanKey
resource representing a plan customer.
Destructuring the Response
getUsagePlanKeysResponse Source #
Creates a value of GetUsagePlanKeysResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gupkrsItems
- The current page of elements from this collection.gupkrsPosition
- Undocumented member.gupkrsResponseStatus
- -- | The response status code.
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.
See: getUsagePlanKeysResponse
smart constructor.
Response Lenses
gupkrsItems :: Lens' GetUsagePlanKeysResponse [UsagePlanKey] Source #
The current page of elements from this collection.
gupkrsPosition :: Lens' GetUsagePlanKeysResponse (Maybe Text) Source #
Undocumented member.
gupkrsResponseStatus :: Lens' GetUsagePlanKeysResponse Int Source #
- - | The response status code.