удаление-задачи

Описание

Удаляет задачу и связанные с ней выполнения задач.

Удаление задачи может занять время, в зависимости от количества созданных для нее выполнений задач и других факторов. Пока задача удаляется, ее статус будет отображаться как «DELETION_IN_PROGRESS». Попытка удалить или отменить задачу, статус которой уже «DELETION_IN_PROGRESS», приведет к ошибке.

Одновременно могут иметь статус «DELETION_IN_PROGRESS» только 10 задач, в противном случае произойдет LimitExceededException.

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

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

Синтаксис

  delete-job
--job-id <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 (строка)

Идентификатор задачи, которую необходимо удалить.

После завершения удаления задачи вы можете повторно использовать этот jobId при создании новой задачи. Однако это не рекомендуется, и вы должны убедиться, что ваши устройства не используют jobId для ссылки на удаленную задачу.

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

(Необязательно) При значении true можно удалить задачу, которая находится в статусе «IN_PROGRESS». В противном случае можно удалить только задачу в конечном состоянии («COMPLETED» или «CANCELED»), иначе произойдет ошибка. По умолчанию false.

Примечание

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

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

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

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

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

Примечание

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

--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
text
table
yaml
yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Используемый регион. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

on
off
auto

--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 пример удаляет указанную задачу. Указав параметр --force, задача удаляется, даже если ее статус IN_PROGRESS.

aws iot delete-job \
    --job-id "example-job-04" \
    --force

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

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

Вывод

Нет