[ aws . stepfunctions ]
validate-state-machine-definition
Описание
Проверяет синтаксис определения машины состояний, указанного на языке Amazon States Language (ASL), структурированном языке на основе JSON.
Вы можете проверить, что определение машины состояний верно, не создавая ресурс машины состояний.
Предлагаемое использование для ValidateStateMachineDefinition :
- Интегрируйте автоматические проверки в свой процесс проверки кода или непрерывной интеграции (CI), чтобы проверить определения машины состояний перед началом развертывания.
- Запустите валидацию из хука Git pre-commit, чтобы проверить определение перед добавлением в вашу репозиторий исходного кода.
Проверка будет искать проблемы в определении вашей машины состояний и возвращать результат и список элементов диагностики.
Значение результата будет OK, когда определение вашего рабочего процесса может быть успешно создано или обновлено. Обратите внимание, что результат может быть OK, даже если в ответе присутствуют диагностические предупреждения. Значение результата будет FAIL, когда определение рабочего процесса содержит ошибки, которые помешают вам создать или обновить вашу машину состояний.
Список элементов данных ValidateStateMachineDefinitionDiagnostic может содержать ноль или более элементов ПРЕДУПРЕЖДЕНИЕ и/или ОШИБКА.
Примечание
API ValidateStateMachineDefinition может добавить новые диагностические сведения в будущем, скорректировать коды диагностики или изменить формулировку сообщений. Ваши автоматизированные процессы должны полагаться только на значение поля результат (OK, FAIL). Не полагайтесь на точный порядок, количество или формулировки диагностических сообщений.См. также: Документация API AWS
Синтаксис
validate-state-machine-definition
--definition <value>
[--type <value>]
[--severity <value>]
[--max-results <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]
Параметры
--definition (строка)
--type (строка)
Тип целевой машины состояний для этого определения. По умолчанию — STANDARD.
Возможные значения:
STANDARDEXPRESS
--severity (строка)
Минимальный уровень диагностики для возврата. ERROR возвращает только ERROR диагностики, в то время как WARNING возвращает как WARNING, так и ERROR диагностики. По умолчанию — ERROR.
Возможные значения:
ERRORWARNING
--max-results (целое число)
Максимальное количество диагностических данных, возвращаемых за один вызов. По умолчанию и максимальное значение — 100. Установка значения в 0 также использует значение по умолчанию 100.
Если количество диагностических данных в ответе превышает maxResults, значение поля truncated в ответе будет установлено в true.
--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.
Вывод
result -> (строка)
OK, когда не обнаружено синтаксических ошибок, или FAIL, если определение рабочего процесса не прошло проверку.diagnostics -> (список)
Массив диагностических ошибок и предупреждений, обнаруженных во время проверки определения машины состояний. Поскольку предупреждения не препятствуют развертыванию определения вашего рабочего процесса, значение результата может быть OK, даже если в ответе присутствуют диагностические предупреждения.
(структура)
Описывает возможные проблемы, обнаруженные во время проверки машины состояний. Вместо повышения исключения, проверка вернет список элементов диагностики, содержащих диагностическую информацию.
Примечание
Список кодов предупреждений
Нет .$ в поле, которое, похоже, является JSONPath или внутренней функцией.
Значение поля выглядит как путь, но имя поля не заканчивается на «Path».
Попытка использовать путь в результате состояния прохода.
Список кодов ошибок
Найдена проблема синтаксиса JSON.
Получен пустой или нулевой входной параметр рабочего процесса.
Проверка схемы сообщила об ошибках.
Значение поля ресурса состояния задачи недействительно.
Рабочий процесс не имеет конечного состояния.
Одно и то же имя состояния появляется более одного раза.
Имя состояния не соответствует соглашению об именовании.
Имя машины состояний не указано.
Имя машины состояний не соответствует соглашению об именовании.
Имя состояния превышает допустимую длину.
Имя состояния уже существует.
Имя метки появляется более одного раза.
Вы предоставили недопустимое имя метки.
Значение поля «Next» не совпадает с известным именем состояния.
Состояния слишком глубоко вложены.
severity -> (строка)
Значение ERROR означает, что вы не можете создать или обновить машину состояний с этим определением.
WARNING уровень диагностических сообщений предупреждает вас о потенциальных проблемах, но они не помешают вам создать или обновить вашу машину состояний.code -> (строка)
message -> (строка)
location -> (строка)
Расположение проблемы в машине состояний, если доступно.
Для ошибок, специфичных для поля, расположение может иметь формат: /States/<StateName>/<FieldName>, например: /States/FailState/ErrorPath.
truncated -> (булево)
true, если количество диагностических данных, обнаруженных в определении рабочего процесса, превышает maxResults. Когда все результаты диагностики возвращаются, значение будет false.
© Copyright 2025, Amazon Web Services. Created using Sphinx.