HookConfiguration¶
Structure Class¶
dataclass
¶
Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q Business.
You can configure your Lambda function using the
PreExtractionHookConfiguration parameter if you want to apply advanced
alterations on the original or raw documents.
If you want to apply advanced alterations on the Amazon Q Business
structured documents, you must configure your Lambda function using
PostExtractionHookConfiguration.
You can only invoke one Lambda function. However, this function can invoke other functions it requires.
For more information, see Custom document enrichment.
Attributes¶
class-attribute
instance-attribute
¶
invocation_condition: DocumentAttributeCondition | None = None
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.
class-attribute
instance-attribute
¶
lambda_arn: str | None = None
The Amazon Resource Name (ARN) of the Lambda function during ingestion. For more information, see Using Lambda functions for Amazon Q Business document enrichment.
class-attribute
instance-attribute
¶
role_arn: str | None = None
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.
class-attribute
instance-attribute
¶
s3_bucket_name: str | None = None
Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.