Spec-Zone.ru › AWS CLI v2

[ aws . deadline ]

list-steps

Описание

Отображает шаги для задачи.

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

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

Синтаксис

  list-steps
--farm-id <value>
--queue-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]

Параметры

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

Идентификатор фермы, который следует включить в список шагов.

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

Идентификатор очереди, который следует включить в список шагов.

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

Идентификатор задачи, который следует включить в список шагов.

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

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

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

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя командной строки AWS.

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

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

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя командной строки AWS.

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

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

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя командной строки AWS.

--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 (булево)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запросы параметров ввода CLI.

Вывод

steps -> (список)

Шаги в списке.

(структура)

Подробная информация о шаге.

stepId -> (строка)

Идентификатор шага.

name -> (строка)

Название шага.

lifecycleStatus -> (строка)

Статус жизненного цикла.

lifecycleStatusMessage -> (строка)

Сообщение, описывающее жизненный цикл шага.

taskRunStatus -> (строка)

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

  • PENDING — ожидающий и ждёт ресурсов.
  • READY — готов к обработке.
  • ASSIGNED — назначен и будет выполняться следующим на рабочем узле.
  • SCHEDULED — запланирован для запуска на рабочем узле.
  • INTERRUPTING — прерывается.
  • RUNNING — выполняется на рабочем узле.
  • SUSPENDED — задача приостановлена.
  • CANCELED — задача отменена.
  • FAILED — задача завершилась неудачно.
  • SUCCEEDED — задача завершилась успешно.

taskRunStatusCounts -> (словарь)

Количество задач, выполняемых в рамках задачи.

key -> (строка)

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

targetTaskRunStatus -> (строка)

Статус задачи, с которого следует начать задачу.

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

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

createdBy -> (строка)

Пользователь или система, создавшие этот ресурс.

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

Дата и время обновления ресурса.

updatedBy -> (строка)

Пользователь или система, обновившие этот ресурс.

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

Дата и время запуска ресурса.

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

Дата и время завершения работы ресурса.

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

Количество зависимостей для шага.

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

Количество разрешенных зависимостей.

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

Количество неразрешённых зависимостей.

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

Количество обработчиков, которые были разрешены.

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

Количество неразрешённых обработчиков.

nextToken -> (строка)

Если Deadline Cloud возвращает nextToken, значит, доступны дополнительные результаты. Значение nextToken — уникальный маркер постраничной обработки для каждой страницы. Для получения следующей страницы вызовите операцию снова, используя возвращённый маркер. Не изменяйте другие аргументы. Если результатов больше нет, то nextToken устанавливается в null. Каждый маркер постраничной обработки истекает через 24 часа. Если вы укажете недействительный маркер, будет получена ошибка HTTP 400 ValidationException.

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

Spec-Zone.ru

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