Spec-Zone.ru › AWS CLI v2

[ aws . devops-guru ]

list-notification-channels

Описание

Возвращает список каналов уведомлений, настроенных для DevOps Guru. Каждый канал уведомлений используется для уведомления вас, когда DevOps Guru генерирует понимание, которое содержит информацию о том, как улучшить ваши операции. Поддерживаемый канал уведомлений — Amazon Simple Notification Service (Amazon SNS).

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

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

Синтаксис

  list-notification-channels
[--cli-input-json | --cli-input-yaml]
[--starting-token <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]

Параметры

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

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

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

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

--max-items (целое число)

Общее количество элементов, которые нужно вернуть в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничной загрузки укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

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

--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 для вывода.

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

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

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

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

Вывод

Channels -> (список)

Массив, содержащий запрошенные каналы уведомлений.

(структура)

Информация о канале уведомлений. Канал уведомлений используется для уведомления вас, когда DevOps Guru создаёт понимание. Поддерживаемый канал уведомлений — Amazon Simple Notification Service (Amazon SNS).

Если вы используете тему Amazon SNS в другой учётной записи, необходимо добавить к ней политику, предоставляющую DevOps Guru разрешение отправлять ей уведомления. DevOps Guru добавляет необходимую политику от вашего имени для отправки уведомлений с использованием Amazon SNS в вашей учётной записи. DevOps Guru поддерживает только стандартные темы SNS. Дополнительная информация приведена в разделе Разрешения для тем Amazon SNS.

Если вы используете тему Amazon SNS, зашифрованную с помощью управляемого ключа (CMK) службы управления ключами Amazon Web Services, необходимо добавить разрешения к CMK. Дополнительная информация приведена в разделе Разрешения для тем Amazon SNS, зашифрованных с помощью ключей Amazon Web Services KMS.

Id -> (строка)

Идентификатор канала уведомлений.

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

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

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

Информация о канале уведомлений, настроенном в DevOps Guru для отправки уведомлений при создании понимания.

Если вы используете тему Amazon SNS в другой учётной записи, необходимо добавить к ней политику, предоставляющую DevOps Guru разрешение отправлять ей уведомления. DevOps Guru добавляет необходимую политику от вашего имени для отправки уведомлений с использованием Amazon SNS в вашей учётной записи. DevOps Guru поддерживает только стандартные темы SNS. Дополнительная информация приведена в разделе Разрешения для тем Amazon SNS.

Если вы используете тему Amazon SNS, зашифрованную с помощью управляемого ключа (CMK) службы управления ключами Amazon Web Services, необходимо добавить разрешения к CMK. Дополнительная информация приведена в разделе Разрешения для тем Amazon SNS, зашифрованных с помощью ключей Amazon Web Services KMS.

TopicArn -> (строка)

Идентификатор ресурса Amazon (ARN) темы Amazon Simple Notification Service.

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

Настройки фильтра для темы уведомлений Amazon SNS, которую вы используете с DevOps Guru. Если вы не предоставляете настройки фильтра, используются настройки по умолчанию для получения уведомлений обо всех типах сообщений с уровнем серьёзности High или Medium.

Severities -> (список)

Уровни серьёзности, для которых вы хотите получать уведомления. Например, вы можете выбрать получение уведомлений только для понимания с уровнями серьёзности HIGH и MEDIUM. Дополнительная информация приведена в разделе Понимание уровней серьёзности понимания.

(строка)

MessageTypes -> (список)

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

(строка)

NextToken -> (строка)

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

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

Spec-Zone.ru

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