Struct aws_sdk_rekognition::client::fluent_builders::GetSegmentDetection

pub struct GetSegmentDetection { /* private fields */ }

Fluent builder constructing a request to GetSegmentDetection.

Gets the segment detection results of a Amazon Rekognition Video analysis started by StartSegmentDetection.

Segment detection with Amazon Rekognition Video is an asynchronous operation. You start segment detection by calling StartSegmentDetection which returns a job identifier (JobId). When the segment detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartSegmentDetection. To get the results of the segment detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call GetSegmentDetection and pass the job identifier (JobId) from the initial call of StartSegmentDetection.

GetSegmentDetection returns detected segments in an array (Segments) of SegmentDetection objects. Segments is sorted by the segment types specified in the SegmentTypes input parameter of StartSegmentDetection. Each element of the array includes the detected segment, the precentage confidence in the acuracy of the detected segment, the type of the segment, and the frame in which the segment was detected.

Use SelectedSegmentTypes to find out the type of segment detection requested in the call to StartSegmentDetection.

Use the MaxResults parameter to limit the number of segment detections returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetSegmentDetection and populate the NextToken request parameter with the token value returned from the previous call to GetSegmentDetection.

For more information, see Detecting Video Segments in Stored Video in the Amazon Rekognition Developer Guide.

Implementations

impl GetSegmentDetection

pub async fn send(
    self
) -> Result<GetSegmentDetectionOutput, SdkError<GetSegmentDetectionError>>

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 into_paginator(self) -> GetSegmentDetectionPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

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

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

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

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

pub fn max_results(self, input: i32) -> Self

Maximum number of results to return per paginated call. The largest value you can specify is 1000.

pub fn set_max_results(self, input: Option<i32>) -> Self

Maximum number of results to return per paginated call. The largest value you can specify is 1000.

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

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 text.

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

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 text.

Trait Implementations

impl Clone for GetSegmentDetection

fn clone(&self) -> GetSegmentDetection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetSegmentDetection

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

Formats the value using the given formatter.