Spec-Zone.ru › AWS CLI v2

[ aws . ssm ]

describe-maintenance-window-execution-tasks

Описание

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

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

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

Синтаксис

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

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

--filters (список)

Необязательные фильтры, используемые для сужения возвращаемых задач. Поддерживаемый ключ фильтра — STATUS со соответствующими значениями PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING и CANCELLED.

(структура)

Фильтр, используемый в запросе. Поддерживаемые ключи фильтров зависят от операции 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
  • текст
  • таблица
  • 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.

Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. Дополнительные сведения см. в разделе Использование кавычек со строками в Руководстве пользователя AWS CLI.

Чтобы перечислить все задачи, связанные с выполнением окна обслуживания

Следующий ssm describe-maintenance-window-execution-tasks пример перечисляет задачи, связанные с указанным выполнением окна обслуживания.

aws ssm describe-maintenance-window-execution-tasks \
    --window-execution-id "518d5565-5969-4cca-8f0e-da3b2EXAMPLE"

Вывод:

{
    "WindowExecutionTaskIdentities": [
        {
            "Status": "SUCCESS",
            "TaskArn": "AWS-RunShellScript",
            "StartTime": 1487692834.684,
            "TaskType": "RUN_COMMAND",
            "EndTime": 1487692835.005,
            "WindowExecutionId": "518d5565-5969-4cca-8f0e-da3b2EXAMPLE",
            "TaskExecutionId": "ac0c6ae1-daa3-4a89-832e-d3845EXAMPLE"
        }
    ]
}

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

Вывод

WindowExecutionTaskIdentities -> (список)

Информация о выполнениях задач.

(структура)

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

WindowExecutionId -> (строка)

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

TaskExecutionId -> (строка)

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

Статус -> (строка)

Статус выполнения задачи.

StatusDetails -> (строка)

Подробности, объясняющие статус выполнения задачи. Не доступно для всех значений статуса.

StartTime -> (временная метка)

Время начала выполнения задачи.

EndTime -> (временная метка)

Время завершения выполнения задачи.

TaskArn -> (строка)

Amazon Resource Name (ARN) задачи, которая была выполнена.

TaskType -> (строка)

Тип задачи, которая была выполнена.

AlarmConfiguration -> (структура)

Подробности для CloudWatch-тревоги, применённой к задаче вашего окна обслуживания.

IgnorePollAlarmFailure -> (булево)

Когда это значение равно true , ваша автоматизация или команда продолжают выполняться в случаях, когда мы не можем получить информацию о состоянии тревоги из CloudWatch. В случаях, когда мы успешно получаем состояние тревоги OK или INSUFFICIENT_DATA, автоматизация или команда продолжают выполняться независимо от этого значения. По умолчанию false.

Alarms -> (список)

Название CloudWatch-тревоги, указанной в конфигурации.

(структура)

CloudWatch-тревога, которую вы применяете к автоматизации или команде.

Name -> (строка)

Имя вашей CloudWatch-тревоги.

TriggeredAlarms -> (список)

CloudWatch-тревога, которая была вызвана задачей окна обслуживания.

(структура)

Подробности о состоянии вашей CloudWatch-тревоги.

Name -> (строка)

Имя вашей CloudWatch-тревоги.

State -> (строка)

Состояние вашей CloudWatch-тревоги.

NextToken -> (строка)

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

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

Spec-Zone.ru

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