Skip to content

Commit

Permalink
feat: Doc Input/Output
Browse files Browse the repository at this point in the history
Signed-off-by: 35C4n0r <jaykumar20march@gmail.com>
  • Loading branch information
35C4n0r committed Jan 13, 2025
1 parent 07c66c1 commit 2622cfd
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/providers/documentation/amazonsqs-provider.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,25 @@ If you only want to give read scope to your key-secret pair the permission polic
If you only want to give read & write scope to your key-secret pair the permission policy: AmazonSQSFullAccess
Both are the policies are prebuilt in AWS.

## Inputs for AmazonSQS Action

- `message`: str: Body/Message for the notification
- `group_id`: str | None: Mandatory only if Queue is of type FIFO, ignored incase of a normal Queue.
- `dedup_id`: str | None: Mandatory only if Queue is of type FIFO, ignored incase of a normal Queue.
- **kwargs: dict | None: You can pass additional key-value pairs, that will be sent as MessageAttributes in the notification.

## Output for AmazonSQS Action
For more detail, visit [sqs-documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sqs/client/send_message.html#).
```json
{
'MD5OfMessageBody': 'string',
'MD5OfMessageAttributes': 'string',
'MD5OfMessageSystemAttributes': 'string',
'MessageId': 'string',
'SequenceNumber': 'string'
}
```

<Note>
- When using the AmazonSQS action, if your queue is fifo, then it is **mandatory** to pass a dedup_id & group_id.
- All the extra fields present in the MessageAttribute is stored in alert.label as a key-value pair dictionary.
Expand Down

0 comments on commit 2622cfd

Please sign in to comment.