Categories:

User & Security DDL (Third-Party Service Integrations)

ALTER NOTIFICATION INTEGRATION

Modifies the properties for an existing notification integration.

See also:

CREATE NOTIFICATION INTEGRATION , DROP INTEGRATION , SHOW INTEGRATIONS

In this Topic:

Syntax

ALTER [ NOTIFICATION ] INTEGRATION [ IF EXISTS ] <name> SET
  [ ENABLED = { TRUE | FALSE } ]
  cloudProviderParams
  [ COMMENT = '<string_literal>' ]

ALTER [ NOTIFICATION ] INTEGRATION <name> SET TAG <tag_name> = '<tag_value>' [ , <tag_name> = '<tag_value>' ... ]

ALTER [ NOTIFICATION ] INTEGRATION <name> UNSET TAG <tag_name> [ , <tag_name> ... ]

ALTER [ NOTIFICATION ] INTEGRATION [ IF EXISTS ] <name> UNSET
  ENABLED |
  COMMENT

Where:

cloudProviderParams (for Amazon S3) ::=
  AWS_SNS_TOPIC_ARN = '<topic_arn>'
  AWS_SNS_ROLE_ARN = '<iam_role_arn>'

cloudProviderParams (for Google Cloud Storage) ::=
  GCP_PUBSUB_SUBSCRIPTION_NAME = '<subscription_id>'

cloudProviderParams (for Microsoft Azure) ::=
  AZURE_STORAGE_QUEUE_PRIMARY_URI = 'https://<storage_queue_account>.queue.core.windows.net/<storage_queue_name>'
  AZURE_TENANT_ID = '<ad_directory_id>'

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: Allows the integration to run based on the parameters specified in the pipe definition.

  • 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 (i.e. the key) and the tag value.

The tag value is always a string, and the maximum number of characters for the tag value is 256. The maximum number of unique tag keys that can be set on an object is 20.

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 ... ]

  • COMMENT

Cloud Provider Parameters (cloudProviderParams)

Amazon S3

AWS_SNS_TOPIC_ARN = '<topic_arn>'

Amazon Resource Name (ARN) of the Amazon SNS (SNS) topic that handles error messages.

Note that you must first modify the IAM policy for the topic and change the resource to the new topic ARN. For information, see “Step 2: Creating the IAM Policy” in Enabling Error Notifications for Snowpipe.

AWS_SNS_ROLE_ARN = '<iam_role_arn>'

ARN of the IAM role that has permissions to publish error messages to the SNS topic.

Note that you must update the IAM policy for the role and grant the sts:AssumeRole action to the Snowflake user. For information, see “Modify the Trust Relationship in the IAM Role” in Enabling Error Notifications for Snowpipe.

Google Cloud Storage

GCP_PUBSUB_SUBSCRIPTION_NAME = '<subscription_id>'

Pub/Sub topic subscription ID used to allow Snowflake access to event messages.

Microsoft Azure

AZURE_STORAGE_QUEUE_PRIMARY_URI = 'https://storage_queue_account.queue.core.windows.net/storage_queue_name'

Specifies the queue ID for the Azure Queue Storage queue created for Event Grid notifications.

Note

An Azure Queue Storage queue supports a single notification integration. Referencing a single storage queue in multiple notification integrations can result in missing data in target tables because event notifications are split between notification integrations.

For more information, see:

Snowpipe

Automating Snowpipe for Microsoft Azure Blob Storage

External tables

Refreshing External Tables Automatically for Azure Blob Storage

AZURE_TENANT_ID = 'ad_directory_id'

Specifies the ID of the Azure Active Directory tenant used for identity management. This ID is needed to generate the consent URL that grants Snowflake access to the Event Grid notification subscription, which is used to automatically trigger Snowpipe loads of new files in blob storage.

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;
Back to top