Spec-Zone.ru › AWS CLI v2

[ aws . health ]

describe-event-types

Описание

Возвращает типы событий, соответствующие заданным фильтрам. Вы можете использовать эту операцию API для получения информации о событиях Health, таких как категория, служба Amazon Web Services и код события. Метаданные каждого события отображаются в объекте EventType.

Если вы не укажете фильтры, операция API вернёт все типы событий в произвольном порядке.

Примечание

Данная операция API использует постраничный вывод. Укажите параметр nextToken в следующем запросе, чтобы получить больше результатов.

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

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

Синопсис

  describe-event-types
[--filter <value>]
[--locale <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]

Параметры

--filter (структура)

Значения для сужения возвращаемых результатов.

eventTypeCodes -> (список)

Список кодов типов событий.

(строка)

services -> (список)

Службы Amazon Web Services, связанные с событием. Например, EC2 , RDS .

(строка)

eventTypeCategories -> (список)

Список кодов категорий типов событий. Возможные значения — issue , accountNotification или scheduledChange . В настоящее время значение investigation не поддерживается.

(строка)

Сокращенная синтаксическая конструкция:

eventTypeCodes=string,string,services=string,string,eventTypeCategories=string,string

Синтаксис JSON:

{
  "eventTypeCodes": ["string", ...],
  "services": ["string", ...],
  "eventTypeCategories": ["issue"|"accountNotification"|"scheduledChange"|"investigation", ...]
}

--locale (строка)

Локаль (язык), в котором должна быть возвращена информация. По умолчанию используется английский (en), и на данный момент это единственное поддерживаемое значение.

--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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

eventTypes -> (список)

Список типов событий, соответствующих фильтрам. Типы событий имеют категорию (issue , accountNotification или scheduledChange ), службу (например, EC2 , RDS , DATAPIPELINE , BILLING ) и код (в формате AWS_*SERVICE* _*DESCRIPTION* `` ; for example, ``AWS_EC2_SYSTEM_MAINTENANCE_EVENT ).

(структура)

Содержит метаданные о типе события, отслеживаемого Health. EventType показывает категорию, службу и код типа события. Например, issue может быть категорией, EC2 — службой, а AWS_EC2_SYSTEM_MAINTENANCE_EVENT — кодом типа события.

Вы можете использовать операцию API DescribeEventTypes, чтобы получить эту информацию об событии.

Вы также можете использовать консоль Amazon CloudWatch Events для создания правила, которое позволит вам получать уведомления или выполнять действия, когда Health предоставляет определённое событие вашей учётной записи Amazon Web Services. Подробнее см. в Руководстве пользователя Health раздел «Отслеживание событий Health с помощью Amazon CloudWatch Events».

service -> (строка)

Служба Amazon Web Services, затронутая событием. Например, EC2 , RDS .

code -> (строка)

Уникальный идентификатор типа события. Формат — AWS_*SERVICE* _*DESCRIPTION* `` ; for example, ``AWS_EC2_SYSTEM_MAINTENANCE_EVENT .

category -> (строка)

Список кодов категорий типов событий. Возможные значения — issue , accountNotification или scheduledChange . В настоящее время значение investigation не поддерживается.

nextToken -> (строка)

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

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

Spec-Zone.ru

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