Spec-Zone.ru › AWS CLI v2

[ aws . neptunedata ]

get-loader-job-status

Описание

Получает информацию о статусе указанной задачи загрузки. Neptune отслеживает последние 1024 задач массовой загрузки и сохраняет последние 10 000 подробностей об ошибках для каждой задачи.

Дополнительную информацию см. в разделе Neptune Loader Get-Status API.

При вызове этой операции в кластере Neptune с включенной аутентификацией IAM, пользователь или роль IAM, выполняющие запрос, должны иметь присоединенную политику, разрешающую действие IAM neptune-db:GetLoaderJobStatus в этом кластере.

См. также: Документация API AWS

get-loader-job-status использует значения типа документа. Типы документов следуют модели данных JSON, где допустимые значения — строки, числа, булевы значения, null, массивы и объекты. Для входных данных команд, параметров и вложенных параметров, помеченных типом document, необходимо предоставить JSON. Краткая синтаксическая запись не поддерживает типы документов.

Синтаксис

  get-loader-job-status
--load-id <value>
[--details | --no-details]
[--errors | --no-errors]
[--page <value>]
[--errors-per-page <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]

Параметры

--load-id (строка)

Идентификатор задачи загрузки, статус которой нужно получить.

--details | --no-details (логическое значение)

Флаг, указывающий, следует ли включать подробности, выходящие за рамки общего статуса (TRUE или FALSE; по умолчанию FALSE).

--errors | --no-errors (логическое значение)

Флаг, указывающий, следует ли включать список ошибок, которые произошли (TRUE или FALSE; по умолчанию FALSE).

Список ошибок разбит на страницы. Параметры page и errorsPerPage позволяют просматривать все ошибки по страницам.

--page (целое число)

Номер страницы с ошибками (положительное целое число; по умолчанию 1). Действителен только при установленном параметре errors в значение TRUE.

--errors-per-page (целое число)

Количество ошибок, возвращаемых на каждой странице (положительное целое число; по умолчанию 10). Действителен только при установленном параметре errors в значение TRUE.

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использование определенного профиля из вашего файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

  • on
  • off
  • auto

--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.

Вывод

status -> (строка)

Код HTTP-ответа запроса.

payload -> (документ)

Информация о статусе задачи загрузки в структуре, которая может выглядеть так:

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API