Class: Aws::Rekognition::Types::StartTextDetectionRequest

Inherits:

Struct

• Object
• Struct
• Aws::Rekognition::Types::StartTextDetectionRequest

Defined in:

gems/aws-sdk-rekognition/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::StartTextDetectionFilters

  Optional parameters that let you set criteria the text must meet to be included in your response.

• #job_tag ⇒ String

  An identifier returned in the completion status published by your Amazon Simple Notification Service topic.

• #notification_channel ⇒ Types::NotificationChannel

  The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation.

• #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 StartTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentaly started more than once.

Returns:

• (String)

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

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

#filters ⇒ Types::StartTextDetectionFilters

Optional parameters that let you set criteria the text must meet to be included in your response.

Returns:

• (Types::StartTextDetectionFilters)

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

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

#job_tag ⇒ String

An identifier returned in the completion status published by 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 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 7488

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

#notification_channel ⇒ Types::NotificationChannel

The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see Calling Amazon Rekognition Video operations. 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. For more information, see Giving access to multiple Amazon SNS topics.

Returns:

• (Types::NotificationChannel)

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

class StartTextDetectionRequest < Struct.new(
  :video,
  :client_request_token,
  :notification_channel,
  :job_tag,
  :filters)
  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 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 7488

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