You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Rekognition::Types::StartSegmentDetectionRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing StartSegmentDetectionRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  video: { # required
    s3_object: {
      bucket: "S3Bucket",
      name: "S3ObjectName",
      version: "S3ObjectVersion",
    },
  },
  client_request_token: "ClientRequestToken",
  notification_channel: {
    sns_topic_arn: "SNSTopicArn", # required
    role_arn: "RoleArn", # required
  },
  job_tag: "JobTag",
  filters: {
    technical_cue_filter: {
      min_segment_confidence: 1.0,
    },
    shot_filter: {
      min_segment_confidence: 1.0,
    },
  },
  segment_types: ["TECHNICAL_CUE"], # required, accepts TECHNICAL_CUE, SHOT
}

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_token ⇒ String

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.

Returns:

  • (String) —

    Idempotent token used to identify the start request.

#filters ⇒ Types::StartSegmentDetectionFilters

Filters for technical cue or shot detection.

Returns:

#job_tag ⇒ String

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.

Returns:

  • (String) —

    An identifier you specify that\'s returned in the completion notification that\'s published to your Amazon Simple Notification Service topic.

#notification_channel ⇒ Types::NotificationChannel

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the segment detection operation.

Returns:

  • (Types::NotificationChannel) —

    The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the segment detection operation.

#segment_types ⇒ Array<String>

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

Returns:

  • (Array<String>) —

    An array of segment types to detect in the video.

#video ⇒ Types::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.

Returns:

  • (Types::Video) —

    Video file stored in an Amazon S3 bucket.