aws-iam-data 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Tobi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,34 @@
+# aws-iam-data
+This repository provides AWS IAM data gathered from the official [AWS IAM docs](https://docs.aws.amazon.com/service-authorization/latest/reference/reference_policies_actions-resources-contextkeys.html) as a convenient npm package ([aws-iam-data](https://www.npmjs.com/package/aws-iam-data)), that can be used in other OSS projects.
+
+The package also includes the [TypeScript interface definitions](src/awsIamData.d.ts).
+
+## Usage
+You can install [aws-iam-data](https://www.npmjs.com/package/aws-iam-data) as a dependecy to your Node/TypeScript project via 
+
+```bash
+npm i --save aws-iam-data
+```
+
+To use it in your own projects, see [examples/index.js](examples/index.js) or the code below:
+
+```javascript
+const { iamData, metadata } = require('aws-iam-data');
+
+// Get overall service count
+console.log(`Contains ${metadata.serviceCount} services!`);
+
+// Get EC2 data
+const ec2IamData = iamData.filter(service => service.name === 'Amazon EC2')[0];
+
+// Get actions and their access level
+const ec2Actions = ec2IamData.actions.map(action => ({ name: action.name, accessLevel: action.accessLevel }));
+console.log(JSON.stringify(ec2Actions, null, 2));
+
+// Get EC2 resource types
+const ec2ResourceTypes = ec2IamData.resourceTypes.map(action => ({ name: action.name, arnPattern: action.arnPattern }));
+console.log(JSON.stringify(ec2ResourceTypes, null, 2));
+```
+
+## Automatic updates
+The CI pipeline will check for AWS IAM docs updates everyday at 4AM, and automatically publish a new patch version if updates are detected.