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

Description

 
Synopsis

Documentation

data DocumentAttributeValue Source #

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

Instances details
FromJSON DocumentAttributeValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValue

ToJSON DocumentAttributeValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValue

Generic DocumentAttributeValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValue

Associated Types

type Rep DocumentAttributeValue :: Type -> Type #

Read DocumentAttributeValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValue

Show DocumentAttributeValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValue

NFData DocumentAttributeValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValue

Methods

rnf :: DocumentAttributeValue -> () #

Eq DocumentAttributeValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValue

Hashable DocumentAttributeValue Source # 
Instance details

Defined in Amazonka.Kendra.Types.DocumentAttributeValue

type Rep DocumentAttributeValue Source # 
Instance details

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 Source #

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) Source #

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_stringListValue :: Lens' DocumentAttributeValue (Maybe [Text]) Source #

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