Enabling Error Notifications for Tasks

This topic provides instructions for configuring error notification support for tasks using cloud messaging. This feature triggers a notification describing the errors encountered when a task executes SQL code.

The error notification feature is supported for both serverless tasks and user-managed tasks (i.e. tasks that rely on a virtual warehouse to provide the compute resources).

Note

Currently, error notifications rely on cloud messaging provided by the Amazon Simple Notification Service service; support for Google Cloud Pub/Sub queue and Microsoft Azure Event Grid is planned.

In this Topic:

Notes

  • Snowflake makes a best effort to ensure message delivery of error notifications but cannot guarantee delivery during this preview.

  • This feature is implemented using the notification integration object. A notification integration is a Snowflake object that provides an interface between Snowflake and third-party cloud message queuing services.

Enabling Error Notifications with Amazon SNS

Step 1: Creating an Amazon SNS Topic

Create an SNS topic in your AWS account to handle all error messages. Record the Amazon Resource Name (ARN) for the SNS topic.

To reduce latency and avoid data egress charges for sending notifications across regions, we recommend creating the SNS topic in the same region as your Snowflake account.

For instructions, see the Creating an Amazon SNS topic in the SNS documentation.

Step 2: Creating the IAM Policy

Create an AWS Identity and Access Management (IAM) policy that grants permissions to publish to the SNS topic. The policy defines the following actions:

  • sns:publish

    Publish to the SNS topic.

  1. Log into the AWS Management Console.

  2. From the home dashboard, choose Identity & Access Management (IAM):

  3. Choose Account settings from the left-hand navigation pane.

  4. Expand the Security Token Service Regions list, find the AWS region corresponding to the region where your account is located, and choose Activate if the status is Inactive.

  5. Choose Policies from the left-hand navigation pane.

  6. Click Create Policy.

  7. Click the JSON tab.

  8. Add a policy document that defines actions that can be taken on your SNS topic.

    Copy and paste the following text into the policy editor:

    {
        "Version": "2012-10-17",
        "Statement": [
          {
             "Effect": "Allow",
             "Action": [
                 "sns:Publish"
             ],
             "Resource": "<sns_topic_arn>"
          }
        ]
     }
    

    Replace sns_topic_arn with the ARN of the SNS topic you created in Step 1: Creating an Amazon SNS Topic (in this topic).

  9. Click Review policy.

  10. Enter the policy name (e.g. snowflake_sns_topic) and an optional description. Click Create policy.

Step 3: Creating the AWS IAM Role

Create an AWS IAM role on which to assign privileges on the SNS topic.

  1. Log into the AWS Management Console.

  2. From the home dashboard, choose Identity & Access Management (IAM):

  3. Choose Roles from the left-hand navigation pane.

  4. Click the Create role button.

  5. Select Another AWS account as the trusted entity type.

  6. In the Account ID field, enter your own AWS account ID temporarily.

  7. Select the Require external ID option. This option enables you to grant permissions on your Amazon account resources (i.e. SNS) to a third party (i.e. Snowflake).

    For now, enter a dummy ID such as 0000. Later, you will modify the trust relationship and replace the dummy ID with the external ID for the Snowflake IAM user generated for your account. A condition in the trust policy for your IAM role allows your Snowflake users to assume the role using the notification integration object you will create later.

  8. Click the Next button.

  9. Locate the policy you created in Step 2: Creating the IAM Policy (in this topic), and select this policy.

  10. Click the Next button.

  11. Enter a name and description for the role, and click the Create role button.

  12. Record the Role ARN value located on the role summary page. You will specify this value in one or more later steps.

Step 4: Creating the Notification Integration

Create a notification integration using CREATE NOTIFICATION INTEGRATION. An integration is a Snowflake object that references the SNS topic you created.

A single notification integration can support multiple pipes.

Note

Only account administrators (users with the ACCOUNTADMIN role) or a role with the global CREATE INTEGRATION privilege can execute this SQL command.

CREATE NOTIFICATION INTEGRATION <integration_name>
  ENABLED = true
  TYPE = QUEUE
  NOTIFICATION_PROVIDER = AWS_SNS
  DIRECTION = OUTBOUND
  AWS_SNS_TOPIC_ARN = '<topic_arn>'
  AWS_SNS_ROLE_ARN = '<iam_role_arn>'

Where:

<integration_name>

Name of the new integration.

DIRECTION = OUTBOUND

Direction of the cloud messaging with respect to Snowflake. Required only when configuring error notifications.

<topic_arn>

SNS topic ARN you recorded in Step 1: Creating an Amazon SNS Topic (in this topic).

<iam_role_arn>

IAM role ARN you recorded in Step 3: Creating the AWS IAM Role (in this topic).

For example:

CREATE NOTIFICATION INTEGRATION my_notification_int
  ENABLED = true
  TYPE = QUEUE
  NOTIFICATION_PROVIDER = AWS_SNS
  DIRECTION = OUTBOUND
  AWS_SNS_TOPIC_ARN = 'arn:aws:sns:us-east-2:111122223333:sns_topic'
  AWS_SNS_ROLE_ARN = 'arn:aws:iam::111122223333:role/error_sns_role';

Step 5: Granting Snowflake Access to the SNS Topic

Retrieve the IAM User ARN and SNS Topic External ID

  1. Execute DESCRIBE INTEGRATION:

    DESC NOTIFICATION INTEGRATION <integration_name>;
    

    Where:

    • integration_name is the name of the notification integration you created in Step 4: Creating the Notification Integration (in this topic).

    For example:

    DESC NOTIFICATION INTEGRATION my_notification_int;
    
    +---------------------------+-------------------+------------------------------------------------------+----------------------+
    |   property                |   property_type   |   property_value                                     |   property_default   |
    +---------------------------+-------------------+------------------------------------------------------+----------------------+
    |   ENABLED                 |   Boolean         |   true                                               |   false              |
    |   NOTIFICATION_PROVIDER   |   String          |   AWS_SNS                                            |                      |
    |   DIRECTION               |   String          |   OUTBOUND                                           |   INBOUND            |
    |   AWS_SNS_TOPIC_ARN       |   String          |   arn:aws:sns:us-east-2:111122223333:myaccount       |                      |
    |   AWS_SNS_ROLE_ARN        |   String          |   arn:aws:iam::111122223333:role/myrole              |                      |
    |   SF_AWS_IAM_USER_ARN     |   String          |   arn:aws:iam::123456789001:user/c_myaccount         |                      |
    |   SF_AWS_EXTERNAL_ID      |   String          |   MYACCOUNT_SFCRole=2_a123456/s0aBCDEfGHIJklmNoPq=   |                      |
    +---------------------------+-------------------+------------------------------------------------------+----------------------+
    
  2. Record the following generated values:

    SF_AWS_IAM_USER_ARN

    ARN for the Snowflake IAM user created for your account. Users in your Snowflake account will assume the IAM role you created in Step 3: Creating the AWS IAM Role by submitting the external ID for this user using your notification integration.

    SF_AWS_EXTERNAL_ID

    External ID for the Snowflake IAM user created for your account.

    In the next step, you will update the trust relationship for the IAM role with these values.

Note the DIRECTION property, which indicates the direction of the cloud messaging with respect to Snowflake.

Modify the Trust Relationship in the IAM Role

  1. Log into the AWS Management Console.

  2. From the home dashboard, choose Identity & Access Management (IAM):

  3. Choose Roles from the left-hand navigation pane.

  4. Click on the role you created in Step 3: Creating the AWS IAM Role (in this topic).

  5. Click on the Trust relationships tab.

  6. Click the Edit trust relationship button.

  7. Modify the policy document with the DESC NOTIFICATION INTEGRATION output values you recorded in Retrieve the IAM User ARN and SNS Topic External ID (in this topic):

    Policy document for IAM role

    {
      "Version": "2012-10-17",
      "Statement": [
        {
          "Sid": "",
          "Effect": "Allow",
          "Principal": {
            "AWS": "<sf_aws_iam_user_arn>"
          },
          "Action": "sts:AssumeRole",
          "Condition": {
            "StringEquals": {
              "sts:ExternalId": "<sf_aws_external_id>"
            }
          }
        }
      ]
    }
    

    Where:

    • sf_aws_iam_user_arn is the SF_AWS_IAM_USER_ARN value you recorded.

    • sf_aws_external_id is the SF_AWS_EXTERNAL_ID value you recorded.

  8. Click the Update Trust Policy button. The changes are saved.

Step 6: Enabling Error Notifications in Tasks

Enable the error notification integration for individual standalone or root tasks by setting ERROR_INTEGRATION parameter value. You can set the parameter value when you create a task (using CREATE TASK) or later (using ALTER TASK).

Although the error notification integration is specified on a root task, any failed task in the same task tree sends error notifications to the integration.

Note

Creating or modifying a task that references a notification integration requires a role that has the USAGE privilege on the notification integration. In addition, the role must have either the CREATE TASK privilege on the schema or the OWNERSHIP privilege on the task, respectively.

New Task

Create a new task using CREATE TASK. For descriptions of all available task parameters, see the SQL command topic:

CREATE TASK <name>
  [...]
  ERROR_INTEGRATION = <integration_name>
  AS <sql>

Where:

ERROR_INTEGRATION = <integration_name>

Name of the notification integration you created in Step 4: Creating the Notification Integration (in this topic).

The following example creates a serverless task that supports error notifications. The task inserts the current timestamp into a table column every 5 minutes:

CREATE TASK mytask
  SCHEDULE = '5 MINUTE'
  ERROR_INTEGRATION = my_notification_int
  AS
  INSERT INTO mytable(ts) VALUES(CURRENT_TIMESTAMP);

Existing Task

Modify an existing task using ALTER TASK:

ALTER TASK <name> SET ERROR_INTEGRATION = <integration_name>;

Where <integration_name> is the name of the notification integration you created in Step 4: Creating the Notification Integration (in this topic).

For example:

ALTER TASK mytask SET ERROR_INTEGRATION = my_notification_int;

Error Notification Message Payload

The body of error messages identifies the task and the errors encountered during a task run.

The following is a sample message payload describing a task error. The payload can include one or more error messages.

{\"version\":\"1.0\",\"messageId\":\"3ff1eff0-7ad7-493c-9552-c0307087e0c6\",\"messageType\":\"USER_TASK_FAILED\",\"timestamp\":\"2021-11-11T19:46:39.648Z\",\"accountName\":\"AWS_UTEN_DPO_ACC\",\"taskName\":\"AWS_UTEN_DPO_DB.AWS_UTEN_SC.UTEN_AWS_TK1\",\"taskId\":\"01a03962-2b57-889e-0000-000000000001\",\"rootTaskName\":\"AWS_UTEN_DPO_DB.AWS_UTEN_SC.UTEN_AWS_TK1\",\"rootTaskId\":\"01a03962-2b57-889e-0000-000000000001\",\"messages\":[{\"runId\":\"2021-11-11T19:46:23.826Z\",\"scheduledTime\":\"2021-11-11T19:46:23.826Z\",\"queryStartTime\":\"2021-11-11T19:46:24.879Z\",\"completedTime\":\"null\",\"queryId\":\"01a03962-0300-0002-0000-0000000034d8\",\"errorCode\":\"000630\",\"errorMessage\":\"Statement reached its statement or warehouse timeout of 10 second(s) and was canceled.\"}]}

Note that you must parse the string into a JSON object to process values in the payload.

Back to top