Spec-Zone.ru › AWS CLI v2

[ aws . ssm ]

describe-maintenance-window-targets

Описание

Отображает цели, зарегистрированные в окне обслуживания.

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

describe-maintenance-window-targets является постраничной операцией. Для получения всего набора результатов могут быть выполнены несколько вызовов API. Вы можете отключить постраничность, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничной обработкой, аргумент --query должен извлекать данные из результатов следующих выражений запроса: Targets

Синтаксис

  describe-maintenance-window-targets
--window-id <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 (строка)

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

--filters (список)

Дополнительные фильтры, которые могут использоваться для сужения области возвращаемых целей окна. Поддерживаемые ключи фильтров — Type, WindowTargetId и OwnerInformation.

(структура)

Фильтр, используемый в запросе. Поддерживаемые ключи фильтров зависят от операции API, которая включает фильтр. Операции API, использующие MaintenanceWindowFilter>, включают следующие:

  • DescribeMaintenanceWindowExecutions
  • DescribeMaintenanceWindowExecutionTaskInvocations
  • DescribeMaintenanceWindowExecutionTasks
  • DescribeMaintenanceWindows
  • DescribeMaintenanceWindowTargets
  • DescribeMaintenanceWindowTasks

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

Название фильтра.

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

Значения фильтра.

(строка)

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

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 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.

Пример 1: Чтобы отобразить все цели для окна обслуживания

Следующий describe-maintenance-window-targets пример отображает все цели для окна обслуживания.

aws ssm describe-maintenance-window-targets \
    --window-id "mw-06cf17cbefEXAMPLE"

Вывод:

{
    "Targets": [
        {
            "ResourceType": "INSTANCE",
            "OwnerInformation": "Single instance",
            "WindowId": "mw-06cf17cbefEXAMPLE",
            "Targets": [
                {
                    "Values": [
                        "i-0000293ffdEXAMPLE"
                    ],
                    "Key": "InstanceIds"
                }
            ],
            "WindowTargetId": "350d44e6-28cc-44e2-951f-4b2c9EXAMPLE"
        },
        {
            "ResourceType": "INSTANCE",
            "OwnerInformation": "Two instances in a list",
            "WindowId": "mw-06cf17cbefEXAMPLE",
            "Targets": [
                {
                    "Values": [
                        "i-0000293ffdEXAMPLE",
                        "i-0cb2b964d3EXAMPLE"
                    ],
                    "Key": "InstanceIds"
                }
            ],
            "WindowTargetId": "e078a987-2866-47be-bedd-d9cf4EXAMPLE"
        }
    ]
}

Пример 2: Чтобы отобразить все цели для окна обслуживания, соответствующие определенному значению информации об владельце

Этот describe-maintenance-window-targets пример отображает все цели для окна обслуживания со значением.

aws ssm describe-maintenance-window-targets \
    --window-id "mw-0ecb1226ddEXAMPLE" \
    --filters "Key=OwnerInformation,Values=CostCenter1"

Вывод:

{
    "Targets": [
        {
            "WindowId": "mw-0ecb1226ddEXAMPLE",
            "WindowTargetId": "da89dcc3-7f9c-481d-ba2b-edcb7d0057f9",
            "ResourceType": "INSTANCE",
            "Targets": [
                {
                    "Key": "tag:Environment",
                    "Values": [
                        "Prod"
                    ]
                }
            ],
            "OwnerInformation": "CostCenter1",
            "Name": "ProdTarget1"
        }
    ]
}

Дополнительные сведения см. в разделе Просмотр информации о окнах обслуживания (AWS CLI) в Руководстве пользователя AWS Systems Manager.

Выходные данные

Цели -> (список)

Информация о целях в окне технического обслуживания.

(структура)

Цель, зарегистрированная в окне технического обслуживания.

WindowId -> (строка)

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

WindowTargetId -> (строка)

Идентификатор цели.

ResourceType -> (строка)

Тип цели, которая регистрируется в окне технического обслуживания.

Цели -> (список)

Цели, управляемые узлы или метки.

Укажите управляемые узлы в следующем формате:

Key=instanceids,Values=<instanceid1>,<instanceid2>

Метки указываются в следующем формате:

Key=<tag name>,Values=<tag value>.

(структура)

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

Примечание

Для задач типа «Запуск команды» в окне технического обслуживания необходимо указать одну или несколько целей. В зависимости от задачи, цели являются необязательными для других типов задач окна технического обслуживания (Автоматизация, 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. Например, если вы указали tag:ServerRole, вы можете указать value:WebServer, чтобы выполнить команду на экземплярах, которые включают метки EC2 ServerRole,WebServer.

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

(строка)

OwnerInformation -> (строка)

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

Имя -> (строка)

Название цели окна технического обслуживания.

Описание -> (строка)

Описание цели.

NextToken -> (строка)

Токен для запроса следующего набора элементов. Если дополнительных элементов нет, строка пустая.

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

Spec-Zone.ru

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