обновить-задачу-окна-технического-обслуживания
Описание
Изменяет задачу, назначенную окну технического обслуживания. Вы не можете изменить тип задачи, но можете изменить следующие значения:
-
TaskARN. Например, вы можете изменить задачуRUN_COMMANDсAWS-RunPowerShellScriptнаAWS-RunShellScript. ServiceRoleArnTaskInvocationParametersPriorityMaxConcurrencyMaxErrors
Примечание
Для задач типа «Команда выполнения» окна технического обслуживания необходимо указать один или несколько целевых объектов. В зависимости от задачи, целевые объекты необязательны для других типов задач окна технического обслуживания (Automation, Lambda и Step Functions). Дополнительную информацию о запуске задач без указания целевых объектов см. в руководстве пользователя Amazon Web Services Systems Manager в разделе «Регистрация задач окна технического обслуживания без целевых объектов».Если значение параметра в UpdateMaintenanceWindowTask равно null, соответствующее поле не изменяется. Если вы установите Replace в значение true, все поля, необходимые для операции RegisterTaskWithMaintenanceWindow, будут обязательными для этого запроса. Неуказанные необязательные поля устанавливаются в null.
Предупреждение
При обновлении задачи окна технического обслуживания, для которой заданы параметры вTaskInvocationParameters, необходимо повторно указать все значения TaskInvocationParameters, которые вы хотите сохранить. Значения, которые вы не укажете повторно, будут удалены. Например, предположим, что при регистрации задачи «Команда выполнения» вы указали значения TaskInvocationParameters для Comment, NotificationConfig и OutputS3BucketName. Если вы обновите задачу окна технического обслуживания и укажете только другое значение OutputS3BucketName, значения для Comment и NotificationConfig будут удалены.См. также: Документация API AWS
Синтаксис
update-maintenance-window-task
--window-id <value>
--window-task-id <value>
[--targets <value>]
[--task-arn <value>]
[--service-role-arn <value>]
[--task-parameters <value>]
[--task-invocation-parameters <value>]
[--priority <value>]
[--max-concurrency <value>]
[--max-errors <value>]
[--logging-info <value>]
[--name <value>]
[--description <value>]
[--replace | --no-replace]
[--cutoff-behavior <value>]
[--alarm-configuration <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]
Параметры
--window-id (строка)
--window-task-id (строка)
--targets (список)
Целевые объекты (управляемые узлы или теги) для изменения. Управляемые узлы указываются в формате Key=instanceids,Values=instanceID_1,instanceID_2. Теги указываются в формате Key=tag_name,Values=tag_value.
Примечание
Для задач типа «Команда выполнения» окна технического обслуживания необходимо указать один или несколько целевых объектов. В зависимости от задачи, целевые объекты необязательны для других типов задач окна технического обслуживания (Automation, Lambda и Step Functions). Дополнительную информацию о запуске задач без указания целевых объектов см. в руководстве пользователя Amazon Web Services Systems Manager в разделе «Регистрация задач окна технического обслуживания без целевых объектов».(структура)
Массив критериев поиска, которые нацелены на управляемые узлы с помощью пары «ключ-значение», которую вы указываете.
Примечание
Для задач типа «Команда выполнения» окна технического обслуживания необходимо указать один или несколько целевых объектов. В зависимости от задачи, целевые объекты необязательны для других типов задач окна технического обслуживания (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. Например, если вы указали tag:ServerRole, вы могли бы указать value:WebServer, чтобы выполнить команду на экземплярах, которые включают теги EC2 ServerRole,WebServer.
В зависимости от типа целевого объекта, максимальное количество значений для ключа может быть меньше глобального максимума 50.
(строка)
Сокращённый синтаксис:
Key=string,Values=string,string ...
Синтаксис JSON:
[
{
"Key": "string",
"Values": ["string", ...]
}
...
]
--task-arn (строка)
--service-role-arn (строка)
Amazon Resource Name (ARN) роли службы IAM для Amazon Web Services Systems Manager для принятия роли при выполнении задачи окна технического обслуживания. Если вы не укажете ARN роли службы, Systems Manager использует роль связанной службы в вашем аккаунте. Если в вашем аккаунте нет соответствующей роли связанной службы для Systems Manager, она создаётся при запуске RegisterTaskWithMaintenanceWindow.
Однако для повышения уровня безопасности мы настоятельно рекомендуем создать пользовательскую политику и пользовательскую роль службы для выполнения задач вашего окна технического обслуживания. Политика может быть разработана для предоставления только необходимых разрешений для конкретных задач вашего окна технического обслуживания. Дополнительную информацию см. в разделе «Настройка окон технического обслуживания» в руководстве пользователя Amazon Web Services Systems Manager.
--task-parameters (карта)
Параметры для изменения.
Примечание
TaskParameters устарел. Чтобы указать параметры, передаваемые задаче при её запуске, используйте параметр Parameters в структуре TaskInvocationParameters. Информацию о том, как Systems Manager обрабатывает эти параметры для поддерживаемых типов задач окна технического обслуживания, см. в разделе MaintenanceWindowTaskInvocationParameters.Карта имеет следующий формат:
Ключ: строка, от 1 до 255 символов
Значение: массив строк, каждая строка от 1 до 255 символов
ключ -> (строка)
значение -> (структура)
Определяет значения для параметра задачи.
Значения -> (список)
Это поле содержит массив из 0 или более строк, каждая длиной от 1 до 255 символов.
(строка)
Сокращённый синтаксис:
KeyName1=Values=string,string,KeyName2=Values=string,string
Синтаксис JSON:
{"string": {
"Values": ["string", ...]
}
...}
--task-invocation-parameters (структура)
Параметры, которые задача должна использовать во время выполнения. Заполните только поля, соответствующие типу задачи. Все остальные поля должны быть пустыми.
Предупреждение
При обновлении задачи окна технического обслуживания, для которой указаны параметры вTaskInvocationParameters, необходимо повторно указать все значения TaskInvocationParameters, которые вы хотите сохранить. Значения, которые вы не укажете повторно, будут удалены. Например, предположим, что при регистрации задачи Run Command вы указали значения TaskInvocationParameters для Comment, NotificationConfig и OutputS3BucketName. Если вы обновите задачу окна технического обслуживания и укажете только другое значение OutputS3BucketName, значения для Comment и NotificationConfig будут удалены.RunCommand -> (структура)
Параметры для задачи типа RUN_COMMAND.
Comment -> (строка)
CloudWatchOutputConfig -> (структура)
Настройки для отправки выходных данных команды в Amazon CloudWatch Logs.
CloudWatchLogGroupName -> (строка)
Имя группы журналов CloudWatch Logs, в которую вы хотите отправить выходные данные команды. Если вы не укажете имя группы, Amazon Web Services Systems Manager автоматически создаст для вас группу журналов. Группа журналов использует следующий формат именования:
CloudWatchOutputEnabled -> (булево)
DocumentHash -> (строка)
DocumentHashType -> (строка)
DocumentVersion -> (строка)
Версия документа Amazon Web Services Systems Manager (документ SSM) для использования в запросе. Вы можете указать $DEFAULT, $LATEST или конкретный номер версии. Если вы запускаете команды с помощью Amazon Web Services CLI, вам необходимо экранировать первые два варианта с помощью обратной косой черты. Если вы указываете номер версии, вам не нужно использовать обратную косую черту. Например:
--document-version "\$DEFAULT"
--document-version "\$LATEST"
--document-version "3"
NotificationConfig -> (структура)
Настройки для отправки уведомлений о изменениях состояния команды на основе каждого управляемого узла.
NotificationArn -> (строка)
NotificationEvents -> (список)
Различные события, для которых вы можете получать уведомления. Дополнительную информацию об этих событиях см. в разделе «Мониторинг изменений состояния Systems Manager с помощью уведомлений Amazon SNS» в руководстве пользователя Amazon Web Services Systems Manager.
(строка)
NotificationType -> (строка)
Тип уведомления.
-
Command: Получение уведомления при изменении состояния команды. -
Invocation: Для команд, отправленных на несколько управляемых узлов, получение уведомления на основе каждого узла при изменении состояния команды.
OutputS3BucketName -> (строка)
OutputS3KeyPrefix -> (строка)
Parameters -> (словарь)
Параметры для выполнения задачи RUN_COMMAND.
key -> (строка)
value -> (список)
ServiceRoleArn -> (строка)
Идентификатор ресурса Amazon (ARN) роли службы IAM для Amazon Web Services Systems Manager для принятия роли при выполнении задачи окна технического обслуживания. Если вы не укажете ARN роли службы, Systems Manager использует связанную роль службы в вашей учетной записи. Если в вашей учетной записи нет соответствующей связанной роли для Systems Manager, она создается при запуске RegisterTaskWithMaintenanceWindow.
Однако для повышения безопасности мы настоятельно рекомендуем создавать собственную политику и собственную роль службы для выполнения задач окна технического обслуживания. Политика может быть составлена таким образом, чтобы предоставлять только необходимые разрешения для ваших конкретных задач окна технического обслуживания. Дополнительную информацию см. в разделе «Настройка окон технического обслуживания» в руководстве пользователя Amazon Web Services Systems Manager.
TimeoutSeconds -> (целое число)
Automation -> (структура)
Параметры для задачи типа AUTOMATION.
DocumentVersion -> (строка)
Parameters -> (словарь)
Параметры для задачи AUTOMATION.
Для получения информации об указании и обновлении параметров задач см. RegisterTaskWithMaintenanceWindow и UpdateMaintenanceWindowTask.
Примечание
LoggingInfo устарел. Для указания ведра Amazon Simple Storage Service (Amazon S3) для хранения журналов используйте вместо этого параметры OutputS3BucketName и OutputS3KeyPrefix в структуре TaskInvocationParameters. Дополнительную информацию о том, как Amazon Web Services Systems Manager обрабатывает эти параметры для поддерживаемых типов задач окна технического обслуживания, см. в разделе MaintenanceWindowTaskInvocationParameters.
TaskParameters устарел. Для указания параметров, передаваемых задаче при ее выполнении, используйте вместо этого параметр Parameters в структуре TaskInvocationParameters. Дополнительную информацию о том, как Systems Manager обрабатывает эти параметры для поддерживаемых типов задач окна технического обслуживания, см. в разделе MaintenanceWindowTaskInvocationParameters.
Для типов задач AUTOMATION Amazon Web Services Systems Manager игнорирует любые значения, указанные для этих параметров.
key -> (строка)
value -> (список)
StepFunctions -> (структура)
Параметры для задачи типа STEP_FUNCTIONS.
Input -> (строка)
STEP_FUNCTIONS.Name -> (строка)
STEP_FUNCTIONS.Lambda -> (структура)
Параметры для задачи типа LAMBDA.
ClientContext -> (строка)
Qualifier -> (строка)
Payload -> (бинарный блок)
Синтаксис JSON:
{
"RunCommand": {
"Comment": "string",
"CloudWatchOutputConfig": {
"CloudWatchLogGroupName": "string",
"CloudWatchOutputEnabled": true|false
},
"DocumentHash": "string",
"DocumentHashType": "Sha256"|"Sha1",
"DocumentVersion": "string",
"NotificationConfig": {
"NotificationArn": "string",
"NotificationEvents": ["All"|"InProgress"|"Success"|"TimedOut"|"Cancelled"|"Failed", ...],
"NotificationType": "Command"|"Invocation"
},
"OutputS3BucketName": "string",
"OutputS3KeyPrefix": "string",
"Parameters": {"string": ["string", ...]
...},
"ServiceRoleArn": "string",
"TimeoutSeconds": integer
},
"Automation": {
"DocumentVersion": "string",
"Parameters": {"string": ["string", ...]
...}
},
"StepFunctions": {
"Input": "string",
"Name": "string"
},
"Lambda": {
"ClientContext": "string",
"Qualifier": "string",
"Payload": blob
}
}
--priority (целое число)
--max-concurrency (строка)
Новое значение MaxConcurrency, которое вы хотите указать. MaxConcurrency — это количество целевых задач, которые могут выполняться параллельно.
Примечание
Хотя этот элемент указан как «Необязательно», значение можно опустить только при регистрации или обновлении задачи без целевых задач. Во всех остальных случаях необходимо предоставить значение.
Для задач окна технического обслуживания без указанной цели вы не можете указать значение для этого параметра. Вместо этого система вставляет значение-заполнитель 1. Это значение не влияет на выполнение задачи.
--max-errors (строка)
Новое значение MaxErrors, которое нужно указать. MaxErrors — это максимальное количество ошибок, допускаемых перед тем, как задача перестанет планироваться.
Примечание
Хотя этот элемент указан как «Необязательно», значение можно опустить только при регистрации или обновлении задачи без целевых задач. Во всех остальных случаях необходимо предоставить значение.
Для задач окна технического обслуживания без указанной цели вы не можете указать значение для этого параметра. Вместо этого система вставляет значение-заполнитель 1. Это значение не влияет на выполнение задачи.
--logging-info (структура)
Новое расположение журналов в Amazon S3 для указания.
Примечание
LoggingInfo устарел. Для указания ведра Amazon Simple Storage Service (Amazon S3) для хранения журналов используйте вместо этого параметры OutputS3BucketName и OutputS3KeyPrefix в структуре TaskInvocationParameters. Дополнительную информацию о том, как Amazon Web Services Systems Manager обрабатывает эти параметры для поддерживаемых типов задач окна технического обслуживания, см. в разделе MaintenanceWindowTaskInvocationParameters.S3BucketName -> (строка)
S3KeyPrefix -> (строка)
S3Region -> (строка)
Сокращенный синтаксис:
S3BucketName=string,S3KeyPrefix=string,S3Region=string
Синтаксис JSON:
{
"S3BucketName": "string",
"S3KeyPrefix": "string",
"S3Region": "string"
}
--name (строка)
--description (строка)
--replace | --no-replace (булево)
--cutoff-behavior (строка)
Указывает, должны ли задачи продолжать выполняться после достижения времени отключения, указанного в окне обслуживания.
-
CONTINUE_TASK: Когда достигается время отключения, все выполняющиеся задачи продолжают выполняться. Значение по умолчанию. -
CANCEL_TASK:- Для задач Автоматизации, Lambda, Step Functions: Когда достигается время отключения, все уже выполняющиеся вызовы задач продолжают выполняться, но новые вызовы задач не запускаются.
- Для задач «Запуск команды»: Когда достигается время отключения, система отправляет операцию CancelCommand, которая пытается отменить команду, связанную с задачей. Однако нет гарантии, что команда будет завершена, и соответствующий процесс будет остановлен.
Статус задач, которые не завершены, — TIMED_OUT.
Возможные значения:
CONTINUE_TASKCANCEL_TASK
--alarm-configuration (структура)
Сигнализация CloudWatch, которую вы хотите применить к задаче окна обслуживания.
IgnorePollAlarmFailure -> (boolean)
Alarms -> (список)
Имя сигнализации CloudWatch, указанной в конфигурации.
(структура)
Сигнализация CloudWatch, которую вы применяете к автоматизации или команде.
Name -> (строка)
Сокращенная синтаксическая запись:
IgnorePollAlarmFailure=boolean,Alarms=[{Name=string},{Name=string}]
Синтаксис JSON:
{
"IgnorePollAlarmFailure": true|false,
"Alarms": [
{
"Name": "string"
}
...
]
}
--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 (boolean)
Включить отладку протоколирования.
--endpoint-url (строка)
Переопределить URL по умолчанию команды заданным URL.
--no-verify-ssl (boolean)
По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI проверяет сертификаты SSL. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.
--no-paginate (boolean)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования для вывода команды.
- json
- text
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определенный профиль из вашего файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/выключить вывод цвета.
- on
- off
- auto
--no-sign-request (boolean)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл с набором сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь тайм-аута. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь тайм-аута. Значение по умолчанию — 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной строкой base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI версии 1, а двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настроек cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Отключить кли-паджер для вывода.
--cli-auto-prompt (boolean)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматическое запроса параметров ввода CLI.
Примеры
Примечание
Чтобы использовать следующие примеры, вы должны установить и настроить AWS CLI. Подробнее см. руководство «Начало работы» в «Руководстве пользователя AWS CLI».
Если не указано иное, все примеры используют правила цитирования, подобные правилам Unix. Эти примеры необходимо адаптировать к правилам цитирования вашей консоли. См. «Использование кавычек со строками» в «Руководстве пользователя AWS CLI».
Обновление задачи окна обслуживания
Следующий update-maintenance-window-task пример обновляет роль службы для задачи окна обслуживания.
aws ssm update-maintenance-window-task \
--window-id "mw-0c5ed765acEXAMPLE" \
--window-task-id "23d3809e-9fbe-4ddf-b41a-b49d7EXAMPLE" \
--service-role-arn "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM"
Вывод:
{
"ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM",
"MaxErrors": "1",
"TaskArn": "AWS-UpdateEC2Config",
"MaxConcurrency": "1",
"WindowTaskId": "23d3809e-9fbe-4ddf-b41a-b49d7EXAMPLE",
"TaskParameters": {},
"Priority": 1,
"TaskInvocationParameters": {
"RunCommand": {
"TimeoutSeconds": 600,
"Parameters": {
"allowDowngrade": [
"false"
]
}
}
},
"WindowId": "mw-0c5ed765acEXAMPLE",
"Description": "UpdateEC2Config",
"Targets": [
{
"Values": [
"57e8344e-fe64-4023-8191-6bf05EXAMPLE"
],
"Key": "WindowTargetIds"
}
],
"Name": "UpdateEC2Config"
}
Дополнительную информацию см. в разделе «Обновление окна обслуживания (AWS CLI)» в «Руководстве пользователя AWS Systems Manager».
Выходные данные
WindowId -> (строка)
WindowTaskId -> (строка)
Targets -> (список)
Обновленные значения целевых значений.
(структура)
Массив критериев поиска, которые нацелены на управляемые узлы, используя заданную вами пару «ключ-значение».
Примечание
Для задач типа «Запуск команды» в окнах обслуживания необходимо указать один или несколько целевых узлов. В зависимости от задачи, для других типов задач окна обслуживания (Автоматизация, 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 -> (строка)
Values -> (список)
Пользовательские критерии, которые сопоставляются с Key . Например, если вы указали tag:ServerRole, вы можете указать value:WebServer для запуска команды на экземплярах, содержащих теги EC2 ServerRole,WebServer.
В зависимости от типа целевого узла максимальное количество значений для ключа может быть ниже глобального максимума 50.
(строка)
TaskArn -> (строка)
ServiceRoleArn -> (строка)
Amazon Resource Name (ARN) роли службы IAM для Amazon Web Services Systems Manager для принятия роли при выполнении задачи окна обслуживания. Если вы не укажете ARN роли службы, Systems Manager использует связанную роль службы в вашей учетной записи. Если в вашей учетной записи нет подходящей связанной роли для Systems Manager, она создается при запуске RegisterTaskWithMaintenanceWindow.
Однако для повышения уровня безопасности настоятельно рекомендуется создавать пользовательскую политику и пользовательскую роль службы для выполнения задач ваших окон обслуживания. Политика может быть составлена таким образом, чтобы предоставлять только необходимые разрешения для конкретных задач ваших окон обслуживания. Дополнительную информацию см. в разделе «Настройка окон обслуживания» в руководстве пользователя Amazon Web Services Systems Manager.
TaskParameters -> (карта)
Обновленные значения параметров.
Примечание
TaskParameters устарело. Чтобы указать параметры, которые нужно передать задаче при ее запуске, вместо этого используйте параметр Parameters в структуре TaskInvocationParameters. Информацию о том, как Systems Manager обрабатывает эти параметры для поддерживаемых типов задач окна обслуживания, см. в разделе MaintenanceWindowTaskInvocationParameters.key -> (строка)
value -> (структура)
Определяет значения параметра задачи.
Values -> (список)
Это поле содержит массив из 0 или более строк, каждая из которых имеет длину от 1 до 255 символов.
(строка)
TaskInvocationParameters -> (структура)
Обновленные значения параметров.
RunCommand -> (структура)
Параметры для задачи типа RUN_COMMAND.
Comment -> (строка)
CloudWatchOutputConfig -> (структура)
Настройки для отправки выходных данных команды в Amazon CloudWatch Logs.
CloudWatchLogGroupName -> (строка)
Имя группы журналов CloudWatch Logs, в которую нужно отправить выходные данные команды. Если вы не укажете имя группы, Amazon Web Services Systems Manager автоматически создаст для вас группу журналов. Имя группы журналов имеет следующий формат:
CloudWatchOutputEnabled -> (булево)
DocumentHash -> (строка)
DocumentHashType -> (строка)
DocumentVersion -> (строка)
Версия документа Amazon Web Services Systems Manager (SSM-документ) для использования в запросе. Вы можете указать $DEFAULT, $LATEST или конкретный номер версии. Если вы запускаете команды с помощью Amazon Web Services CLI, то вы должны экранировать первые два варианта, используя обратный слэш. Если вы указываете номер версии, то использование обратного слэша не требуется. Например:
--document-version "\$DEFAULT"
--document-version "\$LATEST"
--document-version "3"
NotificationConfig -> (структура)
Настройки для отправки уведомлений об изменениях статуса команды для каждого управляемого узла.
NotificationArn -> (строка)
NotificationEvents -> (список)
Различные события, о которых вы можете получать уведомления. Дополнительную информацию об этих событиях см. в разделе «Мониторинг изменений статуса Systems Manager с помощью уведомлений Amazon SNS» в Руководстве пользователя Amazon Web Services Systems Manager.
(строка)
NotificationType -> (строка)
Тип уведомления.
-
Command: Получение уведомления при изменении статуса команды. -
Invocation: При отправке команд на несколько управляемых узлов, получение уведомления на основе каждого узла при изменении статуса команды.
OutputS3BucketName -> (строка)
OutputS3KeyPrefix -> (строка)
Parameters -> (карта)
Параметры выполнения задачи RUN_COMMAND.
key -> (строка)
value -> (список)
ServiceRoleArn -> (строка)
Amazon Resource Name (ARN) роли службы IAM для Amazon Web Services Systems Manager для принятия роли при выполнении задачи окна обслуживания. Если вы не укажете ARN роли службы, Systems Manager использует связанную роль службы в вашей учетной записи. Если в вашей учетной записи нет подходящей связанной роли для Systems Manager, она создается при запуске RegisterTaskWithMaintenanceWindow.
Однако для повышения уровня безопасности настоятельно рекомендуется создавать пользовательскую политику и пользовательскую роль службы для выполнения задач ваших окон обслуживания. Политика может быть составлена таким образом, чтобы предоставлять только необходимые разрешения для конкретных задач ваших окон обслуживания. Дополнительную информацию см. в разделе «Настройка окон обслуживания» в руководстве пользователя Amazon Web Services Systems Manager.
TimeoutSeconds -> (целое число)
Automation -> (структура)
Параметры для задачи типа AUTOMATION.
DocumentVersion -> (строка)
Parameters -> (карта)
Параметры для задачи AUTOMATION.
Дополнительную информацию о задании и обновлении параметров задачи см. в разделе RegisterTaskWithMaintenanceWindow и UpdateMaintenanceWindowTask.
Примечание
LoggingInfo устарело. Чтобы указать корзину Amazon Simple Storage Service (Amazon S3) для хранения журналов, используйте вместо этого параметры OutputS3BucketName и OutputS3KeyPrefix в структуре TaskInvocationParameters. Дополнительную информацию о том, как Amazon Web Services Systems Manager обрабатывает эти параметры для поддерживаемых типов задач окна обслуживания, см. в разделе MaintenanceWindowTaskInvocationParameters.
TaskParameters устарело. Чтобы указать параметры, которые нужно передать задаче при ее запуске, используйте вместо этого параметр Parameters в структуре TaskInvocationParameters. Информацию о том, как Systems Manager обрабатывает эти параметры для поддерживаемых типов задач окна обслуживания, см. в разделе MaintenanceWindowTaskInvocationParameters.
Для задач типа AUTOMATION Amazon Web Services Systems Manager игнорирует любые значения, указанные для этих параметров.
key -> (строка)
value -> (список)
StepFunctions -> (структура)
Параметры для задачи типа STEP_FUNCTIONS.
Input -> (строка)
STEP_FUNCTIONS.Name -> (строка)
STEP_FUNCTIONS.Lambda -> (структура)
Параметры для задачи типа LAMBDA.
ClientContext -> (строка)
Qualifier -> (строка)
Payload -> (байтовый массив)
Priority -> (целое число)
MaxConcurrency -> (строка)
MaxConcurrency.MaxErrors -> (строка)
MaxErrors.LoggingInfo -> (структура)
Обновленная информация о протоколировании в Amazon S3.
Примечание
LoggingInfo устарело. Чтобы указать ведро Amazon Simple Storage Service (Amazon S3) для хранения журналов, используйте вместо этого параметры OutputS3BucketName и OutputS3KeyPrefix в структуре TaskInvocationParameters. Для получения информации о том, как Amazon Web Services Systems Manager обрабатывает эти параметры для поддерживаемых типов задач окна обслуживания, см. MaintenanceWindowTaskInvocationParameters .S3BucketName -> (строка)
S3KeyPrefix -> (строка)
S3Region -> (строка)
Name -> (строка)
Description -> (строка)
CutoffBehavior -> (строка)
AlarmConfiguration -> (структура)
Подробности о CloudWatch-сигнализации, применённой к задаче окна обслуживания.
IgnorePollAlarmFailure -> (логическое значение)
Alarms -> (список)
Имя CloudWatch-сигнализации, указанной в конфигурации.
(структура)
CloudWatch-сигнализация, применённая к автоматизации или команде.
Name -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.