create-command
Описание
Создает команду. Команда содержит повторно используемые конфигурации, которые могут быть применены перед отправкой устройствам.
См. также: Документацию AWS API
Синтаксис
create-command
--command-id <value>
[--namespace <value>]
[--display-name <value>]
[--description <value>]
[--payload <value>]
[--mandatory-parameters <value>]
[--role-arn <value>]
[--tags <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]
Параметры
--command-id (строка)
--namespace (строка)
Пространство имен команды. Зарезервированные темы MQTT и валидации будут использоваться для выполнения команд в соответствии с настройкой пространства имен.
Возможные значения:
AWS-IoTAWS-IoT-FleetWise
--display-name (строка)
--description (строка)
--payload (структура)
Объект полезной нагрузки для команды. Вы должны указать эту информацию при использовании пространства имен AWS-IoT.
Вы можете загрузить статический файл полезной нагрузки из локального хранилища, содержащий инструкции для обработки устройства. Файл полезной нагрузки может использовать любой формат. Чтобы убедиться, что устройство правильно интерпретирует полезную нагрузку, рекомендуется указать тип содержимого полезной нагрузки.
content -> (бинарный файл)
contentType -> (строка)
application/json . Дополнительную информацию о различных типах содержимого см. в разделе Общие типы MIME .Сокращенный синтаксис:
content=blob,contentType=string
Синтаксис JSON:
{
"content": blob,
"contentType": "string"
}
--mandatory-parameters (список)
Список параметров, необходимых для API StartCommandExecution. Эти параметры необходимо указывать только при использовании пространства имен AWS-IoT-FleetWise. Вы можете указать их здесь или при запуске команды с использованием API StartCommandExecution.
(структура)
Карта пар ключ-значение, описывающих команду.
name -> (строка)
value -> (структура)
Значение, используемое для описания команды. При присвоении значения параметру оно переопределит любое предварительно заданное значение.
S -> (строка)
Атрибут типа Строка. Например:
"S": "Hello"B -> (булево)
Атрибут типа Булево. Например:
"BOOL": trueI -> (целое число)
L -> (длинное целое число)
D -> (двойное число)
BIN -> (бинарный файл)
Атрибут типа Двоичный. Например:
"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"UL -> (строка)
defaultValue -> (структура)
Значение по умолчанию, используемое для описания команды. Это значение, которое используется для параметра, если ему не назначено другое.
S -> (строка)
Атрибут типа Строка. Например:
"S": "Hello"B -> (булево)
Атрибут типа Булево. Например:
"BOOL": trueI -> (целое число)
L -> (длинное целое число)
D -> (двойное число)
BIN -> (бинарный файл)
Атрибут типа Двоичный. Например:
"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"UL -> (строка)
description -> (строка)
Сокращенный синтаксис:
name=string,value={S=string,B=boolean,I=integer,L=long,D=double,BIN=blob,UL=string},defaultValue={S=string,B=boolean,I=integer,L=long,D=double,BIN=blob,UL=string},description=string ...
Синтаксис JSON:
[
{
"name": "string",
"value": {
"S": "string",
"B": true|false,
"I": integer,
"L": long,
"D": double,
"BIN": blob,
"UL": "string"
},
"defaultValue": {
"S": "string",
"B": true|false,
"I": integer,
"L": long,
"D": double,
"BIN": blob,
"UL": "string"
},
"description": "string"
}
...
]
--role-arn (строка)
AWS-IoT-FleetWise. Эта роль предоставляет IoT Device Management разрешение на доступ к ресурсам IoT FleetWise для генерации полезной нагрузки для команды. Это поле не требуется при использовании пространства имен AWS-IoT.--tags (список)
Пары имя-значение, используемые в качестве метаданных для управления командой.
(структура)
Набор пар ключ/значение, используемых для управления ресурсом.
Key -> (строка)
Value -> (строка)
Сокращенный синтаксис:
Key=string,Value=string ...
Синтаксис JSON:
[
{
"Key": "string",
"Value": "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.
Вывод
commandId -> (строка)
commandArn -> (строка)
arn:aws:iot:<region>:<accountid>:command/<commandId>
© Copyright 2025, Amazon Web Services. Created using Sphinx.