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 |
Import API keys from an external source, such as a CSV-formatted file.
- importAPIKeys :: HashMap Text Value -> APIKeysFormat -> ImportAPIKeys
- data ImportAPIKeys
- iakFailOnWarnings :: Lens' ImportAPIKeys (Maybe Bool)
- iakBody :: Lens' ImportAPIKeys (HashMap Text Value)
- iakFormat :: Lens' ImportAPIKeys APIKeysFormat
- importAPIKeysResponse :: Int -> ImportAPIKeysResponse
- data ImportAPIKeysResponse
- iakrsIds :: Lens' ImportAPIKeysResponse [Text]
- iakrsWarnings :: Lens' ImportAPIKeysResponse [Text]
- iakrsResponseStatus :: Lens' ImportAPIKeysResponse Int
Creating a Request
Creates a value of ImportAPIKeys
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iakFailOnWarnings
- A query parameter to indicate whether to rollbackApiKey
importation (true
) or not (false
) when error is encountered.iakBody
- The payload of the POST request to import API keys. For the payload format, see API Key File Format .iakFormat
- A query parameter to specify the input format to imported API keys. Currently, only thecsv
format is supported.
data ImportAPIKeys Source #
The POST request to import API keys from an external source, such as a CSV-formatted file.
See: importAPIKeys
smart constructor.
Request Lenses
iakFailOnWarnings :: Lens' ImportAPIKeys (Maybe Bool) Source #
A query parameter to indicate whether to rollback ApiKey
importation (true
) or not (false
) when error is encountered.
iakBody :: Lens' ImportAPIKeys (HashMap Text Value) Source #
The payload of the POST request to import API keys. For the payload format, see API Key File Format .
iakFormat :: Lens' ImportAPIKeys APIKeysFormat Source #
A query parameter to specify the input format to imported API keys. Currently, only the csv
format is supported.
Destructuring the Response
importAPIKeysResponse Source #
Creates a value of ImportAPIKeysResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iakrsIds
- A list of all theApiKey
identifiers.iakrsWarnings
- A list of warning messages.iakrsResponseStatus
- -- | The response status code.
data ImportAPIKeysResponse Source #
The identifier of an ApiKey
used in a UsagePlan
.
See: importAPIKeysResponse
smart constructor.
Response Lenses
iakrsWarnings :: Lens' ImportAPIKeysResponse [Text] Source #
A list of warning messages.
iakrsResponseStatus :: Lens' ImportAPIKeysResponse Int Source #
- - | The response status code.