Amazonka.Kendra.Types.DocumentInfo

Documentation

data DocumentInfo

Identifies a document for which to retrieve status information

See: newDocumentInfo smart constructor.

Constructors

DocumentInfo'

Fields

• attributes :: Maybe [DocumentAttribute]

  Attributes that identify a specific version of a document to check.

  The only valid attributes are:

  • version
  • datasourceId
  • jobExecutionId

  The attributes follow these rules:

  • dataSourceId and jobExecutionId must be used together.
  • version is ignored if dataSourceId and jobExecutionId are not provided.
  • If dataSourceId and jobExecutionId are provided, but version is not, the version defaults to "0".
• documentId :: Text

  The identifier of the document.

Instances

ToJSON DocumentInfo

Defined in Amazonka.Kendra.Types.DocumentInfo

Methods

toJSON :: DocumentInfo -> Value

toEncoding :: DocumentInfo -> Encoding

toJSONList :: [DocumentInfo] -> Value

toEncodingList :: [DocumentInfo] -> Encoding

Generic DocumentInfo

Defined in Amazonka.Kendra.Types.DocumentInfo

Associated Types

type Rep DocumentInfo :: Type -> Type

Methods

from :: DocumentInfo -> Rep DocumentInfo x

to :: Rep DocumentInfo x -> DocumentInfo

Read DocumentInfo

Defined in Amazonka.Kendra.Types.DocumentInfo

Methods

readsPrec :: Int -> ReadS DocumentInfo

readList :: ReadS [DocumentInfo]

readPrec :: ReadPrec DocumentInfo

readListPrec :: ReadPrec [DocumentInfo]

Show DocumentInfo

Defined in Amazonka.Kendra.Types.DocumentInfo

Methods

showsPrec :: Int -> DocumentInfo -> ShowS

show :: DocumentInfo -> String

showList :: [DocumentInfo] -> ShowS

NFData DocumentInfo

Defined in Amazonka.Kendra.Types.DocumentInfo

Methods

rnf :: DocumentInfo -> ()

Eq DocumentInfo

Defined in Amazonka.Kendra.Types.DocumentInfo

Methods

(==) :: DocumentInfo -> DocumentInfo -> Bool

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

Hashable DocumentInfo

Defined in Amazonka.Kendra.Types.DocumentInfo

Methods

hashWithSalt :: Int -> DocumentInfo -> Int

hash :: DocumentInfo -> Int

type Rep DocumentInfo

Defined in Amazonka.Kendra.Types.DocumentInfo

type Rep DocumentInfo = D1 ('MetaData "DocumentInfo" "Amazonka.Kendra.Types.DocumentInfo" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DocumentInfo'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DocumentAttribute])) :*: S1 ('MetaSel ('Just "documentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDocumentInfo

Arguments

:: Text

$sel:documentId:DocumentInfo'

-> DocumentInfo

Create a value of DocumentInfo 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:attributes:DocumentInfo', documentInfo_attributes - Attributes that identify a specific version of a document to check.

The only valid attributes are:

• version
• datasourceId
• jobExecutionId

The attributes follow these rules:

• dataSourceId and jobExecutionId must be used together.
• version is ignored if dataSourceId and jobExecutionId are not provided.
• If dataSourceId and jobExecutionId are provided, but version is not, the version defaults to "0".

$sel:documentId:DocumentInfo', documentInfo_documentId - The identifier of the document.

documentInfo_attributes :: Lens' DocumentInfo (Maybe [DocumentAttribute])

Attributes that identify a specific version of a document to check.

The only valid attributes are:

• version
• datasourceId
• jobExecutionId

The attributes follow these rules:

• dataSourceId and jobExecutionId must be used together.
• version is ignored if dataSourceId and jobExecutionId are not provided.
• If dataSourceId and jobExecutionId are provided, but version is not, the version defaults to "0".

documentInfo_documentId :: Lens' DocumentInfo Text

The identifier of the document.