Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jagaapple/aws-actions-list

A list of all documented AWS actions for IAM Policy Document.
https://github.com/jagaapple/aws-actions-list

aws iam

Last synced: 23 days ago
JSON representation

A list of all documented AWS actions for IAM Policy Document.

Awesome Lists containing this project

README

        

aws-actions-list

📄 A list of all documented AWS actions for IAM Policy Document 👤


npm
CircleCI
license
@jagaapple_tech

## Table of Contents

- [Table of Contents](#table-of-contents)
- [Features](#features)
- [Quick Start](#quick-start)
- [Requirements](#requirements)
- [Installation](#installation)
- [Basic Command](#basic-command)
- [`show`](#show)
- [Extracting Columns](#extracting-columns)
- [Output Format](#output-format)
- [Contributing to aws-actions-list](#contributing-to-aws-actions-list)
- [License](#license)

## Features

| FEATURES | WHAT YOU CAN DO |
|------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
| 🌏 **Fetches all policy actions** | Don't give up to write [`PolicyDocument`](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_action.html) |
| 📄 **Only documented actions** | All actions are fetched from official online documents |
| 🔄 **Always up-to-date** | Fetched actions are always up-to-date |
| 💭 **Interactive Filtering** | You can extract only actions you want |

## Quick Start
### Requirements
- Node.js 8.0.0 or higher
- npm or Yarn

### Installation
```bash
$ npm install -g aws-actions-list
```

aws-actions-list is CLI program so recommend to install globally.

If you use Yarn, use the following command.

```bash
$ yarn global add aws-actions-list
```

## Basic Command
### `show`
```bash
$ aws-actions-list show
```

Gets all services and acitons and you can extract actions you want.

#### Extracting Columns
When you extract two or more columns, aws-actions-list outputs actions as object (hash/dictionary/set) in array.

```json
[
{
"name": "appsync:CreateApiKey",
"description": "Creates a unique key that you can distribute to clients who are executing your API.",
"documentURI": "https://docs.aws.amazon.com/appsync/latest/APIReference/API_CreateApiKey.html"
},
{
"name": "appsync:CreateDataSource",
"description": "Creates a DataSource object.",
"documentURI": "https://docs.aws.amazon.com/appsync/latest/APIReference/API_CreateDataSource.html"
}
]
```

When you extract one column, aws-actions-list outputs actions as string in array. `name` column is selected by default.

```json
[
"appsync:CreateApiKey",
"appsync:CreateDataSource"
]
```

#### Output Format
Currently aws-actions-list supports to output actions as JSON or YAML format.

```
? Select an output type (Use arrow keys)
❯ json
yaml
```

## Contributing to aws-actions-list
Bug reports and pull requests are welcome on GitHub at
[https://github.com/jagaapple/aws-actions-list](https://github.com/jagaapple/aws-actions-list).
This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the
[Contributor Covenant](http://contributor-covenant.org) code of conduct.

Please read [Contributing Guidelines](./.github/CONTRIBUTING.md) before development and contributing.

## License
The library is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

Copyright 2019 Jaga Apple. All rights reserved.