rekognition_get_label_detection: Gets the label detection results of a Amazon Rekognition...

Description Usage Arguments Value Request syntax

View source: R/rekognition_operations.R

Description

Gets the label detection results of a Amazon Rekognition Video analysis started by start_label_detection.

The label detection operation is started by a call to start_label_detection 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 get_label_detection and pass the job identifier (JobId) from the initial call to start_label_detection.

get_label_detection 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 get_label_detection.

Usage

1
rekognition_get_label_detection(JobId, MaxResults, NextToken, SortBy)

Arguments

JobId

[required] Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to StartlabelDetection.

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

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.

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.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
list(
  JobStatus = "IN_PROGRESS"|"SUCCEEDED"|"FAILED",
  StatusMessage = "string",
  VideoMetadata = list(
    Codec = "string",
    DurationMillis = 123,
    Format = "string",
    FrameRate = 123.0,
    FrameHeight = 123,
    FrameWidth = 123
  ),
  NextToken = "string",
  Labels = list(
    list(
      Timestamp = 123,
      Label = list(
        Name = "string",
        Confidence = 123.0,
        Instances = list(
          list(
            BoundingBox = list(
              Width = 123.0,
              Height = 123.0,
              Left = 123.0,
              Top = 123.0
            ),
            Confidence = 123.0
          )
        ),
        Parents = list(
          list(
            Name = "string"
          )
        )
      )
    )
  ),
  LabelModelVersion = "string"
)

Request syntax

1
2
3
4
5
6
svc$get_label_detection(
  JobId = "string",
  MaxResults = 123,
  NextToken = "string",
  SortBy = "NAME"|"TIMESTAMP"
)

paws.machine.learning documentation built on Aug. 23, 2021, 9:14 a.m.