Spec-Zone.ru › AWS CLI v2

[ aws . ec2 ]

describe-instance-event-windows

Описание

Описывает указанные окна событий или все окна событий.

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

Дополнительную информацию см. в разделе Определение окон событий для запланированных событий в руководстве пользователя Amazon EC2 .

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

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

Синтаксис

  describe-instance-event-windows
[--dry-run | --no-dry-run]
[--instance-event-window-ids <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]

Параметры

--dry-run | --no-dry-run (boolean)

Проверяет, есть ли у вас необходимые разрешения для действия, не отправляя фактический запрос, и предоставляет ответ об ошибке. Если у вас есть необходимые разрешения, ответ об ошибке является DryRunOperation. В противном случае это UnauthorizedOperation.

--instance-event-window-ids (список)

Идентификаторы окон событий.

(строка)

Синтаксис:

"string" "string" ...

--filters (список)

Один или несколько фильтров.

  • dedicated-host-id - Окна событий, связанные с указанным идентификатором выделенного хоста.
  • event-window-name - Окна событий, связанные с указанными именами.
  • instance-id - Окна событий, связанные с указанным идентификатором экземпляра.
  • instance-tag - Окна событий, связанные с указанным тегом и значением.
  • instance-tag-key - Окна событий, связанные с указанным ключом тега, независимо от значения.
  • instance-tag-value - Окна событий, связанные с указанным значением тега, независимо от ключа.
  • tag:<key> - Комбинация ключ/значение тега, назначенного окну событий. Используйте ключ тега в имени фильтра, а значение тега в качестве значения фильтра. Например, чтобы найти все ресурсы, имеющие тег с ключом Owner и значением CMX, укажите tag:Owner для имени фильтра и CMX для значения фильтра.
  • tag-key - Ключ тега, назначенного окну событий. Используйте этот фильтр для поиска всех окон событий, имеющих тег с определенным ключом, независимо от значения тега.
  • tag-value - Значение тега, назначенного окну событий. Используйте этот фильтр для поиска всех окон событий, имеющих тег с определенным значением, независимо от ключа тега.

(структура)

Пара ключ-значение фильтра, используемая для возврата более конкретного списка результатов из операции describe. Фильтры могут использоваться для сопоставления набора ресурсов по определенным критериям, таким как теги, атрибуты или идентификаторы.

Если вы указываете несколько фильтров, фильтры объединяются с помощью AND, и запрос возвращает только результаты, соответствующие всем указанным фильтрам.

Дополнительную информацию см. в разделе Список и фильтрация с помощью командной строки и API в руководстве пользователя Amazon EC2 .

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

Имя фильтра. Имена фильтров чувствительны к регистру.

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

Значения фильтра. Значения фильтров чувствительны к регистру. Если вы указываете несколько значений для фильтра, значения объединяются с помощью OR, и запрос возвращает все результаты, соответствующие любому из указанных значений.

(строка)

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

Name=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

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

--starting-token (строка)

Маркер для указания точки начала постраничной обработки. Это NextToken из ранее усеченного ответа.

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

--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 (boolean)

Включить отладку логирования.

--endpoint-url (строка)

Переопределить стандартный URL команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого подключения SSL AWS CLI проверяет сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки сертификатов SSL.

--no-paginate (boolean)

Отключить автоматическую пагинацию. Если автоматическая пагинация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

  • json
  • text
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

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

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/окружения.

--version (строка)

Отображение версии этого инструмента.

--color (строка)

Включение/выключение цветного вывода.

  • включить
  • выключить
  • авто

--no-sign-request (boolean)

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

--ca-bundle (строка)

Файл сертификатов CA для использования при проверке сертификатов SSL. Переопределяет настройки конфигурации/окружения.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию - 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 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 (boolean)

Отключить постраничную обработку вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Примеры

Примечание

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

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

Пример 1: Описание всех окон событий

Следующий describe-instance-event-windows пример описывает все окна событий в указанном регионе.

aws ec2 describe-instance-event-windows \
    --region us-east-1

Вывод:

{
    "InstanceEventWindows": [
        {
            "InstanceEventWindowId": "iew-0abcdef1234567890",
            "Name": "myEventWindowName",
            "CronExpression": "* 21-23 * * 2,3",
            "AssociationTarget": {
                "InstanceIds": [
                    "i-1234567890abcdef0",
                    "i-0598c7d356eba48d7"
                ],
                "Tags": [],
                "DedicatedHostIds": []
            },
            "State": "active",
            "Tags": []
        }

        ...

    ],
    "NextToken": "9d624e0c-388b-4862-a31e-a85c64fc1d4a"
}

Пример 2: Описание конкретного окна событий

Следующий describe-instance-event-windows пример описывает конкретное событие, используя параметр instance-event-window для описания конкретного окна событий.

aws ec2 describe-instance-event-windows \
    --region us-east-1 \
    --instance-event-window-ids iew-0abcdef1234567890

Вывод:

{
    "InstanceEventWindows": [
        {
            "InstanceEventWindowId": "iew-0abcdef1234567890",
            "Name": "myEventWindowName",
            "CronExpression": "* 21-23 * * 2,3",
            "AssociationTarget": {
                "InstanceIds": [
                    "i-1234567890abcdef0",
                    "i-0598c7d356eba48d7"
                ],
                "Tags": [],
                "DedicatedHostIds": []
            },
            "State": "active",
            "Tags": []
        }
}

Пример 3: Описание окон событий, соответствующих одному или нескольким фильтрам

Следующий describe-instance-event-windows пример описывает окна событий, соответствующие одному или нескольким фильтрам, используя параметр filter. Фильтр instance-id используется для описания всех окон событий, связанных с указанной экземпляром. При использовании фильтра выполняется точное соответствие. Однако фильтр instance-id отличается. Если нет точного соответствия идентификатору экземпляра, то происходит обращение к косвенным связям с окном событий, таким как теги экземпляра или идентификатор выделенного хоста (если экземпляр является выделенным хостом).

aws ec2 describe-instance-event-windows \
    --region us-east-1 \
    --filters Name=instance-id,Values=i-1234567890abcdef0 \
    --max-results 100 \
    --next-token <next-token-value>

Вывод:

{
    "InstanceEventWindows": [
        {
            "InstanceEventWindowId": "iew-0dbc0adb66f235982",
            "TimeRanges": [
                {
                    "StartWeekDay": "sunday",
                    "StartHour": 2,
                    "EndWeekDay": "sunday",
                    "EndHour": 8
                }
            ],
            "Name": "myEventWindowName",
            "AssociationTarget": {
                "InstanceIds": [],
                "Tags": [],
                "DedicatedHostIds": [
                    "h-0140d9a7ecbd102dd"
                ]
            },
            "State": "active",
            "Tags": []
        }
    ]
}

В примере вывода экземпляр находится на выделенном хосте, который связан с окном событий.

Дополнительную информацию о ограничениях окон событий см. в Руководстве пользователя Amazon EC2.

Вывод

InstanceEventWindows -> (список)

Информация о окнах событий.

(структура)

Окно событий.

InstanceEventWindowId -> (строка)

Идентификатор окна событий.

TimeRanges -> (список)

Одно или несколько временных диапазонов, определенных для окна событий.

(структура)

Дата и время начала и окончания временного диапазона в формате UTC.

StartWeekDay -> (строка)

День начала временного диапазона.

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

Час начала временного диапазона.

EndWeekDay -> (строка)

День окончания временного диапазона.

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

Час окончания временного диапазона.

Name -> (строка)

Имя окна событий.

CronExpression -> (строка)

Выражение cron, определенное для окна событий.

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

Один или несколько целевых объектов, связанных с окном событий.

InstanceIds -> (список)

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

(строка)

Tags -> (список)

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

Обратите внимание, что, хотя вы не можете создавать ключи тегов, начинающиеся с aws:, вы можете указать существующие управляемые Amazon Web Services ключи тегов (с префиксом aws:), когда вы указываете их как целевые объекты для связи с окном событий.

(структура)

Описывает тег.

Key -> (строка)

Ключ тега.

Ограничения: ключи тегов чувствительны к регистру и принимают максимум 127 символов Unicode. Не должны начинаться с aws:.

Value -> (строка)

Значение тега.

Ограничения: значения тегов чувствительны к регистру и принимают максимум 256 символов Unicode.

DedicatedHostIds -> (список)

Идентификаторы выделенных хостов, связанных с окном событий.

(строка)

State -> (строка)

Текущее состояние окна событий.

Tags -> (список)

Теги экземпляра, связанные с окном событий.

(структура)

Описывает тег.

Key -> (строка)

Ключ тега.

Ограничения: ключи тегов чувствительны к регистру и принимают максимум 127 символов Unicode. Не должны начинаться с aws:.

Value -> (строка)

Значение тега.

Ограничения: значения тегов чувствительны к регистру и принимают максимум 256 символов Unicode.

NextToken -> (строка)

Токен для получения следующей страницы результатов. Это значение null, когда больше результатов нет.

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

Spec-Zone.ru

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