Skip to content

DescribeNotificationRuleResult

Source code in docs_src/capo_codestar_notifications/types/describe_notification_rule_result.py
class DescribeNotificationRuleResult(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>"""
    event_types: NotRequired[
        "capo_codestar_notifications.types.event_type_batch.EventTypeBatch"
    ]
    """<p>A list of the event types associated with the notification rule.</p>"""
    resource: NotRequired[
        "capo_codestar_notifications.types.notification_rule_resource.NotificationRuleResource"
    ]
    """<p>The Amazon Resource Name (ARN) of the resource associated with the notification rule.</p>"""
    targets: NotRequired["capo_codestar_notifications.types.targets_batch.TargetsBatch"]
    """<p>A list of the Amazon Q Developer in chat applications topics and Amazon Q Developer in chat applications clients associated with the notification rule.</p>"""
    detail_type: NotRequired["capo_codestar_notifications.types.detail_type.DetailType"]
    """<p>The level of detail included 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>"""
    created_by: NotRequired[
        "capo_codestar_notifications.types.notification_rule_created_by.NotificationRuleCreatedBy"
    ]
    """<p>The name or email alias of the person who created the notification rule.</p>"""
    status: NotRequired[
        "capo_codestar_notifications.types.notification_rule_status.NotificationRuleStatus"
    ]
    """<p>The status of the notification rule. Valid statuses are on (sending notifications) or off (not sending notifications).</p>"""
    created_timestamp: NotRequired[
        "capo_codestar_notifications.types.created_timestamp.CreatedTimestamp"
    ]
    """<p>The date and time the notification rule was created, in timestamp format.</p>"""
    last_modified_timestamp: NotRequired[
        "capo_codestar_notifications.types.last_modified_timestamp.LastModifiedTimestamp"
    ]
    """<p>The date and time the notification rule was most recently updated, in timestamp format.</p>"""
    tags: NotRequired["capo_codestar_notifications.types.tags.Tags"]
    """<p>The tags associated with the notification rule.</p>"""

arn instance-attribute

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

created_by instance-attribute

created_by: NotRequired[NotificationRuleCreatedBy]

The name or email alias of the person who created the notification rule.

created_timestamp instance-attribute

created_timestamp: NotRequired[CreatedTimestamp]

The date and time the notification rule was created, in timestamp format.

detail_type instance-attribute

detail_type: NotRequired[DetailType]

The level of detail included 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_types instance-attribute

event_types: NotRequired[EventTypeBatch]

A list of the event types associated with the notification rule.

last_modified_timestamp instance-attribute

last_modified_timestamp: NotRequired[LastModifiedTimestamp]

The date and time the notification rule was most recently updated, in timestamp format.

name instance-attribute

name: NotRequired[NotificationRuleName]

The name of the notification rule.

resource instance-attribute

resource: NotRequired[NotificationRuleResource]

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

status instance-attribute

status: NotRequired[NotificationRuleStatus]

The status of the notification rule. Valid statuses are on (sending notifications) or off (not sending notifications).

tags instance-attribute

tags: NotRequired[Tags]

The tags associated with the notification rule.

targets instance-attribute

targets: NotRequired[TargetsBatch]

A list of the Amazon Q Developer in chat applications topics and Amazon Q Developer in chat applications clients associated with the notification rule.