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

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

Overview

Note:

When making an API call, you may pass HookConfiguration data as a hash:

{
  invocation_condition: {
    condition_document_attribute_key: "DocumentAttributeKey", # required
    operator: "GreaterThan", # required, accepts GreaterThan, GreaterThanOrEquals, LessThan, LessThanOrEquals, Equals, NotEquals, Contains, NotContains, Exists, NotExists, BeginsWith
    condition_on_value: {
      string_value: "DocumentAttributeStringValue",
      string_list_value: ["String"],
      long_value: 1,
      date_value: Time.now,
    },
  },
  lambda_arn: "LambdaArn", # required
  s3_bucket: "S3BucketName", # required
}

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#invocation_conditionTypes::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.



8052
8053
8054
8055
8056
8057
8058
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8052

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

#lambda_arnString

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.

Returns:

  • (String)


8052
8053
8054
8055
8056
8057
8058
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8052

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

#s3_bucketString

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

Returns:

  • (String)


8052
8053
8054
8055
8056
8057
8058
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8052

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