How do I create an SQS queue to receive Live Events data from Canvas?

Document created by Emily Allen Employee on Feb 15, 2018Last modified by Emily Allen Employee on Jul 18, 2018
Version 3Show Document
  • View in full screen mode

To receive data from Canvas you will need to set up and maintain a queue in Amazon Web Services. Amazon Web Services' Simple Queue Service (SQS) is currently the only supported queue. Additionally, you will need to grant the appropriate permissions for the queue to receive data.

 

After you set up a queue with the appropriate permissions, you can subscribe to events in the Canvas Data Portal and begin receiving data.

 

Notes:

  • If you do not have access to the Canvas Data Portal in your account, please contact your Customer Success Manager.
  • FIFO queues are not currently supported.
  • When setting up an SQS queue you can enable long polling in a standard queue. Long Polling helps eliminate the number of empty responses and false empty responses. For more information about long polling, please see the Amazon SQS Long Polling documentation.

 

Open Amazon SQS Console

Open Amazon SQS Console

In the Amazon Web Services console, open the Simple Queue Service (SQS) console by typing the name in the Services field. When Simple Queue Service displays in the list, click the name. 

 

Create New Queue

Create New Queue

In the Amazon SQS console, click the Create New Queue button.

 

Enter Queue Name

Enter Queue Name

Enter a name for the queue. The name of the queue must begin with canvas-live-events.

 

Select Standard Queue

Select Standard Queue

By default, Standard Queue will be selected.

 

To create a queue with the default settings, click the Quick-Create Queue [1] button. To configure additional queue parameters, click the Configure Queue [2] button.

 

Note: FIFO Queues are not currently supported.

 

Open Queue Permissions

Select Queue

Select the checkbox next to the name of your queue. In the queue details area, click the Permissions tab.

 

Add Queue Permissions

Add Queue Permission

Click the Add a Permission button.

 

Enter Permission Details

Enter Permission Details

In the permission details window, select the Allow radio button [1].

 

In the Principal field, enter the account number 636161780776 [2]. This account number is required for the queue to receive Live Events data.

 

Select the All SQS Actions checkbox [3].

 

Click the Add Permission button [4].

 

View Queue Permission

View Queue Permission

In the queue details area, the permission will display in the Permissions tab.

 

To edit the permission, click the Edit icon [1]. To delete the permission, click the Delete icon [2].

2 people found this helpful

Attachments

    Outcomes