Skip to content

Commit ee98c99

Browse files
benwilson512benwilson512
committed
doc updates
1 parent a9265ad commit ee98c99

File tree

8 files changed

+23
-178
lines changed

8 files changed

+23
-178
lines changed

‎lib/ex_aws/ec2.ex

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
11
defmodule ExAws.EC2 do
2+
@moduledoc """
3+
Operations on AWS EC2
4+
"""
5+
26
import ExAws.Utils
37

48
@version "2015-10-01"

‎lib/ex_aws/kinesis.ex

Lines changed: 1 addition & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,6 @@
11
defmodule ExAws.Kinesis do
22
@moduledoc """
3-
Defines a Kinesis client.
4-
5-
Usage:
6-
```
7-
defmodule MyApp.Kinesis do
8-
use ExAws.Kinesis.Client, otp_app: :my_otp_app
9-
end
10-
```
11-
12-
In your config
13-
```
14-
config :my_otp_app, :ex_aws,
15-
kinesis: [], # kinesis config goes here
16-
dynamodb: [], # you get the idea
17-
```
18-
19-
You can now use MyApp.Kinesis as the root module for the Kinesis api without needing
20-
to pass in a particular configuration.
21-
This enables different otp apps to configure their AWS configuration separately.
22-
23-
The alignment with a particular OTP app however is entirely optional.
24-
The following also works:
25-
26-
```
27-
defmodule MyApp.Kinesis do
28-
use ExAws.Kinesis.Client
29-
30-
def config_root do
31-
Application.get_all_env(:my_aws_config_root)
32-
end
33-
end
34-
```
35-
ExAws now expects the config for that kinesis client to live under
36-
37-
```elixir
38-
config :my_aws_config_root
39-
kinesis: [] # Kinesis config goes here
40-
```
41-
42-
Default config values can be found in ExAws.Config
3+
Operations on AWS Kinesis
434
445
http://docs.aws.amazon.com/kinesis/latest/APIReference/API_Operations.html
456
"""

‎lib/ex_aws/lambda.ex

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
defmodule ExAws.Lambda do
2+
@moduledoc """
3+
Operations on ExAws Lambda
4+
"""
5+
26
import ExAws.Utils, only: [camelize_keys: 1, upcase: 1]
37
require Logger
48

5-
@moduledoc false
6-
# Implimentation of the AWS Kinesis API.
7-
#
8-
# See ExAws.Kinesis.Client for usage.
9-
109
@namespace "Lambda"
1110
@actions %{
1211
add_permission: :post,

‎lib/ex_aws/rds.ex

Lines changed: 4 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,11 @@
11
defmodule ExAws.RDS do
2-
import ExAws.Utils, only: [camelize_keys: 1]
3-
4-
@version "2014-10-31"
5-
6-
72
@moduledoc """
8-
The purpose of this module is to surface the ExAws.RDS API tied to a single
9-
configuration chosen, sich that it does not need passed in with every request.
3+
Operations on AWS RDS
4+
"""
105

11-
Usage:
12-
```
13-
defmodule MyApp.RDS do
14-
use ExAws.RDS.Client, otp_app: :my_otp_app
15-
end
16-
```
6+
import ExAws.Utils, only: [camelize_keys: 1]
177

18-
In your config
19-
```
20-
config :my_otp_app, :ex_aws,
21-
rds: [], # RDS config goes here
22-
```
23-
"""
8+
@version "2014-10-31"
249

2510
@type db_instance_classes :: [
2611
:db_t1_micro | :db_m1_small | :db_m1_medium | :db_m1_large | :db_m1_xlarge |

‎lib/ex_aws/s3.ex

Lines changed: 1 addition & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,6 @@
11
defmodule ExAws.S3 do
2-
32
@moduledoc """
4-
The purpose of this module is to surface the ExAws.S3 API tied to a single
5-
configuration chosen, such that it does not need passed in with every request.
6-
7-
Usage:
8-
```
9-
defmodule MyApp.S3 do
10-
use ExAws.S3.Client, otp_app: :my_otp_app
11-
end
12-
```
13-
14-
In your config
15-
```
16-
config :my_otp_app, :ex_aws,
17-
s3: [], # S3 config goes here
18-
```
19-
20-
You can now use MyApp.S3 as the root module for the S3 api without needing
21-
to pass in a particular configuration.
22-
This enables different otp apps to configure their AWS configuration separately.
23-
24-
The alignment with a particular OTP app while convenient is however entirely optional.
25-
The following also works:
26-
27-
```
28-
defmodule MyApp.S3 do
29-
use ExAws.S3.Client
30-
31-
def config_root do
32-
Application.get_all_env(:my_aws_config_root)
33-
end
34-
end
35-
```
36-
ExAws now expects the config for that S3 client to live under
37-
38-
```elixir
39-
config :my_aws_config_root
40-
s3: [] # S3 config goes here
41-
```
42-
43-
This is in fact how the functions in ExAws.S3 that do not require a config work.
44-
Default config values can be found in ExAws.Config. The default configuration is always used,
45-
and then the configuration of a particular client is merged in and overrides the defaults.
3+
Operations on AWS S3
464
"""
475

486
import ExAws.S3.Utils

‎lib/ex_aws/sns.ex

Lines changed: 1 addition & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -2,60 +2,7 @@ defmodule ExAws.SNS do
22
import ExAws.Utils, only: [camelize_key: 1, camelize_keys: 1]
33

44
@moduledoc """
5-
Defines an SNS Client
6-
7-
By default you can use ExAws.SNS
8-
9-
## Usage
10-
11-
```
12-
defmodule MyApp.SNS do
13-
use ExAws.SNS.Client, otp_app: :my_otp_app
14-
end
15-
```
16-
17-
In your config:
18-
19-
```
20-
config :my_otp_app, :ex_aws,
21-
sns: [], # SNS config goes here
22-
```
23-
24-
You can now use MyApp.SNS as the root module for the SNS API without
25-
needing to pass in a particular configuration. This enables different OTP
26-
apps to configure their AWS configurations separately.
27-
28-
The alignment with a particular OTP app while convenient is however entirely
29-
optional.
30-
31-
The following also works:
32-
33-
```
34-
defmodule MyApp.SNS do
35-
use ExAws.SNS.Client
36-
37-
def config_root do
38-
Application.get_all_env(:my_aws_config_root)
39-
end
40-
end
41-
```
42-
43-
ExAws now expects the config for that client to live under `:my_aws_config_root`:
44-
45-
```elixir
46-
config :my_aws_config_root
47-
sns: [] # SNS config goes here
48-
```
49-
50-
Default config values can be found in ExAws.Config.
51-
52-
## General notes
53-
54-
TODO
55-
56-
## Examples
57-
58-
TODO
5+
Operations on AWS SNS
596
607
http://docs.aws.amazon.com/sns/latest/APIReference/API_Operations.html
618
"""

‎lib/ex_aws/sqs.ex

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,6 @@
11
defmodule ExAws.SQS do
22
@moduledoc """
3-
The purpose of this module is to surface the ExAws.SQS API tied to a single
4-
configuration chose, such that it does not need passed in with every request
5-
6-
Usage:
7-
```elixir
8-
defmodule MyApp.SQS do
9-
use ExAws.SQS.Client, otp_app: :my_otp_app
10-
end
11-
```
12-
13-
In your config
14-
```elixir
15-
config :my_otp_app, ExAws,
16-
sqs: [], #SQS config goes here
17-
```
3+
Operations on AWS SQS
184
"""
195

206
@type sqs_permission ::

‎mix.exs

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,22 @@
11
defmodule ExAws.Mixfile do
22
use Mix.Project
33

4+
@version "1.0.0-beta1"
5+
46
def project do
57
[app: :ex_aws,
6-
version: "1.0.0-beta1",
8+
version: @version,
79
elixir: "~> 1.0",
810
elixirc_paths: elixirc_paths(Mix.env),
911
description: "AWS client. Currently supports Dynamo, EC2, Kinesis, Lambda, RDS, S3, SNS, SQS",
1012
name: "ExAws",
1113
source_url: "https://github.com/cargosense/ex_aws",
1214
package: package,
1315
dialyzer: [flags: "--fullpath"],
14-
deps: deps]
16+
deps: deps,
17+
docs: [main: "ExAws", source_ref: "v#{@version}",
18+
source_url: "https://github.com/cargosense/ex_aws"]
19+
]
1520
end
1621

1722
def application do

0 commit comments

Comments
 (0)