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

Amazonka.CognitoIdentity.ListIdentities

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the identities in an identity pool.

You must use AWS Developer credentials to call this API.

Synopsis

data ListIdentities = ListIdentities' {
- hideDisabled :: Maybe Bool
- nextToken :: Maybe Text
- identityPoolId :: Text
- maxResults :: Natural
}
newListIdentities :: Text -> Natural -> ListIdentities
listIdentities_hideDisabled :: Lens' ListIdentities (Maybe Bool)
listIdentities_nextToken :: Lens' ListIdentities (Maybe Text)
listIdentities_identityPoolId :: Lens' ListIdentities Text
listIdentities_maxResults :: Lens' ListIdentities Natural
data ListIdentitiesResponse = ListIdentitiesResponse' {
- identities :: Maybe [IdentityDescription]
- identityPoolId :: Maybe Text
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListIdentitiesResponse :: Int -> ListIdentitiesResponse
listIdentitiesResponse_identities :: Lens' ListIdentitiesResponse (Maybe [IdentityDescription])
listIdentitiesResponse_identityPoolId :: Lens' ListIdentitiesResponse (Maybe Text)
listIdentitiesResponse_nextToken :: Lens' ListIdentitiesResponse (Maybe Text)
listIdentitiesResponse_httpStatus :: Lens' ListIdentitiesResponse Int

Creating a Request

data ListIdentities Source #

Input to the ListIdentities action.

See: newListIdentities smart constructor.

Constructors

ListIdentities'
Fields hideDisabled :: Maybe Bool An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response. nextToken :: Maybe Text A pagination token. identityPoolId :: Text An identity pool ID in the format REGION:GUID. maxResults :: Natural The maximum number of identities to return.

Instances

Instances details

ToJSON ListIdentities Source #
Instance details Defined in Amazonka.CognitoIdentity.ListIdentities Methods toJSON :: ListIdentities -> Value # toEncoding :: ListIdentities -> Encoding # toJSONList :: [ListIdentities] -> Value # toEncodingList :: [ListIdentities] -> Encoding #
ToHeaders ListIdentities Source #
Instance details Defined in Amazonka.CognitoIdentity.ListIdentities Methods toHeaders :: ListIdentities -> [Header] #
ToPath ListIdentities Source #
Instance details Defined in Amazonka.CognitoIdentity.ListIdentities Methods toPath :: ListIdentities -> ByteString #
ToQuery ListIdentities Source #
Instance details Defined in Amazonka.CognitoIdentity.ListIdentities Methods toQuery :: ListIdentities -> QueryString #
AWSRequest ListIdentities Source #
Instance details Defined in Amazonka.CognitoIdentity.ListIdentities Associated Types type AWSResponse ListIdentities # Methods request :: (Service -> Service) -> ListIdentities -> Request ListIdentities # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListIdentities -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListIdentities))) #
Generic ListIdentities Source #
Instance details Defined in Amazonka.CognitoIdentity.ListIdentities Associated Types type Rep ListIdentities :: Type -> Type # Methods from :: ListIdentities -> Rep ListIdentities x # to :: Rep ListIdentities x -> ListIdentities #
Read ListIdentities Source #
Instance details Defined in Amazonka.CognitoIdentity.ListIdentities Methods readsPrec :: Int -> ReadS ListIdentities # readList :: ReadS [ListIdentities] # readPrec :: ReadPrec ListIdentities # readListPrec :: ReadPrec [ListIdentities] #
Show ListIdentities Source #
Instance details Defined in Amazonka.CognitoIdentity.ListIdentities Methods showsPrec :: Int -> ListIdentities -> ShowS # show :: ListIdentities -> String # showList :: [ListIdentities] -> ShowS #
NFData ListIdentities Source #
Instance details Defined in Amazonka.CognitoIdentity.ListIdentities Methods rnf :: ListIdentities -> () #
Eq ListIdentities Source #
Instance details Defined in Amazonka.CognitoIdentity.ListIdentities Methods (==) :: ListIdentities -> ListIdentities -> Bool # (/=) :: ListIdentities -> ListIdentities -> Bool #
Hashable ListIdentities Source #
Instance details Defined in Amazonka.CognitoIdentity.ListIdentities Methods hashWithSalt :: Int -> ListIdentities -> Int # hash :: ListIdentities -> Int #
type AWSResponse ListIdentities Source #
Instance details Defined in Amazonka.CognitoIdentity.ListIdentities type AWSResponse ListIdentities = ListIdentitiesResponse
type Rep ListIdentities Source #
Instance details Defined in Amazonka.CognitoIdentity.ListIdentities type Rep ListIdentities = D1 ('MetaData "ListIdentities" "Amazonka.CognitoIdentity.ListIdentities" "amazonka-cognito-identity-2.0-9cap08KVWNhAJ5mbkAF9NH" 'False) (C1 ('MetaCons "ListIdentities'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "hideDisabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "identityPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural))))

newListIdentities Source #

Arguments

:: Text	`ListIdentities`
-> Natural	`$sel:maxResults:ListIdentities'`
-> ListIdentities

Create a value of ListIdentities 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:hideDisabled:ListIdentities', listIdentities_hideDisabled - An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.

ListIdentities, listIdentities_nextToken - A pagination token.

ListIdentities, listIdentities_identityPoolId - An identity pool ID in the format REGION:GUID.

$sel:maxResults:ListIdentities', listIdentities_maxResults - The maximum number of identities to return.

Request Lenses

listIdentities_hideDisabled :: 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.

listIdentities_nextToken :: Lens' ListIdentities (Maybe Text) Source #

A pagination token.

listIdentities_identityPoolId :: Lens' ListIdentities Text Source #

An identity pool ID in the format REGION:GUID.

listIdentities_maxResults :: Lens' ListIdentities Natural Source #

The maximum number of identities to return.

Destructuring the Response

data ListIdentitiesResponse Source #

The response to a ListIdentities request.

See: newListIdentitiesResponse smart constructor.

Constructors

ListIdentitiesResponse'
Fields identities :: Maybe [IdentityDescription] An object containing a set of identities and associated mappings. identityPoolId :: Maybe Text An identity pool ID in the format REGION:GUID. nextToken :: Maybe Text A pagination token. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListIdentitiesResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.ListIdentities Associated Types type Rep ListIdentitiesResponse :: Type -> Type # Methods from :: ListIdentitiesResponse -> Rep ListIdentitiesResponse x # to :: Rep ListIdentitiesResponse x -> ListIdentitiesResponse #
Read ListIdentitiesResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.ListIdentities Methods readsPrec :: Int -> ReadS ListIdentitiesResponse # readList :: ReadS [ListIdentitiesResponse] # readPrec :: ReadPrec ListIdentitiesResponse # readListPrec :: ReadPrec [ListIdentitiesResponse] #
Show ListIdentitiesResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.ListIdentities Methods showsPrec :: Int -> ListIdentitiesResponse -> ShowS # show :: ListIdentitiesResponse -> String # showList :: [ListIdentitiesResponse] -> ShowS #
NFData ListIdentitiesResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.ListIdentities Methods rnf :: ListIdentitiesResponse -> () #
Eq ListIdentitiesResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.ListIdentities Methods (==) :: ListIdentitiesResponse -> ListIdentitiesResponse -> Bool # (/=) :: ListIdentitiesResponse -> ListIdentitiesResponse -> Bool #
type Rep ListIdentitiesResponse Source #
Instance details Defined in Amazonka.CognitoIdentity.ListIdentities type Rep ListIdentitiesResponse = D1 ('MetaData "ListIdentitiesResponse" "Amazonka.CognitoIdentity.ListIdentities" "amazonka-cognito-identity-2.0-9cap08KVWNhAJ5mbkAF9NH" 'False) (C1 ('MetaCons "ListIdentitiesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "identities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [IdentityDescription])) :: S1 ('MetaSel ('Just "identityPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListIdentitiesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListIdentitiesResponse'`
-> ListIdentitiesResponse

Create a value of ListIdentitiesResponse 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:identities:ListIdentitiesResponse', listIdentitiesResponse_identities - An object containing a set of identities and associated mappings.

ListIdentities, listIdentitiesResponse_identityPoolId - An identity pool ID in the format REGION:GUID.

ListIdentities, listIdentitiesResponse_nextToken - A pagination token.

$sel:httpStatus:ListIdentitiesResponse', listIdentitiesResponse_httpStatus - The response's http status code.

Response Lenses

listIdentitiesResponse_identities :: Lens' ListIdentitiesResponse (Maybe [IdentityDescription]) Source #

An object containing a set of identities and associated mappings.

listIdentitiesResponse_identityPoolId :: Lens' ListIdentitiesResponse (Maybe Text) Source #

An identity pool ID in the format REGION:GUID.

listIdentitiesResponse_nextToken :: Lens' ListIdentitiesResponse (Maybe Text) Source #

A pagination token.

listIdentitiesResponse_httpStatus :: Lens' ListIdentitiesResponse Int Source #

The response's http status code.