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.
GetCelebrityRecognition
only returns the default
facial attributes (BoundingBox
, Confidence
,
Landmarks
, Pose
, and Quality
). The other facial attributes listed
in the Face
object of the following response syntax are not returned. For more information,
see FaceDetail.
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
The request accepts the following data in JSON format.
- JobId
-
Job identifier for the required celebrity recognition analysis. You can get the job identifer from a call to
StartCelebrityRecognition
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9-_]+$
Required: Yes
- MaxResults
-
Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
- NextToken
-
If the previous response was incomplete (because there is more recognized celebrities to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of celebrities.
Type: String
Length Constraints: Maximum length of 255.
Required: No
- SortBy
-
Sort to use for celebrities returned in
Celebrities
field. SpecifyID
to sort by the celebrity identifier, specifyTIMESTAMP
to sort by the time the celebrity was recognized.Type: String
Valid Values:
ID | TIMESTAMP
Required: No
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"
}
],
"Eyeglasses": {
"Confidence": number,
"Value": boolean
},
"EyesOpen": {
"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",
"Name": "string",
"Urls": [ "string" ]
},
"Timestamp": number
}
],
"JobStatus": "string",
"NextToken": "string",
"StatusMessage": "string",
"VideoMetadata": {
"Codec": "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.
- Celebrities
-
Array of celebrities recognized in the video.
Type: Array of CelebrityRecognition objects
- JobStatus
-
The current status of the celebrity recognition job.
Type: String
Valid Values:
IN_PROGRESS | SUCCEEDED | FAILED
- NextToken
-
If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of celebrities.
Type: String
Length Constraints: Maximum length of 255.
- StatusMessage
-
If the job fails,
StatusMessage
provides a descriptive error message.Type: String
- VideoMetadata
-
Information about a video that Amazon Rekognition Video analyzed.
Videometadata
is returned in every page of paginated responses from a Amazon Rekognition Video operation.Type: VideoMetadata object
Errors
- AccessDeniedException
-
You are not authorized to perform the action.
HTTP Status Code: 400
- InternalServerError
-
Amazon Rekognition experienced a service issue. Try your call again.
HTTP Status Code: 500
- InvalidPaginationTokenException
-
Pagination token in the request is not valid.
HTTP Status Code: 400
- InvalidParameterException
-
Input parameter violated a constraint. Validate your parameter before calling the API operation again.
HTTP Status Code: 400
- ProvisionedThroughputExceededException
-
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.
HTTP Status Code: 400
- ResourceNotFoundException
-
The collection specified in the request cannot be found.
HTTP Status Code: 400
- ThrottlingException
-
Amazon Rekognition is temporarily unable to process the request. Try your call again.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: