Spec-Zone.ru › AWS CLI v2

[ aws . mgn ]

describe-jobs

Описание

Возвращает список заданий. Используйте фильтры JobsID, fromDate и toData, чтобы ограничить возвращаемые задания. Ответ сортируется по creationDateTime — сначала последняя дата. Задания обычно создаются API StartTest, StartCutover и TerminateTargetInstances. Задания также создаются API DiagnosticLaunch и TerminateDiagnosticInstances, доступными только для поддержки и используемыми только в ответ на соответствующие запросы поддержки.

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

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

Синтаксис

  describe-jobs
[--account-id <value>]
[--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]

Параметры

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

Запрос на описание элементов журнала заданий по идентификатору учетной записи.

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

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

  • включено
  • выключено
  • автоматически

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

Вывод

items -> (список)

Запрос на описание элементов журнала заданий.

(структура)

Задание.

arn -> (строка)

ARN конкретного задания.

creationDateTime -> (строка)

Время создания задания.

endDateTime -> (строка)

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

initiatedBy -> (строка)

Поле, инициализированное заданием.

jobID -> (строка)

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

participatingServers -> (список)

Серверы, участвующие в конкретном задании.

(структура)

Сервер, участвующий в задании.

launchStatus -> (строка)

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

launchedEc2InstanceID -> (строка)

Идентификатор запущенного экземпляра ec2 участвующего сервера.

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

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

postLaunchActionsLaunchStatusList -> (список)

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

(структура)

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

executionID -> (строка)

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

executionStatus -> (строка)

Статус выполнения документа AWS Systems Manager.

failureReason -> (строка)

Причина сбоя документа AWS Systems Manager.

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

Документ AWS Systems Manager для действий после запуска задания.

actionName -> (строка)

Наименование документа AWS Systems Manager для удобства пользователя.

externalParameters -> (карта)

Внешние параметры документа AWS Systems Manager.

key -> (строка)

value -> (метка объединённой структуры)

Внешний параметр документа AWS Systems Manager.

Примечание

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

dynamicPath -> (строка)

Динамический путь к внешним параметрам документа AWS Systems Manager.

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

Если true, Cutover не будет включён, если документ завершился неудачно.

parameters -> (карта)

Параметры документа AWS Systems Manager.

key -> (строка)

value -> (список)

(структура)

Параметр хранилища параметров AWS Systems Manager.

parameterName -> (строка)

Имя параметра хранилища параметров AWS Systems Manager.

parameterType -> (строка)

Тип параметра хранилища параметров AWS Systems Manager.

ssmDocumentName -> (строка)

Имя или полный ARN документа AWS Systems Manager.

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

Таймаут в секундах документа AWS Systems Manager.

ssmDocumentType -> (строка)

Тип документа AWS Systems Manager.

ssmAgentDiscoveryDatetime -> (строка)

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

sourceServerID -> (строка)

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

status -> (строка)

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

tags -> (карта)

Теги, связанные с конкретным заданием.

key -> (строка)

value -> (строка)

type -> (строка)

Тип задания.

nextToken -> (строка)

Запрос на ответ задания с помощью следующего токена.

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

Spec-Zone.ru

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