Class: Aws::Kendra::Types::BatchGetDocumentStatusRequest

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 BatchGetDocumentStatusRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#document_info_listArray<Types::DocumentInfo>

A list of DocumentInfo objects that identify the documents for which to get the status. You identify the documents by their document ID and optional attributes.

Returns:



697
698
699
700
701
702
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 697

class BatchGetDocumentStatusRequest < Struct.new(
  :index_id,
  :document_info_list)
  SENSITIVE = []
  include Aws::Structure
end

#index_idString

The identifier of the index to add documents to. The index ID is returned by the CreateIndex operation.

Returns:

  • (String)


697
698
699
700
701
702
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 697

class BatchGetDocumentStatusRequest < Struct.new(
  :index_id,
  :document_info_list)
  SENSITIVE = []
  include Aws::Structure
end