class Aws::Rekognition::Types::StartTextDetectionRequest
@note When making an API call, you may pass StartTextDetectionRequest
data as a 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: { word_filter: { min_confidence: 1.0, min_bounding_box_height: 1.0, min_bounding_box_width: 1.0, }, regions_of_interest: [ { bounding_box: { width: 1.0, height: 1.0, left: 1.0, top: 1.0, }, }, ], }, }
@!attribute [rw] 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. @return [Types::Video]
@!attribute [rw] client_request_token
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. @return [String]
@!attribute [rw] notification_channel
The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see api-video. 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][1]. [1]: https://docs.aws.amazon.com/rekognition/latest/dg/api-video-roles.html#api-video-roles-all-topics @return [Types::NotificationChannel]
@!attribute [rw] job_tag
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. @return [String]
@!attribute [rw] filters
Optional parameters that let you set criteria the text must meet to be included in your response. @return [Types::StartTextDetectionFilters]
Constants
- SENSITIVE