get-automation-execution

Описание

Получение подробной информации об определенном выполнении автоматизации.

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

Синтаксис

  get-automation-execution
--automation-execution-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]

Параметры

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

Уникальный идентификатор существующего выполнения автоматизации для проверки. Идентификатор выполнения возвращается в StartAutomationExecution при запуске выполнения сценария автоматизации.

--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 для вывода.

--cli-auto-prompt (булево)

Автоматически запрашивать параметры CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запроса параметров CLI.

Примеры

Примечание

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

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

Для отображения подробностей о выполнении автоматизации

Следующий get-automation-execution пример отображает подробную информацию о выполнении автоматизации.

aws ssm get-automation-execution \
    --automation-execution-id 73c8eef8-f4ee-4a05-820c-e354fEXAMPLE

Вывод:

{
    "AutomationExecution": {
        "AutomationExecutionId": "73c8eef8-f4ee-4a05-820c-e354fEXAMPLE",
        "DocumentName": "AWS-StartEC2Instance",
        "DocumentVersion": "1",
        "ExecutionStartTime": 1583737233.748,
        "ExecutionEndTime": 1583737234.719,
        "AutomationExecutionStatus": "Success",
        "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": {}
            }
        ],
        "StepExecutionsTruncated": false,
        "Parameters": {
            "AutomationAssumeRole": [
                ""
            ],
            "InstanceId": [
                "i-0cb99161f6EXAMPLE"
            ]
        },
        "Outputs": {},
        "Mode": "Auto",
        "ExecutedBy": "arn:aws:sts::29884EXAMPLE:assumed-role/mw_service_role/OrchestrationService",
        "Targets": [],
        "ResolvedTargets": {
            "ParameterValues": [],
            "Truncated": false
        }
    }
}

Дополнительную информацию см. в руководстве пользователя AWS Systems Manager.

Вывод

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

Подробная информация о текущем состоянии выполнения автоматизации.

AutomationExecutionId -> (строка)

Идентификатор выполнения.

DocumentName -> (строка)

Название сценария автоматизации, используемого во время выполнения.

DocumentVersion -> (строка)

Версия документа для использования во время выполнения.

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

Время начала выполнения.

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

Время окончания выполнения.

AutomationExecutionStatus -> (строка)

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

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 -> (список)

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

(строка)

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, если оба указаны.

(структура)

Примечание

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

Для всех инструментов 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=*

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

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

(строка)

TargetsMaxConcurrency -> (строка)

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

TargetsMaxErrors -> (строка)

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

TriggeredAlarms -> (список)

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

(структура)

Подробности о состоянии вашей сигнализации CloudWatch.

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

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

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

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

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

Информация о шаге-предке.

StepExecutionId -> (строка)

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

StepName -> (строка)

Имя шага.

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

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

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

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

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

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

StepExecutionsTruncated -> (булево)

Булево значение, указывающее, содержит ли ответ полный список выполнений шагов автоматизации. Если значение true, используйте операцию API DescribeAutomationStepExecutions для получения полного списка выполнений шагов.

Parameters -> (массив)

Маппинг ключ-значение параметров выполнения, которые были предоставлены при вызове StartAutomationExecution.

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

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

(строка)

Outputs -> (массив)

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

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

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

(строка)

СообщениеОбОшибке -> (строка)

Сообщение, описывающее причину сбоя выполнения, если состояние установлено в «Ошибка».

Режим -> (строка)

Режим выполнения автоматизации.

IdРодительскогоВыполненияАвтоматизации -> (строка)

AutomationExecutionId родительской автоматизации.

ВыполненПользователем -> (строка)

Amazon Resource Name (ARN) пользователя, который запустил автоматизацию.

ТекущееИмяШага -> (строка)

Имя шага, который в данный момент выполняется.

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

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

ИмяПараметраЦели -> (строка)

Имя параметра.

Цели -> (список)

Указанные цели.

(структура)

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

Примечание

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

Поддерживаемые форматы включают:

Для всех инструментов Systems Manager:

Key=tag-key,Values=tag-value-1,tag-value-2

Для Automation и 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=*

Для Run Command и Maintenance Windows:

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
Кроме того, Maintenance Windows поддерживают назначение типов ресурсов:
- 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.

(строка)

TargetMaps -> (список)

Указанное сопоставление ключ-значение параметров документа с целевыми ресурсами.

(массив)

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

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

(строка)

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

Список разрешенных целей в выполнении контроля скорости.

ParameterValues -> (список)

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

(строка)

Усеченный -> (булево)

Булево значение, указывающее, усечен ли список разрешенных целей.

MaxConcurrency -> (строка)

Значение MaxConcurrency, указанное пользователем при запуске выполнения.

MaxErrors -> (строка)

Значение MaxErrors, указанное пользователем при запуске выполнения.

Цель -> (строка)

Цель выполнения.

TargetLocations -> (список)

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

(структура)

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

Accounts -> (список)

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

(строка)

Regions -> (список)

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

(строка)

TargetLocationMaxConcurrency -> (строка)

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

TargetLocationMaxErrors -> (строка)

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

ExecutionRoleName -> (строка)

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

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

IgnorePollAlarmFailure -> (булево)

Когда это значение равно true, ваша автоматизация или команда продолжают выполняться в случаях, когда мы не можем получить информацию о состоянии сигнализации из CloudWatch. В тех случаях, когда мы успешно получаем состояние сигнализации «В порядке» или «НЕДОСТАТОЧНЫЕ_ДАННЫЕ», автоматизация или команда продолжают выполняться независимо от этого значения. По умолчанию — false.

Alarms -> (список)

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

(структура)

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

Name -> (строка)

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

IncludeChildOrganizationUnits -> (булево)

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

ExcludeAccounts -> (список)

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

(строка)

Цели -> (список)

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

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

(структура)

Примечание

Поддерживаемые форматы включают:

Для всех инструментов Systems Manager:

Key=tag-key,Values=tag-value-1,tag-value-2

Для Automation и 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=*

Для Run Command и Maintenance Windows:

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
Кроме того, Maintenance Windows поддерживают назначение типов ресурсов:
- 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=*

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

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

(строка)

TargetsMaxConcurrency -> (строка)

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

TargetsMaxErrors -> (строка)

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

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

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

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

Общее количество шагов, выполненных во всех указанных регионах и учетных записях Amazon Web Services для текущего выполнения автоматизации.

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

Общее количество шагов, успешно завершенных во всех указанных регионах и учетных записях Amazon Web Services для текущего выполнения автоматизации.

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

Общее количество шагов, не выполненных во всех указанных регионах и учетных записях Amazon Web Services для текущего выполнения автоматизации.

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

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

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

Общее количество шагов, истекших по времени во всех указанных регионах и учетных записях Amazon Web Services для текущего выполнения автоматизации.

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

Подробная информация о CloudWatch тревоге, применённой к вашей автоматизации.

IgnorePollAlarmFailure -> (булево)

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

Alarms -> (список)

Имя CloudWatch тревоги, указанное в конфигурации.

(структура)

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

Name -> (строка)

Имя вашей CloudWatch тревоги.

TriggeredAlarms -> (список)

CloudWatch тревога, инициированная автоматизацией.

(структура)

Подробности о состоянии вашей CloudWatch тревоги.

Name -> (строка)

Имя вашей CloudWatch тревоги.

State -> (строка)

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

TargetLocationsURL -> (строка)

Публично доступный URL-адрес файла, содержащий TargetLocations тело. В настоящее время поддерживаются только файлы в предопределённых объёмах Amazon S3.

AutomationSubtype -> (строка)

Подтип операции автоматизации. В настоящее время поддерживается только значение ChangeRequest .

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

Дата и время начала запланированной операции автоматизации.

Runbooks -> (список)

Информация о запускаемых runbooks Automation, которые выполняются как часть рабочей области runbook.

Примечание

Запущенные в рабочей области runbook runbooks Automation не смогут запуститься до получения всех необходимых утверждений для запроса изменения.

(структура)

Информация о runbook Automation, используемом в рабочей области runbook в Change Manager.

Примечание

DocumentName -> (строка)

Имя runbook Automation, используемого в рабочей области runbook.

DocumentVersion -> (строка)

Версия runbook Automation, используемого в рабочей области runbook.

Parameters -> (отображение)

Отображение пар «ключ-значение» параметров выполнения, которые были предоставлены при вызове StartChangeRequestExecution .

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

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

(строка)

TargetParameterName -> (строка)

Имя параметра, используемого в качестве целевого ресурса для потоковой рабочей области runbook. Требуется, если вы укажите Targets .

Targets -> (список)

Сопоставление пар «ключ-значение» для целевых ресурсов, на которых операция runbook выполняет задачи. Требуется, если вы укажите TargetParameterName .

(структура)

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

Примечание

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

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

Для всех инструментов Systems Manager:

Key=tag-key,Values=tag-value-1,tag-value-2

Для Automation и 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.

(строка)

TargetMaps -> (список)

Сопоставление пар «ключ-значение» параметров runbook с целевыми ресурсами. Оба параметра «Targets» и «TargetMaps» не могут быть указаны вместе.

(отображение)

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

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

(строка)

MaxConcurrency -> (строка)

Значение MaxConcurrency , указанное пользователем при запуске операции, указывающее максимальное количество ресурсов, на которые операция runbook может выполняться одновременно.

MaxErrors -> (строка)

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

TargetLocations -> (список)

Информация о регионах Amazon Web Services и учетных записях Amazon Web Services, на которые нацелена текущая операция Runbook.

(структура)

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

Accounts -> (список)

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

(строка)

Regions -> (список)

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

(строка)

TargetLocationMaxConcurrency -> (строка)

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

TargetLocationMaxErrors -> (строка)

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

ExecutionRoleName -> (строка)

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

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

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

IgnorePollAlarmFailure -> (булево)

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

Alarms -> (список)

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

(структура)

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

Name -> (строка)

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

IncludeChildOrganizationUnits -> (булево)

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

ExcludeAccounts -> (список)

Учетные записи Amazon Web Services или организационные единицы, которые следует исключить в качестве расширенных целевых объектов.

(строка)

Targets -> (список)

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

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

(структура)

Примечание

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

Для всех инструментов Systems Manager:

Key=tag-key,Values=tag-value-1,tag-value-2

Для Automation и 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=*

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

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

(строка)

TargetsMaxConcurrency -> (строка)

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

TargetsMaxErrors -> (строка)

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

OpsItemId -> (строка)

Идентификатор OpsItem, созданного для представления запроса изменения Change Manager.

AssociationId -> (строка)

Идентификатор ассоциации State Manager, используемой в операции Automation.

ChangeRequestName -> (строка)

Имя запроса изменения Change Manager.

Variables -> (отображение)

Переменные, определенные для автоматизации.

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

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

(строка)

END_OF_DOCUMENT_MARKER