Skip to content

UpdateNotificationRuleRequest

Source code in docs_src/capo_codestar_notifications/types/update_notification_rule_request.py
class UpdateNotificationRuleRequest(TypedDict, closed=True):
    arn: "capo_codestar_notifications.types.notification_rule_arn.NotificationRuleArn"
    """<p>The Amazon Resource Name (ARN) of the notification rule.</p>"""
    name: NotRequired[
        "capo_codestar_notifications.types.notification_rule_name.NotificationRuleName"
    ]
    """<p>The name of the notification rule.</p>"""
    status: NotRequired[
        "capo_codestar_notifications.types.notification_rule_status.NotificationRuleStatus"
    ]
    """<p>The status of the notification rule. Valid statuses include enabled (sending notifications) or disabled (not sending notifications).</p>"""
    event_type_ids: NotRequired[
        "capo_codestar_notifications.types.event_type_ids.EventTypeIds"
    ]
    """<p>A list of event types associated with this notification rule. For a complete list of event types and IDs, see <a href="https://docs.aws.amazon.com/codestar-notifications/latest/userguide/concepts.html#concepts-api">Notification concepts</a> in the <i>Developer Tools Console User Guide</i>.</p>"""
    targets: NotRequired["capo_codestar_notifications.types.targets.Targets"]
    """<p>The address and type of the targets to receive notifications from this notification rule.</p>"""
    detail_type: NotRequired["capo_codestar_notifications.types.detail_type.DetailType"]
    """<p>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 CodeStar Notifications and/or the service for the resource for which the notification is created.</p>"""

arn instance-attribute

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

detail_type instance-attribute

detail_type: NotRequired[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 CodeStar Notifications and/or the service for the resource for which the notification is created.

event_type_ids instance-attribute

event_type_ids: NotRequired[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.

name instance-attribute

name: NotRequired[NotificationRuleName]

The name of the notification rule.

status instance-attribute

status: NotRequired[NotificationRuleStatus]

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

targets instance-attribute

targets: NotRequired[Targets]

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