Spec-Zone.ru › AWS CLI v2

[ aws . stepfunctions ]

list-executions

Описание

Перечисляет все выполнения машины состояний или выполнения Map Run. Вы можете перечислить все выполнения, связанные с машиной состояний, указав Amazon Resource Name (ARN) машины состояний, или связанные с Map Run, указав ARN Map Run. Используя этот API-действия, вы также можете перечислить все повторно запущенные выполнения.

Вы также можете указать ARN псевдонима машины состояний или ARN версии, чтобы перечислить выполнения, связанные с определённым псевдонимом или версией.

Результаты сортируются по времени, причём последнее выполнение идёт первым.

Если возвращается nextToken, доступны дополнительные результаты. Значение nextToken — уникальный маркер постраничной навигации для каждой страницы. Повторите вызов, используя возвращённый маркер, чтобы получить следующую страницу. Все остальные аргументы остаются неизменными. Каждый маркер постраничной навигации истекает через 24 часа. Использование истекшего маркера постраничной навигации вернёт ошибку HTTP 400 InvalidToken.

Примечание

Данная операция имеет конечную согласованность. Результаты являются приблизительными и могут не отражать совсем недавние обновления и изменения.

Это API-действие не поддерживается машинами состояний EXPRESS.

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

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

Синтаксис

  list-executions
[--state-machine-arn <value>]
[--status-filter <value>]
[--map-run-arn <value>]
[--redrive-filter <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]

Параметры

--state-machine-arn (строка)

Amazon Resource Name (ARN) машины состояний, чьи выполнения перечисляются.

Вы можете указать либо mapRunArn, либо stateMachineArn, но не оба.

Вы также можете вернуть список выполнений, связанных с определённым псевдонимом или версией, указав ARN псевдонима или ARN версии в параметре stateMachineArn.

--status-filter (строка)

Если указано, перечисляются только выполнения, статус которых соответствует заданному фильтру.

Возможные значения:

  • RUNNING
  • SUCCEEDED
  • FAILED
  • TIMED_OUT
  • ABORTED
  • PENDING_REDRIVE

--map-run-arn (строка)

Amazon Resource Name (ARN) Map Run, который запустил дочерние выполнения рабочего процесса. Если указано поле mapRunArn, возвращается список всех дочерних выполнений рабочего процесса, запущенных Map Run. Подробнее см. в разделе «Просмотр Map Run» в руководстве разработчика Step Functions.

Вы можете указать либо mapRunArn, либо stateMachineArn, но не оба.

--redrive-filter (строка)

Устанавливает фильтр для перечисления выполнений на основе того, были ли они повторно запущены.

Для распределённого Map, redriveFilter устанавливает фильтр для перечисления дочерних выполнений рабочего процесса на основе того, были ли они повторно запущены.

Если вы не предоставите redriveFilter, Step Functions вернёт список как повторно запущенных, так и не повторно запущенных выполнений.

Если вы предоставите ARN машины состояний в redriveFilter, API вернёт исключение проверки.

Возможные значения:

  • REDRIVEN
  • NOT_REDRIVEN

--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 для вывода.

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

executions -> (список)

Список соответствующих исполнений.

(структура)

Содержит данные об исполнении.

executionArn -> (строка)

Идентификатор Amazon Resource Name (ARN) исполнения.

stateMachineArn -> (строка)

Идентификатор Amazon Resource Name (ARN) машины состояний, которая выполнила исполнение.

name -> (строка)

Имя исполнения.

Имя не должно содержать:

  • пробелы
  • скобки < > { } [ ]
  • символы подстановки ? *
  • специальные символы " # % \ ^ | ~ ` $ & , ; : /
  • управляющие символы (U+0000-001F , U+007F-009F )

Для включения ведения журнала с CloudWatch Logs имя должно содержать только 0-9, A-Z, a-z, -, и _.

status -> (строка)

Текущий статус исполнения.

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

Дата начала исполнения.

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

Если исполнение уже завершено, дата его завершения.

mapRunArn -> (строка)

Идентификатор Amazon Resource Name (ARN) выполнения Map. Это поле возвращается только если mapRunArn было указано в действии API ListExecutions. Если stateMachineArn было указано в ListExecutions, поле mapRunArn не возвращается.

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

Общее количество обработанных элементов в исполнении дочернего рабочего процесса. Это поле возвращается только если mapRunArn было указано в действии API ListExecutions. Если stateMachineArn было указано в ListExecutions, поле itemCount не возвращается.

stateMachineVersionArn -> (строка)

Идентификатор Amazon Resource Name (ARN) версии машины состояний, связанной с исполнением.

Если выполнение машины состояний было начато с неопределённым ARN, возвращается null.

Если выполнение было начато с помощью stateMachineAliasArn, оба параметра stateMachineAliasArn и stateMachineVersionArn содержат соответствующие значения.

stateMachineAliasArn -> (строка)

Идентификатор Amazon Resource Name (ARN) псевдонима машины состояний, используемого для запуска исполнения.

Если выполнение машины состояний было начато с неопределённым ARN или ARN версии, возвращается null.

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

Количество раз, когда вы перезапустили исполнение. Если исполнение ещё не перезапускалось, значение redriveCount равно 0. Это значение обновляется только при успешном перезапуске исполнения.

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

Дата последнего перезапуска исполнения.

nextToken -> (строка)

Если возвращается nextToken, доступны дополнительные результаты. Значение nextToken представляет собой уникальный маркер постраничной навигации для каждой страницы. Повторите вызов, используя возвращённый маркер, чтобы получить следующую страницу. Все остальные аргументы остаются неизменными. Каждый маркер постраничной навигации действует в течение 24 часов. Использование истекшего маркера постраничной навигации вернёт ошибку HTTP 400 InvalidToken.

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

Spec-Zone.ru

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