describe-maintenance-window-schedule
Описание
Получает информацию о предстоящих запусках окна обслуживания.
См. также: Документация API AWS
describe-maintenance-window-schedule — это страницованная операция. Для получения всего набора результатов могут потребоваться несколько вызовов API. Вы можете отключить страницовку, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе со страницовкой, аргумент --query должен извлекать данные из результатов следующих выражений запроса: ScheduledWindowExecutions
Синтаксис
describe-maintenance-window-schedule
[--window-id <value>]
[--targets <value>]
[--resource-type <value>]
[--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]
Параметры
--window-id (строка)
--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
--filters (список)
Фильтры, используемые для ограничения области результатов. Например, вы можете ограничить запуски окна обслуживания только теми, которые запланированы до или после определенной даты и времени.
(структура)
Определяет фильтр, используемый в API Patch Manager. Поддерживаемые ключи фильтров зависят от операции API, включающей фильтр. Операции API Patch Manager, использующие PatchOrchestratorFilter, включают следующие:
- DescribeAvailablePatches
- DescribeInstancePatches
- DescribePatchBaselines
- DescribePatchGroups
Ключ -> (строка)
Значения -> (список)
Значение фильтра.
(строка)
Сокращенный синтаксис:
Key=string,Values=string,string ...
Синтаксис JSON:
[
{
"Key": "string",
"Values": ["string", ...]
}
...
]
--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 (целое число)
Максимальное время чтения сокета в секундах. Если значение установлено в 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.
Пример 1: Отображение предстоящих выполнений для окна обслуживания
Следующий describe-maintenance-window-schedule пример отображает все предстоящие выполнения для указанного окна обслуживания.
aws ssm describe-maintenance-window-schedule \
--window-id mw-ab12cd34eEXAMPLE
Вывод:
{
"ScheduledWindowExecutions": [
{
"WindowId": "mw-ab12cd34eEXAMPLE",
"Name": "My-First-Maintenance-Window",
"ExecutionTime": "2020-02-19T16:00Z"
},
{
"WindowId": "mw-ab12cd34eEXAMPLE",
"Name": "My-First-Maintenance-Window",
"ExecutionTime": "2020-02-26T16:00Z"
},
...
]
}
Пример 2: Отображение всех предстоящих выполнений для окна обслуживания до указанной даты
Следующий describe-maintenance-window-schedule пример отображает все предстоящие выполнения для указанного окна обслуживания, которые происходят до указанной даты.
aws ssm describe-maintenance-window-schedule \
--window-id mw-0ecb1226dd7b2e9a6 \
--filters "Key=ScheduledBefore,Values=2020-02-15T06:00:00Z"
Пример 3: Отображение всех предстоящих выполнений для окна обслуживания после указанной даты
Следующий describe-maintenance-window-schedule пример отображает все предстоящие выполнения для указанного окна обслуживания, которые происходят после указанной даты.
aws ssm describe-maintenance-window-schedule \
--window-id mw-0ecb1226dd7b2e9a6 \
--filters "Key=ScheduledAfter,Values=2020-02-15T06:00:00Z"
Дополнительную информацию см. в разделе «Просмотр информации о графиках окон обслуживания (AWS CLI)» в Руководстве пользователя AWS Systems Manager.
Вывод
ScheduledWindowExecutions -> (список)
Информация о запланированных выполнениях окон обслуживания для указанного диапазона времени.
(структура)
Информация о запланированном выполнении окна обслуживания.
WindowId -> (строка)
Name -> (строка)
ExecutionTime -> (строка)
NextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.