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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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", # required
  },
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#data_source_sync_job_metric_target ⇒ Types::DataSourceSyncJobMetricTarget

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

Returns:


521
522
523
524
525
526
527
 
# File 'lib/aws-sdk-kendra/types.rb', line 521

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

#document_id_list ⇒ Array<String>

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

Returns:

  • (Array<String>) 

521
522
523
524
525
526
527
 
# File 'lib/aws-sdk-kendra/types.rb', line 521

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

#index_id ⇒ String

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

Returns:

  • (String) 

521
522
523
524
525
526
527
 
# File 'lib/aws-sdk-kendra/types.rb', line 521

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