You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing BatchDeleteDocumentRequest as input to an Aws::Client method, you can use a vanilla 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:

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:

#document_id_list ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#index_id ⇒ String

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

Returns:

  • (String) —

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