Spec-Zone.ru › AWS CLI v2

[ aws . iot ]

list-job-executions-for-thing

Описание

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

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

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

list-job-executions-for-thing является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько API-запросов. Вы можете отключить постраничную навигацию, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе, содержащем несколько страниц, аргумент --query должен извлекать данные из результатов следующих выражений запроса: executionSummaries

Синтаксис

  list-job-executions-for-thing
--thing-name <value>
[--status <value>]
[--namespace-id <value>]
[--job-id <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--thing-name (строка)

Имя устройства.

--status (строка)

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

Возможные значения:

  • QUEUED
  • IN_PROGRESS
  • SUCCEEDED
  • FAILED
  • TIMED_OUT
  • REJECTED
  • REMOVED
  • CANCELED

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

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

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

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, поскольку строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Маркер для указания места начала постраничной навигации. Это NextToken из ранее обрезанного ответа.

Примеры использования см. в разделе Постраничная навигация в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания AWS-вызовов.

Примеры использования см. в разделе Постраничная навигация в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов, которые нужно вернуть в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничной навигации укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничная навигация в Руководстве пользователя AWS Command Line Interface.

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

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

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

Чтобы перечислить задания, выполненные для устройства

Следующий пример list-job-executions-for-thing перечисляет все задания, выполненные для устройства с именем MyRaspberryPi.

aws iot list-job-executions-for-thing \
    --thing-name "MyRaspberryPi"

Вывод:

{
    "executionSummaries": [
        {
            "jobId": "example-job-01",
            "jobExecutionSummary": {
                "status": "QUEUED",
                "queuedAt": 1560787023.636,
                "lastUpdatedAt": 1560787023.636,
                "executionNumber": 1
            }
        }
    ]
}

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

Вывод

executionSummaries -> (список)

Список сводных данных о выполнении заданий.

(структура)

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

jobId -> (строка)

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

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

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

status -> (строка)

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

queuedAt -> (отметка времени)

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

startedAt -> (отметка времени)

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

lastUpdatedAt -> (отметка времени)

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

executionNumber -> (длинное целое)

Строка (состоящая из цифр от «0» до «9»), которая идентифицирует это конкретное выполнение задания на этом конкретном устройстве. Она может быть использована позднее в командах, которые возвращают или обновляют информацию о выполнении задания.

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

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

nextToken -> (строка)

Маркер для следующего набора результатов или null, если дополнительных результатов нет.

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

Spec-Zone.ru

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