Skip to content

CustomDocumentEnrichmentConfiguration

Used by
Source code in docs_src/capo_kendra/types/custom_document_enrichment_configuration.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
class CustomDocumentEnrichmentConfiguration(TypedDict, closed=True):
    inline_configurations: NotRequired[
        "capo_kendra.types.inline_custom_document_enrichment_configuration_list.InlineCustomDocumentEnrichmentConfigurationList"
    ]
    """<p>Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.</p>"""
    pre_extraction_hook_configuration: NotRequired[
        "capo_kendra.types.hook_configuration.HookConfiguration"
    ]
    """<p>Configuration information for invoking a Lambda function in Lambda on the original or raw documents before extracting their metadata and text. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#advanced-data-manipulation">Advanced data manipulation</a>.</p>"""
    post_extraction_hook_configuration: NotRequired[
        "capo_kendra.types.hook_configuration.HookConfiguration"
    ]
    """<p>Configuration information for invoking a Lambda function in Lambda on the structured documents with their metadata and text extracted. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#advanced-data-manipulation">Advanced data manipulation</a>.</p>"""
    role_arn: NotRequired["capo_kendra.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of an IAM role with permission to run <code>PreExtractionHookConfiguration</code> and <code>PostExtractionHookConfiguration</code> for altering document metadata and content during the document ingestion process. 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>"""

inline_configurations instance-attribute 

inline_configurations: NotRequired[InlineCustomDocumentEnrichmentConfigurationList]

Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.

post_extraction_hook_configuration instance-attribute 

post_extraction_hook_configuration: NotRequired[HookConfiguration]

Configuration information for invoking a Lambda function in Lambda on the structured documents with their metadata and text extracted. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation.

pre_extraction_hook_configuration instance-attribute 

pre_extraction_hook_configuration: NotRequired[HookConfiguration]

Configuration information for invoking a Lambda function in Lambda on the original or raw documents before extracting their metadata and text. You can use a Lambda function to apply advanced logic for creating, modifying, or deleting document metadata and content. For more information, see Advanced data manipulation.

role_arn instance-attribute 

role_arn: NotRequired[RoleArn]

The Amazon Resource Name (ARN) of an IAM role with permission to run PreExtractionHookConfiguration and PostExtractionHookConfiguration for altering document metadata and content during the document ingestion process. For more information, see an IAM roles for Amazon Kendra.