[ aws . rekognition ]
recognize-celebrities¶
Description¶
Returns an array of celebrities recognized in the input image. For more information, see Recognizing celebrities in the Amazon Rekognition Developer Guide.
RecognizeCelebritiesreturns the 64 largest faces in the image. It lists the recognized celebrities in theCelebrityFacesarray and any unrecognized faces in theUnrecognizedFacesarray.RecognizeCelebritiesdoesn’t return celebrities whose faces aren’t among the largest 64 faces in the image.
For each celebrity recognized, 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.
Amazon Rekognition doesn’t 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 GetCelebrityInfo operation.
You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS 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 Recognizing celebrities in an image in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:RecognizeCelebrities operation.
See also: AWS API Documentation
Synopsis¶
recognize-celebrities
[--image <value>]
[--image-bytes <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options¶
--image (structure)
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.
If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the
Bytesfield. For more information, see Images in the Amazon Rekognition developer guide.To specify a local file use
--image-bytesinstead.Bytes -> (blob)
Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass toDetectCustomLabelsis 4MB.S3Object -> (structure)
Identifies an S3 object as the image source.
Bucket -> (string)
Name of the S3 bucket.Name -> (string)
S3 object key name.Version -> (string)
If the bucket is versioning enabled, you can specify the object version.
Shorthand Syntax:
Bytes=blob,S3Object={Bucket=string,Name=string,Version=string}
JSON Syntax:
{
"Bytes": blob,
"S3Object": {
"Bucket": "string",
"Name": "string",
"Version": "string"
}
}
--image-bytes (blob)
The content of the image to be uploaded. To specify the content of a local file use the fileb:// prefix. Example: fileb://image.png
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
- on
- off
- auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To recognize celebrities in an image
The following recognize-celebrities command recognizes celebrities in the specified image stored in an Amazon S3 bucket.:
aws rekognition recognize-celebrities \
--image "S3Object={Bucket=MyImageS3Bucket,Name=moviestars.jpg}"
Output:
{
"UnrecognizedFaces": [
{
"BoundingBox": {
"Width": 0.14416666328907013,
"Top": 0.07777778059244156,
"Left": 0.625,
"Height": 0.2746031880378723
},
"Confidence": 99.9990234375,
"Pose": {
"Yaw": 10.80408763885498,
"Roll": -12.761146545410156,
"Pitch": 10.96889877319336
},
"Quality": {
"Sharpness": 94.1185531616211,
"Brightness": 79.18367004394531
},
"Landmarks": [
{
"Y": 0.18220913410186768,
"X": 0.6702951788902283,
"Type": "eyeLeft"
},
{
"Y": 0.16337193548679352,
"X": 0.7188183665275574,
"Type": "eyeRight"
},
{
"Y": 0.20739148557186127,
"X": 0.7055801749229431,
"Type": "nose"
},
{
"Y": 0.2889308035373688,
"X": 0.687512218952179,
"Type": "mouthLeft"
},
{
"Y": 0.2706988751888275,
"X": 0.7250053286552429,
"Type": "mouthRight"
}
]
}
],
"CelebrityFaces": [
{
"MatchConfidence": 100.0,
"Face": {
"BoundingBox": {
"Width": 0.14000000059604645,
"Top": 0.1190476194024086,
"Left": 0.82833331823349,
"Height": 0.2666666805744171
},
"Confidence": 99.99359130859375,
"Pose": {
"Yaw": -10.509642601013184,
"Roll": -14.51749324798584,
"Pitch": 13.799399375915527
},
"Quality": {
"Sharpness": 78.74752044677734,
"Brightness": 42.201324462890625
},
"Landmarks": [
{
"Y": 0.2290833294391632,
"X": 0.8709492087364197,
"Type": "eyeLeft"
},
{
"Y": 0.20639978349208832,
"X": 0.9153988361358643,
"Type": "eyeRight"
},
{
"Y": 0.25417643785476685,
"X": 0.8907724022865295,
"Type": "nose"
},
{
"Y": 0.32729196548461914,
"X": 0.8876466155052185,
"Type": "mouthLeft"
},
{
"Y": 0.3115464746952057,
"X": 0.9238573312759399,
"Type": "mouthRight"
}
]
},
"Name": "Celeb A",
"Urls": [
"www.imdb.com/name/aaaaaaaaa"
],
"Id": "1111111"
},
{
"MatchConfidence": 97.0,
"Face": {
"BoundingBox": {
"Width": 0.13333334028720856,
"Top": 0.24920634925365448,
"Left": 0.4449999928474426,
"Height": 0.2539682686328888
},
"Confidence": 99.99979400634766,
"Pose": {
"Yaw": 6.557040691375732,
"Roll": -7.316643714904785,
"Pitch": 9.272967338562012
},
"Quality": {
"Sharpness": 83.23492431640625,
"Brightness": 78.83267974853516
},
"Landmarks": [
{
"Y": 0.3625510632991791,
"X": 0.48898839950561523,
"Type": "eyeLeft"
},
{
"Y": 0.35366007685661316,
"X": 0.5313721299171448,
"Type": "eyeRight"
},
{
"Y": 0.3894785940647125,
"X": 0.5173314809799194,
"Type": "nose"
},
{
"Y": 0.44889405369758606,
"X": 0.5020005702972412,
"Type": "mouthLeft"
},
{
"Y": 0.4408611059188843,
"X": 0.5351271629333496,
"Type": "mouthRight"
}
]
},
"Name": "Celeb B",
"Urls": [
"www.imdb.com/name/bbbbbbbbb"
],
"Id": "2222222"
},
{
"MatchConfidence": 100.0,
"Face": {
"BoundingBox": {
"Width": 0.12416666746139526,
"Top": 0.2968254089355469,
"Left": 0.2150000035762787,
"Height": 0.23650793731212616
},
"Confidence": 99.99958801269531,
"Pose": {
"Yaw": 7.801797866821289,
"Roll": -8.326810836791992,
"Pitch": 7.844768047332764
},
"Quality": {
"Sharpness": 86.93206024169922,
"Brightness": 79.81291198730469
},
"Landmarks": [
{
"Y": 0.4027804136276245,
"X": 0.2575301229953766,
"Type": "eyeLeft"
},
{
"Y": 0.3934555947780609,
"X": 0.2956969439983368,
"Type": "eyeRight"
},
{
"Y": 0.4309830069541931,
"X": 0.2837020754814148,
"Type": "nose"
},
{
"Y": 0.48186683654785156,
"X": 0.26812544465065,
"Type": "mouthLeft"
},
{
"Y": 0.47338807582855225,
"X": 0.29905644059181213,
"Type": "mouthRight"
}
]
},
"Name": "Celeb C",
"Urls": [
"www.imdb.com/name/ccccccccc"
],
"Id": "3333333"
},
{
"MatchConfidence": 97.0,
"Face": {
"BoundingBox": {
"Width": 0.11916666477918625,
"Top": 0.3698412775993347,
"Left": 0.008333333767950535,
"Height": 0.22698412835597992
},
"Confidence": 99.99999237060547,
"Pose": {
"Yaw": 16.38478660583496,
"Roll": -1.0260354280471802,
"Pitch": 5.975185394287109
},
"Quality": {
"Sharpness": 83.23492431640625,
"Brightness": 61.408443450927734
},
"Landmarks": [
{
"Y": 0.4632347822189331,
"X": 0.049406956881284714,
"Type": "eyeLeft"
},
{
"Y": 0.46388113498687744,
"X": 0.08722897619009018,
"Type": "eyeRight"
},
{
"Y": 0.5020678639411926,
"X": 0.0758260041475296,
"Type": "nose"
},
{
"Y": 0.544157862663269,
"X": 0.054029736667871475,
"Type": "mouthLeft"
},
{
"Y": 0.5463630557060242,
"X": 0.08464983850717545,
"Type": "mouthRight"
}
]
},
"Name": "Celeb D",
"Urls": [
"www.imdb.com/name/ddddddddd"
],
"Id": "4444444"
}
]
}
For more information, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide.
Output¶
CelebrityFaces -> (list)
Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 64 celebrities in an image. Each celebrity object includes the following attributes:
Face,Confidence,Emotions,Landmarks,Pose,Quality,Smile,Id,KnownGender,MatchConfidence,Name,Urls.(structure)
Provides information about a celebrity recognized by the RecognizeCelebrities operation.
Urls -> (list)
An array of URLs pointing to additional information about the celebrity. If there is no additional information about the celebrity, this list is empty.
(string)
Name -> (string)
The name of the celebrity.Id -> (string)
A unique identifier for the celebrity.Face -> (structure)
Provides information about the celebrity’s face, such as its location on the image.
BoundingBox -> (structure)
Bounding box of the face.
Width -> (float)
Width of the bounding box as a ratio of the overall image width.Height -> (float)
Height of the bounding box as a ratio of the overall image height.Left -> (float)
Left coordinate of the bounding box as a ratio of overall image width.Top -> (float)
Top coordinate of the bounding box as a ratio of overall image height.Confidence -> (float)
Level of confidence that what the bounding box contains is a face.Landmarks -> (list)
An array of facial landmarks.
(structure)
Indicates the location of the landmark on the face.
Type -> (string)
Type of landmark.X -> (float)
The x-coordinate of the landmark expressed as a ratio of the width of the image. The x-coordinate is measured from the left-side of the image. For example, if the image is 700 pixels wide and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.Y -> (float)
The y-coordinate of the landmark expressed as a ratio of the height of the image. The y-coordinate is measured from the top of the image. For example, if the image height is 200 pixels and the y-coordinate of the landmark is at 50 pixels, this value is 0.25.Pose -> (structure)
Indicates the pose of the face as determined by its pitch, roll, and yaw.
Roll -> (float)
Value representing the face rotation on the roll axis.Yaw -> (float)
Value representing the face rotation on the yaw axis.Pitch -> (float)
Value representing the face rotation on the pitch axis.Quality -> (structure)
Identifies face image brightness and sharpness.
Brightness -> (float)
Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.Sharpness -> (float)
Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.Emotions -> (list)
The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include “Happy”, “Sad”, “Angry”, “Confused”, “Disgusted”, “Surprised”, “Calm”, “Unknown”, and “Fear”.
(structure)
The emotions that appear to be expressed on the face, and the confidence level in the determination. The API is only making a determination of the physical appearance of a person’s face. It is not a determination of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have a sad face might not be sad emotionally.
Type -> (string)
Type of emotion detected.Confidence -> (float)
Level of confidence in the determination.Smile -> (structure)
Indicates whether or not the face is smiling, and the confidence level in the determination.
Value -> (boolean)
Boolean value that indicates whether the face is smiling or not.Confidence -> (float)
Level of confidence in the determination.MatchConfidence -> (float)
The confidence, in percentage, that Amazon Rekognition has that the recognized face is the celebrity.KnownGender -> (structure)
The known gender identity for the celebrity that matches the provided ID. The known gender identity can be Male, Female, Nonbinary, or Unlisted.
Type -> (string)
A string value of the KnownGender info about the Celebrity.
UnrecognizedFaces -> (list)
Details about each unrecognized face in the image.
(structure)
Provides face metadata for target image faces that are analyzed by
CompareFacesandRecognizeCelebrities.BoundingBox -> (structure)
Bounding box of the face.
Width -> (float)
Width of the bounding box as a ratio of the overall image width.Height -> (float)
Height of the bounding box as a ratio of the overall image height.Left -> (float)
Left coordinate of the bounding box as a ratio of overall image width.Top -> (float)
Top coordinate of the bounding box as a ratio of overall image height.Confidence -> (float)
Level of confidence that what the bounding box contains is a face.Landmarks -> (list)
An array of facial landmarks.
(structure)
Indicates the location of the landmark on the face.
Type -> (string)
Type of landmark.X -> (float)
The x-coordinate of the landmark expressed as a ratio of the width of the image. The x-coordinate is measured from the left-side of the image. For example, if the image is 700 pixels wide and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.Y -> (float)
The y-coordinate of the landmark expressed as a ratio of the height of the image. The y-coordinate is measured from the top of the image. For example, if the image height is 200 pixels and the y-coordinate of the landmark is at 50 pixels, this value is 0.25.Pose -> (structure)
Indicates the pose of the face as determined by its pitch, roll, and yaw.
Roll -> (float)
Value representing the face rotation on the roll axis.Yaw -> (float)
Value representing the face rotation on the yaw axis.Pitch -> (float)
Value representing the face rotation on the pitch axis.Quality -> (structure)
Identifies face image brightness and sharpness.
Brightness -> (float)
Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.Sharpness -> (float)
Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.Emotions -> (list)
The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include “Happy”, “Sad”, “Angry”, “Confused”, “Disgusted”, “Surprised”, “Calm”, “Unknown”, and “Fear”.
(structure)
The emotions that appear to be expressed on the face, and the confidence level in the determination. The API is only making a determination of the physical appearance of a person’s face. It is not a determination of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have a sad face might not be sad emotionally.
Type -> (string)
Type of emotion detected.Confidence -> (float)
Level of confidence in the determination.Smile -> (structure)
Indicates whether or not the face is smiling, and the confidence level in the determination.
Value -> (boolean)
Boolean value that indicates whether the face is smiling or not.Confidence -> (float)
Level of confidence in the determination.
OrientationCorrection -> (string)
Note
Support for estimating image orientation using the the OrientationCorrection field has ceased as of August 2021. Any returned values for this field included in an API response will always be NULL.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
CelebrityFacesandUnrecognizedFacesrepresent face locations before the image orientation is corrected.Note
If the input image is in .jpeg format, it might contain exchangeable image (Exif) metadata that includes the image’s orientation. If so, and the Exif metadata for the input image populates the orientation field, the value ofOrientationCorrectionis null. TheCelebrityFacesandUnrecognizedFacesbounding box coordinates represent face locations after Exif metadata is used to correct the image orientation. Images in .png format don’t contain Exif metadata.