amazonka-rekognition-1.6.0: Amazon Rekognition SDK.

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

Network.AWS.Rekognition.RecognizeCelebrities

Contents

Description

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.

Synopsis

Creating a Request

recognizeCelebrities #

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 #

See: recognizeCelebrities smart constructor.

Instances

Eq RecognizeCelebrities # 
Data RecognizeCelebrities # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RecognizeCelebrities -> c RecognizeCelebrities #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RecognizeCelebrities #

toConstr :: RecognizeCelebrities -> Constr #

dataTypeOf :: RecognizeCelebrities -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RecognizeCelebrities) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RecognizeCelebrities) #

gmapT :: (forall b. Data b => b -> b) -> RecognizeCelebrities -> RecognizeCelebrities #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RecognizeCelebrities -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RecognizeCelebrities -> r #

gmapQ :: (forall d. Data d => d -> u) -> RecognizeCelebrities -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> RecognizeCelebrities -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RecognizeCelebrities -> m RecognizeCelebrities #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RecognizeCelebrities -> m RecognizeCelebrities #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RecognizeCelebrities -> m RecognizeCelebrities #

Read RecognizeCelebrities # 
Show RecognizeCelebrities # 
Generic RecognizeCelebrities # 
Hashable RecognizeCelebrities # 
ToJSON RecognizeCelebrities # 
NFData RecognizeCelebrities # 

Methods

rnf :: RecognizeCelebrities -> () #

AWSRequest RecognizeCelebrities # 
ToHeaders RecognizeCelebrities # 
ToPath RecognizeCelebrities # 
ToQuery RecognizeCelebrities # 
type Rep RecognizeCelebrities # 
type Rep RecognizeCelebrities = D1 * (MetaData "RecognizeCelebrities" "Network.AWS.Rekognition.RecognizeCelebrities" "amazonka-rekognition-1.6.0-4TmAlrIlJHI1iGSYhkZbGT" True) (C1 * (MetaCons "RecognizeCelebrities'" PrefixI True) (S1 * (MetaSel (Just Symbol "_rcImage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Image)))
type Rs RecognizeCelebrities # 

Request Lenses

rcImage :: Lens' RecognizeCelebrities Image #

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 #

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 in CelebrityFaces and UnrecognizedFaces 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 #

See: recognizeCelebritiesResponse smart constructor.

Instances

Eq RecognizeCelebritiesResponse # 
Data RecognizeCelebritiesResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RecognizeCelebritiesResponse -> c RecognizeCelebritiesResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RecognizeCelebritiesResponse #

toConstr :: RecognizeCelebritiesResponse -> Constr #

dataTypeOf :: RecognizeCelebritiesResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RecognizeCelebritiesResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RecognizeCelebritiesResponse) #

gmapT :: (forall b. Data b => b -> b) -> RecognizeCelebritiesResponse -> RecognizeCelebritiesResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RecognizeCelebritiesResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RecognizeCelebritiesResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> RecognizeCelebritiesResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> RecognizeCelebritiesResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RecognizeCelebritiesResponse -> m RecognizeCelebritiesResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RecognizeCelebritiesResponse -> m RecognizeCelebritiesResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RecognizeCelebritiesResponse -> m RecognizeCelebritiesResponse #

Read RecognizeCelebritiesResponse # 
Show RecognizeCelebritiesResponse # 
Generic RecognizeCelebritiesResponse # 
NFData RecognizeCelebritiesResponse # 
type Rep RecognizeCelebritiesResponse # 
type Rep RecognizeCelebritiesResponse = D1 * (MetaData "RecognizeCelebritiesResponse" "Network.AWS.Rekognition.RecognizeCelebrities" "amazonka-rekognition-1.6.0-4TmAlrIlJHI1iGSYhkZbGT" False) (C1 * (MetaCons "RecognizeCelebritiesResponse'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_rcrsCelebrityFaces") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Celebrity]))) (S1 * (MetaSel (Just Symbol "_rcrsOrientationCorrection") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe OrientationCorrection)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_rcrsUnrecognizedFaces") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [ComparedFace]))) (S1 * (MetaSel (Just Symbol "_rcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

rcrsCelebrityFaces :: Lens' RecognizeCelebritiesResponse [Celebrity] #

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) #

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] #

Details about each unrecognized face in the image.