Copyright | (c) 2013-2017 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 |
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.
This operation returns paginated results.
- listFaces :: Text -> ListFaces
- data ListFaces
- lfNextToken :: Lens' ListFaces (Maybe Text)
- lfMaxResults :: Lens' ListFaces (Maybe Natural)
- lfCollectionId :: Lens' ListFaces Text
- listFacesResponse :: Int -> ListFacesResponse
- data ListFacesResponse
- lfrsNextToken :: Lens' ListFacesResponse (Maybe Text)
- lfrsFaces :: Lens' ListFacesResponse [Face]
- lfrsResponseStatus :: Lens' ListFacesResponse Int
Creating a Request
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.
See: listFaces
smart constructor.
Request Lenses
lfNextToken :: 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.
Destructuring the Response
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 ofFace
objects.lfrsResponseStatus
- -- | The response status code.
data ListFacesResponse Source #
See: listFacesResponse
smart constructor.
Response Lenses
lfrsNextToken :: 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.
lfrsResponseStatus :: Lens' ListFacesResponse Int Source #
- - | The response status code.