Skip to content

GetTextDetectionResponse

Source code in docs_src/capo_rekognition/types/get_text_detection_response.py
class GetTextDetectionResponse(TypedDict, closed=True):
    job_status: NotRequired["capo_rekognition.types.video_job_status.VideoJobStatus"]
    """<p>Current status of the text 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"]
    text_detections: NotRequired[
        "capo_rekognition.types.text_detection_results.TextDetectionResults"
    ]
    """<p>An array of text detected in the video. Each element contains the detected text, the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.</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 text.</p>"""
    text_model_version: NotRequired["capo_rekognition.types.string.String"]
    """<p>Version number of the text detection model that was used to detect text.</p>"""
    job_id: NotRequired["capo_rekognition.types.job_id.JobId"]
    """<p>Job identifier for the text detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartTextDetection.</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 StartTextDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.</p>"""

job_id instance-attribute

job_id: NotRequired[JobId]

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

job_status instance-attribute

job_status: NotRequired[VideoJobStatus]

Current status of the text detection job.

job_tag instance-attribute

job_tag: NotRequired[JobTag]

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

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

status_message instance-attribute

status_message: NotRequired[StatusMessage]

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

text_detections instance-attribute

text_detections: NotRequired[TextDetectionResults]

An array of text detected in the video. Each element contains the detected text, the time in milliseconds from the start of the video that the text was detected, and where it was detected on the screen.

text_model_version instance-attribute

text_model_version: NotRequired[String]

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

video instance-attribute

video: NotRequired[Video]

video_metadata instance-attribute

video_metadata: NotRequired[VideoMetadata]