Skip to content

GetLabelDetectionResponse

Source code in docs_src/capo_rekognition/types/get_label_detection_response.py
class GetLabelDetectionResponse(TypedDict, closed=True):
    job_status: NotRequired["capo_rekognition.types.video_job_status.VideoJobStatus"]
    """<p>The current status of the label detection job.</p>"""
    status_message: NotRequired["capo_rekognition.types.status_message.StatusMessage"]
    """<p>If the job fails, <code>StatusMessage</code> provides a descriptive error message.</p>"""
    video_metadata: NotRequired["capo_rekognition.types.video_metadata.VideoMetadata"]
    """<p>Information about a video that Amazon Rekognition Video analyzed. <code>Videometadata</code> is returned in every page of paginated responses from a Amazon Rekognition video operation.</p>"""
    next_token: NotRequired["capo_rekognition.types.pagination_token.PaginationToken"]
    """<p>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.</p>"""
    labels: NotRequired["capo_rekognition.types.label_detections.LabelDetections"]
    """<p>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. </p>"""
    label_model_version: NotRequired["capo_rekognition.types.string.String"]
    """<p>Version number of the label detection model that was used to detect labels.</p>"""
    job_id: NotRequired["capo_rekognition.types.job_id.JobId"]
    """<p>Job identifier for the label detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartLabelDetection.</p>"""
    video: NotRequired["capo_rekognition.types.video.Video"]
    job_tag: NotRequired["capo_rekognition.types.job_tag.JobTag"]
    """<p>A job identifier specified in the call to StartLabelDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.</p>"""
    get_request_metadata: NotRequired[
        "capo_rekognition.types.get_label_detection_request_metadata.GetLabelDetectionRequestMetadata"
    ]
    """<p>Information about the paramters used when getting a response. Includes information on aggregation and sorting methods.</p>"""

get_request_metadata instance-attribute

get_request_metadata: NotRequired[GetLabelDetectionRequestMetadata]

Information about the paramters used when getting a response. Includes information on aggregation and sorting methods.

job_id instance-attribute

job_id: NotRequired[JobId]

Job identifier for the label detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartLabelDetection.

job_status instance-attribute

job_status: NotRequired[VideoJobStatus]

The current status of the label detection job.

job_tag instance-attribute

job_tag: NotRequired[JobTag]

A job identifier specified in the call to StartLabelDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.

label_model_version instance-attribute

label_model_version: NotRequired[String]

Version number of the label detection model that was used to detect labels.

labels instance-attribute

labels: NotRequired[LabelDetections]

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.

next_token instance-attribute

next_token: NotRequired[PaginationToken]

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.

status_message instance-attribute

status_message: NotRequired[StatusMessage]

If the job fails, StatusMessage provides a descriptive error message.

video instance-attribute

video: NotRequired[Video]

video_metadata instance-attribute

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