Skip to content

SendDataSetNotificationRequest

Source code in docs_src/capo_dataexchange/types/send_data_set_notification_request.py
class SendDataSetNotificationRequest(TypedDict, closed=True):
    scope: NotRequired["capo_dataexchange.types.scope_details.ScopeDetails"]
    """<p>Affected scope of this notification such as the underlying resources affected by the notification event.</p>"""
    client_token: NotRequired["capo_dataexchange.types.client_token.ClientToken"]
    """<p>Idempotency key for the notification, this key allows us to deduplicate notifications that are sent in quick succession erroneously.</p>"""
    comment: NotRequired[
        "capo_dataexchange.types.__string_min0_max4096.__stringMin0Max4096"
    ]
    """<p>Free-form text field for providers to add information about their notifications.</p>"""
    data_set_id: "capo_dataexchange.types.id.Id"
    """<p>Affected data set of the notification.</p>"""
    details: NotRequired[
        "capo_dataexchange.types.notification_details.NotificationDetails"
    ]
    """<p>Extra details specific to this notification type.</p>"""
    type: "capo_dataexchange.types.notification_type.NotificationType"
    """<p>The type of the notification. Describing the kind of event the notification is alerting you to.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

Idempotency key for the notification, this key allows us to deduplicate notifications that are sent in quick succession erroneously.

comment instance-attribute

comment: NotRequired[__stringMin0Max4096]

Free-form text field for providers to add information about their notifications.

data_set_id instance-attribute

data_set_id: Id

Affected data set of the notification.

details instance-attribute

details: NotRequired[NotificationDetails]

Extra details specific to this notification type.

scope instance-attribute

scope: NotRequired[ScopeDetails]

Affected scope of this notification such as the underlying resources affected by the notification event.

type instance-attribute

The type of the notification. Describing the kind of event the notification is alerting you to.