Skip to content

HookConfiguration

Source code in docs_src/capo_qbusiness/types/hook_configuration.py 
14
15
16
17
18
19
20
21
22
23
24
class HookConfiguration(TypedDict, closed=True):
    invocation_condition: NotRequired[
        "capo_qbusiness.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 Q Business should invoke a function that inserts the current date-time.</p>"""
    lambda_arn: NotRequired["capo_qbusiness.types.lambda_arn.LambdaArn"]
    """<p>The Amazon Resource Name (ARN) of the Lambda function during ingestion. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/cde-lambda-operations.html">Using Lambda functions for Amazon Q Business document enrichment</a>.</p>"""
    s3_bucket_name: NotRequired["capo_qbusiness.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/amazonq/latest/business-use-dg/cde-lambda-operations.html#cde-lambda-operations-data-contracts">Data contracts for Lambda functions</a>.</p>"""
    role_arn: NotRequired["capo_qbusiness.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of a role with permission to run <code>PreExtractionHookConfiguration</code> and <code>PostExtractionHookConfiguration</code> for altering document metadata and content during the document ingestion process.</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 Q Business should invoke a function that inserts the current date-time.

lambda_arn instance-attribute 

lambda_arn: NotRequired[LambdaArn]

The Amazon Resource Name (ARN) of the Lambda function during ingestion. For more information, see Using Lambda functions for Amazon Q Business document enrichment.

role_arn instance-attribute 

role_arn: NotRequired[RoleArn]

The Amazon Resource Name (ARN) of a role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process.

s3_bucket_name instance-attribute 

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