Spec-Zone.ru › AWS CLI v2

[ aws . ssm ]

update-maintenance-window-target

Описание

Изменяет целевой объект существующего окна обслуживания. Вы можете изменить следующее:

  • Имя
  • Описание
  • Владелец
  • Идентификаторы для целевого объекта по идентификатору
  • Теги для целевого объекта по тегу
  • Из любого поддерживаемого типа тега в другой. Три поддерживаемых типа тегов — целевой объект по идентификатору, целевой объект по тегу и группа ресурсов. Дополнительную информацию см. в разделе Целевой объект.

Примечание

Если параметр равен null, соответствующее поле не изменяется.

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

Синтаксис

  update-maintenance-window-target
--window-id <value>
--window-target-id <value>
[--targets <value>]
[--owner-information <value>]
[--name <value>]
[--description <value>]
[--replace | --no-replace]
[--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-target-id (строка)

Идентификатор целевого объекта для изменения.

--targets (список)

Целевые объекты для добавления или замены.

(структура)

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

Примечание

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

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

Для всех инструментов 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 и окон обслуживания:
  • 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 User Guide в разделе Назначение нескольких управляемых узлов.

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

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

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

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

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

(строка)

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

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

Синтаксис JSON:

[
  {
    "Key": "string",
    "Values": ["string", ...]
  }
  ...
]

--owner-information (строка)

Предоставленное пользователем значение, которое будет включено во все события Amazon CloudWatch Events, созданные во время выполнения задач для этих целевых объектов в данном окне обслуживания.

--name (строка)

Название обновления.

--description (строка)

Необязательное описание обновления.

--replace | --no-replace (логическое значение)

Если True, то все поля, необходимые для операции RegisterTargetWithMaintenanceWindow, также необходимы для этого запроса API. Необязательные поля, которые не указаны, устанавливаются в null.

--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 в руководстве AWS CLI User Guide.

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

Для обновления целевого объекта окна обслуживания

Следующий пример update-maintenance-window-target обновляет только имя целевого объекта окна обслуживания.

aws ssm update-maintenance-window-target \
    --window-id "mw-0c5ed765acEXAMPLE" \
    --window-target-id "57e8344e-fe64-4023-8191-6bf05EXAMPLE" \
    --name "NewName" \
    --no-replace

Вывод:

{
    "Description": "",
    "OwnerInformation": "",
    "WindowTargetId": "57e8344e-fe64-4023-8191-6bf05EXAMPLE",
    "WindowId": "mw-0c5ed765acEXAMPLE",
    "Targets": [
        {
            "Values": [
                "i-1234567890EXAMPLE"
            ],
            "Key": "InstanceIds"
        }
    ],
    "Name": "NewName"
}

Дополнительную информацию см. в руководстве AWS Systems Manager User Guide в разделе Обновление окна обслуживания (AWS CLI).

Вывод

WindowId -> (строка)

Идентификатор окна технического обслуживания, указанный в запросе обновления.

WindowTargetId -> (строка)

Идентификатор целевой области, указанный в запросе обновления.

Targets -> (список)

Обновленные целевые области.

(структура)

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

Примечание

Необходимо указать одну или несколько целевых областей для задач типа 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 и окон технического обслуживания:
  • 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 -> (строка)

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

Values -> (список)

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

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

(строка)

OwnerInformation -> (строка)

Обновленный владелец.

Name -> (строка)

Обновленное имя.

Description -> (строка)

Обновленное описание.

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

Spec-Zone.ru

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