Spec-Zone.ru › AWS CLI v2

[ aws . codestar-notifications ]

обновить-правило-уведомления

Описание

Обновляет правило уведомления для ресурса. Вы можете изменить события, которые запускают правило уведомления, состояние правила и целевые объекты, которые получают уведомления.

Примечание

Для добавления или удаления тегов для правила уведомления необходимо использовать TagResource и UntagResource.

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

Синтаксис

  update-notification-rule
--arn <value>
[--name <value>]
[--status <value>]
[--event-type-ids <value>]
[--targets <value>]
[--detail-type <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) правила уведомления.

--name (строка)

Имя правила уведомления.

--status (строка)

Состояние правила уведомления. Допустимые состояния включают enabled (отправка уведомлений) или disabled (не отправлять уведомлений).

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

  • ENABLED
  • DISABLED

--event-type-ids (список)

Список типов событий, связанных с этим правилом уведомления. Полный список типов событий и идентификаторов см. в разделе «Концепции уведомлений» в Руководстве пользователя консоли инструментов разработчика.

(строка)

Синтаксис:

"string" "string" ...

--targets (список)

Список адресов и типов целевых объектов, которые должны получать уведомления от этого правила уведомления.

(структура)

Информация о темах бота или клиентах бота, связанных с правилом уведомления.

TargetType -> (строка)

Тип целевого объекта. Может быть темой бота или клиентом бота.

  • Темы бота указываются как SNS.
  • Клиенты бота указываются как AWSChatbotSlack.

TargetAddress -> (строка)

Amazon Resource Name (ARN) темы бота или клиента бота.

Сокращенный синтаксис:

TargetType=string,TargetAddress=string ...

Синтаксис JSON:

[
  {
    "TargetType": "string",
    "TargetAddress": "string"
  }
  ...
]

--detail-type (строка)

Уровень детализации, который следует включить в уведомления для данного ресурса. BASIC будет содержать только содержимое события, как оно отображается в Amazon CloudWatch. FULL будет содержать любую дополнительную информацию, предоставленную AWS CodeStar Notifications и/или сервисом для ресурса, для которого создается уведомление.

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

  • BASIC
  • FULL

--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
  • таблица
  • 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.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Более подробную информацию см. в руководстве «Начало работы» в Руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры потребуют адаптации к правилам цитирования вашей оболочки. См. раздел «Использование кавычек со строками» в Руководстве пользователя AWS CLI.

Для обновления правила уведомления

Следующий update-notification-rule пример обновляет правило уведомления с именем MyNotificationRule в учетной записи AWS 123456789012, используя файл JSON с именем update.json.

aws codestar-notifications update-notification-rule \
    --cli-input-json file://update.json

Содержимое update.json:

{
    "Name": "MyUpdatedNotificationRule",
    "EventTypeIds": [
        "codecommit-repository-branches-and-tags-created"
    ],
    "Resource": "arn:aws:codecommit:us-east-1:123456789012:MyDemoRepo",
    "Targets": [
        {
            "TargetType": "SNS",
            "TargetAddress": "arn:aws:sns:us-east-1:123456789012:MyNotificationTopic"
        }
    ],
    "Status": "ENABLED",
    "DetailType": "FULL"
}

Вывод:

{
    "Arn": "arn:aws:codestar-notifications:us-east-1:123456789012:notificationrule/dc82df7a-EXAMPLE"
}

Дополнительную информацию см. в разделе «Редактирование правила уведомления» в Руководстве пользователя консоли инструментов разработчика AWS.

Вывод

Нет

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

Spec-Zone.ru

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