Amazon S3 Events

Cloud Elements supports events via polling or webhooks depending on the API provider. For more information about our Events framework, see Events Overview.

Supported Events and Resources

Cloud Elements supports events via webhooks for Amazon S3.

Webhooks

You can configure webhooks through the UI or through API in the JSON body of the /instances API call. First, you must set up webhooks on the Amazon website. Cloud Elements uses Simple Notification Service (SNS) to enable notifications for Amazon S3. 

Configure Webhooks 

Follow these steps to configure webhooks for Amazon S3

1. Via a web browser, go to https://aws.amazon.com/console/ 
2. SIgn in to Amazon Web Services using your credentials.
3. Once logged in, enter SNS in the search bar.
   
4. On the navigation panel to your left, click Topics.
   
5. On the top right corner of the page, click Create Topic. 
6. Enter a Topic name and Display Name (optional).
7. Click on Access Policy.
8. Choose the Advanced method to define your policy using a JSON object.
   
9. In the JSON editor, enter the Service i.e. Amazon S3's domain name.
   
10. Add the Resource name and the Arn link i.e. your S3 bucket name in the JSON.
    
11. Click on the Create topic button.

Use the Topic ARN and Topic Name on Cloud Elements platform to enable webhooks for Amazon S3.

Configure Webhooks Through the UI

To configure webhooks through the UI, follow the same steps to authenticate an element instance, and then turn on events. Fill in the two mandatory fields that appear - 

• SNS Topic Key - Amazon S3 Topic ARN that you recorded while configuring Webhooks on the AWS Console.
• SNS Topic Name - Amazon Topic Name that you entered while creating a topic on the AWS Console.

For more information, see Authenticate an Element Instance with Events (UI) or the element-specific authentication topic.

Configure Webhooks Through API

To add webhooks when authenticating through the /instances API call, add the following to the configuration object in the JSON body. For more information about each parameter described here, see Parameters.

{
"event.notification.enabled": true,
"event.vendor.type": "webhooks",
"validate.instance": true,
"event.sns.topic.arn": "<INSERT_TOPIC_ARN>",
"event.sns.topic.name": "<INSERT_TOPIC_NAME>"
}

Example JSON with Webhooks

Instance JSON with webhooks events enabled:

{
  "element": {
    "key": "amazons3"
  },
  "configuration": {
    "filter.response.nulls": "true",
    "event.vendor.type": "webhooks",
    "event.notification.enabled": true,
    "validate.instance": "true",
    "event.sns.topic.arn": "xxxxxxxxxx",
    "event.sns.topic.name": "xxxxxxxxxx",
    "filemanagement.provider.access_key": "******",
    "filemanagement.provider.secret_key": "******",
    "filemanagement.provider.bucket_name": "xxxxxxxxxx",
    "filemanagement.provider.region_name": "xxxxxxxxxx"
  },
  "tags": [
    "<Add_Your_Tag>"
  ],
  "name": "<INSTANCE_NAME>"
}

Parameters

API parameters are in code formatting.