Amazonka.Kendra.Types.ColumnConfiguration

Documentation

data ColumnConfiguration

Provides information about how Amazon Kendra should use the columns of a database in an index.

See: newColumnConfiguration smart constructor.

Constructors

ColumnConfiguration'

Fields

• documentTitleColumnName :: Maybe Text

  The column that contains the title of the document.

• fieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)

  An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex API.

• documentIdColumnName :: Text

  The column that provides the document's identifier.

• documentDataColumnName :: Text

  The column that contains the contents of the document.

• changeDetectingColumns :: NonEmpty Text

  One to five columns that indicate when a document in the database has changed.

Instances

FromJSON ColumnConfiguration

Defined in Amazonka.Kendra.Types.ColumnConfiguration

Methods

parseJSON :: Value -> Parser ColumnConfiguration

parseJSONList :: Value -> Parser [ColumnConfiguration]

ToJSON ColumnConfiguration

Defined in Amazonka.Kendra.Types.ColumnConfiguration

Methods

toJSON :: ColumnConfiguration -> Value

toEncoding :: ColumnConfiguration -> Encoding

toJSONList :: [ColumnConfiguration] -> Value

toEncodingList :: [ColumnConfiguration] -> Encoding

Generic ColumnConfiguration

Defined in Amazonka.Kendra.Types.ColumnConfiguration

Associated Types

type Rep ColumnConfiguration :: Type -> Type

Methods

from :: ColumnConfiguration -> Rep ColumnConfiguration x

to :: Rep ColumnConfiguration x -> ColumnConfiguration

Read ColumnConfiguration

Defined in Amazonka.Kendra.Types.ColumnConfiguration

Methods

readsPrec :: Int -> ReadS ColumnConfiguration

readList :: ReadS [ColumnConfiguration]

readPrec :: ReadPrec ColumnConfiguration

readListPrec :: ReadPrec [ColumnConfiguration]

Show ColumnConfiguration

Defined in Amazonka.Kendra.Types.ColumnConfiguration

Methods

showsPrec :: Int -> ColumnConfiguration -> ShowS

show :: ColumnConfiguration -> String

showList :: [ColumnConfiguration] -> ShowS

NFData ColumnConfiguration

Defined in Amazonka.Kendra.Types.ColumnConfiguration

Methods

rnf :: ColumnConfiguration -> ()

Eq ColumnConfiguration

Defined in Amazonka.Kendra.Types.ColumnConfiguration

Methods

(==) :: ColumnConfiguration -> ColumnConfiguration -> Bool

(/=) :: ColumnConfiguration -> ColumnConfiguration -> Bool

Hashable ColumnConfiguration

Defined in Amazonka.Kendra.Types.ColumnConfiguration

Methods

hashWithSalt :: Int -> ColumnConfiguration -> Int

hash :: ColumnConfiguration -> Int

type Rep ColumnConfiguration

Defined in Amazonka.Kendra.Types.ColumnConfiguration

type Rep ColumnConfiguration = D1 ('MetaData "ColumnConfiguration" "Amazonka.Kendra.Types.ColumnConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "ColumnConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "documentTitleColumnName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "fieldMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty DataSourceToIndexFieldMapping)))) :*: (S1 ('MetaSel ('Just "documentIdColumnName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "documentDataColumnName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "changeDetectingColumns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))))

newColumnConfiguration

Arguments

:: Text

$sel:documentIdColumnName:ColumnConfiguration'

-> Text

$sel:documentDataColumnName:ColumnConfiguration'

-> NonEmpty Text

$sel:changeDetectingColumns:ColumnConfiguration'

-> ColumnConfiguration

Create a value of ColumnConfiguration 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:documentTitleColumnName:ColumnConfiguration', columnConfiguration_documentTitleColumnName - The column that contains the title of the document.

$sel:fieldMappings:ColumnConfiguration', columnConfiguration_fieldMappings - An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex API.

$sel:documentIdColumnName:ColumnConfiguration', columnConfiguration_documentIdColumnName - The column that provides the document's identifier.

$sel:documentDataColumnName:ColumnConfiguration', columnConfiguration_documentDataColumnName - The column that contains the contents of the document.

$sel:changeDetectingColumns:ColumnConfiguration', columnConfiguration_changeDetectingColumns - One to five columns that indicate when a document in the database has changed.

columnConfiguration_documentTitleColumnName :: Lens' ColumnConfiguration (Maybe Text)

The column that contains the title of the document.

columnConfiguration_fieldMappings :: Lens' ColumnConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))

An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex API.

columnConfiguration_documentIdColumnName :: Lens' ColumnConfiguration Text

The column that provides the document's identifier.

columnConfiguration_documentDataColumnName :: Lens' ColumnConfiguration Text

The column that contains the contents of the document.

columnConfiguration_changeDetectingColumns :: Lens' ColumnConfiguration (NonEmpty Text)

One to five columns that indicate when a document in the database has changed.