StartDocumentAnalysisRequest ¶

class StartDocumentAnalysisRequest(TypedDict, closed=True):
    document_location: "capo_textract.types.document_location.DocumentLocation"
    """<p>The location of the document to be processed.</p>"""
    feature_types: "capo_textract.types.feature_types.FeatureTypes"
    """<p>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 <code>FeatureTypes</code>. All lines and words detected in the document are included in the response (including text that isn't related to the value of <code>FeatureTypes</code>). </p>"""
    client_request_token: NotRequired[
        "capo_textract.types.client_request_token.ClientRequestToken"
    ]
    """<p>The idempotent token that you use to identify the start request. If you use the same token with multiple <code>StartDocumentAnalysis</code> requests, the same <code>JobId</code> is returned. Use <code>ClientRequestToken</code> to prevent the same job from being accidentally started more than once. For more information, see <a href="https://docs.aws.amazon.com/textract/latest/dg/api-async.html">Calling Amazon Textract Asynchronous Operations</a>.</p>"""
    job_tag: NotRequired["capo_textract.types.job_tag.JobTag"]
    """<p>An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use <code>JobTag</code> to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).</p>"""
    notification_channel: NotRequired[
        "capo_textract.types.notification_channel.NotificationChannel"
    ]
    """<p>The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to. </p>"""
    output_config: NotRequired["capo_textract.types.output_config.OutputConfig"]
    """<p>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.</p>"""
    kms_key_id: NotRequired["capo_textract.types.kms_key_id.KMSKeyId"]
    """<p>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.</p>"""
    queries_config: NotRequired["capo_textract.types.queries_config.QueriesConfig"]
    adapters_config: NotRequired["capo_textract.types.adapters_config.AdaptersConfig"]
    """<p>Specifies the adapter to be used when analyzing a document.</p>"""