удаление-документов-пакетно
Описание
Удаляет один или несколько документов из индекса. Документы должны быть добавлены с помощью API BatchPutDocument.
Документы удаляются асинхронно. Вы можете отслеживать процесс удаления, используя Amazon Web Services CloudWatch. Любые сообщения об ошибках, связанные с обработкой пакета, отправляются в ваш журнал Amazon Web Services CloudWatch. Также вы можете использовать API BatchGetDocumentStatus для отслеживания прогресса удаления документов.
Удаление документов из индекса с помощью BatchDeleteDocument может занять до часа или более, в зависимости от количества документов, которые нужно удалить.
См. также: Документация API AWS
Синтаксис
batch-delete-document
--index-id <value>
--document-id-list <value>
[--data-source-sync-job-metric-target <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Параметры
--index-id (строка)
--document-id-list (список)
Один или несколько идентификаторов документов для удаления из индекса.
(строка)
Синтаксис:
"string" "string" ...
--data-source-sync-job-metric-target (структура)
Сопоставляет определённую задачу синхронизации источника данных с определённым источником данных.
DataSourceId -> (строка)
DataSourceSyncJobId -> (строка)
Идентификатор задачи синхронизации, выполняющейся на источнике данных.
Если идентификатор задачи синхронизации не указан и задача синхронизации выполняется, используется идентификатор этой задачи, и метрики генерируются для этой задачи синхронизации.
Если идентификатор задачи синхронизации не указан и задача синхронизации не выполняется, метрики не генерируются, и документы индексируются/удаляются на уровне индекса без метрик задачи синхронизации.
Сокращенный синтаксис:
DataSourceId=string,DataSourceSyncJobId=string
Синтаксис JSON:
{
"DataSourceId": "string",
"DataSourceSyncJobId": "string"
}
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные данные с помощью значения, предоставленного в JSON, так как строка будет воспринята буквально. Это может не быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если указано без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если указано значение output, он валидирует входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.
Глобальные параметры
--debug (логическое значение)
Включить отладку логов.
--endpoint-url (строка)
Переопределить URL по умолчанию команды заданным URL.
--no-verify-ssl (логическое значение)
По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.
--no-paginate (логическое значение)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования вывода команды.
- json
- текст
- таблица
- yaml
- yaml-поток
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определённый профиль из вашего файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (строка)
Показать версию этого инструмента.
--color (строка)
Включить/выключить цветной вывод.
- включить
- выключить
- автоматически
--no-sign-request (логическое значение)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл с сертификатом CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (целое число)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (целое число)
Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как base64-кодированная строка. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла непосредственно независимо от настроек cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для заданного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (логическое значение)
Отключить пейджер CLI для вывода.
--cli-auto-prompt (логическое значение)
Автоматически запросить параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматический запрос параметров ввода CLI.
Вывод
FailedDocuments -> (список)
Список документов, которые не удалось удалить из индекса. Каждая запись содержит сообщение об ошибке, объясняющее причину невозможности удаления документа из индекса.
(структура)
Предоставляет информацию о документах, которые не удалось удалить из индекса с помощью API BatchDeleteDocument.
Id -> (строка)
DataSourceId -> (строка)
ErrorCode -> (строка)
ErrorMessage -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.