Skip to content

StartTextDetectionRequest

Source code in docs_src/capo_rekognition/types/start_text_detection_request.py
class StartTextDetectionRequest(TypedDict, closed=True):
    video: "capo_rekognition.types.video.Video"
    client_request_token: NotRequired[
        "capo_rekognition.types.client_request_token.ClientRequestToken"
    ]
    """<p>Idempotent token used to identify the start request. If you use the same token with multiple <code>StartTextDetection</code> requests, the same <code>JobId</code> is returned. Use <code>ClientRequestToken</code> to prevent the same job from being accidentaly started more than once.</p>"""
    notification_channel: NotRequired[
        "capo_rekognition.types.notification_channel.NotificationChannel"
    ]
    job_tag: NotRequired["capo_rekognition.types.job_tag.JobTag"]
    """<p>An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</p>"""
    filters: NotRequired[
        "capo_rekognition.types.start_text_detection_filters.StartTextDetectionFilters"
    ]
    """<p>Optional parameters that let you set criteria the text must meet to be included in your response.</p>"""

client_request_token instance-attribute

client_request_token: NotRequired[ClientRequestToken]

Idempotent token used to identify the start request. If you use the same token with multiple StartTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentaly started more than once.

filters instance-attribute

filters: NotRequired[StartTextDetectionFilters]

Optional parameters that let you set criteria the text must meet to be included in your response.

job_tag instance-attribute

job_tag: NotRequired[JobTag]

An identifier returned in the completion status published by your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

notification_channel instance-attribute

notification_channel: NotRequired[NotificationChannel]

video instance-attribute

video: Video