Struct GetLabelDetectionOutput

#[non_exhaustive]
pub struct GetLabelDetectionOutput {
    pub job_status: Option<VideoJobStatus>,
    pub status_message: Option<String>,
    pub video_metadata: Option<VideoMetadata>,
    pub next_token: Option<String>,
    pub labels: Option<Vec<LabelDetection>>,
    pub label_model_version: Option<String>,
    pub job_id: Option<String>,
    pub video: Option<Video>,
    pub job_tag: Option<String>,
    pub get_request_metadata: Option<GetLabelDetectionRequestMetadata>,
    /* private fields */
}

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.

job_status: Option<VideoJobStatus>

The current status of the label detection job.

status_message: Option<String>

If the job fails, StatusMessage provides a descriptive error message.

video_metadata: Option<VideoMetadata>

Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.

next_token: Option<String>

If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of labels.

labels: Option<Vec<LabelDetection>>

An array of labels detected in the video. Each element contains the detected label and the time, in milliseconds from the start of the video, that the label was detected.

label_model_version: Option<String>

Version number of the label detection model that was used to detect labels.

job_id: Option<String>

Job identifier for the label detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartLabelDetection.

video: Option<Video>

Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use Video to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.

job_tag: Option<String>

A job identifier specified in the call to StartLabelDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.

get_request_metadata: Option<GetLabelDetectionRequestMetadata>

Information about the paramters used when getting a response. Includes information on aggregation and sorting methods.

Implementations

impl GetLabelDetectionOutput

pub fn job_status(&self) -> Option<&VideoJobStatus>

The current status of the label detection job.

pub fn status_message(&self) -> Option<&str>

If the job fails, StatusMessage provides a descriptive error message.

pub fn video_metadata(&self) -> Option<&VideoMetadata>

Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.

pub fn next_token(&self) -> Option<&str>

If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of labels.

pub fn labels(&self) -> &[LabelDetection]

An array of labels detected in the video. Each element contains the detected label and the time, in milliseconds from the start of the video, that the label was detected.

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

pub fn label_model_version(&self) -> Option<&str>

Version number of the label detection model that was used to detect labels.

pub fn job_id(&self) -> Option<&str>

Job identifier for the label detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartLabelDetection.

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

Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use Video to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.

pub fn job_tag(&self) -> Option<&str>

A job identifier specified in the call to StartLabelDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.

pub fn get_request_metadata(&self) -> Option<&GetLabelDetectionRequestMetadata>

Information about the paramters used when getting a response. Includes information on aggregation and sorting methods.

impl GetLabelDetectionOutput

pub fn builder() -> GetLabelDetectionOutputBuilder

Creates a new builder-style object to manufacture GetLabelDetectionOutput.

Trait Implementations

impl Clone for GetLabelDetectionOutput

fn clone(&self) -> GetLabelDetectionOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetLabelDetectionOutput

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

Formats the value using the given formatter.

impl PartialEq for GetLabelDetectionOutput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl RequestId for GetLabelDetectionOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for GetLabelDetectionOutput