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

Inherits:

Struct

• Object
• Struct
• Aws::Rekognition::Types::StartSegmentDetectionRequest

Includes:

Structure

Defined in:

lib/aws-sdk-rekognition/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_request_token ⇒ String

  Idempotent token used to identify the start request.

• #filters ⇒ Types::StartSegmentDetectionFilters

  Filters for technical cue or shot detection.

• #job_tag ⇒ 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.

• #segment_types ⇒ Array<String>

  An array of segment types to detect in the video.

• #video ⇒ Types::Video

  Video file stored in an Amazon S3 bucket.

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)

# File 'lib/aws-sdk-rekognition/types.rb', line 7316

class StartSegmentDetectionRequest < Struct.new(
  :video,
  :client_request_token,
  :notification_channel,
  :job_tag,
  :filters,
  :segment_types)
  SENSITIVE = []
  include Aws::Structure
end

#filters ⇒ Types::StartSegmentDetectionFilters

Filters for technical cue or shot detection.

Returns:

• (Types::StartSegmentDetectionFilters)

# File 'lib/aws-sdk-rekognition/types.rb', line 7316

class StartSegmentDetectionRequest < Struct.new(
  :video,
  :client_request_token,
  :notification_channel,
  :job_tag,
  :filters,
  :segment_types)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-rekognition/types.rb', line 7316

class StartSegmentDetectionRequest < Struct.new(
  :video,
  :client_request_token,
  :notification_channel,
  :job_tag,
  :filters,
  :segment_types)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (Types::NotificationChannel)

# File 'lib/aws-sdk-rekognition/types.rb', line 7316

class StartSegmentDetectionRequest < Struct.new(
  :video,
  :client_request_token,
  :notification_channel,
  :job_tag,
  :filters,
  :segment_types)
  SENSITIVE = []
  include Aws::Structure
end

#segment_types ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'lib/aws-sdk-rekognition/types.rb', line 7316

class StartSegmentDetectionRequest < Struct.new(
  :video,
  :client_request_token,
  :notification_channel,
  :job_tag,
  :filters,
  :segment_types)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-rekognition/types.rb', line 7316

class StartSegmentDetectionRequest < Struct.new(
  :video,
  :client_request_token,
  :notification_channel,
  :job_tag,
  :filters,
  :segment_types)
  SENSITIVE = []
  include Aws::Structure
end