@aws-sdk/client-codeguru-security 3.873.0 → 3.876.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -11
- package/dist-types/CodeGuruSecurity.d.ts +1 -11
- package/dist-types/CodeGuruSecurityClient.d.ts +1 -11
- package/dist-types/commands/CreateScanCommand.d.ts +1 -3
- package/dist-types/commands/CreateUploadUrlCommand.d.ts +1 -4
- package/dist-types/commands/GetFindingsCommand.d.ts +1 -3
- package/dist-types/commands/GetMetricsSummaryCommand.d.ts +1 -3
- package/dist-types/commands/ListScansCommand.d.ts +1 -2
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -3
- package/dist-types/commands/TagResourceCommand.d.ts +1 -3
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -3
- package/dist-types/index.d.ts +1 -11
- package/dist-types/models/models_0.d.ts +57 -177
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -6,17 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
AWS SDK for JavaScript CodeGuruSecurity Client for Node.js, Browser and React Native.
|
|
8
8
|
|
|
9
|
-
<note>
|
|
10
|
-
<p>Amazon CodeGuru Security is in preview release and is subject to change.</p>
|
|
11
|
-
</note>
|
|
12
|
-
<p>This section provides documentation for the Amazon CodeGuru Security API operations.
|
|
13
|
-
CodeGuru Security is a service that uses program analysis and machine learning to detect
|
|
14
|
-
security policy violations and vulnerabilities, and recommends ways to address these security
|
|
15
|
-
risks.</p>
|
|
16
|
-
<p>By proactively detecting and providing recommendations for addressing security risks,
|
|
17
|
-
CodeGuru Security improves the overall security of your application code. For more information
|
|
18
|
-
about CodeGuru Security, see the
|
|
19
|
-
<a href="https://docs.aws.amazon.com/codeguru/latest/security-ug/what-is-codeguru-security.html">Amazon CodeGuru Security User Guide</a>. </p>
|
|
9
|
+
<note> <p>On November 20, 2025, AWS will discontinue support for Amazon CodeGuru Security. After November 20, 2025, you will no longer be able to access the /codeguru/security console, service resources, or documentation. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/security-ug/end-of-support.html">https://docs.aws.amazon.com/codeguru/latest/security-ug/end-of-support.html</a>.</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> <p>By proactively detecting and providing recommendations for addressing security risks, CodeGuru Security improves the overall security of your application code. For more information about CodeGuru Security, see the <a href="https://docs.aws.amazon.com/codeguru/latest/security-ug/what-is-codeguru-security.html">Amazon CodeGuru Security User Guide</a>. </p>
|
|
20
10
|
|
|
21
11
|
## Installing
|
|
22
12
|
|
|
@@ -96,17 +96,7 @@ export interface CodeGuruSecurity {
|
|
|
96
96
|
updateAccountConfiguration(args: UpdateAccountConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccountConfigurationCommandOutput) => void): void;
|
|
97
97
|
}
|
|
98
98
|
/**
|
|
99
|
-
* <note>
|
|
100
|
-
* <p>Amazon CodeGuru Security is in preview release and is subject to change.</p>
|
|
101
|
-
* </note>
|
|
102
|
-
* <p>This section provides documentation for the Amazon CodeGuru Security API operations.
|
|
103
|
-
* CodeGuru Security is a service that uses program analysis and machine learning to detect
|
|
104
|
-
* security policy violations and vulnerabilities, and recommends ways to address these security
|
|
105
|
-
* risks.</p>
|
|
106
|
-
* <p>By proactively detecting and providing recommendations for addressing security risks,
|
|
107
|
-
* CodeGuru Security improves the overall security of your application code. For more information
|
|
108
|
-
* about CodeGuru Security, see the
|
|
109
|
-
* <a href="https://docs.aws.amazon.com/codeguru/latest/security-ug/what-is-codeguru-security.html">Amazon CodeGuru Security User Guide</a>. </p>
|
|
99
|
+
* <note> <p>On November 20, 2025, AWS will discontinue support for Amazon CodeGuru Security. After November 20, 2025, you will no longer be able to access the /codeguru/security console, service resources, or documentation. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/security-ug/end-of-support.html">https://docs.aws.amazon.com/codeguru/latest/security-ug/end-of-support.html</a>.</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> <p>By proactively detecting and providing recommendations for addressing security risks, CodeGuru Security improves the overall security of your application code. For more information about CodeGuru Security, see the <a href="https://docs.aws.amazon.com/codeguru/latest/security-ug/what-is-codeguru-security.html">Amazon CodeGuru Security User Guide</a>. </p>
|
|
110
100
|
* @public
|
|
111
101
|
*/
|
|
112
102
|
export declare class CodeGuruSecurity extends CodeGuruSecurityClient implements CodeGuruSecurity {
|
|
@@ -182,17 +182,7 @@ export type CodeGuruSecurityClientResolvedConfigType = __SmithyResolvedConfigura
|
|
|
182
182
|
export interface CodeGuruSecurityClientResolvedConfig extends CodeGuruSecurityClientResolvedConfigType {
|
|
183
183
|
}
|
|
184
184
|
/**
|
|
185
|
-
* <note>
|
|
186
|
-
* <p>Amazon CodeGuru Security is in preview release and is subject to change.</p>
|
|
187
|
-
* </note>
|
|
188
|
-
* <p>This section provides documentation for the Amazon CodeGuru Security API operations.
|
|
189
|
-
* CodeGuru Security is a service that uses program analysis and machine learning to detect
|
|
190
|
-
* security policy violations and vulnerabilities, and recommends ways to address these security
|
|
191
|
-
* risks.</p>
|
|
192
|
-
* <p>By proactively detecting and providing recommendations for addressing security risks,
|
|
193
|
-
* CodeGuru Security improves the overall security of your application code. For more information
|
|
194
|
-
* about CodeGuru Security, see the
|
|
195
|
-
* <a href="https://docs.aws.amazon.com/codeguru/latest/security-ug/what-is-codeguru-security.html">Amazon CodeGuru Security User Guide</a>. </p>
|
|
185
|
+
* <note> <p>On November 20, 2025, AWS will discontinue support for Amazon CodeGuru Security. After November 20, 2025, you will no longer be able to access the /codeguru/security console, service resources, or documentation. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/security-ug/end-of-support.html">https://docs.aws.amazon.com/codeguru/latest/security-ug/end-of-support.html</a>.</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> <p>By proactively detecting and providing recommendations for addressing security risks, CodeGuru Security improves the overall security of your application code. For more information about CodeGuru Security, see the <a href="https://docs.aws.amazon.com/codeguru/latest/security-ug/what-is-codeguru-security.html">Amazon CodeGuru Security User Guide</a>. </p>
|
|
196
186
|
* @public
|
|
197
187
|
*/
|
|
198
188
|
export declare class CodeGuruSecurityClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, CodeGuruSecurityClientResolvedConfig> {
|
|
@@ -70,9 +70,7 @@ declare const CreateScanCommand_base: {
|
|
|
70
70
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
71
71
|
*
|
|
72
72
|
* @throws {@link ConflictException} (client fault)
|
|
73
|
-
* <p>The requested operation would cause a conflict with the current state of a service
|
|
74
|
-
* resource associated with the request. Resolve the conflict before retrying this
|
|
75
|
-
* request.</p>
|
|
73
|
+
* <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.</p>
|
|
76
74
|
*
|
|
77
75
|
* @throws {@link InternalServerException} (server fault)
|
|
78
76
|
* <p>The server encountered an internal error and is unable to complete the request.</p>
|
|
@@ -27,10 +27,7 @@ declare const CreateUploadUrlCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Generates a pre-signed URL, request headers used to upload a code resource, and code
|
|
31
|
-
* artifact identifier for the uploaded resource.</p>
|
|
32
|
-
* <p>You can upload your code resource to the URL with the request headers using any HTTP
|
|
33
|
-
* client.</p>
|
|
30
|
+
* <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>
|
|
34
31
|
* @example
|
|
35
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
33
|
* ```javascript
|
|
@@ -115,9 +115,7 @@ declare const GetFindingsCommand_base: {
|
|
|
115
115
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
116
116
|
*
|
|
117
117
|
* @throws {@link ConflictException} (client fault)
|
|
118
|
-
* <p>The requested operation would cause a conflict with the current state of a service
|
|
119
|
-
* resource associated with the request. Resolve the conflict before retrying this
|
|
120
|
-
* request.</p>
|
|
118
|
+
* <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.</p>
|
|
121
119
|
*
|
|
122
120
|
* @throws {@link InternalServerException} (server fault)
|
|
123
121
|
* <p>The server encountered an internal error and is unable to complete the request.</p>
|
|
@@ -27,9 +27,7 @@ declare const GetMetricsSummaryCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns a summary of metrics for an account from a specified date, including number of open
|
|
31
|
-
* findings, the categories with most findings, the scans with most open findings, and scans with
|
|
32
|
-
* most open critical findings. </p>
|
|
30
|
+
* <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>
|
|
33
31
|
* @example
|
|
34
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
33
|
* ```javascript
|
|
@@ -27,8 +27,7 @@ declare const ListScansCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Returns a list of all scans in an account. Does not return <code>EXPRESS</code>
|
|
31
|
-
* scans.</p>
|
|
30
|
+
* <p>Returns a list of all scans in an account. Does not return <code>EXPRESS</code> scans.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -57,9 +57,7 @@ declare const ListTagsForResourceCommand_base: {
|
|
|
57
57
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
58
58
|
*
|
|
59
59
|
* @throws {@link ConflictException} (client fault)
|
|
60
|
-
* <p>The requested operation would cause a conflict with the current state of a service
|
|
61
|
-
* resource associated with the request. Resolve the conflict before retrying this
|
|
62
|
-
* request.</p>
|
|
60
|
+
* <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.</p>
|
|
63
61
|
*
|
|
64
62
|
* @throws {@link InternalServerException} (server fault)
|
|
65
63
|
* <p>The server encountered an internal error and is unable to complete the request.</p>
|
|
@@ -56,9 +56,7 @@ declare const TagResourceCommand_base: {
|
|
|
56
56
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
57
57
|
*
|
|
58
58
|
* @throws {@link ConflictException} (client fault)
|
|
59
|
-
* <p>The requested operation would cause a conflict with the current state of a service
|
|
60
|
-
* resource associated with the request. Resolve the conflict before retrying this
|
|
61
|
-
* request.</p>
|
|
59
|
+
* <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.</p>
|
|
62
60
|
*
|
|
63
61
|
* @throws {@link InternalServerException} (server fault)
|
|
64
62
|
* <p>The server encountered an internal error and is unable to complete the request.</p>
|
|
@@ -56,9 +56,7 @@ declare const UntagResourceCommand_base: {
|
|
|
56
56
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
57
57
|
*
|
|
58
58
|
* @throws {@link ConflictException} (client fault)
|
|
59
|
-
* <p>The requested operation would cause a conflict with the current state of a service
|
|
60
|
-
* resource associated with the request. Resolve the conflict before retrying this
|
|
61
|
-
* request.</p>
|
|
59
|
+
* <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.</p>
|
|
62
60
|
*
|
|
63
61
|
* @throws {@link InternalServerException} (server fault)
|
|
64
62
|
* <p>The server encountered an internal error and is unable to complete the request.</p>
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,15 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* <note>
|
|
3
|
-
* <p>Amazon CodeGuru Security is in preview release and is subject to change.</p>
|
|
4
|
-
* </note>
|
|
5
|
-
* <p>This section provides documentation for the Amazon CodeGuru Security API operations.
|
|
6
|
-
* CodeGuru Security is a service that uses program analysis and machine learning to detect
|
|
7
|
-
* security policy violations and vulnerabilities, and recommends ways to address these security
|
|
8
|
-
* risks.</p>
|
|
9
|
-
* <p>By proactively detecting and providing recommendations for addressing security risks,
|
|
10
|
-
* CodeGuru Security improves the overall security of your application code. For more information
|
|
11
|
-
* about CodeGuru Security, see the
|
|
12
|
-
* <a href="https://docs.aws.amazon.com/codeguru/latest/security-ug/what-is-codeguru-security.html">Amazon CodeGuru Security User Guide</a>. </p>
|
|
2
|
+
* <note> <p>On November 20, 2025, AWS will discontinue support for Amazon CodeGuru Security. After November 20, 2025, you will no longer be able to access the /codeguru/security console, service resources, or documentation. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/security-ug/end-of-support.html">https://docs.aws.amazon.com/codeguru/latest/security-ug/end-of-support.html</a>.</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> <p>By proactively detecting and providing recommendations for addressing security risks, CodeGuru Security improves the overall security of your application code. For more information about CodeGuru Security, see the <a href="https://docs.aws.amazon.com/codeguru/latest/security-ug/what-is-codeguru-security.html">Amazon CodeGuru Security User Guide</a>. </p>
|
|
13
3
|
*
|
|
14
4
|
* @packageDocumentation
|
|
15
5
|
*/
|
|
@@ -28,8 +28,7 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
28
28
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
29
29
|
}
|
|
30
30
|
/**
|
|
31
|
-
* <p>A numeric value corresponding to the severity of a finding, such as the number of open
|
|
32
|
-
* findings or the average time it takes to close findings of a given severity.</p>
|
|
31
|
+
* <p>A numeric value corresponding to the severity of a finding, such as the number of open findings or the average time it takes to close findings of a given severity.</p>
|
|
33
32
|
* @public
|
|
34
33
|
*/
|
|
35
34
|
export interface FindingMetricsValuePerSeverity {
|
|
@@ -85,8 +84,7 @@ export interface AccountFindingsMetric {
|
|
|
85
84
|
*/
|
|
86
85
|
openFindings?: FindingMetricsValuePerSeverity | undefined;
|
|
87
86
|
/**
|
|
88
|
-
* <p>The average time in days it takes to close findings of each severity as of a specified
|
|
89
|
-
* date.</p>
|
|
87
|
+
* <p>The average time in days it takes to close findings of each severity as of a specified date.</p>
|
|
90
88
|
* @public
|
|
91
89
|
*/
|
|
92
90
|
meanTimeToClose?: FindingMetricsValuePerSeverity | undefined;
|
|
@@ -124,9 +122,7 @@ export interface FindingIdentifier {
|
|
|
124
122
|
*/
|
|
125
123
|
export interface BatchGetFindingsRequest {
|
|
126
124
|
/**
|
|
127
|
-
* <p>A list of finding identifiers. Each identifier consists of a <code>scanName</code> and a
|
|
128
|
-
* <code>findingId</code>. You retrieve the <code>findingId</code> when you call
|
|
129
|
-
* <code>GetFindings</code>.</p>
|
|
125
|
+
* <p>A list of finding identifiers. Each identifier consists of a <code>scanName</code> and a <code>findingId</code>. You retrieve the <code>findingId</code> when you call <code>GetFindings</code>.</p>
|
|
130
126
|
* @public
|
|
131
127
|
*/
|
|
132
128
|
findingIdentifiers: FindingIdentifier[] | undefined;
|
|
@@ -215,8 +211,7 @@ export interface Remediation {
|
|
|
215
211
|
*/
|
|
216
212
|
recommendation?: Recommendation | undefined;
|
|
217
213
|
/**
|
|
218
|
-
* <p>A list of <code>SuggestedFix</code> objects. Each object contains information about a suggested code
|
|
219
|
-
* fix to remediate the finding.</p>
|
|
214
|
+
* <p>A list of <code>SuggestedFix</code> objects. Each object contains information about a suggested code fix to remediate the finding.</p>
|
|
220
215
|
* @public
|
|
221
216
|
*/
|
|
222
217
|
suggestedFixes?: SuggestedFix[] | undefined;
|
|
@@ -282,8 +277,7 @@ export interface CodeLine {
|
|
|
282
277
|
content?: string | undefined;
|
|
283
278
|
}
|
|
284
279
|
/**
|
|
285
|
-
* <p>Information about the location of security vulnerabilities that Amazon CodeGuru Security
|
|
286
|
-
* detected in your code.</p>
|
|
280
|
+
* <p>Information about the location of security vulnerabilities that Amazon CodeGuru Security detected in your code.</p>
|
|
287
281
|
* @public
|
|
288
282
|
*/
|
|
289
283
|
export interface FilePath {
|
|
@@ -303,14 +297,12 @@ export interface FilePath {
|
|
|
303
297
|
*/
|
|
304
298
|
startLine?: number | undefined;
|
|
305
299
|
/**
|
|
306
|
-
* <p>The last line number of the code snippet where the security vulnerability appears in your
|
|
307
|
-
* code.</p>
|
|
300
|
+
* <p>The last line number of the code snippet where the security vulnerability appears in your code.</p>
|
|
308
301
|
* @public
|
|
309
302
|
*/
|
|
310
303
|
endLine?: number | undefined;
|
|
311
304
|
/**
|
|
312
|
-
* <p>A list of <code>CodeLine</code> objects that describe where the security vulnerability
|
|
313
|
-
* appears in your code.</p>
|
|
305
|
+
* <p>A list of <code>CodeLine</code> objects that describe where the security vulnerability appears in your code.</p>
|
|
314
306
|
* @public
|
|
315
307
|
*/
|
|
316
308
|
codeSnippet?: CodeLine[] | undefined;
|
|
@@ -336,8 +328,7 @@ export interface Vulnerability {
|
|
|
336
328
|
*/
|
|
337
329
|
id?: string | undefined;
|
|
338
330
|
/**
|
|
339
|
-
* <p> An object that describes the location of the detected security vulnerability in your
|
|
340
|
-
* code.</p>
|
|
331
|
+
* <p> An object that describes the location of the detected security vulnerability in your code.</p>
|
|
341
332
|
* @public
|
|
342
333
|
*/
|
|
343
334
|
filePath?: FilePath | undefined;
|
|
@@ -375,8 +366,7 @@ export interface Finding {
|
|
|
375
366
|
*/
|
|
376
367
|
id?: string | undefined;
|
|
377
368
|
/**
|
|
378
|
-
* <p>The time when the finding was last updated. Findings are updated when you remediate them
|
|
379
|
-
* or when the finding code location changes. </p>
|
|
369
|
+
* <p>The time when the finding was last updated. Findings are updated when you remediate them or when the finding code location changes. </p>
|
|
380
370
|
* @public
|
|
381
371
|
*/
|
|
382
372
|
updatedAt?: Date | undefined;
|
|
@@ -401,10 +391,7 @@ export interface Finding {
|
|
|
401
391
|
*/
|
|
402
392
|
vulnerability?: Vulnerability | undefined;
|
|
403
393
|
/**
|
|
404
|
-
* <p>The severity of the finding. Severity can be critical, high, medium, low, or
|
|
405
|
-
* informational. For information on severity levels, see
|
|
406
|
-
* <a href="https://docs.aws.amazon.com/codeguru/latest/security-ug/findings-overview.html#severity-distribution">Finding severity</a> in the
|
|
407
|
-
* <i>Amazon CodeGuru Security User Guide</i>.</p>
|
|
394
|
+
* <p>The severity of the finding. Severity can be critical, high, medium, low, or informational. For information on severity levels, see <a href="https://docs.aws.amazon.com/codeguru/latest/security-ug/findings-overview.html#severity-distribution">Finding severity</a> in the <i>Amazon CodeGuru Security User Guide</i>.</p>
|
|
408
395
|
* @public
|
|
409
396
|
*/
|
|
410
397
|
severity?: Severity | undefined;
|
|
@@ -419,15 +406,12 @@ export interface Finding {
|
|
|
419
406
|
*/
|
|
420
407
|
title?: string | undefined;
|
|
421
408
|
/**
|
|
422
|
-
* <p>One or more tags or categorizations that are associated with a detector. These tags are
|
|
423
|
-
* defined by type, programming language, or other classification such as maintainability or
|
|
424
|
-
* consistency.</p>
|
|
409
|
+
* <p>One or more tags or categorizations that are associated with a detector. These tags are defined by type, programming language, or other classification such as maintainability or consistency.</p>
|
|
425
410
|
* @public
|
|
426
411
|
*/
|
|
427
412
|
detectorTags?: string[] | undefined;
|
|
428
413
|
/**
|
|
429
|
-
* <p>The identifier for the detector that detected the finding in your code. A detector is a
|
|
430
|
-
* defined rule based on industry standards and AWS best practices. </p>
|
|
414
|
+
* <p>The identifier for the detector that detected the finding in your code. A detector is a defined rule based on industry standards and AWS best practices. </p>
|
|
431
415
|
* @public
|
|
432
416
|
*/
|
|
433
417
|
detectorId?: string | undefined;
|
|
@@ -452,9 +436,7 @@ export interface BatchGetFindingsResponse {
|
|
|
452
436
|
*/
|
|
453
437
|
findings: Finding[] | undefined;
|
|
454
438
|
/**
|
|
455
|
-
* <p>A list of errors for individual findings which were not fetched. Each
|
|
456
|
-
* BatchGetFindingsError contains the <code>scanName</code>, <code>findingId</code>,
|
|
457
|
-
* <code>errorCode</code> and error <code>message</code>.</p>
|
|
439
|
+
* <p>A list of errors for individual findings which were not fetched. Each BatchGetFindingsError contains the <code>scanName</code>, <code>findingId</code>, <code>errorCode</code> and error <code>message</code>.</p>
|
|
458
440
|
* @public
|
|
459
441
|
*/
|
|
460
442
|
failedFindings: BatchGetFindingsError[] | undefined;
|
|
@@ -566,9 +548,7 @@ export declare class ValidationException extends __BaseException {
|
|
|
566
548
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
567
549
|
}
|
|
568
550
|
/**
|
|
569
|
-
* <p>The requested operation would cause a conflict with the current state of a service
|
|
570
|
-
* resource associated with the request. Resolve the conflict before retrying this
|
|
571
|
-
* request.</p>
|
|
551
|
+
* <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.</p>
|
|
572
552
|
* @public
|
|
573
553
|
*/
|
|
574
554
|
export declare class ConflictException extends __BaseException {
|
|
@@ -595,8 +575,7 @@ export declare class ConflictException extends __BaseException {
|
|
|
595
575
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
596
576
|
}
|
|
597
577
|
/**
|
|
598
|
-
* <p>The identifier for a resource object that contains resources to scan. Specifying a
|
|
599
|
-
* codeArtifactId is required to create a scan.</p>
|
|
578
|
+
* <p>The identifier for a resource object that contains resources to scan. Specifying a codeArtifactId is required to create a scan.</p>
|
|
600
579
|
* @public
|
|
601
580
|
*/
|
|
602
581
|
export type ResourceId = ResourceId.CodeArtifactIdMember | ResourceId.$UnknownMember;
|
|
@@ -605,8 +584,7 @@ export type ResourceId = ResourceId.CodeArtifactIdMember | ResourceId.$UnknownMe
|
|
|
605
584
|
*/
|
|
606
585
|
export declare namespace ResourceId {
|
|
607
586
|
/**
|
|
608
|
-
* <p>The identifier for the code file uploaded to the resource object. Returned by
|
|
609
|
-
* <code>CreateUploadUrl</code> when you upload resources to be scanned.</p>
|
|
587
|
+
* <p>The identifier for the code file uploaded to the resource object. Returned by <code>CreateUploadUrl</code> when you upload resources to be scanned.</p>
|
|
610
588
|
* @public
|
|
611
589
|
*/
|
|
612
590
|
interface CodeArtifactIdMember {
|
|
@@ -643,8 +621,7 @@ export type ScanType = (typeof ScanType)[keyof typeof ScanType];
|
|
|
643
621
|
*/
|
|
644
622
|
export interface CreateScanRequest {
|
|
645
623
|
/**
|
|
646
|
-
* <p>The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent
|
|
647
|
-
* the accidental creation of duplicate scans if there are failures and retries.</p>
|
|
624
|
+
* <p>The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries.</p>
|
|
648
625
|
* @public
|
|
649
626
|
*/
|
|
650
627
|
clientToken?: string | undefined;
|
|
@@ -654,43 +631,22 @@ export interface CreateScanRequest {
|
|
|
654
631
|
*/
|
|
655
632
|
resourceId: ResourceId | undefined;
|
|
656
633
|
/**
|
|
657
|
-
* <p>The unique name that CodeGuru Security uses to track revisions across multiple scans of
|
|
658
|
-
* the same resource. Only allowed for a <code>STANDARD</code> scan type. </p>
|
|
634
|
+
* <p>The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a <code>STANDARD</code> scan type. </p>
|
|
659
635
|
* @public
|
|
660
636
|
*/
|
|
661
637
|
scanName: string | undefined;
|
|
662
638
|
/**
|
|
663
|
-
* <p>The type of scan, either <code>Standard</code> or <code>Express</code>. Defaults to
|
|
664
|
-
* <code>Standard</code> type if missing.</p>
|
|
665
|
-
* <p>
|
|
666
|
-
* <code>Express</code> scans run on limited resources and use a limited set of detectors to
|
|
667
|
-
* analyze your code in near-real time. <code>Standard</code> scans have standard resource limits
|
|
668
|
-
* and use the full set of detectors to analyze your code.</p>
|
|
639
|
+
* <p>The type of scan, either <code>Standard</code> or <code>Express</code>. Defaults to <code>Standard</code> type if missing.</p> <p> <code>Express</code> scans run on limited resources and use a limited set of detectors to analyze your code in near-real time. <code>Standard</code> scans have standard resource limits and use the full set of detectors to analyze your code.</p>
|
|
669
640
|
* @public
|
|
670
641
|
*/
|
|
671
642
|
scanType?: ScanType | undefined;
|
|
672
643
|
/**
|
|
673
|
-
* <p>The type of analysis you want CodeGuru Security to perform in the scan, either
|
|
674
|
-
* <code>Security</code> or <code>All</code>. The <code>Security</code> type only generates
|
|
675
|
-
* findings related to security. The <code>All</code> type generates both security findings and
|
|
676
|
-
* quality findings. Defaults to <code>Security</code> type if missing.</p>
|
|
644
|
+
* <p>The type of analysis you want CodeGuru Security to perform in the scan, either <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>
|
|
677
645
|
* @public
|
|
678
646
|
*/
|
|
679
647
|
analysisType?: AnalysisType | undefined;
|
|
680
648
|
/**
|
|
681
|
-
* <p>An array of key-value pairs used to tag a scan. A tag is a custom attribute
|
|
682
|
-
* label with two parts:</p>
|
|
683
|
-
* <ul>
|
|
684
|
-
* <li>
|
|
685
|
-
* <p>A tag key. For example, <code>CostCenter</code>, <code>Environment</code>, or
|
|
686
|
-
* <code>Secret</code>. Tag keys are case sensitive.</p>
|
|
687
|
-
* </li>
|
|
688
|
-
* <li>
|
|
689
|
-
* <p>An optional tag value field. For example, <code>111122223333</code>,
|
|
690
|
-
* <code>Production</code>, or a team name. Omitting the tag value is the same as using an
|
|
691
|
-
* empty string. Tag values are case sensitive.</p>
|
|
692
|
-
* </li>
|
|
693
|
-
* </ul>
|
|
649
|
+
* <p>An array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts:</p> <ul> <li> <p>A tag key. For example, <code>CostCenter</code>, <code>Environment</code>, or <code>Secret</code>. Tag keys are case sensitive.</p> </li> <li> <p>An optional tag value field. For example, <code>111122223333</code>, <code>Production</code>, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.</p> </li> </ul>
|
|
694
650
|
* @public
|
|
695
651
|
*/
|
|
696
652
|
tags?: Record<string, string> | undefined;
|
|
@@ -728,8 +684,7 @@ export interface CreateScanResponse {
|
|
|
728
684
|
*/
|
|
729
685
|
resourceId: ResourceId | undefined;
|
|
730
686
|
/**
|
|
731
|
-
* <p>The current state of the scan. Returns either <code>InProgress</code>,
|
|
732
|
-
* <code>Successful</code>, or <code>Failed</code>.</p>
|
|
687
|
+
* <p>The current state of the scan. Returns either <code>InProgress</code>, <code>Successful</code>, or <code>Failed</code>.</p>
|
|
733
688
|
* @public
|
|
734
689
|
*/
|
|
735
690
|
scanState: ScanState | undefined;
|
|
@@ -771,9 +726,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
771
726
|
*/
|
|
772
727
|
export interface CreateUploadUrlRequest {
|
|
773
728
|
/**
|
|
774
|
-
* <p>The name of the scan that will use the uploaded resource. CodeGuru Security uses the
|
|
775
|
-
* unique scan name to track revisions across multiple scans of the same resource. Use this
|
|
776
|
-
* <code>scanName</code> when you call <code>CreateScan</code> on the code resource you upload to this URL.</p>
|
|
729
|
+
* <p>The name of the scan that will use the uploaded resource. CodeGuru Security uses the unique scan name to track revisions across multiple scans of the same resource. Use this <code>scanName</code> when you call <code>CreateScan</code> on the code resource you upload to this URL.</p>
|
|
777
730
|
* @public
|
|
778
731
|
*/
|
|
779
732
|
scanName: string | undefined;
|
|
@@ -783,20 +736,17 @@ export interface CreateUploadUrlRequest {
|
|
|
783
736
|
*/
|
|
784
737
|
export interface CreateUploadUrlResponse {
|
|
785
738
|
/**
|
|
786
|
-
* <p>A pre-signed S3 URL. You can upload the code file you want to scan with the required
|
|
787
|
-
* <code>requestHeaders</code> using any HTTP client.</p>
|
|
739
|
+
* <p>A pre-signed S3 URL. You can upload the code file you want to scan with the required <code>requestHeaders</code> using any HTTP client.</p>
|
|
788
740
|
* @public
|
|
789
741
|
*/
|
|
790
742
|
s3Url: string | undefined;
|
|
791
743
|
/**
|
|
792
|
-
* <p>A set of key-value pairs that contain the required headers when uploading your
|
|
793
|
-
* resource.</p>
|
|
744
|
+
* <p>A set of key-value pairs that contain the required headers when uploading your resource.</p>
|
|
794
745
|
* @public
|
|
795
746
|
*/
|
|
796
747
|
requestHeaders: Record<string, string> | undefined;
|
|
797
748
|
/**
|
|
798
|
-
* <p>The identifier for the uploaded code resource. Pass this to <code>CreateScan</code> to use
|
|
799
|
-
* the uploaded resources.</p>
|
|
749
|
+
* <p>The identifier for the uploaded code resource. Pass this to <code>CreateScan</code> to use the uploaded resources.</p>
|
|
800
750
|
* @public
|
|
801
751
|
*/
|
|
802
752
|
codeArtifactId: string | undefined;
|
|
@@ -807,14 +757,12 @@ export interface CreateUploadUrlResponse {
|
|
|
807
757
|
export interface GetAccountConfigurationRequest {
|
|
808
758
|
}
|
|
809
759
|
/**
|
|
810
|
-
* <p>Information about the encryption configuration for an account. Required to call
|
|
811
|
-
* <code>UpdateAccountConfiguration</code>.</p>
|
|
760
|
+
* <p>Information about the encryption configuration for an account. Required to call <code>UpdateAccountConfiguration</code>.</p>
|
|
812
761
|
* @public
|
|
813
762
|
*/
|
|
814
763
|
export interface EncryptionConfig {
|
|
815
764
|
/**
|
|
816
|
-
* <p>The KMS key ARN that is used for encryption. If an AWS-managed key is used for encryption,
|
|
817
|
-
* returns empty.</p>
|
|
765
|
+
* <p>The KMS key ARN that is used for encryption. If an AWS-managed key is used for encryption, returns empty.</p>
|
|
818
766
|
* @public
|
|
819
767
|
*/
|
|
820
768
|
kmsKeyArn?: string | undefined;
|
|
@@ -824,10 +772,7 @@ export interface EncryptionConfig {
|
|
|
824
772
|
*/
|
|
825
773
|
export interface GetAccountConfigurationResponse {
|
|
826
774
|
/**
|
|
827
|
-
* <p>An <code>EncryptionConfig</code> object that contains the KMS key ARN that is used for
|
|
828
|
-
* encryption. By default, CodeGuru Security uses an AWS-managed key for encryption. To specify
|
|
829
|
-
* your own key, call <code>UpdateAccountConfiguration</code>. If you do not specify a
|
|
830
|
-
* customer-managed key, returns empty.</p>
|
|
775
|
+
* <p>An <code>EncryptionConfig</code> object that contains the KMS key ARN that is used for encryption. By default, CodeGuru Security uses an AWS-managed key for encryption. To specify your own key, call <code>UpdateAccountConfiguration</code>. If you do not specify a customer-managed key, returns empty.</p>
|
|
831
776
|
* @public
|
|
832
777
|
*/
|
|
833
778
|
encryptionConfig: EncryptionConfig | undefined;
|
|
@@ -842,23 +787,17 @@ export interface GetFindingsRequest {
|
|
|
842
787
|
*/
|
|
843
788
|
scanName: string | undefined;
|
|
844
789
|
/**
|
|
845
|
-
* <p>A token to use for paginating results that are returned in the response. Set the value of
|
|
846
|
-
* this parameter to null for the first request. For subsequent calls, use the <code>nextToken</code> value
|
|
847
|
-
* returned from the previous request to continue listing results after the first page.</p>
|
|
790
|
+
* <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the <code>nextToken</code> value returned from the previous request to continue listing results after the first page.</p>
|
|
848
791
|
* @public
|
|
849
792
|
*/
|
|
850
793
|
nextToken?: string | undefined;
|
|
851
794
|
/**
|
|
852
|
-
* <p>The maximum number of results to return in the response. Use this parameter when
|
|
853
|
-
* paginating results. If additional results exist beyond the number you specify, the <code>nextToken</code>
|
|
854
|
-
* element is returned in the response. Use <code>nextToken</code> in a subsequent request to retrieve
|
|
855
|
-
* additional results. If not specified, returns 1000 results.</p>
|
|
795
|
+
* <p>The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the <code>nextToken</code> element is returned in the response. Use <code>nextToken</code> in a subsequent request to retrieve additional results. If not specified, returns 1000 results.</p>
|
|
856
796
|
* @public
|
|
857
797
|
*/
|
|
858
798
|
maxResults?: number | undefined;
|
|
859
799
|
/**
|
|
860
|
-
* <p>The status of the findings you want to get. Pass either <code>Open</code>,
|
|
861
|
-
* <code>Closed</code>, or <code>All</code>.</p>
|
|
800
|
+
* <p>The status of the findings you want to get. Pass either <code>Open</code>, <code>Closed</code>, or <code>All</code>.</p>
|
|
862
801
|
* @public
|
|
863
802
|
*/
|
|
864
803
|
status?: Status | undefined;
|
|
@@ -873,8 +812,7 @@ export interface GetFindingsResponse {
|
|
|
873
812
|
*/
|
|
874
813
|
findings?: Finding[] | undefined;
|
|
875
814
|
/**
|
|
876
|
-
* <p>A pagination token. You can use this in future calls to <code>GetFindings</code> to continue listing
|
|
877
|
-
* results after the current page. </p>
|
|
815
|
+
* <p>A pagination token. You can use this in future calls to <code>GetFindings</code> to continue listing results after the current page. </p>
|
|
878
816
|
* @public
|
|
879
817
|
*/
|
|
880
818
|
nextToken?: string | undefined;
|
|
@@ -884,8 +822,7 @@ export interface GetFindingsResponse {
|
|
|
884
822
|
*/
|
|
885
823
|
export interface GetMetricsSummaryRequest {
|
|
886
824
|
/**
|
|
887
|
-
* <p>The date you want to retrieve summary metrics from, rounded to the nearest day. The date
|
|
888
|
-
* must be within the past two years.</p>
|
|
825
|
+
* <p>The date you want to retrieve summary metrics from, rounded to the nearest day. The date must be within the past two years.</p>
|
|
889
826
|
* @public
|
|
890
827
|
*/
|
|
891
828
|
date: Date | undefined;
|
|
@@ -896,8 +833,7 @@ export interface GetMetricsSummaryRequest {
|
|
|
896
833
|
*/
|
|
897
834
|
export interface CategoryWithFindingNum {
|
|
898
835
|
/**
|
|
899
|
-
* <p>The name of the finding category. A finding category is determined by the detector that
|
|
900
|
-
* detected the finding.</p>
|
|
836
|
+
* <p>The name of the finding category. A finding category is determined by the detector that detected the finding.</p>
|
|
901
837
|
* @public
|
|
902
838
|
*/
|
|
903
839
|
categoryName?: string | undefined;
|
|
@@ -939,20 +875,17 @@ export interface MetricsSummary {
|
|
|
939
875
|
*/
|
|
940
876
|
openFindings?: FindingMetricsValuePerSeverity | undefined;
|
|
941
877
|
/**
|
|
942
|
-
* <p>A list of <code>CategoryWithFindingNum</code> objects for the top 5 finding categories
|
|
943
|
-
* with the most findings.</p>
|
|
878
|
+
* <p>A list of <code>CategoryWithFindingNum</code> objects for the top 5 finding categories with the most findings.</p>
|
|
944
879
|
* @public
|
|
945
880
|
*/
|
|
946
881
|
categoriesWithMostFindings?: CategoryWithFindingNum[] | undefined;
|
|
947
882
|
/**
|
|
948
|
-
* <p>A list of <code>ScanNameWithFindingNum</code> objects for the top 3 scans with the most
|
|
949
|
-
* number of open findings.</p>
|
|
883
|
+
* <p>A list of <code>ScanNameWithFindingNum</code> objects for the top 3 scans with the most number of open findings.</p>
|
|
950
884
|
* @public
|
|
951
885
|
*/
|
|
952
886
|
scansWithMostOpenFindings?: ScanNameWithFindingNum[] | undefined;
|
|
953
887
|
/**
|
|
954
|
-
* <p>A list of <code>ScanNameWithFindingNum</code> objects for the top 3 scans with the most
|
|
955
|
-
* number of open critical findings.</p>
|
|
888
|
+
* <p>A list of <code>ScanNameWithFindingNum</code> objects for the top 3 scans with the most number of open critical findings.</p>
|
|
956
889
|
* @public
|
|
957
890
|
*/
|
|
958
891
|
scansWithMostOpenCriticalFindings?: ScanNameWithFindingNum[] | undefined;
|
|
@@ -977,8 +910,7 @@ export interface GetScanRequest {
|
|
|
977
910
|
*/
|
|
978
911
|
scanName: string | undefined;
|
|
979
912
|
/**
|
|
980
|
-
* <p>UUID that identifies the individual scan run you want to view details about. You retrieve
|
|
981
|
-
* this when you call the <code>CreateScan</code> operation. Defaults to the latest scan run if missing.</p>
|
|
913
|
+
* <p>UUID that identifies the individual scan run you want to view details about. You retrieve this when you call the <code>CreateScan</code> operation. Defaults to the latest scan run if missing.</p>
|
|
982
914
|
* @public
|
|
983
915
|
*/
|
|
984
916
|
runId?: string | undefined;
|
|
@@ -998,8 +930,7 @@ export interface GetScanResponse {
|
|
|
998
930
|
*/
|
|
999
931
|
runId: string | undefined;
|
|
1000
932
|
/**
|
|
1001
|
-
* <p>The current state of the scan. Returns either <code>InProgress</code>,
|
|
1002
|
-
* <code>Successful</code>, or <code>Failed</code>.</p>
|
|
933
|
+
* <p>The current state of the scan. Returns either <code>InProgress</code>, <code>Successful</code>, or <code>Failed</code>.</p>
|
|
1003
934
|
* @public
|
|
1004
935
|
*/
|
|
1005
936
|
scanState: ScanState | undefined;
|
|
@@ -1009,10 +940,7 @@ export interface GetScanResponse {
|
|
|
1009
940
|
*/
|
|
1010
941
|
createdAt: Date | undefined;
|
|
1011
942
|
/**
|
|
1012
|
-
* <p>The type of analysis CodeGuru Security performed in the scan, either
|
|
1013
|
-
* <code>Security</code> or <code>All</code>. The <code>Security</code> type only generates
|
|
1014
|
-
* findings related to security. The <code>All</code> type generates both security findings and
|
|
1015
|
-
* quality findings.</p>
|
|
943
|
+
* <p>The type of analysis CodeGuru Security performed in the scan, either <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.</p>
|
|
1016
944
|
* @public
|
|
1017
945
|
*/
|
|
1018
946
|
analysisType: AnalysisType | undefined;
|
|
@@ -1042,30 +970,22 @@ export interface GetScanResponse {
|
|
|
1042
970
|
*/
|
|
1043
971
|
export interface ListFindingsMetricsRequest {
|
|
1044
972
|
/**
|
|
1045
|
-
* <p>A token to use for paginating results that are returned in the response. Set the
|
|
1046
|
-
* value of this parameter to null for the first request. For subsequent calls, use the <code>nextToken</code>
|
|
1047
|
-
* value returned from the previous request to continue listing results after the first
|
|
1048
|
-
* page.</p>
|
|
973
|
+
* <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the <code>nextToken</code> value returned from the previous request to continue listing results after the first page.</p>
|
|
1049
974
|
* @public
|
|
1050
975
|
*/
|
|
1051
976
|
nextToken?: string | undefined;
|
|
1052
977
|
/**
|
|
1053
|
-
* <p>The maximum number of results to return in the response. Use this parameter when
|
|
1054
|
-
* paginating results. If additional results exist beyond the number you specify, the <code>nextToken</code>
|
|
1055
|
-
* element is returned in the response. Use <code>nextToken</code> in a subsequent request to retrieve
|
|
1056
|
-
* additional results. If not specified, returns 1000 results.</p>
|
|
978
|
+
* <p>The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the <code>nextToken</code> element is returned in the response. Use <code>nextToken</code> in a subsequent request to retrieve additional results. If not specified, returns 1000 results.</p>
|
|
1057
979
|
* @public
|
|
1058
980
|
*/
|
|
1059
981
|
maxResults?: number | undefined;
|
|
1060
982
|
/**
|
|
1061
|
-
* <p>The start date of the interval which you want to retrieve metrics from. Rounds to the
|
|
1062
|
-
* nearest day.</p>
|
|
983
|
+
* <p>The start date of the interval which you want to retrieve metrics from. Rounds to the nearest day.</p>
|
|
1063
984
|
* @public
|
|
1064
985
|
*/
|
|
1065
986
|
startDate: Date | undefined;
|
|
1066
987
|
/**
|
|
1067
|
-
* <p>The end date of the interval which you want to retrieve metrics from. Round to the nearest
|
|
1068
|
-
* day.</p>
|
|
988
|
+
* <p>The end date of the interval which you want to retrieve metrics from. Round to the nearest day.</p>
|
|
1069
989
|
* @public
|
|
1070
990
|
*/
|
|
1071
991
|
endDate: Date | undefined;
|
|
@@ -1080,8 +1000,7 @@ export interface ListFindingsMetricsResponse {
|
|
|
1080
1000
|
*/
|
|
1081
1001
|
findingsMetrics?: AccountFindingsMetric[] | undefined;
|
|
1082
1002
|
/**
|
|
1083
|
-
* <p>A pagination token. You can use this in future calls to <code>ListFindingMetrics</code> to continue
|
|
1084
|
-
* listing results after the current page. </p>
|
|
1003
|
+
* <p>A pagination token. You can use this in future calls to <code>ListFindingMetrics</code> to continue listing results after the current page. </p>
|
|
1085
1004
|
* @public
|
|
1086
1005
|
*/
|
|
1087
1006
|
nextToken?: string | undefined;
|
|
@@ -1091,17 +1010,12 @@ export interface ListFindingsMetricsResponse {
|
|
|
1091
1010
|
*/
|
|
1092
1011
|
export interface ListScansRequest {
|
|
1093
1012
|
/**
|
|
1094
|
-
* <p>A token to use for paginating results that are returned in the response. Set the value of
|
|
1095
|
-
* this parameter to null for the first request. For subsequent calls, use the <code>nextToken</code> value
|
|
1096
|
-
* returned from the previous request to continue listing results after the first page.</p>
|
|
1013
|
+
* <p>A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the <code>nextToken</code> value returned from the previous request to continue listing results after the first page.</p>
|
|
1097
1014
|
* @public
|
|
1098
1015
|
*/
|
|
1099
1016
|
nextToken?: string | undefined;
|
|
1100
1017
|
/**
|
|
1101
|
-
* <p>The maximum number of results to return in the response. Use this parameter when
|
|
1102
|
-
* paginating results. If additional results exist beyond the number you specify, the <code>nextToken</code>
|
|
1103
|
-
* element is returned in the response. Use <code>nextToken</code> in a subsequent request to retrieve
|
|
1104
|
-
* additional results. If not specified, returns 100 results.</p>
|
|
1018
|
+
* <p>The maximum number of results to return in the response. Use this parameter when paginating results. If additional results exist beyond the number you specify, the <code>nextToken</code> element is returned in the response. Use <code>nextToken</code> in a subsequent request to retrieve additional results. If not specified, returns 100 results.</p>
|
|
1105
1019
|
* @public
|
|
1106
1020
|
*/
|
|
1107
1021
|
maxResults?: number | undefined;
|
|
@@ -1112,8 +1026,7 @@ export interface ListScansRequest {
|
|
|
1112
1026
|
*/
|
|
1113
1027
|
export interface ScanSummary {
|
|
1114
1028
|
/**
|
|
1115
|
-
* <p>The state of the scan. A scan can be <code>In Progress</code>,
|
|
1116
|
-
* <code>Complete</code>, or <code>Failed</code>. </p>
|
|
1029
|
+
* <p>The state of the scan. A scan can be <code>In Progress</code>, <code>Complete</code>, or <code>Failed</code>. </p>
|
|
1117
1030
|
* @public
|
|
1118
1031
|
*/
|
|
1119
1032
|
scanState: ScanState | undefined;
|
|
@@ -1153,8 +1066,7 @@ export interface ListScansResponse {
|
|
|
1153
1066
|
*/
|
|
1154
1067
|
summaries?: ScanSummary[] | undefined;
|
|
1155
1068
|
/**
|
|
1156
|
-
* <p>A pagination token. You can use this in future calls to <code>ListScans</code> to continue listing
|
|
1157
|
-
* results after the current page.</p>
|
|
1069
|
+
* <p>A pagination token. You can use this in future calls to <code>ListScans</code> to continue listing results after the current page.</p>
|
|
1158
1070
|
* @public
|
|
1159
1071
|
*/
|
|
1160
1072
|
nextToken?: string | undefined;
|
|
@@ -1164,8 +1076,7 @@ export interface ListScansResponse {
|
|
|
1164
1076
|
*/
|
|
1165
1077
|
export interface ListTagsForResourceRequest {
|
|
1166
1078
|
/**
|
|
1167
|
-
* <p>The ARN of the <code>ScanName</code> object. You can retrieve this ARN by calling
|
|
1168
|
-
* <code>CreateScan</code>, <code>ListScans</code>, or <code>GetScan</code>.</p>
|
|
1079
|
+
* <p>The ARN of the <code>ScanName</code> object. You can retrieve this ARN by calling <code>CreateScan</code>, <code>ListScans</code>, or <code>GetScan</code>.</p>
|
|
1169
1080
|
* @public
|
|
1170
1081
|
*/
|
|
1171
1082
|
resourceArn: string | undefined;
|
|
@@ -1175,19 +1086,7 @@ export interface ListTagsForResourceRequest {
|
|
|
1175
1086
|
*/
|
|
1176
1087
|
export interface ListTagsForResourceResponse {
|
|
1177
1088
|
/**
|
|
1178
|
-
* <p>An array of key-value pairs used to tag an existing scan. A tag is a custom attribute
|
|
1179
|
-
* label with two parts:</p>
|
|
1180
|
-
* <ul>
|
|
1181
|
-
* <li>
|
|
1182
|
-
* <p>A tag key. For example, <code>CostCenter</code>, <code>Environment</code>, or
|
|
1183
|
-
* <code>Secret</code>. Tag keys are case sensitive.</p>
|
|
1184
|
-
* </li>
|
|
1185
|
-
* <li>
|
|
1186
|
-
* <p>An optional tag value field. For example, <code>111122223333</code>,
|
|
1187
|
-
* <code>Production</code>, or a team name. Omitting the tag value is the same as using an
|
|
1188
|
-
* empty string. Tag values are case sensitive.</p>
|
|
1189
|
-
* </li>
|
|
1190
|
-
* </ul>
|
|
1089
|
+
* <p>An array of key-value pairs used to tag an existing scan. A tag is a custom attribute label with two parts:</p> <ul> <li> <p>A tag key. For example, <code>CostCenter</code>, <code>Environment</code>, or <code>Secret</code>. Tag keys are case sensitive.</p> </li> <li> <p>An optional tag value field. For example, <code>111122223333</code>, <code>Production</code>, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.</p> </li> </ul>
|
|
1191
1090
|
* @public
|
|
1192
1091
|
*/
|
|
1193
1092
|
tags?: Record<string, string> | undefined;
|
|
@@ -1197,25 +1096,12 @@ export interface ListTagsForResourceResponse {
|
|
|
1197
1096
|
*/
|
|
1198
1097
|
export interface TagResourceRequest {
|
|
1199
1098
|
/**
|
|
1200
|
-
* <p>The ARN of the <code>ScanName</code> object. You can retrieve this ARN by calling
|
|
1201
|
-
* <code>CreateScan</code>, <code>ListScans</code>, or <code>GetScan</code>.</p>
|
|
1099
|
+
* <p>The ARN of the <code>ScanName</code> object. You can retrieve this ARN by calling <code>CreateScan</code>, <code>ListScans</code>, or <code>GetScan</code>.</p>
|
|
1202
1100
|
* @public
|
|
1203
1101
|
*/
|
|
1204
1102
|
resourceArn: string | undefined;
|
|
1205
1103
|
/**
|
|
1206
|
-
* <p>An array of key-value pairs used to tag an existing scan. A tag is a custom attribute
|
|
1207
|
-
* label with two parts:</p>
|
|
1208
|
-
* <ul>
|
|
1209
|
-
* <li>
|
|
1210
|
-
* <p>A tag key. For example, <code>CostCenter</code>, <code>Environment</code>, or
|
|
1211
|
-
* <code>Secret</code>. Tag keys are case sensitive.</p>
|
|
1212
|
-
* </li>
|
|
1213
|
-
* <li>
|
|
1214
|
-
* <p>An optional tag value field. For example, <code>111122223333</code>,
|
|
1215
|
-
* <code>Production</code>, or a team name. Omitting the tag value is the same as using an
|
|
1216
|
-
* empty string. Tag values are case sensitive.</p>
|
|
1217
|
-
* </li>
|
|
1218
|
-
* </ul>
|
|
1104
|
+
* <p>An array of key-value pairs used to tag an existing scan. A tag is a custom attribute label with two parts:</p> <ul> <li> <p>A tag key. For example, <code>CostCenter</code>, <code>Environment</code>, or <code>Secret</code>. Tag keys are case sensitive.</p> </li> <li> <p>An optional tag value field. For example, <code>111122223333</code>, <code>Production</code>, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.</p> </li> </ul>
|
|
1219
1105
|
* @public
|
|
1220
1106
|
*/
|
|
1221
1107
|
tags: Record<string, string> | undefined;
|
|
@@ -1230,8 +1116,7 @@ export interface TagResourceResponse {
|
|
|
1230
1116
|
*/
|
|
1231
1117
|
export interface UntagResourceRequest {
|
|
1232
1118
|
/**
|
|
1233
|
-
* <p>The ARN of the <code>ScanName</code> object. You can retrieve this ARN by calling
|
|
1234
|
-
* <code>CreateScan</code>, <code>ListScans</code>, or <code>GetScan</code>.</p>
|
|
1119
|
+
* <p>The ARN of the <code>ScanName</code> object. You can retrieve this ARN by calling <code>CreateScan</code>, <code>ListScans</code>, or <code>GetScan</code>.</p>
|
|
1235
1120
|
* @public
|
|
1236
1121
|
*/
|
|
1237
1122
|
resourceArn: string | undefined;
|
|
@@ -1251,10 +1136,7 @@ export interface UntagResourceResponse {
|
|
|
1251
1136
|
*/
|
|
1252
1137
|
export interface UpdateAccountConfigurationRequest {
|
|
1253
1138
|
/**
|
|
1254
|
-
* <p>The customer-managed KMS key ARN you want to use for encryption. If not specified,
|
|
1255
|
-
* CodeGuru Security will use an AWS-managed key for encryption. If you previously specified a
|
|
1256
|
-
* customer-managed KMS key and want CodeGuru Security to use an AWS-managed key for encryption
|
|
1257
|
-
* instead, pass nothing.</p>
|
|
1139
|
+
* <p>The customer-managed KMS key ARN you want to use for encryption. If not specified, CodeGuru Security will use an AWS-managed key for encryption. If you previously specified a customer-managed KMS key and want CodeGuru Security to use an AWS-managed key for encryption instead, pass nothing.</p>
|
|
1258
1140
|
* @public
|
|
1259
1141
|
*/
|
|
1260
1142
|
encryptionConfig: EncryptionConfig | undefined;
|
|
@@ -1264,9 +1146,7 @@ export interface UpdateAccountConfigurationRequest {
|
|
|
1264
1146
|
*/
|
|
1265
1147
|
export interface UpdateAccountConfigurationResponse {
|
|
1266
1148
|
/**
|
|
1267
|
-
* <p>An <code>EncryptionConfig</code> object that contains the KMS key ARN that is used for
|
|
1268
|
-
* encryption. If you did not specify a customer-managed KMS key in the request, returns empty.
|
|
1269
|
-
* </p>
|
|
1149
|
+
* <p>An <code>EncryptionConfig</code> object that contains the KMS key ARN that is used for encryption. If you did not specify a customer-managed KMS key in the request, returns empty. </p>
|
|
1270
1150
|
* @public
|
|
1271
1151
|
*/
|
|
1272
1152
|
encryptionConfig: EncryptionConfig | undefined;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-codeguru-security",
|
|
3
3
|
"description": "AWS SDK for JavaScript Codeguru Security Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.876.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-codeguru-security",
|
|
@@ -20,17 +20,17 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "5.2.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "5.2.0",
|
|
23
|
-
"@aws-sdk/core": "3.
|
|
24
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
23
|
+
"@aws-sdk/core": "3.876.0",
|
|
24
|
+
"@aws-sdk/credential-provider-node": "3.876.0",
|
|
25
25
|
"@aws-sdk/middleware-host-header": "3.873.0",
|
|
26
|
-
"@aws-sdk/middleware-logger": "3.
|
|
26
|
+
"@aws-sdk/middleware-logger": "3.876.0",
|
|
27
27
|
"@aws-sdk/middleware-recursion-detection": "3.873.0",
|
|
28
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
28
|
+
"@aws-sdk/middleware-user-agent": "3.876.0",
|
|
29
29
|
"@aws-sdk/region-config-resolver": "3.873.0",
|
|
30
30
|
"@aws-sdk/types": "3.862.0",
|
|
31
31
|
"@aws-sdk/util-endpoints": "3.873.0",
|
|
32
32
|
"@aws-sdk/util-user-agent-browser": "3.873.0",
|
|
33
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
33
|
+
"@aws-sdk/util-user-agent-node": "3.876.0",
|
|
34
34
|
"@smithy/config-resolver": "^4.1.5",
|
|
35
35
|
"@smithy/core": "^3.8.0",
|
|
36
36
|
"@smithy/fetch-http-handler": "^5.1.1",
|