Spec-Zone.ru › AWS CLI v2

[ aws . iotsitewise ]

create-bulk-import-job

Описание

Определяет задачу загрузки данных в IoT SiteWise из Amazon S3. Дополнительные сведения см. в разделе Создание задачи импорта данных в массовом режиме (CLI) в Руководстве пользователя Amazon Simple Storage Service.

Предупреждение

Перед созданием задачи импорта данных в массовом режиме необходимо включить теплый уровень IoT SiteWise или холодный уровень IoT SiteWise. Дополнительные сведения о настройке параметров хранения см. в разделе PutStorageConfiguration.

Массовый импорт предназначен для хранения исторических данных в IoT SiteWise. Он не запускает вычисления или уведомления в теплом или холодном уровнях хранения IoT SiteWise.

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

Синтаксис

  create-bulk-import-job
--job-name <value>
--job-role-arn <value>
--files <value>
--error-report-location <value>
--job-configuration <value>
[--adaptive-ingestion | --no-adaptive-ingestion]
[--delete-files-after-import| --no-delete-files-after-import]
[--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-name (строка)

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

--job-role-arn (строка)

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

--files (список)

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

(структура)

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

bucket -> (строка)

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

key -> (строка)

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

versionId -> (строка)

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

Сокращенный синтаксис:

bucket=string,key=string,versionId=string ...

Синтаксис JSON:

[
  {
    "bucket": "string",
    "key": "string",
    "versionId": "string"
  }
  ...
]

--error-report-location (структура)

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

bucket -> (строка)

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

prefix -> (строка)

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

Сокращенный синтаксис:

bucket=string,prefix=string

Синтаксис JSON:

{
  "bucket": "string",
  "prefix": "string"
}

--job-configuration (структура)

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

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

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

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

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

columnNames -> (список)

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

(строка)

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

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

Синтаксис JSON:

{
  "fileFormat": {
    "csv": {
      "columnNames": ["ALIAS"|"ASSET_ID"|"PROPERTY_ID"|"DATA_TYPE"|"TIMESTAMP_SECONDS"|"TIMESTAMP_NANO_OFFSET"|"QUALITY"|"VALUE", ...]
    },
    "parquet": {

    }
  }
}

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

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

--delete-files-after-import | --no-delete-files-after-import (логическое значение)

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

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

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

Spec-Zone.ru

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