describe-maintenance-windows-for-target
Описание
Извлекает информацию о целевых задачах или заданиях окна обслуживания, с которыми связан управляемый узел.
См. также: Документация API AWS
describe-maintenance-windows-for-target является постраничной операцией. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить постраничность, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной загрузкой аргумент --query должен извлекать данные из результатов следующих выражений запроса: WindowIdentities
Синтаксис
describe-maintenance-windows-for-target
--targets <value>
--resource-type <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]
Параметры
--targets (список)
Идентификатор управляемого узла или пара «ключ-значение» для извлечения информации.
(структура)
Массив критериев поиска, которые нацелены на управляемые узлы с использованием пары «ключ-значение», которую вы указываете.
Примечание
Для задач типа «Команда выполнения» в окне обслуживания необходимо указать один или несколько целевых узлов. В зависимости от задачи, целевые узлы необязательны для других типов задач окна обслуживания (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- Кроме того, окна обслуживания поддерживают нацеливание на типы ресурсов:
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", ...]
}
...
]
--resource-type (строка)
Тип ресурса, для которого требуется информация. Например, INSTANCE.
Возможные значения:
INSTANCERESOURCE_GROUP
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы указаны в командной строке, эти значения переопределят значения, предоставленные JSON. Передать произвольные двоичные значения с помощью предоставленного значения JSON невозможно, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания точки начала постраничной загрузки. Это NextToken из ранее усеченного ответа.
Примеры использования см. в разделе «Постраничная загрузка» в руководстве пользователя AWS CLI.
--page-size (целое число)
Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выходных данных команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.
Примеры использования см. в разделе «Постраничная загрузка» в руководстве пользователя AWS CLI.
--max-items (целое число)
Общее количество элементов, которые должны быть возвращены в выходных данных команды. Если общее количество доступных элементов превышает указанное значение, в выходных данных команды предоставляется NextToken. Для возобновления постраничной загрузки необходимо предоставить значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken непосредственно вне AWS CLI.
Примеры использования см. в разделе «Постраничная загрузка» в руководстве пользователя AWS CLI.
--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 (int)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет ограничено по времени. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение установлено в 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.
Для отображения всех окон обслуживания, связанных с определенным экземпляром
Следующий пример describe-maintenance-windows-for-target отображает окна обслуживания, которые имеют целевые объекты или задачи, связанные с указанным экземпляром.
aws ssm describe-maintenance-windows-for-target \
--targets Key=InstanceIds,Values=i-1234567890EXAMPLE \
--resource-type INSTANCE
Вывод:
{
"WindowIdentities": [
{
"WindowId": "mw-0c5ed765acEXAMPLE",
"Name": "My-First-Maintenance-Window"
}
]
}
Дополнительную информацию см. в руководстве пользователя AWS Systems Manager в разделе «Просмотр информации об окнах обслуживания (AWS CLI»).
Вывод
WindowIdentities -> (список)
Информация о целевых задачах и задачах окна обслуживания, с которыми связан управляемый узел.
(структура)
Окно обслуживания, к которому принадлежит указанный целевой объект.
WindowId -> (строка)
Name -> (строка)
NextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.