Spec-Zone.ru › AWS CLI v2

[ aws . stepfunctions ]

start-execution

Описание

Запускает выполнение машины состояний.

Квалифицированный ARN машины состояний может ссылаться на состояние распределённой карты, определённое внутри машины состояний, на ARN версии или на ARN псевдонима.

Ниже приведены примеры квалифицированных и неквалифицированных ARN машин состояний:

  • Следующий квалифицированный ARN машины состояний ссылается на состояние распределённой карты с меткой mapStateLabel в машине состояний с именем myStateMachine . arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel

Примечание

Если вы укажете квалифицированный ARN машины состояний, который ссылается на состояние распределённой карты , запрос завершится с ошибкой ValidationException .
  • Следующий квалифицированный ARN машины состояний ссылается на псевдоним с именем PROD . arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>

Примечание

Если вы укажете квалифицированный ARN машины состояний, который ссылается на ARN версии или ARN псевдонима, запрос запустит выполнение для этой версии или псевдонима.
  • Следующий неквалифицированный ARN машины состояний ссылается на машину состояний с именем myStateMachine . arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>

Если вы запускаете выполнение с помощью неквалифицированного ARN машины состояний, Step Functions использует последнюю версию машины состояний для выполнения.

Для запуска выполнений версии машины состояний, вызовите StartExecution и укажите ARN версии или ARN псевдонима, указывающего на версию.

Примечание

StartExecution является идемпотентным для STANDARD рабочих процессов. Для STANDARD рабочего процесса, если вы вызовете StartExecution с тем же именем и вводом, что и работающее выполнение, вызов завершится успешно и вернёт тот же ответ, что и исходный запрос. Если выполнение закрыто или если входные данные отличаются, будет возвращена ошибка 400 ExecutionAlreadyExists. Вы можете повторно использовать имена через 90 дней.

StartExecution не является идемпотентным для EXPRESS рабочих процессов.

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

Краткое описание

  start-execution
--state-machine-arn <value>
[--name <value>]
[--input <value>]
[--trace-header <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]

Параметры

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

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

Параметр stateMachineArn принимает один из следующих входов:

  • Неквалифицированный ARN машины состояний – Ссылается на ARN машины состояний, который не квалифицирован версией или псевдонимом ARN. Следующий пример неквалифицированного ARN машины состояний. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine> Step Functions не связывает выполнения машин состояний, которые вы запускаете с неквалифицированным ARN, с какой-либо версией. Это верно даже в том случае, если эта версия использует ту же ревизию, что и выполнение.
  • ARN версии машины состояний – Ссылается на ARN версии, который представляет собой комбинацию ARN машины состояний и номера версии, разделённых двоеточием (:). Следующий пример ARN для версии 10. arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>:10 Step Functions не связывает выполнения, которые вы запускаете с ARN версии, с какими-либо псевдонимами, указывающими на эту версию.
  • ARN псевдонима машины состояний – Ссылается на ARN псевдонима, который представляет собой комбинацию ARN машины состояний и имени псевдонима, разделённых двоеточием (:). Следующий пример ARN для псевдонима с именем PROD . arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD> Step Functions связывает выполнения, которые вы запускаете с ARN псевдонима, с этим псевдонимом и версией машины состояний, используемой для этого выполнения.

--name (строка)

Необязательное имя выполнения. Это имя должно быть уникальным для вашей учетной записи Amazon Web Services, региона и машины состояний в течение 90 дней. Дополнительную информацию см. в разделе Ограничения, связанные с выполнениями машин состояний, в Руководстве разработчика Step Functions.

Если вы не укажете имя для выполнения, Step Functions автоматически сгенерирует универсальный уникальный идентификатор (UUID) в качестве имени выполнения.

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

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

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

--input (строка)

Строка, содержащая JSON-данные входных данных для выполнения, например:

"input": "{\"first_name\" : \"test\"}"

Примечание

Если вы не включаете какие-либо JSON-данные входных данных, вы всё равно должны включить две фигурные скобки, например: "input": "{}"

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

--trace-header (строка)

Передаёт заголовок трассировки X-Ray. Заголовок трассировки также может быть передан в полезной нагрузке запроса.

--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
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

Отображение версии данного инструмента.

--color (строка)

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

  • вкл
  • выкл
  • авто

--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 (логическое)

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

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

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

Вывод

executionArn -> (строка)

Amazon Resource Name (ARN), идентифицирующий выполнение.

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

Дата запуска выполнения.

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

Spec-Zone.ru

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