Skip to content

Update Notification Rule

codestarnotifications_update_notification_rule R Documentation

Updates a notification rule for a resource

Description

Updates a notification rule for a resource. You can change the events that trigger the notification rule, the status of the rule, and the targets that receive the notifications.

To add or remove tags for a notification rule, you must use tag_resource and untag_resource.

Usage

codestarnotifications_update_notification_rule(Arn, Name, Status,
  EventTypeIds, Targets, DetailType)

Arguments

Arn

[required] The Amazon Resource Name (ARN) of the notification rule.

Name

The name of the notification rule.

Status

The status of the notification rule. Valid statuses include enabled (sending notifications) or disabled (not sending notifications).

EventTypeIds

A list of event types associated with this notification rule. For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide.

Targets

The address and type of the targets to receive notifications from this notification rule.

DetailType

The level of detail to include in the notifications for this resource. BASIC will include only the contents of the event as it would appear in Amazon CloudWatch. FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.

Value

An empty list.

Request syntax

svc$update_notification_rule(
  Arn = "string",
  Name = "string",
  Status = "ENABLED"|"DISABLED",
  EventTypeIds = list(
    "string"
  ),
  Targets = list(
    list(
      TargetType = "string",
      TargetAddress = "string"
    )
  ),
  DetailType = "BASIC"|"FULL"
)