GetCelebrityRecognition

Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by StartCelebrityRecognition.

Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call to StartCelebrityRecognition which returns a job identifier (JobId).

When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartCelebrityRecognition. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetCelebrityDetection and pass the job identifier (JobId) from the initial call to StartCelebrityDetection.

For more information, see Working with stored videos.

GetCelebrityRecognition returns detected celebrities and the time(s) they are detected in an array (Celebrities) of CelebrityRecognition objects. Each CelebrityRecognition contains information about the celebrity in a CelebrityDetail object and the time, Timestamp, the celebrity was detected. This CelebrityDetail object stores information about the detected celebrity's face attributes, a face bounding box, known gender, the celebrity's name, and a confidence estimate.

By default, the Celebrities array is sorted by time (milliseconds from the start of the video). You can also sort the array by celebrity by specifying the value ID in the SortBy input parameter.

The CelebrityDetail object includes the celebrity identifer and additional information urls. If you don't store the additional information urls, you can get them later by calling GetCelebrityInfo with the celebrity identifer.

No information is returned for faces not recognized as celebrities.

Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetCelebrityDetection and populate the NextToken request parameter with the token value returned from the previous call to GetCelebrityRecognition.

Request Syntax

{
   "JobId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SortBy": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Response Syntax

{
   "Celebrities": [ 
      { 
         "Celebrity": { 
            "BoundingBox": { 
               "Height": number,
               "Left": number,
               "Top": number,
               "Width": number
            },
            "Confidence": number,
            "Face": { 
               "AgeRange": { 
                  "High": number,
                  "Low": number
               },
               "Beard": { 
                  "Confidence": number,
                  "Value": boolean
               },
               "BoundingBox": { 
                  "Height": number,
                  "Left": number,
                  "Top": number,
                  "Width": number
               },
               "Confidence": number,
               "Emotions": [ 
                  { 
                     "Confidence": number,
                     "Type": "string"
                  }
               ],
               "EyeDirection": { 
                  "Confidence": number,
                  "Pitch": number,
                  "Yaw": number
               },
               "Eyeglasses": { 
                  "Confidence": number,
                  "Value": boolean
               },
               "EyesOpen": { 
                  "Confidence": number,
                  "Value": boolean
               },
               "FaceOccluded": { 
                  "Confidence": number,
                  "Value": boolean
               },
               "Gender": { 
                  "Confidence": number,
                  "Value": "string"
               },
               "Landmarks": [ 
                  { 
                     "Type": "string",
                     "X": number,
                     "Y": number
                  }
               ],
               "MouthOpen": { 
                  "Confidence": number,
                  "Value": boolean
               },
               "Mustache": { 
                  "Confidence": number,
                  "Value": boolean
               },
               "Pose": { 
                  "Pitch": number,
                  "Roll": number,
                  "Yaw": number
               },
               "Quality": { 
                  "Brightness": number,
                  "Sharpness": number
               },
               "Smile": { 
                  "Confidence": number,
                  "Value": boolean
               },
               "Sunglasses": { 
                  "Confidence": number,
                  "Value": boolean
               }
            },
            "Id": "string",
            "KnownGender": { 
               "Type": "string"
            },
            "Name": "string",
            "Urls": [ "string" ]
         },
         "Timestamp": number
      }
   ],
   "JobId": "string",
   "JobStatus": "string",
   "JobTag": "string",
   "NextToken": "string",
   "StatusMessage": "string",
   "Video": { 
      "S3Object": { 
         "Bucket": "string",
         "Name": "string",
         "Version": "string"
      }
   },
   "VideoMetadata": { 
      "Codec": "string",
      "ColorRange": "string",
      "DurationMillis": number,
      "Format": "string",
      "FrameHeight": number,
      "FrameRate": number,
      "FrameWidth": number
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Errors

For information about the errors that are common to all actions, see Common Errors.

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: