Copyright | (c) 2013-2018 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 |
Network.AWS.CognitoIdentity.ListIdentities
Description
Lists the identities in a pool.
You must use AWS Developer credentials to call this API.
Synopsis
- listIdentities :: Text -> Natural -> ListIdentities
- data ListIdentities
- liHideDisabled :: Lens' ListIdentities (Maybe Bool)
- liNextToken :: Lens' ListIdentities (Maybe Text)
- liIdentityPoolId :: Lens' ListIdentities Text
- liMaxResults :: Lens' ListIdentities Natural
- listIdentitiesResponse :: Int -> ListIdentitiesResponse
- data ListIdentitiesResponse
- lirsIdentityPoolId :: Lens' ListIdentitiesResponse (Maybe Text)
- lirsNextToken :: Lens' ListIdentitiesResponse (Maybe Text)
- lirsIdentities :: Lens' ListIdentitiesResponse [IdentityDescription]
- lirsResponseStatus :: Lens' ListIdentitiesResponse Int
Creating a Request
Arguments
:: Text | |
-> Natural | |
-> ListIdentities |
Creates a value of ListIdentities
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
liHideDisabled
- An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.liNextToken
- A pagination token.liIdentityPoolId
- An identity pool ID in the format REGION:GUID.liMaxResults
- The maximum number of identities to return.
data ListIdentities Source #
Input to the ListIdentities action.
See: listIdentities
smart constructor.
Instances
Request Lenses
liHideDisabled :: Lens' ListIdentities (Maybe Bool) Source #
An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.
liNextToken :: Lens' ListIdentities (Maybe Text) Source #
A pagination token.
liIdentityPoolId :: Lens' ListIdentities Text Source #
An identity pool ID in the format REGION:GUID.
liMaxResults :: Lens' ListIdentities Natural Source #
The maximum number of identities to return.
Destructuring the Response
listIdentitiesResponse Source #
Arguments
:: Int | |
-> ListIdentitiesResponse |
Creates a value of ListIdentitiesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lirsIdentityPoolId
- An identity pool ID in the format REGION:GUID.lirsNextToken
- A pagination token.lirsIdentities
- An object containing a set of identities and associated mappings.lirsResponseStatus
- -- | The response status code.
data ListIdentitiesResponse Source #
The response to a ListIdentities request.
See: listIdentitiesResponse
smart constructor.
Instances
Response Lenses
lirsIdentityPoolId :: Lens' ListIdentitiesResponse (Maybe Text) Source #
An identity pool ID in the format REGION:GUID.
lirsNextToken :: Lens' ListIdentitiesResponse (Maybe Text) Source #
A pagination token.
lirsIdentities :: Lens' ListIdentitiesResponse [IdentityDescription] Source #
An object containing a set of identities and associated mappings.
lirsResponseStatus :: Lens' ListIdentitiesResponse Int Source #
- - | The response status code.