Class: Aws::Kendra::Types::DocumentInfo

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

Note:

When making an API call, you may pass DocumentInfo data as a hash:

{
  document_id: "DocumentId", # required
  attributes: [
    {
      key: "DocumentAttributeKey", # required
      value: { # required
        string_value: "DocumentAttributeStringValue",
        string_list_value: ["String"],
        long_value: 1,
        date_value: Time.now,
      },
    },
  ],
}

Identifies a document for which to retrieve status information

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attributes ⇒ Array<Types::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".

Returns:



5997
5998
5999
6000
6001
6002
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5997

class DocumentInfo < Struct.new(
  :document_id,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end

#document_id ⇒ String

The unique identifier of the document.

Returns:

  • (String) 


5997
5998
5999
6000
6001
6002
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 5997

class DocumentInfo < Struct.new(
  :document_id,
  :attributes)
  SENSITIVE = []
  include Aws::Structure
end