Spec-Zone.ru › AWS CLI v2

[ aws . ssm ]

describe-maintenance-window-execution-task-invocations

Описание

Возвращает отдельные выполнения задач (по одному на целевой объект) для определённой задачи, выполненной в рамках выполнения окна обслуживания.

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

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

Синтаксис

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

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

--task-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
  • text
  • таблица
  • 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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого файла, которое соответствует двоичному блоку, 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-window-execution-task-invocations отображает вызовы для указанной задачи, выполненной в рамках указанного выполнения окна обслуживания.

aws ssm describe-maintenance-window-execution-task-invocations \
    --window-execution-id "518d5565-5969-4cca-8f0e-da3b2a638355" \
    --task-id "ac0c6ae1-daa3-4a89-832e-d384503b6586"

Вывод:

{
    "WindowExecutionTaskInvocationIdentities": [
        {
            "Status": "SUCCESS",
            "Parameters": "{\"documentName\":\"AWS-RunShellScript\",\"instanceIds\":[\"i-0000293ffd8c57862\"],\"parameters\":{\"commands\":[\"df\"]},\"maxConcurrency\":\"1\",\"maxErrors\":\"1\"}",
            "InvocationId": "e274b6e1-fe56-4e32-bd2a-8073c6381d8b",
            "StartTime": 1487692834.723,
            "EndTime": 1487692834.871,
            "WindowExecutionId": "518d5565-5969-4cca-8f0e-da3b2a638355",
            "TaskExecutionId": "ac0c6ae1-daa3-4a89-832e-d384503b6586"
        }
    ]
}

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

Вывод

WindowExecutionTaskInvocationIdentities -> (список)

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

(структура)

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

WindowExecutionId -> (строка)

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

TaskExecutionId -> (строка)

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

InvocationId -> (строка)

Идентификатор вызова задачи.

ExecutionId -> (строка)

Идентификатор действия, выполненного в сервисе, который фактически обработался вызов задачи. Если тип задачи — RUN_COMMAND, это идентификатор команды.

TaskType -> (строка)

Тип задачи.

Parameters -> (строка)

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

Status -> (строка)

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

StatusDetails -> (строка)

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

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

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

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

Время завершения вызова.

OwnerInformation -> (строка)

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

WindowTargetId -> (строка)

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

NextToken -> (строка)

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

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

Spec-Zone.ru

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