ALTER NOTIFICATION INTEGRATION

Modifies the properties for an existing notification integration.

See also:

CREATE NOTIFICATION INTEGRATION , DROP INTEGRATION , SHOW INTEGRATIONS

Syntax

Automated data loads or metadata refreshes

ALTER [ NOTIFICATION ] INTEGRATION [ IF EXISTS ] <name> SET
  [ ENABLED = { TRUE | FALSE } ]
  [ TAG <tag_name> = '<tag_value>' [ , <tag_name> = '<tag_value>' ... ] ]
  [ COMMENT = '<string_literal>' ]
Copy

Push notifications

ALTER [ NOTIFICATION ] INTEGRATION [ IF EXISTS ] <name> SET
  [ ENABLED = { TRUE | FALSE } ]
  cloudProviderParamsPush
  [ TAG <tag_name> = '<tag_value>' [ , <tag_name> = '<tag_value>' ... ] ]
  [ COMMENT = '<string_literal>' ]
Copy
Where:
cloudProviderParamsPush (for Amazon Simple Notification Service) ::=
  AWS_SNS_TOPIC_ARN = '<topic_arn>'
  AWS_SNS_ROLE_ARN = '<iam_role_arn>'
Copy
cloudProviderParamsPush (for Google Pub/Sub) ::=
  GCP_PUBSUB_SUBSCRIPTION_NAME = '<subscription_id>'
Copy
cloudProviderParamsPush (for Microsoft Azure Event Grid) ::=
  AZURE_STORAGE_QUEUE_PRIMARY_URI = '<queue_URL>'
  AZURE_TENANT_ID = '<directory_ID>';
Copy

Email notifications

ALTER [ NOTIFICATION ] INTEGRATION [ IF EXISTS ] <name> SET
  [ ENABLED = { TRUE | FALSE } ]
  [ ALLOWED_RECIPIENTS = ( '<email_address_1>' [ , ... '<email_address_N>' ] ) ]
  [ TAG <tag_name> = '<tag_value>' [ , <tag_name> = '<tag_value>' ... ] ]
  [ COMMENT = '<string_literal>' ]

ALTER [ NOTIFICATION ] INTEGRATION [ IF EXISTS ] <name> UNSET {
  ALLOWED_RECIPIENTS |
  COMMENT
}
Copy

Parameters

name

Identifier for the integration to alter. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive.

SET ...

Specifies one or more properties/parameters to set for the table (separated by blank spaces, commas, or new lines):

ENABLED = { TRUE | FALSE }

Specifies whether to initiate operation of the integration or suspend it.

  • TRUE: Enables the integration.

  • FALSE: Suspends the integration for maintenance. Any integration between Snowflake and a third-party service fails to work.

TAG tag_name = 'tag_value' [ , tag_name = 'tag_value' , ... ]

Specifies the tag name and the tag string value.

The tag value is always a string, and the maximum number of characters for the tag value is 256.

For details about specifying tags in a statement, refer to Tag quotas for objects and columns.

ALLOWED_RECIPIENTS=('email_address_1' [, ... 'email_address_N'])

(For TYPE = EMAIL) A comma-separated list of quoted email addresses that can receive notification emails from this integration.

You must specify email addresses of users in the current account. These users must verify their email addresses.

The maximum number of email addresses that you can specify is 50.

If you omit this parameter, you can send email notifications to any verified email address in the current account.

COMMENT = 'string_literal'

String (literal) that specifies a comment for the integration.

UNSET ...

Specifies one or more properties/parameters to unset for the API integration, which resets them back to their defaults:

  • ENABLED

  • TAG tag_name [ , tag_name ... ]

  • ALLOWED_RECIPIENTS

  • COMMENT

Cloud Provider Parameters for Push Notifications (cloudProviderParamsPush)

See descriptions of these parameters in the Cloud Provider Parameters for Push Notifications (cloudProviderParamsPush) section of CREATE NOTIFICATION INTEGRATION.

Usage Notes

  • Regarding metadata:

    Attention

    Customers should ensure that no personal data (other than for a User object), sensitive data, export-controlled data, or other regulated data is entered as metadata when using the Snowflake service. For more information, see Metadata Fields in Snowflake.

Examples

The following example initiates operation of a suspended integration:

ALTER NOTIFICATION INTEGRATION myint SET ENABLED = TRUE;

ALTER NOTIFICATION INTEGRATION myint UNSET COMMENT;
Copy