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.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 Listing Faces in a Collection in the Amazon Rekognition Developer Guide.

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

This operation returns paginated results.

Synopsis

data ListFaces = ListFaces' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- collectionId :: Text
}
newListFaces :: Text -> ListFaces
listFaces_maxResults :: Lens' ListFaces (Maybe Natural)
listFaces_nextToken :: Lens' ListFaces (Maybe Text)
listFaces_collectionId :: Lens' ListFaces Text
data ListFacesResponse = ListFacesResponse' {
- faceModelVersion :: Maybe Text
- faces :: Maybe [Face]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListFacesResponse :: Int -> ListFacesResponse
listFacesResponse_faceModelVersion :: Lens' ListFacesResponse (Maybe Text)
listFacesResponse_faces :: Lens' ListFacesResponse (Maybe [Face])
listFacesResponse_nextToken :: Lens' ListFacesResponse (Maybe Text)
listFacesResponse_httpStatus :: Lens' ListFacesResponse Int

Creating a Request

data ListFaces Source #

See: newListFaces smart constructor.

Constructors

ListFaces'
Fields maxResults :: Maybe Natural Maximum number of faces to return. nextToken :: 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. collectionId :: Text ID of the collection from which to list the faces.

Instances

Instances details

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

newListFaces Source #

Arguments

:: Text	`ListFaces`
-> ListFaces

Create a value of ListFaces 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:maxResults:ListFaces', listFaces_maxResults - Maximum number of faces to return.

ListFaces, listFaces_nextToken - 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.

ListFaces, listFaces_collectionId - ID of the collection from which to list the faces.

Request Lenses

listFaces_maxResults :: Lens' ListFaces (Maybe Natural) Source #

Maximum number of faces to return.

listFaces_nextToken :: Lens' ListFaces (Maybe Text) Source #

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.

listFaces_collectionId :: Lens' ListFaces Text Source #

ID of the collection from which to list the faces.

Destructuring the Response

data ListFacesResponse Source #

See: newListFacesResponse smart constructor.

Constructors

ListFacesResponse'

Fields

faceModelVersion :: Maybe Text
Version number of the face detection model associated with the input collection (CollectionId).
faces :: Maybe [Face]
An array of Face objects.
nextToken :: 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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListFacesResponse Source #
Instance details Defined in Amazonka.Rekognition.ListFaces Associated Types type Rep ListFacesResponse :: Type -> Type # Methods from :: ListFacesResponse -> Rep ListFacesResponse x # to :: Rep ListFacesResponse x -> ListFacesResponse #
Read ListFacesResponse Source #
Instance details Defined in Amazonka.Rekognition.ListFaces Methods readsPrec :: Int -> ReadS ListFacesResponse # readList :: ReadS [ListFacesResponse] # readPrec :: ReadPrec ListFacesResponse # readListPrec :: ReadPrec [ListFacesResponse] #
Show ListFacesResponse Source #
Instance details Defined in Amazonka.Rekognition.ListFaces Methods showsPrec :: Int -> ListFacesResponse -> ShowS # show :: ListFacesResponse -> String # showList :: [ListFacesResponse] -> ShowS #
NFData ListFacesResponse Source #
Instance details Defined in Amazonka.Rekognition.ListFaces Methods rnf :: ListFacesResponse -> () #
Eq ListFacesResponse Source #
Instance details Defined in Amazonka.Rekognition.ListFaces Methods (==) :: ListFacesResponse -> ListFacesResponse -> Bool # (/=) :: ListFacesResponse -> ListFacesResponse -> Bool #
type Rep ListFacesResponse Source #
Instance details Defined in Amazonka.Rekognition.ListFaces type Rep ListFacesResponse = D1 ('MetaData "ListFacesResponse" "Amazonka.Rekognition.ListFaces" "amazonka-rekognition-2.0-EaCrS9R3rWADqefEZvOx5B" 'False) (C1 ('MetaCons "ListFacesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "faceModelVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "faces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Face]))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListFacesResponse Source #

Arguments

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

Create a value of ListFacesResponse 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:faceModelVersion:ListFacesResponse', listFacesResponse_faceModelVersion - Version number of the face detection model associated with the input collection (CollectionId).

$sel:faces:ListFacesResponse', listFacesResponse_faces - An array of Face objects.

ListFaces, listFacesResponse_nextToken - 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.

$sel:httpStatus:ListFacesResponse', listFacesResponse_httpStatus - The response's http status code.

Response Lenses

listFacesResponse_faceModelVersion :: Lens' ListFacesResponse (Maybe Text) Source #

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

listFacesResponse_faces :: Lens' ListFacesResponse (Maybe [Face]) Source #

An array of Face objects.

listFacesResponse_nextToken :: Lens' ListFacesResponse (Maybe Text) Source #

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.

listFacesResponse_httpStatus :: Lens' ListFacesResponse Int Source #

The response's http status code.