w.notification_destinations: Notification Destinations

class databricks.sdk.service.settings.NotificationDestinationsAPI

The notification destinations API lets you programmatically manage a workspace’s notification destinations. Notification destinations are used to send notifications for query alerts and jobs to destinations outside of Databricks. Only workspace admins can create, update, and delete notification destinations.

create([, config: Optional[Config], display_name: Optional[str]]) → NotificationDestination

Create a notification destination.

Creates a notification destination. Requires workspace admin permissions.

Parameters:

  • config – Config (optional) The configuration for the notification destination. Must wrap EXACTLY one of the nested configs.

  • display_name – str (optional) The display name for the notification destination.

Returns:

NotificationDestination

delete(id: str)

Delete a notification destination.

Deletes a notification destination. Requires workspace admin permissions.

Parameters:

id – str

get(id: str) → NotificationDestination

Get a notification destination.

Gets a notification destination.

Parameters:

id – str

Returns:

NotificationDestination

list([, page_size: Optional[int], page_token: Optional[str]]) → Iterator[ListNotificationDestinationsResult]

List notification destinations.

Lists notification destinations.

Parameters:

  • page_size – int (optional)

  • page_token – str (optional)

Returns:

Iterator over ListNotificationDestinationsResult

update(id: str [, config: Optional[Config], display_name: Optional[str]]) → NotificationDestination

Update a notification destination.

Updates a notification destination. Requires workspace admin permissions. At least one field is required in the request body.

Parameters:

  • id – str UUID identifying notification destination.

  • config – Config (optional) The configuration for the notification destination. Must wrap EXACTLY one of the nested configs.

  • display_name – str (optional) The display name for the notification destination.

Returns:

NotificationDestination