Skip to content

StartLabelDetectionRequest

Source code in docs_src/capo_rekognition/types/start_label_detection_request.py
class StartLabelDetectionRequest(TypedDict, closed=True):
    video: "capo_rekognition.types.video.Video"
    """<p>The video in which you want to detect labels. The video must be stored in an Amazon S3 bucket.</p>"""
    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>StartLabelDetection</code> requests, the same <code>JobId</code> is returned. Use <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </p>"""
    min_confidence: NotRequired["capo_rekognition.types.percent.Percent"]
    """<p>Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label. Confidence represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't return any labels with a confidence level lower than this specified value.</p> <p>If you don't specify <code>MinConfidence</code>, the operation returns labels and bounding boxes (if detected) with confidence values greater than or equal to 50 percent.</p>"""
    notification_channel: NotRequired[
        "capo_rekognition.types.notification_channel.NotificationChannel"
    ]
    """<p>The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the label detection operation to. The Amazon SNS topic must have a topic name that begins with <i>AmazonRekognition</i> if you are using the AmazonRekognitionServiceRole permissions policy.</p>"""
    job_tag: NotRequired["capo_rekognition.types.job_tag.JobTag"]
    """<p>An identifier you specify that's returned in the completion notification that's published to 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>"""
    features: NotRequired[
        "capo_rekognition.types.label_detection_feature_list.LabelDetectionFeatureList"
    ]
    """<p>The features to return after video analysis. You can specify that GENERAL_LABELS are returned.</p>"""
    settings: NotRequired[
        "capo_rekognition.types.label_detection_settings.LabelDetectionSettings"
    ]
    """<p>The settings for a StartLabelDetection request.Contains the specified parameters for the label detection request of an asynchronous label analysis operation. Settings can include filters for GENERAL_LABELS.</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 StartLabelDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

features instance-attribute

features: NotRequired[LabelDetectionFeatureList]

The features to return after video analysis. You can specify that GENERAL_LABELS are returned.

job_tag instance-attribute

job_tag: NotRequired[JobTag]

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

min_confidence instance-attribute

min_confidence: NotRequired[Percent]

Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label. Confidence represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't return any labels with a confidence level lower than this specified value.

If you don't specify MinConfidence, the operation returns labels and bounding boxes (if detected) with confidence values greater than or equal to 50 percent.

notification_channel instance-attribute

notification_channel: NotRequired[NotificationChannel]

The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the label detection operation to. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

settings instance-attribute

settings: NotRequired[LabelDetectionSettings]

The settings for a StartLabelDetection request.Contains the specified parameters for the label detection request of an asynchronous label analysis operation. Settings can include filters for GENERAL_LABELS.

video instance-attribute

video: Video

The video in which you want to detect labels. The video must be stored in an Amazon S3 bucket.