amazonka-rekognition-1.4.5: Amazon Rekognition SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Rekognition.ListFaces

Contents

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

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

Synopsis

Creating a Request

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 # 
Data 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 # 
Show ListFaces # 
Generic ListFaces # 

Associated Types

type Rep ListFaces :: * -> * #

Hashable ListFaces # 
ToJSON ListFaces # 
NFData ListFaces # 

Methods

rnf :: ListFaces -> () #

AWSRequest ListFaces # 
ToQuery ListFaces # 
ToPath ListFaces # 
ToHeaders ListFaces # 

Methods

toHeaders :: ListFaces -> [Header] #

type Rep ListFaces # 
type Rep ListFaces = D1 (MetaData "ListFaces" "Network.AWS.Rekognition.ListFaces" "amazonka-rekognition-1.4.5-7kQQXfpD3s0BAUEtxNCePO" False) (C1 (MetaCons "ListFaces'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lfNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lfMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_lfCollectionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs ListFaces # 

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 #

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:

  • 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 # 
Data ListFacesResponse # 

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 # 
Show ListFacesResponse # 
Generic ListFacesResponse # 
NFData ListFacesResponse # 

Methods

rnf :: ListFacesResponse -> () #

type Rep ListFacesResponse # 
type Rep ListFacesResponse = D1 (MetaData "ListFacesResponse" "Network.AWS.Rekognition.ListFaces" "amazonka-rekognition-1.4.5-7kQQXfpD3s0BAUEtxNCePO" False) (C1 (MetaCons "ListFacesResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_lfrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_lfrsFaces") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Face]))) (S1 (MetaSel (Just Symbol "_lfrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

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.