# BroadwaySQS
A AWS SQS connector for [Broadway](https://github.com/plataformatec/broadway).
Documentation can be found at [https://hexdocs.pm/broadway_sqs](https://hexdocs.pm/broadway_sqs).
For more details on using Broadway with Amazon SQS, please see the
[Amazon SQS Guide](https://hexdocs.pm/broadway/amazon-sqs.html).
This project provides:
* `BroadwaySQS.Producer` - A GenStage producer that continuously receives messages from
a SQS queue and acknowledge them after being successfully processed.
* `BroadwaySQS.SQSClient` - A generic behaviour to implement SQS clients.
* `BroadwaySQS.ExAwsClient` - Default SQS client used by `BroadwaySQS.Producer`.
## Installation
Add `:broadway_sqs` to the list of dependencies in `mix.exs` along with the HTTP
client of your choice (defaults to `:hackney`):
```elixir
def deps do
[
{:broadway_sqs, "~> 0.1.0"},
{:hackney, "~> 1.9"}
]
end
```
## Usage
Configure Broadway with one or more producers using `BroadwaySQS.Producer`:
```elixir
Broadway.start_link(MyBroadway,
name: MyBroadway,
producers: [
default: [
module: {BroadwaySQS.Producer, queue_name: "my_queue"}
]
]
)
```
## License
Copyright 2019 Plataformatec
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.