Spec-Zone.ru › AWS CLI v2

[ aws . iotsitewise ]

описание-задачи-импорта-данных

Описание

Получает информацию о запросе на задачу импорта данных. Дополнительную информацию см. в разделе «Описание задачи импорта данных (CLI)» в Руководстве пользователя Amazon Simple Storage Service.

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

Синтаксис

  describe-bulk-import-job
--job-id <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]

Параметры

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

Идентификатор задачи.

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

Вывод

jobId -> (строка)

Идентификатор задачи.

jobName -> (строка)

Уникальное имя, которое помогает идентифицировать запрос задачи.

jobStatus -> (строка)

Статус задачи импорта данных может быть одним из следующих значений:

  • PENDING – IoT SiteWise ожидает завершения текущей задачи импорта данных.
  • CANCELLED – Задача импорта данных была отменена.
  • RUNNING – IoT SiteWise обрабатывает ваш запрос на импорт данных из Amazon S3.
  • COMPLETED – IoT SiteWise успешно выполнил ваш запрос на импорт данных из Amazon S3.
  • FAILED – IoT SiteWise не смог обработать ваш запрос на импорт данных из Amazon S3. Вы можете использовать журналы, сохраненные в указанном расположении отчета об ошибках в Amazon S3, для устранения неполадок.
  • COMPLETED_WITH_FAILURES – IoT SiteWise выполнил ваш запрос на импорт данных из Amazon S3 с ошибками. Вы можете использовать журналы, сохраненные в указанном расположении отчета об ошибках в Amazon S3, для устранения неполадок.

jobRoleArn -> (строка)

ARN роли IAM, которая позволяет IoT SiteWise считывать данные Amazon S3.

files -> (список)

Файлы в указанном ведре Amazon S3, содержащие ваши данные.

(структура)

Файл в Amazon S3, где сохранены ваши данные.

bucket -> (строка)

Имя ведра Amazon S3, из которого импортируются данные.

key -> (строка)

Ключ объекта Amazon S3, содержащего ваши данные. Каждый объект имеет ключ, являющийся уникальным идентификатором. Каждый объект имеет ровно один ключ.

versionId -> (строка)

Идентификатор версии для идентификации конкретной версии объекта Amazon S3, содержащего ваши данные.

errorReportLocation -> (структура)

Назначение Amazon S3, где сохраняются ошибки, связанные с запросом на создание задачи.

bucket -> (строка)

Имя ведра Amazon S3, в которое отправляются ошибки, связанные с задачей импорта данных.

prefix -> (строка)

Amazon S3 использует префикс в качестве имени папки для организации данных в ведре. Каждый объект Amazon S3 имеет ключ, который является его уникальным идентификатором в ведре. Каждый объект в ведре имеет ровно один ключ. Префикс должен заканчиваться слешем (/). Дополнительную информацию см. в разделе Организация объектов с помощью префиксов в Руководстве пользователя Amazon Simple Storage Service.

jobConfiguration -> (структура)

Содержит конфигурационную информацию задачи, например, формат файла, используемый для сохранения данных в Amazon S3.

fileFormat -> (структура)

Формат файла данных в S3.

csv -> (структура)

Файл в формате .CSV.

columnNames -> (список)

Имена столбцов, указанные в файле .csv.

(строка)

parquet -> (структура)

Файл в формате parquet.

jobCreationDate -> (метка времени)

Дата создания задачи в формате Unix epoch TIME.

jobLastUpdateDate -> (метка времени)

Дата последнего обновления задачи в формате Unix epoch time.

adaptiveIngestion -> (логическое значение)

Если установлено в true, новые данные импортируются в хранилище IoT SiteWise. Вычисляются измерения с уведомлениями, метриками и преобразованиями. Если установлено в false, исторические данные импортируются в IoT SiteWise как есть.

deleteFilesAfterImport -> (логическое значение)

Если установлено в true, ваши файлы данных удаляются из S3 после импорта в хранилище IoT SiteWise.

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

Spec-Zone.ru

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