Skip to content

CreateNotificationRuleRequest

Source code in docs_src/capo_codestar_notifications/types/create_notification_rule_request.py
class CreateNotificationRuleRequest(TypedDict, closed=True):
    name: (
        "capo_codestar_notifications.types.notification_rule_name.NotificationRuleName"
    )
    """<p>The name for the notification rule. Notification rule names must be unique in your Amazon Web Services account.</p>"""
    event_type_ids: "capo_codestar_notifications.types.event_type_ids.EventTypeIds"
    """<p>A list of event types associated with this notification rule. For a list of allowed events, see <a>EventTypeSummary</a>.</p>"""
    resource: "capo_codestar_notifications.types.notification_rule_resource.NotificationRuleResource"
    """<p>The Amazon Resource Name (ARN) of the resource to associate with the notification rule. Supported resources include pipelines in CodePipeline, repositories in CodeCommit, and build projects in CodeBuild.</p>"""
    targets: "capo_codestar_notifications.types.targets.Targets"
    """<p>A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Amazon Q Developer in chat applications clients to associate with the notification rule.</p>"""
    detail_type: "capo_codestar_notifications.types.detail_type.DetailType"
    """<p>The level of detail to include in the notifications for this resource. <code>BASIC</code> will include only the contents of the event as it would appear in Amazon CloudWatch. <code>FULL</code> will include any supplemental information provided by CodeStar Notifications and/or the service for the resource for which the notification is created.</p>"""
    client_request_token: NotRequired[
        "capo_codestar_notifications.types.client_request_token.ClientRequestToken"
    ]
    """<p>A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request with the same parameters is received and a token is included, the request returns information about the initial request that used that token.</p> <note> <p>The Amazon Web Services SDKs prepopulate client request tokens. If you are using an Amazon Web Services SDK, an idempotency token is created for you.</p> </note>"""
    tags: NotRequired["capo_codestar_notifications.types.tags.Tags"]
    """<p>A list of tags to apply to this notification rule. Key names cannot start with "<code>aws</code>". </p>"""
    status: NotRequired[
        "capo_codestar_notifications.types.notification_rule_status.NotificationRuleStatus"
    ]
    """<p>The status of the notification rule. The default value is <code>ENABLED</code>. If the status is set to <code>DISABLED</code>, notifications aren't sent for the notification rule.</p>"""

client_request_token instance-attribute

client_request_token: NotRequired[ClientRequestToken]

A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request with the same parameters is received and a token is included, the request returns information about the initial request that used that token.

The Amazon Web Services SDKs prepopulate client request tokens. If you are using an Amazon Web Services SDK, an idempotency token is created for you.

detail_type instance-attribute

detail_type: 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: EventTypeIds

A list of event types associated with this notification rule. For a list of allowed events, see EventTypeSummary.

name instance-attribute

The name for the notification rule. Notification rule names must be unique in your Amazon Web Services account.

resource instance-attribute

The Amazon Resource Name (ARN) of the resource to associate with the notification rule. Supported resources include pipelines in CodePipeline, repositories in CodeCommit, and build projects in CodeBuild.

status instance-attribute

status: NotRequired[NotificationRuleStatus]

The status of the notification rule. The default value is ENABLED. If the status is set to DISABLED, notifications aren't sent for the notification rule.

tags instance-attribute

tags: NotRequired[Tags]

A list of tags to apply to this notification rule. Key names cannot start with "aws".

targets instance-attribute

targets: Targets

A list of Amazon Resource Names (ARNs) of Amazon Simple Notification Service topics and Amazon Q Developer in chat applications clients to associate with the notification rule.