@aws-sdk/client-codeguru-security 3.587.0 → 3.590.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 -2
- package/dist-cjs/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +1 -0
- package/dist-types/CodeGuruSecurity.d.ts +1 -2
- package/dist-types/CodeGuruSecurityClient.d.ts +5 -6
- package/dist-types/commands/BatchGetFindingsCommand.d.ts +1 -1
- package/dist-types/commands/CreateScanCommand.d.ts +1 -1
- package/dist-types/commands/CreateUploadUrlCommand.d.ts +3 -2
- package/dist-types/commands/GetAccountConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/GetMetricsSummaryCommand.d.ts +1 -1
- package/dist-types/commands/GetScanCommand.d.ts +4 -0
- package/dist-types/commands/ListScansCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAccountConfigurationCommand.d.ts +1 -1
- package/dist-types/index.d.ts +1 -2
- package/dist-types/models/models_0.d.ts +75 -57
- package/dist-types/runtimeConfig.native.d.ts +1 -1
- package/dist-types/ts3.4/CodeGuruSecurityClient.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +1 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -1
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -7,8 +7,7 @@
|
|
|
7
7
|
AWS SDK for JavaScript CodeGuruSecurity Client for Node.js, Browser and React Native.
|
|
8
8
|
|
|
9
9
|
<note>
|
|
10
|
-
<p>Amazon CodeGuru Security is in preview release and is subject to
|
|
11
|
-
change.</p>
|
|
10
|
+
<p>Amazon CodeGuru Security is in preview release and is subject to change.</p>
|
|
12
11
|
</note>
|
|
13
12
|
<p>This section provides documentation for the Amazon CodeGuru Security API operations.
|
|
14
13
|
CodeGuru Security is a service that uses program analysis and machine learning to detect
|
package/dist-cjs/index.js
CHANGED
|
@@ -691,6 +691,7 @@ var de_GetScanCommand = /* @__PURE__ */ __name(async (output, context) => {
|
|
|
691
691
|
const doc = (0, import_smithy_client.take)(data, {
|
|
692
692
|
analysisType: import_smithy_client.expectString,
|
|
693
693
|
createdAt: (_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))),
|
|
694
|
+
errorMessage: import_smithy_client.expectString,
|
|
694
695
|
numberOfRevisions: import_smithy_client.expectLong,
|
|
695
696
|
runId: import_smithy_client.expectString,
|
|
696
697
|
scanName: import_smithy_client.expectString,
|
|
@@ -276,6 +276,7 @@ export const de_GetScanCommand = async (output, context) => {
|
|
|
276
276
|
const doc = take(data, {
|
|
277
277
|
analysisType: __expectString,
|
|
278
278
|
createdAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
279
|
+
errorMessage: __expectString,
|
|
279
280
|
numberOfRevisions: __expectLong,
|
|
280
281
|
runId: __expectString,
|
|
281
282
|
scanName: __expectString,
|
|
@@ -97,8 +97,7 @@ export interface CodeGuruSecurity {
|
|
|
97
97
|
}
|
|
98
98
|
/**
|
|
99
99
|
* <note>
|
|
100
|
-
* <p>Amazon CodeGuru Security is in preview release and is subject to
|
|
101
|
-
* change.</p>
|
|
100
|
+
* <p>Amazon CodeGuru Security is in preview release and is subject to change.</p>
|
|
102
101
|
* </note>
|
|
103
102
|
* <p>This section provides documentation for the Amazon CodeGuru Security API operations.
|
|
104
103
|
* CodeGuru Security is a service that uses program analysis and machine learning to detect
|
|
@@ -103,15 +103,15 @@ export interface ClientDefaults extends Partial<__SmithyConfiguration<__HttpHand
|
|
|
103
103
|
* Enables FIPS compatible endpoints.
|
|
104
104
|
*/
|
|
105
105
|
useFipsEndpoint?: boolean | __Provider<boolean>;
|
|
106
|
+
/**
|
|
107
|
+
* The AWS region to which this client will send requests
|
|
108
|
+
*/
|
|
109
|
+
region?: string | __Provider<string>;
|
|
106
110
|
/**
|
|
107
111
|
* The provider populating default tracking information to be sent with `user-agent`, `x-amz-user-agent` header
|
|
108
112
|
* @internal
|
|
109
113
|
*/
|
|
110
114
|
defaultUserAgentProvider?: Provider<__UserAgent>;
|
|
111
|
-
/**
|
|
112
|
-
* The AWS region to which this client will send requests
|
|
113
|
-
*/
|
|
114
|
-
region?: string | __Provider<string>;
|
|
115
115
|
/**
|
|
116
116
|
* Default credentials provider; Not available in browser runtime.
|
|
117
117
|
* @deprecated
|
|
@@ -165,8 +165,7 @@ export interface CodeGuruSecurityClientResolvedConfig extends CodeGuruSecurityCl
|
|
|
165
165
|
}
|
|
166
166
|
/**
|
|
167
167
|
* <note>
|
|
168
|
-
* <p>Amazon CodeGuru Security is in preview release and is subject to
|
|
169
|
-
* change.</p>
|
|
168
|
+
* <p>Amazon CodeGuru Security is in preview release and is subject to change.</p>
|
|
170
169
|
* </note>
|
|
171
170
|
* <p>This section provides documentation for the Amazon CodeGuru Security API operations.
|
|
172
171
|
* CodeGuru Security is a service that uses program analysis and machine learning to detect
|
|
@@ -26,7 +26,7 @@ declare const BatchGetFindingsCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Returns a list of
|
|
29
|
+
* <p>Returns a list of requested findings from standard scans.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -26,7 +26,7 @@ declare const CreateScanCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Use to create a scan using code uploaded to an S3 bucket.</p>
|
|
29
|
+
* <p>Use to create a scan using code uploaded to an Amazon S3 bucket.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -26,8 +26,9 @@ declare const CreateUploadUrlCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Generates a pre-signed URL
|
|
30
|
-
*
|
|
29
|
+
* <p>Generates a pre-signed URL, request headers used to upload a code resource, and code
|
|
30
|
+
* artifact identifier for the uploaded resource.</p>
|
|
31
|
+
* <p>You can upload your code resource to the URL with the request headers using any HTTP
|
|
31
32
|
* client.</p>
|
|
32
33
|
* @example
|
|
33
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -26,7 +26,7 @@ declare const GetAccountConfigurationCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Use to get
|
|
29
|
+
* <p>Use to get the encryption configuration for an account.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -26,7 +26,7 @@ declare const GetMetricsSummaryCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Returns
|
|
29
|
+
* <p>Returns a summary of metrics for an account from a specified date, including number of open
|
|
30
30
|
* findings, the categories with most findings, the scans with most open findings, and scans with
|
|
31
31
|
* most open critical findings. </p>
|
|
32
32
|
* @example
|
|
@@ -48,6 +48,7 @@ declare const GetScanCommand_base: {
|
|
|
48
48
|
* // updatedAt: new Date("TIMESTAMP"),
|
|
49
49
|
* // numberOfRevisions: Number("long"),
|
|
50
50
|
* // scanNameArn: "STRING_VALUE",
|
|
51
|
+
* // errorMessage: "STRING_VALUE",
|
|
51
52
|
* // };
|
|
52
53
|
*
|
|
53
54
|
* ```
|
|
@@ -70,6 +71,9 @@ declare const GetScanCommand_base: {
|
|
|
70
71
|
* @throws {@link ThrottlingException} (client fault)
|
|
71
72
|
* <p>The request was denied due to request throttling.</p>
|
|
72
73
|
*
|
|
74
|
+
* @throws {@link ValidationException} (client fault)
|
|
75
|
+
* <p>The input fails to satisfy the specified constraints.</p>
|
|
76
|
+
*
|
|
73
77
|
* @throws {@link CodeGuruSecurityServiceException}
|
|
74
78
|
* <p>Base exception class for all service exceptions from CodeGuruSecurity service.</p>
|
|
75
79
|
*
|
|
@@ -26,7 +26,7 @@ declare const ListScansCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Returns a list of all
|
|
29
|
+
* <p>Returns a list of all scans in an account. Does not return <code>EXPRESS</code>
|
|
30
30
|
* scans.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -26,7 +26,7 @@ declare const UpdateAccountConfigurationCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Use to update
|
|
29
|
+
* <p>Use to update the encryption configuration for an account.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
package/dist-types/index.d.ts
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* <note>
|
|
3
|
-
* <p>Amazon CodeGuru Security is in preview release and is subject to
|
|
4
|
-
* change.</p>
|
|
3
|
+
* <p>Amazon CodeGuru Security is in preview release and is subject to change.</p>
|
|
5
4
|
* </note>
|
|
6
5
|
* <p>This section provides documentation for the Amazon CodeGuru Security API operations.
|
|
7
6
|
* CodeGuru Security is a service that uses program analysis and machine learning to detect
|
|
@@ -28,64 +28,65 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
28
28
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
29
29
|
}
|
|
30
30
|
/**
|
|
31
|
-
* <p>
|
|
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>
|
|
32
33
|
* @public
|
|
33
34
|
*/
|
|
34
35
|
export interface FindingMetricsValuePerSeverity {
|
|
35
36
|
/**
|
|
36
|
-
* <p>
|
|
37
|
-
* actionable.</p>
|
|
37
|
+
* <p>A numeric value corresponding to an informational finding.</p>
|
|
38
38
|
* @public
|
|
39
39
|
*/
|
|
40
40
|
info?: number;
|
|
41
41
|
/**
|
|
42
|
-
* <p>
|
|
42
|
+
* <p>A numeric value corresponding to a low severity finding.</p>
|
|
43
43
|
* @public
|
|
44
44
|
*/
|
|
45
45
|
low?: number;
|
|
46
46
|
/**
|
|
47
|
-
* <p>
|
|
47
|
+
* <p>A numeric value corresponding to a medium severity finding.</p>
|
|
48
48
|
* @public
|
|
49
49
|
*/
|
|
50
50
|
medium?: number;
|
|
51
51
|
/**
|
|
52
|
-
* <p>
|
|
52
|
+
* <p>A numeric value corresponding to a high severity finding.</p>
|
|
53
53
|
* @public
|
|
54
54
|
*/
|
|
55
55
|
high?: number;
|
|
56
56
|
/**
|
|
57
|
-
* <p>
|
|
57
|
+
* <p>A numeric value corresponding to a critical finding.</p>
|
|
58
58
|
* @public
|
|
59
59
|
*/
|
|
60
60
|
critical?: number;
|
|
61
61
|
}
|
|
62
62
|
/**
|
|
63
|
-
* <p>A summary of findings metrics
|
|
63
|
+
* <p>A summary of findings metrics for an account on a specified date.</p>
|
|
64
64
|
* @public
|
|
65
65
|
*/
|
|
66
66
|
export interface AccountFindingsMetric {
|
|
67
67
|
/**
|
|
68
|
-
* <p>The date from which the
|
|
68
|
+
* <p>The date from which the findings metrics were retrieved.</p>
|
|
69
69
|
* @public
|
|
70
70
|
*/
|
|
71
71
|
date?: Date;
|
|
72
72
|
/**
|
|
73
|
-
* <p>The number of new findings of each severity
|
|
73
|
+
* <p>The number of new findings of each severity on the specified date.</p>
|
|
74
74
|
* @public
|
|
75
75
|
*/
|
|
76
76
|
newFindings?: FindingMetricsValuePerSeverity;
|
|
77
77
|
/**
|
|
78
|
-
* <p>The number of closed findings of each severity
|
|
78
|
+
* <p>The number of closed findings of each severity on the specified date.</p>
|
|
79
79
|
* @public
|
|
80
80
|
*/
|
|
81
81
|
closedFindings?: FindingMetricsValuePerSeverity;
|
|
82
82
|
/**
|
|
83
|
-
* <p>The number of open findings of each severity
|
|
83
|
+
* <p>The number of open findings of each severity as of the specified date.</p>
|
|
84
84
|
* @public
|
|
85
85
|
*/
|
|
86
86
|
openFindings?: FindingMetricsValuePerSeverity;
|
|
87
87
|
/**
|
|
88
|
-
* <p>The average time it takes to close findings of each severity
|
|
88
|
+
* <p>The average time in days it takes to close findings of each severity as of a specified
|
|
89
|
+
* date.</p>
|
|
89
90
|
* @public
|
|
90
91
|
*/
|
|
91
92
|
meanTimeToClose?: FindingMetricsValuePerSeverity;
|
|
@@ -198,7 +199,7 @@ export interface SuggestedFix {
|
|
|
198
199
|
*/
|
|
199
200
|
description?: string;
|
|
200
201
|
/**
|
|
201
|
-
* <p>The suggested code
|
|
202
|
+
* <p>The suggested code fix. If applicable, includes code patch to replace your source code. </p>
|
|
202
203
|
* @public
|
|
203
204
|
*/
|
|
204
205
|
code?: string;
|
|
@@ -221,18 +222,17 @@ export interface Remediation {
|
|
|
221
222
|
suggestedFixes?: SuggestedFix[];
|
|
222
223
|
}
|
|
223
224
|
/**
|
|
224
|
-
* <p>Information about a resource
|
|
225
|
-
* contains a finding.</p>
|
|
225
|
+
* <p>Information about a resource that contains a finding.</p>
|
|
226
226
|
* @public
|
|
227
227
|
*/
|
|
228
228
|
export interface Resource {
|
|
229
229
|
/**
|
|
230
|
-
* <p>The
|
|
230
|
+
* <p>The <code>scanName</code> of the scan that was run on the resource.</p>
|
|
231
231
|
* @public
|
|
232
232
|
*/
|
|
233
233
|
id?: string;
|
|
234
234
|
/**
|
|
235
|
-
* <p>The identifier for a section of the resource
|
|
235
|
+
* <p>The identifier for a section of the resource.</p>
|
|
236
236
|
* @public
|
|
237
237
|
*/
|
|
238
238
|
subResourceId?: string;
|
|
@@ -342,7 +342,9 @@ export interface Vulnerability {
|
|
|
342
342
|
*/
|
|
343
343
|
filePath?: FilePath;
|
|
344
344
|
/**
|
|
345
|
-
*
|
|
345
|
+
* @deprecated
|
|
346
|
+
*
|
|
347
|
+
* <p>The number of times the vulnerability appears in your code.</p>
|
|
346
348
|
* @public
|
|
347
349
|
*/
|
|
348
350
|
itemCount?: number;
|
|
@@ -363,8 +365,7 @@ export interface Finding {
|
|
|
363
365
|
*/
|
|
364
366
|
description?: string;
|
|
365
367
|
/**
|
|
366
|
-
* <p>The identifier for the component that generated a finding such as
|
|
367
|
-
* AWSInspector.</p>
|
|
368
|
+
* <p>The identifier for the component that generated a finding such as AmazonCodeGuruSecurity.</p>
|
|
368
369
|
* @public
|
|
369
370
|
*/
|
|
370
371
|
generatorId?: string;
|
|
@@ -400,7 +401,10 @@ export interface Finding {
|
|
|
400
401
|
*/
|
|
401
402
|
vulnerability?: Vulnerability;
|
|
402
403
|
/**
|
|
403
|
-
* <p>The severity of the finding
|
|
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>
|
|
404
408
|
* @public
|
|
405
409
|
*/
|
|
406
410
|
severity?: Severity;
|
|
@@ -443,7 +447,7 @@ export interface Finding {
|
|
|
443
447
|
*/
|
|
444
448
|
export interface BatchGetFindingsResponse {
|
|
445
449
|
/**
|
|
446
|
-
* <p> A list of all
|
|
450
|
+
* <p> A list of all findings which were successfully fetched.</p>
|
|
447
451
|
* @public
|
|
448
452
|
*/
|
|
449
453
|
findings: Finding[] | undefined;
|
|
@@ -591,7 +595,8 @@ export declare class ConflictException extends __BaseException {
|
|
|
591
595
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
592
596
|
}
|
|
593
597
|
/**
|
|
594
|
-
* <p>The identifier for a resource object that contains resources
|
|
598
|
+
* <p>The identifier for a resource object that contains resources to scan. Specifying a
|
|
599
|
+
* codeArtifactId is required to create a scan.</p>
|
|
595
600
|
* @public
|
|
596
601
|
*/
|
|
597
602
|
export type ResourceId = ResourceId.CodeArtifactIdMember | ResourceId.$UnknownMember;
|
|
@@ -600,7 +605,8 @@ export type ResourceId = ResourceId.CodeArtifactIdMember | ResourceId.$UnknownMe
|
|
|
600
605
|
*/
|
|
601
606
|
export declare namespace ResourceId {
|
|
602
607
|
/**
|
|
603
|
-
* <p>The identifier for the code file uploaded to the resource
|
|
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>
|
|
604
610
|
* @public
|
|
605
611
|
*/
|
|
606
612
|
interface CodeArtifactIdMember {
|
|
@@ -643,14 +649,13 @@ export interface CreateScanRequest {
|
|
|
643
649
|
*/
|
|
644
650
|
clientToken?: string;
|
|
645
651
|
/**
|
|
646
|
-
* <p>The identifier for
|
|
652
|
+
* <p>The identifier for the resource object to be scanned.</p>
|
|
647
653
|
* @public
|
|
648
654
|
*/
|
|
649
655
|
resourceId: ResourceId | undefined;
|
|
650
656
|
/**
|
|
651
|
-
* <p>The unique name that CodeGuru Security uses to track revisions across multiple
|
|
652
|
-
*
|
|
653
|
-
* specified, it will be auto generated. </p>
|
|
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>
|
|
654
659
|
* @public
|
|
655
660
|
*/
|
|
656
661
|
scanName: string | undefined;
|
|
@@ -778,7 +783,7 @@ export interface CreateUploadUrlRequest {
|
|
|
778
783
|
*/
|
|
779
784
|
export interface CreateUploadUrlResponse {
|
|
780
785
|
/**
|
|
781
|
-
* <p>A pre-signed S3 URL. You can upload the code file you want to scan
|
|
786
|
+
* <p>A pre-signed S3 URL. You can upload the code file you want to scan with the required
|
|
782
787
|
* <code>requestHeaders</code> using any HTTP client.</p>
|
|
783
788
|
* @public
|
|
784
789
|
*/
|
|
@@ -790,7 +795,8 @@ export interface CreateUploadUrlResponse {
|
|
|
790
795
|
*/
|
|
791
796
|
requestHeaders: Record<string, string> | undefined;
|
|
792
797
|
/**
|
|
793
|
-
* <p>The identifier for the uploaded code resource. </
|
|
798
|
+
* <p>The identifier for the uploaded code resource. Pass this to <code>CreateScan</code> to use
|
|
799
|
+
* the uploaded resources.</p>
|
|
794
800
|
* @public
|
|
795
801
|
*/
|
|
796
802
|
codeArtifactId: string | undefined;
|
|
@@ -801,13 +807,14 @@ export interface CreateUploadUrlResponse {
|
|
|
801
807
|
export interface GetAccountConfigurationRequest {
|
|
802
808
|
}
|
|
803
809
|
/**
|
|
804
|
-
* <p>Information about account
|
|
810
|
+
* <p>Information about the encryption configuration for an account. Required to call
|
|
811
|
+
* <code>UpdateAccountConfiguration</code>.</p>
|
|
805
812
|
* @public
|
|
806
813
|
*/
|
|
807
814
|
export interface EncryptionConfig {
|
|
808
815
|
/**
|
|
809
|
-
* <p>The KMS key ARN
|
|
810
|
-
*
|
|
816
|
+
* <p>The KMS key ARN that is used for encryption. If an AWS-managed key is used for encryption,
|
|
817
|
+
* returns empty.</p>
|
|
811
818
|
* @public
|
|
812
819
|
*/
|
|
813
820
|
kmsKeyArn?: string;
|
|
@@ -817,9 +824,10 @@ export interface EncryptionConfig {
|
|
|
817
824
|
*/
|
|
818
825
|
export interface GetAccountConfigurationResponse {
|
|
819
826
|
/**
|
|
820
|
-
* <p>An <code>EncryptionConfig</code> object that contains the KMS key ARN
|
|
827
|
+
* <p>An <code>EncryptionConfig</code> object that contains the KMS key ARN that is used for
|
|
821
828
|
* encryption. By default, CodeGuru Security uses an AWS-managed key for encryption. To specify
|
|
822
|
-
* your own key, call <code>UpdateAccountConfiguration</code
|
|
829
|
+
* your own key, call <code>UpdateAccountConfiguration</code>. If you do not specify a
|
|
830
|
+
* customer-managed key, returns empty.</p>
|
|
823
831
|
* @public
|
|
824
832
|
*/
|
|
825
833
|
encryptionConfig: EncryptionConfig | undefined;
|
|
@@ -844,7 +852,7 @@ export interface GetFindingsRequest {
|
|
|
844
852
|
* <p>The maximum number of results to return in the response. Use this parameter when
|
|
845
853
|
* paginating results. If additional results exist beyond the number you specify, the <code>nextToken</code>
|
|
846
854
|
* element is returned in the response. Use <code>nextToken</code> in a subsequent request to retrieve
|
|
847
|
-
* additional results.</p>
|
|
855
|
+
* additional results. If not specified, returns 1000 results.</p>
|
|
848
856
|
* @public
|
|
849
857
|
*/
|
|
850
858
|
maxResults?: number;
|
|
@@ -877,8 +885,7 @@ export interface GetFindingsResponse {
|
|
|
877
885
|
export interface GetMetricsSummaryRequest {
|
|
878
886
|
/**
|
|
879
887
|
* <p>The date you want to retrieve summary metrics from, rounded to the nearest day. The date
|
|
880
|
-
* must be within the past two years
|
|
881
|
-
* outside of this range is passed, the response will be empty.</p>
|
|
888
|
+
* must be within the past two years.</p>
|
|
882
889
|
* @public
|
|
883
890
|
*/
|
|
884
891
|
date: Date | undefined;
|
|
@@ -901,7 +908,7 @@ export interface CategoryWithFindingNum {
|
|
|
901
908
|
findingNumber?: number;
|
|
902
909
|
}
|
|
903
910
|
/**
|
|
904
|
-
* <p>Information about
|
|
911
|
+
* <p>Information about the number of findings generated by a scan.</p>
|
|
905
912
|
* @public
|
|
906
913
|
*/
|
|
907
914
|
export interface ScanNameWithFindingNum {
|
|
@@ -911,13 +918,13 @@ export interface ScanNameWithFindingNum {
|
|
|
911
918
|
*/
|
|
912
919
|
scanName?: string;
|
|
913
920
|
/**
|
|
914
|
-
* <p>The number of
|
|
921
|
+
* <p>The number of findings generated by a scan.</p>
|
|
915
922
|
* @public
|
|
916
923
|
*/
|
|
917
924
|
findingNumber?: number;
|
|
918
925
|
}
|
|
919
926
|
/**
|
|
920
|
-
* <p>
|
|
927
|
+
* <p>A summary of metrics for an account as of a specified date.</p>
|
|
921
928
|
* @public
|
|
922
929
|
*/
|
|
923
930
|
export interface MetricsSummary {
|
|
@@ -927,25 +934,25 @@ export interface MetricsSummary {
|
|
|
927
934
|
*/
|
|
928
935
|
date?: Date;
|
|
929
936
|
/**
|
|
930
|
-
* <p>The number of open findings of each severity
|
|
937
|
+
* <p>The number of open findings of each severity.</p>
|
|
931
938
|
* @public
|
|
932
939
|
*/
|
|
933
940
|
openFindings?: FindingMetricsValuePerSeverity;
|
|
934
941
|
/**
|
|
935
942
|
* <p>A list of <code>CategoryWithFindingNum</code> objects for the top 5 finding categories
|
|
936
|
-
* with the most
|
|
943
|
+
* with the most findings.</p>
|
|
937
944
|
* @public
|
|
938
945
|
*/
|
|
939
946
|
categoriesWithMostFindings?: CategoryWithFindingNum[];
|
|
940
947
|
/**
|
|
941
948
|
* <p>A list of <code>ScanNameWithFindingNum</code> objects for the top 3 scans with the most
|
|
942
|
-
* number of open
|
|
949
|
+
* number of open findings.</p>
|
|
943
950
|
* @public
|
|
944
951
|
*/
|
|
945
952
|
scansWithMostOpenFindings?: ScanNameWithFindingNum[];
|
|
946
953
|
/**
|
|
947
954
|
* <p>A list of <code>ScanNameWithFindingNum</code> objects for the top 3 scans with the most
|
|
948
|
-
* number of open findings
|
|
955
|
+
* number of open critical findings.</p>
|
|
949
956
|
* @public
|
|
950
957
|
*/
|
|
951
958
|
scansWithMostOpenCriticalFindings?: ScanNameWithFindingNum[];
|
|
@@ -991,7 +998,7 @@ export interface GetScanResponse {
|
|
|
991
998
|
*/
|
|
992
999
|
runId: string | undefined;
|
|
993
1000
|
/**
|
|
994
|
-
* <p>The current state of the scan.
|
|
1001
|
+
* <p>The current state of the scan. Returns either <code>InProgress</code>,
|
|
995
1002
|
* <code>Successful</code>, or <code>Failed</code>.</p>
|
|
996
1003
|
* @public
|
|
997
1004
|
*/
|
|
@@ -1024,6 +1031,11 @@ export interface GetScanResponse {
|
|
|
1024
1031
|
* @public
|
|
1025
1032
|
*/
|
|
1026
1033
|
scanNameArn?: string;
|
|
1034
|
+
/**
|
|
1035
|
+
* <p>Details about the error that causes a scan to fail to be retrieved.</p>
|
|
1036
|
+
* @public
|
|
1037
|
+
*/
|
|
1038
|
+
errorMessage?: string;
|
|
1027
1039
|
}
|
|
1028
1040
|
/**
|
|
1029
1041
|
* @public
|
|
@@ -1041,17 +1053,19 @@ export interface ListFindingsMetricsRequest {
|
|
|
1041
1053
|
* <p>The maximum number of results to return in the response. Use this parameter when
|
|
1042
1054
|
* paginating results. If additional results exist beyond the number you specify, the <code>nextToken</code>
|
|
1043
1055
|
* element is returned in the response. Use <code>nextToken</code> in a subsequent request to retrieve
|
|
1044
|
-
* additional results.</p>
|
|
1056
|
+
* additional results. If not specified, returns 1000 results.</p>
|
|
1045
1057
|
* @public
|
|
1046
1058
|
*/
|
|
1047
1059
|
maxResults?: number;
|
|
1048
1060
|
/**
|
|
1049
|
-
* <p>The start date of the interval which you want to retrieve metrics from
|
|
1061
|
+
* <p>The start date of the interval which you want to retrieve metrics from. Rounds to the
|
|
1062
|
+
* nearest day.</p>
|
|
1050
1063
|
* @public
|
|
1051
1064
|
*/
|
|
1052
1065
|
startDate: Date | undefined;
|
|
1053
1066
|
/**
|
|
1054
|
-
* <p>The end date of the interval which you want to retrieve metrics from
|
|
1067
|
+
* <p>The end date of the interval which you want to retrieve metrics from. Round to the nearest
|
|
1068
|
+
* day.</p>
|
|
1055
1069
|
* @public
|
|
1056
1070
|
*/
|
|
1057
1071
|
endDate: Date | undefined;
|
|
@@ -1087,7 +1101,7 @@ export interface ListScansRequest {
|
|
|
1087
1101
|
* <p>The maximum number of results to return in the response. Use this parameter when
|
|
1088
1102
|
* paginating results. If additional results exist beyond the number you specify, the <code>nextToken</code>
|
|
1089
1103
|
* element is returned in the response. Use <code>nextToken</code> in a subsequent request to retrieve
|
|
1090
|
-
* additional results.</p>
|
|
1104
|
+
* additional results. If not specified, returns 100 results.</p>
|
|
1091
1105
|
* @public
|
|
1092
1106
|
*/
|
|
1093
1107
|
maxResults?: number;
|
|
@@ -1151,7 +1165,7 @@ export interface ListScansResponse {
|
|
|
1151
1165
|
export interface ListTagsForResourceRequest {
|
|
1152
1166
|
/**
|
|
1153
1167
|
* <p>The ARN of the <code>ScanName</code> object. You can retrieve this ARN by calling
|
|
1154
|
-
* <code>ListScans</code
|
|
1168
|
+
* <code>CreateScan</code>, <code>ListScans</code>, or <code>GetScan</code>.</p>
|
|
1155
1169
|
* @public
|
|
1156
1170
|
*/
|
|
1157
1171
|
resourceArn: string | undefined;
|
|
@@ -1184,7 +1198,7 @@ export interface ListTagsForResourceResponse {
|
|
|
1184
1198
|
export interface TagResourceRequest {
|
|
1185
1199
|
/**
|
|
1186
1200
|
* <p>The ARN of the <code>ScanName</code> object. You can retrieve this ARN by calling
|
|
1187
|
-
*
|
|
1201
|
+
* <code>CreateScan</code>, <code>ListScans</code>, or <code>GetScan</code>.</p>
|
|
1188
1202
|
* @public
|
|
1189
1203
|
*/
|
|
1190
1204
|
resourceArn: string | undefined;
|
|
@@ -1217,7 +1231,7 @@ export interface TagResourceResponse {
|
|
|
1217
1231
|
export interface UntagResourceRequest {
|
|
1218
1232
|
/**
|
|
1219
1233
|
* <p>The ARN of the <code>ScanName</code> object. You can retrieve this ARN by calling
|
|
1220
|
-
*
|
|
1234
|
+
* <code>CreateScan</code>, <code>ListScans</code>, or <code>GetScan</code>.</p>
|
|
1221
1235
|
* @public
|
|
1222
1236
|
*/
|
|
1223
1237
|
resourceArn: string | undefined;
|
|
@@ -1237,7 +1251,10 @@ export interface UntagResourceResponse {
|
|
|
1237
1251
|
*/
|
|
1238
1252
|
export interface UpdateAccountConfigurationRequest {
|
|
1239
1253
|
/**
|
|
1240
|
-
* <p>The KMS key ARN you want to use for encryption.
|
|
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>
|
|
1241
1258
|
* @public
|
|
1242
1259
|
*/
|
|
1243
1260
|
encryptionConfig: EncryptionConfig | undefined;
|
|
@@ -1247,8 +1264,9 @@ export interface UpdateAccountConfigurationRequest {
|
|
|
1247
1264
|
*/
|
|
1248
1265
|
export interface UpdateAccountConfigurationResponse {
|
|
1249
1266
|
/**
|
|
1250
|
-
* <p>An <code>EncryptionConfig</code> object that contains the KMS key ARN
|
|
1251
|
-
* encryption
|
|
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>
|
|
1252
1270
|
* @public
|
|
1253
1271
|
*/
|
|
1254
1272
|
encryptionConfig: EncryptionConfig | undefined;
|
|
@@ -18,8 +18,8 @@ export declare const getRuntimeConfig: (config: CodeGuruSecurityClientConfig) =>
|
|
|
18
18
|
serviceId: string;
|
|
19
19
|
useDualstackEndpoint: boolean | import("@smithy/types").Provider<boolean>;
|
|
20
20
|
useFipsEndpoint: boolean | import("@smithy/types").Provider<boolean>;
|
|
21
|
-
defaultUserAgentProvider: import("@smithy/types").Provider<import("@smithy/types").UserAgent>;
|
|
22
21
|
region: string | import("@smithy/types").Provider<any>;
|
|
22
|
+
defaultUserAgentProvider: import("@smithy/types").Provider<import("@smithy/types").UserAgent>;
|
|
23
23
|
credentialDefaultProvider: (input: any) => import("@smithy/types").AwsCredentialIdentityProvider;
|
|
24
24
|
maxAttempts: number | import("@smithy/types").Provider<number>;
|
|
25
25
|
retryMode: string | import("@smithy/types").Provider<string>;
|
|
@@ -148,8 +148,8 @@ export interface ClientDefaults
|
|
|
148
148
|
serviceId?: string;
|
|
149
149
|
useDualstackEndpoint?: boolean | __Provider<boolean>;
|
|
150
150
|
useFipsEndpoint?: boolean | __Provider<boolean>;
|
|
151
|
-
defaultUserAgentProvider?: Provider<__UserAgent>;
|
|
152
151
|
region?: string | __Provider<string>;
|
|
152
|
+
defaultUserAgentProvider?: Provider<__UserAgent>;
|
|
153
153
|
credentialDefaultProvider?: (input: any) => AwsCredentialIdentityProvider;
|
|
154
154
|
maxAttempts?: number | __Provider<number>;
|
|
155
155
|
retryMode?: string | __Provider<string>;
|
|
@@ -22,10 +22,10 @@ export declare const getRuntimeConfig: (
|
|
|
22
22
|
serviceId: string;
|
|
23
23
|
useDualstackEndpoint: boolean | import("@smithy/types").Provider<boolean>;
|
|
24
24
|
useFipsEndpoint: boolean | import("@smithy/types").Provider<boolean>;
|
|
25
|
+
region: string | import("@smithy/types").Provider<any>;
|
|
25
26
|
defaultUserAgentProvider: import("@smithy/types").Provider<
|
|
26
27
|
import("@smithy/types").UserAgent
|
|
27
28
|
>;
|
|
28
|
-
region: string | import("@smithy/types").Provider<any>;
|
|
29
29
|
credentialDefaultProvider: (
|
|
30
30
|
input: any
|
|
31
31
|
) => import("@smithy/types").AwsCredentialIdentityProvider;
|
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.590.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,10 +20,10 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
23
|
-
"@aws-sdk/client-sso-oidc": "3.
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/core": "3.
|
|
26
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
23
|
+
"@aws-sdk/client-sso-oidc": "3.590.0",
|
|
24
|
+
"@aws-sdk/client-sts": "3.590.0",
|
|
25
|
+
"@aws-sdk/core": "3.588.0",
|
|
26
|
+
"@aws-sdk/credential-provider-node": "3.590.0",
|
|
27
27
|
"@aws-sdk/middleware-host-header": "3.577.0",
|
|
28
28
|
"@aws-sdk/middleware-logger": "3.577.0",
|
|
29
29
|
"@aws-sdk/middleware-recursion-detection": "3.577.0",
|