Merge pull request #170 from stackql/feature/doc-updates

aws doc updates

Author: jeffreyaven

docs/aws-docs/index.md

@@ -1,95 +1,91 @@
----
-title: aws
-hide_title: false
-hide_table_of_contents: false
-keywords:
-  - aws
-  - aws cloud control
-  - cloud control api
-  - stackql
-  - infrastructure-as-code
-  - configuration-as-data
-  - cloud inventory
-description: Query, deploy and manage AWS resources using SQL
-custom_edit_url: null
-image: /img/providers/aws/stackql-aws-provider-featured-image.png
-id: aws-doc
-slug: /providers/aws
-
----
-
-import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
-
+---
+title: aws
+hide_title: false
+hide_table_of_contents: false
+keywords:
+  - aws
+  - aws cloud control
+  - cloud control api
+  - stackql
+  - infrastructure-as-code
+  - configuration-as-data
+  - cloud inventory
+description: Query, deploy and manage AWS resources using SQL
+custom_edit_url: null
+image: /img/providers/aws/stackql-aws-provider-featured-image.png
+id: aws-doc
+slug: /providers/aws
+
+---
+
+import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';
+
 Cloud services from AWS.
 
 :::info Provider Summary (v24.06.00240)
 
 <div class="row">
 <div class="providerDocColumn">
 <span>total services:&nbsp;<b>218</b></span><br />
-<span>total methods:&nbsp;<b>2914</b></span><br />
-</div>
-<div class="providerDocColumn">
 <span>total resources:&nbsp;<b>1013</b></span><br />
-<span>total selectable resources:&nbsp;<b>1010</b></span><br />
 </div>
 </div>
 
 :::
 
-See also:   
-[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe)  [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry)
-* * * 
-
-## Installation
-
-To pull the latest version of the `aws` provider, run the following command:  
-
-```bash
-REGISTRY PULL aws;
-```
-> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry).  
-
-## Authentication
-
-The following system environment variables are used for authentication by default:  
-
-- <CopyableCode code="AWS_ACCESS_KEY_ID" /> - AWS Access Key ID (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html">How to Create AWS Credentials</a>)
-- <CopyableCode code="AWS_SECRET_ACCESS_KEY" /> - AWS Secret Access Key (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html">How to Create AWS Credentials</a>)
-- <CopyableCode code="AWS_SESSION_TOKEN" /> - [<i>OPTIONAL:</i> only required if using <CopyableCode code="aws sts assume-role" />] AWS Session Token (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html">Temporary security credentials in IAM</a>)
-  
-These variables are sourced at runtime (from the local machine or as CI variables/secrets).  
-
-<details>
-
-<summary>Using different environment variables</summary>
-
-To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program.  For example:  
-
-```bash
-
-AUTH='{ "aws": { "type": "aws_signing_v4", "keyIDenvvar": "YOUR_ACCESS_KEY_ID_VAR", "credentialsenvvar": "YOUR_SECRET_KEY_VAR" }}'
-stackql shell --auth="${AUTH}"
-
-```
-or using PowerShell:  
-
-```powershell
-
-$Auth = "{ 'aws': { 'type': 'aws_signing_v4',  'keyIDenvvar': 'YOUR_ACCESS_KEY_ID_VAR', 'credentialsenvvar': 'YOUR_SECRET_KEY_VAR' }}"
-stackql.exe shell --auth=$Auth
-
-```
-</details>
-
-
-## Server Parameters
-
-
-The following parameter is required for the `aws` provider:  
-
-- <CopyableCode code="region" /> - AWS region (e.g. <code>us-east-1</code>)
-
+See also:   
+[[` SHOW `]](https://stackql.io/docs/language-spec/show) [[` DESCRIBE `]](https://stackql.io/docs/language-spec/describe)  [[` REGISTRY `]](https://stackql.io/docs/language-spec/registry)
+* * * 
+
+## Installation
+
+To pull the latest version of the `aws` provider, run the following command:  
+
+```bash
+REGISTRY PULL aws;
+```
+> To view previous provider versions or to pull a specific provider version, see [here](https://stackql.io/docs/language-spec/registry).  
+
+## Authentication
+
+The following system environment variables are used for authentication by default:  
+
+- <CopyableCode code="AWS_ACCESS_KEY_ID" /> - AWS Access Key ID (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html">How to Create AWS Credentials</a>)
+- <CopyableCode code="AWS_SECRET_ACCESS_KEY" /> - AWS Secret Access Key (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html">How to Create AWS Credentials</a>)
+- <CopyableCode code="AWS_SESSION_TOKEN" /> - [<i>OPTIONAL:</i> only required if using <CopyableCode code="aws sts assume-role" />] AWS Session Token (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html">Temporary security credentials in IAM</a>)
+  
+These variables are sourced at runtime (from the local machine or as CI variables/secrets).  
+
+<details>
+
+<summary>Using different environment variables</summary>
+
+To use different environment variables (instead of the defaults), use the `--auth` flag of the `stackql` program.  For example:  
+
+```bash
+
+AUTH='{ "aws": { "type": "aws_signing_v4", "keyIDenvvar": "YOUR_ACCESS_KEY_ID_VAR", "credentialsenvvar": "YOUR_SECRET_KEY_VAR" }}'
+stackql shell --auth="${AUTH}"
+
+```
+or using PowerShell:  
+
+```powershell
+
+$Auth = "{ 'aws': { 'type': 'aws_signing_v4',  'keyIDenvvar': 'YOUR_ACCESS_KEY_ID_VAR', 'credentialsenvvar': 'YOUR_SECRET_KEY_VAR' }}"
+stackql.exe shell --auth=$Auth
+
+```
+</details>
+
+
+## Server Parameters
+
+
+The following parameter is required for the `aws` provider:  
+
+- <CopyableCode code="region" /> - AWS region (e.g. <code>us-east-1</code>)
+
 This parameter must be supplied to the `WHERE` clause of each `SELECT` statement.
 
 ## Services

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

@@ -21,8 +21,6 @@ The accessanalyzer service documentation.
 <div class="row">
 <div class="providerDocColumn">
 <span>total resources:&nbsp;<b>1</b></span><br />
-<span>total selectable resources:&nbsp;<b>1</b></span><br />
-<span>total methods:&nbsp;<b>1</b></span><br />
 </div>
 </div>
 

docs/aws-docs/providers/aws/acmpca/certificates/index.md

@@ -33,12 +33,12 @@ Creates, updates, deletes or gets a <code>certificate</code> resource or lists <
 <table><tbody><tr><th>Name</th><th>Datatype</th><th>Description</th></tr><tr><td><CopyableCode code="api_passthrough" /></td><td><code>object</code></td><td>Specifies X.509 certificate information to be included in the issued certificate. An <code>APIPassthrough</code> or <code>APICSRPassthrough</code> template variant must be selected, or else this parameter is ignored.</td></tr>
 <tr><td><CopyableCode code="certificate_authority_arn" /></td><td><code>string</code></td><td>The Amazon Resource Name (ARN) for the private CA issues the certificate.</td></tr>
 <tr><td><CopyableCode code="certificate_signing_request" /></td><td><code>string</code></td><td>The certificate signing request (CSR) for the certificate.</td></tr>
-<tr><td><CopyableCode code="signing_algorithm" /></td><td><code>string</code></td><td>The name of the algorithm that will be used to sign the certificate to be issued. This parameter should not be confused with the <code>SigningAlgorithm</code> parameter used to sign a CSR in the <code>CreateCertificateAuthority</code> action. The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.</td></tr>
+<tr><td><CopyableCode code="signing_algorithm" /></td><td><code>string</code></td><td>The name of the algorithm that will be used to sign the certificate to be issued. <br />This parameter should not be confused with the <code>SigningAlgorithm</code> parameter used to sign a CSR in the <code>CreateCertificateAuthority</code> action.<br />The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.</td></tr>
 <tr><td><CopyableCode code="template_arn" /></td><td><code>string</code></td><td>Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, PCAshort defaults to the <code>EndEntityCertificate/V1</code> template. For more information about PCAshort templates, see &#91;Using Templates&#93;(https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html).</td></tr>
 <tr><td><CopyableCode code="validity" /></td><td><code>object</code></td><td>The period of time during which the certificate will be valid.</td></tr>
-<tr><td><CopyableCode code="validity_not_before" /></td><td><code>object</code></td><td>Information describing the start of the validity period of the certificate. This parameter sets the “Not Before" date for the certificate. By default, when issuing a certificate, PCAshort sets the "Not Before" date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The <code>ValidityNotBefore</code> parameter can be used to customize the “Not Before” value. Unlike the <code>Validity</code> parameter, the <code>ValidityNotBefore</code> parameter is optional. The <code>ValidityNotBefore</code> value is expressed as an explicit date and time, using the <code>Validity</code> type value <code>ABSOLUTE</code>.</td></tr>
+<tr><td><CopyableCode code="validity_not_before" /></td><td><code>object</code></td><td>Information describing the start of the validity period of the certificate. This parameter sets the “Not Before" date for the certificate.<br />By default, when issuing a certificate, PCAshort sets the "Not Before" date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The <code>ValidityNotBefore</code> parameter can be used to customize the “Not Before” value. <br />Unlike the <code>Validity</code> parameter, the <code>ValidityNotBefore</code> parameter is optional.<br />The <code>ValidityNotBefore</code> value is expressed as an explicit date and time, using the <code>Validity</code> type value <code>ABSOLUTE</code>.</td></tr>
 <tr><td><CopyableCode code="certificate" /></td><td><code>string</code></td><td></td></tr>
-<tr><td><CopyableCode code="arn" /></td><td><code>undefined</code></td><td></td></tr>
+<tr><td><CopyableCode code="arn" /></td><td><code>string</code></td><td></td></tr>
 <tr><td><CopyableCode code="region" /></td><td><code>string</code></td><td>AWS region.</td></tr>
 </tbody></table>
 

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

@@ -21,8 +21,6 @@ The acmpca service documentation.
 <div class="row">
 <div class="providerDocColumn">
 <span>total resources:&nbsp;<b>4</b></span><br />
-<span>total selectable resources:&nbsp;<b>4</b></span><br />
-<span>total methods:&nbsp;<b>4</b></span><br />
 </div>
 </div>
 

docs/aws-docs/providers/aws/amplify/apps/index.md

@@ -34,8 +34,8 @@ Creates, updates, deletes or gets an <code>app</code> resource or lists <code>ap
 <tr><td><CopyableCode code="app_id" /></td><td><code>string</code></td><td></td></tr>
 <tr><td><CopyableCode code="app_name" /></td><td><code>string</code></td><td></td></tr>
 <tr><td><CopyableCode code="arn" /></td><td><code>string</code></td><td></td></tr>
-<tr><td><CopyableCode code="auto_branch_creation_config" /></td><td><code>undefined</code></td><td></td></tr>
-<tr><td><CopyableCode code="basic_auth_config" /></td><td><code>undefined</code></td><td></td></tr>
+<tr><td><CopyableCode code="auto_branch_creation_config" /></td><td><code>object</code></td><td></td></tr>
+<tr><td><CopyableCode code="basic_auth_config" /></td><td><code>object</code></td><td></td></tr>
 <tr><td><CopyableCode code="build_spec" /></td><td><code>string</code></td><td></td></tr>
 <tr><td><CopyableCode code="custom_headers" /></td><td><code>string</code></td><td></td></tr>
 <tr><td><CopyableCode code="custom_rules" /></td><td><code>array</code></td><td></td></tr>

docs/aws-docs/providers/aws/amplify/branches/index.md

@@ -32,8 +32,8 @@ Creates, updates, deletes or gets a <code>branch</code> resource or lists <code>
 ## Fields
 <table><tbody><tr><th>Name</th><th>Datatype</th><th>Description</th></tr><tr><td><CopyableCode code="app_id" /></td><td><code>string</code></td><td></td></tr>
 <tr><td><CopyableCode code="arn" /></td><td><code>string</code></td><td></td></tr>
-<tr><td><CopyableCode code="basic_auth_config" /></td><td><code>undefined</code></td><td></td></tr>
-<tr><td><CopyableCode code="backend" /></td><td><code>undefined</code></td><td></td></tr>
+<tr><td><CopyableCode code="basic_auth_config" /></td><td><code>object</code></td><td></td></tr>
+<tr><td><CopyableCode code="backend" /></td><td><code>object</code></td><td></td></tr>
 <tr><td><CopyableCode code="branch_name" /></td><td><code>string</code></td><td></td></tr>
 <tr><td><CopyableCode code="build_spec" /></td><td><code>string</code></td><td></td></tr>
 <tr><td><CopyableCode code="description" /></td><td><code>string</code></td><td></td></tr>

docs/aws-docs/providers/aws/amplify/domains/index.md

@@ -35,8 +35,8 @@ Creates, updates, deletes or gets a <code>domain</code> resource or lists <code>
 <tr><td><CopyableCode code="auto_sub_domain_creation_patterns" /></td><td><code>array</code></td><td></td></tr>
 <tr><td><CopyableCode code="auto_sub_domain_iam_role" /></td><td><code>string</code></td><td></td></tr>
 <tr><td><CopyableCode code="certificate_record" /></td><td><code>string</code></td><td></td></tr>
-<tr><td><CopyableCode code="certificate" /></td><td><code>undefined</code></td><td></td></tr>
-<tr><td><CopyableCode code="certificate_settings" /></td><td><code>undefined</code></td><td></td></tr>
+<tr><td><CopyableCode code="certificate" /></td><td><code>object</code></td><td></td></tr>
+<tr><td><CopyableCode code="certificate_settings" /></td><td><code>object</code></td><td></td></tr>
 <tr><td><CopyableCode code="domain_name" /></td><td><code>string</code></td><td></td></tr>
 <tr><td><CopyableCode code="domain_status" /></td><td><code>string</code></td><td></td></tr>
 <tr><td><CopyableCode code="update_status" /></td><td><code>string</code></td><td></td></tr>

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

@@ -21,8 +21,6 @@ The amplify service documentation.
 <div class="row">
 <div class="providerDocColumn">
 <span>total resources:&nbsp;<b>3</b></span><br />
-<span>total selectable resources:&nbsp;<b>3</b></span><br />
-<span>total methods:&nbsp;<b>3</b></span><br />
 </div>
 </div>
 

docs/aws-docs/providers/aws/amplifyuibuilder/components/index.md

@@ -31,21 +31,21 @@ Creates, updates, deletes or gets a <code>component</code> resource or lists <co
 
 ## Fields
 <table><tbody><tr><th>Name</th><th>Datatype</th><th>Description</th></tr><tr><td><CopyableCode code="app_id" /></td><td><code>string</code></td><td></td></tr>
-<tr><td><CopyableCode code="binding_properties" /></td><td><code>undefined</code></td><td></td></tr>
+<tr><td><CopyableCode code="binding_properties" /></td><td><code>object</code></td><td></td></tr>
 <tr><td><CopyableCode code="children" /></td><td><code>array</code></td><td></td></tr>
-<tr><td><CopyableCode code="collection_properties" /></td><td><code>undefined</code></td><td></td></tr>
+<tr><td><CopyableCode code="collection_properties" /></td><td><code>object</code></td><td></td></tr>
 <tr><td><CopyableCode code="component_type" /></td><td><code>string</code></td><td></td></tr>
 <tr><td><CopyableCode code="created_at" /></td><td><code>string</code></td><td></td></tr>
 <tr><td><CopyableCode code="environment_name" /></td><td><code>string</code></td><td></td></tr>
-<tr><td><CopyableCode code="events" /></td><td><code>undefined</code></td><td></td></tr>
+<tr><td><CopyableCode code="events" /></td><td><code>object</code></td><td></td></tr>
 <tr><td><CopyableCode code="id" /></td><td><code>string</code></td><td></td></tr>
 <tr><td><CopyableCode code="modified_at" /></td><td><code>string</code></td><td></td></tr>
 <tr><td><CopyableCode code="name" /></td><td><code>string</code></td><td></td></tr>
-<tr><td><CopyableCode code="overrides" /></td><td><code>undefined</code></td><td></td></tr>
-<tr><td><CopyableCode code="properties" /></td><td><code>undefined</code></td><td></td></tr>
+<tr><td><CopyableCode code="overrides" /></td><td><code>object</code></td><td></td></tr>
+<tr><td><CopyableCode code="properties" /></td><td><code>object</code></td><td></td></tr>
 <tr><td><CopyableCode code="schema_version" /></td><td><code>string</code></td><td></td></tr>
 <tr><td><CopyableCode code="source_id" /></td><td><code>string</code></td><td></td></tr>
-<tr><td><CopyableCode code="tags" /></td><td><code>undefined</code></td><td></td></tr>
+<tr><td><CopyableCode code="tags" /></td><td><code>object</code></td><td></td></tr>
 <tr><td><CopyableCode code="variants" /></td><td><code>array</code></td><td></td></tr>
 <tr><td><CopyableCode code="region" /></td><td><code>string</code></td><td>AWS region.</td></tr>
 </tbody></table>

docs/aws-docs/providers/aws/amplifyuibuilder/forms/index.md

@@ -31,18 +31,18 @@ Creates, updates, deletes or gets a <code>form</code> resource or lists <code>fo
 
 ## Fields
 <table><tbody><tr><th>Name</th><th>Datatype</th><th>Description</th></tr><tr><td><CopyableCode code="app_id" /></td><td><code>string</code></td><td></td></tr>
-<tr><td><CopyableCode code="cta" /></td><td><code>undefined</code></td><td></td></tr>
-<tr><td><CopyableCode code="data_type" /></td><td><code>undefined</code></td><td></td></tr>
+<tr><td><CopyableCode code="cta" /></td><td><code>object</code></td><td></td></tr>
+<tr><td><CopyableCode code="data_type" /></td><td><code>object</code></td><td></td></tr>
 <tr><td><CopyableCode code="environment_name" /></td><td><code>string</code></td><td></td></tr>
-<tr><td><CopyableCode code="fields" /></td><td><code>undefined</code></td><td></td></tr>
-<tr><td><CopyableCode code="form_action_type" /></td><td><code>undefined</code></td><td></td></tr>
+<tr><td><CopyableCode code="fields" /></td><td><code>object</code></td><td></td></tr>
+<tr><td><CopyableCode code="form_action_type" /></td><td><code>string</code></td><td></td></tr>
 <tr><td><CopyableCode code="id" /></td><td><code>string</code></td><td></td></tr>
-<tr><td><CopyableCode code="label_decorator" /></td><td><code>undefined</code></td><td></td></tr>
+<tr><td><CopyableCode code="label_decorator" /></td><td><code>string</code></td><td></td></tr>
 <tr><td><CopyableCode code="name" /></td><td><code>string</code></td><td></td></tr>
 <tr><td><CopyableCode code="schema_version" /></td><td><code>string</code></td><td></td></tr>
-<tr><td><CopyableCode code="sectional_elements" /></td><td><code>undefined</code></td><td></td></tr>
-<tr><td><CopyableCode code="style" /></td><td><code>undefined</code></td><td></td></tr>
-<tr><td><CopyableCode code="tags" /></td><td><code>undefined</code></td><td></td></tr>
+<tr><td><CopyableCode code="sectional_elements" /></td><td><code>object</code></td><td></td></tr>
+<tr><td><CopyableCode code="style" /></td><td><code>object</code></td><td></td></tr>
+<tr><td><CopyableCode code="tags" /></td><td><code>object</code></td><td></td></tr>
 <tr><td><CopyableCode code="region" /></td><td><code>string</code></td><td>AWS region.</td></tr>
 </tbody></table>
 

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

@@ -21,8 +21,6 @@ The amplifyuibuilder service documentation.
 <div class="row">
 <div class="providerDocColumn">
 <span>total resources:&nbsp;<b>3</b></span><br />
-<span>total selectable resources:&nbsp;<b>3</b></span><br />
-<span>total methods:&nbsp;<b>3</b></span><br />
 </div>
 </div>
 

docs/aws-docs/providers/aws/amplifyuibuilder/themes/index.md

@@ -37,7 +37,7 @@ Creates, updates, deletes or gets a <code>theme</code> resource or lists <code>t
 <tr><td><CopyableCode code="modified_at" /></td><td><code>string</code></td><td></td></tr>
 <tr><td><CopyableCode code="name" /></td><td><code>string</code></td><td></td></tr>
 <tr><td><CopyableCode code="overrides" /></td><td><code>array</code></td><td></td></tr>
-<tr><td><CopyableCode code="tags" /></td><td><code>undefined</code></td><td></td></tr>
+<tr><td><CopyableCode code="tags" /></td><td><code>object</code></td><td></td></tr>
 <tr><td><CopyableCode code="values" /></td><td><code>array</code></td><td></td></tr>
 <tr><td><CopyableCode code="region" /></td><td><code>string</code></td><td>AWS region.</td></tr>
 </tbody></table>