amazonka-kendra-2.0: Amazon KendraFrontendService SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Kendra.Types.HookConfiguration

Description

 
Synopsis

Documentation

data HookConfiguration Source #

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.

See: newHookConfiguration smart constructor.

Constructors

HookConfiguration' 

Fields

Instances

Instances details
FromJSON HookConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.HookConfiguration

ToJSON HookConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.HookConfiguration

Generic HookConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.HookConfiguration

Associated Types

type Rep HookConfiguration :: Type -> Type #

Read HookConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.HookConfiguration

Show HookConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.HookConfiguration

NFData HookConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.HookConfiguration

Methods

rnf :: HookConfiguration -> () #

Eq HookConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.HookConfiguration

Hashable HookConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.HookConfiguration

type Rep HookConfiguration Source # 
Instance details

Defined in Amazonka.Kendra.Types.HookConfiguration

type Rep HookConfiguration = D1 ('MetaData "HookConfiguration" "Amazonka.Kendra.Types.HookConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "HookConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "invocationCondition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttributeCondition)) :*: (S1 ('MetaSel ('Just "lambdaArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "s3Bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newHookConfiguration Source #

Create a value of HookConfiguration 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:invocationCondition:HookConfiguration', hookConfiguration_invocationCondition - 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.

$sel:lambdaArn:HookConfiguration', hookConfiguration_lambdaArn - 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.

$sel:s3Bucket:HookConfiguration', hookConfiguration_s3Bucket - Stores the original, raw documents or the structured, parsed documents before and after altering them. For more information, see Data contracts for Lambda functions.

hookConfiguration_invocationCondition :: Lens' HookConfiguration (Maybe DocumentAttributeCondition) Source #

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.

hookConfiguration_lambdaArn :: Lens' HookConfiguration Text Source #

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.

hookConfiguration_s3Bucket :: Lens' HookConfiguration Text Source #

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