Spec-Zone.ru › AWS CLI v2

[ aws . swf ]

describe-workflow-execution

Описание

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

Примечание

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

Контроль доступа

Вы можете использовать политики IAM для управления доступом к этому действию к ресурсам Amazon SWF следующим образом:

  • Используйте элемент Resource с именем домена, чтобы ограничить действие только указанными доменам.
  • Используйте элемент Action для разрешения или запрета разрешения на вызов этого действия.
  • Вы не можете использовать политику IAM для ограничения параметров этого действия.

Если у вызывающего лица недостаточно разрешений для вызова действия или значения параметров выходят за пределы заданных ограничений, действие завершается неудачно. Соответствующий атрибут события cause устанавливается в значение OPERATION_NOT_PERMITTED . Более подробная информация и примеры политик IAM приведены в разделе Использование IAM для управления доступом к потокам работ Amazon SWF в руководстве разработчика Amazon SWF.

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

Синтаксис

  describe-workflow-execution
--domain <value>
--execution <value>
[--cli-input-json | --cli-input-yaml]
[--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 (строка)

Имя домена, содержащего исполнение потока работ.

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

Исполнение потока работ, которое нужно описать.

workflowId -> (строка)

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

runId -> (строка)

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

Сокращенный синтаксис:

workflowId=string,runId=string

Синтаксис JSON:

{
  "workflowId": "string",
  "runId": "string"
}

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

--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-auto-prompt (логическое значение)

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

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

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

Вывод

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

Информация об исполнении рабочего процесса.

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 -> (булево значение)

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

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

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

taskStartToCloseTimeout -> (строка)

Максимальная продолжительность задач принятия решений для этого исполнения рабочего процесса.

Продолжительность указана в секундах, целое число, больше или равно 0. Можно использовать NONE, чтобы указать неограниченную продолжительность.

executionStartToCloseTimeout -> (строка)

Общее время для этого исполнения рабочего процесса.

Продолжительность указана в секундах, целое число, больше или равно 0. Можно использовать NONE, чтобы указать неограниченную продолжительность.

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

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

name -> (строка)

Имя списка задач.

taskPriority -> (строка)

Приоритет, назначенный задачам принятия решений для этого исполнения рабочего процесса. Допустимые значения — целые числа, которые варьируются от Integer.MIN_VALUE (-2147483648) до Integer.MAX_VALUE (2147483647). Более высокие числа указывают более высокий приоритет.

Дополнительную информацию о настройке приоритета задач см. в разделе «Настройка приоритета задач» в Руководстве разработчика Amazon SWF.

childPolicy -> (строка)

Политика, используемая для дочерних исполнений рабочего процесса, если это исполнение рабочего процесса завершается явным вызовом действия TerminateWorkflowExecution или из-за истечения таймаута.

Поддерживаемые политики для дочерних процессов:

  • TERMINATE – дочерние исполнения завершаются.
  • REQUEST_CANCEL – для каждого дочернего исполнения предпринимается попытка отмены, занося в его историю событие WorkflowExecutionCancelRequested. Решающему агенту необходимо предпринять соответствующие действия при получении истории исполнения с этим событием.
  • ABANDON – никаких действий не предпринимается. Дочерние исполнения продолжают выполняться.

lambdaRole -> (строка)

Роль IAM, прикрепленная к дочернему исполнению рабочего процесса.

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

Количество задач для этого исполнения рабочего процесса. Включает открытые и закрытые задачи всех типов.

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

Количество задач активности, статус которых — OPEN.

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

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

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

Количество таймеров, запущенных этим исполнением рабочего процесса, которые еще не сработали.

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

Количество дочерних исполнений рабочего процесса, статус которых — OPEN.

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

Количество задач Lambda, статус которых — OPEN.

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

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

latestExecutionContext -> (строка)

Последний executionContext, предоставленный решающим агентом для этого исполнения рабочего процесса. Решающий агент может предоставить executionContext (строка произвольного формата) при закрытии задачи принятия решений с помощью RespondDecisionTaskCompleted.

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

Spec-Zone.ru

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