Spec-Zone.ru › AWS CLI v2

[ aws . iot-jobs-data ]

обновление-выполнения-задачи

Описание

Обновляет состояние выполнения задачи.

Требуется разрешение на доступ к действию UpdateJobExecution.

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

Синтаксис

  update-job-execution
--job-id <value>
--thing-name <value>
--status <value>
[--status-details <value>]
[--step-timeout-in-minutes <value>]
[--expected-version <value>]
[--include-job-execution-state | --no-include-job-execution-state]
[--include-job-document | --no-include-job-document]
[--execution-number <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]

Параметры

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

Уникальный идентификатор, присвоенный этой задаче при ее создании.

--thing-name (строка)

Имя вещи, связанной с устройством.

--status (строка)

Новое состояние выполнения задачи (IN_PROGRESS, FAILED, SUCCESS, или REJECTED). Это значение должно быть указано при каждом обновлении.

Возможные значения:

  • QUEUED
  • IN_PROGRESS
  • SUCCEEDED
  • FAILED
  • TIMED_OUT
  • REJECTED
  • REMOVED
  • CANCELED

--status-details (массив)

Необязательно. Коллекция пар «имя-значение», описывающих состояние выполнения задачи. Если не указано, statusDetails останутся неизменными.

Максимальная длина значения в паре «имя-значение» составляет 1024 символа.

ключ -> (строка)

значение -> (строка)

Сокращенный синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--step-timeout-in-minutes (длинное целое)

Указывает время, которое у этого устройства есть для завершения выполнения этой задачи. Если состояние выполнения задачи не переходит в конечное состояние до истечения этого таймера или до его сброса (вызовом UpdateJobExecution, установкой состояния в IN_PROGRESS и указанием нового значения таймаута в этом поле), состояние выполнения задачи автоматически будет установлено в TIMED_OUT. Обратите внимание, что установка или сброс таймаута шага не влияет на таймаут выполнения, который мог быть указан при создании задачи (CreateJob с использованием поля timeoutConfig).

Допустимые значения для этого параметра находятся в диапазоне от 1 до 10080 (от 1 минуты до 7 дней). Также допустимо значение -1, которое отменит текущий таймер шага (созданный предыдущим использованием UpdateJobExecutionRequest).

--expected-version (длинное целое)

Необязательно. Ожидаемая текущая версия выполнения задачи. При каждом обновлении выполнения задачи ее версия увеличивается. Если версия выполнения задачи, хранящаяся в Jobs, не совпадает, обновление отклоняется с ошибкой VersionMismatch, и возвращается ErrorResponse, содержащий текущие данные состояния выполнения задачи. (Это делает ненужным выполнение отдельного запроса DescribeJobExecution для получения данных состояния выполнения задачи.)

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

Необязательно. При включении и установке в значение true ответ содержит данные JobExecutionState. По умолчанию значение false.

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

Необязательно. При установке в значение true ответ содержит документ задачи. По умолчанию значение false.

--execution-number (длинное целое)

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

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

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы с AWS CLI в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования Unix-подобных оболочек. Эти примеры потребуется адаптировать к правилам цитирования вашей оболочки. Дополнительную информацию см. в разделе «Использование кавычек со строками» в Руководстве пользователя AWS CLI.

Для обновления состояния выполнения задачи

В следующем update-job-execution примере обновляется состояние указанной задачи и вещи.

aws iot-jobs-data update-job-execution \
    --job-id SampleJob \
    --thing-name MotionSensor1 \
    --status REMOVED \
    --endpoint-url https://1234567890abcd.jobs.iot.us-west-2.amazonaws.com

Вывод:

{
    "executionState": {
        "status": "REMOVED",
        "versionNumber": 3
    },
}

Дополнительную информацию см. в разделе «Устройства и задачи» в Руководстве разработчика AWS IoT.

Вывод

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

Объект JobExecutionState.

status -> (строка)

Состояние выполнения задачи. Может быть одним из следующих: «ОЧЕРЕДЬ», «В_ПРОЦЕССЕ», «НЕУДАЧА», «УСПЕХ», «ОТМЕНЕНО», «ИСТЕКЛО_ВРЕМЯ», «ОТКАЗАНО» или «УДАЛЕНО».

statusDetails -> (массив)

Коллекция пар «имя-значение», описывающих состояние выполнения задачи.

Максимальная длина значения в паре «имя-значение» составляет 1024 символа.

ключ -> (строка)

значение -> (строка)

versionNumber -> (длинное целое)

Версия выполнения задачи. Версии выполнения задач увеличиваются каждый раз при их обновлении устройством.

jobDocument -> (строка)

Содержимое документов задачи.

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

Spec-Zone.ru

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