You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Rekognition::Types::GetLabelDetectionRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetLabelDetectionRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  job_id: "JobId", # required
  max_results: 1,
  next_token: "PaginationToken",
  sort_by: "NAME", # accepts NAME, TIMESTAMP
}

Instance Attribute Summary collapse

Instance Attribute Details

#job_id ⇒ String

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

Returns:

  • (String) —

    Job identifier for the label detection operation for which you want results returned.

#max_results ⇒ Integer

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.

Returns:

  • (Integer) —

    Maximum number of results to return per paginated call.

#next_token ⇒ String

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.

Returns:

  • (String) —

    If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response.

#sort_by ⇒ String

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.

Possible values:

  • NAME
  • TIMESTAMP

Returns:

  • (String) —

    Sort to use for elements in the Labels array.