STARTTEXTDETECTION()`¶

About StartTextDetection¶

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. StartTextDetection 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 GetTextDetection and pass the job identifier (JobId) from the initial call to StartTextDetection.

Method Signature¶

METHODS /AWS1/IF_REK~STARTTEXTDETECTION
  IMPORTING
    !IO_VIDEO TYPE REF TO /AWS1/CL_REKVIDEO OPTIONAL
    !IV_CLIENTREQUESTTOKEN TYPE /AWS1/REKCLIENTREQUESTTOKEN OPTIONAL
    !IO_NOTIFICATIONCHANNEL TYPE REF TO /AWS1/CL_REKNOTIFCHANNEL OPTIONAL
    !IV_JOBTAG TYPE /AWS1/REKJOBTAG OPTIONAL
    !IO_FILTERS TYPE REF TO /AWS1/CL_REKSTRTTXTDETECTFILTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_rekstarttextdetectrsp
  RAISING
    /AWS1/CX_REKACCESSDENIEDEX
    /AWS1/CX_REKIDEMPOTENTPRMMIS00
    /AWS1/CX_REKINTERNALSERVERERR
    /AWS1/CX_REKINVALIDPARAMETEREX
    /AWS1/CX_REKINVALIDS3OBJECTEX
    /AWS1/CX_REKLIMITEXCEEDEDEX
    /AWS1/CX_REKPROVTHRUPUTEXCDEX
    /AWS1/CX_REKTHROTTLINGEX
    /AWS1/CX_REKVIDEOTOOLARGEEX
    /AWS1/CX_REKCLIENTEXC
    /AWS1/CX_REKSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`io_video` `TYPE REF TO /AWS1/CL_REKVIDEO` `/AWS1/CL_REKVIDEO`¶

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.

Optional arguments:¶

`iv_clientrequesttoken` `TYPE /AWS1/REKCLIENTREQUESTTOKEN` `/AWS1/REKCLIENTREQUESTTOKEN`¶

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.

`io_notificationchannel` `TYPE REF TO /AWS1/CL_REKNOTIFCHANNEL` `/AWS1/CL_REKNOTIFCHANNEL`¶

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.

`iv_jobtag` `TYPE /AWS1/REKJOBTAG` `/AWS1/REKJOBTAG`¶

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.

`io_filters` `TYPE REF TO /AWS1/CL_REKSTRTTXTDETECTFILTS` `/AWS1/CL_REKSTRTTXTDETECTFILTS`¶

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

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_rekstarttextdetectrsp` `/AWS1/CL_REKSTARTTEXTDETECTRSP`¶

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->starttextdetection(
  io_filters = new /aws1/cl_rekstrttxtdetectfilts(
    io_wordfilter = new /aws1/cl_rekdetectionfilter(
      iv_minboundingboxheight = '0.1'
      iv_minboundingboxwidth = '0.1'
      iv_minconfidence = '0.1'
    )
    it_regionsofinterest = VALUE /aws1/cl_rekregionofinterest=>tt_regionsofinterest(
      (
        new /aws1/cl_rekregionofinterest(
          io_boundingbox = new /aws1/cl_rekboundingbox(
            iv_height = '0.1'
            iv_left = '0.1'
            iv_top = '0.1'
            iv_width = '0.1'
          )
          it_polygon = VALUE /aws1/cl_rekpoint=>tt_polygon(
            (
              new /aws1/cl_rekpoint(
                iv_x = '0.1'
                iv_y = '0.1'
              )
            )
          )
        )
      )
    )
  )
  io_notificationchannel = new /aws1/cl_reknotifchannel(
    iv_rolearn = |string|
    iv_snstopicarn = |string|
  )
  io_video = new /aws1/cl_rekvideo(
    io_s3object = new /aws1/cl_reks3object(
      iv_bucket = |string|
      iv_name = |string|
      iv_version = |string|
    )
  )
  iv_clientrequesttoken = |string|
  iv_jobtag = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_jobid = lo_result->get_jobid( ).
ENDIF.

/AWS1/IF_REK=>STARTTEXTDETECTION()¶