# GetCelebrityRecognition
Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by [StartCelebrityRecognition](API_StartCelebrityRecognition.md).
Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call to [StartCelebrityRecognition](API_StartCelebrityRecognition.md) 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](https://docs.aws.amazon.com/rekognition/latest/dg/video.html).
`GetCelebrityRecognition` returns detected celebrities and the time(s) they are detected in an array (`Celebrities`) of [CelebrityRecognition](API_CelebrityRecognition.md) objects. Each `CelebrityRecognition` contains information about the celebrity in a [CelebrityDetail](API_CelebrityDetail.md) object and the time, `Timestamp`, the celebrity was detected. This [CelebrityDetail](API_CelebrityDetail.md) object stores information about the detected celebrity's face attributes, a face bounding box, known gender, the celebrity's name, and a confidence estimate.
**Note**
`GetCelebrityRecognition` only returns the default facial attributes (`BoundingBox`, `Confidence`, `Landmarks`, `Pose`, and `Quality`). The `BoundingBox` field only applies to the detected face instance. The other facial attributes listed in the `Face` object of the following response syntax are not returned. For more information, see [FaceDetail](API_FaceDetail.md).
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](API_GetCelebrityInfo.md) 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [JobId](#API_GetCelebrityRecognition_RequestSyntax) **
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](#API_GetCelebrityRecognition_RequestSyntax) **
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](#API_GetCelebrityRecognition_RequestSyntax) **
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](#API_GetCelebrityRecognition_RequestSyntax) **
Sort to use for celebrities returned in `Celebrities` field. Specify `ID` to sort by the celebrity identifier, specify `TIMESTAMP` 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"
}
],
"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.
** [Celebrities](#API_GetCelebrityRecognition_ResponseSyntax) **
Array of celebrities recognized in the video.
Type: Array of [CelebrityRecognition](API_CelebrityRecognition.md) objects
** [JobId](#API_GetCelebrityRecognition_ResponseSyntax) **
Job identifier for the celebrity recognition operation for which you want to obtain results. The job identifer is returned by an initial call to StartCelebrityRecognition.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern: `^[a-zA-Z0-9-_]+$`
** [JobStatus](#API_GetCelebrityRecognition_ResponseSyntax) **
The current status of the celebrity recognition job.
Type: String
Valid Values: `IN_PROGRESS | SUCCEEDED | FAILED`
** [JobTag](#API_GetCelebrityRecognition_ResponseSyntax) **
A job identifier specified in the call to StartCelebrityRecognition and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: `[a-zA-Z0-9_.\-:+=\/]+`
** [NextToken](#API_GetCelebrityRecognition_ResponseSyntax) **
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](#API_GetCelebrityRecognition_ResponseSyntax) **
If the job fails, `StatusMessage` provides a descriptive error message.
Type: String
** [Video](#API_GetCelebrityRecognition_ResponseSyntax) **
Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as [StartLabelDetection](API_StartLabelDetection.md) use `Video` to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.
Type: [Video](API_Video.md) object
** [VideoMetadata](#API_GetCelebrityRecognition_ResponseSyntax) **
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](API_VideoMetadata.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 resource 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:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/rekognition-2016-06-27/GetCelebrityRecognition)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/rekognition-2016-06-27/GetCelebrityRecognition)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/rekognition-2016-06-27/GetCelebrityRecognition)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/rekognition-2016-06-27/GetCelebrityRecognition)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/rekognition-2016-06-27/GetCelebrityRecognition)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/rekognition-2016-06-27/GetCelebrityRecognition)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/rekognition-2016-06-27/GetCelebrityRecognition)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/rekognition-2016-06-27/GetCelebrityRecognition)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/rekognition-2016-06-27/GetCelebrityRecognition)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/rekognition-2016-06-27/GetCelebrityRecognition)