Container for the parameters to the StartDocumentTextDetection operation. Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.
StartDocumentTextDetection can analyze text in documents that are in JPEG,
PNG, TIFF, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation
to specify the bucket name and file name of the document.
StartTextDetection returns a job identifier (JobId) that you use to
get the results of the operation. When text detection is finished, Amazon Textract
publishes a completion status to the Amazon Simple Notification Service (Amazon SNS)
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 GetDocumentTextDetection, and pass the
job identifier (JobId) from the initial call to StartDocumentTextDetection.
For more information, see Document Text Detection.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.Textract.AmazonTextractRequest
Amazon.Textract.Model.StartDocumentTextDetectionRequest
Namespace: Amazon.Textract.Model
Assembly: AWSSDK.Textract.dll
Version: 3.x.y.z
Syntax
public class StartDocumentTextDetectionRequest : AmazonTextractRequest IAmazonWebServiceRequest
The StartDocumentTextDetectionRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
StartDocumentTextDetectionRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
ClientRequestToken | System.String |
Gets and sets the property ClientRequestToken.
The idempotent token that's used to identify the start request. If you use the same
token with multiple |
|
|
DocumentLocation | Amazon.Textract.Model.DocumentLocation |
Gets and sets the property DocumentLocation. The location of the document to be processed. |
|
|
JobTag | System.String |
Gets and sets the property JobTag.
An identifier that you specify that's included in the completion notification published
to the Amazon SNS topic. For example, you can use |
|
|
KMSKeyId | System.String |
Gets and sets the property KMSKeyId. The KMS key used to encrypt the inference results. This can be in either Key ID or Key Alias format. When a KMS key is provided, the KMS key will be used for server-side encryption of the objects in the customer bucket. When this parameter is not enabled, the result will be encrypted server side,using SSE-S3. |
|
|
NotificationChannel | Amazon.Textract.Model.NotificationChannel |
Gets and sets the property NotificationChannel. The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to. |
|
|
OutputConfig | Amazon.Textract.Model.OutputConfig |
Gets and sets the property OutputConfig. Sets if the output will go to a customer defined bucket. By default Amazon Textract will save the results internally to be accessed with the GetDocumentTextDetection operation. |
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