docs(client-codeguru-security): Documentation updates for CodeGuru Se…

…curity.
aws · Jul 18, 2023 · 11c89c0 · 11c89c0
1 parent 16e1114
commit 11c89c0
Show file tree

Hide file tree

Showing 7 changed files with 2,998 additions and 2,981 deletions.
diff --git a/clients/client-codeguru-security/README.md b/clients/client-codeguru-security/README.md
@@ -6,7 +6,11 @@
 
 AWS SDK for JavaScript CodeGuruSecurity Client for Node.js, Browser and React Native.
 
-<p>This section provides documentation for the <a href="https://docs.aws.amazon.com/https:/docs.aws.amazon.com/codeguru/latest/security-ug/what-is-codeguru-security.html">Amazon CodeGuru Security</a> API operations.
+<note>
+<p>Amazon CodeGuru Security is in preview release and is subject to
+change.</p>
+</note>
+<p>This section provides documentation for the Amazon CodeGuru Security API operations.
 CodeGuru Security is a service that uses program analysis and machine learning to detect
 security policy violations and vulnerabilities, and recommends ways to address these security
 risks.</p>

diff --git a/clients/client-codeguru-security/src/CodeGuruSecurity.ts b/clients/client-codeguru-security/src/CodeGuruSecurity.ts
@@ -251,7 +251,11 @@ export interface CodeGuruSecurity {
 
 /**
  * @public
- * <p>This section provides documentation for the <a href="https://docs.aws.amazon.com/https:/docs.aws.amazon.com/codeguru/latest/security-ug/what-is-codeguru-security.html">Amazon CodeGuru Security</a> API operations.
+ * <note>
+ *             <p>Amazon CodeGuru Security is in preview release and is subject to
+ *         change.</p>
+ *          </note>
+ *          <p>This section provides documentation for the Amazon CodeGuru Security API operations.
  *       CodeGuru Security is a service that uses program analysis and machine learning to detect
  *       security policy violations and vulnerabilities, and recommends ways to address these security
  *       risks.</p>

diff --git a/clients/client-codeguru-security/src/CodeGuruSecurityClient.ts b/clients/client-codeguru-security/src/CodeGuruSecurityClient.ts
@@ -284,7 +284,11 @@ export interface CodeGuruSecurityClientResolvedConfig extends CodeGuruSecurityCl
 
 /**
  * @public
- * <p>This section provides documentation for the <a href="https://docs.aws.amazon.com/https:/docs.aws.amazon.com/codeguru/latest/security-ug/what-is-codeguru-security.html">Amazon CodeGuru Security</a> API operations.
+ * <note>
+ *             <p>Amazon CodeGuru Security is in preview release and is subject to
+ *         change.</p>
+ *          </note>
+ *          <p>This section provides documentation for the Amazon CodeGuru Security API operations.
  *       CodeGuru Security is a service that uses program analysis and machine learning to detect
  *       security policy violations and vulnerabilities, and recommends ways to address these security
  *       risks.</p>

diff --git a/clients/client-codeguru-security/src/commands/ListScansCommand.ts b/clients/client-codeguru-security/src/commands/ListScansCommand.ts
@@ -36,7 +36,8 @@ export interface ListScansCommandOutput extends ListScansResponse, __MetadataBea
 
 /**
  * @public
- * <p>Returns a list of all the scans in an account.</p>
+ * <p>Returns a list of all the standard scans in an account. Does not return express
+ *       scans.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-codeguru-security/src/index.ts b/clients/client-codeguru-security/src/index.ts
@@ -1,7 +1,11 @@
 // smithy-typescript generated code
 /* eslint-disable */
 /**
- * <p>This section provides documentation for the <a href="https://docs.aws.amazon.com/https:/docs.aws.amazon.com/codeguru/latest/security-ug/what-is-codeguru-security.html">Amazon CodeGuru Security</a> API operations.
+ * <note>
+ *             <p>Amazon CodeGuru Security is in preview release and is subject to
+ *         change.</p>
+ *          </note>
+ *          <p>This section provides documentation for the Amazon CodeGuru Security API operations.
  *       CodeGuru Security is a service that uses program analysis and machine learning to detect
  *       security policy violations and vulnerabilities, and recommends ways to address these security
  *       risks.</p>

diff --git a/clients/client-codeguru-security/src/models/models_0.ts b/clients/client-codeguru-security/src/models/models_0.ts
@@ -738,7 +738,7 @@ export interface CreateScanRequest {
 
   /**
    * <p>The type of analysis you want CodeGuru Security to perform in the scan, either
-   *         <code>Security</code> or <code>All</code>. The <code>Secuirty</code> type only generates
+   *         <code>Security</code> or <code>All</code>. The <code>Security</code> type only generates
    *       findings related to security. The <code>All</code> type generates both security findings and
    *       quality findings. Defaults to <code>Security</code> type if missing.</p>
    */