describe-execution
Описание
Вы можете использовать DescribeExecution, чтобы проверить детали выполнения указанного рабочего процесса.
Примечание
Этот вызов API возвращает только данные для выполняемых рабочих процессов.
Если вы предоставите идентификатор выполнения, которое не находится в процессе выполнения, или если выполнение не соответствует указанному идентификатору рабочего процесса, будет выдано исключение ResourceNotFound.
См. также: Документацию API AWS
Синтаксис
describe-execution
--execution-id <value>
--workflow-id <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-id (строка)
--workflow-id (строка)
--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 (строка)
Переопределить адрес по умолчанию команды на указанный адрес.
--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.
Вывод
WorkflowId -> (строка)
Execution -> (структура)
Структура, содержащая подробности выполнения потока работ.
ExecutionId -> (строка)
InitialFileLocation -> (структура)
Структура, описывающая расположение файла в Amazon S3 или EFS. Это расположение файла при старте выполнения: если файл копируется, это начальное (в отличие от целевого) расположение файла.
S3FileLocation -> (структура)
Указывает детали S3 для используемого файла, такие как ведро, ETag и так далее.
Bucket -> (строка)
Key -> (строка)
VersionId -> (строка)
Etag -> (строка)
EfsFileLocation -> (структура)
Указывает идентификатор Amazon EFS и путь к используемому файлу.
FileSystemId -> (строка)
Path -> (строка)
ServiceMetadata -> (структура)
Объект-контейнер для данных сеанса, связанных с потоком работ.
UserDetails -> (структура)
Идентификатор сервера (ServerId), идентификатор сеанса (SessionId) и пользователь (UserName) составляют UserDetails.
UserName -> (строка)
ServerId -> (строка)
SessionId -> (строка)
ExecutionRole -> (строка)
LoggingConfiguration -> (структура)
Роль ведения журнала IAM, связанная с выполнением.
LoggingRole -> (строка)
LogGroupName -> (строка)
PosixProfile -> (структура)
Полная POSIX-идентичность, включая идентификатор пользователя (Uid), идентификатор группы (Gid) и любые идентификаторы дополнительных групп (SecondaryGids), которые контролируют доступ пользователей к файловым системам Amazon EFS. Разрешения POSIX, заданные на файлах и каталогах в файловой системе, определяют уровень доступа пользователей при передаче файлов в файловые системы Amazon EFS и из них.
Uid -> (целое)
Gid -> (целое)
SecondaryGids -> (список)
Дополнительные идентификаторы групп POSIX, используемые для всех операций EFS этим пользователем.
(целое)
Status -> (строка)
Results -> (структура)
Структура, описывающая результаты выполнения. Она включает список шагов с подробными данными каждого шага, тип ошибки и сообщение (при наличии) и OnExceptionSteps структуру.
Steps -> (список)
Указывает данные для шагов в указанном потоке работ.
(структура)
Указывает следующие данные для шага: ошибка (при наличии), выводы (при наличии) и тип шага.
StepType -> (строка)
Один из доступных типов шагов.
Outputs -> (строка)
TAG.Error -> (структура)
Указывает данные об ошибке, если она возникла во время выполнения указанного шага потока работ.
Type -> (строка)
Указывает тип ошибки.
-
ALREADY_EXISTS: возникает для шага копирования, если опция перезаписи не выбрана, а файл с таким же именем уже существует в целевом расположении. -
BAD_REQUEST: общая ошибка запроса: например, шаг, пытающийся добавить тег к файлу EFS, возвращаетBAD_REQUEST, так как теги могут быть добавлены только к файлам S3. -
CUSTOM_STEP_FAILED: возникает, когда пользовательский шаг предоставил обратный вызов, указывающий на ошибку. -
INTERNAL_SERVER_ERROR: общая ошибка, которая может возникнуть по разным причинам. -
NOT_FOUND: возникает, когда запрашиваемый объект, например исходный файл для шага копирования, не существует. -
PERMISSION_DENIED: возникает, если ваша политика не содержит необходимых разрешений для выполнения одного или нескольких шагов в потоке работ. -
TIMEOUT: возникает при истечении времени выполнения.
Примечание
Можно установитьTimeoutSeconds для пользовательского шага, от 1 секунды до 1800 секунд (30 минут).-
THROTTLED: возникает, если превышен новый показатель повторной загрузки выполнения — один поток работ в секунду.
Message -> (строка)
ErrorType.OnExceptionSteps -> (список)
Указывает шаги (действия), которые нужно выполнить, если во время выполнения потока работ возникли ошибки.
(структура)
Указывает следующие данные для шага: ошибка (при наличии), выводы (при наличии) и тип шага.
StepType -> (строка)
Один из доступных типов шагов.
Outputs -> (строка)
TAG.Error -> (структура)
Указывает данные об ошибке, если она возникла во время выполнения указанного шага потока работ.
Type -> (строка)
Указывает тип ошибки.
-
ALREADY_EXISTS: возникает для шага копирования, если опция перезаписи не выбрана, а файл с таким же именем уже существует в целевом расположении. -
BAD_REQUEST: общая ошибка запроса: например, шаг, пытающийся добавить тег к файлу EFS, возвращаетBAD_REQUEST, так как теги могут быть добавлены только к файлам S3. -
CUSTOM_STEP_FAILED: возникает, когда пользовательский шаг предоставил обратный вызов, указывающий на ошибку. -
INTERNAL_SERVER_ERROR: общая ошибка, которая может возникнуть по разным причинам. -
NOT_FOUND: возникает, когда запрашиваемый объект, например исходный файл для шага копирования, не существует. -
PERMISSION_DENIED: возникает, если ваша политика не содержит необходимых разрешений для выполнения одного или нескольких шагов в потоке работ. -
TIMEOUT: возникает при истечении времени выполнения.
Примечание
Можно установитьTimeoutSeconds для пользовательского шага, от 1 секунды до 1800 секунд (30 минут).-
THROTTLED: возникает, если превышен новый показатель повторной загрузки выполнения — один поток работ в секунду.
Message -> (строка)
ErrorType.
© Copyright 2025, Amazon Web Services. Created using Sphinx.