Spec-Zone.ru › AWS CLI v2

[ aws . stepfunctions ]

describe-map-run

Описание

Предоставляет информацию о конфигурации, ходе выполнения и результатах выполнения Map Run. Если вы повторно запустили Map Run, этот API-запрос также вернёт информацию о повторных запусках этого Map Run. Дополнительную информацию см. в разделе «Изучение Map Run» в руководстве разработчика Step Functions.

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

Синтаксис

  describe-map-run
--map-run-arn <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]

Параметры

--map-run-arn (строка)

Amazon Resource Name (ARN), определяющий Map Run.

--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
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать конкретный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включает/отключает цветной вывод.

  • включено
  • выключено
  • автоматически

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

Вывод

mapRunArn -> (строка)

Amazon Resource Name (ARN), определяющий Map Run.

executionArn -> (строка)

Amazon Resource Name (ARN), определяющий выполнение, в котором был запущен Map Run.

status -> (строка)

Текущий статус Map Run.

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

Дата запуска Map Run.

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

Дата остановки Map Run.

maxConcurrency -> (целое число)

Максимальное количество дочерних задач потока выполнения, настроенных для одновременного выполнения Map Run.

toleratedFailurePercentage -> (вещественное число)

Максимальный процент завершившихся неудачно дочерних задач потока выполнения, прежде чем Map Run завершится неудачно.

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

Максимальное количество завершившихся неудачно дочерних задач потока выполнения, прежде чем Map Run завершится неудачно.

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

JSON-объект, содержащий информацию о общем количестве элементов и количестве элементов для каждого статуса обработки, например, pending и failed.

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

Общее количество элементов для обработки в дочерних задачах потока выполнения, которые ещё не начали выполнение.

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

Общее количество элементов, которые обрабатываются в дочерних задачах потока выполнения, которые в настоящее время выполняются.

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

Общее количество элементов, обработанных в дочерних задачах потока выполнения, которые завершились успешно.

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

Общее количество элементов, обработанных в дочерних задачах потока выполнения, которые завершились неудачно.

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

Общее количество элементов, обработанных в дочерних задачах потока выполнения, которые истекли по времени.

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

Общее количество элементов, обработанных в дочерних задачах потока выполнения, которые были остановлены пользователем или Step Functions, потому что Map Run завершился неудачно.

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

Общее количество элементов, обработанных во всех дочерних задачах потока выполнения, запущенных Map Run.

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

Возвращает количество элементов, результаты которых были записаны ResultWriter. Дополнительную информацию см. в разделе «ResultWriter» в руководстве разработчика Step Functions.

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

Количество FAILED, ABORTED или TIMED_OUT элементов в дочерних задачах потока выполнения, которые не могут быть повторно запущены, поскольку статус выполнения этих дочерних задач является терминальным. Например, дочерние задачи с состоянием выполнения FAILED, ABORTED или TIMED_OUT и redriveStatus NOT_REDRIVABLE.

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

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

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

JSON-объект, содержащий информацию о общем количестве дочерних задач потока выполнения для Map Run и количестве дочерних задач потока выполнения для каждого состояния, например, failed и succeeded.

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

Общее количество дочерних задач потока выполнения, которые были начаты Map Run, но ещё не начали выполнение.

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

Общее количество дочерних задач потока выполнения, которые были начаты Map Run и в настоящее время выполняются.

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

Общее количество дочерних задач потока выполнения, которые были начаты Map Run и завершились успешно.

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

Общее количество дочерних задач потока выполнения, которые были начаты Map Run, но завершились неудачно.

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

Общее количество дочерних задач потока выполнения, которые были начаты Map Run и истекли по времени.

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

Общее количество дочерних задач потока выполнения, которые были начаты Map Run и выполнялись, но были остановлены пользователем или Step Functions, потому что Map Run завершился неудачно.

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

Общее количество дочерних задач потока выполнения, которые были начаты Map Run.

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

Возвращает количество дочерних задач потока выполнения, результаты которых были записаны ResultWriter. Дополнительную информацию см. в разделе «ResultWriter» в руководстве разработчика Step Functions.

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

Количество FAILED, ABORTED или TIMED_OUT дочерних задач потока выполнения, которые не могут быть повторно запущены, поскольку их статус выполнения является терминальным. Например, дочерние задачи с состоянием выполнения FAILED, ABORTED или TIMED_OUT и redriveStatus NOT_REDRIVABLE.

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

Количество неудачных дочерних задач потока выполнения, которые в настоящее время ожидают повторного запуска. Статус этих дочерних задач потока выполнения мог быть FAILED, ABORTED или TIMED_OUT в исходной попытке выполнения или в предыдущей попытке повторного запуска.

redriveCount -> (целое число)

Количество раз, когда вы повторно запускали Map Run. Если вы ещё не повторно запускали Map Run, значение redriveCount равно 0. Это значение обновляется только при успешном повторном запуске Map Run.

redriveDate -> (метка времени)

Дата последнего повторного запуска Map Run. Если вы ещё не повторно запускали Map Run, значение redriveDate равно null.

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

Spec-Zone.ru

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