Amazonka.Kendra.Types.DocumentAttributeValue

Documentation

data DocumentAttributeValue

The value of a document attribute. You can only provide one value for a document attribute.

See: newDocumentAttributeValue smart constructor.

Constructors

DocumentAttributeValue'

Fields

• dateValue :: Maybe POSIX

  A date expressed as an ISO 8601 string.

  It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

• longValue :: Maybe Integer

  A long integer value.

• stringListValue :: Maybe [Text]

  A list of strings. The default maximum length or number of strings is 10.

• stringValue :: Maybe Text

  A string, such as "department".

Instances

FromJSON DocumentAttributeValue

Defined in Amazonka.Kendra.Types.DocumentAttributeValue

Methods

parseJSON :: Value -> Parser DocumentAttributeValue

parseJSONList :: Value -> Parser [DocumentAttributeValue]

ToJSON DocumentAttributeValue

Defined in Amazonka.Kendra.Types.DocumentAttributeValue

Methods

toJSON :: DocumentAttributeValue -> Value

toEncoding :: DocumentAttributeValue -> Encoding

toJSONList :: [DocumentAttributeValue] -> Value

toEncodingList :: [DocumentAttributeValue] -> Encoding

Generic DocumentAttributeValue

Defined in Amazonka.Kendra.Types.DocumentAttributeValue

Associated Types

type Rep DocumentAttributeValue :: Type -> Type

Methods

from :: DocumentAttributeValue -> Rep DocumentAttributeValue x

to :: Rep DocumentAttributeValue x -> DocumentAttributeValue

Read DocumentAttributeValue

Defined in Amazonka.Kendra.Types.DocumentAttributeValue

Methods

readsPrec :: Int -> ReadS DocumentAttributeValue

readList :: ReadS [DocumentAttributeValue]

readPrec :: ReadPrec DocumentAttributeValue

readListPrec :: ReadPrec [DocumentAttributeValue]

Show DocumentAttributeValue

Defined in Amazonka.Kendra.Types.DocumentAttributeValue

Methods

showsPrec :: Int -> DocumentAttributeValue -> ShowS

show :: DocumentAttributeValue -> String

showList :: [DocumentAttributeValue] -> ShowS

NFData DocumentAttributeValue

Defined in Amazonka.Kendra.Types.DocumentAttributeValue

Methods

rnf :: DocumentAttributeValue -> ()

Eq DocumentAttributeValue

Defined in Amazonka.Kendra.Types.DocumentAttributeValue

Methods

(==) :: DocumentAttributeValue -> DocumentAttributeValue -> Bool

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

Hashable DocumentAttributeValue

Defined in Amazonka.Kendra.Types.DocumentAttributeValue

Methods

hashWithSalt :: Int -> DocumentAttributeValue -> Int

hash :: DocumentAttributeValue -> Int

type Rep DocumentAttributeValue

Defined in Amazonka.Kendra.Types.DocumentAttributeValue

type Rep DocumentAttributeValue = D1 ('MetaData "DocumentAttributeValue" "Amazonka.Kendra.Types.DocumentAttributeValue" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DocumentAttributeValue'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dateValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "longValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :*: (S1 ('MetaSel ('Just "stringListValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "stringValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDocumentAttributeValue :: DocumentAttributeValue

Create a value of DocumentAttributeValue 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:dateValue:DocumentAttributeValue', documentAttributeValue_dateValue - A date expressed as an ISO 8601 string.

It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

$sel:longValue:DocumentAttributeValue', documentAttributeValue_longValue - A long integer value.

$sel:stringListValue:DocumentAttributeValue', documentAttributeValue_stringListValue - A list of strings. The default maximum length or number of strings is 10.

$sel:stringValue:DocumentAttributeValue', documentAttributeValue_stringValue - A string, such as "department".

documentAttributeValue_dateValue :: Lens' DocumentAttributeValue (Maybe UTCTime)

A date expressed as an ISO 8601 string.

It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.

documentAttributeValue_longValue :: Lens' DocumentAttributeValue (Maybe Integer)

A long integer value.

documentAttributeValue_stringListValue :: Lens' DocumentAttributeValue (Maybe [Text])

A list of strings. The default maximum length or number of strings is 10.

documentAttributeValue_stringValue :: Lens' DocumentAttributeValue (Maybe Text)

A string, such as "department".