# AWS SNS Notify

## <img src="/files/unvXIA1tfCQaEPSRSeAf" alt="" data-size="line"> AWS SNS Notify

### Description <a href="#description" id="description"></a>

The AWS SNS Notify transform enables you to send notifications from an Apache Hop pipeline via Amazon Web Services Simple Notification Service to subscribed users.

| Hop Engine | <sup>✓</sup> |
| ---------- | ------------ |
| Spark      | ?            |
| Flink      | ?            |
| Dataflow   | ?            |

### Preconditions

Before the first execution you need to create an IAM-Role (e.g. for usage on EC2/ECS) or an IAM-User with an AWS Key and Secret and attach the required policies for pushing notifications via SNS.

You also need to create one ore more subscription topics you want to push the messages to.

### Options

#### AWS Settings tab

| option                    | description                                                                                                                                                                                                  |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Use AWS Credentials chain | Apache Hop tries to pick up the AWS credentials from the host environment. For more information, check the [Credentials](https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/credentials.html) docs. |
| AWS Access Key            | your AWS Access Key (`AWS_ACCESS_KEY_ID`)                                                                                                                                                                    |
| AWS Secret Access Key     | the secret for your AWS Access Key (`AWS_SECRET_ACCESS_KEY`)                                                                                                                                                 |
| AWS Region                | the AWS-Region the service is running in.                                                                                                                                                                    |

#### Notifications

On the Notifications Tab you can define the behaviour when notifications will be send, the topicARN, the content and a Field for the MessageID.

| Option           | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Event type       | <p>please choose whether a notifications should be send with:</p><ul><li>the first row (recommended)</li><li>or for each row (be carefully not to spam your users!).</li></ul>                                                                                                                                                                                                                                                                                                                                                            |
| Message ID       | for each notification a Message-ID is retrieved from SNS. This can be written to an output field defined here.                                                                                                                                                                                                                                                                                                                                                                                                                            |
| SNS-Fields table | <p><strong>In the table only three rows</strong> are valid (all others will be ignored an refused on save/load of transformation).</p><p>All rows can be specified either from a field (<code>Field</code> column) or as a static value (<code>Static value</code> column). Toggle between field or static value with the <code>Value in Field?</code> option.</p><ul><li>topicARN: the ARN for your SNS topic</li><li>Subject: the subject for the notification you want to send</li><li>Message: the message you want to send</li></ul> |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.primeur.com/data-shaper-1.21/knowing-the-data-shaper-designer/pipelines/transforms/aws-sns-notify.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.