Struct GetLabelDetectionInput

#[non_exhaustive]
pub struct GetLabelDetectionInput {
    pub job_id: Option<String>,
    pub max_results: Option<i32>,
    pub next_token: Option<String>,
    pub sort_by: Option<LabelDetectionSortBy>,
    pub aggregate_by: Option<LabelDetectionAggregateBy>,
}

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_id: Option<String>

Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to StartlabelDetection.

max_results: Option<i32>

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

next_token: Option<String>

If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of labels.

sort_by: Option<LabelDetectionSortBy>

Sort to use for elements in the Labels array. Use TIMESTAMP to sort array elements by the time labels are detected. Use NAME to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP.

aggregate_by: Option<LabelDetectionAggregateBy>

Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.

Implementations

impl GetLabelDetectionInput

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

Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to StartlabelDetection.

pub fn max_results(&self) -> Option<i32>

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

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

If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of labels.

pub fn sort_by(&self) -> Option<&LabelDetectionSortBy>

Sort to use for elements in the Labels array. Use TIMESTAMP to sort array elements by the time labels are detected. Use NAME to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP.

pub fn aggregate_by(&self) -> Option<&LabelDetectionAggregateBy>

Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.

impl GetLabelDetectionInput

pub fn builder() -> GetLabelDetectionInputBuilder

Creates a new builder-style object to manufacture GetLabelDetectionInput.

Trait Implementations

impl Clone for GetLabelDetectionInput

fn clone(&self) -> GetLabelDetectionInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetLabelDetectionInput

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

Formats the value using the given formatter.

impl PartialEq for GetLabelDetectionInput

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