[ aws . iottwinmaker ]
получить-задачу-передачи-метаданных
Описание
Получение задачи передачи метаданных.
См. также: Документацию API AWS
Синтаксис
get-metadata-transfer-job
--metadata-transfer-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]
Параметры
--metadata-transfer-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.
Вывод
metadataTransferJobId -> (строка)
arn -> (строка)
description -> (строка)
sources -> (список)
Источники задачи передачи метаданных.
(структура)
Настройки источника.
type -> (строка)
s3Configuration -> (структура)
Настройки источника S3.
location -> (строка)
iotSiteWiseConfiguration -> (структура)
Настройки источника IoT SiteWise.
filters -> (список)
Фильтры настроек источника AWS IoT SiteWise.
(структура-объединение тэгов)
Фильтр настроек источника AWS IoT SiteWise.
Примечание
Это структура-объединение тэгов. Можно установить только один из следующих верхних ключей:filterByAssetModel, filterByAsset.filterByAssetModel -> (структура)
Фильтровать по модели актива.
assetModelId -> (строка)
assetModelExternalId -> (строка)
includeOffspring -> (булево)
includeAssets -> (булево)
filterByAsset -> (структура)
Фильтровать по активу.
assetId -> (строка)
assetExternalId -> (строка)
includeOffspring -> (булево)
includeAssetModel -> (булево)
iotTwinMakerConfiguration -> (структура)
Настройки источника IoT TwinMaker.
workspace -> (строка)
filters -> (список)
Фильтры настроек источника AWS IoT TwinMaker.
(структура-объединение тэгов)
Фильтр настроек источника AWS IoT TwinMaker.
Примечание
Это структура-объединение тэгов. Можно установить только один из следующих верхних ключей:filterByComponentType, filterByEntity.filterByComponentType -> (структура)
Фильтровать по типу компонента.
componentTypeId -> (строка)
filterByEntity -> (структура)
Фильтровать по сущности.
entityId -> (строка)
destination -> (структура)
Цель задачи передачи метаданных.
type -> (строка)
s3Configuration -> (структура)
Настройки S3 назначения. [нужно добавить сущность S3]
location -> (строка)
iotTwinMakerConfiguration -> (структура)
Настройки Amazon Web Services IoT TwinMaker назначения.
workspace -> (строка)
metadataTransferJobRole -> (строка)
reportUrl -> (строка)
creationDateTime -> (временная метка)
updateDateTime -> (временная метка)
status -> (структура)
Статус задачи передачи метаданных.
state -> (строка)
error -> (структура)
Ошибка задачи передачи метаданных.
code -> (строка)
message -> (строка)
queuedPosition -> (целое число)
progress -> (структура)
Прогресс задачи передачи метаданных.
totalCount -> (целое число)
succeededCount -> (целое число)
skippedCount -> (целое число)
failedCount -> (целое число)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|