Skip to content

Starts asynchronous detection of text in a stored video

Description

Starts asynchronous detection of text in a stored video.

Amazon Rekognition Video can detect text in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. start_text_detection returns a job identifier (JobId) which you use to get the results of the operation. When text detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. if so, call get_text_detection and pass the job identifier (JobId) from the initial call to start_text_detection.

Usage

rekognition_start_text_detection(Video, ClientRequestToken,
  NotificationChannel, JobTag, Filters)

Arguments

  • Video

    [required] Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as start_label_detection use Video to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.

  • ClientRequestToken

    Idempotent token used to identify the start request. If you use the same token with multiple start_text_detection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentaly started more than once.

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

  • JobTag

    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.

  • Filters

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

Value

A list with the following syntax:

list(
  JobId = "string"
)

Request syntax

svc$start_text_detection(
  Video = list(
    S3Object = list(
      Bucket = "string",
      Name = "string",
      Version = "string"
    )
  ),
  ClientRequestToken = "string",
  NotificationChannel = list(
    SNSTopicArn = "string",
    RoleArn = "string"
  ),
  JobTag = "string",
  Filters = list(
    WordFilter = list(
      MinConfidence = 123.0,
      MinBoundingBoxHeight = 123.0,
      MinBoundingBoxWidth = 123.0
    ),
    RegionsOfInterest = list(
      list(
        BoundingBox = list(
          Width = 123.0,
          Height = 123.0,
          Left = 123.0,
          Top = 123.0
        ),
        Polygon = list(
          list(
            X = 123.0,
            Y = 123.0
          )
        )
      )
    )
  )
)