Amazonka.Kendra.Types.DocumentAttribute

Documentation

data DocumentAttribute

A document attribute or metadata field. To create custom document attributes, see Custom attributes.

See: newDocumentAttribute smart constructor.

Constructors

DocumentAttribute'

Fields

• key :: Text

  The identifier for the attribute.

• value :: DocumentAttributeValue

  The value of the attribute.

Instances

FromJSON DocumentAttribute

Defined in Amazonka.Kendra.Types.DocumentAttribute

Methods

parseJSON :: Value -> Parser DocumentAttribute

parseJSONList :: Value -> Parser [DocumentAttribute]

ToJSON DocumentAttribute

Defined in Amazonka.Kendra.Types.DocumentAttribute

Methods

toJSON :: DocumentAttribute -> Value

toEncoding :: DocumentAttribute -> Encoding

toJSONList :: [DocumentAttribute] -> Value

toEncodingList :: [DocumentAttribute] -> Encoding

Generic DocumentAttribute

Defined in Amazonka.Kendra.Types.DocumentAttribute

Associated Types

type Rep DocumentAttribute :: Type -> Type

Methods

from :: DocumentAttribute -> Rep DocumentAttribute x

to :: Rep DocumentAttribute x -> DocumentAttribute

Read DocumentAttribute

Defined in Amazonka.Kendra.Types.DocumentAttribute

Methods

readsPrec :: Int -> ReadS DocumentAttribute

readList :: ReadS [DocumentAttribute]

readPrec :: ReadPrec DocumentAttribute

readListPrec :: ReadPrec [DocumentAttribute]

Show DocumentAttribute

Defined in Amazonka.Kendra.Types.DocumentAttribute

Methods

showsPrec :: Int -> DocumentAttribute -> ShowS

show :: DocumentAttribute -> String

showList :: [DocumentAttribute] -> ShowS

NFData DocumentAttribute

Defined in Amazonka.Kendra.Types.DocumentAttribute

Methods

rnf :: DocumentAttribute -> ()

Eq DocumentAttribute

Defined in Amazonka.Kendra.Types.DocumentAttribute

Methods

(==) :: DocumentAttribute -> DocumentAttribute -> Bool

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

Hashable DocumentAttribute

Defined in Amazonka.Kendra.Types.DocumentAttribute

Methods

hashWithSalt :: Int -> DocumentAttribute -> Int

hash :: DocumentAttribute -> Int

type Rep DocumentAttribute

Defined in Amazonka.Kendra.Types.DocumentAttribute

type Rep DocumentAttribute = D1 ('MetaData "DocumentAttribute" "Amazonka.Kendra.Types.DocumentAttribute" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DocumentAttribute'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DocumentAttributeValue)))

newDocumentAttribute

Arguments

:: Text

$sel:key:DocumentAttribute'

-> DocumentAttributeValue

$sel:value:DocumentAttribute'

-> DocumentAttribute

Create a value of DocumentAttribute 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:key:DocumentAttribute', documentAttribute_key - The identifier for the attribute.

$sel:value:DocumentAttribute', documentAttribute_value - The value of the attribute.

documentAttribute_key :: Lens' DocumentAttribute Text

The identifier for the attribute.

documentAttribute_value :: Lens' DocumentAttribute DocumentAttributeValue

The value of the attribute.