describe-automation-executions
Описание
Предоставляет подробную информацию обо всех активных и завершенных выполнениях Automation.
См. также: Документацию API AWS
describe-automation-executions является постраничной операцией. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной обработкой, аргумент --query должен извлекать данные из результатов следующих выражений запроса: AutomationExecutionMetadataList
Синтаксис
describe-automation-executions
[--filters <value>]
[--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]
Параметры
--filters (список)
Фильтры, используемые для ограничения области выполняемых запросов.
(структура)
Фильтр для сопоставления определенных выполнений автоматизации. Он используется для ограничения области возвращаемой информации о выполнении Automation.
Ключ -> (строка)
Значения -> (список)
Значения, используемые для ограничения информации о выполнении, связанной с ключом фильтра.
(строка)
Сокращенный синтаксис:
Key=string,Values=string,string ...
Синтаксис JSON:
[
{
"Key": "DocumentNamePrefix"|"ExecutionStatus"|"ExecutionId"|"ParentExecutionId"|"CurrentAction"|"StartTimeBefore"|"StartTimeAfter"|"AutomationType"|"TagKey"|"TargetResourceGroup"|"AutomationSubtype"|"OpsItemId",
"Values": ["string", ...]
}
...
]
--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
- 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.
Примеры
Примечание
Для использования следующих примеров необходимо установить и настроить AWS CLI. Подробности см. в руководстве по началу работы в Руководстве пользователя AWS CLI.
За исключением случаев, когда указано иное, во всех примерах используются правила цитирования Unix. Эти примеры необходимо адаптировать к правилам цитирования вашего терминала. См. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI.
Для описания выполнения автоматизации
Следующий describe-automation-executions пример отображает подробности о выполнении Automation.
aws ssm describe-automation-executions \
--filters Key=ExecutionId,Values=73c8eef8-f4ee-4a05-820c-e354fEXAMPLE
Вывод:
{
"AutomationExecutionMetadataList": [
{
"AutomationExecutionId": "73c8eef8-f4ee-4a05-820c-e354fEXAMPLE",
"DocumentName": "AWS-StartEC2Instance",
"DocumentVersion": "1",
"AutomationExecutionStatus": "Success",
"ExecutionStartTime": 1583737233.748,
"ExecutionEndTime": 1583737234.719,
"ExecutedBy": "arn:aws:sts::29884EXAMPLE:assumed-role/mw_service_role/OrchestrationService",
"LogFile": "",
"Outputs": {},
"Mode": "Auto",
"Targets": [],
"ResolvedTargets": {
"ParameterValues": [],
"Truncated": false
},
"AutomationType": "Local"
}
]
}
Для получения дополнительной информации см. Выполнение простого рабочего процесса Automation в Руководстве пользователя AWS Systems Manager.
Вывод
AutomationExecutionMetadataList -> (список)
Список сведений о каждом выполнении автоматизации, соответствующем заданным фильтрам.
(структура)
Сведения о конкретном выполнении автоматизации.
AutomationExecutionId -> (строка)
DocumentName -> (строка)
DocumentVersion -> (строка)
AutomationExecutionStatus -> (строка)
ExecutionStartTime -> (метка времени)
ExecutionEndTime -> (метка времени)
ExecutedBy -> (строка)
LogFile -> (строка)
Outputs -> (словарь)
Список выходных данных выполнения, определённых в сценарии автоматизации.
ключ -> (строка)
значение -> (список)
Mode -> (строка)
ParentAutomationExecutionId -> (строка)
CurrentStepName -> (строка)
CurrentAction -> (строка)
FailureMessage -> (строка)
TargetParameterName -> (строка)
Targets -> (список)
Цели, определённые пользователем при запуске автоматизации.
(структура)
Массив критериев поиска, которые нацелены на управляемые узлы с помощью пары «ключ-значение», которую вы указываете.
Примечание
Для задач типа Run Command в окне обслуживания необходимо указать одну или несколько целей. В зависимости от задачи цели необязательны для других типов задач в окне обслуживания (автоматизация, Lambda и Step Functions). Дополнительную информацию о выполнении задач, не указывающих цели, см. в руководстве пользователя Amazon Web Services Systems Manager в разделе «Регистрация задач окна обслуживания без целей».Поддерживаемые форматы включают:
Key=tag-key,Values=tag-value-1,tag-value-2
Key=tag:tag-key,Values=tag-valueKey=ResourceGroup,Values=resource-group-nameKey=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-3Key=tag:tag-key,Values=tag-value-1,tag-value-2Key=resource-groups:Name,Values=resource-group-name- Кроме того, окна обслуживания поддерживают нацеливание на типы ресурсов:
Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3Key=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 -> (список)
Список значений параметров, отправленных целевым ресурсам, разрешённым во время выполнения автоматизации.
(строка)
Truncated -> (логическое значение)
MaxConcurrency -> (строка)
MaxConcurrency, указанное пользователем при запуске автоматизации.MaxErrors -> (строка)
MaxErrors, указанное пользователем при запуске автоматизации.Target -> (строка)
AutomationType -> (строка)
AlarmConfiguration -> (структура)
Подробности для сигнализации CloudWatch, применённой к вашей автоматизации.
IgnorePollAlarmFailure -> (логическое значение)
Alarms -> (список)
Имя сигнализации CloudWatch, указанной в конфигурации.
(структура)
Сигнализация CloudWatch, применяемая к автоматизации или команде.
Name -> (строка)
TriggeredAlarms -> (список)
Сигнализация CloudWatch, вызвавшая автоматизацию.
(структура)
Сведения о состоянии вашей сигнализации CloudWatch.
Name -> (строка)
State -> (строка)
TargetLocationsURL -> (строка)
TargetLocations. В настоящее время поддерживаются только файлы в подписанных ведрах Amazon S3.AutomationSubtype -> (строка)
ChangeRequest.ScheduledTime -> (метка времени)
Runbooks -> (список)
Информация о выполнении Automation runbooks, которые выполняются во время рабочего процесса runbook в Change Manager.
Примечание
Automation runbooks, указанные для рабочего процесса runbook, не могут быть выполнены, пока не будут получены все необходимые утверждения для запроса изменения.(структура)
Информация об Automation runbook, используемом в рабочем процессе runbook в Change Manager.
Примечание
Automation runbooks, указанные для рабочего процесса runbook, не могут быть выполнены, пока не будут получены все необходимые утверждения для запроса изменения.DocumentName -> (строка)
DocumentVersion -> (строка)
Parameters -> (отображение)
Словарь параметров выполнения, предоставленных при вызове StartChangeRequestExecution.
key -> (строка)
value -> (список)
TargetParameterName -> (строка)
Targets.Targets -> (список)
Сопоставление параметров с целевыми ресурсами, на которых операция runbook выполняет задачи. Требуется, если вы указываете TargetParameterName.
(структура)
Массив критериев поиска, которые нацеливаются на управляемые узлы с помощью пары «ключ-значение», которую вы указываете.
Примечание
Для задач типа Run Command в окне технического обслуживания необходимо указать один или несколько целевых объектов. В зависимости от задачи целевые объекты необязательны для других типов задач в окне технического обслуживания (Automation, Lambda и Step Functions). Дополнительную информацию о выполнении задач, не указывающих целевые объекты, см. в разделе «Регистрация задач в окне технического обслуживания без целевых объектов» в Руководстве пользователя Amazon Web Services Systems Manager.Поддерживаемые форматы включают следующие.
Key=tag-key,Values=tag-value-1,tag-value-2
Key=tag:tag-key,Values=tag-valueKey=ResourceGroup,Values=resource-group-nameKey=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-3Key=tag:tag-key,Values=tag-value-1,tag-value-2Key=resource-groups:Name,Values=resource-group-name- Кроме того, Maintenance Windows поддерживают нацеливание на типы ресурсов:
Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3Key=tag:tag-key,Values=tag-value-1,tag-value-2- Для нацеливания на все экземпляры в регионе Amazon Web Services:
Key=InstanceIds,Values=*
Дополнительную информацию о том, как отправлять команды, нацеленные на управляемые узлы с помощью параметров Key,Value, см. в разделе «Нацеливание на несколько управляемых узлов» в Руководстве пользователя Amazon Web Services Systems Manager.
Key -> (строка)
Values -> (список)
Пользовательские критерии, сопоставляемые с Key. Например, если вы указали tag:ServerRole, вы можете указать value:WebServer для запуска команды на экземплярах, включающих теги EC2 ServerRole,WebServer.
В зависимости от типа целевого объекта максимальное количество значений для ключа может быть меньше глобального максимума 50.
(строка)
TargetMaps -> (список)
Сопоставление параметров runbook с целевыми ресурсами. И Targets, и TargetMaps не могут быть указаны вместе.
(отображение)
key -> (строка)
value -> (список)
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 -> (строка)
TargetLocationMaxErrors -> (строка)
ExecutionRoleName -> (строка)
AWS-SystemsManager-AutomationExecutionRole.TargetLocationAlarmConfiguration -> (структура)
Подробности о CloudWatch-сигнализации, которую вы хотите применить к автоматизации или команде.
IgnorePollAlarmFailure -> (логическое значение)
Alarms -> (список)
Название CloudWatch-сигнализации, указанной в конфигурации.
(структура)
CloudWatch-сигнализация, которую вы применяете к автоматизации или команде.
Name -> (строка)
IncludeChildOrganizationUnits -> (логическое значение)
false.ExcludeAccounts -> (список)
Учетные записи Amazon Web Services или организационные единицы для исключения в качестве расширенных целевых объектов.
(строка)
Targets -> (список)
Список сопоставлений «ключ-значение» для нацеливания на ресурсы. Если вы указываете значения для этого типа данных, вы также должны указать значение для TargetParameterName.
Этот параметр Targets имеет приоритет над параметром StartAutomationExecution:Targets, если оба указаны.
(структура)
Массив критериев поиска, которые нацеливаются на управляемые узлы с помощью пары «ключ-значение», которую вы указываете.
Примечание
Для задач типа Run Command в окне технического обслуживания необходимо указать один или несколько целевых объектов. В зависимости от задачи целевые объекты необязательны для других типов задач в окне технического обслуживания (Automation, Lambda и Step Functions). Дополнительную информацию о выполнении задач, не указывающих целевые объекты, см. в разделе «Регистрация задач в окне технического обслуживания без целевых объектов» в Руководстве пользователя Amazon Web Services Systems Manager.Поддерживаемые форматы включают следующие.
Key=tag-key,Values=tag-value-1,tag-value-2
Key=tag:tag-key,Values=tag-valueKey=ResourceGroup,Values=resource-group-nameKey=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-3Key=tag:tag-key,Values=tag-value-1,tag-value-2Key=resource-groups:Name,Values=resource-group-name- Кроме того, Maintenance Windows поддерживают нацеливание на типы ресурсов:
Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3Key=tag:tag-key,Values=tag-value-1,tag-value-2- Для нацеливания на все экземпляры в регионе Amazon Web Services:
Key=InstanceIds,Values=*
Дополнительную информацию о том, как отправлять команды, нацеленные на управляемые узлы с помощью параметров Key,Value, см. в разделе «Нацеливание на несколько управляемых узлов» в Руководстве пользователя Amazon Web Services Systems Manager.
Key -> (строка)
Values -> (список)
Пользовательские критерии, сопоставляемые с Key. Например, если вы указали tag:ServerRole, вы можете указать value:WebServer для запуска команды на экземплярах, включающих теги EC2 ServerRole,WebServer.
В зависимости от типа целевого объекта максимальное количество значений для ключа может быть меньше глобального максимума 50.
(строка)
TargetsMaxConcurrency -> (строка)
TargetsMaxConcurrency имеет приоритет над параметром StartAutomationExecution:MaxConcurrency, если оба указаны.TargetsMaxErrors -> (строка)
TargetsMaxErrors имеет приоритет над параметром StartAutomationExecution:MaxErrors, если оба указаны.OpsItemId -> (строка)
AssociationId -> (строка)
ChangeRequestName -> (строка)
NextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.