Spec-Zone.ru › AWS CLI v2

[ aws . iot ]

удаление-исполнения-задания

Описание

Удаляет исполнение задания.

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

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

Синтаксис

  delete-job-execution
--job-id <value>
--thing-name <value>
--execution-number <value>
[--force | --no-force]
[--namespace-id <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 (строка)

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

--execution-number (целое число)

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

Обратите внимание, что после удаления исполнения задания, executionNumber может быть повторно использовано IoT, поэтому убедитесь, что вы используете правильное значение.

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

(Необязательно) Если true, вы можете удалить исполнение задания, которое находится в состоянии «В_ПРОЦЕССЕ». В противном случае вы можете удалить только исполнение задания, находящееся в терминальном состоянии («УСПЕШНО», «ОШИБКА», «ОТКАЗАНО», «УДАЛЕНО» или «ОТМЕНЕНО»), иначе произойдёт исключение. По умолчанию false.

Примечание

Удаление исполнения задания, которое находится в состоянии «В_ПРОЦЕССЕ», помешает устройству получить доступ к информации о задании или обновить статус исполнения задания. Будьте осторожны и убедитесь, что устройство может восстановиться до допустимого состояния.

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

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

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

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

Примечание

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

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

Примеры

Примечание

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

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

Для удаления исполнения задания

Следующий delete-job-execution пример удаляет исполнение задания указанного задания на устройстве. Используйте describe-job-execution, чтобы получить номер исполнения.

aws iot delete-job-execution
    --job-id "example-job-02"
    --thing-name "MyRaspberryPi"
    --execution-number 1

Эта команда не выдаёт вывод.

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

Вывод

Нет

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

Spec-Zone.ru

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