describe-maintenance-window-tasks

Описание

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

Примечание

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

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

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

Синтаксис

  describe-maintenance-window-tasks
--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 (список)

Необязательные фильтры, используемые для сужения области возвращаемых задач. Поддерживаемые ключи фильтров — WindowTaskId, TaskArn, Priority и TaskType.

(структура)

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

--cli-auto-prompt (булево)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматический запрос параметров ввода CLI.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве пользователя по началу работы с AWS CLI.

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

Пример 1: Вывод всех задач для окна обслуживания

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

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

Вывод:

{
    "Tasks": [
        {
            "WindowId": "mw-06cf17cbefEXAMPLE",
            "WindowTaskId": "018b31c3-2d77-4b9e-bd48-c91edEXAMPLE",
            "TaskArn": "AWS-RestartEC2Instance",
            "TaskParameters": {},
            "Type": "AUTOMATION",
            "Description": "Restarting EC2 Instance for maintenance",
            "MaxConcurrency": "1",
            "MaxErrors": "1",
            "Name": "My-Automation-Example-Task",
            "Priority": 0,
            "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM",
            "Targets": [
                {
                    "Key": "WindowTargetIds",
                    "Values": [
                        "da89dcc3-7f9c-481d-ba2b-edcb7EXAMPLE"
                    ]
                }
            ]
        },
        {
            "WindowId": "mw-06cf17cbefEXAMPLE",
            "WindowTaskId": "1943dee0-0a17-4978-9bf4-3cc2fEXAMPLE",
            "TaskArn": "AWS-DisableS3BucketPublicReadWrite",
            "TaskParameters": {},
            "Type": "AUTOMATION",
            "Description": "Automation task to disable read/write access on public S3 buckets",
            "MaxConcurrency": "10",
            "MaxErrors": "5",
            "Name": "My-Disable-S3-Public-Read-Write-Access-Automation-Task",
            "Priority": 0,
            "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM",
            "Targets": [
                {
                    "Key": "WindowTargetIds",
                    "Values": [
                        "da89dcc3-7f9c-481d-ba2b-edcb7EXAMPLE"
                    ]
                }
            ]
        }
    ]
}

Пример 2: Вывод всех задач для окна обслуживания, вызывающих документ команды AWS-RunPowerShellScript

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

aws ssm describe-maintenance-window-tasks \
    --window-id "mw-ab12cd34eEXAMPLE" \
    --filters "Key=TaskArn,Values=AWS-RunPowerShellScript"

Вывод:

{
    "Tasks": [
        {
            "WindowId": "mw-ab12cd34eEXAMPLE",
            "WindowTaskId": "0d36e6b4-3a4f-411e-adcb-3558eEXAMPLE",
            "TaskArn": "AWS-RunPowerShellScript",
            "Type": "RUN_COMMAND",
            "Targets": [
                {
                    "Key": "WindowTargetIds",
                    "Values": [
                        "da89dcc3-7f9c-481d-ba2b-edcb7EXAMPLE"
                    ]
                }
            ],
            "TaskParameters": {},
            "Priority": 1,
            "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM",
            "MaxConcurrency": "1",
            "MaxErrors": "1",
            "Name": "MyTask"
        }
    ]
}

Пример 3: Вывод всех задач для окна обслуживания, у которых Приоритет равен 3

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

aws ssm describe-maintenance-window-tasks \
    --window-id "mw-ab12cd34eEXAMPLE" \
    --filters "Key=Priority,Values=3"

Вывод:

{
    "Tasks": [
        {
            "WindowId": "mw-ab12cd34eEXAMPLE",
            "WindowTaskId": "0d36e6b4-3a4f-411e-adcb-3558eEXAMPLE",
            "TaskArn": "AWS-RunPowerShellScript",
            "Type": "RUN_COMMAND",
            "Targets": [
                {
                    "Key": "WindowTargetIds",
                    "Values": [
                        "da89dcc3-7f9c-481d-ba2b-edcb7EXAMPLE"
                    ]
                }
            ],
            "TaskParameters": {},
            "Priority": 3,
            "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM",
            "MaxConcurrency": "1",
            "MaxErrors": "1",
            "Name": "MyRunCommandTask"
        },
        {
            "WindowId": "mw-ab12cd34eEXAMPLE",
            "WindowTaskId": "ee45feff-ad65-4a6c-b478-5cab8EXAMPLE",
            "TaskArn": "AWS-RestartEC2Instance",
            "Type": "AUTOMATION",
            "Targets": [
                {
                    "Key": "WindowTargetIds",
                    "Values": [
                        "da89dcc3-7f9c-481d-ba2b-edcb7EXAMPLE"
                    ]
                }
            ],
            "TaskParameters": {},
            "Priority": 3,
            "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM",
            "MaxConcurrency": "10",
            "MaxErrors": "5",
            "Name": "My-Automation-Task",
            "Description": "A description for my Automation task"
        }
    ]
}

Пример 4: Вывод всех задач для окна обслуживания, у которых Приоритет равен 1 и используется Run Command

Этот describe-maintenance-window-tasks пример выводит все задачи для указанного окна обслуживания, у которых Priority равен 1 и используется Run Command.

aws ssm describe-maintenance-window-tasks \
    --window-id "mw-ab12cd34eEXAMPLE" \
    --filters "Key=Priority,Values=1" "Key=TaskType,Values=RUN_COMMAND"

Вывод:

{
    "Tasks": [
        {
            "WindowId": "mw-ab12cd34eEXAMPLE",
            "WindowTaskId": "0d36e6b4-3a4f-411e-adcb-3558eEXAMPLE",
            "TaskArn": "AWS-RunPowerShellScript",
            "Type": "RUN_COMMAND",
            "Targets": [
                {
                    "Key": "WindowTargetIds",
                    "Values": [
                        "da89dcc3-7f9c-481d-ba2b-edcb7EXAMPLE"
                    ]
                }
            ],
            "TaskParameters": {},
            "Priority": 1,
            "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM",
            "MaxConcurrency": "1",
            "MaxErrors": "1",
            "Name": "MyRunCommandTask"
        }
    ]
}

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

Вывод

Задачи -> (список)

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

(структура)

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

WindowId -> (строка)

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

WindowTaskId -> (строка)

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

TaskArn -> (строка)

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

Type -> (строка)

Тип задачи.

Targets -> (список)

Цели (управляемые узлы или теги). Управляемые узлы указываются с помощью Key=instanceids,Values=<instanceid1>,<instanceid2>. Теги указываются с помощью Key=<tag name>,Values=<tag value>.

(структура)

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

Примечание

Необходимо указать одну или несколько целей для задач типа Run Command в окне технического обслуживания. В зависимости от задачи, цели необязательны для других типов задач окна технического обслуживания (Automation, 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 -> (строка)

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

Values -> (список)

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

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

(строка)

TaskParameters -> (карта)

Параметры, которые должны быть переданы задаче при её выполнении.

Примечание

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

key -> (строка)

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

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

Values -> (список)

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

(строка)

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

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

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

Информация об S3-ведре для записи журналов задач.

Примечание

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

S3BucketName -> (строка)

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

S3KeyPrefix -> (строка)

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

S3Region -> (строка)

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

ServiceRoleArn -> (строка)

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

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

MaxConcurrency -> (строка)

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

Примечание

Хотя этот элемент указан как «Требуется: Нет», значение можно опустить только при регистрации или обновлении задачи без целей. Во всех остальных случаях необходимо предоставить значение.

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

MaxErrors -> (строка)

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

Примечание

Name -> (строка)

Имя задачи.

Description -> (строка)

Описание задачи.

CutoffBehavior -> (строка)

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

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

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

IgnorePollAlarmFailure -> (логическое значение)

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

Alarms -> (список)

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

(структура)

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

Name -> (строка)

Имя вашей сигнализации CloudWatch.

NextToken -> (строка)

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

END_OF_DOCUMENT_MARKER