[ aws . stepfunctions ]
describe-execution
Описание
Предоставляет информацию об исполнении состояния машины, такую как связанная с исполнением машина состояний, входные и выходные данные исполнения, а также соответствующие метаданные исполнения. Если вы повторно запустили исполнение, вы можете использовать это действие API для получения информации о повторных запусках этого исполнения. Кроме того, вы можете использовать это действие API для возврата Amazon Resource Name (ARN) Map Run, если исполнение было запущено Map Run.
Если вы указали ARN версии или алиаса при вызове действия API StartExecution, DescribeExecution возвращает этот ARN.
Примечание
Данная операция является согласованной со временем. Результаты являются результатом наилучших усилий и могут не отражать очень недавние обновления и изменения.Исполнения машины состояний EXPRESS не поддерживаются DescribeExecution, если их не запустил Map Run.
См. также: Документация AWS API
Синтаксис
describe-execution
--execution-arn <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]
Параметры
--execution-arn (строка)
--included-data (строка)
Если определение вашей машины состояний зашифровано с помощью ключа KMS, вызывающим сторонам необходимо иметь право kms:Decrypt для расшифровки определения. В качестве альтернативы вы можете вызвать API DescribeStateMachine с includedData = METADATA_ONLY, чтобы получить успешный ответ без зашифрованного определения.
Возможные значения:
ALL_DATAMETADATA_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-auto-prompt (логическое значение)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматический запрос параметров ввода CLI.
Вывод
executionArn -> (строка)
stateMachineArn -> (строка)
name -> (строка)
Имя выполнения.
Имя не должно содержать:
- пробелы
- скобки
< > { } [ ] - символы подстановки
? * - специальные символы
" # % \ ^ | ~ ` $ & , ; : / - управляющие символы (
U+0000-001F,U+007F-009F)
Для включения ведения журнала с помощью CloudWatch Logs имя должно содержать только цифры 0-9, буквы A-Z, a-z, - и _.
status -> (строка)
startDate -> (временная метка)
stopDate -> (временная метка)
input -> (строка)
inputDetails -> (структура)
Предоставляет подробную информацию о входных или выходных данных выполнения.
included -> (булево)
true.output -> (строка)
JSON-данные выходных данных выполнения. На размер полезной нагрузки накладываются ограничения, которые выражаются в байтах в кодировке UTF-8.
Примечание
Это поле устанавливается только в случае успешного выполнения. Если выполнение завершилось неудачно, это поле равно null.outputDetails -> (структура)
Предоставляет подробную информацию о входных или выходных данных выполнения.
included -> (булево)
true.traceHeader -> (строка)
mapRunArn -> (строка)
error -> (строка)
cause -> (строка)
stateMachineVersionArn -> (строка)
Amazon Resource Name (ARN) версии машины состояний, связанной с выполнением. ARN версии — это комбинация ARN машины состояний и номера версии, разделенные двоеточием (:). Например, stateMachineARN:1.
Если вы запускаете выполнение с помощью запроса StartExecution без указания версии машины состояний или ARN псевдонима, Step Functions возвращает значение null.
stateMachineAliasArn -> (строка)
Amazon Resource Name (ARN) псевдонима машины состояний, связанной с выполнением. ARN псевдонима — это комбинация ARN машины состояний и имени псевдонима, разделенные двоеточием (:). Например, stateMachineARN:PROD.
Если вы запускаете выполнение с помощью запроса StartExecution с ARN версии машины состояний, это поле будет равно null.
redriveCount -> (целое число)
redriveCount равно 0. Это значение обновляется только в случае успешного повторного запуска выполнения.redriveDate -> (временная метка)
Дата последнего повторного запуска выполнения. Если выполнение еще не было повторно запущено, значение redriveDate равно null.
Значение redriveDate недоступно, если вы повторно запускаете запуск Map, который инициирует дочерние рабочие процессы типа EXPRESS.
redriveStatus -> (строка)
Указывает, можно ли повторно запустить выполнение в данный момент.
- Для выполнений типа
STANDARD, значениеredriveStatusравноNOT_REDRIVABLE, если вызов API RedriveExecution вернет ошибкуExecutionNotRedrivable. - Для распределенного запуска Map, включающего дочерние рабочие процессы типа
STANDARD, значениеredriveStatusуказывает, можно ли повторно запустить дочерние рабочие процессы. - Для распределенного запуска Map, включающего дочерние рабочие процессы типа
EXPRESS, значениеredriveStatusуказывает, можно ли повторно запустить дочерние рабочие процессы. Вы можете повторно запустить завершившиеся неудачно или по истечении времениEXPRESSрабочие процессы только если они являются частью запуска Map. При повторном запуске запуска Map эти рабочие процессы перезапускаются с помощью действия API StartExecution.
redriveStatusReason -> (строка)
Когда redriveStatus равно NOT_REDRIVABLE, redriveStatusReason указывает причину, по которой выполнение нельзя повторно запустить.
- Для выполнений типа
STANDARDили для распределенного запуска Map, включающего дочерние рабочие процессы типаSTANDARD,redriveStatusReasonможет содержать одну из следующих причин:-
State machine is in DELETING status. -
Execution is RUNNING and cannot be redriven. -
Execution is SUCCEEDED and cannot be redriven. -
Execution was started before the launch of RedriveExecution. -
Execution history event limit exceeded. -
Execution has exceeded the max execution time. -
Execution redrivable period exceeded.
-
- Для распределенного запуска Map, включающего дочерние рабочие процессы типа
EXPRESS,redriveStatusReasonвозвращается только если дочерние рабочие процессы не могут быть повторно запущены. Это происходит, когда дочерние рабочие процессы завершились успешно.
© Copyright 2025, Amazon Web Services. Created using Sphinx.