Skip to content

Commit

Permalink
Fixes typos
Browse files Browse the repository at this point in the history
  • Loading branch information
abitdodgy committed Oct 20, 2018
1 parent 5925a32 commit 81f375d
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 36 deletions.
46 changes: 13 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

Easily interact with the AWS IAM API to work with users, access keys, and any other entity. This is an IAM service module for [ExAws](https://github.com/ex-aws/ex_aws).

The lib provides a low-level `operation/3` function to build any AIM API action.
The lib provides a low-level `operation/3` function to build any IAM API action.

```
```elixir
op = Iam.operation(:list_users, max_items: 50, path: "/my/path/")
%ExAws.Operation.Query{
action: "ListUsers",
Expand All @@ -27,11 +27,11 @@ resp = ExAws.request(op)
is_truncated: "false",
users: [
%{
arn: "arn:aws:iam::085326204011:user/baz/bar",
arn: "arn:aws:iam::085326204011:user/my/path/abitdodgy",
create_date: "2018-10-17T00:09:19Z",
path: "/baz/",
path: "/my/path/",
user_id: "AIDAIAPPW7ERTKFL2R3TI",
user_name: "bar"
user_name: "abitdodgy"
}
]
},
Expand All @@ -41,7 +41,7 @@ resp = ExAws.request(op)
}}
```

The lib also provides higher-level convenience functions for interacting with specific services and for returning structs.
The lib also provides higher-level convenience functions for interacting with specific services.

```elixir
op = Iam.create_user("my_user", path: "/my/path")
Expand All @@ -57,8 +57,12 @@ op = Iam.create_user("my_user", path: "/my/path")
path: "/my/path",
service: :iam
}
```

You can also return entity structs.

user =
```
user =
op
|> ExAws.request()
|> Iam.to_user()
Expand Down Expand Up @@ -95,7 +99,7 @@ Parsers are currently implemented for the following actions:
You can also provider your own parser as long as it implements a `parse/2` function.

```elixir
op = Iam.operation(:list_users, parser: &MyParser.parse/2)
Iam.operation(:list_users, parser: &MyParser.parse/2)
```

## Installation
Expand Down Expand Up @@ -123,31 +127,7 @@ config :ex_aws,

## Usage

[See the documentation](https://hexdocs.pm/ex_aws_iam) for details. The following operations are currently available.

### User

* ListUsers
* GetUser
* CreateUser
* UpdateUser
* DeleteUser

### Group

* ListGroups
* GetGroup
* CreateGroup
* UpdateGroup
* DeleteGroup

### AccessKey

* ListAccessKeys
* GetAccessKeyLastUsed
* CreateAccessKey
* UpdateAccessKey
* DeleteAccessKey
[See the documentation](https://hexdocs.pm/ex_aws_iam/ExAws.Iam.html) for details.

## License

Expand Down
4 changes: 1 addition & 3 deletions lib/ex_aws/iam.ex
Original file line number Diff line number Diff line change
Expand Up @@ -86,12 +86,10 @@ defmodule ExAws.Iam do
* `action` - The name of the action you want to call. Should be a _CamelCase_ string.
* `params` - A keyword list of any params the action takes.
* `params` - A keyword list of any params the action accepts.
## Options
Any options that the given action
* `parser` - A function to parse the request result. Defaults
to `Parser.parser/2`.
Expand Down

0 comments on commit 81f375d

Please sign in to comment.