| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Rekognition.GetLabelDetection
Description
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. If
there is no NAME specified, the default sort is by timestamp.
You can select how results are aggregated by using the AggregateBy
input parameter. The default aggregation method is TIMESTAMPS. You can
also aggregate by SEGMENTS, which aggregates all instances of labels
detected in a given segment.
The returned Labels array may include the following attributes:
- Name - The name of the detected label.
- Confidence - The level of confidence in the label assigned to a detected object.
- Parents - The ancestor labels for a detected label. GetLabelDetection returns a hierarchical taxonomy of detected labels. For example, a detected car might be assigned the label car. The label car has two parent labels: Vehicle (its parent) and Transportation (its grandparent). The response includes the all ancestors for a label, where every ancestor is a unique label. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response.
- Aliases - Possible Aliases for the label.
- Categories - The label categories that the detected label belongs to.
- BoundingBox — Bounding boxes are described for all instances of detected common object labels, returned in an array of Instance objects. An Instance object contains a BoundingBox object, describing the location of the label on the input image. It also includes the confidence for the accuracy of the detected bounding box.
- Timestamp - Time, in milliseconds from the start of the video, that
the label was detected. For aggregation by
SEGMENTS, theStartTimestampMillis,EndTimestampMillis, andDurationMillisstructures are what define a segment. Although the “Timestamp” structure is still returned with each label, its value is set to be the same asStartTimestampMillis.
Timestamp and Bounding box information are returned for detected
Instances, only if aggregation is done by TIMESTAMPS. If aggregating
by SEGMENTS, information about detected instances isn’t returned.
The version of the label model used for the detection is also returned.
__Note DominantColors isn't returned for Instances, although it is
shown as part of the response in the sample seen below.__
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.
Synopsis
- data GetLabelDetection = GetLabelDetection' {}
- newGetLabelDetection :: Text -> GetLabelDetection
- getLabelDetection_aggregateBy :: Lens' GetLabelDetection (Maybe LabelDetectionAggregateBy)
- getLabelDetection_maxResults :: Lens' GetLabelDetection (Maybe Natural)
- getLabelDetection_nextToken :: Lens' GetLabelDetection (Maybe Text)
- getLabelDetection_sortBy :: Lens' GetLabelDetection (Maybe LabelDetectionSortBy)
- getLabelDetection_jobId :: Lens' GetLabelDetection Text
- data GetLabelDetectionResponse = GetLabelDetectionResponse' {}
- newGetLabelDetectionResponse :: Int -> GetLabelDetectionResponse
- getLabelDetectionResponse_jobStatus :: Lens' GetLabelDetectionResponse (Maybe VideoJobStatus)
- getLabelDetectionResponse_labelModelVersion :: Lens' GetLabelDetectionResponse (Maybe Text)
- getLabelDetectionResponse_labels :: Lens' GetLabelDetectionResponse (Maybe [LabelDetection])
- getLabelDetectionResponse_nextToken :: Lens' GetLabelDetectionResponse (Maybe Text)
- getLabelDetectionResponse_statusMessage :: Lens' GetLabelDetectionResponse (Maybe Text)
- getLabelDetectionResponse_videoMetadata :: Lens' GetLabelDetectionResponse (Maybe VideoMetadata)
- getLabelDetectionResponse_httpStatus :: Lens' GetLabelDetectionResponse Int
Creating a Request
data GetLabelDetection Source #
See: newGetLabelDetection smart constructor.
Constructors
| GetLabelDetection' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> GetLabelDetection |
Create a value of GetLabelDetection with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:aggregateBy:GetLabelDetection', getLabelDetection_aggregateBy - Defines how to aggregate the returned results. Results can be aggregated
by timestamps or segments.
$sel:maxResults:GetLabelDetection', getLabelDetection_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.
GetLabelDetection, getLabelDetection_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.
$sel:sortBy:GetLabelDetection', getLabelDetection_sortBy - Sort to use for elements in the Labels array. Use TIMESTAMP to sort
array elements by the time labels are detected. Use NAME to
alphabetically group elements for a label together. Within each label
group, the array element are sorted by detection confidence. The default
sort is by TIMESTAMP.
$sel:jobId:GetLabelDetection', getLabelDetection_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.
Request Lenses
getLabelDetection_aggregateBy :: Lens' GetLabelDetection (Maybe LabelDetectionAggregateBy) Source #
Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.
getLabelDetection_maxResults :: Lens' GetLabelDetection (Maybe Natural) Source #
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.
getLabelDetection_nextToken :: Lens' GetLabelDetection (Maybe Text) Source #
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.
getLabelDetection_sortBy :: Lens' GetLabelDetection (Maybe LabelDetectionSortBy) Source #
Sort to use for elements in the Labels array. Use TIMESTAMP to sort
array elements by the time labels are detected. Use NAME to
alphabetically group elements for a label together. Within each label
group, the array element are sorted by detection confidence. The default
sort is by TIMESTAMP.
getLabelDetection_jobId :: Lens' GetLabelDetection Text Source #
Job identifier for the label detection operation for which you want
results returned. You get the job identifer from an initial call to
StartlabelDetection.
Destructuring the Response
data GetLabelDetectionResponse Source #
See: newGetLabelDetectionResponse smart constructor.
Constructors
| GetLabelDetectionResponse' | |
Fields
| |
Instances
newGetLabelDetectionResponse Source #
Create a value of GetLabelDetectionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:jobStatus:GetLabelDetectionResponse', getLabelDetectionResponse_jobStatus - The current status of the label detection job.
$sel:labelModelVersion:GetLabelDetectionResponse', getLabelDetectionResponse_labelModelVersion - Version number of the label detection model that was used to detect
labels.
GetLabelDetectionResponse, getLabelDetectionResponse_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.
GetLabelDetection, getLabelDetectionResponse_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.
GetLabelDetectionResponse, getLabelDetectionResponse_statusMessage - If the job fails, StatusMessage provides a descriptive error message.
$sel:videoMetadata:GetLabelDetectionResponse', getLabelDetectionResponse_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.
$sel:httpStatus:GetLabelDetectionResponse', getLabelDetectionResponse_httpStatus - The response's http status code.
Response Lenses
getLabelDetectionResponse_jobStatus :: Lens' GetLabelDetectionResponse (Maybe VideoJobStatus) Source #
The current status of the label detection job.
getLabelDetectionResponse_labelModelVersion :: Lens' GetLabelDetectionResponse (Maybe Text) Source #
Version number of the label detection model that was used to detect labels.
getLabelDetectionResponse_labels :: Lens' GetLabelDetectionResponse (Maybe [LabelDetection]) Source #
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.
getLabelDetectionResponse_nextToken :: Lens' GetLabelDetectionResponse (Maybe Text) Source #
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.
getLabelDetectionResponse_statusMessage :: Lens' GetLabelDetectionResponse (Maybe Text) Source #
If the job fails, StatusMessage provides a descriptive error message.
getLabelDetectionResponse_videoMetadata :: Lens' GetLabelDetectionResponse (Maybe VideoMetadata) Source #
Information about a video that Amazon Rekognition Video analyzed.
Videometadata is returned in every page of paginated responses from a
Amazon Rekognition video operation.
getLabelDetectionResponse_httpStatus :: Lens' GetLabelDetectionResponse Int Source #
The response's http status code.