Packages
ex_aws
2.0.1
2.7.0
2.6.1
2.6.0
2.5.11
2.5.10
2.5.9
2.5.8
2.5.7
2.5.6
2.5.5
2.5.4
2.5.3
2.5.2
2.5.1
2.5.0
2.4.4
2.4.3
2.4.2
2.4.1
2.4.0
2.3.4
2.3.3
2.3.2
2.3.1
2.3.0
2.2.10
2.2.9
2.2.8
2.2.7
2.2.6
2.2.5
2.2.4
2.2.3
2.2.2
2.2.1
2.2.0
2.1.9
2.1.8
2.1.7
2.1.6
2.1.5
2.1.4
2.1.3
2.1.2
2.1.1
2.1.0
2.0.2
2.0.1
2.0.0
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.0.0
1.0.0-rc.4
1.0.0-rc.3
1.0.0-rc.1
1.0.0-beta3
1.0.0-beta2
1.0.0-beta1
1.0.0-beta0
0.5.0
0.4.19
0.4.18
0.4.17
0.4.15
0.4.14
0.4.13
0.4.11
0.4.10
0.4.9
0.4.8
0.4.7
0.4.6
0.4.5
0.4.4
0.4.3
0.4.2
0.4.1
0.4.0
0.3.1
0.3.0
0.2.0
0.1.2
0.1.1
0.1.0
0.0.5
0.0.4
0.0.3
AWS client for Elixir. Currently supports Dynamo, DynamoStreams, EC2, Firehose, Kinesis, KMS, Lambda, RRDS, Route53, S3, SES, SNS, SQS, STS and others.
Current section
Files
Jump to
Current section
Files
lib/ex_aws.ex
defmodule ExAws do
@moduledoc File.read!("#{__DIR__}/../README.md")
use Application
@doc """
Perform an AWS request
First build an operation from one of the services, and then pass it to this
function to perform it.
If you want to build an operation manually, see: `ExAws.Operation`
This function takes an optional second parameter of configuration overrides.
This is useful if you want to have certain configuration changed on a per
request basis.
## Examples
If you have one of the service modules installed, you can just use those service
modules like this:
```
ExAws.S3.list_buckets |> ExAws.request
ExAws.S3.list_buckets |> ExAws.request(region: "eu-west-1")
ExAws.Dynamo.get_object("users", "foo@bar.com") |> ExAws.request
```
Alternatively you can create operation structs manually for services
that aren't supported:
```
op = %ExAws.Operation.JSON{
http_method: :post,
service: :dynamodb,
headers: [
{"x-amz-target", "DynamoDB_20120810.ListTables"},
{"content-type", "application/x-amz-json-1.0"}
],
}
ExAws.request(op)
```
"""
@spec request(ExAws.Operation.t) :: term
@spec request(ExAws.Operation.t, Keyword.t) :: {:ok, term} | {:error, term}
def request(op, config_overrides \\ []) do
ExAws.Operation.perform(op, ExAws.Config.new(op.service, config_overrides))
end
@doc """
Perform an AWS request, raise if it fails.
Same as `request/1,2` except it will either return the successful response from
AWS or raise an exception.
"""
@spec request!(ExAws.Operation.t) :: term | no_return
@spec request!(ExAws.Operation.t, Keyword.t) :: term | no_return
def request!(op, config_overrides \\ []) do
case request(op, config_overrides) do
{:ok, result} ->
result
error ->
raise ExAws.Error, """
ExAws Request Error!
#{inspect error}
"""
end
end
@doc """
Return a stream for the AWS resource.
## Examples
```
ExAws.S3.list_objects("my-bucket") |> ExAws.stream!
```
"""
@spec stream!(ExAws.Operation.t) :: Enumerable.t
@spec stream!(ExAws.Operation.t, Keyword.t) :: Enumerable.t
def stream!(op, config_overrides \\ []) do
ExAws.Operation.stream!(op, ExAws.Config.new(op.service, config_overrides))
end
@doc false
def start(_type, _args) do
import Supervisor.Spec, warn: false
children = [
worker(ExAws.Config.AuthCache, [[name: ExAws.Config.AuthCache]]),
]
opts = [strategy: :one_for_one, name: ExAws.Supervisor]
Supervisor.start_link(children, opts)
end
end