Skip to content

HookConfigurationDict

Dictionary Type

HookConfigurationDict

Bases: TypedDict

Dictionary form of HookConfiguration.

Attributes

invocation_condition instance-attribute

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: str | 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.

role_arn instance-attribute
role_arn: str | 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.

s3_bucket_name instance-attribute
s3_bucket_name: str | 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.