Struct aws_sdk_rekognition::client::fluent_builders::StartSegmentDetection

pub struct StartSegmentDetection { /* private fields */ }

Fluent builder constructing a request to StartSegmentDetection.

Starts asynchronous detection of segment detection in a stored video.

Amazon Rekognition Video can detect segments in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartSegmentDetection returns a job identifier (JobId) which you use to get the results of the operation. When segment detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

You can use the Filters (StartSegmentDetectionFilters) input parameter to specify the minimum detection confidence returned in the response. Within Filters, use ShotFilter (StartShotDetectionFilter) to filter detected shots. Use TechnicalCueFilter (StartTechnicalCueDetectionFilter) to filter technical cues.

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 to StartSegmentDetection.

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

Implementations

impl StartSegmentDetection

pub async fn send(
    self
) -> Result<StartSegmentDetectionOutput, SdkError<StartSegmentDetectionError>>

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 video(self, input: Video) -> Self

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 set_video(self, input: Option<Video>) -> Self

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 client_request_token(self, input: impl Into<String>) -> Self

Idempotent token used to identify the start request. If you use the same token with multiple StartSegmentDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

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

Idempotent token used to identify the start request. If you use the same token with multiple StartSegmentDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

pub fn notification_channel(self, input: NotificationChannel) -> Self

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the segment detection operation. Note that the Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.

pub fn set_notification_channel(
    self,
    input: Option<NotificationChannel>
) -> Self

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the segment detection operation. Note that the Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.

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

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 set_job_tag(self, input: Option<String>) -> Self

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 filters(self, input: StartSegmentDetectionFilters) -> Self

Filters for technical cue or shot detection.

pub fn set_filters(self, input: Option<StartSegmentDetectionFilters>) -> Self

Filters for technical cue or shot detection.

pub fn segment_types(self, input: SegmentType) -> Self

Appends an item to SegmentTypes.

To override the contents of this collection use set_segment_types.

An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

pub fn set_segment_types(self, input: Option<Vec<SegmentType>>) -> Self

An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

Trait Implementations

impl Clone for StartSegmentDetection

fn clone(&self) -> StartSegmentDetection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartSegmentDetection

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

Formats the value using the given formatter.