Spec-Zone.ru › AWS CLI v2

[ aws . iot ]

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

Описание

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

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

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

Синтаксис

  cancel-job-execution
--job-id <value>
--thing-name <value>
[--force | --no-force]
[--expected-version <value>]
[--status-details <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 (строка)

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

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

(Необязательно) Если true, выполнение задачи будет отменено, если его состояние IN_PROGRESS или QUEUED, в противном случае выполнение задачи будет отменено только если его состояние QUEUED. Если вы пытаетесь отменить выполнение задачи, которая находится в состоянии IN_PROGRESS, и не задаёте force значение true, то будет выброшено исключение InvalidStateTransitionException. Значение по умолчанию false.

Отмена выполнения задачи, находящейся в состоянии «IN_PROGRESS», может привести к тому, что устройство не сможет обновить состояние выполнения задачи. Будьте осторожны и убедитесь, что устройство может восстановиться в допустимое состояние.

--expected-version (целое число)

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

--status-details (карта)

Коллекция пар имя/значение, описывающих состояние выполнения задачи. Если не указано, statusDetails остаются неизменными. Вы можете указать не более 10 пар имя/значение.

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

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

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

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

Для отмены выполнения задачи на устройстве

Следующий cancel-job-execution пример отменяет выполнение указанной задачи на устройстве. Если задача не находится в состоянии QUEUED, необходимо добавить параметр --force.

aws iot cancel-job-execution \
    --job-id "example-job-03" \
    --thing-name "MyRPi"

Эта команда не генерирует никакого вывода.

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

Вывод

Нет

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

Spec-Zone.ru

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