Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration

Description

Synopsis

Documentation

data CustomDocumentEnrichmentConfiguration Source #

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.

See: newCustomDocumentEnrichmentConfiguration smart constructor.

Constructors

CustomDocumentEnrichmentConfiguration'

Fields

inlineConfigurations :: Maybe [InlineCustomDocumentEnrichmentConfiguration]
Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.
postExtractionHookConfiguration :: Maybe 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.
preExtractionHookConfiguration :: Maybe 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.
roleArn :: Maybe Text
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.

Instances

Instances details

FromJSON CustomDocumentEnrichmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration Methods parseJSON :: Value -> Parser CustomDocumentEnrichmentConfiguration # parseJSONList :: Value -> Parser [CustomDocumentEnrichmentConfiguration] #
ToJSON CustomDocumentEnrichmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration Methods toJSON :: CustomDocumentEnrichmentConfiguration -> Value # toEncoding :: CustomDocumentEnrichmentConfiguration -> Encoding # toJSONList :: [CustomDocumentEnrichmentConfiguration] -> Value # toEncodingList :: [CustomDocumentEnrichmentConfiguration] -> Encoding #
Generic CustomDocumentEnrichmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration Associated Types type Rep CustomDocumentEnrichmentConfiguration :: Type -> Type # Methods from :: CustomDocumentEnrichmentConfiguration -> Rep CustomDocumentEnrichmentConfiguration x # to :: Rep CustomDocumentEnrichmentConfiguration x -> CustomDocumentEnrichmentConfiguration #
Read CustomDocumentEnrichmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration Methods readsPrec :: Int -> ReadS CustomDocumentEnrichmentConfiguration # readList :: ReadS [CustomDocumentEnrichmentConfiguration] # readPrec :: ReadPrec CustomDocumentEnrichmentConfiguration # readListPrec :: ReadPrec [CustomDocumentEnrichmentConfiguration] #
Show CustomDocumentEnrichmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration Methods showsPrec :: Int -> CustomDocumentEnrichmentConfiguration -> ShowS # show :: CustomDocumentEnrichmentConfiguration -> String # showList :: [CustomDocumentEnrichmentConfiguration] -> ShowS #
NFData CustomDocumentEnrichmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration Methods rnf :: CustomDocumentEnrichmentConfiguration -> () #
Eq CustomDocumentEnrichmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration Methods (==) :: CustomDocumentEnrichmentConfiguration -> CustomDocumentEnrichmentConfiguration -> Bool # (/=) :: CustomDocumentEnrichmentConfiguration -> CustomDocumentEnrichmentConfiguration -> Bool #
Hashable CustomDocumentEnrichmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration Methods hashWithSalt :: Int -> CustomDocumentEnrichmentConfiguration -> Int # hash :: CustomDocumentEnrichmentConfiguration -> Int #
type Rep CustomDocumentEnrichmentConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration type Rep CustomDocumentEnrichmentConfiguration = D1 ('MetaData "CustomDocumentEnrichmentConfiguration" "Amazonka.Kendra.Types.CustomDocumentEnrichmentConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "CustomDocumentEnrichmentConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "inlineConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InlineCustomDocumentEnrichmentConfiguration])) :: S1 ('MetaSel ('Just "postExtractionHookConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HookConfiguration))) :: (S1 ('MetaSel ('Just "preExtractionHookConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HookConfiguration)) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newCustomDocumentEnrichmentConfiguration :: CustomDocumentEnrichmentConfiguration Source #

Create a value of CustomDocumentEnrichmentConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:inlineConfigurations:CustomDocumentEnrichmentConfiguration', customDocumentEnrichmentConfiguration_inlineConfigurations - Configuration information to alter document attributes or metadata fields and content when ingesting documents into Amazon Kendra.

$sel:postExtractionHookConfiguration:CustomDocumentEnrichmentConfiguration', customDocumentEnrichmentConfiguration_postExtractionHookConfiguration - 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.

$sel:preExtractionHookConfiguration:CustomDocumentEnrichmentConfiguration', customDocumentEnrichmentConfiguration_preExtractionHookConfiguration - 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.

$sel:roleArn:CustomDocumentEnrichmentConfiguration', customDocumentEnrichmentConfiguration_roleArn - 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.

customDocumentEnrichmentConfiguration_inlineConfigurations :: Lens' CustomDocumentEnrichmentConfiguration (Maybe [InlineCustomDocumentEnrichmentConfiguration]) Source #

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

customDocumentEnrichmentConfiguration_postExtractionHookConfiguration :: Lens' CustomDocumentEnrichmentConfiguration (Maybe HookConfiguration) Source #

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.

customDocumentEnrichmentConfiguration_preExtractionHookConfiguration :: Lens' CustomDocumentEnrichmentConfiguration (Maybe HookConfiguration) Source #

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.

customDocumentEnrichmentConfiguration_roleArn :: Lens' CustomDocumentEnrichmentConfiguration (Maybe Text) Source #

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.