Spec-Zone.ru › AWS CLI v2

[ aws . iot ]

обновить-задачу

Описание

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

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

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

Синтаксис

  update-job
--job-id <value>
[--description <value>]
[--presigned-url-config <value>]
[--job-executions-rollout-config <value>]
[--abort-config <value>]
[--timeout-config <value>]
[--namespace-id <value>]
[--job-executions-retry-config <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 (строка)

Идентификатор задачи, которую нужно обновить.

--description (строка)

Краткое текстовое описание задачи.

--presigned-url-config (структура)

Конфигурационная информация для предварительно подписанных S3 URL.

roleArn -> (строка)

ARN роли IAM, которая предоставляет разрешение на загрузку файлов из ведра S3, где хранятся данные/обновления задачи. Роль также должна предоставить разрешение IoT на загрузку файлов.

Предупреждение

Для получения информации о решении проблемы с двойственным агентом см. предотвращение проблем с двойственным агентом между службами в руководстве разработчика Amazon Web Services IoT Core.

expiresInSec -> (целое)

Сколько времени (в секундах) действительны предварительно подписанные URL. Допустимые значения: 60—3600, значение по умолчанию — 3600 секунд. Предварительно подписанные URL генерируются, когда Jobs получает запрос MQTT для документа задачи.

Краткая форма синтаксиса:

roleArn=string,expiresInSec=long

Синтаксис JSON:

{
  "roleArn": "string",
  "expiresInSec": long
}

--job-executions-rollout-config (структура)

Позволяет создать поэтапный запуск задачи.

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

Максимальное количество устройств, которые будут уведомлены о запланированной задаче в минуту. Этот параметр позволяет создать поэтапный запуск.

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

Скорость увеличения для запуска задачи. Этот параметр позволяет определить экспоненциальную скорость для запуска задачи.

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

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

incrementFactor -> (двойное)

Экспоненциальный множитель для увеличения скорости запуска задачи.

Amazon Web Services IoT Core поддерживает не более одной цифры после десятичной точки (например, 1,5, но не 1,55).

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

Критерии для начала увеличения скорости запуска задачи.

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

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

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

Пороговое значение для количества успешных устройств, которое инициирует увеличение скорости запуска.

Краткая форма синтаксиса:

maximumPerMinute=integer,exponentialRate={baseRatePerMinute=integer,incrementFactor=double,rateIncreaseCriteria={numberOfNotifiedThings=integer,numberOfSucceededThings=integer}}

Синтаксис JSON:

{
  "maximumPerMinute": integer,
  "exponentialRate": {
    "baseRatePerMinute": integer,
    "incrementFactor": double,
    "rateIncreaseCriteria": {
      "numberOfNotifiedThings": integer,
      "numberOfSucceededThings": integer
    }
  }
}

--abort-config (структура)

Позволяет создать критерии для прерывания задачи.

criteriaList -> (список)

Список критериев, определяющих, когда и как прервать задачу.

(структура)

Критерии, определяющие, когда и как происходит прерывание задачи.

failureType -> (строка)

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

action -> (строка)

Тип действия по выполнению задачи для инициирования прерывания задачи.

thresholdPercentage -> (двойное)

Минимальный процент сбоев выполнения задачи, которые должны произойти для прерывания задачи.

Amazon Web Services IoT Core поддерживает не более двух цифр после десятичной точки (например, 10,9 и 10,99, но не 10,999).

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

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

Краткая форма синтаксиса:

criteriaList=[{failureType=string,action=string,thresholdPercentage=double,minNumberOfExecutedThings=integer},{failureType=string,action=string,thresholdPercentage=double,minNumberOfExecutedThings=integer}]

Синтаксис JSON:

{
  "criteriaList": [
    {
      "failureType": "FAILED"|"REJECTED"|"TIMED_OUT"|"ALL",
      "action": "CANCEL",
      "thresholdPercentage": double,
      "minNumberOfExecutedThings": integer
    }
    ...
  ]
}

--timeout-config (структура)

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

inProgressTimeoutInMinutes -> (целое)

Указывает время в минутах, которое у этого устройства есть на завершение выполнения задачи. Интервал таймаута может составлять от 1 минуты до 7 дней (от 1 до 10080 минут). Время выполнения задачи нельзя обновить, и оно будет применяться ко всем выполнениям задачи для задачи. Всякий раз, когда выполнение задачи остается в состоянии IN_PROGRESS дольше этого интервала, выполнение задачи завершится неудачей и переключится в конечное состояние TIMED_OUT.

Краткая форма синтаксиса:

inProgressTimeoutInMinutes=long

Синтаксис JSON:

{
  "inProgressTimeoutInMinutes": long
}

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

Имя пространства, используемое для обозначения задачи, управляемой клиентом.

При указании значения для этого параметра Amazon Web Services IoT Core отправляет уведомления о задачах в темы MQTT, содержащие значение в следующем формате.

$aws/things/*THING_NAME* /jobs/*JOB_ID* /notify-namespace-*NAMESPACE_ID* /

Примечание

Функция namespaceId в настоящее время поддерживается только IoT Greengrass. Дополнительную информацию см. в разделе Настройка устройств ядра IoT Greengrass.

--job-executions-retry-config (структура)

Позволяет создать критерии повторной попытки выполнения задачи.

criteriaList -> (список)

Список критериев, определяющих количество попыток повтора для каждого типа сбоев для задачи.

(структура)

Критерии, определяющие количество попыток повтора для каждого типа сбоев для задачи.

failureType -> (строка)

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

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

Количество попыток повтора, разрешенных для типа сбоев для задачи.

Краткая форма синтаксиса:

criteriaList=[{failureType=string,numberOfRetries=integer},{failureType=string,numberOfRetries=integer}]

Синтаксис JSON:

{
  "criteriaList": [
    {
      "failureType": "FAILED"|"TIMED_OUT"|"ALL",
      "numberOfRetries": integer
    }
    ...
  ]
}

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

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

Для получения подробного статуса задания

Следующий update-job пример получает подробный статус задания с идентификатором example-job-01.

aws iot describe-job \
    --job-id "example-job-01"

Вывод:

{
    "job": {
        "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-01",
        "jobId": "example-job-01",
        "targetSelection": "SNAPSHOT",
        "status": "IN_PROGRESS",
        "targets": [
            "arn:aws:iot:us-west-2:123456789012:thing/MyRaspberryPi"
        ],
        "description": "example job test",
        "presignedUrlConfig": {},
        "jobExecutionsRolloutConfig": {},
        "createdAt": 1560787022.733,
        "lastUpdatedAt": 1560787026.294,
        "jobProcessDetails": {
            "numberOfCanceledThings": 0,
            "numberOfSucceededThings": 0,
            "numberOfFailedThings": 0,
            "numberOfRejectedThings": 0,
            "numberOfQueuedThings": 1,
            "numberOfInProgressThings": 0,
            "numberOfRemovedThings": 0,
            "numberOfTimedOutThings": 0
        },
        "timeoutConfig": {}
    }
}

Дополнительную информацию можно найти в разделе Создание и управление заданиями (CLI) в Руководстве разработчика AWS IoT.

Вывод

Нет

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

Spec-Zone.ru

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