Spec-Zone.ru › AWS CLI v2

[ aws . iottwinmaker ]

create-metadata-transfer-job

Описание

Создаёт новую задачу передачи метаданных.

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

Синтаксис

  create-metadata-transfer-job
[--metadata-transfer-job-id <value>]
[--description <value>]
--sources <value>
--destination <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]

Параметры

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

Идентификатор задачи передачи метаданных.

--description (строка)

Описание задачи передачи метаданных.

--sources (список)

Источники задачи передачи метаданных.

(структура)

Конфигурация источника.

тип -> (строка)

Тип конфигурации источника.

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

Конфигурация источника S3.

местоположение -> (строка)

Местоположение источника конфигурации S3.

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

Конфигурация источника IoT SiteWise.

фильтры -> (список)

Фильтры конфигурации источника AWS IoT SiteWise.

(структура помеченного объединения)

Фильтр конфигурации источника AWS IoT SiteWise.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть установлен: filterByAssetModel, filterByAsset.

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

Фильтр по модели актива.

assetModelId -> (строка)

Идентификатор модели актива.

assetModelExternalId -> (строка)

Внешний идентификатор модели актива.

includeOffspring -> (булево)

Включать потомков актива. [нужно описание]

includeAssets -> (булево)

Включать активы.

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

Фильтр по активу.

assetId -> (строка)

Фильтр по идентификатору актива.

assetExternalId -> (строка)

Внешний идентификатор актива.

includeOffspring -> (булево)

Включать дочерние активы. [нужно описание]

includeAssetModel -> (булево)

Включать модель актива.

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

Конфигурация источника IoT TwinMaker.

workspace -> (строка)

Рабочее пространство IoT TwinMaker.

фильтры -> (список)

Фильтры конфигурации источника AWS IoT TwinMaker задачи передачи метаданных.

(структура помеченного объединения)

Фильтр конфигурации источника AWS IoT TwinMaker задачи передачи метаданных.

Примечание

Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть установлен: filterByComponentType, filterByEntity.

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

Фильтр по типу компонента.

componentTypeId -> (строка)

Идентификатор типа компонента.

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

Фильтр по сущности.

entityId -> (строка)

Идентификатор сущности.

Синтаксис JSON:

[
  {
    "type": "s3"|"iotsitewise"|"iottwinmaker",
    "s3Configuration": {
      "location": "string"
    },
    "iotSiteWiseConfiguration": {
      "filters": [
        {
          "filterByAssetModel": {
            "assetModelId": "string",
            "assetModelExternalId": "string",
            "includeOffspring": true|false,
            "includeAssets": true|false
          },
          "filterByAsset": {
            "assetId": "string",
            "assetExternalId": "string",
            "includeOffspring": true|false,
            "includeAssetModel": true|false
          }
        }
        ...
      ]
    },
    "iotTwinMakerConfiguration": {
      "workspace": "string",
      "filters": [
        {
          "filterByComponentType": {
            "componentTypeId": "string"
          },
          "filterByEntity": {
            "entityId": "string"
          }
        }
        ...
      ]
    }
  }
  ...
]

--destination (структура)

Назначение задачи передачи метаданных.

тип -> (строка)

Тип назначения.

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

Конфигурация S3 назначения задачи передачи метаданных. [необходимо добавить сущность S3]

местоположение -> (строка)

Местоположение конфигурации S3 назначения.

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

Конфигурация Amazon Web Services IoT TwinMaker задачи передачи метаданных.

workspace -> (строка)

Рабочее пространство IoT TwinMaker.

Краткая запись:

type=string,s3Configuration={location=string},iotTwinMakerConfiguration={workspace=string}

Синтаксис JSON:

{
  "type": "s3"|"iotsitewise"|"iottwinmaker",
  "s3Configuration": {
    "location": "string"
  },
  "iotTwinMakerConfiguration": {
    "workspace": "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.

Вывод

metadataTransferJobId -> (строка)

Идентификатор задачи передачи метаданных.

arn -> (строка)

ARN задачи передачи метаданных.

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

Свойство creationDateTime задачи передачи метаданных.

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

Статус ответа задачи передачи метаданных.

state -> (строка)

Состояние задачи передачи метаданных.

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

Ошибка задачи передачи метаданных.

code -> (строка)

Код ошибки.

message -> (строка)

Сообщение об ошибке.

queuedPosition -> (целое число)

Позиция в очереди.

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

Spec-Zone.ru

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