Network.AWS.Rekognition.RecognizeCelebrities

Returns an array of celebrities recognized in the input image. The image is passed either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. The image must be either a PNG or JPEG formatted file. For more information, see 'celebrity-recognition' .

RecognizeCelebrities returns the 15 largest faces in the image. It lists recognized celebrities in the CelebrityFaces list and unrecognized faces in the UnrecognizedFaces list. The operation doesn't return celebrities whose face sizes are smaller than the largest 15 faces in the image.

For each celebrity recognized, the API 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.

For an example, see 'recognize-celebrities-tutorial' .

This operation requires permissions to perform the rekognition:RecognizeCelebrities operation.

Creating a Request

recognizeCelebrities

Arguments

:: Image

rcImage

-> 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 to use for celebrity recognition.

data RecognizeCelebrities

See: recognizeCelebrities smart constructor.

Instances

Eq RecognizeCelebrities

Methods

(==) :: RecognizeCelebrities -> RecognizeCelebrities -> Bool

(/=) :: RecognizeCelebrities -> RecognizeCelebrities -> Bool

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

Methods

readsPrec :: Int -> ReadS RecognizeCelebrities

readList :: ReadS [RecognizeCelebrities]

readPrec :: ReadPrec RecognizeCelebrities

readListPrec :: ReadPrec [RecognizeCelebrities]

Show RecognizeCelebrities

Methods

showsPrec :: Int -> RecognizeCelebrities -> ShowS

show :: RecognizeCelebrities -> String

showList :: [RecognizeCelebrities] -> ShowS

Generic RecognizeCelebrities

Associated Types

type Rep RecognizeCelebrities :: * -> *

Methods

from :: RecognizeCelebrities -> Rep RecognizeCelebrities x

to :: Rep RecognizeCelebrities x -> RecognizeCelebrities

Hashable RecognizeCelebrities

Methods

hashWithSalt :: Int -> RecognizeCelebrities -> Int

hash :: RecognizeCelebrities -> Int

ToJSON RecognizeCelebrities

Methods

toJSON :: RecognizeCelebrities -> Value

toEncoding :: RecognizeCelebrities -> Encoding

toJSONList :: [RecognizeCelebrities] -> Value

toEncodingList :: [RecognizeCelebrities] -> Encoding

NFData RecognizeCelebrities

Methods

rnf :: RecognizeCelebrities -> ()

AWSRequest RecognizeCelebrities

Associated Types

type Rs RecognizeCelebrities :: *

Methods

request :: RecognizeCelebrities -> Request RecognizeCelebrities

response :: MonadResource m => Logger -> Service -> Proxy * RecognizeCelebrities -> ClientResponse -> m (Response RecognizeCelebrities)

ToQuery RecognizeCelebrities

Methods

toQuery :: RecognizeCelebrities -> QueryString

ToPath RecognizeCelebrities

Methods

toPath :: RecognizeCelebrities -> ByteString

ToHeaders RecognizeCelebrities

Methods

toHeaders :: RecognizeCelebrities -> [Header]

type Rep RecognizeCelebrities

type Rep RecognizeCelebrities = D1 (MetaData "RecognizeCelebrities" "Network.AWS.Rekognition.RecognizeCelebrities" "amazonka-rekognition-1.5.0-B4jtpxqOYsT3vpCV9vDK91" True) (C1 (MetaCons "RecognizeCelebrities'" PrefixI True) (S1 (MetaSel (Just Symbol "_rcImage") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Image)))

type Rs RecognizeCelebrities

type Rs RecognizeCelebrities = RecognizeCelebritiesResponse

Request Lenses

rcImage :: Lens' RecognizeCelebrities Image

The input image to use for celebrity recognition.

Destructuring the Response

recognizeCelebritiesResponse

Arguments

:: Int

rcrsResponseStatus

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

Methods

(==) :: RecognizeCelebritiesResponse -> RecognizeCelebritiesResponse -> Bool

(/=) :: RecognizeCelebritiesResponse -> RecognizeCelebritiesResponse -> Bool

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

Methods

readsPrec :: Int -> ReadS RecognizeCelebritiesResponse

readList :: ReadS [RecognizeCelebritiesResponse]

readPrec :: ReadPrec RecognizeCelebritiesResponse

readListPrec :: ReadPrec [RecognizeCelebritiesResponse]

Show RecognizeCelebritiesResponse

Methods

showsPrec :: Int -> RecognizeCelebritiesResponse -> ShowS

show :: RecognizeCelebritiesResponse -> String

showList :: [RecognizeCelebritiesResponse] -> ShowS

Generic RecognizeCelebritiesResponse

Associated Types

type Rep RecognizeCelebritiesResponse :: * -> *

Methods

from :: RecognizeCelebritiesResponse -> Rep RecognizeCelebritiesResponse x

to :: Rep RecognizeCelebritiesResponse x -> RecognizeCelebritiesResponse

NFData RecognizeCelebritiesResponse

Methods

rnf :: RecognizeCelebritiesResponse -> ()

type Rep RecognizeCelebritiesResponse

type Rep RecognizeCelebritiesResponse = D1 (MetaData "RecognizeCelebritiesResponse" "Network.AWS.Rekognition.RecognizeCelebrities" "amazonka-rekognition-1.5.0-B4jtpxqOYsT3vpCV9vDK91" 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.

rcrsResponseStatus :: Lens' RecognizeCelebritiesResponse Int

• - | The response status code.