Skip to content

Commit 328b317

Browse files
authored
Update README.md
1 parent cd70d75 commit 328b317

File tree

1 file changed

+36
-30
lines changed

1 file changed

+36
-30
lines changed

README.md

+36-30
Original file line numberDiff line numberDiff line change
@@ -61,44 +61,50 @@ EC2 DescribeInternetGateways ca-central-1: 1 items retrieved
6161
The resulting `myobjects.json` file, holds a JSON array with the following structure:
6262
```js
6363
[
64-
{
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": [
7464
{
75-
"State": {
76-
"Value": "available"
77-
},
78-
"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...
7988
}
80-
],
81-
"InternetGatewayId": "igw-0562ad6d",
82-
"OwnerId": "000000000000",
83-
"Tags": []
84-
}}
85-
,
86-
.
87-
.
88-
.
89+
]
8990
```
9091

9192
### Profile Record
9293

9394
Each profile record holds:
94-
```json
95+
```js
9596
{
96-
"ServiceName": "EC2", // AWS service to execute
97-
"Name": "DescribeInternetGateways", // Specific API to execute
98-
"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
99-
"Enabled": true, // if false, this API is skipped
100-
"PageSize": 18 // if this API supports paging, this value will be the page size for each request.
101-
},
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+
}
102108
```
103109

104110
## Download & Run

0 commit comments

Comments
 (0)