test-state

Описание

Принимает определение отдельного состояния и выполняет его. Вы можете протестировать состояние, не создавая машину состояний или не обновляя существующую машину состояний. С помощью этого API вы можете протестировать следующее:

Поток обработки данных входных и выходных данных состояния
Запрос и ответ интеграции с сервисом Amazon Web Services
Запрос и ответ задачи HTTP

Вы можете вызывать этот API только для одного состояния за раз. Состояния, которые можно протестировать, включают:

Все типы задач, кроме Activity
Pass
Wait
Choice
Succeed
Fail

API TestState предполагает роль IAM, которая должна содержать необходимые разрешения IAM для ресурсов, к которым обращается ваше состояние. Сведения о разрешениях, которые может потребовать состояние, см. в разделе Разрешения IAM для тестирования состояния.

API TestState может выполняться до пяти минут. Если выполнение состояния превысит этот срок, оно завершается ошибкой States.Timeout.

TestState не поддерживает задачи Activity, .sync или .waitForTaskToken шаблоны интеграции сервисов, состояния Parallel или Map.

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

Синтаксис

  test-state
--definition <value>
[--role-arn <value>]
[--input <value>]
[--inspection-level <value>]
[--reveal-secrets | --no-reveal-secrets]
[--variables <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 (строка)

Определение состояния на языке Amazon States Language (ASL).

--role-arn (строка)

Идентификатор ресурса (ARN) роли выполнения с необходимыми разрешениями IAM для состояния.

--input (строка)

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

--inspection-level (строка)

Определяет значения, которые нужно вернуть при тестировании состояния. Вы можете указать один из следующих типов:

INFO : Показывает итоговый выход состояния. По умолчанию Step Functions устанавливает inspectionLevel на значение INFO, если вы не указываете уровень.
DEBUG : Показывает итоговый выход состояния вместе с результатом обработки входных и выходных данных.
TRACE : Показывает запрос и ответ HTTP для задачи HTTP. Этот уровень также показывает итоговый выход состояния вместе с результатом обработки входных и выходных данных.

Каждый из этих уровней также предоставляет информацию о статусе выполнения состояния и о следующей стадии перехода.

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

INFO
DEBUG
TRACE

--reveal-secrets | --no-reveal-secrets (логическое значение)

Указывает, включать ли секретную информацию в результаты теста. Для задач HTTP секрет включает данные, которые соединение EventBridge добавляет для изменения заголовков HTTP-запроса, параметров запроса и тела. Step Functions не пропускает никакую информацию, включенную в определение состояния или HTTP-ответ.

Если вы установите revealSecrets в значение true, вы должны убедиться, что пользователь IAM, который вызывает API TestState, имеет разрешение на действие states:RevealSecrets. Пример политики IAM, которая устанавливает разрешение states:RevealSecrets, см. в разделе Разрешения IAM для тестирования состояния. Без этого разрешения Step Functions возвращает ошибку отказа в доступе.

По умолчанию revealSecrets установлено в значение false.

--variables (строка)

JSON-объект, который устанавливает переменные, используемые в тестируемом состоянии. Ключи объекта — имена переменных, значения — значения переменных.

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

Вывод

output -> (строка)

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

error -> (строка)

Возвращаемая ошибка при завершении выполнения состояния с ошибкой.

cause -> (строка)

Подробное описание причины ошибки при завершении выполнения состояния с ошибкой.

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

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

input -> (строка)

Исходный вход состояния.

afterArguments -> (строка)

Входные данные после того, как Step Functions применит фильтр Arguments. Это событие будет присутствовать только тогда, когда QueryLanguage для машины состояний или отдельных состояний установлено в JSONata. Подробнее см. в разделе Преобразование данных с помощью Step Functions.

afterInputPath -> (строка)

Входные данные после того, как Step Functions применит фильтр InputPath. Не заполняется, когда QueryLanguage имеет значение JSONata.

afterParameters -> (строка)

Эффективные входные данные после того, как Step Functions применит фильтр Parameters. Не заполняется, когда QueryLanguage имеет значение JSONata.

result -> (строка)

Исходный результат состояния.

afterResultSelector -> (строка)

Эффективный результат после того, как Step Functions применит фильтр ResultSelector. Не заполняется, когда QueryLanguage имеет значение JSONata.

afterResultPath -> (строка)

Эффективный результат в сочетании с исходными входными данными состояния после того, как Step Functions применит фильтр ResultPath. Не заполняется, когда QueryLanguage имеет значение JSONata.

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

Исходный HTTP-запрос, отправленный при тестировании задачи HTTP.

protocol -> (строка)

Протокол, используемый для отправки HTTP-запроса.

method -> (строка)

HTTP-метод, используемый для HTTP-запроса.

url -> (строка)

API-точка, используемая для HTTP-запроса.

headers -> (строка)

Заголовки запроса, связанные с HTTP-запросом.

body -> (строка)

Тело запроса для HTTP-запроса.

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

Исходный HTTP-ответ, возвращаемый при тестировании задачи HTTP.

protocol -> (строка)

Протокол, используемый для возврата HTTP-ответа.

statusCode -> (строка)

Код состояния HTTP-ответа.

statusMessage -> (строка)

Сообщение, связанное с кодом состояния HTTP.

headers -> (строка)

Заголовки ответа, связанные с HTTP-ответом.

body -> (строка)

Возвращенный HTTP-ответ.

variables -> (строка)

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

nextState -> (строка)

Имя следующего состояния для перехода. Если вы не определили следующее состояние в своём определении или если выполнение состояния завершилось ошибкой, это поле не содержит значения.

status -> (строка)

Статус выполнения состояния.