Spec-Zone.ru › AWS CLI v2

[ aws . ssm ]

describe-automation-step-executions

Описание

Информация обо всех активных и завершенных этапах выполнения в рабочем процессе Automation.

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

describe-automation-step-executions является постраничной операцией. Для получения всего набора результатов могут быть выпущены несколько API-запросов. Вы можете отключить постраничную обработку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной обработкой аргумент --query должен извлечь данные из результатов следующих выражений запроса: StepExecutions

Синтаксис

  describe-automation-step-executions
--automation-execution-id <value>
[--filters <value>]
[--reverse-order | --no-reverse-order]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--automation-execution-id (строка)

Идентификатор выполнения Automation, для которого требуется описание выполнения шагов.

--filters (список)

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

(структура)

Фильтр для ограничения количества возвращаемой информации о выполнении шага вызовом.

Ключ -> (строка)

Один или несколько ключей для ограничения результатов.

Значения -> (список)

Значения ключа фильтра.

(строка)

Сокращенный синтаксис:

Key=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Key": "StartTimeBefore"|"StartTimeAfter"|"StepExecutionStatus"|"StepExecutionId"|"StepName"|"Action"|"ParentStepExecutionId"|"ParentStepIteration"|"ParentStepIteratorValue",
    "Values": ["string", ...]
  }
  ...
]

--reverse-order | --no-reverse-order (булево)

Указывает, нужно ли перечислять шаги выполнения в обратном порядке по времени начала. Значение по умолчанию - 'false'.

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, указанному в --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения, используя значение, предоставленное в JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен для указания места начала постраничной обработки. Это NextToken из ранее усеченного ответа.

Примеры использования см. в разделе «Постраничная обработка» в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-службы. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-службы, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-службы.

Примеры использования см. в разделе «Постраничная обработка» в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов, которые необходимо вернуть в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничной обработки укажите значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken непосредственно за пределами AWS CLI.

Примеры использования см. в разделе «Постраничная обработка» в Руководстве пользователя AWS Command Line Interface.

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

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. См. руководство по началу работы в Руководстве пользователя AWS CLI для получения дополнительной информации.

Если не указано иное, все примеры имеют правила цитирования, похожие на unix-подобные. Эти примеры необходимо адаптировать к правилам цитирования вашей оболочки. См. Использование кавычек со строками в Руководстве пользователя AWS CLI.

Пример 1: Описание всех шагов для выполнения Automation

Следующий пример выводит подробную информацию о шагах выполнения Automation.

aws ssm describe-automation-step-executions \
    --automation-execution-id 73c8eef8-f4ee-4a05-820c-e354fEXAMPLE

Вывод:

{
    "StepExecutions": [
        {
            "StepName": "startInstances",
            "Action": "aws:changeInstanceState",
            "ExecutionStartTime": 1583737234.134,
            "ExecutionEndTime": 1583737234.672,
            "StepStatus": "Success",
            "Inputs": {
                "DesiredState": "\"running\"",
                "InstanceIds": "[\"i-0cb99161f6EXAMPLE\"]"
            },
            "Outputs": {
                "InstanceStates": [
                    "running"
                ]
            },
            "StepExecutionId": "95e70479-cf20-4d80-8018-7e4e2EXAMPLE",
            "OverriddenParameters": {}
        }
    ]
}

Пример 2: Описание конкретного шага для выполнения Automation

Следующий пример выводит подробную информацию о конкретном шаге выполнения Automation.

aws ssm describe-automation-step-executions \
    --automation-execution-id 73c8eef8-f4ee-4a05-820c-e354fEXAMPLE \
    --filters Key=StepExecutionId,Values=95e70479-cf20-4d80-8018-7e4e2EXAMPLE

Дополнительную информацию см. в разделе «Запуск шага рабочего процесса Automation поэтапно (командная строка)» в Руководстве пользователя AWS Systems Manager.

Вывод

StepExecutions -> (список)

Список подробностей о текущем состоянии всех шагов, составляющих выполнение.

(структура)

Подробная информация о состоянии выполнения шага Автоматизации.

StepName -> (строка)

Имя этого шага выполнения.

Action -> (строка)

Действие, выполняемое этим шагом. Действие определяет поведение шага.

TimeoutSeconds -> (длинное целое)

Время ожидания шага в секундах.

OnFailure -> (строка)

Действие, которое должно быть выполнено, если шаг завершится неудачно. Значение по умолчанию — Abort.

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

Максимальное количество попыток выполнения действия шага. Значение по умолчанию — 1.

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

Если выполнение шага началось, здесь содержится время начала шага. Если шаг находится в состоянии Ожидание, это поле не заполнено.

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

Если выполнение шага завершилось, здесь содержится время завершения выполнения. Если шаг еще не завершен, это поле не заполнено.

StepStatus -> (строка)

Статус выполнения для этого шага.

ResponseCode -> (строка)

Код ответа, возвращенный в результате выполнения шага.

Inputs -> (словарь)

Полностью разрешенные значения, переданные в шаг перед выполнением.

ключ -> (строка)

значение -> (строка)

Outputs -> (словарь)

Возвращенные значения из выполнения шага.

ключ -> (строка)

значение -> (список)

(строка)

Response -> (строка)

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

FailureMessage -> (строка)

Если шаг завершился неудачно, это сообщение объясняет причину неудачи выполнения.

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

Информация об ошибке Автоматизации.

FailureStage -> (строка)

Этап выполнения Автоматизации, на котором произошла ошибка. Этапы включают в себя: InputValidation, PreVerification, Invocation, PostVerification.

FailureType -> (строка)

Тип ошибки Автоматизации. Типы ошибок включают в себя: Action, Permission, Throttling, Verification, Internal.

Details -> (словарь)

Подробная информация об ошибке шага Автоматизации.

ключ -> (строка)

значение -> (список)

(строка)

StepExecutionId -> (строка)

Уникальный идентификатор выполнения шага.

OverriddenParameters -> (словарь)

Список параметров, заданных пользователем для переопределения при выполнении шага.

ключ -> (строка)

значение -> (список)

(строка)

IsEnd -> (логическое значение)

Флаг, который можно использовать для завершения автоматизации независимо от того, выполняется ли шаг успешно или нет.

NextStep -> (строка)

Следующий шаг после успешного выполнения шага.

IsCritical -> (логическое значение)

Флаг, который можно использовать для определения того, приведет ли неудача текущего шага к неудаче Автоматизации.

ValidNextSteps -> (список)

Стратегии, используемые при неудачном выполнении шага; мы поддерживаем Продолжить и Прервать. Прервать приведет к отказу автоматизации при неудачном выполнении шага. Продолжить проигнорирует ошибку текущего шага и позволит автоматизации выполнить следующий шаг. При условных ветвлениях мы добавляем step:stepName, чтобы автоматизация перешла к другому конкретному шагу.

(строка)

Targets -> (список)

Цели для выполнения шага.

(структура)

Массив критериев поиска, которые нацелены на управляемые узлы с использованием пары «ключ-значение», которую вы указываете.

Примечание

Для задач типа «Команда выполнения» в окне обслуживания необходимо указать одну или несколько целей. В зависимости от задачи цели необязательны для других типов задач в окне обслуживания (Автоматизация, Lambda и Step Functions). Дополнительные сведения о запуске задач без указания целей см. в руководстве пользователя Amazon Web Services Systems Manager .

Поддерживаемые форматы включают в себя следующие.

Для всех инструментов Systems Manager:
  • Key=tag-key,Values=tag-value-1,tag-value-2
Для Автоматизации и Change Manager:
  • Key=tag:tag-key,Values=tag-value
  • Key=ResourceGroup,Values=resource-group-name
  • Key=ParameterValues,Values=value-1,value-2,value-3
  • Для нацеливания на все экземпляры в регионе Amazon Web Services:
    • Key=AWS::EC2::Instance,Values=*
    • Key=InstanceIds,Values=*
Для Команды выполнения и окон обслуживания:
  • Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
  • Key=tag:tag-key,Values=tag-value-1,tag-value-2
  • Key=resource-groups:Name,Values=resource-group-name
  • Кроме того, окна обслуживания поддерживают нацеливание на типы ресурсов:
    • Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2
Для State Manager:
  • Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
  • Key=tag:tag-key,Values=tag-value-1,tag-value-2
  • Для нацеливания на все экземпляры в регионе Amazon Web Services:
    • Key=InstanceIds,Values=*

Дополнительные сведения о том, как отправлять команды, которые нацелены на управляемые узлы с использованием параметров Key,Value, см. в руководстве пользователя Amazon Web Services Systems Manager .

Ключ -> (строка)

Пользовательские критерии для отправки команд, которые нацелены на управляемые узлы, соответствующие этим критериям.

Значения -> (список)

Пользовательские критерии, которые сопоставляются с Key. Например, если вы указали tag:ServerRole, вы можете указать value:WebServer для запуска команды на экземплярах, содержащих теги EC2 ServerRole,WebServer.

В зависимости от типа цели максимальное количество значений для ключа может быть меньше глобального максимума в 50.

(строка)

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

Сочетание регионов Amazon Web Services и учетных записей Amazon Web Services, на которые нацелено текущее выполнение Автоматизации.

Accounts -> (список)

Учетные записи Amazon Web Services, на которые нацелено текущее выполнение Автоматизации.

(строка)

Regions -> (список)

Регионы Amazon Web Services, на которые нацелено текущее выполнение Автоматизации.

(строка)

TargetLocationMaxConcurrency -> (строка)

Максимальное количество регионов Amazon Web Services и учетных записей Amazon Web Services, которые разрешено выполнять Автоматизацию одновременно.

TargetLocationMaxErrors -> (строка)

Максимальное количество ошибок, разрешенных перед тем, как система перестанет помещать в очередь дополнительные выполнения Автоматизации для выполняемой в настоящее время Автоматизации.

ExecutionRoleName -> (строка)

Роль выполнения Автоматизации, используемая текущей выполняющейся Автоматизацией. Если не указано, значение по умолчанию — AWS-SystemsManager-AutomationExecutionRole.

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

Подробности для сигнализации CloudWatch, которую вы хотите применить к автоматизации или команде.

IgnorePollAlarmFailure -> (логическое значение)

Если это значение равно true , ваша автоматизация или команда продолжает выполняться в случаях, когда мы не можем получить информацию о состоянии сигнализации из CloudWatch. В случаях, когда мы успешно получаем состояние сигнализации OK или INSUFFICIENT_DATA, автоматизация или команда продолжают выполняться независимо от этого значения. Значение по умолчанию — false.

Alarms -> (список)

Имя сигнализации CloudWatch, указанной в конфигурации.

(структура)

Сигнализация CloudWatch, которую вы применяете к автоматизации или команде.

Name -> (строка)

Имя вашей сигнализации CloudWatch.

IncludeChildOrganizationUnits -> (логическое значение)

Указывает, следует ли включать дочерние организационные подразделения (OU), которые являются потомками целевых OU. Значение по умолчанию — false.

ExcludeAccounts -> (список)

Учетные записи Amazon Web Services или организационные подразделения для исключения в качестве расширенных целей.

(строка)

Targets -> (список)

Список сопоставлений «ключ-значение» для нацеливания на ресурсы. Если вы указываете значения для этого типа данных, вы также должны указать значение для TargetParameterName.

Этот параметр Targets имеет приоритет над параметром StartAutomationExecution:Targets, если оба они указаны.

(структура)

Массив критериев поиска, которые нацелены на управляемые узлы с использованием пары «ключ-значение», которую вы указываете.

Примечание

Для задач типа «Команда выполнения» в окне обслуживания необходимо указать одну или несколько целей. В зависимости от задачи цели необязательны для других типов задач в окне обслуживания (Автоматизация, Lambda и Step Functions). Дополнительные сведения о запуске задач без указания целей см. в руководстве пользователя Amazon Web Services Systems Manager .

Поддерживаемые форматы включают в себя следующие.

Для всех инструментов Systems Manager:
  • Key=tag-key,Values=tag-value-1,tag-value-2
Для Автоматизации и Change Manager:
  • Key=tag:tag-key,Values=tag-value
  • Key=ResourceGroup,Values=resource-group-name
  • Key=ParameterValues,Values=value-1,value-2,value-3
  • Для нацеливания на все экземпляры в регионе Amazon Web Services:
    • Key=AWS::EC2::Instance,Values=*
    • Key=InstanceIds,Values=*
Для Команды выполнения и окон обслуживания:
  • Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
  • Key=tag:tag-key,Values=tag-value-1,tag-value-2
  • Key=resource-groups:Name,Values=resource-group-name
  • Кроме того, окна обслуживания поддерживают нацеливание на типы ресурсов:
    • Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2
Для State Manager:
  • Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
  • Key=tag:tag-key,Values=tag-value-1,tag-value-2
  • Для нацеливания на все экземпляры в регионе Amazon Web Services:
    • Key=InstanceIds,Values=*

Дополнительные сведения о том, как отправлять команды, которые нацелены на управляемые узлы с использованием параметров Key,Value, см. в руководстве пользователя Amazon Web Services Systems Manager .

Ключ -> (строка)

Пользовательские критерии для отправки команд, которые нацелены на управляемые узлы, соответствующие этим критериям.

Значения -> (список)

Пользовательские критерии, которые сопоставляются с Key. Например, если вы указали tag:ServerRole, вы можете указать value:WebServer для запуска команды на экземплярах, содержащих теги EC2 ServerRole,WebServer.

В зависимости от типа цели максимальное количество значений для ключа может быть меньше глобального максимума в 50.

(строка)

TargetsMaxConcurrency -> (строка)

Максимальное количество целевых объектов, которые разрешено запускать эту задачу параллельно. Этот TargetsMaxConcurrency параметр имеет приоритет над параметром StartAutomationExecution:MaxConcurrency, если оба указаны.

TargetsMaxErrors -> (строка)

Максимальное количество ошибок, разрешенных перед тем, как система перестанет запускать автоматизацию на дополнительных целевых объектах. Этот параметр TargetsMaxErrors имеет приоритет над параметром StartAutomationExecution:MaxErrors, если оба указаны.

TriggeredAlarms -> (список)

Сигналы CloudWatch, которые были вызваны автоматизацией.

(структура)

Подробности о состоянии сигнала CloudWatch.

Имя -> (строка)

Название вашего сигнала CloudWatch.

Состояние -> (строка)

Состояние вашего сигнала CloudWatch.

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

Информация о родительском шаге.

StepExecutionId -> (строка)

Уникальный идентификатор выполнения шага.

StepName -> (строка)

Имя шага.

Действие -> (строка)

Имя действия автоматизации.

Итерация -> (целое число)

Текущая итерация цикла, представленная целым числом.

ЗначениеИтератора -> (строка)

Текущее значение указанного итератора в цикле.

NextToken -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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