Skip to content

StartExpenseAnalysisRequest

Source code in docs_src/capo_textract/types/start_expense_analysis_request.py
class StartExpenseAnalysisRequest(TypedDict, closed=True):
    document_location: "capo_textract.types.document_location.DocumentLocation"
    """<p>The location of the document to be processed.</p>"""
    client_request_token: NotRequired[
        "capo_textract.types.client_request_token.ClientRequestToken"
    ]
    """<p>The idempotent token that's used to identify the start request. If you use the same token with multiple <code>StartDocumentTextDetection</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 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 <code>GetExpenseAnalysis</code> 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>"""

client_request_token instance-attribute

client_request_token: NotRequired[ClientRequestToken]

The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations

document_location instance-attribute

document_location: DocumentLocation

The location of the document to be processed.

job_tag instance-attribute

job_tag: NotRequired[JobTag]

An identifier you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).

kms_key_id instance-attribute

kms_key_id: NotRequired[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.

notification_channel instance-attribute

notification_channel: NotRequired[NotificationChannel]

The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

output_config instance-attribute

output_config: NotRequired[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 GetExpenseAnalysis operation.