Class: Aws::Kendra::Types::HookConfiguration

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kendra/types.rb

Overview

Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Kendra. You can configure your Lambda function using [PreExtractionHookConfiguration] if you want to apply advanced alterations on the original or raw documents. If you want to apply advanced alterations on the Amazon Kendra 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 [Customizing document metadata during the ingestion process].

[1]: docs.aws.amazon.com/kendra/latest/dg/API_CustomDocumentEnrichmentConfiguration.html [2]: docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#invocation_condition ⇒ Types::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.

Returns:



6476
6477
6478
6479
6480
6481
6482
 
# File 'lib/aws-sdk-kendra/types.rb', line 6476

class HookConfiguration < Struct.new(
  :invocation_condition,
  :lambda_arn,
  :s3_bucket)
  SENSITIVE = []
  include Aws::Structure
end

#lambda_arn ⇒ String

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

[1]: docs.aws.amazon.com/kendra/latest/dg/iam-roles.html

Returns:

  • (String) 


6476
6477
6478
6479
6480
6481
6482
 
# File 'lib/aws-sdk-kendra/types.rb', line 6476

class HookConfiguration < Struct.new(
  :invocation_condition,
  :lambda_arn,
  :s3_bucket)
  SENSITIVE = []
  include Aws::Structure
end

#s3_bucket ⇒ String

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

[1]: docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html#cde-data-contracts-lambda

Returns:

  • (String) 


6476
6477
6478
6479
6480
6481
6482
 
# File 'lib/aws-sdk-kendra/types.rb', line 6476

class HookConfiguration < Struct.new(
  :invocation_condition,
  :lambda_arn,
  :s3_bucket)
  SENSITIVE = []
  include Aws::Structure
end