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

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

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

Overview

Note:

When passing StartTextDetectionRequest 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: {
    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,
        },
      },
    ],
  },
}

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

Returns:

  • (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.

Returns:

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

    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. For more information, see api-video.

Returns:

  • (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. 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.