Container for the parameters to the StartDocumentAnalysis operation. Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.
StartDocumentAnalysis 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.
StartDocumentAnalysis returns a job identifier (JobId) that you use
to get the results of the operation. When text analysis 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
analysis operation, first check that the status value published to the Amazon SNS
topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job
identifier (JobId) from the initial call to StartDocumentAnalysis.
For more information, see Document Text Analysis.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.Textract.AmazonTextractRequest
Amazon.Textract.Model.StartDocumentAnalysisRequest
Namespace: Amazon.Textract.Model
Assembly: AWSSDK.Textract.dll
Version: 3.x.y.z
Syntax
public class StartDocumentAnalysisRequest : AmazonTextractRequest IAmazonWebServiceRequest
The StartDocumentAnalysisRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
StartDocumentAnalysisRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
AdaptersConfig | Amazon.Textract.Model.AdaptersConfig |
Gets and sets the property AdaptersConfig. Specifies the adapter to be used when analyzing a document. |
|
|
ClientRequestToken | System.String |
Gets and sets the property ClientRequestToken.
The idempotent token that you use 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. |
|
|
FeatureTypes | System.Collections.Generic.List<System.String> |
Gets and sets the property FeatureTypes.
A list of the types of analysis to perform. Add TABLES to the list to return information
about the tables that are detected in the input document. Add FORMS to return detected
form data. To perform both types of analysis, add TABLES and FORMS to |
|
|
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 by the GetDocumentAnalysis operation. |
|
|
QueriesConfig | Amazon.Textract.Model.QueriesConfig |
Gets and sets the property QueriesConfig. |
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