list-jobs
Описание
Список заданий.
Требуется разрешение на доступ к действию ListJobs.
См. также: Документацию API AWS
list-jobs является постраничным. Для получения всего набора результатов может потребоваться несколько вызовов API. Вы можете отключить постраничный вывод, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлекать данные из результатов следующих выражений запроса: jobs
Синтаксис
list-jobs
[--status <value>]
[--target-selection <value>]
[--thing-group-name <value>]
[--thing-group-id <value>]
[--namespace-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]
Параметры
--status (строка)
Необязательный фильтр, позволяющий искать задания со указанным статусом.
Возможные значения:
IN_PROGRESSCANCELEDCOMPLETEDDELETION_IN_PROGRESSSCHEDULED
--target-selection (строка)
Указывает, будет ли задание продолжаться (CONTINUOUS), или оно завершится после того, как все указанные в качестве целей устройства завершат выполнение задания (SNAPSHOT). Если непрерывное, задание также может быть запущено на устройстве, когда обнаружено изменение в целевом устройстве. Например, задание будет выполнено на устройстве, когда устройство добавлено в группу целей, даже после завершения задания всеми устройствами, которые изначально находились в группе.
Примечание
Рекомендуется использовать непрерывные задания вместо заданий моментальных снимков для динамических целей группы устройств. Используя непрерывные задания, устройства, которые присоединяются к группе, получают выполнение задания даже после создания задания.Возможные значения:
CONTINUOUSSNAPSHOT
--thing-group-name (строка)
--thing-group-id (строка)
--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.
--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
- текст
- таблица
- 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 (булево)
Автоматически запросить параметры ввода командной строки.
--no-cli-auto-prompt (булево)
Отключить автоматическое запроса параметров ввода командной строки.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в руководстве пользователя AWS CLI.
Чтобы вывести список заданий в вашей учетной записи AWS
Следующий пример list-jobs выводит все задания в вашей учетной записи AWS, отсортированные по статусу задания.
aws iot list-jobs
Вывод:
{
"jobs": [
{
"jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-01",
"jobId": "example-job-01",
"targetSelection": "SNAPSHOT",
"status": "IN_PROGRESS",
"createdAt": 1560787022.733,
"lastUpdatedAt": 1560787026.294
}
]
}
Дополнительную информацию см. в разделе Создание и управление заданиями (CLI) в руководстве разработчика AWS IoT.
Вывод
jobs -> (список)
Список заданий.
(структура)
Сводка задания.
jobArn -> (строка)
jobId -> (строка)
thingGroupId -> (строка)
targetSelection -> (строка)
Указывает, будет ли задание продолжаться (CONTINUOUS), или оно завершится после того, как все указанные в качестве целей устройства завершат выполнение задания (SNAPSHOT). Если непрерывное, задание также может быть запущено на устройстве, когда обнаружено изменение в целевом устройстве. Например, задание будет выполнено на устройстве, когда устройство добавлено в группу целей, даже после завершения задания всеми устройствами, которые изначально находились в группе.
Примечание
Рекомендуется использовать непрерывные задания вместо заданий моментальных снимков для динамических целей группы устройств. Используя непрерывные задания, устройства, которые присоединяются к группе, получают выполнение задания даже после создания задания.status -> (строка)
createdAt -> (метка времени)
lastUpdatedAt -> (метка времени)
completedAt -> (метка времени)
isConcurrent -> (булево)
nextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.