AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the StartTextDetection operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Rekognition.AmazonRekognitionRequest
      Amazon.Rekognition.Model.StartTextDetectionRequest

Namespace: Amazon.Rekognition.Model
Assembly: AWSSDK.Rekognition.dll
Version: 3.x.y.z

Syntax

C#
public class StartTextDetectionRequest : AmazonRekognitionRequest
         IAmazonWebServiceRequest

The StartTextDetectionRequest type exposes the following members

Constructors

NameDescription
Public Method StartTextDetectionRequest()

Properties

NameTypeDescription
Public Property ClientRequestToken System.String

Gets and sets the property ClientRequestToken.

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.

Public Property Filters Amazon.Rekognition.Model.StartTextDetectionFilters

Gets and sets the property Filters.

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

Public Property JobTag System.String

Gets and sets the property 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.

Public Property NotificationChannel Amazon.Rekognition.Model.NotificationChannel

Gets and sets the property NotificationChannel.

Public Property Video Amazon.Rekognition.Model.Video

Gets and sets the property Video.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5