[ aws . iot-jobs-data ]
start-command-execution
Описание
Используя команду, созданную с помощью API CreateCommand, запустите выполнение команды на определенном устройстве.
См. также: Документацию API AWS
Синтаксис
start-command-execution
--target-arn <value>
--command-arn <value>
[--parameters <value>]
[--execution-timeout-seconds <value>]
[--client-token <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]
Параметры
--target-arn (строка)
--command-arn (строка)
arn:aws:iot:<region>:<accountid>:command/<commandName>
--parameters (карта)
Список параметров, необходимых API StartCommandExecution при выполнении команды на устройстве.
ключ -> (строка)
значение -> (структура)
Список значений, используемых для описания конкретного параметра команды.
S -> (строка)
Атрибут типа Строка. Например:
"S": "Hello"B -> (булево)
Атрибут типа Булево. Например:
"BOOL": trueI -> (целое число)
L -> (длинное целое)
D -> (двойное число)
BIN -> (байты)
UL -> (строка)
Сокращенный синтаксис:
KeyName1=S=string,B=boolean,I=integer,L=long,D=double,BIN=blob,UL=string,KeyName2=S=string,B=boolean,I=integer,L=long,D=double,BIN=blob,UL=string
Синтаксис JSON:
{"string": {
"S": "string",
"B": true|false,
"I": integer,
"L": long,
"D": double,
"BIN": blob,
"UL": "string"
}
...}
--execution-timeout-seconds (длинное целое)
TIMED_OUT.--client-token (строка)
--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.
Вывод
executionId -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.