Spec-Zone.ru › AWS CLI v2

[ aws . уведомления ]

list-notification-events

Описание

Возвращает список NotificationEvents согласно заданным фильтрам в обратном хронологическом порядке (самые новые вначале).

Предупреждение

Уведомления пользователя хранятся в отдельных регионах, которые вы регистрируете как центры уведомлений, и в регионе правила источника события. ListNotificationEvents возвращает только уведомления, хранящиеся в том же регионе, в котором вызывается действие. Уведомления пользователя не заполняют уведомления в новых регионах, выбранных в качестве центров уведомлений. По этой причине рекомендуется выполнять вызовы в вашем старейшем зарегистрированном центре уведомлений. Дополнительную информацию см. в разделе «Центры уведомлений» в Руководстве пользователя Amazon Web Services User Notifications.

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

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

Синтаксис

  list-notification-events
[--start-time <value>]
[--end-time <value>]
[--locale <value>]
[--source <value>]
[--include-child-events | --no-include-child-events]
[--aggregate-notification-event-arn <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]

Параметры

--start-time (метка времени)

Самое раннее время событий, которые нужно вернуть из этого вызова.

--end-time (метка времени)

Самое позднее время событий, которые нужно вернуть из этого вызова.

--locale (строка)

Код языка региона для языка, используемого для полученных NotificationEvent. По умолчанию используется английский язык (en_US).

Возможные значения:

  • de_DE
  • en_CA
  • en_US
  • en_UK
  • es_ES
  • fr_CA
  • fr_FR
  • id_ID
  • it_IT
  • ja_JP
  • ko_KR
  • pt_BR
  • tr_TR
  • zh_CN
  • zh_TW

--source (строка)

Соответствующий источник события.

Должен совпадать с одним из допустимых источников EventBridge. Поддерживаются только события, исходящие от сервисов Amazon Web Services. Например, aws.ec2 и aws.cloudwatch. Дополнительную информацию см. в разделе «Доставка событий из сервисов Amazon Web Services» в Руководстве пользователя Amazon EventBridge.

--include-child-events | --no-include-child-events (логическое значение)

Включать агрегированные дочерние события в результат.

--aggregate-notification-event-arn (строка)

Amazon Resource Name (ARN) aggregatedNotificationEventArn для сопоставления.

--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.

Вывод

nextToken -> (строка)

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

notificationEvents -> (список)

Список событий уведомлений.

(структура)

Описание краткого резюме NotificationEvent. Используется только при перечислении событий уведомлений.

arn -> (строка)

Amazon Resource Name (ARN) ресурса.

notificationConfigurationArn -> (строка)

ARN NotificationConfiguration.

relatedAccount -> (строка)

Имя учетной записи, содержащей NotificationHub.

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

Время создания NotificationEvent.

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

Ссылается на объект NotificationEventSummary.

Аналогичная по структуре content в ответе GetNotificationEvent.

schemaVersion -> (строка)

Версия схемы события уведомления.

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

Метаданные исходного события.

eventOriginRegion -> (строка)

Регион, в котором произошло уведомление.

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

source -> (строка)

Сопоставленный источник события.

Должен совпадать с одним из допустимых источников EventBridge. Поддерживаются только события, исходящие от сервисов Amazon Web Services. Например, aws.ec2 и aws.cloudwatch. Дополнительную информацию см. в разделе Доставка событий из сервисов Amazon Web Services в Руководстве пользователя Amazon EventBridge.

eventType -> (строка)

Тип события для сопоставления.

Должен совпадать с одним из допустимых типов событий Amazon EventBridge. Например, Уведомление о состоянии экземпляра EC2 и Изменение состояния сигнализации Amazon CloudWatch. Дополнительную информацию см. в разделе Доставка событий из сервисов Amazon Web Services в Руководстве пользователя Amazon EventBridge.

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

Компоненты сообщения события уведомления.

headline -> (строка)

Резюме длиной в предложение. Например, заголовки или тема письма.

eventStatus -> (строка)

Предоставляет дополнительную информацию о текущем состоянии NotificationEvent.

  • Значения:
    • HEALTHY
      • Все EventRules находятся в состоянии ACTIVE.
    • UNHEALTHY
      • Некоторые EventRules находятся в состоянии ACTIVE, а некоторые — в состоянии INACTIVE.

notificationType -> (строка)

Тип события, вызвавшего уведомление.

  • Значения:
    • ALERT
      • Уведомление об событии, при котором что-то было запущено, инициировано, повторно открыто, развернуто или был превышен порог.
    • WARNING
      • Уведомление об событии, при котором может возникнуть проблема. Например, что-то приближается к порогу.
    • ANNOUNCEMENT
      • Уведомление о важном событии. Например, шаг в рабочем процессе или путь эскалации или обновление рабочего процесса.
    • INFORMATIONAL
      • Уведомление об информационных сообщениях. Например, рекомендации, объявления о сервисах или напоминания.

aggregationEventType -> (строка)

Тип агрегации NotificationConfiguration.

  • Значения:
    • AGGREGATE
      • Событие уведомления является агрегированным уведомлением. Агрегированные уведомления обобщают сгруппированные события за определенный период времени.
    • CHILD
      • Некоторые EventRules находятся в состоянии ACTIVE, а некоторые — в состоянии INACTIVE. Любой вызов может быть выполнен.
    • NONE
      • Уведомление не агрегировано.

aggregateNotificationEventArn -> (строка)

ARN aggregatedNotificationEventArn для сопоставления.

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

Предоставляет агрегированные сводные данные для событий уведомления.

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

Указывает количество событий, связанных с ключом агрегации.

aggregatedBy -> (список)

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

(структура)

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

name -> (строка)

Указывает тип ключа агрегации.

value -> (строка)

Указывает значение, связанное с именем ключа агрегации.

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

Указывает учетные записи Amazon Web Services в ключе агрегации.

name -> (строка)

Имя измерения сводки.

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

Общее количество вхождений для этого измерения.

sampleValues -> (список)

Указывает образцы значений, найденные в измерении.

(строка)

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

Указывает регионы Amazon Web Services в ключе агрегации.

name -> (строка)

Имя измерения сводки.

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

Общее количество вхождений для этого измерения.

sampleValues -> (список)

Указывает образцы значений, найденные в измерении.

(строка)

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

Указывает набор организационных единиц, участвующих в ключе агрегации.

name -> (строка)

Имя измерения сводки.

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

Общее количество вхождений для этого измерения.

sampleValues -> (список)

Указывает образцы значений, найденные в измерении.

(строка)

additionalSummarizationDimensions -> (список)

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

(структура)

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

name -> (строка)

Имя измерения сводки.

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

Общее количество вхождений для этого измерения.

sampleValues -> (список)

Указывает образцы значений, найденные в измерении.

(строка)

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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