Spec-Zone.ru › AWS CLI v2

[ aws . drs ]

describe-jobs

Описание

Возвращает список заданий. Используйте фильтры JobsID, fromDate и toDate, чтобы ограничить возвращаемые задания. Ответ сортируется по creationDataTime — сначала самая последняя дата. Задания создаются API StartRecovery, TerminateRecoveryInstances и StartFailbackLaunch. Задания также создаются API DiagnosticLaunch и TerminateDiagnosticInstances, которые доступны только для Support и используются только в ответ на соответствующие запросы поддержки.

См. также: AWS API Documentation

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

Синтаксис

  describe-jobs
[--filters <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]

Параметры

--filters (структура)

Набор фильтров для возврата заданий.

fromDate -> (строка)

Начальная дата в запросе диапазона дат.

jobIDs -> (список)

Массив идентификаторов заданий, которые должны быть возвращены. Пустой массив означает все задания.

(строка)

toDate -> (строка)

Конечная дата в запросе диапазона дат.

Сокращенный синтаксис:

fromDate=string,jobIDs=string,string,toDate=string

Синтаксис JSON:

{
  "fromDate": "string",
  "jobIDs": ["string", ...],
  "toDate": "string"
}

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

Вывод

items -> (список)

Массив заданий.

(структура)

Задание — это асинхронный рабочий процесс.

arn -> (строка)

ARN задания.

creationDateTime -> (строка)

Дата и время создания задания.

endDateTime -> (строка)

Дата и время завершения задания.

initiatedBy -> (строка)

Строка, представляющая того, кто инициировал задание.

jobID -> (строка)

Идентификатор задания.

participatingResources -> (список)

Список ресурсов, на которых действует задание.

(структура)

Представляет ресурс, участвующий в асинхронном задании.

launchStatus -> (строка)

Статус запуска участвующего ресурса.

participatingResourceID -> (структура помеченного объединения)

Идентификатор участвующего ресурса.

Примечание

Это структура помеченного объединения. Может быть установлено только одно из следующих ключей верхнего уровня: sourceNetworkID.

sourceNetworkID -> (строка)

Идентификатор исходной сети.

participatingServers -> (список)

Список серверов, на которых действует задание.

(структура)

Представляет сервер, участвующий в асинхронном задании.

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

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

runs -> (список)

Список статусов действий после запуска.

(структура)

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

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

Действие.

actionCode -> (строка)

Код действия после запуска.

actionId -> (строка)

Идентификатор действия после запуска.

actionVersion -> (строка)

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

active -> (логическое значение)

Действие после запуска активно.

category -> (строка)

Категория действия после запуска.

description -> (строка)

Описание действия после запуска.

name -> (строка)

Название действия после запуска.

optional -> (логическое значение)

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

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

Порядок действия после запуска.

parameters -> (массив)

Параметры действия после запуска.

key -> (строка)

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

Параметр действия после запуска.

type -> (строка)

Тип.

value -> (строка)

Значение.

type -> (строка)

Тип действия после запуска.

failureReason -> (строка)

Причина неудачи.

runId -> (строка)

Идентификатор выполнения.

status -> (строка)

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

ssmAgentDiscoveryDatetime -> (строка)

Время, когда AWS Systems Manager был обнаружен как запущенный на запущенной инстанции.

launchStatus -> (строка)

Статус запуска участвующего сервера.

recoveryInstanceID -> (строка)

Идентификатор Recovery Instance участвующего сервера.

sourceServerID -> (строка)

Идентификатор исходного сервера участвующего сервера.

status -> (строка)

Статус задания.

tags -> (массив)

Список тегов, связанных с заданием.

key -> (строка)

value -> (строка)

type -> (строка)

Тип задания.

nextToken -> (строка)

Токен следующего задания для извлечения.

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

Spec-Zone.ru

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