Class: Aws::Kendra::Types::BatchDeleteDocumentRequest

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

{
  index_id: "IndexId", # required
  document_id_list: ["DocumentId"], # required
  data_source_sync_job_metric_target: {
    data_source_id: "DataSourceId", # required
    data_source_sync_job_id: "DataSourceSyncJobId",
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_source_sync_job_metric_targetTypes::DataSourceSyncJobMetricTarget

Maps a particular data source sync job to a particular data source.



607
608
609
610
611
612
613
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 607

class BatchDeleteDocumentRequest < Struct.new(
  :index_id,
  :document_id_list,
  :data_source_sync_job_metric_target)
  SENSITIVE = []
  include Aws::Structure
end

#document_id_listArray<String>

One or more identifiers for documents to delete from the index.

Returns:

  • (Array<String>)


607
608
609
610
611
612
613
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 607

class BatchDeleteDocumentRequest < Struct.new(
  :index_id,
  :document_id_list,
  :data_source_sync_job_metric_target)
  SENSITIVE = []
  include Aws::Structure
end

#index_idString

The identifier of the index that contains the documents to delete.

Returns:

  • (String)


607
608
609
610
611
612
613
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 607

class BatchDeleteDocumentRequest < Struct.new(
  :index_id,
  :document_id_list,
  :data_source_sync_job_metric_target)
  SENSITIVE = []
  include Aws::Structure
end