Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Gets information about the current ApiKeys resource.
This operation returns paginated results.
- getAPIKeys :: GetAPIKeys
- data GetAPIKeys
- gakIncludeValues :: Lens' GetAPIKeys (Maybe Bool)
- gakNameQuery :: Lens' GetAPIKeys (Maybe Text)
- gakLimit :: Lens' GetAPIKeys (Maybe Int)
- gakPosition :: Lens' GetAPIKeys (Maybe Text)
- getAPIKeysResponse :: Int -> GetAPIKeysResponse
- data GetAPIKeysResponse
- gakrsItems :: Lens' GetAPIKeysResponse [APIKey]
- gakrsWarnings :: Lens' GetAPIKeysResponse [Text]
- gakrsPosition :: Lens' GetAPIKeysResponse (Maybe Text)
- gakrsResponseStatus :: Lens' GetAPIKeysResponse Int
Creating a Request
getAPIKeys :: GetAPIKeys Source #
Creates a value of GetAPIKeys
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data GetAPIKeys Source #
A request to get information about the current ApiKeys resource.
See: getAPIKeys
smart constructor.
Request Lenses
gakIncludeValues :: Lens' GetAPIKeys (Maybe Bool) Source #
A boolean flag to specify whether (true
) or not (false
) the result contains key values.
gakNameQuery :: Lens' GetAPIKeys (Maybe Text) Source #
The name of queried API keys.
gakLimit :: Lens' GetAPIKeys (Maybe Int) Source #
The maximum number of ApiKeys to get information about.
gakPosition :: Lens' GetAPIKeys (Maybe Text) Source #
The position of the current ApiKeys resource to get information about.
Destructuring the Response
Creates a value of GetAPIKeysResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data GetAPIKeysResponse Source #
Represents a collection of API keys as represented by an ApiKeys resource.
See: getAPIKeysResponse
smart constructor.
Response Lenses
gakrsWarnings :: Lens' GetAPIKeysResponse [Text] Source #
A list of warning messages logged during the import of API keys when the failOnWarnings
option is set to true.
gakrsPosition :: Lens' GetAPIKeysResponse (Maybe Text) Source #
Undocumented member.
gakrsResponseStatus :: Lens' GetAPIKeysResponse Int Source #
The response status code.