| 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.AppSync.ListApiKeys
Description
Lists the API keys for a given API.
API keys are deleted automatically 60 days after they expire. However,
they may still be included in the response until they have actually been
deleted. You can safely call DeleteApiKey to manually delete a key
before it's automatically deleted.
This operation returns paginated results.
Synopsis
- data ListApiKeys = ListApiKeys' {}
- newListApiKeys :: Text -> ListApiKeys
- listApiKeys_nextToken :: Lens' ListApiKeys (Maybe Text)
- listApiKeys_maxResults :: Lens' ListApiKeys (Maybe Natural)
- listApiKeys_apiId :: Lens' ListApiKeys Text
- data ListApiKeysResponse = ListApiKeysResponse' {}
- newListApiKeysResponse :: Int -> ListApiKeysResponse
- listApiKeysResponse_apiKeys :: Lens' ListApiKeysResponse (Maybe [ApiKey])
- listApiKeysResponse_nextToken :: Lens' ListApiKeysResponse (Maybe Text)
- listApiKeysResponse_httpStatus :: Lens' ListApiKeysResponse Int
Creating a Request
data ListApiKeys Source #
See: newListApiKeys smart constructor.
Constructors
| ListApiKeys' | |
Instances
Arguments
| :: Text | |
| -> ListApiKeys |
Create a value of ListApiKeys 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:nextToken:ListApiKeys', listApiKeys_nextToken - An identifier that was returned from the previous call to this
operation, which can be used to return the next set of items in the
list.
$sel:maxResults:ListApiKeys', listApiKeys_maxResults - The maximum number of results you want the request to return.
$sel:apiId:ListApiKeys', listApiKeys_apiId - The API ID.
Request Lenses
listApiKeys_nextToken :: Lens' ListApiKeys (Maybe Text) Source #
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
listApiKeys_maxResults :: Lens' ListApiKeys (Maybe Natural) Source #
The maximum number of results you want the request to return.
listApiKeys_apiId :: Lens' ListApiKeys Text Source #
The API ID.
Destructuring the Response
data ListApiKeysResponse Source #
See: newListApiKeysResponse smart constructor.
Constructors
| ListApiKeysResponse' | |
Instances
newListApiKeysResponse Source #
Arguments
| :: Int | |
| -> ListApiKeysResponse |
Create a value of ListApiKeysResponse 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:apiKeys:ListApiKeysResponse', listApiKeysResponse_apiKeys - The ApiKey objects.
$sel:nextToken:ListApiKeys', listApiKeysResponse_nextToken - An identifier to be passed in the next request to this operation to
return the next set of items in the list.
$sel:httpStatus:ListApiKeysResponse', listApiKeysResponse_httpStatus - The response's http status code.
Response Lenses
listApiKeysResponse_apiKeys :: Lens' ListApiKeysResponse (Maybe [ApiKey]) Source #
The ApiKey objects.
listApiKeysResponse_nextToken :: Lens' ListApiKeysResponse (Maybe Text) Source #
An identifier to be passed in the next request to this operation to return the next set of items in the list.
listApiKeysResponse_httpStatus :: Lens' ListApiKeysResponse Int Source #
The response's http status code.