DocumentInfo - Amazon Kendra API Reference

DocumentInfo

Identifies a document for which to retrieve status information

Contents

DocumentId

The identifier of the document.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: Yes

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

Type: Array of DocumentAttribute objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: