Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Returns information about all key pairs in the user's account.
This operation returns paginated results.
Synopsis
- data GetKeyPairs = GetKeyPairs' {}
- newGetKeyPairs :: GetKeyPairs
- getKeyPairs_includeDefaultKeyPair :: Lens' GetKeyPairs (Maybe Bool)
- getKeyPairs_pageToken :: Lens' GetKeyPairs (Maybe Text)
- data GetKeyPairsResponse = GetKeyPairsResponse' {
- keyPairs :: Maybe [KeyPair]
- nextPageToken :: Maybe Text
- httpStatus :: Int
- newGetKeyPairsResponse :: Int -> GetKeyPairsResponse
- getKeyPairsResponse_keyPairs :: Lens' GetKeyPairsResponse (Maybe [KeyPair])
- getKeyPairsResponse_nextPageToken :: Lens' GetKeyPairsResponse (Maybe Text)
- getKeyPairsResponse_httpStatus :: Lens' GetKeyPairsResponse Int
Creating a Request
data GetKeyPairs Source #
See: newGetKeyPairs
smart constructor.
GetKeyPairs' | |
|
Instances
newGetKeyPairs :: GetKeyPairs Source #
Create a value of GetKeyPairs
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:includeDefaultKeyPair:GetKeyPairs'
, getKeyPairs_includeDefaultKeyPair
- A Boolean value that indicates whether to include the default key pair
in the response of your request.
$sel:pageToken:GetKeyPairs'
, getKeyPairs_pageToken
- The token to advance to the next page of results from your request.
To get a page token, perform an initial GetKeyPairs
request. If your
results are paginated, the response will return a next page token that
you can specify as the page token in a subsequent request.
Request Lenses
getKeyPairs_includeDefaultKeyPair :: Lens' GetKeyPairs (Maybe Bool) Source #
A Boolean value that indicates whether to include the default key pair in the response of your request.
getKeyPairs_pageToken :: Lens' GetKeyPairs (Maybe Text) Source #
The token to advance to the next page of results from your request.
To get a page token, perform an initial GetKeyPairs
request. If your
results are paginated, the response will return a next page token that
you can specify as the page token in a subsequent request.
Destructuring the Response
data GetKeyPairsResponse Source #
See: newGetKeyPairsResponse
smart constructor.
GetKeyPairsResponse' | |
|
Instances
newGetKeyPairsResponse Source #
Create a value of GetKeyPairsResponse
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:keyPairs:GetKeyPairsResponse'
, getKeyPairsResponse_keyPairs
- An array of key-value pairs containing information about the key pairs.
$sel:nextPageToken:GetKeyPairsResponse'
, getKeyPairsResponse_nextPageToken
- The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetKeyPairs
request
and specify the next page token using the pageToken
parameter.
$sel:httpStatus:GetKeyPairsResponse'
, getKeyPairsResponse_httpStatus
- The response's http status code.
Response Lenses
getKeyPairsResponse_keyPairs :: Lens' GetKeyPairsResponse (Maybe [KeyPair]) Source #
An array of key-value pairs containing information about the key pairs.
getKeyPairsResponse_nextPageToken :: Lens' GetKeyPairsResponse (Maybe Text) Source #
The token to advance to the next page of results from your request.
A next page token is not returned if there are no more results to display.
To get the next page of results, perform another GetKeyPairs
request
and specify the next page token using the pageToken
parameter.
getKeyPairsResponse_httpStatus :: Lens' GetKeyPairsResponse Int Source #
The response's http status code.