Class: Aws::Kendra::Types::CustomDocumentEnrichmentConfiguration

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 CustomDocumentEnrichmentConfiguration data as a hash:

{
  inline_configurations: [
    {
      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,
        },
      },
      target: {
        target_document_attribute_key: "DocumentAttributeKey",
        target_document_attribute_value_deletion: false,
        target_document_attribute_value: {
          string_value: "DocumentAttributeStringValue",
          string_list_value: ["String"],
          long_value: 1,
          date_value: Time.now,
        },
      },
      document_content_deletion: false,
    },
  ],
  pre_extraction_hook_configuration: {
    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
  },
  post_extraction_hook_configuration: {
    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
  },
  role_arn: "RoleArn",
}

Provides the configuration information for altering document metadata and content during the document ingestion process.

For more information, see Customizing document metadata during the ingestion process.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#inline_configurationsArray<Types::InlineCustomDocumentEnrichmentConfiguration>

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



3457
3458
3459
3460
3461
3462
3463
3464
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3457

class CustomDocumentEnrichmentConfiguration < Struct.new(
  :inline_configurations,
  :pre_extraction_hook_configuration,
  :post_extraction_hook_configuration,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

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



3457
3458
3459
3460
3461
3462
3463
3464
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3457

class CustomDocumentEnrichmentConfiguration < Struct.new(
  :inline_configurations,
  :pre_extraction_hook_configuration,
  :post_extraction_hook_configuration,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

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



3457
3458
3459
3460
3461
3462
3463
3464
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3457

class CustomDocumentEnrichmentConfiguration < Struct.new(
  :inline_configurations,
  :pre_extraction_hook_configuration,
  :post_extraction_hook_configuration,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

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. For more information, see IAM roles for Amazon Kendra.

Returns:

  • (String)


3457
3458
3459
3460
3461
3462
3463
3464
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3457

class CustomDocumentEnrichmentConfiguration < Struct.new(
  :inline_configurations,
  :pre_extraction_hook_configuration,
  :post_extraction_hook_configuration,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end