Skip to content

Commit 7086ea9

Browse files
committed
Merge branch 'master' of https://github.com/dtylman/AWSRetriever
2 parents 16224ad + 328b317 commit 7086ea9

File tree

1 file changed

+37
-26
lines changed

1 file changed

+37
-26
lines changed

README.md

+37-26
Original file line numberDiff line numberDiff line change
@@ -59,41 +59,52 @@ EC2 DescribeInternetGateways ca-central-1: 1 items retrieved
5959
```
6060

6161
The resulting `myobjects.json` file, holds a JSON array with the following structure:
62-
```json
62+
```js
6363
[
64-
{ "Type" : "InternetGateway", // the type of the object listed
65-
"Service" : "EC2", // the service it was retrieved from
66-
"Region" : "ap-northeast-2", // the region
67-
"Source" : { //the object itself, will change according to the object
68-
"Attachments": [
6964
{
70-
"State": {
71-
"Value": "available"
72-
},
73-
"VpcId": "vpc-e2e9f18a"
65+
// the type of the object listed:
66+
"Type": "InternetGateway",
67+
// the service it was retrieved from:
68+
"Service": "EC2",
69+
// the region:
70+
"Region": "ap-northeast-2",
71+
//the object itself, will change according to the object:
72+
"Source": {
73+
"Attachments": [
74+
{
75+
"State": {
76+
"Value": "available"
77+
},
78+
"VpcId": "vpc-e2e9f18a"
79+
}
80+
],
81+
"InternetGatewayId": "igw-0562ad6d",
82+
"OwnerId": "000000000000",
83+
"Tags": []
84+
}
85+
},
86+
{
87+
// more objects...
7488
}
75-
],
76-
"InternetGatewayId": "igw-0562ad6d",
77-
"OwnerId": "000000000000",
78-
"Tags": []
79-
}}
80-
,
81-
.
82-
.
83-
.
89+
]
8490
```
8591

8692
### Profile Record
8793

8894
Each profile record holds:
89-
```json
95+
```js
9096
{
91-
"ServiceName": "EC2", // AWS service to execute
92-
"Name": "DescribeInternetGateways", // Specific API to execute
93-
"Regions": "ap-northeast-1 ap-northeast-2 ap-south-1 ap-southeast-1 ap-southeast-2 ca-central-1 eu-central-1 eu-north-1 eu-west-1 eu-west-2 eu-west-3 sa-east-1 us-east-1 us-east-2 us-west-1 us-west-2", // a list of regions to call
94-
"Enabled": true, // if false, this API is skipped
95-
"PageSize": 18 // if this API supports paging, this value will be the page size for each request.
96-
},
97+
// AWS service to execute
98+
"ServiceName": "EC2",
99+
// Specific API to execute:
100+
"Name": "DescribeInternetGateways",
101+
// A list of regions to call:
102+
"Regions": "ap-northeast-1 ap-northeast-2 ap-south-1 ap-southeast-1 ap-southeast-2 ca-central-1 eu-central-1 eu-north-1 eu-west-1 eu-west-2 eu-west-3 sa-east-1 us-east-1 us-east-2 us-west-1 us-west-2",
103+
// if false, this API is skipped
104+
"Enabled": true,
105+
// if this API supports paging, this value will be the page size for each request.
106+
"PageSize": 18
107+
}
97108
```
98109

99110
## Download & Run

0 commit comments

Comments
 (0)