Package software.amazon.awssdk.services.rekognition.model

Interface StartLabelDetectionRequest.Builder

    • Method Detail

      • video

        StartLabelDetectionRequest.Builder video​(Video video)

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

        Parameters:
        video - The video in which you want to detect labels. The video must be stored in an Amazon S3 bucket.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientRequestToken

        StartLabelDetectionRequest.Builder clientRequestToken​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • minConfidence

        StartLabelDetectionRequest.Builder minConfidence​(Float minConfidence)

        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.

        Parameters:
        minConfidence - 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • notificationChannel

        StartLabelDetectionRequest.Builder notificationChannel​(NotificationChannel 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • jobTag

        StartLabelDetectionRequest.Builder jobTag​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • featuresWithStrings

        StartLabelDetectionRequest.Builder featuresWithStrings​(Collection<String> features)

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

        Parameters:
        features - The features to return after video analysis. You can specify that GENERAL_LABELS are returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • featuresWithStrings

        StartLabelDetectionRequest.Builder featuresWithStrings​(String... features)

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

        Parameters:
        features - The features to return after video analysis. You can specify that GENERAL_LABELS are returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • features

        StartLabelDetectionRequest.Builder features​(Collection<LabelDetectionFeatureName> features)

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

        Parameters:
        features - The features to return after video analysis. You can specify that GENERAL_LABELS are returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • features

        StartLabelDetectionRequest.Builder features​(LabelDetectionFeatureName... features)

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

        Parameters:
        features - The features to return after video analysis. You can specify that GENERAL_LABELS are returned.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • settings

        StartLabelDetectionRequest.Builder settings​(LabelDetectionSettings settings)

        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.

        Parameters:
        settings - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.