Spec-Zone.ru › AWS CLI v2

[ aws . stepfunctions ]

start-sync-execution

Описание

Запускает выполнение синхронной машины состояний Express. StartSyncExecution недоступен для рабочих процессов STANDARD.

Примечание

StartSyncExecution вернёт ответ 200 OK, даже если выполнение завершилось ошибкой, потому что код состояния в ответе API не отражает ошибки функции. Коды ошибок предназначены для ошибок, которые препятствуют запуску выполнения, таких как ошибки разрешений, ошибки лимитов или проблемы с кодом и конфигурацией вашей машины состояний.

Примечание

Данное действие API не регистрируется в CloudTrail.

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

Синтаксис

  start-sync-execution
--state-machine-arn <value>
[--name <value>]
[--input <value>]
[--trace-header <value>]
[--included-data <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) машины состояний для выполнения.

--name (строка)

Имя выполнения.

--input (строка)

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

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

Примечание

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

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

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

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

--included-data (строка)

Если определение вашей машины состояний зашифровано с помощью ключа KMS, вызывающие стороны должны иметь разрешение kms:Decrypt для расшифровки определения. В качестве альтернативы, вы можете вызвать API с includedData = METADATA_ONLY, чтобы получить успешный ответ без зашифрованного определения.

Возможные значения:

  • ALL_DATA
  • METADATA_ONLY

--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.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

executionArn -> (строка)

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

stateMachineArn -> (строка)

Amazon Resource Name (ARN), идентифицирующий машину состояний.

name -> (строка)

Имя выполнения.

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

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

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

Если выполнение уже завершилось, дата остановки выполнения.

status -> (строка)

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

error -> (строка)

Код ошибки сбоя.

cause -> (строка)

Более подробное объяснение причины сбоя.

input -> (строка)

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

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

Предоставляет подробности о входных или выходных данных выполнения.

included -> (булево)

Указывает, были ли входные или выходные данные включены в ответ. Всегда true для вызовов API.

output -> (строка)

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

Примечание

Это поле устанавливается только в случае успешного выполнения. Если выполнение завершилось ошибкой, это поле равно null.

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

Предоставляет подробности о входных или выходных данных выполнения.

included -> (булево)

Указывает, были ли входные или выходные данные включены в ответ. Всегда true для вызовов API.

traceHeader -> (строка)

Заголовок отслеживания X-Ray, переданный выполнению.

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

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

billedMemoryUsedInMB -> (длинное целое число)

Фактическое использование памяти вашим рабочим процессом в МБ.

billedDurationInMilliseconds -> (длинное целое число)

Фактическое время выполнения вашего рабочего процесса в миллисекундах.

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

Spec-Zone.ru

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