Struct aws_sdk_rekognition::operation::start_label_detection::StartLabelDetectionInput

#[non_exhaustive]
pub struct StartLabelDetectionInput {
    pub video: Option<Video>,
    pub client_request_token: Option<String>,
    pub min_confidence: Option<f32>,
    pub notification_channel: Option<NotificationChannel>,
    pub job_tag: Option<String>,
    pub features: Option<Vec<LabelDetectionFeatureName>>,
    pub settings: Option<LabelDetectionSettings>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

video: Option<Video>

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

client_request_token: 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.

min_confidence: 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.

notification_channel: 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.

job_tag: 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.

features: Option<Vec<LabelDetectionFeatureName>>

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

settings: 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.

Implementations

impl StartLabelDetectionInput

pub fn 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) -> Option<&str>

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) -> 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) -> 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) -> Option<&str>

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) -> &[LabelDetectionFeatureName]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .features.is_none().

pub fn 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.

impl StartLabelDetectionInput

pub fn builder() -> StartLabelDetectionInputBuilder

Creates a new builder-style object to manufacture StartLabelDetectionInput.

Trait Implementations

impl Clone for StartLabelDetectionInput

fn clone(&self) -> StartLabelDetectionInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartLabelDetectionInput

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

Formats the value using the given formatter.

impl PartialEq for StartLabelDetectionInput

fn eq(&self, other: &StartLabelDetectionInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StartLabelDetectionInput