Package software.amazon.awssdk.services.qbusiness.model

Class HookConfiguration

java.lang.Object

software.amazon.awssdk.services.qbusiness.model.HookConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<HookConfiguration.Builder,HookConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class HookConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<HookConfiguration.Builder,HookConfiguration>

Provides the configuration information for invoking a Lambda function in Lambda to alter document metadata and content when ingesting documents into Amazon Q.

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 Q 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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HookConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static HookConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
DocumentAttributeCondition	invocationCondition()	The condition used for when a Lambda function should be invoked.
String	lambdaArn()	The Amazon Resource Name (ARN) of a role with permission to run a Lambda function during ingestion.
String	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.
String	s3BucketName()	Stores the original, raw documents or the structured, parsed documents before and after altering them.
List<SdkField<?>>	sdkFields()
static Class<? extends HookConfiguration.Builder>	serializableBuilderClass()
HookConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

invocationCondition

public final DocumentAttributeCondition 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 Q should invoke a function that inserts the current date-time.

Returns:

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 should invoke a function that inserts the current date-time.

lambdaArn

public final String 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 Custom Document Enrichment (CDE).

Returns:

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).

roleArn

public final String 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.

Returns:

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.

s3BucketName

public final String s3BucketName()

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:

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

toBuilder

public HookConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<HookConfiguration.Builder,HookConfiguration>

builder

public static HookConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends HookConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo