Skip to content

Commit ed7b888

Browse files
author
awstools
committed
feat(client-codeguru-security): This release includes minor model updates and documentation updates.
1 parent 4847ad6 commit ed7b888

15 files changed

+171
-130
lines changed

Diff for: clients/client-codeguru-security/README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@
77
AWS SDK for JavaScript CodeGuruSecurity Client for Node.js, Browser and React Native.
88

99
<note>
10-
<p>Amazon CodeGuru Security is in preview release and is subject to
11-
change.</p>
10+
<p>Amazon CodeGuru Security is in preview release and is subject to change.</p>
1211
</note>
1312
<p>This section provides documentation for the Amazon CodeGuru Security API operations.
1413
CodeGuru Security is a service that uses program analysis and machine learning to detect

Diff for: clients/client-codeguru-security/src/CodeGuruSecurity.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -253,8 +253,7 @@ export interface CodeGuruSecurity {
253253

254254
/**
255255
* <note>
256-
* <p>Amazon CodeGuru Security is in preview release and is subject to
257-
* change.</p>
256+
* <p>Amazon CodeGuru Security is in preview release and is subject to change.</p>
258257
* </note>
259258
* <p>This section provides documentation for the Amazon CodeGuru Security API operations.
260259
* CodeGuru Security is a service that uses program analysis and machine learning to detect

Diff for: clients/client-codeguru-security/src/CodeGuruSecurityClient.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -298,8 +298,7 @@ export interface CodeGuruSecurityClientResolvedConfig extends CodeGuruSecurityCl
298298

299299
/**
300300
* <note>
301-
* <p>Amazon CodeGuru Security is in preview release and is subject to
302-
* change.</p>
301+
* <p>Amazon CodeGuru Security is in preview release and is subject to change.</p>
303302
* </note>
304303
* <p>This section provides documentation for the Amazon CodeGuru Security API operations.
305304
* CodeGuru Security is a service that uses program analysis and machine learning to detect

Diff for: clients/client-codeguru-security/src/commands/BatchGetFindingsCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export interface BatchGetFindingsCommandInput extends BatchGetFindingsRequest {}
2727
export interface BatchGetFindingsCommandOutput extends BatchGetFindingsResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>Returns a list of all requested findings.</p>
30+
* <p>Returns a list of requested findings from standard scans.</p>
3131
* @example
3232
* Use a bare-bones client and the command you need to make an API call.
3333
* ```javascript

Diff for: clients/client-codeguru-security/src/commands/CreateScanCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export interface CreateScanCommandInput extends CreateScanRequest {}
2727
export interface CreateScanCommandOutput extends CreateScanResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>Use to create a scan using code uploaded to an S3 bucket.</p>
30+
* <p>Use to create a scan using code uploaded to an Amazon S3 bucket.</p>
3131
* @example
3232
* Use a bare-bones client and the command you need to make an API call.
3333
* ```javascript

Diff for: clients/client-codeguru-security/src/commands/CreateUploadUrlCommand.ts

+3-2
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,9 @@ export interface CreateUploadUrlCommandInput extends CreateUploadUrlRequest {}
3131
export interface CreateUploadUrlCommandOutput extends CreateUploadUrlResponse, __MetadataBearer {}
3232

3333
/**
34-
* <p>Generates a pre-signed URL and request headers used to upload a code resource.</p>
35-
* <p>You can upload your code resource to the URL and add the request headers using any HTTP
34+
* <p>Generates a pre-signed URL, request headers used to upload a code resource, and code
35+
* artifact identifier for the uploaded resource.</p>
36+
* <p>You can upload your code resource to the URL with the request headers using any HTTP
3637
* client.</p>
3738
* @example
3839
* Use a bare-bones client and the command you need to make an API call.

Diff for: clients/client-codeguru-security/src/commands/GetAccountConfigurationCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export interface GetAccountConfigurationCommandInput extends GetAccountConfigura
2727
export interface GetAccountConfigurationCommandOutput extends GetAccountConfigurationResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>Use to get account level configuration.</p>
30+
* <p>Use to get the encryption configuration for an account.</p>
3131
* @example
3232
* Use a bare-bones client and the command you need to make an API call.
3333
* ```javascript

Diff for: clients/client-codeguru-security/src/commands/GetMetricsSummaryCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export interface GetMetricsSummaryCommandInput extends GetMetricsSummaryRequest
2727
export interface GetMetricsSummaryCommandOutput extends GetMetricsSummaryResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>Returns top level metrics about an account from a specified date, including number of open
30+
* <p>Returns a summary of metrics for an account from a specified date, including number of open
3131
* findings, the categories with most findings, the scans with most open findings, and scans with
3232
* most open critical findings. </p>
3333
* @example

Diff for: clients/client-codeguru-security/src/commands/GetScanCommand.ts

+4
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ export interface GetScanCommandOutput extends GetScanResponse, __MetadataBearer
4949
* // updatedAt: new Date("TIMESTAMP"),
5050
* // numberOfRevisions: Number("long"),
5151
* // scanNameArn: "STRING_VALUE",
52+
* // errorMessage: "STRING_VALUE",
5253
* // };
5354
*
5455
* ```
@@ -71,6 +72,9 @@ export interface GetScanCommandOutput extends GetScanResponse, __MetadataBearer
7172
* @throws {@link ThrottlingException} (client fault)
7273
* <p>The request was denied due to request throttling.</p>
7374
*
75+
* @throws {@link ValidationException} (client fault)
76+
* <p>The input fails to satisfy the specified constraints.</p>
77+
*
7478
* @throws {@link CodeGuruSecurityServiceException}
7579
* <p>Base exception class for all service exceptions from CodeGuruSecurity service.</p>
7680
*

Diff for: clients/client-codeguru-security/src/commands/ListScansCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export interface ListScansCommandInput extends ListScansRequest {}
2727
export interface ListScansCommandOutput extends ListScansResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>Returns a list of all the standard scans in an account. Does not return express
30+
* <p>Returns a list of all scans in an account. Does not return <code>EXPRESS</code>
3131
* scans.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.

Diff for: clients/client-codeguru-security/src/commands/UpdateAccountConfigurationCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ export interface UpdateAccountConfigurationCommandInput extends UpdateAccountCon
2727
export interface UpdateAccountConfigurationCommandOutput extends UpdateAccountConfigurationResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>Use to update account-level configuration with an encryption key.</p>
30+
* <p>Use to update the encryption configuration for an account.</p>
3131
* @example
3232
* Use a bare-bones client and the command you need to make an API call.
3333
* ```javascript

Diff for: clients/client-codeguru-security/src/index.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22
/* eslint-disable */
33
/**
44
* <note>
5-
* <p>Amazon CodeGuru Security is in preview release and is subject to
6-
* change.</p>
5+
* <p>Amazon CodeGuru Security is in preview release and is subject to change.</p>
76
* </note>
87
* <p>This section provides documentation for the Amazon CodeGuru Security API operations.
98
* CodeGuru Security is a service that uses program analysis and machine learning to detect

0 commit comments

Comments
 (0)