Spec-Zone.ru › AWS CLI v2

[ aws . iot-jobs-data ]

describe-job-execution

Описание

Получение данных о выполнении задания.

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

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

Синтаксис

  describe-job-execution
--job-id <value>
--thing-name <value>
[--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 (строка)

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

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

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

--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
  • text
  • таблица
  • yaml
  • yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

Регион для использования. Переопределяет настройки config/env.

--version (строка)

Отображение версии данного инструмента.

--color (строка)

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

  • вкл
  • выкл
  • авто

--no-sign-request (логическое значение)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.

--ca-bundle (строка)

Файл с набором сертификатов CA для проверки сертификатов SSL. Переопределяет настройки config/env.

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

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

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

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

Вывод:

{
    "execution": {
        "approximateSecondsBeforeTimedOut": 88,
        "executionNumber": 2939653338,
        "jobId": "SampleJob",
        "lastUpdatedAt": 1567701875.743,
        "queuedAt": 1567701902.444,
        "status": "QUEUED",
        "thingName": "MotionSensor1 ",
        "versionNumber": 3
   }
}

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

Вывод

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

Содержит данные о выполнении задания.

jobId -> (строка)

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

thingName -> (строка)

Имя объекта, выполняющего задание.

status -> (строка)

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

statusDetails -> (массив)

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

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

key -> (строка)

value -> (строка)

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

Время в секундах с начала эпохи, когда выполнение задания было помещено в очередь.

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

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

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

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

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

Приблизительное количество секунд, оставшееся до того, как состояние выполнения задания будет изменено на TIMED_OUT. Фактический таймаут выполнения задания может произойти до 60 секунд позже, чем ожидаемое время.

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

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

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

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

jobDocument -> (строка)

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

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

Spec-Zone.ru

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