Struct aws_sdk_rekognition::operation::start_label_detection::builders::StartLabelDetectionFluentBuilder

pub struct StartLabelDetectionFluentBuilder { /* private fields */ }

Fluent builder constructing a request to StartLabelDetection.

Starts asynchronous detection of labels in a stored video.

Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities like a person getting out of a car or a person skiing.

The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartLabelDetection returns a job identifier (JobId) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier (JobId) from the initial call to StartLabelDetection.

Optional Parameters

StartLabelDetection has the GENERAL_LABELS Feature applied by default. This feature allows you to provide filtering criteria to the Settings parameter. You can filter with sets of individual labels or with label categories. You can specify inclusive filters, exclusive filters, or a combination of inclusive and exclusive filters. For more information on filtering, see Detecting labels in a video.

You can specify MinConfidence to control the confidence threshold for the labels returned. The default is 50.

Implementations

impl StartLabelDetectionFluentBuilder

pub fn as_input(&self) -> &StartLabelDetectionInputBuilder

Access the StartLabelDetection as a reference.

pub async fn send( self ) -> Result<StartLabelDetectionOutput, SdkError<StartLabelDetectionError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<StartLabelDetectionOutput, StartLabelDetectionError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn video(self, input: Video) -> Self

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

pub fn set_video(self, input: Option<Video>) -> Self

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

pub fn get_video(&self) -> &Option<Video>

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

pub fn client_request_token(self, input: impl Into<String>) -> Self

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.

pub fn set_client_request_token(self, input: Option<String>) -> Self

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.

pub fn get_client_request_token(&self) -> &Option<String>

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.

pub fn min_confidence(self, input: f32) -> Self

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.

pub fn set_min_confidence(self, input: Option<f32>) -> Self

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.

pub fn get_min_confidence(&self) -> &Option<f32>

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.

pub fn notification_channel(self, input: NotificationChannel) -> Self

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.

pub fn set_notification_channel( self, input: Option<NotificationChannel> ) -> Self

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.

pub fn get_notification_channel(&self) -> &Option<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.

pub fn job_tag(self, input: impl Into<String>) -> Self

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.

pub fn set_job_tag(self, input: Option<String>) -> Self

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.

pub fn get_job_tag(&self) -> &Option<String>

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.

pub fn features(self, input: LabelDetectionFeatureName) -> Self

Appends an item to Features.

To override the contents of this collection use set_features.

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

pub fn set_features(self, input: Option<Vec<LabelDetectionFeatureName>>) -> Self

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

pub fn get_features(&self) -> &Option<Vec<LabelDetectionFeatureName>>

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

pub fn settings(self, input: LabelDetectionSettings) -> Self

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.

pub fn set_settings(self, input: Option<LabelDetectionSettings>) -> Self

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.

pub fn get_settings(&self) -> &Option<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.

Trait Implementations

impl Clone for StartLabelDetectionFluentBuilder

fn clone(&self) -> StartLabelDetectionFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartLabelDetectionFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.