Spec-Zone.ru › AWS CLI v2

[ aws . swf ]

list-closed-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 (Using IAM to Manage Access to Amazon SWF Workflows).

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

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

Синопсис

  list-closed-workflow-executions
--domain <value>
[--start-time-filter <value>]
[--close-time-filter <value>]
[--execution-filter <value>]
[--close-status-filter <value>]
[--type-filter <value>]
[--tag-filter <value>]
[--reverse-order | --no-reverse-order]
[--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 (структура)

При указании исполняемые рабочие потоки включаются в результаты на основе того, попадают ли их временные метки запуска в заданный интервал. Также, если этот параметр указан, возвращаемые результаты упорядочиваются по временным меткам запуска.

Примечание

startTimeFilter и closeTimeFilter взаимоисключающие. Вы должны указать один из них в запросе, но не оба.

oldestDate -> (временная метка)

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

latestDate -> (временная метка)

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

Краткая форма синтаксиса:

oldestDate=timestamp,latestDate=timestamp

Синтаксис JSON:

{
  "oldestDate": timestamp,
  "latestDate": timestamp
}

--close-time-filter (структура)

Если указано, исполняемые рабочие потоки включаются в результаты на основе того, попадают ли их временные метки закрытия в заданный интервал. Также, если этот параметр указан, возвращаемые результаты упорядочиваются по временным меткам закрытия.

Примечание

startTimeFilter и closeTimeFilter взаимоисключающие. Вы должны указать один из них в запросе, но не оба.

oldestDate -> (временная метка)

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

latestDate -> (временная метка)

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

Краткая форма синтаксиса:

oldestDate=timestamp,latestDate=timestamp

Синтаксис JSON:

{
  "oldestDate": timestamp,
  "latestDate": timestamp
}

--execution-filter (структура)

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

Примечание

closeStatusFilter , executionFilter , typeFilter и tagFilter взаимоисключающие. Вы можете указать не более одного из них в запросе.

workflowId -> (строка)

Идентификатор рабочего потока для соответствия критериям фильтра.

Краткая форма синтаксиса:

workflowId=string

Синтаксис JSON:

{
  "workflowId": "string"
}

--close-status-filter (структура)

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

Примечание

closeStatusFilter , executionFilter , typeFilter и tagFilter взаимоисключающие. Вы можете указать не более одного из них в запросе.

status -> (строка)

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

Краткая форма синтаксиса:

status=string

Синтаксис JSON:

{
  "status": "COMPLETED"|"FAILED"|"CANCELED"|"TERMINATED"|"CONTINUED_AS_NEW"|"TIMED_OUT"
}

--type-filter (структура)

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

Примечание

closeStatusFilter , executionFilter , typeFilter и tagFilter взаимоисключающие. Вы можете указать не более одного из них в запросе.

name -> (строка)

Имя типа рабочего потока.

version -> (строка)

Версия типа рабочего потока.

Краткая форма синтаксиса:

name=string,version=string

Синтаксис JSON:

{
  "name": "string",
  "version": "string"
}

--tag-filter (структура)

Если указано, выводятся только исполнения, имеющие соответствующий тег.

Примечание

closeStatusFilter , executionFilter , typeFilter и tagFilter взаимоисключающие. Вы можете указать не более одного из них в запросе.

tag -> (строка)

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

Теги могут содержать только буквы, цифры, пробелы или следующие символы: _ . : / = + - @ .

Краткая форма синтаксиса:

tag=string

Синтаксис JSON:

{
  "tag": "string"
}

--reverse-order | --no-reverse-order (логическое значение)

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

--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 (boolean)

Включить отладку логирования.

--endpoint-url (string)

Переопределить стандартный URL команды указанным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверяет сертификаты SSL. Этот параметр переопределяет поведение по умолчанию проверки сертификатов SSL.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет настройки из конфигурации/окружения.

--version (string)

Отобразить версию этого инструмента.

--color (string)

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

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Файл с сертификатами CA для проверки SSL-сертификатов. Переопределяет настройки из конфигурации/окружения.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и без таймаута. Значение по умолчанию 60 секунд.

--cli-binary-format (string)

Стиль форматирования для бинарных блоков. По умолчанию формат 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 (boolean)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

executionInfos -> (список)

Список структур с информацией о выполнении рабочих процессов.

(структура)

Содержит информацию о выполнении рабочего процесса.

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

Выполнение рабочего процесса, о котором идет речь.

workflowId -> (строка)

Пользовательский идентификатор, связанный с выполнением рабочего процесса.

runId -> (строка)

Уникальный системный идентификатор выполнения рабочего процесса.

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

Тип выполнения рабочего процесса.

name -> (строка)

Название типа рабочего процесса.

Примечание

Комбинация имени типа рабочего процесса и версии должна быть уникальной в рамках домена.

version -> (строка)

Версия типа рабочего процесса.

Примечание

Комбинация имени типа рабочего процесса и версии должна быть уникальной в рамках домена.

startTimestamp -> (временная метка)

Время начала выполнения.

closeTimestamp -> (временная метка)

Время закрытия выполнения рабочего процесса. Устанавливается только если статус выполнения CLOSED.

executionStatus -> (строка)

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

closeStatus -> (строка)

Если статус выполнения закрыт, это указывает, как выполнение было закрыто:

  • COMPLETED – выполнение успешно завершено.
  • CANCELED – выполнение было отменено. Отмена позволяет реализации корректно завершить работу перед закрытием выполнения.
  • TERMINATED – выполнение было принудительно завершено.
  • FAILED – выполнение не удалось завершить.
  • TIMED_OUT – выполнение не завершилось в отведенное время и было автоматически завершено по таймауту.
  • CONTINUED_AS_NEW – выполнение логически продолжено. Это означает, что текущее выполнение завершилось, и было начато новое выполнение для продолжения рабочего процесса.

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

Если выполнение рабочего процесса является дочерним по отношению к другому выполнению, содержит выполнение рабочего процесса, которое инициировало данное выполнение.

workflowId -> (строка)

Пользовательский идентификатор, связанный с выполнением рабочего процесса.

runId -> (строка)

Уникальный системный идентификатор выполнения рабочего процесса.

tagList -> (список)

Список тегов, связанных с выполнением рабочего процесса. Теги могут использоваться для идентификации и перечисления интересующих выполнений рабочих процессов через API видимости. Выполнение рабочего процесса может иметь не более 5 тегов.

(строка)

cancelRequested -> (boolean)

Устанавливается в true, если для данного выполнения рабочего процесса запрошена отмена.

nextPageToken -> (строка)

Если в результате предыдущего вызова был возвращен NextPageToken, то есть больше результатов. Чтобы получить следующую страницу результатов, выполните вызов снова, используя возвращённый токен в nextPageToken. Все остальные аргументы остаются неизменными.

Настроенное maximumPageSize определяет, сколько результатов может быть возвращено в одном вызове.

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

Spec-Zone.ru

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