@aws-sdk/client-codeguru-security 3.533.0 → 3.540.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/dist-cjs/endpoint/endpointResolver.js +4 -2
- package/dist-cjs/index.js +0 -3
- package/dist-es/endpoint/endpointResolver.js +3 -1
- package/dist-es/index.js +0 -1
- package/dist-types/CodeGuruSecurity.d.ts +3 -1
- package/dist-types/CodeGuruSecurityClient.d.ts +1 -1
- package/dist-types/commands/BatchGetFindingsCommand.d.ts +2 -1
- package/dist-types/commands/CreateScanCommand.d.ts +2 -1
- package/dist-types/commands/CreateUploadUrlCommand.d.ts +2 -1
- package/dist-types/commands/GetAccountConfigurationCommand.d.ts +2 -1
- package/dist-types/commands/GetFindingsCommand.d.ts +2 -1
- package/dist-types/commands/GetMetricsSummaryCommand.d.ts +2 -1
- package/dist-types/commands/GetScanCommand.d.ts +2 -1
- package/dist-types/commands/ListFindingsMetricsCommand.d.ts +2 -1
- package/dist-types/commands/ListScansCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateAccountConfigurationCommand.d.ts +2 -1
- package/dist-types/index.d.ts +0 -1
- package/dist-types/models/models_0.d.ts +167 -167
- package/dist-types/ts3.4/CodeGuruSecurity.d.ts +2 -0
- package/dist-types/ts3.4/commands/BatchGetFindingsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateScanCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateUploadUrlCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetAccountConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetFindingsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetMetricsSummaryCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetScanCommand.d.ts +7 -0
- package/dist-types/ts3.4/commands/ListFindingsMetricsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListScansCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateAccountConfigurationCommand.d.ts +9 -0
- package/dist-types/ts3.4/index.d.ts +0 -1
- package/package.json +40 -40
|
@@ -1,25 +1,25 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { CodeGuruSecurityServiceException as __BaseException } from "./CodeGuruSecurityServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
5
|
+
* @public
|
|
6
6
|
*/
|
|
7
7
|
export declare class AccessDeniedException extends __BaseException {
|
|
8
8
|
readonly name: "AccessDeniedException";
|
|
9
9
|
readonly $fault: "client";
|
|
10
10
|
/**
|
|
11
|
-
* @public
|
|
12
11
|
* <p>The identifier for the error.</p>
|
|
12
|
+
* @public
|
|
13
13
|
*/
|
|
14
14
|
errorCode: string | undefined;
|
|
15
15
|
/**
|
|
16
|
-
* @public
|
|
17
16
|
* <p>The identifier for the resource you don't have access to.</p>
|
|
17
|
+
* @public
|
|
18
18
|
*/
|
|
19
19
|
resourceId?: string;
|
|
20
20
|
/**
|
|
21
|
-
* @public
|
|
22
21
|
* <p>The type of resource you don't have access to.</p>
|
|
22
|
+
* @public
|
|
23
23
|
*/
|
|
24
24
|
resourceType?: string;
|
|
25
25
|
/**
|
|
@@ -28,65 +28,65 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
28
28
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
29
29
|
}
|
|
30
30
|
/**
|
|
31
|
-
* @public
|
|
32
31
|
* <p>The severity of the issue in the code that generated a finding.</p>
|
|
32
|
+
* @public
|
|
33
33
|
*/
|
|
34
34
|
export interface FindingMetricsValuePerSeverity {
|
|
35
35
|
/**
|
|
36
|
-
* @public
|
|
37
36
|
* <p>The finding is related to quality or readability improvements and not considered
|
|
38
37
|
* actionable.</p>
|
|
38
|
+
* @public
|
|
39
39
|
*/
|
|
40
40
|
info?: number;
|
|
41
41
|
/**
|
|
42
|
-
* @public
|
|
43
42
|
* <p>The severity of the finding is low and does require action on its own.</p>
|
|
43
|
+
* @public
|
|
44
44
|
*/
|
|
45
45
|
low?: number;
|
|
46
46
|
/**
|
|
47
|
-
* @public
|
|
48
47
|
* <p>The severity of the finding is medium and should be addressed as a mid-term priority.</p>
|
|
48
|
+
* @public
|
|
49
49
|
*/
|
|
50
50
|
medium?: number;
|
|
51
51
|
/**
|
|
52
|
-
* @public
|
|
53
52
|
* <p>The severity of the finding is high and should be addressed as a near-term priority.</p>
|
|
53
|
+
* @public
|
|
54
54
|
*/
|
|
55
55
|
high?: number;
|
|
56
56
|
/**
|
|
57
|
-
* @public
|
|
58
57
|
* <p>The severity of the finding is critical and should be addressed immediately.</p>
|
|
58
|
+
* @public
|
|
59
59
|
*/
|
|
60
60
|
critical?: number;
|
|
61
61
|
}
|
|
62
62
|
/**
|
|
63
|
-
* @public
|
|
64
63
|
* <p>A summary of findings metrics in an account.</p>
|
|
64
|
+
* @public
|
|
65
65
|
*/
|
|
66
66
|
export interface AccountFindingsMetric {
|
|
67
67
|
/**
|
|
68
|
-
* @public
|
|
69
68
|
* <p>The date from which the finding metrics were retrieved.</p>
|
|
69
|
+
* @public
|
|
70
70
|
*/
|
|
71
71
|
date?: Date;
|
|
72
72
|
/**
|
|
73
|
-
* @public
|
|
74
73
|
* <p>The number of new findings of each severity in account on the specified date.</p>
|
|
74
|
+
* @public
|
|
75
75
|
*/
|
|
76
76
|
newFindings?: FindingMetricsValuePerSeverity;
|
|
77
77
|
/**
|
|
78
|
-
* @public
|
|
79
78
|
* <p>The number of closed findings of each severity in an account on the specified date.</p>
|
|
79
|
+
* @public
|
|
80
80
|
*/
|
|
81
81
|
closedFindings?: FindingMetricsValuePerSeverity;
|
|
82
82
|
/**
|
|
83
|
-
* @public
|
|
84
83
|
* <p>The number of open findings of each severity in an account as of the specified date.</p>
|
|
84
|
+
* @public
|
|
85
85
|
*/
|
|
86
86
|
openFindings?: FindingMetricsValuePerSeverity;
|
|
87
87
|
/**
|
|
88
|
-
* @public
|
|
89
88
|
* <p>The average time it takes to close findings of each severity in days.</p>
|
|
89
|
+
* @public
|
|
90
90
|
*/
|
|
91
91
|
meanTimeToClose?: FindingMetricsValuePerSeverity;
|
|
92
92
|
}
|
|
@@ -103,18 +103,18 @@ export declare const AnalysisType: {
|
|
|
103
103
|
*/
|
|
104
104
|
export type AnalysisType = (typeof AnalysisType)[keyof typeof AnalysisType];
|
|
105
105
|
/**
|
|
106
|
-
* @public
|
|
107
106
|
* <p>An object that contains information about a finding and the scan that generated it. </p>
|
|
107
|
+
* @public
|
|
108
108
|
*/
|
|
109
109
|
export interface FindingIdentifier {
|
|
110
110
|
/**
|
|
111
|
-
* @public
|
|
112
111
|
* <p>The name of the scan that generated the finding. </p>
|
|
112
|
+
* @public
|
|
113
113
|
*/
|
|
114
114
|
scanName: string | undefined;
|
|
115
115
|
/**
|
|
116
|
-
* @public
|
|
117
116
|
* <p>The identifier for a finding.</p>
|
|
117
|
+
* @public
|
|
118
118
|
*/
|
|
119
119
|
findingId: string | undefined;
|
|
120
120
|
}
|
|
@@ -123,10 +123,10 @@ export interface FindingIdentifier {
|
|
|
123
123
|
*/
|
|
124
124
|
export interface BatchGetFindingsRequest {
|
|
125
125
|
/**
|
|
126
|
-
* @public
|
|
127
126
|
* <p>A list of finding identifiers. Each identifier consists of a <code>scanName</code> and a
|
|
128
127
|
* <code>findingId</code>. You retrieve the <code>findingId</code> when you call
|
|
129
128
|
* <code>GetFindings</code>.</p>
|
|
129
|
+
* @public
|
|
130
130
|
*/
|
|
131
131
|
findingIdentifiers: FindingIdentifier[] | undefined;
|
|
132
132
|
}
|
|
@@ -146,94 +146,94 @@ export declare const ErrorCode: {
|
|
|
146
146
|
*/
|
|
147
147
|
export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
|
|
148
148
|
/**
|
|
149
|
-
* @public
|
|
150
149
|
* <p>Contains information about the error that caused a finding to fail to be retrieved.</p>
|
|
150
|
+
* @public
|
|
151
151
|
*/
|
|
152
152
|
export interface BatchGetFindingsError {
|
|
153
153
|
/**
|
|
154
|
-
* @public
|
|
155
154
|
* <p>The name of the scan that generated the finding.</p>
|
|
155
|
+
* @public
|
|
156
156
|
*/
|
|
157
157
|
scanName: string | undefined;
|
|
158
158
|
/**
|
|
159
|
-
* @public
|
|
160
159
|
* <p>The finding ID of the finding that was not fetched.</p>
|
|
160
|
+
* @public
|
|
161
161
|
*/
|
|
162
162
|
findingId: string | undefined;
|
|
163
163
|
/**
|
|
164
|
-
* @public
|
|
165
164
|
* <p>A code associated with the type of error.</p>
|
|
165
|
+
* @public
|
|
166
166
|
*/
|
|
167
167
|
errorCode: ErrorCode | undefined;
|
|
168
168
|
/**
|
|
169
|
-
* @public
|
|
170
169
|
* <p>Describes the error.</p>
|
|
170
|
+
* @public
|
|
171
171
|
*/
|
|
172
172
|
message: string | undefined;
|
|
173
173
|
}
|
|
174
174
|
/**
|
|
175
|
-
* @public
|
|
176
175
|
* <p>Information about the recommended course of action to remediate a finding.</p>
|
|
176
|
+
* @public
|
|
177
177
|
*/
|
|
178
178
|
export interface Recommendation {
|
|
179
179
|
/**
|
|
180
|
-
* @public
|
|
181
180
|
* <p>The recommended course of action to remediate the finding.</p>
|
|
181
|
+
* @public
|
|
182
182
|
*/
|
|
183
183
|
text?: string;
|
|
184
184
|
/**
|
|
185
|
-
* @public
|
|
186
185
|
* <p>The URL address to the recommendation for remediating the finding. </p>
|
|
186
|
+
* @public
|
|
187
187
|
*/
|
|
188
188
|
url?: string;
|
|
189
189
|
}
|
|
190
190
|
/**
|
|
191
|
-
* @public
|
|
192
191
|
* <p>Information about the suggested code fix to remediate a finding.</p>
|
|
192
|
+
* @public
|
|
193
193
|
*/
|
|
194
194
|
export interface SuggestedFix {
|
|
195
195
|
/**
|
|
196
|
-
* @public
|
|
197
196
|
* <p>A description of the suggested code fix and why it is being suggested. </p>
|
|
197
|
+
* @public
|
|
198
198
|
*/
|
|
199
199
|
description?: string;
|
|
200
200
|
/**
|
|
201
|
-
* @public
|
|
202
201
|
* <p>The suggested code to add to your file. </p>
|
|
202
|
+
* @public
|
|
203
203
|
*/
|
|
204
204
|
code?: string;
|
|
205
205
|
}
|
|
206
206
|
/**
|
|
207
|
-
* @public
|
|
208
207
|
* <p>Information about how to remediate a finding.</p>
|
|
208
|
+
* @public
|
|
209
209
|
*/
|
|
210
210
|
export interface Remediation {
|
|
211
211
|
/**
|
|
212
|
-
* @public
|
|
213
212
|
* <p>An object that contains information about the recommended course of action to remediate a finding.</p>
|
|
213
|
+
* @public
|
|
214
214
|
*/
|
|
215
215
|
recommendation?: Recommendation;
|
|
216
216
|
/**
|
|
217
|
-
* @public
|
|
218
217
|
* <p>A list of <code>SuggestedFix</code> objects. Each object contains information about a suggested code
|
|
219
218
|
* fix to remediate the finding.</p>
|
|
219
|
+
* @public
|
|
220
220
|
*/
|
|
221
221
|
suggestedFixes?: SuggestedFix[];
|
|
222
222
|
}
|
|
223
223
|
/**
|
|
224
|
-
* @public
|
|
225
224
|
* <p>Information about a resource, such as an Amazon S3 bucket or AWS Lambda function, that
|
|
226
225
|
* contains a finding.</p>
|
|
226
|
+
* @public
|
|
227
227
|
*/
|
|
228
228
|
export interface Resource {
|
|
229
229
|
/**
|
|
230
|
-
* @public
|
|
231
230
|
* <p>The identifier for the resource.</p>
|
|
231
|
+
* @public
|
|
232
232
|
*/
|
|
233
233
|
id?: string;
|
|
234
234
|
/**
|
|
235
|
-
* @public
|
|
236
235
|
* <p>The identifier for a section of the resource, such as an AWS Lambda layer.</p>
|
|
236
|
+
* @public
|
|
237
237
|
*/
|
|
238
238
|
subResourceId?: string;
|
|
239
239
|
}
|
|
@@ -266,175 +266,175 @@ export declare const Status: {
|
|
|
266
266
|
*/
|
|
267
267
|
export type Status = (typeof Status)[keyof typeof Status];
|
|
268
268
|
/**
|
|
269
|
-
* @public
|
|
270
269
|
* <p>The line of code where a finding was detected.</p>
|
|
270
|
+
* @public
|
|
271
271
|
*/
|
|
272
272
|
export interface CodeLine {
|
|
273
273
|
/**
|
|
274
|
-
* @public
|
|
275
274
|
* <p>The code line number.</p>
|
|
275
|
+
* @public
|
|
276
276
|
*/
|
|
277
277
|
number?: number;
|
|
278
278
|
/**
|
|
279
|
-
* @public
|
|
280
279
|
* <p>The code that contains a vulnerability.</p>
|
|
280
|
+
* @public
|
|
281
281
|
*/
|
|
282
282
|
content?: string;
|
|
283
283
|
}
|
|
284
284
|
/**
|
|
285
|
-
* @public
|
|
286
285
|
* <p>Information about the location of security vulnerabilities that Amazon CodeGuru Security
|
|
287
286
|
* detected in your code.</p>
|
|
287
|
+
* @public
|
|
288
288
|
*/
|
|
289
289
|
export interface FilePath {
|
|
290
290
|
/**
|
|
291
|
-
* @public
|
|
292
291
|
* <p>The name of the file.</p>
|
|
292
|
+
* @public
|
|
293
293
|
*/
|
|
294
294
|
name?: string;
|
|
295
295
|
/**
|
|
296
|
-
* @public
|
|
297
296
|
* <p>The path to the resource with the security vulnerability.</p>
|
|
297
|
+
* @public
|
|
298
298
|
*/
|
|
299
299
|
path?: string;
|
|
300
300
|
/**
|
|
301
|
-
* @public
|
|
302
301
|
* <p>The first line number of the code snippet where the security vulnerability appears in your code.</p>
|
|
302
|
+
* @public
|
|
303
303
|
*/
|
|
304
304
|
startLine?: number;
|
|
305
305
|
/**
|
|
306
|
-
* @public
|
|
307
306
|
* <p>The last line number of the code snippet where the security vulnerability appears in your
|
|
308
307
|
* code.</p>
|
|
308
|
+
* @public
|
|
309
309
|
*/
|
|
310
310
|
endLine?: number;
|
|
311
311
|
/**
|
|
312
|
-
* @public
|
|
313
312
|
* <p>A list of <code>CodeLine</code> objects that describe where the security vulnerability
|
|
314
313
|
* appears in your code.</p>
|
|
314
|
+
* @public
|
|
315
315
|
*/
|
|
316
316
|
codeSnippet?: CodeLine[];
|
|
317
317
|
}
|
|
318
318
|
/**
|
|
319
|
-
* @public
|
|
320
319
|
* <p>Information about a security vulnerability that Amazon CodeGuru Security detected.</p>
|
|
320
|
+
* @public
|
|
321
321
|
*/
|
|
322
322
|
export interface Vulnerability {
|
|
323
323
|
/**
|
|
324
|
-
* @public
|
|
325
324
|
* <p>One or more URL addresses that contain details about a vulnerability.</p>
|
|
325
|
+
* @public
|
|
326
326
|
*/
|
|
327
327
|
referenceUrls?: string[];
|
|
328
328
|
/**
|
|
329
|
-
* @public
|
|
330
329
|
* <p>One or more vulnerabilities that are related to the vulnerability being described.</p>
|
|
330
|
+
* @public
|
|
331
331
|
*/
|
|
332
332
|
relatedVulnerabilities?: string[];
|
|
333
333
|
/**
|
|
334
|
-
* @public
|
|
335
334
|
* <p>The identifier for the vulnerability.</p>
|
|
335
|
+
* @public
|
|
336
336
|
*/
|
|
337
337
|
id?: string;
|
|
338
338
|
/**
|
|
339
|
-
* @public
|
|
340
339
|
* <p> An object that describes the location of the detected security vulnerability in your
|
|
341
340
|
* code.</p>
|
|
341
|
+
* @public
|
|
342
342
|
*/
|
|
343
343
|
filePath?: FilePath;
|
|
344
344
|
/**
|
|
345
|
-
* @public
|
|
346
345
|
* <p> The number of times the vulnerability appears in your code.</p>
|
|
346
|
+
* @public
|
|
347
347
|
*/
|
|
348
348
|
itemCount?: number;
|
|
349
349
|
}
|
|
350
350
|
/**
|
|
351
|
-
* @public
|
|
352
351
|
* <p>Information about a finding that was detected in your code.</p>
|
|
352
|
+
* @public
|
|
353
353
|
*/
|
|
354
354
|
export interface Finding {
|
|
355
355
|
/**
|
|
356
|
-
* @public
|
|
357
356
|
* <p>The time when the finding was created.</p>
|
|
357
|
+
* @public
|
|
358
358
|
*/
|
|
359
359
|
createdAt?: Date;
|
|
360
360
|
/**
|
|
361
|
-
* @public
|
|
362
361
|
* <p>A description of the finding.</p>
|
|
362
|
+
* @public
|
|
363
363
|
*/
|
|
364
364
|
description?: string;
|
|
365
365
|
/**
|
|
366
|
-
* @public
|
|
367
366
|
* <p>The identifier for the component that generated a finding such as AWSCodeGuruSecurity or
|
|
368
367
|
* AWSInspector.</p>
|
|
368
|
+
* @public
|
|
369
369
|
*/
|
|
370
370
|
generatorId?: string;
|
|
371
371
|
/**
|
|
372
|
-
* @public
|
|
373
372
|
* <p>The identifier for a finding.</p>
|
|
373
|
+
* @public
|
|
374
374
|
*/
|
|
375
375
|
id?: string;
|
|
376
376
|
/**
|
|
377
|
-
* @public
|
|
378
377
|
* <p>The time when the finding was last updated. Findings are updated when you remediate them
|
|
379
378
|
* or when the finding code location changes. </p>
|
|
379
|
+
* @public
|
|
380
380
|
*/
|
|
381
381
|
updatedAt?: Date;
|
|
382
382
|
/**
|
|
383
|
-
* @public
|
|
384
383
|
* <p>The type of finding. </p>
|
|
384
|
+
* @public
|
|
385
385
|
*/
|
|
386
386
|
type?: string;
|
|
387
387
|
/**
|
|
388
|
-
* @public
|
|
389
388
|
* <p>The status of the finding. A finding status can be open or closed. </p>
|
|
389
|
+
* @public
|
|
390
390
|
*/
|
|
391
391
|
status?: Status;
|
|
392
392
|
/**
|
|
393
|
-
* @public
|
|
394
393
|
* <p>The resource where Amazon CodeGuru Security detected a finding.</p>
|
|
394
|
+
* @public
|
|
395
395
|
*/
|
|
396
396
|
resource?: Resource;
|
|
397
397
|
/**
|
|
398
|
-
* @public
|
|
399
398
|
* <p>An object that describes the detected security vulnerability.</p>
|
|
399
|
+
* @public
|
|
400
400
|
*/
|
|
401
401
|
vulnerability?: Vulnerability;
|
|
402
402
|
/**
|
|
403
|
-
* @public
|
|
404
403
|
* <p>The severity of the finding.</p>
|
|
404
|
+
* @public
|
|
405
405
|
*/
|
|
406
406
|
severity?: Severity;
|
|
407
407
|
/**
|
|
408
|
-
* @public
|
|
409
408
|
* <p>An object that contains the details about how to remediate a finding.</p>
|
|
409
|
+
* @public
|
|
410
410
|
*/
|
|
411
411
|
remediation?: Remediation;
|
|
412
412
|
/**
|
|
413
|
-
* @public
|
|
414
413
|
* <p>The title of the finding.</p>
|
|
414
|
+
* @public
|
|
415
415
|
*/
|
|
416
416
|
title?: string;
|
|
417
417
|
/**
|
|
418
|
-
* @public
|
|
419
418
|
* <p>One or more tags or categorizations that are associated with a detector. These tags are
|
|
420
419
|
* defined by type, programming language, or other classification such as maintainability or
|
|
421
420
|
* consistency.</p>
|
|
421
|
+
* @public
|
|
422
422
|
*/
|
|
423
423
|
detectorTags?: string[];
|
|
424
424
|
/**
|
|
425
|
-
* @public
|
|
426
425
|
* <p>The identifier for the detector that detected the finding in your code. A detector is a
|
|
427
426
|
* defined rule based on industry standards and AWS best practices. </p>
|
|
427
|
+
* @public
|
|
428
428
|
*/
|
|
429
429
|
detectorId?: string;
|
|
430
430
|
/**
|
|
431
|
-
* @public
|
|
432
431
|
* <p>The name of the detector that identified the security vulnerability in your code. </p>
|
|
432
|
+
* @public
|
|
433
433
|
*/
|
|
434
434
|
detectorName?: string;
|
|
435
435
|
/**
|
|
436
|
-
* @public
|
|
437
436
|
* <p>The identifier for the rule that generated the finding.</p>
|
|
437
|
+
* @public
|
|
438
438
|
*/
|
|
439
439
|
ruleId?: string;
|
|
440
440
|
}
|
|
@@ -443,29 +443,29 @@ export interface Finding {
|
|
|
443
443
|
*/
|
|
444
444
|
export interface BatchGetFindingsResponse {
|
|
445
445
|
/**
|
|
446
|
-
* @public
|
|
447
446
|
* <p> A list of all requested findings.</p>
|
|
447
|
+
* @public
|
|
448
448
|
*/
|
|
449
449
|
findings: Finding[] | undefined;
|
|
450
450
|
/**
|
|
451
|
-
* @public
|
|
452
451
|
* <p>A list of errors for individual findings which were not fetched. Each
|
|
453
452
|
* BatchGetFindingsError contains the <code>scanName</code>, <code>findingId</code>,
|
|
454
453
|
* <code>errorCode</code> and error <code>message</code>.</p>
|
|
454
|
+
* @public
|
|
455
455
|
*/
|
|
456
456
|
failedFindings: BatchGetFindingsError[] | undefined;
|
|
457
457
|
}
|
|
458
458
|
/**
|
|
459
|
-
* @public
|
|
460
459
|
* <p>The server encountered an internal error and is unable to complete the request.</p>
|
|
460
|
+
* @public
|
|
461
461
|
*/
|
|
462
462
|
export declare class InternalServerException extends __BaseException {
|
|
463
463
|
readonly name: "InternalServerException";
|
|
464
464
|
readonly $fault: "server";
|
|
465
465
|
$retryable: {};
|
|
466
466
|
/**
|
|
467
|
-
* @public
|
|
468
467
|
* <p>The internal error encountered by the server.</p>
|
|
468
|
+
* @public
|
|
469
469
|
*/
|
|
470
470
|
error?: string;
|
|
471
471
|
/**
|
|
@@ -474,8 +474,8 @@ export declare class InternalServerException extends __BaseException {
|
|
|
474
474
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
475
475
|
}
|
|
476
476
|
/**
|
|
477
|
-
* @public
|
|
478
477
|
* <p>The request was denied due to request throttling.</p>
|
|
478
|
+
* @public
|
|
479
479
|
*/
|
|
480
480
|
export declare class ThrottlingException extends __BaseException {
|
|
481
481
|
readonly name: "ThrottlingException";
|
|
@@ -484,18 +484,18 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
484
484
|
throttling: boolean;
|
|
485
485
|
};
|
|
486
486
|
/**
|
|
487
|
-
* @public
|
|
488
487
|
* <p>The identifier for the error.</p>
|
|
488
|
+
* @public
|
|
489
489
|
*/
|
|
490
490
|
errorCode: string | undefined;
|
|
491
491
|
/**
|
|
492
|
-
* @public
|
|
493
492
|
* <p>The identifier for the originating service.</p>
|
|
493
|
+
* @public
|
|
494
494
|
*/
|
|
495
495
|
serviceCode?: string;
|
|
496
496
|
/**
|
|
497
|
-
* @public
|
|
498
497
|
* <p>The identifier for the originating quota.</p>
|
|
498
|
+
* @public
|
|
499
499
|
*/
|
|
500
500
|
quotaCode?: string;
|
|
501
501
|
/**
|
|
@@ -504,18 +504,18 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
504
504
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
505
505
|
}
|
|
506
506
|
/**
|
|
507
|
-
* @public
|
|
508
507
|
* <p>Information about a validation exception.</p>
|
|
508
|
+
* @public
|
|
509
509
|
*/
|
|
510
510
|
export interface ValidationExceptionField {
|
|
511
511
|
/**
|
|
512
|
-
* @public
|
|
513
512
|
* <p>The name of the exception.</p>
|
|
513
|
+
* @public
|
|
514
514
|
*/
|
|
515
515
|
name: string | undefined;
|
|
516
516
|
/**
|
|
517
|
-
* @public
|
|
518
517
|
* <p>Describes the exception.</p>
|
|
518
|
+
* @public
|
|
519
519
|
*/
|
|
520
520
|
message: string | undefined;
|
|
521
521
|
}
|
|
@@ -535,25 +535,25 @@ export declare const ValidationExceptionReason: {
|
|
|
535
535
|
*/
|
|
536
536
|
export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
537
537
|
/**
|
|
538
|
-
* @public
|
|
539
538
|
* <p>The input fails to satisfy the specified constraints.</p>
|
|
539
|
+
* @public
|
|
540
540
|
*/
|
|
541
541
|
export declare class ValidationException extends __BaseException {
|
|
542
542
|
readonly name: "ValidationException";
|
|
543
543
|
readonly $fault: "client";
|
|
544
544
|
/**
|
|
545
|
-
* @public
|
|
546
545
|
* <p>The identifier for the error.</p>
|
|
546
|
+
* @public
|
|
547
547
|
*/
|
|
548
548
|
errorCode: string | undefined;
|
|
549
549
|
/**
|
|
550
|
-
* @public
|
|
551
550
|
* <p>The reason the request failed validation.</p>
|
|
551
|
+
* @public
|
|
552
552
|
*/
|
|
553
553
|
reason: ValidationExceptionReason | undefined;
|
|
554
554
|
/**
|
|
555
|
-
* @public
|
|
556
555
|
* <p>The field that caused the error, if applicable.</p>
|
|
556
|
+
* @public
|
|
557
557
|
*/
|
|
558
558
|
fieldList?: ValidationExceptionField[];
|
|
559
559
|
/**
|
|
@@ -562,27 +562,27 @@ export declare class ValidationException extends __BaseException {
|
|
|
562
562
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
563
563
|
}
|
|
564
564
|
/**
|
|
565
|
-
* @public
|
|
566
565
|
* <p>The requested operation would cause a conflict with the current state of a service
|
|
567
566
|
* resource associated with the request. Resolve the conflict before retrying this
|
|
568
567
|
* request.</p>
|
|
568
|
+
* @public
|
|
569
569
|
*/
|
|
570
570
|
export declare class ConflictException extends __BaseException {
|
|
571
571
|
readonly name: "ConflictException";
|
|
572
572
|
readonly $fault: "client";
|
|
573
573
|
/**
|
|
574
|
-
* @public
|
|
575
574
|
* <p>The identifier for the error.</p>
|
|
575
|
+
* @public
|
|
576
576
|
*/
|
|
577
577
|
errorCode: string | undefined;
|
|
578
578
|
/**
|
|
579
|
-
* @public
|
|
580
579
|
* <p>The identifier for the service resource associated with the request.</p>
|
|
580
|
+
* @public
|
|
581
581
|
*/
|
|
582
582
|
resourceId: string | undefined;
|
|
583
583
|
/**
|
|
584
|
-
* @public
|
|
585
584
|
* <p>The type of resource associated with the request.</p>
|
|
585
|
+
* @public
|
|
586
586
|
*/
|
|
587
587
|
resourceType: string | undefined;
|
|
588
588
|
/**
|
|
@@ -591,8 +591,8 @@ export declare class ConflictException extends __BaseException {
|
|
|
591
591
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
592
592
|
}
|
|
593
593
|
/**
|
|
594
|
-
* @public
|
|
595
594
|
* <p>The identifier for a resource object that contains resources where a finding was detected.</p>
|
|
595
|
+
* @public
|
|
596
596
|
*/
|
|
597
597
|
export type ResourceId = ResourceId.CodeArtifactIdMember | ResourceId.$UnknownMember;
|
|
598
598
|
/**
|
|
@@ -600,8 +600,8 @@ export type ResourceId = ResourceId.CodeArtifactIdMember | ResourceId.$UnknownMe
|
|
|
600
600
|
*/
|
|
601
601
|
export declare namespace ResourceId {
|
|
602
602
|
/**
|
|
603
|
-
* @public
|
|
604
603
|
* <p>The identifier for the code file uploaded to the resource where a finding was detected.</p>
|
|
604
|
+
* @public
|
|
605
605
|
*/
|
|
606
606
|
interface CodeArtifactIdMember {
|
|
607
607
|
codeArtifactId: string;
|
|
@@ -637,43 +637,42 @@ export type ScanType = (typeof ScanType)[keyof typeof ScanType];
|
|
|
637
637
|
*/
|
|
638
638
|
export interface CreateScanRequest {
|
|
639
639
|
/**
|
|
640
|
-
* @public
|
|
641
640
|
* <p>The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent
|
|
642
641
|
* the accidental creation of duplicate scans if there are failures and retries.</p>
|
|
642
|
+
* @public
|
|
643
643
|
*/
|
|
644
644
|
clientToken?: string;
|
|
645
645
|
/**
|
|
646
|
-
* @public
|
|
647
646
|
* <p>The identifier for an input resource used to create a scan.</p>
|
|
647
|
+
* @public
|
|
648
648
|
*/
|
|
649
649
|
resourceId: ResourceId | undefined;
|
|
650
650
|
/**
|
|
651
|
-
* @public
|
|
652
651
|
* <p>The unique name that CodeGuru Security uses to track revisions across multiple
|
|
653
652
|
* scans of the same resource. Only allowed for a <code>STANDARD</code> scan type. If not
|
|
654
653
|
* specified, it will be auto generated. </p>
|
|
654
|
+
* @public
|
|
655
655
|
*/
|
|
656
656
|
scanName: string | undefined;
|
|
657
657
|
/**
|
|
658
|
-
* @public
|
|
659
658
|
* <p>The type of scan, either <code>Standard</code> or <code>Express</code>. Defaults to
|
|
660
659
|
* <code>Standard</code> type if missing.</p>
|
|
661
660
|
* <p>
|
|
662
661
|
* <code>Express</code> scans run on limited resources and use a limited set of detectors to
|
|
663
662
|
* analyze your code in near-real time. <code>Standard</code> scans have standard resource limits
|
|
664
663
|
* and use the full set of detectors to analyze your code.</p>
|
|
664
|
+
* @public
|
|
665
665
|
*/
|
|
666
666
|
scanType?: ScanType;
|
|
667
667
|
/**
|
|
668
|
-
* @public
|
|
669
668
|
* <p>The type of analysis you want CodeGuru Security to perform in the scan, either
|
|
670
669
|
* <code>Security</code> or <code>All</code>. The <code>Security</code> type only generates
|
|
671
670
|
* findings related to security. The <code>All</code> type generates both security findings and
|
|
672
671
|
* quality findings. Defaults to <code>Security</code> type if missing.</p>
|
|
672
|
+
* @public
|
|
673
673
|
*/
|
|
674
674
|
analysisType?: AnalysisType;
|
|
675
675
|
/**
|
|
676
|
-
* @public
|
|
677
676
|
* <p>An array of key-value pairs used to tag a scan. A tag is a custom attribute
|
|
678
677
|
* label with two parts:</p>
|
|
679
678
|
* <ul>
|
|
@@ -687,6 +686,7 @@ export interface CreateScanRequest {
|
|
|
687
686
|
* empty string. Tag values are case sensitive.</p>
|
|
688
687
|
* </li>
|
|
689
688
|
* </ul>
|
|
689
|
+
* @public
|
|
690
690
|
*/
|
|
691
691
|
tags?: Record<string, string>;
|
|
692
692
|
}
|
|
@@ -708,52 +708,52 @@ export type ScanState = (typeof ScanState)[keyof typeof ScanState];
|
|
|
708
708
|
*/
|
|
709
709
|
export interface CreateScanResponse {
|
|
710
710
|
/**
|
|
711
|
-
* @public
|
|
712
711
|
* <p>The name of the scan.</p>
|
|
712
|
+
* @public
|
|
713
713
|
*/
|
|
714
714
|
scanName: string | undefined;
|
|
715
715
|
/**
|
|
716
|
-
* @public
|
|
717
716
|
* <p>UUID that identifies the individual scan run.</p>
|
|
717
|
+
* @public
|
|
718
718
|
*/
|
|
719
719
|
runId: string | undefined;
|
|
720
720
|
/**
|
|
721
|
-
* @public
|
|
722
721
|
* <p>The identifier for the resource object that contains resources that were scanned.</p>
|
|
722
|
+
* @public
|
|
723
723
|
*/
|
|
724
724
|
resourceId: ResourceId | undefined;
|
|
725
725
|
/**
|
|
726
|
-
* @public
|
|
727
726
|
* <p>The current state of the scan. Returns either <code>InProgress</code>,
|
|
728
727
|
* <code>Successful</code>, or <code>Failed</code>.</p>
|
|
728
|
+
* @public
|
|
729
729
|
*/
|
|
730
730
|
scanState: ScanState | undefined;
|
|
731
731
|
/**
|
|
732
|
-
* @public
|
|
733
732
|
* <p>The ARN for the scan name.</p>
|
|
733
|
+
* @public
|
|
734
734
|
*/
|
|
735
735
|
scanNameArn?: string;
|
|
736
736
|
}
|
|
737
737
|
/**
|
|
738
|
-
* @public
|
|
739
738
|
* <p>The resource specified in the request was not found.</p>
|
|
739
|
+
* @public
|
|
740
740
|
*/
|
|
741
741
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
742
742
|
readonly name: "ResourceNotFoundException";
|
|
743
743
|
readonly $fault: "client";
|
|
744
744
|
/**
|
|
745
|
-
* @public
|
|
746
745
|
* <p>The identifier for the error.</p>
|
|
746
|
+
* @public
|
|
747
747
|
*/
|
|
748
748
|
errorCode: string | undefined;
|
|
749
749
|
/**
|
|
750
|
-
* @public
|
|
751
750
|
* <p>The identifier for the resource that was not found.</p>
|
|
751
|
+
* @public
|
|
752
752
|
*/
|
|
753
753
|
resourceId: string | undefined;
|
|
754
754
|
/**
|
|
755
|
-
* @public
|
|
756
755
|
* <p>The type of resource that was not found.</p>
|
|
756
|
+
* @public
|
|
757
757
|
*/
|
|
758
758
|
resourceType: string | undefined;
|
|
759
759
|
/**
|
|
@@ -766,10 +766,10 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
766
766
|
*/
|
|
767
767
|
export interface CreateUploadUrlRequest {
|
|
768
768
|
/**
|
|
769
|
-
* @public
|
|
770
769
|
* <p>The name of the scan that will use the uploaded resource. CodeGuru Security uses the
|
|
771
770
|
* unique scan name to track revisions across multiple scans of the same resource. Use this
|
|
772
771
|
* <code>scanName</code> when you call <code>CreateScan</code> on the code resource you upload to this URL.</p>
|
|
772
|
+
* @public
|
|
773
773
|
*/
|
|
774
774
|
scanName: string | undefined;
|
|
775
775
|
}
|
|
@@ -778,20 +778,20 @@ export interface CreateUploadUrlRequest {
|
|
|
778
778
|
*/
|
|
779
779
|
export interface CreateUploadUrlResponse {
|
|
780
780
|
/**
|
|
781
|
-
* @public
|
|
782
781
|
* <p>A pre-signed S3 URL. You can upload the code file you want to scan and add the required
|
|
783
782
|
* <code>requestHeaders</code> using any HTTP client.</p>
|
|
783
|
+
* @public
|
|
784
784
|
*/
|
|
785
785
|
s3Url: string | undefined;
|
|
786
786
|
/**
|
|
787
|
-
* @public
|
|
788
787
|
* <p>A set of key-value pairs that contain the required headers when uploading your
|
|
789
788
|
* resource.</p>
|
|
789
|
+
* @public
|
|
790
790
|
*/
|
|
791
791
|
requestHeaders: Record<string, string> | undefined;
|
|
792
792
|
/**
|
|
793
|
-
* @public
|
|
794
793
|
* <p>The identifier for the uploaded code resource. </p>
|
|
794
|
+
* @public
|
|
795
795
|
*/
|
|
796
796
|
codeArtifactId: string | undefined;
|
|
797
797
|
}
|
|
@@ -801,14 +801,14 @@ export interface CreateUploadUrlResponse {
|
|
|
801
801
|
export interface GetAccountConfigurationRequest {
|
|
802
802
|
}
|
|
803
803
|
/**
|
|
804
|
-
* @public
|
|
805
804
|
* <p>Information about account-level configuration.</p>
|
|
805
|
+
* @public
|
|
806
806
|
*/
|
|
807
807
|
export interface EncryptionConfig {
|
|
808
808
|
/**
|
|
809
|
-
* @public
|
|
810
809
|
* <p>The KMS key ARN to use for encryption. This must be provided as a header when uploading
|
|
811
810
|
* your code resource.</p>
|
|
811
|
+
* @public
|
|
812
812
|
*/
|
|
813
813
|
kmsKeyArn?: string;
|
|
814
814
|
}
|
|
@@ -817,10 +817,10 @@ export interface EncryptionConfig {
|
|
|
817
817
|
*/
|
|
818
818
|
export interface GetAccountConfigurationResponse {
|
|
819
819
|
/**
|
|
820
|
-
* @public
|
|
821
820
|
* <p>An <code>EncryptionConfig</code> object that contains the KMS key ARN to use for
|
|
822
821
|
* encryption. By default, CodeGuru Security uses an AWS-managed key for encryption. To specify
|
|
823
822
|
* your own key, call <code>UpdateAccountConfiguration</code>.</p>
|
|
823
|
+
* @public
|
|
824
824
|
*/
|
|
825
825
|
encryptionConfig: EncryptionConfig | undefined;
|
|
826
826
|
}
|
|
@@ -829,29 +829,29 @@ export interface GetAccountConfigurationResponse {
|
|
|
829
829
|
*/
|
|
830
830
|
export interface GetFindingsRequest {
|
|
831
831
|
/**
|
|
832
|
-
* @public
|
|
833
832
|
* <p>The name of the scan you want to retrieve findings from.</p>
|
|
833
|
+
* @public
|
|
834
834
|
*/
|
|
835
835
|
scanName: string | undefined;
|
|
836
836
|
/**
|
|
837
|
-
* @public
|
|
838
837
|
* <p>A token to use for paginating results that are returned in the response. Set the value of
|
|
839
838
|
* this parameter to null for the first request. For subsequent calls, use the <code>nextToken</code> value
|
|
840
839
|
* returned from the previous request to continue listing results after the first page.</p>
|
|
840
|
+
* @public
|
|
841
841
|
*/
|
|
842
842
|
nextToken?: string;
|
|
843
843
|
/**
|
|
844
|
-
* @public
|
|
845
844
|
* <p>The maximum number of results to return in the response. Use this parameter when
|
|
846
845
|
* paginating results. If additional results exist beyond the number you specify, the <code>nextToken</code>
|
|
847
846
|
* element is returned in the response. Use <code>nextToken</code> in a subsequent request to retrieve
|
|
848
847
|
* additional results.</p>
|
|
848
|
+
* @public
|
|
849
849
|
*/
|
|
850
850
|
maxResults?: number;
|
|
851
851
|
/**
|
|
852
|
-
* @public
|
|
853
852
|
* <p>The status of the findings you want to get. Pass either <code>Open</code>,
|
|
854
853
|
* <code>Closed</code>, or <code>All</code>.</p>
|
|
854
|
+
* @public
|
|
855
855
|
*/
|
|
856
856
|
status?: Status;
|
|
857
857
|
}
|
|
@@ -860,14 +860,14 @@ export interface GetFindingsRequest {
|
|
|
860
860
|
*/
|
|
861
861
|
export interface GetFindingsResponse {
|
|
862
862
|
/**
|
|
863
|
-
* @public
|
|
864
863
|
* <p>A list of findings generated by the specified scan.</p>
|
|
864
|
+
* @public
|
|
865
865
|
*/
|
|
866
866
|
findings?: Finding[];
|
|
867
867
|
/**
|
|
868
|
-
* @public
|
|
869
868
|
* <p>A pagination token. You can use this in future calls to <code>GetFindings</code> to continue listing
|
|
870
869
|
* results after the current page. </p>
|
|
870
|
+
* @public
|
|
871
871
|
*/
|
|
872
872
|
nextToken?: string;
|
|
873
873
|
}
|
|
@@ -876,77 +876,77 @@ export interface GetFindingsResponse {
|
|
|
876
876
|
*/
|
|
877
877
|
export interface GetMetricsSummaryRequest {
|
|
878
878
|
/**
|
|
879
|
-
* @public
|
|
880
879
|
* <p>The date you want to retrieve summary metrics from, rounded to the nearest day. The date
|
|
881
880
|
* must be within the past two years since metrics data is only stored for two years. If a date
|
|
882
881
|
* outside of this range is passed, the response will be empty.</p>
|
|
882
|
+
* @public
|
|
883
883
|
*/
|
|
884
884
|
date: Date | undefined;
|
|
885
885
|
}
|
|
886
886
|
/**
|
|
887
|
-
* @public
|
|
888
887
|
* <p>Information about a finding category with open findings.</p>
|
|
888
|
+
* @public
|
|
889
889
|
*/
|
|
890
890
|
export interface CategoryWithFindingNum {
|
|
891
891
|
/**
|
|
892
|
-
* @public
|
|
893
892
|
* <p>The name of the finding category. A finding category is determined by the detector that
|
|
894
893
|
* detected the finding.</p>
|
|
894
|
+
* @public
|
|
895
895
|
*/
|
|
896
896
|
categoryName?: string;
|
|
897
897
|
/**
|
|
898
|
-
* @public
|
|
899
898
|
* <p>The number of open findings in the category.</p>
|
|
899
|
+
* @public
|
|
900
900
|
*/
|
|
901
901
|
findingNumber?: number;
|
|
902
902
|
}
|
|
903
903
|
/**
|
|
904
|
-
* @public
|
|
905
904
|
* <p>Information about a scan with open findings.</p>
|
|
905
|
+
* @public
|
|
906
906
|
*/
|
|
907
907
|
export interface ScanNameWithFindingNum {
|
|
908
908
|
/**
|
|
909
|
-
* @public
|
|
910
909
|
* <p>The name of the scan.</p>
|
|
910
|
+
* @public
|
|
911
911
|
*/
|
|
912
912
|
scanName?: string;
|
|
913
913
|
/**
|
|
914
|
-
* @public
|
|
915
914
|
* <p>The number of open findings generated by a scan.</p>
|
|
915
|
+
* @public
|
|
916
916
|
*/
|
|
917
917
|
findingNumber?: number;
|
|
918
918
|
}
|
|
919
919
|
/**
|
|
920
|
-
* @public
|
|
921
920
|
* <p>Information about summary metrics in an account.</p>
|
|
921
|
+
* @public
|
|
922
922
|
*/
|
|
923
923
|
export interface MetricsSummary {
|
|
924
924
|
/**
|
|
925
|
-
* @public
|
|
926
925
|
* <p>The date from which the metrics summary information was retrieved.</p>
|
|
926
|
+
* @public
|
|
927
927
|
*/
|
|
928
928
|
date?: Date;
|
|
929
929
|
/**
|
|
930
|
-
* @public
|
|
931
930
|
* <p>The number of open findings of each severity in an account.</p>
|
|
931
|
+
* @public
|
|
932
932
|
*/
|
|
933
933
|
openFindings?: FindingMetricsValuePerSeverity;
|
|
934
934
|
/**
|
|
935
|
-
* @public
|
|
936
935
|
* <p>A list of <code>CategoryWithFindingNum</code> objects for the top 5 finding categories
|
|
937
936
|
* with the most open findings in an account.</p>
|
|
937
|
+
* @public
|
|
938
938
|
*/
|
|
939
939
|
categoriesWithMostFindings?: CategoryWithFindingNum[];
|
|
940
940
|
/**
|
|
941
|
-
* @public
|
|
942
941
|
* <p>A list of <code>ScanNameWithFindingNum</code> objects for the top 3 scans with the most
|
|
943
942
|
* number of open critical findings in an account.</p>
|
|
943
|
+
* @public
|
|
944
944
|
*/
|
|
945
945
|
scansWithMostOpenFindings?: ScanNameWithFindingNum[];
|
|
946
946
|
/**
|
|
947
|
-
* @public
|
|
948
947
|
* <p>A list of <code>ScanNameWithFindingNum</code> objects for the top 3 scans with the most
|
|
949
948
|
* number of open findings in an account.</p>
|
|
949
|
+
* @public
|
|
950
950
|
*/
|
|
951
951
|
scansWithMostOpenCriticalFindings?: ScanNameWithFindingNum[];
|
|
952
952
|
}
|
|
@@ -955,8 +955,8 @@ export interface MetricsSummary {
|
|
|
955
955
|
*/
|
|
956
956
|
export interface GetMetricsSummaryResponse {
|
|
957
957
|
/**
|
|
958
|
-
* @public
|
|
959
958
|
* <p>The summary metrics from the specified date.</p>
|
|
959
|
+
* @public
|
|
960
960
|
*/
|
|
961
961
|
metricsSummary?: MetricsSummary;
|
|
962
962
|
}
|
|
@@ -965,14 +965,14 @@ export interface GetMetricsSummaryResponse {
|
|
|
965
965
|
*/
|
|
966
966
|
export interface GetScanRequest {
|
|
967
967
|
/**
|
|
968
|
-
* @public
|
|
969
968
|
* <p>The name of the scan you want to view details about.</p>
|
|
969
|
+
* @public
|
|
970
970
|
*/
|
|
971
971
|
scanName: string | undefined;
|
|
972
972
|
/**
|
|
973
|
-
* @public
|
|
974
973
|
* <p>UUID that identifies the individual scan run you want to view details about. You retrieve
|
|
975
974
|
* this when you call the <code>CreateScan</code> operation. Defaults to the latest scan run if missing.</p>
|
|
975
|
+
* @public
|
|
976
976
|
*/
|
|
977
977
|
runId?: string;
|
|
978
978
|
}
|
|
@@ -981,47 +981,47 @@ export interface GetScanRequest {
|
|
|
981
981
|
*/
|
|
982
982
|
export interface GetScanResponse {
|
|
983
983
|
/**
|
|
984
|
-
* @public
|
|
985
984
|
* <p>The name of the scan.</p>
|
|
985
|
+
* @public
|
|
986
986
|
*/
|
|
987
987
|
scanName: string | undefined;
|
|
988
988
|
/**
|
|
989
|
-
* @public
|
|
990
989
|
* <p>UUID that identifies the individual scan run.</p>
|
|
990
|
+
* @public
|
|
991
991
|
*/
|
|
992
992
|
runId: string | undefined;
|
|
993
993
|
/**
|
|
994
|
-
* @public
|
|
995
994
|
* <p>The current state of the scan. Pass either <code>InProgress</code>,
|
|
996
995
|
* <code>Successful</code>, or <code>Failed</code>.</p>
|
|
996
|
+
* @public
|
|
997
997
|
*/
|
|
998
998
|
scanState: ScanState | undefined;
|
|
999
999
|
/**
|
|
1000
|
-
* @public
|
|
1001
1000
|
* <p>The time the scan was created.</p>
|
|
1001
|
+
* @public
|
|
1002
1002
|
*/
|
|
1003
1003
|
createdAt: Date | undefined;
|
|
1004
1004
|
/**
|
|
1005
|
-
* @public
|
|
1006
1005
|
* <p>The type of analysis CodeGuru Security performed in the scan, either
|
|
1007
1006
|
* <code>Security</code> or <code>All</code>. The <code>Security</code> type only generates
|
|
1008
1007
|
* findings related to security. The <code>All</code> type generates both security findings and
|
|
1009
1008
|
* quality findings.</p>
|
|
1009
|
+
* @public
|
|
1010
1010
|
*/
|
|
1011
1011
|
analysisType: AnalysisType | undefined;
|
|
1012
1012
|
/**
|
|
1013
|
-
* @public
|
|
1014
1013
|
* <p>The time when the scan was last updated. Only available for <code>STANDARD</code> scan types.</p>
|
|
1014
|
+
* @public
|
|
1015
1015
|
*/
|
|
1016
1016
|
updatedAt?: Date;
|
|
1017
1017
|
/**
|
|
1018
|
-
* @public
|
|
1019
1018
|
* <p>The number of times a scan has been re-run on a revised resource.</p>
|
|
1019
|
+
* @public
|
|
1020
1020
|
*/
|
|
1021
1021
|
numberOfRevisions?: number;
|
|
1022
1022
|
/**
|
|
1023
|
-
* @public
|
|
1024
1023
|
* <p>The ARN for the scan name.</p>
|
|
1024
|
+
* @public
|
|
1025
1025
|
*/
|
|
1026
1026
|
scanNameArn?: string;
|
|
1027
1027
|
}
|
|
@@ -1030,29 +1030,29 @@ export interface GetScanResponse {
|
|
|
1030
1030
|
*/
|
|
1031
1031
|
export interface ListFindingsMetricsRequest {
|
|
1032
1032
|
/**
|
|
1033
|
-
* @public
|
|
1034
1033
|
* <p>A token to use for paginating results that are returned in the response. Set the
|
|
1035
1034
|
* value of this parameter to null for the first request. For subsequent calls, use the <code>nextToken</code>
|
|
1036
1035
|
* value returned from the previous request to continue listing results after the first
|
|
1037
1036
|
* page.</p>
|
|
1037
|
+
* @public
|
|
1038
1038
|
*/
|
|
1039
1039
|
nextToken?: string;
|
|
1040
1040
|
/**
|
|
1041
|
-
* @public
|
|
1042
1041
|
* <p>The maximum number of results to return in the response. Use this parameter when
|
|
1043
1042
|
* paginating results. If additional results exist beyond the number you specify, the <code>nextToken</code>
|
|
1044
1043
|
* element is returned in the response. Use <code>nextToken</code> in a subsequent request to retrieve
|
|
1045
1044
|
* additional results.</p>
|
|
1045
|
+
* @public
|
|
1046
1046
|
*/
|
|
1047
1047
|
maxResults?: number;
|
|
1048
1048
|
/**
|
|
1049
|
-
* @public
|
|
1050
1049
|
* <p>The start date of the interval which you want to retrieve metrics from.</p>
|
|
1050
|
+
* @public
|
|
1051
1051
|
*/
|
|
1052
1052
|
startDate: Date | undefined;
|
|
1053
1053
|
/**
|
|
1054
|
-
* @public
|
|
1055
1054
|
* <p>The end date of the interval which you want to retrieve metrics from.</p>
|
|
1055
|
+
* @public
|
|
1056
1056
|
*/
|
|
1057
1057
|
endDate: Date | undefined;
|
|
1058
1058
|
}
|
|
@@ -1061,14 +1061,14 @@ export interface ListFindingsMetricsRequest {
|
|
|
1061
1061
|
*/
|
|
1062
1062
|
export interface ListFindingsMetricsResponse {
|
|
1063
1063
|
/**
|
|
1064
|
-
* @public
|
|
1065
1064
|
* <p>A list of <code>AccountFindingsMetric</code> objects retrieved from the specified time interval.</p>
|
|
1065
|
+
* @public
|
|
1066
1066
|
*/
|
|
1067
1067
|
findingsMetrics?: AccountFindingsMetric[];
|
|
1068
1068
|
/**
|
|
1069
|
-
* @public
|
|
1070
1069
|
* <p>A pagination token. You can use this in future calls to <code>ListFindingMetrics</code> to continue
|
|
1071
1070
|
* listing results after the current page. </p>
|
|
1071
|
+
* @public
|
|
1072
1072
|
*/
|
|
1073
1073
|
nextToken?: string;
|
|
1074
1074
|
}
|
|
@@ -1077,55 +1077,55 @@ export interface ListFindingsMetricsResponse {
|
|
|
1077
1077
|
*/
|
|
1078
1078
|
export interface ListScansRequest {
|
|
1079
1079
|
/**
|
|
1080
|
-
* @public
|
|
1081
1080
|
* <p>A token to use for paginating results that are returned in the response. Set the value of
|
|
1082
1081
|
* this parameter to null for the first request. For subsequent calls, use the <code>nextToken</code> value
|
|
1083
1082
|
* returned from the previous request to continue listing results after the first page.</p>
|
|
1083
|
+
* @public
|
|
1084
1084
|
*/
|
|
1085
1085
|
nextToken?: string;
|
|
1086
1086
|
/**
|
|
1087
|
-
* @public
|
|
1088
1087
|
* <p>The maximum number of results to return in the response. Use this parameter when
|
|
1089
1088
|
* paginating results. If additional results exist beyond the number you specify, the <code>nextToken</code>
|
|
1090
1089
|
* element is returned in the response. Use <code>nextToken</code> in a subsequent request to retrieve
|
|
1091
1090
|
* additional results.</p>
|
|
1091
|
+
* @public
|
|
1092
1092
|
*/
|
|
1093
1093
|
maxResults?: number;
|
|
1094
1094
|
}
|
|
1095
1095
|
/**
|
|
1096
|
-
* @public
|
|
1097
1096
|
* <p>Information about a scan. </p>
|
|
1097
|
+
* @public
|
|
1098
1098
|
*/
|
|
1099
1099
|
export interface ScanSummary {
|
|
1100
1100
|
/**
|
|
1101
|
-
* @public
|
|
1102
1101
|
* <p>The state of the scan. A scan can be <code>In Progress</code>,
|
|
1103
1102
|
* <code>Complete</code>, or <code>Failed</code>. </p>
|
|
1103
|
+
* @public
|
|
1104
1104
|
*/
|
|
1105
1105
|
scanState: ScanState | undefined;
|
|
1106
1106
|
/**
|
|
1107
|
-
* @public
|
|
1108
1107
|
* <p> The time when the scan was created. </p>
|
|
1108
|
+
* @public
|
|
1109
1109
|
*/
|
|
1110
1110
|
createdAt: Date | undefined;
|
|
1111
1111
|
/**
|
|
1112
|
-
* @public
|
|
1113
1112
|
* <p>The time the scan was last updated. A scan is updated when it is re-run.</p>
|
|
1113
|
+
* @public
|
|
1114
1114
|
*/
|
|
1115
1115
|
updatedAt?: Date;
|
|
1116
1116
|
/**
|
|
1117
|
-
* @public
|
|
1118
1117
|
* <p>The name of the scan. </p>
|
|
1118
|
+
* @public
|
|
1119
1119
|
*/
|
|
1120
1120
|
scanName: string | undefined;
|
|
1121
1121
|
/**
|
|
1122
|
-
* @public
|
|
1123
1122
|
* <p>The identifier for the scan run. </p>
|
|
1123
|
+
* @public
|
|
1124
1124
|
*/
|
|
1125
1125
|
runId: string | undefined;
|
|
1126
1126
|
/**
|
|
1127
|
-
* @public
|
|
1128
1127
|
* <p>The ARN for the scan name.</p>
|
|
1128
|
+
* @public
|
|
1129
1129
|
*/
|
|
1130
1130
|
scanNameArn?: string;
|
|
1131
1131
|
}
|
|
@@ -1134,14 +1134,14 @@ export interface ScanSummary {
|
|
|
1134
1134
|
*/
|
|
1135
1135
|
export interface ListScansResponse {
|
|
1136
1136
|
/**
|
|
1137
|
-
* @public
|
|
1138
1137
|
* <p>A list of <code>ScanSummary</code> objects with information about all scans in an account.</p>
|
|
1138
|
+
* @public
|
|
1139
1139
|
*/
|
|
1140
1140
|
summaries?: ScanSummary[];
|
|
1141
1141
|
/**
|
|
1142
|
-
* @public
|
|
1143
1142
|
* <p>A pagination token. You can use this in future calls to <code>ListScans</code> to continue listing
|
|
1144
1143
|
* results after the current page.</p>
|
|
1144
|
+
* @public
|
|
1145
1145
|
*/
|
|
1146
1146
|
nextToken?: string;
|
|
1147
1147
|
}
|
|
@@ -1150,9 +1150,9 @@ export interface ListScansResponse {
|
|
|
1150
1150
|
*/
|
|
1151
1151
|
export interface ListTagsForResourceRequest {
|
|
1152
1152
|
/**
|
|
1153
|
-
* @public
|
|
1154
1153
|
* <p>The ARN of the <code>ScanName</code> object. You can retrieve this ARN by calling
|
|
1155
1154
|
* <code>ListScans</code> or <code>GetScan</code>.</p>
|
|
1155
|
+
* @public
|
|
1156
1156
|
*/
|
|
1157
1157
|
resourceArn: string | undefined;
|
|
1158
1158
|
}
|
|
@@ -1161,7 +1161,6 @@ export interface ListTagsForResourceRequest {
|
|
|
1161
1161
|
*/
|
|
1162
1162
|
export interface ListTagsForResourceResponse {
|
|
1163
1163
|
/**
|
|
1164
|
-
* @public
|
|
1165
1164
|
* <p>An array of key-value pairs used to tag an existing scan. A tag is a custom attribute
|
|
1166
1165
|
* label with two parts:</p>
|
|
1167
1166
|
* <ul>
|
|
@@ -1175,6 +1174,7 @@ export interface ListTagsForResourceResponse {
|
|
|
1175
1174
|
* empty string. Tag values are case sensitive.</p>
|
|
1176
1175
|
* </li>
|
|
1177
1176
|
* </ul>
|
|
1177
|
+
* @public
|
|
1178
1178
|
*/
|
|
1179
1179
|
tags?: Record<string, string>;
|
|
1180
1180
|
}
|
|
@@ -1183,13 +1183,12 @@ export interface ListTagsForResourceResponse {
|
|
|
1183
1183
|
*/
|
|
1184
1184
|
export interface TagResourceRequest {
|
|
1185
1185
|
/**
|
|
1186
|
-
* @public
|
|
1187
1186
|
* <p>The ARN of the <code>ScanName</code> object. You can retrieve this ARN by calling
|
|
1188
1187
|
* <code>ListScans</code> or <code>GetScan</code>.</p>
|
|
1188
|
+
* @public
|
|
1189
1189
|
*/
|
|
1190
1190
|
resourceArn: string | undefined;
|
|
1191
1191
|
/**
|
|
1192
|
-
* @public
|
|
1193
1192
|
* <p>An array of key-value pairs used to tag an existing scan. A tag is a custom attribute
|
|
1194
1193
|
* label with two parts:</p>
|
|
1195
1194
|
* <ul>
|
|
@@ -1203,6 +1202,7 @@ export interface TagResourceRequest {
|
|
|
1203
1202
|
* empty string. Tag values are case sensitive.</p>
|
|
1204
1203
|
* </li>
|
|
1205
1204
|
* </ul>
|
|
1205
|
+
* @public
|
|
1206
1206
|
*/
|
|
1207
1207
|
tags: Record<string, string> | undefined;
|
|
1208
1208
|
}
|
|
@@ -1216,14 +1216,14 @@ export interface TagResourceResponse {
|
|
|
1216
1216
|
*/
|
|
1217
1217
|
export interface UntagResourceRequest {
|
|
1218
1218
|
/**
|
|
1219
|
-
* @public
|
|
1220
1219
|
* <p>The ARN of the <code>ScanName</code> object. You can retrieve this ARN by calling
|
|
1221
1220
|
* <code>ListScans</code> or <code>GetScan</code>.</p>
|
|
1221
|
+
* @public
|
|
1222
1222
|
*/
|
|
1223
1223
|
resourceArn: string | undefined;
|
|
1224
1224
|
/**
|
|
1225
|
-
* @public
|
|
1226
1225
|
* <p>A list of keys for each tag you want to remove from a scan.</p>
|
|
1226
|
+
* @public
|
|
1227
1227
|
*/
|
|
1228
1228
|
tagKeys: string[] | undefined;
|
|
1229
1229
|
}
|
|
@@ -1237,8 +1237,8 @@ export interface UntagResourceResponse {
|
|
|
1237
1237
|
*/
|
|
1238
1238
|
export interface UpdateAccountConfigurationRequest {
|
|
1239
1239
|
/**
|
|
1240
|
-
* @public
|
|
1241
1240
|
* <p>The KMS key ARN you want to use for encryption. Defaults to service-side encryption if missing.</p>
|
|
1241
|
+
* @public
|
|
1242
1242
|
*/
|
|
1243
1243
|
encryptionConfig: EncryptionConfig | undefined;
|
|
1244
1244
|
}
|
|
@@ -1247,9 +1247,9 @@ export interface UpdateAccountConfigurationRequest {
|
|
|
1247
1247
|
*/
|
|
1248
1248
|
export interface UpdateAccountConfigurationResponse {
|
|
1249
1249
|
/**
|
|
1250
|
-
* @public
|
|
1251
1250
|
* <p>An <code>EncryptionConfig</code> object that contains the KMS key ARN to use for
|
|
1252
1251
|
* encryption.</p>
|
|
1252
|
+
* @public
|
|
1253
1253
|
*/
|
|
1254
1254
|
encryptionConfig: EncryptionConfig | undefined;
|
|
1255
1255
|
}
|