Skip to content

GetLabelDetectionRequest

Source code in docs_src/capo_rekognition/types/get_label_detection_request.py
class GetLabelDetectionRequest(TypedDict, closed=True):
    job_id: "capo_rekognition.types.job_id.JobId"
    """<p>Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to <code>StartlabelDetection</code>.</p>"""
    max_results: NotRequired["capo_rekognition.types.max_results.MaxResults"]
    """<p>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.</p>"""
    next_token: NotRequired["capo_rekognition.types.pagination_token.PaginationToken"]
    """<p>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. </p>"""
    sort_by: NotRequired[
        "capo_rekognition.types.label_detection_sort_by.LabelDetectionSortBy"
    ]
    """<p>Sort to use for elements in the <code>Labels</code> array. Use <code>TIMESTAMP</code> to sort array elements by the time labels are detected. Use <code>NAME</code> 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 <code>TIMESTAMP</code>.</p>"""
    aggregate_by: NotRequired[
        "capo_rekognition.types.label_detection_aggregate_by.LabelDetectionAggregateBy"
    ]
    """<p>Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.</p>"""

aggregate_by instance-attribute

aggregate_by: NotRequired[LabelDetectionAggregateBy]

Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.

job_id instance-attribute

job_id: 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.

max_results instance-attribute

max_results: NotRequired[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.

next_token instance-attribute

next_token: NotRequired[PaginationToken]

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.

sort_by instance-attribute

sort_by: NotRequired[LabelDetectionSortBy]

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.