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

Automated data loads or metadata refreshes

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

Push notifications

ALTER [ NOTIFICATION ] INTEGRATION [ IF EXISTS ] <name> SET
  [ ENABLED = { TRUE | FALSE } ]
  cloudProviderParamsPush
  [ 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:

cloudProviderParamsAuto (for Google Cloud Storage) ::=
  GCP_PUBSUB_SUBSCRIPTION_NAME = '<subscription_id>'
cloudProviderParamsAuto (for Microsoft Azure storage) ::=
  AZURE_STORAGE_QUEUE_PRIMARY_URI = '<queue_URL>'
  AZURE_TENANT_ID = '<directory_ID>';
cloudProviderParamsPush (for Amazon Simple Notification Service) ::=
  AWS_SNS_TOPIC_ARN = '<topic_arn>'
  AWS_SNS_ROLE_ARN = '<iam_role_arn>'
cloudProviderParamsPush (for Google Pub/Sub) ::=
  GCP_PUBSUB_SUBSCRIPTION_NAME = '<subscription_id>'
cloudProviderParamsPush (for Microsoft Azure Event Grid) ::=
  AZURE_STORAGE_QUEUE_PRIMARY_URI = '<queue_URL>'
  AZURE_TENANT_ID = '<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 and the tag string 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 tags that can be set on an object is 20. For more information, see Tag Quotas for Objects/Columns.

A single ALTER statement can set or unset a maximum of 5 tags on an object.

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 for Automated Data Loads or Metadata Refreshes (cloudProviderParamsAuto)

See descriptions of these parameters in the Cloud Provider Parameters for Automated Data Loads or Metadata Refreshes (cloudProviderParamsAuto) section of CREATE NOTIFICATION INTEGRATION.

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