Class: Aws::QBusiness::Types::HookConfiguration

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-qbusiness/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 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].

[1]: docs.aws.amazon.com/amazonq/latest/business-use-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 Q Business should invoke a function that inserts the current date-time.

Returns:



4570
4571
4572
4573
4574
4575
4576
4577
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 4570

class HookConfiguration < Struct.new(
  :invocation_condition,
  :lambda_arn,
  :s3_bucket_name,
  :role_arn)
  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 Custom Document Enrichment (CDE)].

[1]: docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html#cde-iam-role

Returns:

  • (String) 


4570
4571
4572
4573
4574
4575
4576
4577
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 4570

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

#role_arn ⇒ String

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.

Returns:

  • (String) 


4570
4571
4572
4573
4574
4575
4576
4577
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 4570

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

#s3_bucket_name ⇒ 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/amazonq/latest/business-use-dg/cde-lambda-operations.html#cde-lambda-operations-data-contracts

Returns:

  • (String) 


4570
4571
4572
4573
4574
4575
4576
4577
 
# File 'lib/aws-sdk-qbusiness/types.rb', line 4570

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