list-open-workflow-executions
Описание
Возвращает список открытых исполнений рабочих процессов в указанном домене, соответствующих критериям фильтрации. Результаты могут быть разделены на несколько страниц. Чтобы получить последующие страницы, необходимо снова выполнить вызов с использованием параметра nextPageToken, возвращенного в начальном вызове.
Примечание
Управление доступом
Вы можете использовать политики IAM для управления доступом к этому действию к ресурсам Amazon SWF следующим образом:
- Используйте элемент
Resourceс именем домена для ограничения действия только определенными доменам. - Используйте элемент
Actionдля разрешения или запрета доступа к вызову этого действия. - Ограничьте следующие параметры с помощью элемента
Conditionс соответствующими ключами.-
tagFilter.tag: ограничение строки. Ключ -swf:tagFilter.tag. -
typeFilter.name: ограничение строки. Ключ -swf:typeFilter.name. -
typeFilter.version: ограничение строки. Ключ -swf:typeFilter.version.
-
Если у вызывающего лица недостаточно прав для вызова действия или значения параметров выходят за пределы указанных ограничений, действие завершается сбоем. Соответствующий параметр атрибута события cause устанавливается в значение OPERATION_NOT_PERMITTED . Дополнительные сведения и примеры политик IAM см. в руководстве разработчика Amazon SWF по управлению доступом с помощью IAM.
См. также: Документация API AWS
list-open-workflow-executions — это операция с постраничным выводом. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлекать данные из результатов следующих выражений запроса: executionInfos
Синтаксис
list-open-workflow-executions
--domain <value>
--start-time-filter <value>
[--type-filter <value>]
[--tag-filter <value>]
[--reverse-order | --no-reverse-order]
[--execution-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]
Параметры
--domain (строка)
--start-time-filter (структура)
Исполнения рабочих процессов включаются в возвращаемые результаты в зависимости от того, находятся ли их начальные времена в диапазоне, заданном этим фильтром.
oldestDate -> (отметка времени)
latestDate -> (отметка времени)
Сокращенный синтаксис:
oldestDate=timestamp,latestDate=timestamp
Синтаксис JSON:
{
"oldestDate": timestamp,
"latestDate": timestamp
}
--type-filter (структура)
Если задано, возвращаются только исполнения указанного типа.
Примечание
executionFilter , typeFilter и tagFilter взаимоисключающие. Вы можете указать не более одного из них в запросе.name -> (строка)
version -> (строка)
Сокращенный синтаксис:
name=string,version=string
Синтаксис JSON:
{
"name": "string",
"version": "string"
}
--tag-filter (структура)
Если задано, перечисляются только исполнения с соответствующей меткой.
Примечание
executionFilter , typeFilter и tagFilter взаимоисключающие. Вы можете указать не более одного из них в запросе.tag -> (строка)
Указывает метку, которая должна быть связана с исполнением, чтобы оно соответствовало критериям фильтра.
Метки могут содержать только буквы, цифры, пробелы или следующие символы: _ . : / = + - @ .
Сокращенный синтаксис:
tag=string
Синтаксис JSON:
{
"tag": "string"
}
--reverse-order | --no-reverse-order (логическое значение)
true, результаты возвращаются в обратном порядке. По умолчанию результаты возвращаются в порядке убывания времени начала исполнений.--execution-filter (структура)
Если задано, возвращаются только исполнения рабочих процессов, соответствующие указанному идентификатору рабочего процесса.
Примечание
executionFilter , typeFilter и tagFilter взаимоисключающие. Вы можете указать не более одного из них в запросе.workflowId -> (строка)
Сокращенный синтаксис:
workflowId=string
Синтаксис JSON:
{
"workflowId": "string"
}
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, заданному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные в формате JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания места начала постраничного вывода. Это NextToken из ранее усеченного ответа.
Примеры использования см. в разделе Постраничный вывод в Руководстве пользователя AWS CLI.
--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.
Вывод
executionInfos -> (список)
Список структур информации о рабочем процессе.
(структура)
Содержит информацию об исполнении рабочего процесса.
execution -> (структура)
Исполнение рабочего процесса, к которому относится эта информация.
workflowId -> (строка)
runId -> (строка)
workflowType -> (структура)
Тип исполнения рабочего процесса.
name -> (строка)
Имя типа рабочего процесса.
Примечание
Комбинация имени и версии типа рабочего процесса должна быть уникальной в рамках домена.version -> (строка)
Версия типа рабочего процесса.
Примечание
Комбинация имени и версии типа рабочего процесса должна быть уникальной в рамках домена.startTimestamp -> (метка времени)
closeTimestamp -> (метка времени)
executionStatus -> (строка)
closeStatus -> (строка)
Если статус исполнения – закрыт, то это указывает, как было закрыто исполнение:
-
COMPLETED– исполнение успешно завершено. -
CANCELED– исполнение отменено. Отмена позволяет реализации корректно завершить работу перед закрытием исполнения. -
TERMINATED– исполнение принудительно завершено. -
FAILED– исполнение не удалось завершить. -
TIMED_OUT– исполнение не завершилось в отведенное время и было автоматически прервано по таймауту. -
CONTINUED_AS_NEW– исполнение логически продолжено. Это означает, что текущее исполнение завершено, и новое исполнение было начато для продолжения рабочего процесса.
parent -> (структура)
Если данное исполнение рабочего процесса является дочерним по отношению к другому исполнению, то содержит исполнение рабочего процесса, которое инициировало это исполнение.
workflowId -> (строка)
runId -> (строка)
tagList -> (список)
Список тегов, связанных с исполнением рабочего процесса. Теги могут использоваться для идентификации и перечисления исполнений рабочих процессов, представляющих интерес, через API видимости. Исполнение рабочего процесса может содержать не более 5 тегов.
(строка)
cancelRequested -> (булево)
nextPageToken -> (строка)
Если в предыдущем вызове был возвращён NextPageToken, то доступны дополнительные результаты. Чтобы получить следующую страницу результатов, выполните вызов снова, используя возвращённый токен в nextPageToken. Все остальные аргументы остаются неизменными.
Настроенный maximumPageSize определяет, сколько результатов может быть возвращено в одном вызове.
© Copyright 2025, Amazon Web Services. Created using Sphinx.