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.Rekognition.ListFaces

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see 'list-faces-in-collection-procedure' .

This operation requires permissions to perform the rekognition:ListFaces action.

This operation returns paginated results.

Synopsis

listFaces :: Text -> ListFaces
data ListFaces
lfNextToken :: Lens' ListFaces (Maybe Text)
lfMaxResults :: Lens' ListFaces (Maybe Natural)
lfCollectionId :: Lens' ListFaces Text
listFacesResponse :: Int -> ListFacesResponse
data ListFacesResponse
lfrsFaceModelVersion :: Lens' ListFacesResponse (Maybe Text)
lfrsNextToken :: Lens' ListFacesResponse (Maybe Text)
lfrsFaces :: Lens' ListFacesResponse [Face]
lfrsResponseStatus :: Lens' ListFacesResponse Int

Creating a Request

listFaces #

Arguments

:: Text	`lfCollectionId`
-> ListFaces

Creates a value of ListFaces with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lfNextToken - If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.
lfMaxResults - Maximum number of faces to return.
lfCollectionId - ID of the collection from which to list the faces.

data ListFaces #

See: listFaces smart constructor.

Instances

Eq ListFaces #
Instance details Defined in Network.AWS.Rekognition.ListFaces Methods (==) :: ListFaces -> ListFaces -> Bool # (/=) :: ListFaces -> ListFaces -> Bool #
Data ListFaces #
Instance details Defined in Network.AWS.Rekognition.ListFaces Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListFaces -> c ListFaces # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListFaces # toConstr :: ListFaces -> Constr # dataTypeOf :: ListFaces -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListFaces) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListFaces) # gmapT :: (forall b. Data b => b -> b) -> ListFaces -> ListFaces # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListFaces -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListFaces -> r # gmapQ :: (forall d. Data d => d -> u) -> ListFaces -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ListFaces -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListFaces -> m ListFaces # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListFaces -> m ListFaces # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListFaces -> m ListFaces #
Read ListFaces #
Instance details Defined in Network.AWS.Rekognition.ListFaces Methods readsPrec :: Int -> ReadS ListFaces # readList :: ReadS [ListFaces] # readPrec :: ReadPrec ListFaces # readListPrec :: ReadPrec [ListFaces] #
Show ListFaces #
Instance details Defined in Network.AWS.Rekognition.ListFaces Methods showsPrec :: Int -> ListFaces -> ShowS # show :: ListFaces -> String # showList :: [ListFaces] -> ShowS #
Generic ListFaces #
Instance details Defined in Network.AWS.Rekognition.ListFaces Associated Types type Rep ListFaces :: * -> * # Methods from :: ListFaces -> Rep ListFaces x # to :: Rep ListFaces x -> ListFaces #
Hashable ListFaces #
Instance details Defined in Network.AWS.Rekognition.ListFaces Methods hashWithSalt :: Int -> ListFaces -> Int # hash :: ListFaces -> Int #
ToJSON ListFaces #
Instance details Defined in Network.AWS.Rekognition.ListFaces Methods toJSON :: ListFaces -> Value # toEncoding :: ListFaces -> Encoding # toJSONList :: [ListFaces] -> Value # toEncodingList :: [ListFaces] -> Encoding #
AWSPager ListFaces #
Instance details Defined in Network.AWS.Rekognition.ListFaces Methods page :: ListFaces -> Rs ListFaces -> Maybe ListFaces #
AWSRequest ListFaces #
Instance details Defined in Network.AWS.Rekognition.ListFaces Associated Types type Rs ListFaces :: * # Methods request :: ListFaces -> Request ListFaces # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy ListFaces -> ClientResponse -> m (Response ListFaces) #
ToHeaders ListFaces #
Instance details Defined in Network.AWS.Rekognition.ListFaces Methods toHeaders :: ListFaces -> [Header] #
ToPath ListFaces #
Instance details Defined in Network.AWS.Rekognition.ListFaces Methods toPath :: ListFaces -> ByteString #
ToQuery ListFaces #
Instance details Defined in Network.AWS.Rekognition.ListFaces Methods toQuery :: ListFaces -> QueryString #
NFData ListFaces #
Instance details Defined in Network.AWS.Rekognition.ListFaces Methods rnf :: ListFaces -> () #
type Rep ListFaces #
Instance details Defined in Network.AWS.Rekognition.ListFaces type Rep ListFaces = D1 (MetaData "ListFaces" "Network.AWS.Rekognition.ListFaces" "amazonka-rekognition-1.6.0-1OMR5H5ExV9ym4zNmFCPP" False) (C1 (MetaCons "ListFaces'" PrefixI True) (S1 (MetaSel (Just "_lfNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_lfMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :: S1 (MetaSel (Just "_lfCollectionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs ListFaces #
Instance details Defined in Network.AWS.Rekognition.ListFaces type Rs ListFaces = ListFacesResponse

Request Lenses

lfNextToken :: Lens' ListFaces (Maybe Text) #

If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.

lfMaxResults :: Lens' ListFaces (Maybe Natural) #

Maximum number of faces to return.

lfCollectionId :: Lens' ListFaces Text #

ID of the collection from which to list the faces.

Destructuring the Response

listFacesResponse #

Arguments

:: Int	`lfrsResponseStatus`
-> ListFacesResponse

Creates a value of ListFacesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

lfrsFaceModelVersion - Version number of the face detection model associated with the input collection (CollectionId ).
lfrsNextToken - If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.
lfrsFaces - An array of Face objects.
lfrsResponseStatus - -- | The response status code.

data ListFacesResponse #

See: listFacesResponse smart constructor.

Instances

Eq ListFacesResponse #
Instance details Defined in Network.AWS.Rekognition.ListFaces Methods (==) :: ListFacesResponse -> ListFacesResponse -> Bool # (/=) :: ListFacesResponse -> ListFacesResponse -> Bool #
Data ListFacesResponse #
Instance details Defined in Network.AWS.Rekognition.ListFaces Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListFacesResponse -> c ListFacesResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListFacesResponse # toConstr :: ListFacesResponse -> Constr # dataTypeOf :: ListFacesResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListFacesResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListFacesResponse) # gmapT :: (forall b. Data b => b -> b) -> ListFacesResponse -> ListFacesResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListFacesResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListFacesResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> ListFacesResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ListFacesResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListFacesResponse -> m ListFacesResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListFacesResponse -> m ListFacesResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListFacesResponse -> m ListFacesResponse #
Read ListFacesResponse #
Instance details Defined in Network.AWS.Rekognition.ListFaces Methods readsPrec :: Int -> ReadS ListFacesResponse # readList :: ReadS [ListFacesResponse] # readPrec :: ReadPrec ListFacesResponse # readListPrec :: ReadPrec [ListFacesResponse] #
Show ListFacesResponse #
Instance details Defined in Network.AWS.Rekognition.ListFaces Methods showsPrec :: Int -> ListFacesResponse -> ShowS # show :: ListFacesResponse -> String # showList :: [ListFacesResponse] -> ShowS #
Generic ListFacesResponse #
Instance details Defined in Network.AWS.Rekognition.ListFaces Associated Types type Rep ListFacesResponse :: * -> * # Methods from :: ListFacesResponse -> Rep ListFacesResponse x # to :: Rep ListFacesResponse x -> ListFacesResponse #
NFData ListFacesResponse #
Instance details Defined in Network.AWS.Rekognition.ListFaces Methods rnf :: ListFacesResponse -> () #
type Rep ListFacesResponse #
Instance details Defined in Network.AWS.Rekognition.ListFaces type Rep ListFacesResponse = D1 (MetaData "ListFacesResponse" "Network.AWS.Rekognition.ListFaces" "amazonka-rekognition-1.6.0-1OMR5H5ExV9ym4zNmFCPP" False) (C1 (MetaCons "ListFacesResponse'" PrefixI True) ((S1 (MetaSel (Just "_lfrsFaceModelVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_lfrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_lfrsFaces") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Face])) :*: S1 (MetaSel (Just "_lfrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

lfrsFaceModelVersion :: Lens' ListFacesResponse (Maybe Text) #

Version number of the face detection model associated with the input collection (CollectionId ).

lfrsNextToken :: Lens' ListFacesResponse (Maybe Text) #

If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.

lfrsFaces :: Lens' ListFacesResponse [Face] #

An array of Face objects.

lfrsResponseStatus :: Lens' ListFacesResponse Int #

- | The response status code.