Struct GetFaceDetectionOutput

#[non_exhaustive]
pub struct GetFaceDetectionOutput {
    pub job_status: Option<VideoJobStatus>,
    pub status_message: Option<String>,
    pub video_metadata: Option<VideoMetadata>,
    pub next_token: Option<String>,
    pub faces: Option<Vec<FaceDetection>>,
    pub job_id: Option<String>,
    pub video: Option<Video>,
    pub job_tag: Option<String>,
    /* 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 face 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 returns this token that you can use in the subsequent request to retrieve the next set of faces.

faces: Option<Vec<FaceDetection>>

An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected.

job_id: Option<String>

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

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 StartFaceDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.

Implementations

impl GetFaceDetectionOutput

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

The current status of the face 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 returns this token that you can use in the subsequent request to retrieve the next set of faces.

pub fn faces(&self) -> &[FaceDetection]

An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face 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 .faces.is_none().

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

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

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 StartFaceDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.

impl GetFaceDetectionOutput

pub fn builder() -> GetFaceDetectionOutputBuilder

Creates a new builder-style object to manufacture GetFaceDetectionOutput.

Trait Implementations

impl Clone for GetFaceDetectionOutput

fn clone(&self) -> GetFaceDetectionOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetFaceDetectionOutput

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

Formats the value using the given formatter.

impl PartialEq for GetFaceDetectionOutput

fn eq(&self, other: &GetFaceDetectionOutput) -> 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 GetFaceDetectionOutput

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

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

impl StructuralPartialEq for GetFaceDetectionOutput