feat(client-codeguru-security): This release includes minor model upd…

…ates and documentation updates.
aws · May 31, 2024 · ed7b888 · ed7b888
1 parent 4847ad6
commit ed7b888
Show file tree

Hide file tree

Showing 15 changed files with 171 additions and 130 deletions.
diff --git a/clients/client-codeguru-security/README.md b/clients/client-codeguru-security/README.md
@@ -7,8 +7,7 @@
 AWS SDK for JavaScript CodeGuruSecurity Client for Node.js, Browser and React Native.
 
 <note>
-<p>Amazon CodeGuru Security is in preview release and is subject to
-change.</p>
+<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

diff --git a/clients/client-codeguru-security/src/CodeGuruSecurity.ts b/clients/client-codeguru-security/src/CodeGuruSecurity.ts
@@ -253,8 +253,7 @@ export interface CodeGuruSecurity {
 
 /**
  * <note>
- *             <p>Amazon CodeGuru Security is in preview release and is subject to
- *         change.</p>
+ *             <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

diff --git a/clients/client-codeguru-security/src/CodeGuruSecurityClient.ts b/clients/client-codeguru-security/src/CodeGuruSecurityClient.ts
@@ -298,8 +298,7 @@ export interface CodeGuruSecurityClientResolvedConfig extends CodeGuruSecurityCl
 
 /**
  * <note>
- *             <p>Amazon CodeGuru Security is in preview release and is subject to
- *         change.</p>
+ *             <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

diff --git a/clients/client-codeguru-security/src/commands/BatchGetFindingsCommand.ts b/clients/client-codeguru-security/src/commands/BatchGetFindingsCommand.ts
@@ -27,7 +27,7 @@ export interface BatchGetFindingsCommandInput extends BatchGetFindingsRequest {}
 export interface BatchGetFindingsCommandOutput extends BatchGetFindingsResponse, __MetadataBearer {}
 
 /**
- * <p>Returns a list of all requested findings.</p>
+ * <p>Returns a list of requested findings from standard 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/commands/CreateScanCommand.ts b/clients/client-codeguru-security/src/commands/CreateScanCommand.ts
@@ -27,7 +27,7 @@ export interface CreateScanCommandInput extends CreateScanRequest {}
 export interface CreateScanCommandOutput extends CreateScanResponse, __MetadataBearer {}
 
 /**
- * <p>Use to create a scan using code uploaded to an S3 bucket.</p>
+ * <p>Use to create a scan using code uploaded to an Amazon S3 bucket.</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/commands/CreateUploadUrlCommand.ts b/clients/client-codeguru-security/src/commands/CreateUploadUrlCommand.ts
@@ -31,8 +31,9 @@ export interface CreateUploadUrlCommandInput extends CreateUploadUrlRequest {}
 export interface CreateUploadUrlCommandOutput extends CreateUploadUrlResponse, __MetadataBearer {}
 
 /**
- * <p>Generates a pre-signed URL and request headers used to upload a code resource.</p>
- *          <p>You can upload your code resource to the URL and add the request headers using any HTTP
+ * <p>Generates a pre-signed URL, request headers used to upload a code resource, and code
+ *       artifact identifier for the uploaded resource.</p>
+ *          <p>You can upload your code resource to the URL with the request headers using any HTTP
  *       client.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-codeguru-security/src/commands/GetAccountConfigurationCommand.ts b/clients/client-codeguru-security/src/commands/GetAccountConfigurationCommand.ts
@@ -27,7 +27,7 @@ export interface GetAccountConfigurationCommandInput extends GetAccountConfigura
 export interface GetAccountConfigurationCommandOutput extends GetAccountConfigurationResponse, __MetadataBearer {}
 
 /**
- * <p>Use to get account level configuration.</p>
+ * <p>Use to get the encryption configuration for an account.</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/commands/GetMetricsSummaryCommand.ts b/clients/client-codeguru-security/src/commands/GetMetricsSummaryCommand.ts
@@ -27,7 +27,7 @@ export interface GetMetricsSummaryCommandInput extends GetMetricsSummaryRequest
 export interface GetMetricsSummaryCommandOutput extends GetMetricsSummaryResponse, __MetadataBearer {}
 
 /**
- * <p>Returns top level metrics about an account from a specified date, including number of open
+ * <p>Returns a summary of metrics for an account from a specified date, including number of open
  *       findings, the categories with most findings, the scans with most open findings, and scans with
  *       most open critical findings. </p>
  * @example

diff --git a/clients/client-codeguru-security/src/commands/GetScanCommand.ts b/clients/client-codeguru-security/src/commands/GetScanCommand.ts
@@ -49,6 +49,7 @@ export interface GetScanCommandOutput extends GetScanResponse, __MetadataBearer
  * //   updatedAt: new Date("TIMESTAMP"),
  * //   numberOfRevisions: Number("long"),
  * //   scanNameArn: "STRING_VALUE",
+ * //   errorMessage: "STRING_VALUE",
  * // };
  *
  * ```
@@ -71,6 +72,9 @@ export interface GetScanCommandOutput extends GetScanResponse, __MetadataBearer
  * @throws {@link ThrottlingException} (client fault)
  *  <p>The request was denied due to request throttling.</p>
  *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the specified constraints.</p>
+ *
  * @throws {@link CodeGuruSecurityServiceException}
  * <p>Base exception class for all service exceptions from CodeGuruSecurity service.</p>
  *

diff --git a/clients/client-codeguru-security/src/commands/ListScansCommand.ts b/clients/client-codeguru-security/src/commands/ListScansCommand.ts
@@ -27,7 +27,7 @@ export interface ListScansCommandInput extends ListScansRequest {}
 export interface ListScansCommandOutput extends ListScansResponse, __MetadataBearer {}
 
 /**
- * <p>Returns a list of all the standard scans in an account. Does not return express
+ * <p>Returns a list of all scans in an account. Does not return <code>EXPRESS</code>
  *       scans.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-codeguru-security/src/commands/UpdateAccountConfigurationCommand.ts b/clients/client-codeguru-security/src/commands/UpdateAccountConfigurationCommand.ts
@@ -27,7 +27,7 @@ export interface UpdateAccountConfigurationCommandInput extends UpdateAccountCon
 export interface UpdateAccountConfigurationCommandOutput extends UpdateAccountConfigurationResponse, __MetadataBearer {}
 
 /**
- * <p>Use to update account-level configuration with an encryption key.</p>
+ * <p>Use to update the encryption configuration for an account.</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
@@ -2,8 +2,7 @@
 /* eslint-disable */
 /**
  * <note>
- *             <p>Amazon CodeGuru Security is in preview release and is subject to
- *         change.</p>
+ *             <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