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 |
Returns an array of celebrities recognized in the input image. For more information, see celebrities
.
RecognizeCelebrities
returns the 100 largest faces in the image. It lists recognized celebrities in the CelebrityFaces
array and unrecognized faces in the UnrecognizedFaces
array. RecognizeCelebrities
doesn't return celebrities whose faces are not amongst the largest 100 faces in the image.
For each celebrity recognized, the RecognizeCelebrities
returns a Celebrity
object. The Celebrity
object contains the celebrity name, ID, URL links to additional information, match confidence, and a ComparedFace
object that you can use to locate the celebrity's face on the image.
Rekognition does not retain information about which images a celebrity has been recognized in. Your application must store this information and use the Celebrity
ID property as a unique identifier for the celebrity. If you don't store the celebrity name or additional information URLs returned by RecognizeCelebrities
, you will need the ID to identify the celebrity in a call to the operation.
You pass the imput image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the Amazon CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
For an example, see 'celebrities-procedure-image' .
This operation requires permissions to perform the rekognition:RecognizeCelebrities
operation.
- recognizeCelebrities :: Image -> RecognizeCelebrities
- data RecognizeCelebrities
- rcImage :: Lens' RecognizeCelebrities Image
- recognizeCelebritiesResponse :: Int -> RecognizeCelebritiesResponse
- data RecognizeCelebritiesResponse
- rcrsCelebrityFaces :: Lens' RecognizeCelebritiesResponse [Celebrity]
- rcrsOrientationCorrection :: Lens' RecognizeCelebritiesResponse (Maybe OrientationCorrection)
- rcrsUnrecognizedFaces :: Lens' RecognizeCelebritiesResponse [ComparedFace]
- rcrsResponseStatus :: Lens' RecognizeCelebritiesResponse Int
Creating a Request
Creates a value of RecognizeCelebrities
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rcImage
- The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
data RecognizeCelebrities Source #
See: recognizeCelebrities
smart constructor.
Request Lenses
rcImage :: Lens' RecognizeCelebrities Image Source #
The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.
Destructuring the Response
recognizeCelebritiesResponse Source #
Creates a value of RecognizeCelebritiesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rcrsCelebrityFaces
- Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 15 celebrities in an image.rcrsOrientationCorrection
- The orientation of the input image (counterclockwise direction). If your application displays the image, you can use this value to correct the orientation. The bounding box coordinates returned inCelebrityFaces
andUnrecognizedFaces
represent face locations before the image orientation is corrected.rcrsUnrecognizedFaces
- Details about each unrecognized face in the image.rcrsResponseStatus
- -- | The response status code.
data RecognizeCelebritiesResponse Source #
See: recognizeCelebritiesResponse
smart constructor.
Response Lenses
rcrsCelebrityFaces :: Lens' RecognizeCelebritiesResponse [Celebrity] Source #
Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 15 celebrities in an image.
rcrsOrientationCorrection :: Lens' RecognizeCelebritiesResponse (Maybe OrientationCorrection) Source #
The orientation of the input image (counterclockwise direction). If your application displays the image, you can use this value to correct the orientation. The bounding box coordinates returned in CelebrityFaces
and UnrecognizedFaces
represent face locations before the image orientation is corrected.
rcrsUnrecognizedFaces :: Lens' RecognizeCelebritiesResponse [ComparedFace] Source #
Details about each unrecognized face in the image.
rcrsResponseStatus :: Lens' RecognizeCelebritiesResponse Int Source #
- - | The response status code.