Spec-Zone.ru › AWS CLI v2

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

list-managed-notification-events

Описание

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

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

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

Синтаксис

  list-managed-notification-events
[--start-time <value>]
[--end-time <value>]
[--locale <value>]
[--source <value>]
[--organizational-unit-id <value>]
[--related-account <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 (строка)

Сервис Amazon Web Services, откуда произошло событие. Например, aws.cloudwatch.

--organizational-unit-id (строка)

Идентификатор Организационной единицы, к которой принадлежит учётная запись Amazon Web Services.

--related-account (строка)

Идентификатор учётной записи Amazon Web Services, связанной с управляемыми событиями уведомлений.

--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
  • таблица
  • 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 для вывода.

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

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

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

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

Вывод

nextToken -> (строка)

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

managedNotificationEvents -> (список)

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

(структура)

Описание обзора и метаданных для ManagedNotificationEvent.

arn -> (строка)

Amazon Resource Name (ARN) управляемого события уведомления.

managedNotificationConfigurationArn -> (строка)

Amazon Resource Name (ARN) ManagedNotificationConfiguration .

relatedAccount -> (строка)

Аккаунт, связанный с ManagedNotificationEvent .

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

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

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

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

schemaVersion -> (строка)

Версия схемы ManagedNotificationEvent .

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

Содержит метаданные о событии, которое вызвало ManagedNotificationEvent .

eventOriginRegion -> (строка)

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

source -> (строка)

Источник службы уведомления.

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

eventType -> (строка)

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

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

Содержит компонент заголовка сообщения.

headline -> (строка)

Краткое описание предложения. Например, заголовки или тема электронного письма.

eventStatus -> (строка)

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

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

notificationType -> (строка)

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

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

aggregationEventType -> (строка)

Тип агрегации уведомлений.

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

organizationalUnitId -> (строка)

Идентификатор организационной единицы, к которой принадлежит аккаунт Amazon Web Services.

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 -> (список)

Указывает примерные значения, найденные в измерении.

(строка)

aggregatedNotificationRegions -> (список)

Список регионов, в которых произошли агрегированные уведомления в этом NotificationEvent .

(строка)

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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