start-workflow-execution
Описание
Запускает выполнение типа потока работ в указанном домене, используя предоставленные workflowId и входные данные.
Этот действие возвращает только что запущенное выполнение потока работ.
Вы можете использовать политики IAM для управления доступом к этому действию к ресурсам Amazon SWF следующим образом:
- Используйте элемент
Resourceс именем домена, чтобы ограничить действие только указанными доменами. - Используйте элемент
Action, чтобы разрешить или запретить разрешение на вызов этого действия. - Ограничьте следующие параметры с помощью элемента
Conditionс соответствующими ключами.-
tagList.member.0: Ключ -swf:tagList.member.0. -
tagList.member.1: Ключ -swf:tagList.member.1. -
tagList.member.2: Ключ -swf:tagList.member.2. -
tagList.member.3: Ключ -swf:tagList.member.3. -
tagList.member.4: Ключ -swf:tagList.member.4. -
taskList: Ограничение строки. Ключ -swf:taskList.name. -
workflowType.name: Ограничение строки. Ключ -swf:workflowType.name. -
workflowType.version: Ограничение строки. Ключ -swf:workflowType.version.
-
Если у вызывающего лица недостаточно разрешений для вызова действия или значения параметров выходят за пределы указанных ограничений, действие завершается неудачно. Соответствующий атрибут события параметр cause устанавливается в значение OPERATION_NOT_PERMITTED . Подробнее и примеры политик IAM см. в разделе Использование IAM для управления доступом к потокам работ Amazon SWF в руководстве разработчика Amazon SWF.
См. также: Документация API AWS
Синтаксис
start-workflow-execution
--domain <value>
--workflow-id <value>
--workflow-type <value>
[--task-list <value>]
[--task-priority <value>]
[--input <value>]
[--execution-start-to-close-timeout <value>]
[--tag-list <value>]
[--task-start-to-close-timeout <value>]
[--child-policy <value>]
[--lambda-role <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 (строка)
Имя домена, в котором создается выполнение потока работ.
Указанная строка не должна содержать : (двоеточие), / (слеш), | (вертикальная черта) или какие-либо управляющие символы (\u0000-\u001f | \u007f-\u009f ). Также она не должна быть литеральной строкой arn .
--workflow-id (строка)
Пользовательский идентификатор, связанный с выполнением потока работ. Вы можете использовать его для связывания пользовательского идентификатора с выполнением потока работ. Вы можете указать тот же идентификатор, если выполнение потока работ логически является *повторным запуском* предыдущего выполнения. Вы не можете одновременно иметь два открытых выполнения потока работ с одним и тем же workflowId в одном и том же домене.
Указанная строка не должна содержать : (двоеточие), / (слеш), | (вертикальная черта) или какие-либо управляющие символы (\u0000-\u001f | \u007f-\u009f ). Также она не должна быть литеральной строкой arn .
--workflow-type (структура)
Тип потока работ для запуска.
name -> (строка)
Имя типа потока работ.
Примечание
Сочетание имени и версии типа потока работ должно быть уникальным в рамках домена.version -> (строка)
Версия типа потока работ.
Примечание
Сочетание имени и версии типа потока работ должно быть уникальным в рамках домена.Сокращенная запись:
name=string,version=string
Синтаксис JSON:
{
"name": "string",
"version": "string"
}
--task-list (структура)
Список задач для использования при создании задач принятия решений для этого выполнения потока работ. Это переопределяет defaultTaskList, указанный при регистрации типа потока работ.
Примечание
Список задач для этого выполнения потока работ должен быть указан либо по умолчанию для типа потока работ, либо через этот параметр. Если ни этот параметр не задан, ни список задач по умолчанию не был указан при регистрации, то возвращается ошибка.Указанная строка не должна содержать : (двоеточие), / (слеш), | (вертикальная черта) или какие-либо управляющие символы (\u0000-\u001f | \u007f-\u009f ). Также она не должна быть литеральной строкой arn .
name -> (строка)
Сокращенная запись:
name=string
Синтаксис JSON:
{
"name": "string"
}
--task-priority (строка)
Приоритет задачи для этого выполнения потока работ. Это переопределяет любой приоритет по умолчанию, назначенный при регистрации типа потока работ. Если не задано, используется приоритет задачи по умолчанию для типа потока работ. Допустимые значения — целые числа, которые варьируются от Integer.MIN_VALUE (-2147483648) до Integer.MAX_VALUE (2147483647). Более высокие числа указывают более высокий приоритет.
Дополнительную информацию о настройке приоритета задач см. в руководстве разработчика Amazon SWF.
--input (строка)
input доступны для нового выполнения потока работ в событии истории WorkflowExecutionStarted.--execution-start-to-close-timeout (строка)
Общее время выполнения для этого выполнения потока работ. Это переопределяет заданное по умолчанию время ожидания от начала до завершения выполнения, указанное при регистрации типа потока работ.
Время указывается в секундах; целое число, большее или равное 0 . Превышение этого лимита приводит к таймауту выполнения потока работ. В отличие от некоторых других параметров таймаута в Amazon SWF, вы не можете указать значение «NONE» для этого таймаута; максимальное время выполнения потока работ составляет один год.
Примечание
Время ожидания от начала до завершения выполнения должно быть указано либо через этот параметр, либо по умолчанию при регистрации типа потока работ. Если ни этот параметр, ни время ожидания по умолчанию не заданы, возвращается ошибка.--tag-list (список)
Список тегов для присвоения выполнению потока работ. Вы можете указать не более 5 тегов. Вы можете перечислить выполнения потоков работ со специфическим тегом, вызвав ListOpenWorkflowExecutions или ListClosedWorkflowExecutions и указав TagFilter.
(строка)
Синтаксис:
"string" "string" ...
--task-start-to-close-timeout (строка)
Устанавливает максимальную продолжительность задач принятия решений для этого выполнения потока работ. Этот параметр переопределяет defaultTaskStartToCloseTimout, указанный при регистрации типа потока работ с помощью RegisterWorkflowType.
Продолжительность указывается в секундах, целое число, большее или равное 0 . Вы можете использовать NONE для указания неограниченной продолжительности.
Примечание
Время ожидания от начала до завершения задачи должно быть указано либо по умолчанию для типа потока работ, либо с помощью этого параметра. Если ни этот параметр не установлен, ни время ожидания по умолчанию не было указано при регистрации, то возвращается ошибка.--child-policy (строка)
Если установлено, определяет политику, которая будет использоваться для дочерних потоков работ этого выполнения потока работ, если оно будет завершено, явным вызовом действия TerminateWorkflowExecution или из-за истечения таймаута. Эта политика переопределяет политику дочерних элементов по умолчанию, указанную при регистрации типа потока работ с помощью RegisterWorkflowType.
Поддерживаемые политики дочерних элементов:
-
TERMINATE– Дочерние выполнения завершаются. -
REQUEST_CANCEL– Попытка отмены выполняется для каждого дочернего выполнения путем записи событияWorkflowExecutionCancelRequestedв его историю. Зависит от решающего принять соответствующие действия при получении истории выполнения с этим событием. -
ABANDON– Никаких действий не предпринимается. Дочерние выполнения продолжают работать.
Примечание
Политика дочерних элементов для этого выполнения потока работ должна быть указана либо по умолчанию для типа потока работ, либо через этот параметр. Если ни этот параметр не установлен, ни политика дочерних элементов по умолчанию не была указана при регистрации, то возвращается ошибка.Возможные значения:
TERMINATEREQUEST_CANCELABANDON
--lambda-role (строка)
Роль IAM, которая должна быть прикреплена к этому выполнению потока работ.
Примечание
Для выполнения этого типа потока работ необходимы роли IAM для вызова функций Lambda. Если вы не прикрепите роль IAM, любая попытка запланировать задачу Lambda завершается неудачей. Это приводит к событию историиScheduleLambdaFunctionFailed. Дополнительную информацию см. в руководстве разработчика Amazon SWF по адресу https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html.--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 (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.
Вывод
runId -> (string)
© Copyright 2025, Amazon Web Services. Created using Sphinx.