Skip to content

Commit 663c1a3

Browse files
authored
Merge pull request #167 from stackql/feature/doc-updates
aws doc updates
2 parents 9c02731 + f812e8d commit 663c1a3

File tree

2,536 files changed

+67487
-129433
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

2,536 files changed

+67487
-129433
lines changed

docs/aws-docs/index.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,16 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
2222

2323
Cloud services from AWS.
2424

25-
:::info Provider Summary (v24.05.00232)
25+
:::info Provider Summary (v24.06.00240)
2626

2727
<div class="row">
2828
<div class="providerDocColumn">
29-
<span>total services:&nbsp;<b>221</b></span><br />
30-
<span>total methods:&nbsp;<b>7,620</b></span><br />
29+
<span>total services:&nbsp;<b>218</b></span><br />
30+
<span>total methods:&nbsp;<b>57</b></span><br />
3131
</div>
3232
<div class="providerDocColumn">
33-
<span>total resources:&nbsp;<b>2,277</b></span><br />
34-
<span>total selectable resources:&nbsp;<b>2,170</b></span><br />
33+
<span>total resources:&nbsp;<b>0</b></span><br />
34+
<span>total selectable resources:&nbsp;<b>-13</b></span><br />
3535
</div>
3636
</div>
3737

@@ -134,7 +134,6 @@ This parameter must be supplied to the `WHERE` clause of each `SELECT` statement
134134
<a href="/providers/aws/cloudhsm/">cloudhsm</a><br />
135135
<a href="/providers/aws/cloudtrail/">cloudtrail</a><br />
136136
<a href="/providers/aws/cloudwatch/">cloudwatch</a><br />
137-
<a href="/providers/aws/cloudwatch_api/">cloudwatch_api</a><br />
138137
<a href="/providers/aws/codeartifact/">codeartifact</a><br />
139138
<a href="/providers/aws/codebuild/">codebuild</a><br />
140139
<a href="/providers/aws/codeconnections/">codeconnections</a><br />
@@ -164,7 +163,6 @@ This parameter must be supplied to the `WHERE` clause of each `SELECT` statement
164163
<a href="/providers/aws/docdbelastic/">docdbelastic</a><br />
165164
<a href="/providers/aws/dynamodb/">dynamodb</a><br />
166165
<a href="/providers/aws/ec2/">ec2</a><br />
167-
<a href="/providers/aws/ec2_api/">ec2_api</a><br />
168166
<a href="/providers/aws/ecr/">ecr</a><br />
169167
<a href="/providers/aws/ecs/">ecs</a><br />
170168
<a href="/providers/aws/efs/">efs</a><br />
@@ -195,7 +193,6 @@ This parameter must be supplied to the `WHERE` clause of each `SELECT` statement
195193
<a href="/providers/aws/healthimaging/">healthimaging</a><br />
196194
<a href="/providers/aws/healthlake/">healthlake</a><br />
197195
<a href="/providers/aws/iam/">iam</a><br />
198-
<a href="/providers/aws/iam_api/">iam_api</a><br />
199196
<a href="/providers/aws/identitystore/">identitystore</a><br />
200197
<a href="/providers/aws/imagebuilder/">imagebuilder</a><br />
201198
<a href="/providers/aws/inspector/">inspector</a><br />
@@ -206,9 +203,9 @@ This parameter must be supplied to the `WHERE` clause of each `SELECT` statement
206203
<a href="/providers/aws/iotcoredeviceadvisor/">iotcoredeviceadvisor</a><br />
207204
<a href="/providers/aws/iotevents/">iotevents</a><br />
208205
<a href="/providers/aws/iotfleethub/">iotfleethub</a><br />
206+
<a href="/providers/aws/iotfleetwise/">iotfleetwise</a><br />
209207
</div>
210208
<div class="providerDocColumn">
211-
<a href="/providers/aws/iotfleetwise/">iotfleetwise</a><br />
212209
<a href="/providers/aws/iotsitewise/">iotsitewise</a><br />
213210
<a href="/providers/aws/iottwinmaker/">iottwinmaker</a><br />
214211
<a href="/providers/aws/iotwireless/">iotwireless</a><br />
@@ -256,11 +253,13 @@ This parameter must be supplied to the `WHERE` clause of each `SELECT` statement
256253
<a href="/providers/aws/organizations/">organizations</a><br />
257254
<a href="/providers/aws/osis/">osis</a><br />
258255
<a href="/providers/aws/panorama/">panorama</a><br />
256+
<a href="/providers/aws/paymentcryptography/">paymentcryptography</a><br />
259257
<a href="/providers/aws/pcaconnectorad/">pcaconnectorad</a><br />
260258
<a href="/providers/aws/personalize/">personalize</a><br />
261259
<a href="/providers/aws/pinpoint/">pinpoint</a><br />
262260
<a href="/providers/aws/pipes/">pipes</a><br />
263261
<a href="/providers/aws/proton/">proton</a><br />
262+
<a href="/providers/aws/qbusiness/">qbusiness</a><br />
264263
<a href="/providers/aws/qldb/">qldb</a><br />
265264
<a href="/providers/aws/quicksight/">quicksight</a><br />
266265
<a href="/providers/aws/ram/">ram</a><br />
@@ -275,13 +274,12 @@ This parameter must be supplied to the `WHERE` clause of each `SELECT` statement
275274
<a href="/providers/aws/robomaker/">robomaker</a><br />
276275
<a href="/providers/aws/rolesanywhere/">rolesanywhere</a><br />
277276
<a href="/providers/aws/route53/">route53</a><br />
278-
<a href="/providers/aws/route53_api/">route53_api</a><br />
277+
<a href="/providers/aws/route53profiles/">route53profiles</a><br />
279278
<a href="/providers/aws/route53recoverycontrol/">route53recoverycontrol</a><br />
280279
<a href="/providers/aws/route53recoveryreadiness/">route53recoveryreadiness</a><br />
281280
<a href="/providers/aws/route53resolver/">route53resolver</a><br />
282281
<a href="/providers/aws/rum/">rum</a><br />
283282
<a href="/providers/aws/s3/">s3</a><br />
284-
<a href="/providers/aws/s3_api/">s3_api</a><br />
285283
<a href="/providers/aws/s3express/">s3express</a><br />
286284
<a href="/providers/aws/s3objectlambda/">s3objectlambda</a><br />
287285
<a href="/providers/aws/s3outposts/">s3outposts</a><br />
@@ -308,7 +306,6 @@ This parameter must be supplied to the `WHERE` clause of each `SELECT` statement
308306
<a href="/providers/aws/systemsmanagersap/">systemsmanagersap</a><br />
309307
<a href="/providers/aws/timestream/">timestream</a><br />
310308
<a href="/providers/aws/transfer/">transfer</a><br />
311-
<a href="/providers/aws/transfer_api/">transfer_api</a><br />
312309
<a href="/providers/aws/verifiedpermissions/">verifiedpermissions</a><br />
313310
<a href="/providers/aws/voiceid/">voiceid</a><br />
314311
<a href="/providers/aws/vpclattice/">vpclattice</a><br />

docs/aws-docs/providers/aws/accessanalyzer/analyzer/index.md

Lines changed: 0 additions & 101 deletions
This file was deleted.

docs/aws-docs/providers/aws/accessanalyzer/analyzers/index.md

Lines changed: 51 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,7 @@ import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
1919
import Tabs from '@theme/Tabs';
2020
import TabItem from '@theme/TabItem';
2121

22-
23-
Used to retrieve a list of <code>analyzers</code> in a region or to create or delete a <code>analyzers</code> resource, use <code>analyzer</code> to read or update an individual resource.
22+
Creates, updates, deletes or gets an <code>analyzer</code> resource or lists <code>analyzers</code> in a region
2423

2524
## Overview
2625
<table><tbody>
@@ -31,11 +30,13 @@ Used to retrieve a list of <code>analyzers</code> in a region or to create or de
3130
</tbody></table>
3231

3332
## Fields
34-
<table><tbody>
35-
<tr><th>Name</th><th>Datatype</th><th>Description</th></tr>
33+
<table><tbody><tr><th>Name</th><th>Datatype</th><th>Description</th></tr><tr><td><CopyableCode code="analyzer_name" /></td><td><code>string</code></td><td>Analyzer name</td></tr>
34+
<tr><td><CopyableCode code="archive_rules" /></td><td><code>array</code></td><td></td></tr>
3635
<tr><td><CopyableCode code="arn" /></td><td><code>string</code></td><td>Amazon Resource Name (ARN) of the analyzer</td></tr>
36+
<tr><td><CopyableCode code="tags" /></td><td><code>array</code></td><td>An array of key-value pairs to apply to this resource.</td></tr>
37+
<tr><td><CopyableCode code="type" /></td><td><code>string</code></td><td>The type of the analyzer, must be one of ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS or ORGANIZATION_UNUSED_ACCESS</td></tr>
38+
<tr><td><CopyableCode code="analyzer_configuration" /></td><td><code>object</code></td><td>The configuration for the analyzer</td></tr>
3739
<tr><td><CopyableCode code="region" /></td><td><code>string</code></td><td>AWS region.</td></tr>
38-
3940
</tbody></table>
4041

4142
## Methods
@@ -56,23 +57,48 @@ Used to retrieve a list of <code>analyzers</code> in a region or to create or de
5657
<td><code>DELETE</code></td>
5758
<td><CopyableCode code="data__Identifier, region" /></td>
5859
</tr>
60+
<tr>
61+
<td><CopyableCode code="update_resource" /></td>
62+
<td><code>UPDATE</code></td>
63+
<td><CopyableCode code="data__Identifier, data__PatchDocument, region" /></td>
64+
</tr>
5965
<tr>
6066
<td><CopyableCode code="list_resource" /></td>
6167
<td><code>SELECT</code></td>
6268
<td><CopyableCode code="region" /></td>
6369
</tr>
70+
<tr>
71+
<td><CopyableCode code="get_resource" /></td>
72+
<td><code>SELECT</code></td>
73+
<td><CopyableCode code="data__Identifier, region" /></td>
74+
</tr>
6475
</tbody></table>
6576

66-
## `SELECT` Example
77+
## `SELECT` examples
78+
List all <code>analyzers</code> in a region.
6779
```sql
6880
SELECT
6981
region,
7082
arn
7183
FROM aws.accessanalyzer.analyzers
7284
WHERE region = 'us-east-1';
7385
```
86+
Gets all properties from an <code>analyzer</code>.
87+
```sql
88+
SELECT
89+
region,
90+
analyzer_name,
91+
archive_rules,
92+
arn,
93+
tags,
94+
type,
95+
analyzer_configuration
96+
FROM aws.accessanalyzer.analyzers
97+
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';
98+
```
7499

75-
## `INSERT` Example
100+
101+
## `INSERT` example
76102

77103
Use the following StackQL query and manifest file to create a new <code>analyzer</code> resource, using [__`stack-deploy`__](https://pypi.org/project/stack-deploy/).
78104

@@ -161,7 +187,7 @@ resources:
161187
</TabItem>
162188
</Tabs>
163189

164-
## `DELETE` Example
190+
## `DELETE` example
165191

166192
```sql
167193
/*+ delete */
@@ -183,6 +209,23 @@ organizations:ListAWSServiceAccessForOrganization,
183209
organizations:ListDelegatedAdministrators
184210
```
185211

212+
### Read
213+
```json
214+
access-analyzer:ListAnalyzers,
215+
access-analyzer:GetAnalyzer,
216+
access-analyzer:ListArchiveRules
217+
```
218+
219+
### Update
220+
```json
221+
access-analyzer:CreateArchiveRule,
222+
access-analyzer:DeleteArchiveRule,
223+
access-analyzer:ListAnalyzers,
224+
access-analyzer:TagResource,
225+
access-analyzer:UntagResource,
226+
access-analyzer:UpdateArchiveRule
227+
```
228+
186229
### Delete
187230
```json
188231
access-analyzer:DeleteAnalyzer

docs/aws-docs/providers/aws/accessanalyzer/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ The accessanalyzer service documentation.
2020

2121
<div class="row">
2222
<div class="providerDocColumn">
23-
<span>total resources:&nbsp;<b>2</b></span><br />
24-
<span>total selectable resources:&nbsp;<b>2</b></span><br />
25-
<span>total methods:&nbsp;<b>2</b></span><br />
23+
<span>total resources:&nbsp;<b>1</b></span><br />
24+
<span>total selectable resources:&nbsp;<b>1</b></span><br />
25+
<span>total methods:&nbsp;<b>1</b></span><br />
2626
</div>
2727
</div>
2828

@@ -31,9 +31,9 @@ The accessanalyzer service documentation.
3131
## Resources
3232
<div class="row">
3333
<div class="providerDocColumn">
34-
<a href="/providers/aws/accessanalyzer/analyzer/">analyzer</a>
34+
<a href="/providers/aws/accessanalyzer/analyzers/">analyzers</a>
3535
</div>
3636
<div class="providerDocColumn">
37-
<a href="/providers/aws/accessanalyzer/analyzers/">analyzers</a>
37+
3838
</div>
3939
</div>

0 commit comments

Comments
 (0)