Skip to content

HookConfiguration

Source code in docs_src/capo_kendra/types/hook_configuration.py 
15
16
17
18
19
20
21
22
23
class HookConfiguration(TypedDict, closed=True):
    invocation_condition: NotRequired[
        "capo_kendra.types.document_attribute_condition.DocumentAttributeCondition"
    ]
    """<p>The condition used for when a Lambda function should be invoked.</p> <p>For example, you can specify a condition that if there are empty date-time values, then Amazon Kendra should invoke a function that inserts the current date-time.</p>"""
    lambda_arn: "capo_kendra.types.lambda_arn.LambdaArn"
    """<p>The Amazon Resource Name (ARN) of an IAM role with permission to run a Lambda function during ingestion. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">an IAM roles for Amazon Kendra</a>.</p>"""
    s3_bucket: "capo_kendra.types.s3_bucket_name.S3BucketName"
    """<p>Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#cde-data-contracts-lambda">Data contracts for Lambda functions</a>.</p>"""

invocation_condition instance-attribute 

invocation_condition: NotRequired[DocumentAttributeCondition]

The condition used for when a Lambda function should be invoked.

For example, you can specify a condition that if there are empty date-time values, then Amazon Kendra should invoke a function that inserts the current date-time.

lambda_arn instance-attribute 

lambda_arn: LambdaArn

The Amazon Resource Name (ARN) of an IAM role with permission to run a Lambda function during ingestion. For more information, see an IAM roles for Amazon Kendra.

s3_bucket instance-attribute 

s3_bucket: S3BucketName

Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.