Spec-Zone.ru › AWS CLI v2

[ aws . ssm ]

get-maintenance-window-task

Описание

Получает детали задачи окна обслуживания.

Примечание

Для задач окон обслуживания без указанной цели вы не можете указать значения для --max-errors и --max-concurrency . Вместо этого система вставляет значение-заполнитель 1, которое может быть отображено в ответе на эту команду. Эти значения не влияют на выполнение вашей задачи и могут быть проигнорированы.

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

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

Синтаксис

  get-maintenance-window-task
--window-id <value>
--window-task-id <value>
[--cli-input-json | --cli-input-yaml]
[--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 (строка)

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

--window-task-id (строка)

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

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставляются в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного JSON-значения, так как строка будет интерпретирована буквально. Это не может быть указано вместе с --cli-input-yaml.

--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 версии 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.

Получение информации о задаче окна обслуживания

Следующий get-maintenance-window-task пример извлекает подробности о заданной задаче окна обслуживания.

aws ssm get-maintenance-window-task \
    --window-id mw-0c5ed765acEXAMPLE \
    --window-task-id 0e842a8d-2d44-4886-bb62-af8dcEXAMPLE

Вывод:

{
    "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM",
    "MaxErrors": "1",
    "TaskArn": "AWS-RunPowerShellScript",
    "MaxConcurrency": "1",
    "WindowTaskId": "0e842a8d-2d44-4886-bb62-af8dcEXAMPLE",
    "TaskParameters": {},
    "Priority": 1,
    "TaskInvocationParameters": {
        "RunCommand": {
            "Comment": "",
            "TimeoutSeconds": 600,
            "Parameters": {
                "commands": [
                    "echo Hello"
                ],
                "executionTimeout": [
                    "3600"
                ],
                "workingDirectory": [
                    ""
                ]
            }
        }
    },
    "WindowId": "mw-0c5ed765acEXAMPLE",
    "TaskType": "RUN_COMMAND",
    "Targets": [
        {
            "Values": [
                "84c818da-b619-4d3d-9651-946f3EXAMPLE"
            ],
            "Key": "WindowTargetIds"
        }
    ],
    "Name": "ExampleTask"
}

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

Вывод

WindowId -> (строка)

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

WindowTaskId -> (строка)

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

Targets -> (список)

Целевые объекты, в которых должна выполняться задача.

(структура)

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

Примечание

Для задач типа «Запуск команды» окна технического обслуживания необходимо указать один или несколько целевых объектов. В зависимости от задачи целевые объекты могут быть необязательными для других типов задач окна технического обслуживания (Автоматизация, 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 и Maintenance Windows:
  • 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
  • Кроме того, Maintenance Windows поддерживает нацеливание на типы ресурсов:
    • 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 -> (строка)

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

Values -> (список)

Пользовательские критерии, которые сопоставляются с Key. Например, если вы указали tag:ServerRole, вы можете указать value:WebServer, чтобы запустить команду на экземплярах, включающих теги EC2 с ServerRole,WebServer.

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

(строка)

TaskArn -> (строка)

Ресурс, используемый задачей во время выполнения. Для задач типа RUN_COMMAND и AUTOMATION значение TaskArn — это имя/ARN документа SSM. Для задач типа LAMBDA — это имя/ARN функции. Для задач типа STEP_FUNCTIONS — это ARN машины состояний.

ServiceRoleArn -> (строка)

Amazon Resource Name (ARN) роли службы IAM для Amazon Web Services Systems Manager для принятия роли при выполнении задачи окна технического обслуживания. Если вы не укажете ARN роли службы, Systems Manager использует роль, связанную со службой, в вашей учетной записи. Если в вашей учетной записи нет подходящей роли, связанной со службой Systems Manager, она создаётся при запуске RegisterTaskWithMaintenanceWindow.

Однако для повышения уровня безопасности мы настоятельно рекомендуем создать пользовательскую политику и пользовательскую роль службы для выполнения задач окна технического обслуживания. Политика может быть сформулирована таким образом, чтобы предоставлять только разрешения, необходимые для конкретных задач окна технического обслуживания. Дополнительную информацию см. в руководстве пользователя Amazon Web Services Systems Manager, раздел «Настройка окон технического обслуживания».

TaskType -> (строка)

Тип задачи для выполнения.

TaskParameters -> (карта)

Параметры, передаваемые задаче при её запуске.

Примечание

TaskParameters устарело. Чтобы указать параметры, которые необходимо передать задаче при её запуске, используйте вместо этого параметр Parameters в структуре TaskInvocationParameters. Дополнительную информацию о том, как Systems Manager обрабатывает эти параметры для поддерживаемых типов задач окна технического обслуживания, см. в документе MaintenanceWindowTaskInvocationParameters.

key -> (строка)

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

Определяет значения для параметра задачи.

Values -> (список)

Это поле содержит массив из 0 или более строк, каждая длиной от 1 до 255 символов.

(строка)

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

Параметры, передаваемые задаче при её запуске.

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

Параметры для задачи типа RUN_COMMAND.

Comment -> (строка)

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

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

Настройки для отправки вывода команды в Amazon CloudWatch Logs.

CloudWatchLogGroupName -> (строка)

Имя группы журналов CloudWatch Logs, в которую вы хотите отправить вывод команды. Если вы не укажете имя группы, Amazon Web Services Systems Manager автоматически создаст для вас группу журналов. Группа журналов использует следующий формат именования:

``aws/ssm/SystemsManagerDocumentName ``

CloudWatchOutputEnabled -> (булево)

Включает отправку вывода команды в CloudWatch Logs.

DocumentHash -> (строка)

SHA-256 или SHA-1 хеш, созданный системой при создании документа. Хеши SHA-1 устарели.

DocumentHashType -> (строка)

SHA-256 или SHA-1. Хеши SHA-1 устарели.

DocumentVersion -> (строка)

Версия документа Amazon Web Services Systems Manager (документ SSM) для использования в запросе. Вы можете указать $DEFAULT, $LATEST или конкретный номер версии. Если вы запускаете команды с помощью Amazon Web Services CLI, то вам нужно экранировать первые два варианта с помощью обратной косой черты. Если вы указываете номер версии, то использовать обратную косую черту не нужно. Например:

--document-version "\$DEFAULT"

--document-version "\$LATEST"

--document-version "3"

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

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

NotificationArn -> (строка)

Amazon Resource Name (ARN) темы Amazon Simple Notification Service (Amazon SNS). Run Command отправляет уведомления об изменениях статуса команды в эту тему.

NotificationEvents -> (список)

Различные события, для которых вы можете получать уведомления. Более подробную информацию об этих событиях см. в руководстве пользователя Amazon Web Services Systems Manager, раздел «Мониторинг изменений состояния Systems Manager с помощью уведомлений Amazon SNS».

(строка)

NotificationType -> (строка)

Тип уведомления.

  • Command: Получение уведомления при изменении статуса команды.
  • Invocation: При отправке команд на несколько управляемых узлов получение уведомления на уровне каждого узла при изменении статуса команды.

OutputS3BucketName -> (строка)

Имя ведра Amazon Simple Storage Service (Amazon S3).

OutputS3KeyPrefix -> (строка)

Подпапка ведра S3.

Parameters -> (карта)

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

key -> (строка)

value -> (список)

(строка)

ServiceRoleArn -> (строка)

Amazon Resource Name (ARN) роли службы IAM для Amazon Web Services Systems Manager для принятия роли при выполнении задачи окна технического обслуживания. Если вы не укажете ARN роли службы, Systems Manager использует роль, связанную со службой, в вашей учетной записи. Если в вашей учетной записи нет подходящей роли, связанной со службой Systems Manager, она создаётся при запуске RegisterTaskWithMaintenanceWindow.

Однако для повышения уровня безопасности мы настоятельно рекомендуем создать пользовательскую политику и пользовательскую роль службы для выполнения задач окна технического обслуживания. Политика может быть сформулирована таким образом, чтобы предоставлять только разрешения, необходимые для конкретных задач окна технического обслуживания. Дополнительную информацию см. в руководстве пользователя Amazon Web Services Systems Manager, раздел «Настройка окон технического обслуживания».

TimeoutSeconds -> (целое число)

Если это время достигнуто, а команда ещё не начала выполнение, она не запускается.

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

Параметры для задачи типа AUTOMATION.

DocumentVersion -> (строка)

Версия сценария Automation для использования при выполнении задачи.

Parameters -> (карта)

Параметры для задачи типа AUTOMATION.

Дополнительную информацию об указании и обновлении параметров задачи см. в разделах RegisterTaskWithMaintenanceWindow и UpdateMaintenanceWindowTask.

Примечание

LoggingInfo устарело. Чтобы указать ведро Amazon Simple Storage Service (Amazon S3) для хранения логов, используйте вместо этого параметры OutputS3BucketName и OutputS3KeyPrefix в структуре TaskInvocationParameters. Дополнительную информацию о том, как Amazon Web Services Systems Manager обрабатывает эти параметры для поддерживаемых типов задач окна технического обслуживания, см. в документе MaintenanceWindowTaskInvocationParameters.

TaskParameters устарело. Чтобы указать параметры для передачи задаче при её запуске, используйте вместо этого параметр Parameters в структуре TaskInvocationParameters. Дополнительную информацию о том, как Systems Manager обрабатывает эти параметры для поддерживаемых типов задач окна технического обслуживания, см. в документе MaintenanceWindowTaskInvocationParameters.

Для задач типа AUTOMATION Amazon Web Services Systems Manager игнорирует любые значения, указанные для этих параметров.

key -> (строка)

value -> (список)

(строка)

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

Параметры для задачи типа STEP_FUNCTIONS.

Input -> (строка)

Входные данные для задачи типа STEP_FUNCTIONS.

Name -> (строка)

Имя задачи типа STEP_FUNCTIONS.

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

Параметры для задачи типа LAMBDA.

ClientContext -> (строка)

Передайте информацию, специфичную для клиента, функции Lambda, которую вы вызываете. Затем вы можете обработать информацию клиента в вашей функции Lambda по своему усмотрению через переменную контекста.

Qualifier -> (строка)

(Необязательно) Укажите версию или псевдоним функции Lambda. Если вы указываете версию функции, операция использует квалифицированный Amazon Resource Name (ARN) функции для вызова конкретной функции Lambda. Если вы указываете псевдоним, операция использует ARN псевдонима для вызова версии функции Lambda, на которую указывает псевдоним.

Payload -> (двоичные данные)

JSON для предоставления функции Lambda в качестве входных данных.

Priority -> (целое число)

Приоритет задачи во время её выполнения. Чем меньше число, тем выше приоритет. Задачи с одинаковым приоритетом планируются параллельно.

MaxConcurrency -> (string)

Максимальное количество целевых задач, которые могут выполняться этой задачей параллельно.

Примечание

Для задач окна обслуживания без указанной цели вы не можете указать значение для этого параметра. Вместо этого система вставляет значение-заполнитель 1, которое может быть отображено в ответе на эту команду. Это значение не влияет на выполнение вашей задачи и может быть проигнорировано.

MaxErrors -> (string)

Максимальное количество ошибок, разрешённых перед тем, как задача перестанет планироваться.

Примечание

Для задач окна обслуживания без указанной цели вы не можете указать значение для этого параметра. Вместо этого система вставляет значение-заполнитель 1, которое может быть отображено в ответе на эту команду. Это значение не влияет на выполнение вашей задачи и может быть проигнорировано.

LoggingInfo -> (structure)

Расположение в Amazon Simple Storage Service (Amazon S3), где регистрируются результаты задачи.

Примечание

LoggingInfo устарело. Чтобы указать ведро Amazon Simple Storage Service (Amazon S3) для хранения журналов, используйте вместо этого параметры OutputS3BucketName и OutputS3KeyPrefix в структуре TaskInvocationParameters. Сведения о том, как Amazon Web Services Systems Manager обрабатывает эти параметры для поддерживаемых типов задач окна обслуживания, см. в MaintenanceWindowTaskInvocationParameters.

S3BucketName -> (string)

Имя ведра S3, в котором хранятся журналы выполнения.

S3KeyPrefix -> (string)

(Необязательно) Подпапка ведра S3.

S3Region -> (string)

Регион Amazon Web Services, в котором расположено ведро S3.

Name -> (string)

Полученное имя задачи.

Description -> (string)

Полученное описание задачи.

CutoffBehavior -> (string)

Действие, выполняемое с задачами при достижении времени завершения окна обслуживания. CONTINUE_TASK означает, что задачи продолжают выполняться. Для задач Automation, Lambda, Step Functions CANCEL_TASK означает, что текущие вызовы задач продолжаются, но новые вызовы задач не запускаются. Для задач Run Command CANCEL_TASK означает, что система пытается остановить задачу, отправив операцию CancelCommand.

AlarmConfiguration -> (structure)

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

IgnorePollAlarmFailure -> (boolean)

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

Alarms -> (list)

Имя CloudWatch-сигнализации, указанной в конфигурации.

(structure)

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

Name -> (string)

Название вашей CloudWatch-сигнализации.

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

Spec-Zone.ru

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