Spec-Zone.ru › AWS CLI v2

[ aws . iot ]

get-command-execution

Описание

Получает информацию о выполнении конкретной команды на отдельном устройстве.

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

Синтаксис

  get-command-execution
--execution-id <value>
--target-arn <value>
[--include-result | --no-include-result]
[--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]

Параметры

--execution-id (строка)

Уникальный идентификатор выполнения команды. Эта информация возвращается в ответ на запрос API StartCommandExecution.

--target-arn (строка)

Amazon Resource Name (ARN) устройства, на котором выполняется команда.

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

Может использоваться для указания, нужно ли включать результат выполнения команды в ответ API GetCommandExecution. Ваше устройство может использовать это поле для предоставления дополнительной информации о выполнении команды. Вам нужно указывать это поле только при использовании пространства имён AWS-IoT.

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

Вывод

executionId -> (строка)

Уникальный идентификатор выполнения команды.

commandArn -> (строка)

Amazon Resource Name (ARN) команды. Например, arn:aws:iot:<region>:<accountid>:command/<commandId>

targetArn -> (строка)

Amazon Resource Name (ARN) устройства, на котором выполняется команда.

status -> (строка)

Статус выполнения команды. После получения устройствами команды и начала выполнения операций, указанных в команде, оно может использовать API MQTT UpdateCommandExecution для обновления информации о статусе.

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

Ваши устройства могут использовать этот параметр для предоставления дополнительного контекста о статусе выполнения команды с помощью кода причины и описания.

reasonCode -> (строка)

Код, предоставляющий дополнительный контекст для статуса выполнения команды.

reasonDescription -> (строка)

Литеральная строка, которую устройства могут необязательно предоставить дополнительную информацию о коде причины для статуса выполнения команды.

result -> (карта)

Значение результата для текущего состояния выполнения команды. Статус предоставляет информацию о прогрессе выполнения команды. Устройство может использовать поле результата для обмена дополнительными подробностями об исполнении, такими как возвращаемое значение удалённого вызова функции.

Примечание

Если вы используете пространство имён AWS-IoT-FleetWise, то это поле не применимо в ответе API.

key -> (строка)

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

Значение результата выполнения команды. Устройство может использовать поле результата для обмена дополнительными подробностями об исполнении, такими как возвращаемое значение удалённого вызова функции.

Примечание

Это поле не применимо, если вы используете пространство имён AWS-IoT-FleetWise.

S -> (строка)

Атрибут типа String. Например:

"S": "Hello"

B -> (логическое значение)

Атрибут типа Boolean. Например:

"BOOL": true

BIN -> (двоичный блок)

Атрибут типа Двоичный.

parameters -> (карта)

Список параметров, которые API StartCommandExecution использовал при выполнении команды на устройстве.

key -> (строка)

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

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

Примечание

commandParameterValue может содержать только одно из перечисленных ниже полей.

S -> (строка)

Атрибут типа String. Например:

"S": "Hello"

B -> (логическое значение)

Атрибут типа Boolean. Например:

"BOOL": true

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

Атрибут типа целое число (32 бита).

L -> (длинное число)

Атрибут типа длинное целое число.

D -> (двойное число)

Атрибут типа двойное число (64 бита).

BIN -> (двоичный блок)

Атрибут типа Двоичный. Например:

"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"

UL -> (строка)

Атрибут типа беззнаковое длинное целое число.

executionTimeoutSeconds -> (длинное число)

Указывает количество времени в секундах, которое устройство может потратить на завершение выполнения команды. Таймер запускается при создании выполнения команды. Если статус выполнения команды не установлен в другое конечное состояние до истечения таймера, он автоматически обновится до TIMED_OUT.

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

Метка времени создания выполнения команды.

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

Метка времени последнего обновления выполнения команды.

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

Метка времени начала выполнения команды.

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

Метка времени завершения выполнения команды.

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

Параметр времени жизни (TTL), указывающий продолжительность, в течение которой выполнения будут храниться в вашем аккаунте. Значение по умолчанию — шесть месяцев.

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

Spec-Zone.ru

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