AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Container for the parameters to the GetCelebrityRecognition operation. 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 in the Amazon Rekognition Developer Guide.
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.
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 in the Amazon Rekognition Developer Guide.
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
.
Namespace: Amazon.Rekognition.Model
Assembly: AWSSDK.Rekognition.dll
Version: 3.x.y.z
public class GetCelebrityRecognitionRequest : AmazonRekognitionRequest IAmazonWebServiceRequest
The GetCelebrityRecognitionRequest type exposes the following members
Name | Description | |
---|---|---|
GetCelebrityRecognitionRequest() |
Name | Type | Description | |
---|---|---|---|
JobId | System.String |
Gets and sets the property JobId.
Job identifier for the required celebrity recognition analysis. You can get the job
identifer from a call to |
|
MaxResults | System.Int32 |
Gets and sets the property 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. |
|
NextToken | System.String |
Gets and sets the property 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. |
|
SortBy | Amazon.Rekognition.CelebrityRecognitionSortBy |
Gets and sets the property SortBy.
Sort to use for celebrities returned in |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5