GetLabelDetection
Gets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection.
The label detection operation is started by a call to StartLabelDetection
which returns a job identifier (JobId
). When the label detection operation finishes, Amazon Rekognition publishes a completion
status to
the Amazon Simple Notification Service topic registered in the initial call to StartlabelDetection
. To get the results
of the label detection operation, first check that the status value published to the
Amazon SNS topic is SUCCEEDED
.
If so, call GetLabelDetection and pass the job identifier
(JobId
) from the initial call to StartLabelDetection
.
GetLabelDetection
returns an array of detected labels (Labels
) sorted by the time
the labels were detected. You can also sort by the label name by specifying NAME
for the
SortBy
input parameter.
The labels returned include the label name, the percentage confidence in the accuracy of the detected label, and the time the label was detected in the video.
The returned labels also include bounding box information for common objects, a hierarchical taxonomy of detected labels, and the version of the label model used for detection.
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 GetlabelDetection
and populate the NextToken
request parameter with the token
value returned from the previous call to GetLabelDetection
.
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 label detection operation for which you want results returned. You get the job identifer from an initial call to
StartlabelDetection
.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 are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of labels.
Type: String
Length Constraints: Maximum length of 255.
Required: No
- SortBy
-
Sort to use for elements in the
Labels
array. UseTIMESTAMP
to sort array elements by the time labels are detected. UseNAME
to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is byTIMESTAMP
.Type: String
Valid Values:
NAME | TIMESTAMP
Required: No
Response Syntax
{
"JobStatus": "string",
"LabelModelVersion": "string",
"Labels": [
{
"Label": {
"Confidence": number,
"Instances": [
{
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Confidence": number
}
],
"Name": "string",
"Parents": [
{
"Name": "string"
}
]
},
"Timestamp": number
}
],
"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.
- JobStatus
-
The current status of the label detection job.
Type: String
Valid Values:
IN_PROGRESS | SUCCEEDED | FAILED
- LabelModelVersion
-
Version number of the label detection model that was used to detect labels.
Type: String
- Labels
-
An array of labels detected in the video. Each element contains the detected label and the time, in milliseconds from the start of the video, that the label was detected.
Type: Array of LabelDetection objects
- 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 labels.
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: