From c5f197e133d6e2297b2843cd97117f8dca1c2453 Mon Sep 17 00:00:00 2001
From: "Gergely Daroczi (@daroczig)" <daroczig@rapporter.net>
Date: Mon, 29 Jan 2024 00:36:09 +0100
Subject: [PATCH] note AWS IAM requirements

---
 README.md | 31 ++++++++++++++++++++++++++++++-
 1 file changed, 30 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index a5913778..fd40329d 100644
--- a/README.md
+++ b/README.md
@@ -21,7 +21,36 @@ Generate `CREATE TABLE` statements for a MySQL database:
 sc-crawler schema mysql
 ```
 
-Fetch datacenter, zone, products etc  data into a SQLite file:
+Fetch and standardize datacenter, zone, products etc data into a single SQLite file:
+
+<details>
+
+<summary>Required permissions for AWS</summary>
+
+You will need the following IAM permissions to be able to run the Crawler in AWS:
+
+```json
+{
+    "Version": "2012-10-17",
+    "Statement": [
+        {
+            "Sid": "AllowCrawler",
+            "Effect": "Allow",
+            "Action": [
+                "pricing:ListPriceLists",
+                "pricing:GetPriceListFileUrl",
+                "pricing:GetProducts",
+                "ec2:DescribeRegions",
+                "ec2:DescribeAvailabilityZones",
+                "ec2:DescribeInstanceTypes"
+            ],
+            "Resource": "*"
+        }
+    ]
+}
+```
+
+</details>
 
 ```shell
 rm sc_crawler.db; sc-crawler pull --cache --log-level DEBUG --include-vendor aws