описание-выполнения-задачи
Описание
Описывает выполнение задачи.
Требуется разрешение на доступ к действию DescribeJobExecution.
См. также: Документацию API AWS
Синтаксис
describe-job-execution
--job-id <value>
--thing-name <value>
[--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 (строка)
--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
- текст
- таблица
- 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.
Для получения подробностей о выполнении задачи на устройстве
Следующий пример получения подробностей о выполнении заданной задачи.
aws iot describe-job-execution \
--job-id "example-job-01" \
--thing-name "MyRaspberryPi"
Вывод:
{
"execution": {
"jobId": "example-job-01",
"status": "QUEUED",
"statusDetails": {},
"thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyRaspberryPi",
"queuedAt": 1560787023.636,
"lastUpdatedAt": 1560787023.636,
"executionNumber": 1,
"versionNumber": 1
}
}
Дополнительная информация содержится в разделе Создание и управление задачами (CLI) в руководстве разработчика AWS IoT.
Вывод
выполнение -> (структура)
Информация о выполнении задачи.
jobId -> (строка)
статус -> (строка)
forceCanceled -> (булево)
true, если выполнение задачи было отменено с параметром force, установленным на true.statusDetails -> (структура)
Коллекция пар имя/значение, описывающих состояние выполнения задачи.
detailsMap -> (карта)
Статус выполнения задачи.
ключ -> (строка)
значение -> (строка)
thingArn -> (строка)
queuedAt -> (метка времени)
startedAt -> (метка времени)
lastUpdatedAt -> (метка времени)
executionNumber -> (целое)
versionNumber -> (целое)
approximateSecondsBeforeTimedOut -> (целое)
TIMED_OUT. Интервал таймаута может быть где-то между 1 минутой и 7 днями (1 до 10080 минут). Фактический таймаут выполнения задачи может наступить до 60 секунд позже, чем рассчитанное время. Это значение не будет включено, если выполнение задачи достигло конечного состояния.
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|