Spec-Zone.ru › AWS CLI v2

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

get-notification-event

Описание

Возвращает указанное NotificationEvent .

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

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

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

Синтаксис

  get-notification-event
--arn <value>
[--locale <value>]
[--cli-input-json | --cli-input-yaml]
[--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]

Параметры

--arn (строка)

Amazon Resource Name (ARN) возвращаемого NotificationEvent .

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

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

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

Вывод

arn -> (строка)

ARN ресурса.

notificationConfigurationArn -> (строка)

ARN NotificationConfiguration .

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

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

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

Содержимое NotificationEvent .

schemaVersion -> (строка)

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

id -> (строка)

Уникальный идентификатор NotificationEvent .

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

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

eventTypeVersion -> (строка)

Версия типа события.

sourceEventId -> (строка)

Идентификатор исходного события.

eventOriginRegion -> (строка)

Регион происхождения события.

relatedAccount -> (строка)

Основной аккаунт Amazon Web Services SourceEvent .

source -> (строка)

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

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

Дата и время возникновения исходного события. Основано на исходном событии.

eventType -> (строка)

Тип события. Например, изменение состояния Amazon CloudWatch.

relatedResources -> (список)

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

(структура)

Ресурс, затронутый или тесно связанный с событием.

id -> (строка)

Уникальный идентификатор ресурса.

Требуется хотя бы один id или ARN.

arn -> (строка)

Amazon Resource Name (ARN) ресурса. Требуется хотя бы один id или ARN.

detailUrl -> (строка)

Ссылка на страницу с подробностями ресурса. Если ссылка на страницу с подробностями недоступна, это ссылка на информационную страницу, описывающую тип ресурса.

tags -> (список)

Карта тегов, присвоенных ресурсу. Тег — это строковая карта пар ключ-значение.

(строка)

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

Описание компонентов сообщения уведомления.

headline -> (строка)

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

paragraphSummary -> (строка)

Краткое изложение в абзаце или в нескольких предложениях. Например, уведомления чат-бота.

completeDescription -> (строка)

Полное изложение со всей возможной релевантной информацией.

dimensions -> (список)

Список свойств в парах ключ-значение. Пары показаны в порядке убывания важности. Каналы могут ограничить количество отображаемых измерений для просмотра уведомлений.

Примечание

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

(структура)

Пара ключ-значение свойств для события.

name -> (строка)

Название измерения

value -> (строка)

Значение измерения.

sourceEventDetailUrl -> (строка)

Ссылка на исходное событие.

sourceEventDetailUrlDisplayText -> (строка)

Подробная ссылка на исходное событие.

notificationType -> (строка)

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

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

eventStatus -> (строка)

Оценённая природа события.

  • Значения:
    • HEALTHY
      • Все EventRules ACTIVE и любой вызов может быть запущен.
    • UNHEALTHY
      • Некоторые EventRules ACTIVE, а некоторые INACTIVE. Любой вызов может быть запущен.

aggregationEventType -> (строка)

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

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

aggregateNotificationEventArn -> (строка)

Если значение aggregationEventType не равно NONE, это Amazon Resource Event (ARN) родительского агрегированного уведомления.

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

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

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

(строка)

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

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

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

Время окончания события.

textParts -> (карта)

Список текстовых значений.

key -> (строка)

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

Описывает объекты текстовой информации, содержащие поля, которые определяют, как составлены объекты текстовых частей.

type -> (строка)

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

displayText -> (строка)

Краткое описание ссылки в одной строке. Должна быть гиперссылкой с самим URL.

Используется для текстовых частей с типом URL .

textByLocale -> (карта)

Карта локалей к тексту на этом языке.

key -> (строка)

value -> (строка)

url -> (строка)

Сам URL.

media -> (список)

Список элементов мультимедиа.

(структура)

Описание элемента мультимедиа.

mediaId -> (строка)

Уникальный идентификатор мультимедиа.

type -> (строка)

Тип мультимедиа.

url -> (строка)

URL мультимедиа.

caption -> (строка)

Подпись к мультимедиа.

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

Spec-Zone.ru

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