Network.AWS.CognitoIdentity.ListIdentities

Lists the identities in a pool.

You must use AWS Developer credentials to call this API.

Creating a Request

listIdentities

Arguments

:: Text

liIdentityPoolId

-> Natural

liMaxResults

-> 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

Input to the ListIdentities action.

See: listIdentities smart constructor.

Instances

Eq ListIdentities

Defined in Network.AWS.CognitoIdentity.ListIdentities

Methods

(==) :: ListIdentities -> ListIdentities -> Bool

(/=) :: ListIdentities -> ListIdentities -> Bool

Data ListIdentities

Defined in Network.AWS.CognitoIdentity.ListIdentities

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListIdentities -> c ListIdentities

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListIdentities

toConstr :: ListIdentities -> Constr

dataTypeOf :: ListIdentities -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListIdentities)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListIdentities)

gmapT :: (forall b. Data b => b -> b) -> ListIdentities -> ListIdentities

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListIdentities -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListIdentities -> r

gmapQ :: (forall d. Data d => d -> u) -> ListIdentities -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListIdentities -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListIdentities -> m ListIdentities

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListIdentities -> m ListIdentities

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListIdentities -> m ListIdentities

Read ListIdentities

Defined in Network.AWS.CognitoIdentity.ListIdentities

Methods

readsPrec :: Int -> ReadS ListIdentities

readList :: ReadS [ListIdentities]

readPrec :: ReadPrec ListIdentities

readListPrec :: ReadPrec [ListIdentities]

Show ListIdentities

Defined in Network.AWS.CognitoIdentity.ListIdentities

Methods

showsPrec :: Int -> ListIdentities -> ShowS

show :: ListIdentities -> String

showList :: [ListIdentities] -> ShowS

Generic ListIdentities

Defined in Network.AWS.CognitoIdentity.ListIdentities

Associated Types

type Rep ListIdentities :: Type -> Type

Methods

from :: ListIdentities -> Rep ListIdentities x

to :: Rep ListIdentities x -> ListIdentities

Hashable ListIdentities

Defined in Network.AWS.CognitoIdentity.ListIdentities

Methods

hashWithSalt :: Int -> ListIdentities -> Int

hash :: ListIdentities -> Int

ToJSON ListIdentities

Defined in Network.AWS.CognitoIdentity.ListIdentities

Methods

toJSON :: ListIdentities -> Value

toEncoding :: ListIdentities -> Encoding

toJSONList :: [ListIdentities] -> Value

toEncodingList :: [ListIdentities] -> Encoding

AWSRequest ListIdentities

Defined in Network.AWS.CognitoIdentity.ListIdentities

Associated Types

type Rs ListIdentities :: Type

Methods

request :: ListIdentities -> Request ListIdentities

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy ListIdentities -> ClientResponse -> m (Response ListIdentities)

ToHeaders ListIdentities

Defined in Network.AWS.CognitoIdentity.ListIdentities

Methods

toHeaders :: ListIdentities -> [Header]

ToPath ListIdentities

Defined in Network.AWS.CognitoIdentity.ListIdentities

Methods

toPath :: ListIdentities -> ByteString

ToQuery ListIdentities

Defined in Network.AWS.CognitoIdentity.ListIdentities

Methods

toQuery :: ListIdentities -> QueryString

NFData ListIdentities

Defined in Network.AWS.CognitoIdentity.ListIdentities

Methods

rnf :: ListIdentities -> ()

type Rep ListIdentities

Defined in Network.AWS.CognitoIdentity.ListIdentities

type Rep ListIdentities = D1 (MetaData "ListIdentities" "Network.AWS.CognitoIdentity.ListIdentities" "amazonka-cognito-identity-1.6.1-JxIOswo68EQKpplMh7b7yR" False) (C1 (MetaCons "ListIdentities'" PrefixI True) ((S1 (MetaSel (Just "_liHideDisabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_liNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_liIdentityPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_liMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat))))

type Rs ListIdentities

Defined in Network.AWS.CognitoIdentity.ListIdentities

type Rs ListIdentities = ListIdentitiesResponse

Request Lenses

liHideDisabled :: Lens' ListIdentities (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.

liNextToken :: Lens' ListIdentities (Maybe Text)

A pagination token.

liIdentityPoolId :: Lens' ListIdentities Text

An identity pool ID in the format REGION:GUID.

liMaxResults :: Lens' ListIdentities Natural

The maximum number of identities to return.

Destructuring the Response

listIdentitiesResponse

Arguments

:: Int

lirsResponseStatus

-> 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

The response to a ListIdentities request.

See: listIdentitiesResponse smart constructor.

Instances

Eq ListIdentitiesResponse

Defined in Network.AWS.CognitoIdentity.ListIdentities

Methods

(==) :: ListIdentitiesResponse -> ListIdentitiesResponse -> Bool

(/=) :: ListIdentitiesResponse -> ListIdentitiesResponse -> Bool

Data ListIdentitiesResponse

Defined in Network.AWS.CognitoIdentity.ListIdentities

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListIdentitiesResponse -> c ListIdentitiesResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListIdentitiesResponse

toConstr :: ListIdentitiesResponse -> Constr

dataTypeOf :: ListIdentitiesResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListIdentitiesResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListIdentitiesResponse)

gmapT :: (forall b. Data b => b -> b) -> ListIdentitiesResponse -> ListIdentitiesResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListIdentitiesResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListIdentitiesResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> ListIdentitiesResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListIdentitiesResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListIdentitiesResponse -> m ListIdentitiesResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListIdentitiesResponse -> m ListIdentitiesResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListIdentitiesResponse -> m ListIdentitiesResponse

Read ListIdentitiesResponse

Defined in Network.AWS.CognitoIdentity.ListIdentities

Methods

readsPrec :: Int -> ReadS ListIdentitiesResponse

readList :: ReadS [ListIdentitiesResponse]

readPrec :: ReadPrec ListIdentitiesResponse

readListPrec :: ReadPrec [ListIdentitiesResponse]

Show ListIdentitiesResponse

Defined in Network.AWS.CognitoIdentity.ListIdentities

Methods

showsPrec :: Int -> ListIdentitiesResponse -> ShowS

show :: ListIdentitiesResponse -> String

showList :: [ListIdentitiesResponse] -> ShowS

Generic ListIdentitiesResponse

Defined in Network.AWS.CognitoIdentity.ListIdentities

Associated Types

type Rep ListIdentitiesResponse :: Type -> Type

Methods

from :: ListIdentitiesResponse -> Rep ListIdentitiesResponse x

to :: Rep ListIdentitiesResponse x -> ListIdentitiesResponse

NFData ListIdentitiesResponse

Defined in Network.AWS.CognitoIdentity.ListIdentities

Methods

rnf :: ListIdentitiesResponse -> ()

type Rep ListIdentitiesResponse

Defined in Network.AWS.CognitoIdentity.ListIdentities

type Rep ListIdentitiesResponse = D1 (MetaData "ListIdentitiesResponse" "Network.AWS.CognitoIdentity.ListIdentities" "amazonka-cognito-identity-1.6.1-JxIOswo68EQKpplMh7b7yR" False) (C1 (MetaCons "ListIdentitiesResponse'" PrefixI True) ((S1 (MetaSel (Just "_lirsIdentityPoolId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lirsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_lirsIdentities") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [IdentityDescription])) :*: S1 (MetaSel (Just "_lirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

lirsIdentityPoolId :: Lens' ListIdentitiesResponse (Maybe Text)

An identity pool ID in the format REGION:GUID.

lirsNextToken :: Lens' ListIdentitiesResponse (Maybe Text)

A pagination token.

lirsIdentities :: Lens' ListIdentitiesResponse [IdentityDescription]

An object containing a set of identities and associated mappings.

lirsResponseStatus :: Lens' ListIdentitiesResponse Int

• - | The response status code.