aws-sdk-codegurusecurity 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-codegurusecurity/client.rb +1060 -0
- data/lib/aws-sdk-codegurusecurity/client_api.rb +605 -0
- data/lib/aws-sdk-codegurusecurity/customizations.rb +0 -0
- data/lib/aws-sdk-codegurusecurity/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-codegurusecurity/endpoint_provider.rb +54 -0
- data/lib/aws-sdk-codegurusecurity/endpoints.rb +197 -0
- data/lib/aws-sdk-codegurusecurity/errors.rb +226 -0
- data/lib/aws-sdk-codegurusecurity/plugins/endpoints.rb +94 -0
- data/lib/aws-sdk-codegurusecurity/resource.rb +26 -0
- data/lib/aws-sdk-codegurusecurity/types.rb +1311 -0
- data/lib/aws-sdk-codegurusecurity.rb +57 -0
- metadata +94 -0
@@ -0,0 +1,1311 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::CodeGuruSecurity
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# You do not have sufficient access to perform this action.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] error_code
|
16
|
+
# The identifier for the error.
|
17
|
+
# @return [String]
|
18
|
+
#
|
19
|
+
# @!attribute [rw] message
|
20
|
+
# Description of the error.
|
21
|
+
# @return [String]
|
22
|
+
#
|
23
|
+
# @!attribute [rw] resource_id
|
24
|
+
# The identifier for the resource you don't have access to.
|
25
|
+
# @return [String]
|
26
|
+
#
|
27
|
+
# @!attribute [rw] resource_type
|
28
|
+
# The type of resource you don't have access to.
|
29
|
+
# @return [String]
|
30
|
+
#
|
31
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/AccessDeniedException AWS API Documentation
|
32
|
+
#
|
33
|
+
class AccessDeniedException < Struct.new(
|
34
|
+
:error_code,
|
35
|
+
:message,
|
36
|
+
:resource_id,
|
37
|
+
:resource_type)
|
38
|
+
SENSITIVE = []
|
39
|
+
include Aws::Structure
|
40
|
+
end
|
41
|
+
|
42
|
+
# A summary of findings metrics in an account.
|
43
|
+
#
|
44
|
+
# @!attribute [rw] closed_findings
|
45
|
+
# The number of closed findings of each severity in an account on the
|
46
|
+
# specified date.
|
47
|
+
# @return [Types::FindingMetricsValuePerSeverity]
|
48
|
+
#
|
49
|
+
# @!attribute [rw] date
|
50
|
+
# The date from which the finding metrics were retrieved.
|
51
|
+
# @return [Time]
|
52
|
+
#
|
53
|
+
# @!attribute [rw] mean_time_to_close
|
54
|
+
# The average time it takes to close findings of each severity in
|
55
|
+
# days.
|
56
|
+
# @return [Types::FindingMetricsValuePerSeverity]
|
57
|
+
#
|
58
|
+
# @!attribute [rw] new_findings
|
59
|
+
# The number of new findings of each severity in account on the
|
60
|
+
# specified date.
|
61
|
+
# @return [Types::FindingMetricsValuePerSeverity]
|
62
|
+
#
|
63
|
+
# @!attribute [rw] open_findings
|
64
|
+
# The number of open findings of each severity in an account as of the
|
65
|
+
# specified date.
|
66
|
+
# @return [Types::FindingMetricsValuePerSeverity]
|
67
|
+
#
|
68
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/AccountFindingsMetric AWS API Documentation
|
69
|
+
#
|
70
|
+
class AccountFindingsMetric < Struct.new(
|
71
|
+
:closed_findings,
|
72
|
+
:date,
|
73
|
+
:mean_time_to_close,
|
74
|
+
:new_findings,
|
75
|
+
:open_findings)
|
76
|
+
SENSITIVE = []
|
77
|
+
include Aws::Structure
|
78
|
+
end
|
79
|
+
|
80
|
+
# Contains information about the error that caused a finding to fail to
|
81
|
+
# be retrieved.
|
82
|
+
#
|
83
|
+
# @!attribute [rw] error_code
|
84
|
+
# A code associated with the type of error.
|
85
|
+
# @return [String]
|
86
|
+
#
|
87
|
+
# @!attribute [rw] finding_id
|
88
|
+
# The finding ID of the finding that was not fetched.
|
89
|
+
# @return [String]
|
90
|
+
#
|
91
|
+
# @!attribute [rw] message
|
92
|
+
# Describes the error.
|
93
|
+
# @return [String]
|
94
|
+
#
|
95
|
+
# @!attribute [rw] scan_name
|
96
|
+
# The name of the scan that generated the finding.
|
97
|
+
# @return [String]
|
98
|
+
#
|
99
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/BatchGetFindingsError AWS API Documentation
|
100
|
+
#
|
101
|
+
class BatchGetFindingsError < Struct.new(
|
102
|
+
:error_code,
|
103
|
+
:finding_id,
|
104
|
+
:message,
|
105
|
+
:scan_name)
|
106
|
+
SENSITIVE = []
|
107
|
+
include Aws::Structure
|
108
|
+
end
|
109
|
+
|
110
|
+
# @!attribute [rw] finding_identifiers
|
111
|
+
# A list of finding identifiers. Each identifier consists of a
|
112
|
+
# `scanName` and a `findingId`. You retrieve the `findingId` when you
|
113
|
+
# call `GetFindings`.
|
114
|
+
# @return [Array<Types::FindingIdentifier>]
|
115
|
+
#
|
116
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/BatchGetFindingsRequest AWS API Documentation
|
117
|
+
#
|
118
|
+
class BatchGetFindingsRequest < Struct.new(
|
119
|
+
:finding_identifiers)
|
120
|
+
SENSITIVE = []
|
121
|
+
include Aws::Structure
|
122
|
+
end
|
123
|
+
|
124
|
+
# @!attribute [rw] failed_findings
|
125
|
+
# A list of errors for individual findings which were not fetched.
|
126
|
+
# Each BatchGetFindingsError contains the `scanName`, `findingId`,
|
127
|
+
# `errorCode` and error `message`.
|
128
|
+
# @return [Array<Types::BatchGetFindingsError>]
|
129
|
+
#
|
130
|
+
# @!attribute [rw] findings
|
131
|
+
# A list of all requested findings.
|
132
|
+
# @return [Array<Types::Finding>]
|
133
|
+
#
|
134
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/BatchGetFindingsResponse AWS API Documentation
|
135
|
+
#
|
136
|
+
class BatchGetFindingsResponse < Struct.new(
|
137
|
+
:failed_findings,
|
138
|
+
:findings)
|
139
|
+
SENSITIVE = []
|
140
|
+
include Aws::Structure
|
141
|
+
end
|
142
|
+
|
143
|
+
# Information about a finding category with open findings.
|
144
|
+
#
|
145
|
+
# @!attribute [rw] category_name
|
146
|
+
# The name of the finding category. A finding category is determined
|
147
|
+
# by the detector that detected the finding.
|
148
|
+
# @return [String]
|
149
|
+
#
|
150
|
+
# @!attribute [rw] finding_number
|
151
|
+
# The number of open findings in the category.
|
152
|
+
# @return [Integer]
|
153
|
+
#
|
154
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/CategoryWithFindingNum AWS API Documentation
|
155
|
+
#
|
156
|
+
class CategoryWithFindingNum < Struct.new(
|
157
|
+
:category_name,
|
158
|
+
:finding_number)
|
159
|
+
SENSITIVE = []
|
160
|
+
include Aws::Structure
|
161
|
+
end
|
162
|
+
|
163
|
+
# The line of code where a finding was detected.
|
164
|
+
#
|
165
|
+
# @!attribute [rw] content
|
166
|
+
# The code that contains a vulnerability.
|
167
|
+
# @return [String]
|
168
|
+
#
|
169
|
+
# @!attribute [rw] number
|
170
|
+
# The code line number.
|
171
|
+
# @return [Integer]
|
172
|
+
#
|
173
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/CodeLine AWS API Documentation
|
174
|
+
#
|
175
|
+
class CodeLine < Struct.new(
|
176
|
+
:content,
|
177
|
+
:number)
|
178
|
+
SENSITIVE = []
|
179
|
+
include Aws::Structure
|
180
|
+
end
|
181
|
+
|
182
|
+
# The requested operation would cause a conflict with the current state
|
183
|
+
# of a service resource associated with the request. Resolve the
|
184
|
+
# conflict before retrying this request.
|
185
|
+
#
|
186
|
+
# @!attribute [rw] error_code
|
187
|
+
# The identifier for the error.
|
188
|
+
# @return [String]
|
189
|
+
#
|
190
|
+
# @!attribute [rw] message
|
191
|
+
# Description of the error.
|
192
|
+
# @return [String]
|
193
|
+
#
|
194
|
+
# @!attribute [rw] resource_id
|
195
|
+
# The identifier for the service resource associated with the request.
|
196
|
+
# @return [String]
|
197
|
+
#
|
198
|
+
# @!attribute [rw] resource_type
|
199
|
+
# The type of resource associated with the request.
|
200
|
+
# @return [String]
|
201
|
+
#
|
202
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ConflictException AWS API Documentation
|
203
|
+
#
|
204
|
+
class ConflictException < Struct.new(
|
205
|
+
:error_code,
|
206
|
+
:message,
|
207
|
+
:resource_id,
|
208
|
+
:resource_type)
|
209
|
+
SENSITIVE = []
|
210
|
+
include Aws::Structure
|
211
|
+
end
|
212
|
+
|
213
|
+
# @!attribute [rw] analysis_type
|
214
|
+
# The type of analysis you want CodeGuru Security to perform in the
|
215
|
+
# scan, either `Security` or `All`. The `Secuirty` type only generates
|
216
|
+
# findings related to security. The `All` type generates both security
|
217
|
+
# findings and quality findings. Defaults to `Security` type if
|
218
|
+
# missing.
|
219
|
+
# @return [String]
|
220
|
+
#
|
221
|
+
# @!attribute [rw] client_token
|
222
|
+
# The idempotency token for the request. Amazon CodeGuru Security uses
|
223
|
+
# this value to prevent the accidental creation of duplicate scans if
|
224
|
+
# there are failures and retries.
|
225
|
+
#
|
226
|
+
# **A suitable default value is auto-generated.** You should normally
|
227
|
+
# not need to pass this option.
|
228
|
+
# @return [String]
|
229
|
+
#
|
230
|
+
# @!attribute [rw] resource_id
|
231
|
+
# The identifier for an input resource used to create a scan.
|
232
|
+
# @return [Types::ResourceId]
|
233
|
+
#
|
234
|
+
# @!attribute [rw] scan_name
|
235
|
+
# The unique name that CodeGuru Security uses to track revisions
|
236
|
+
# across multiple scans of the same resource. Only allowed for a
|
237
|
+
# `STANDARD` scan type. If not specified, it will be auto generated.
|
238
|
+
# @return [String]
|
239
|
+
#
|
240
|
+
# @!attribute [rw] scan_type
|
241
|
+
# The type of scan, either `Standard` or `Express`. Defaults to
|
242
|
+
# `Standard` type if missing.
|
243
|
+
#
|
244
|
+
# `Express` scans run on limited resources and use a limited set of
|
245
|
+
# detectors to analyze your code in near-real time. `Standard` scans
|
246
|
+
# have standard resource limits and use the full set of detectors to
|
247
|
+
# analyze your code.
|
248
|
+
# @return [String]
|
249
|
+
#
|
250
|
+
# @!attribute [rw] tags
|
251
|
+
# An array of key-value pairs used to tag a scan. A tag is a custom
|
252
|
+
# attribute label with two parts:
|
253
|
+
#
|
254
|
+
# * A tag key. For example, `CostCenter`, `Environment`, or `Secret`.
|
255
|
+
# Tag keys are case sensitive.
|
256
|
+
#
|
257
|
+
# * An optional tag value field. For example, `111122223333`,
|
258
|
+
# `Production`, or a team name. Omitting the tag value is the same
|
259
|
+
# as using an empty string. Tag values are case sensitive.
|
260
|
+
# @return [Hash<String,String>]
|
261
|
+
#
|
262
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/CreateScanRequest AWS API Documentation
|
263
|
+
#
|
264
|
+
class CreateScanRequest < Struct.new(
|
265
|
+
:analysis_type,
|
266
|
+
:client_token,
|
267
|
+
:resource_id,
|
268
|
+
:scan_name,
|
269
|
+
:scan_type,
|
270
|
+
:tags)
|
271
|
+
SENSITIVE = []
|
272
|
+
include Aws::Structure
|
273
|
+
end
|
274
|
+
|
275
|
+
# @!attribute [rw] resource_id
|
276
|
+
# The identifier for the resource object that contains resources that
|
277
|
+
# were scanned.
|
278
|
+
# @return [Types::ResourceId]
|
279
|
+
#
|
280
|
+
# @!attribute [rw] run_id
|
281
|
+
# UUID that identifies the individual scan run.
|
282
|
+
# @return [String]
|
283
|
+
#
|
284
|
+
# @!attribute [rw] scan_name
|
285
|
+
# The name of the scan.
|
286
|
+
# @return [String]
|
287
|
+
#
|
288
|
+
# @!attribute [rw] scan_name_arn
|
289
|
+
# The ARN for the scan name.
|
290
|
+
# @return [String]
|
291
|
+
#
|
292
|
+
# @!attribute [rw] scan_state
|
293
|
+
# The current state of the scan. Returns either `InProgress`,
|
294
|
+
# `Successful`, or `Failed`.
|
295
|
+
# @return [String]
|
296
|
+
#
|
297
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/CreateScanResponse AWS API Documentation
|
298
|
+
#
|
299
|
+
class CreateScanResponse < Struct.new(
|
300
|
+
:resource_id,
|
301
|
+
:run_id,
|
302
|
+
:scan_name,
|
303
|
+
:scan_name_arn,
|
304
|
+
:scan_state)
|
305
|
+
SENSITIVE = []
|
306
|
+
include Aws::Structure
|
307
|
+
end
|
308
|
+
|
309
|
+
# @!attribute [rw] scan_name
|
310
|
+
# The name of the scan that will use the uploaded resource. CodeGuru
|
311
|
+
# Security uses the unique scan name to track revisions across
|
312
|
+
# multiple scans of the same resource. Use this `scanName` when you
|
313
|
+
# call `CreateScan` on the code resource you upload to this URL.
|
314
|
+
# @return [String]
|
315
|
+
#
|
316
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/CreateUploadUrlRequest AWS API Documentation
|
317
|
+
#
|
318
|
+
class CreateUploadUrlRequest < Struct.new(
|
319
|
+
:scan_name)
|
320
|
+
SENSITIVE = []
|
321
|
+
include Aws::Structure
|
322
|
+
end
|
323
|
+
|
324
|
+
# @!attribute [rw] code_artifact_id
|
325
|
+
# The identifier for the uploaded code resource.
|
326
|
+
# @return [String]
|
327
|
+
#
|
328
|
+
# @!attribute [rw] request_headers
|
329
|
+
# A set of key-value pairs that contain the required headers when
|
330
|
+
# uploading your resource.
|
331
|
+
# @return [Hash<String,String>]
|
332
|
+
#
|
333
|
+
# @!attribute [rw] s3_url
|
334
|
+
# A pre-signed S3 URL. You can upload the code file you want to scan
|
335
|
+
# and add the required `requestHeaders` using any HTTP client.
|
336
|
+
# @return [String]
|
337
|
+
#
|
338
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/CreateUploadUrlResponse AWS API Documentation
|
339
|
+
#
|
340
|
+
class CreateUploadUrlResponse < Struct.new(
|
341
|
+
:code_artifact_id,
|
342
|
+
:request_headers,
|
343
|
+
:s3_url)
|
344
|
+
SENSITIVE = [:request_headers, :s3_url]
|
345
|
+
include Aws::Structure
|
346
|
+
end
|
347
|
+
|
348
|
+
# Information about account-level configuration.
|
349
|
+
#
|
350
|
+
# @!attribute [rw] kms_key_arn
|
351
|
+
# The KMS key ARN to use for encryption. This must be provided as a
|
352
|
+
# header when uploading your code resource.
|
353
|
+
# @return [String]
|
354
|
+
#
|
355
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/EncryptionConfig AWS API Documentation
|
356
|
+
#
|
357
|
+
class EncryptionConfig < Struct.new(
|
358
|
+
:kms_key_arn)
|
359
|
+
SENSITIVE = []
|
360
|
+
include Aws::Structure
|
361
|
+
end
|
362
|
+
|
363
|
+
# Information about the location of security vulnerabilities that Amazon
|
364
|
+
# CodeGuru Security detected in your code.
|
365
|
+
#
|
366
|
+
# @!attribute [rw] code_snippet
|
367
|
+
# A list of `CodeLine` objects that describe where the security
|
368
|
+
# vulnerability appears in your code.
|
369
|
+
# @return [Array<Types::CodeLine>]
|
370
|
+
#
|
371
|
+
# @!attribute [rw] end_line
|
372
|
+
# The last line number of the code snippet where the security
|
373
|
+
# vulnerability appears in your code.
|
374
|
+
# @return [Integer]
|
375
|
+
#
|
376
|
+
# @!attribute [rw] name
|
377
|
+
# The name of the file.
|
378
|
+
# @return [String]
|
379
|
+
#
|
380
|
+
# @!attribute [rw] path
|
381
|
+
# The path to the resource with the security vulnerability.
|
382
|
+
# @return [String]
|
383
|
+
#
|
384
|
+
# @!attribute [rw] start_line
|
385
|
+
# The first line number of the code snippet where the security
|
386
|
+
# vulnerability appears in your code.
|
387
|
+
# @return [Integer]
|
388
|
+
#
|
389
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/FilePath AWS API Documentation
|
390
|
+
#
|
391
|
+
class FilePath < Struct.new(
|
392
|
+
:code_snippet,
|
393
|
+
:end_line,
|
394
|
+
:name,
|
395
|
+
:path,
|
396
|
+
:start_line)
|
397
|
+
SENSITIVE = []
|
398
|
+
include Aws::Structure
|
399
|
+
end
|
400
|
+
|
401
|
+
# Information about a finding that was detected in your code.
|
402
|
+
#
|
403
|
+
# @!attribute [rw] created_at
|
404
|
+
# The time when the finding was created.
|
405
|
+
# @return [Time]
|
406
|
+
#
|
407
|
+
# @!attribute [rw] description
|
408
|
+
# A description of the finding.
|
409
|
+
# @return [String]
|
410
|
+
#
|
411
|
+
# @!attribute [rw] detector_id
|
412
|
+
# The identifier for the detector that detected the finding in your
|
413
|
+
# code. A detector is a defined rule based on industry standards and
|
414
|
+
# AWS best practices.
|
415
|
+
# @return [String]
|
416
|
+
#
|
417
|
+
# @!attribute [rw] detector_name
|
418
|
+
# The name of the detector that identified the security vulnerability
|
419
|
+
# in your code.
|
420
|
+
# @return [String]
|
421
|
+
#
|
422
|
+
# @!attribute [rw] detector_tags
|
423
|
+
# One or more tags or categorizations that are associated with a
|
424
|
+
# detector. These tags are defined by type, programming language, or
|
425
|
+
# other classification such as maintainability or consistency.
|
426
|
+
# @return [Array<String>]
|
427
|
+
#
|
428
|
+
# @!attribute [rw] generator_id
|
429
|
+
# The identifier for the component that generated a finding such as
|
430
|
+
# AWSCodeGuruSecurity or AWSInspector.
|
431
|
+
# @return [String]
|
432
|
+
#
|
433
|
+
# @!attribute [rw] id
|
434
|
+
# The identifier for a finding.
|
435
|
+
# @return [String]
|
436
|
+
#
|
437
|
+
# @!attribute [rw] remediation
|
438
|
+
# An object that contains the details about how to remediate a
|
439
|
+
# finding.
|
440
|
+
# @return [Types::Remediation]
|
441
|
+
#
|
442
|
+
# @!attribute [rw] resource
|
443
|
+
# The resource where Amazon CodeGuru Security detected a finding.
|
444
|
+
# @return [Types::Resource]
|
445
|
+
#
|
446
|
+
# @!attribute [rw] rule_id
|
447
|
+
# The identifier for the rule that generated the finding.
|
448
|
+
# @return [String]
|
449
|
+
#
|
450
|
+
# @!attribute [rw] severity
|
451
|
+
# The severity of the finding.
|
452
|
+
# @return [String]
|
453
|
+
#
|
454
|
+
# @!attribute [rw] status
|
455
|
+
# The status of the finding. A finding status can be open or closed.
|
456
|
+
# @return [String]
|
457
|
+
#
|
458
|
+
# @!attribute [rw] title
|
459
|
+
# The title of the finding.
|
460
|
+
# @return [String]
|
461
|
+
#
|
462
|
+
# @!attribute [rw] type
|
463
|
+
# The type of finding.
|
464
|
+
# @return [String]
|
465
|
+
#
|
466
|
+
# @!attribute [rw] updated_at
|
467
|
+
# The time when the finding was last updated. Findings are updated
|
468
|
+
# when you remediate them or when the finding code location changes.
|
469
|
+
# @return [Time]
|
470
|
+
#
|
471
|
+
# @!attribute [rw] vulnerability
|
472
|
+
# An object that describes the detected security vulnerability.
|
473
|
+
# @return [Types::Vulnerability]
|
474
|
+
#
|
475
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/Finding AWS API Documentation
|
476
|
+
#
|
477
|
+
class Finding < Struct.new(
|
478
|
+
:created_at,
|
479
|
+
:description,
|
480
|
+
:detector_id,
|
481
|
+
:detector_name,
|
482
|
+
:detector_tags,
|
483
|
+
:generator_id,
|
484
|
+
:id,
|
485
|
+
:remediation,
|
486
|
+
:resource,
|
487
|
+
:rule_id,
|
488
|
+
:severity,
|
489
|
+
:status,
|
490
|
+
:title,
|
491
|
+
:type,
|
492
|
+
:updated_at,
|
493
|
+
:vulnerability)
|
494
|
+
SENSITIVE = []
|
495
|
+
include Aws::Structure
|
496
|
+
end
|
497
|
+
|
498
|
+
# An object that contains information about a finding and the scan that
|
499
|
+
# generated it.
|
500
|
+
#
|
501
|
+
# @!attribute [rw] finding_id
|
502
|
+
# The identifier for a finding.
|
503
|
+
# @return [String]
|
504
|
+
#
|
505
|
+
# @!attribute [rw] scan_name
|
506
|
+
# The name of the scan that generated the finding.
|
507
|
+
# @return [String]
|
508
|
+
#
|
509
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/FindingIdentifier AWS API Documentation
|
510
|
+
#
|
511
|
+
class FindingIdentifier < Struct.new(
|
512
|
+
:finding_id,
|
513
|
+
:scan_name)
|
514
|
+
SENSITIVE = []
|
515
|
+
include Aws::Structure
|
516
|
+
end
|
517
|
+
|
518
|
+
# The severity of the issue in the code that generated a finding.
|
519
|
+
#
|
520
|
+
# @!attribute [rw] critical
|
521
|
+
# The severity of the finding is critical and should be addressed
|
522
|
+
# immediately.
|
523
|
+
# @return [Float]
|
524
|
+
#
|
525
|
+
# @!attribute [rw] high
|
526
|
+
# The severity of the finding is high and should be addressed as a
|
527
|
+
# near-term priority.
|
528
|
+
# @return [Float]
|
529
|
+
#
|
530
|
+
# @!attribute [rw] info
|
531
|
+
# The finding is related to quality or readability improvements and
|
532
|
+
# not considered actionable.
|
533
|
+
# @return [Float]
|
534
|
+
#
|
535
|
+
# @!attribute [rw] low
|
536
|
+
# The severity of the finding is low and does require action on its
|
537
|
+
# own.
|
538
|
+
# @return [Float]
|
539
|
+
#
|
540
|
+
# @!attribute [rw] medium
|
541
|
+
# The severity of the finding is medium and should be addressed as a
|
542
|
+
# mid-term priority.
|
543
|
+
# @return [Float]
|
544
|
+
#
|
545
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/FindingMetricsValuePerSeverity AWS API Documentation
|
546
|
+
#
|
547
|
+
class FindingMetricsValuePerSeverity < Struct.new(
|
548
|
+
:critical,
|
549
|
+
:high,
|
550
|
+
:info,
|
551
|
+
:low,
|
552
|
+
:medium)
|
553
|
+
SENSITIVE = []
|
554
|
+
include Aws::Structure
|
555
|
+
end
|
556
|
+
|
557
|
+
# @api private
|
558
|
+
#
|
559
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/GetAccountConfigurationRequest AWS API Documentation
|
560
|
+
#
|
561
|
+
class GetAccountConfigurationRequest < Aws::EmptyStructure; end
|
562
|
+
|
563
|
+
# @!attribute [rw] encryption_config
|
564
|
+
# An `EncryptionConfig` object that contains the KMS key ARN to use
|
565
|
+
# for encryption. By default, CodeGuru Security uses an AWS-managed
|
566
|
+
# key for encryption. To specify your own key, call
|
567
|
+
# `UpdateAccountConfiguration`.
|
568
|
+
# @return [Types::EncryptionConfig]
|
569
|
+
#
|
570
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/GetAccountConfigurationResponse AWS API Documentation
|
571
|
+
#
|
572
|
+
class GetAccountConfigurationResponse < Struct.new(
|
573
|
+
:encryption_config)
|
574
|
+
SENSITIVE = []
|
575
|
+
include Aws::Structure
|
576
|
+
end
|
577
|
+
|
578
|
+
# @!attribute [rw] max_results
|
579
|
+
# The maximum number of results to return in the response. Use this
|
580
|
+
# parameter when paginating results. If additional results exist
|
581
|
+
# beyond the number you specify, the `nextToken` element is returned
|
582
|
+
# in the response. Use `nextToken` in a subsequent request to retrieve
|
583
|
+
# additional results.
|
584
|
+
# @return [Integer]
|
585
|
+
#
|
586
|
+
# @!attribute [rw] next_token
|
587
|
+
# A token to use for paginating results that are returned in the
|
588
|
+
# response. Set the value of this parameter to null for the first
|
589
|
+
# request. For subsequent calls, use the `nextToken` value returned
|
590
|
+
# from the previous request to continue listing results after the
|
591
|
+
# first page.
|
592
|
+
# @return [String]
|
593
|
+
#
|
594
|
+
# @!attribute [rw] scan_name
|
595
|
+
# The name of the scan you want to retrieve findings from.
|
596
|
+
# @return [String]
|
597
|
+
#
|
598
|
+
# @!attribute [rw] status
|
599
|
+
# The status of the findings you want to get. Pass either `Open`,
|
600
|
+
# `Closed`, or `All`.
|
601
|
+
# @return [String]
|
602
|
+
#
|
603
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/GetFindingsRequest AWS API Documentation
|
604
|
+
#
|
605
|
+
class GetFindingsRequest < Struct.new(
|
606
|
+
:max_results,
|
607
|
+
:next_token,
|
608
|
+
:scan_name,
|
609
|
+
:status)
|
610
|
+
SENSITIVE = []
|
611
|
+
include Aws::Structure
|
612
|
+
end
|
613
|
+
|
614
|
+
# @!attribute [rw] findings
|
615
|
+
# A list of findings generated by the specified scan.
|
616
|
+
# @return [Array<Types::Finding>]
|
617
|
+
#
|
618
|
+
# @!attribute [rw] next_token
|
619
|
+
# A pagination token. You can use this in future calls to
|
620
|
+
# `GetFindings` to continue listing results after the current page.
|
621
|
+
# @return [String]
|
622
|
+
#
|
623
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/GetFindingsResponse AWS API Documentation
|
624
|
+
#
|
625
|
+
class GetFindingsResponse < Struct.new(
|
626
|
+
:findings,
|
627
|
+
:next_token)
|
628
|
+
SENSITIVE = []
|
629
|
+
include Aws::Structure
|
630
|
+
end
|
631
|
+
|
632
|
+
# @!attribute [rw] date
|
633
|
+
# The date you want to retrieve summary metrics from, rounded to the
|
634
|
+
# nearest day. The date must be within the past two years since
|
635
|
+
# metrics data is only stored for two years. If a date outside of this
|
636
|
+
# range is passed, the response will be empty.
|
637
|
+
# @return [Time]
|
638
|
+
#
|
639
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/GetMetricsSummaryRequest AWS API Documentation
|
640
|
+
#
|
641
|
+
class GetMetricsSummaryRequest < Struct.new(
|
642
|
+
:date)
|
643
|
+
SENSITIVE = []
|
644
|
+
include Aws::Structure
|
645
|
+
end
|
646
|
+
|
647
|
+
# @!attribute [rw] metrics_summary
|
648
|
+
# The summary metrics from the specified date.
|
649
|
+
# @return [Types::MetricsSummary]
|
650
|
+
#
|
651
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/GetMetricsSummaryResponse AWS API Documentation
|
652
|
+
#
|
653
|
+
class GetMetricsSummaryResponse < Struct.new(
|
654
|
+
:metrics_summary)
|
655
|
+
SENSITIVE = []
|
656
|
+
include Aws::Structure
|
657
|
+
end
|
658
|
+
|
659
|
+
# @!attribute [rw] run_id
|
660
|
+
# UUID that identifies the individual scan run you want to view
|
661
|
+
# details about. You retrieve this when you call the `CreateScan`
|
662
|
+
# operation. Defaults to the latest scan run if missing.
|
663
|
+
# @return [String]
|
664
|
+
#
|
665
|
+
# @!attribute [rw] scan_name
|
666
|
+
# The name of the scan you want to view details about.
|
667
|
+
# @return [String]
|
668
|
+
#
|
669
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/GetScanRequest AWS API Documentation
|
670
|
+
#
|
671
|
+
class GetScanRequest < Struct.new(
|
672
|
+
:run_id,
|
673
|
+
:scan_name)
|
674
|
+
SENSITIVE = []
|
675
|
+
include Aws::Structure
|
676
|
+
end
|
677
|
+
|
678
|
+
# @!attribute [rw] analysis_type
|
679
|
+
# The type of analysis CodeGuru Security performed in the scan, either
|
680
|
+
# `Security` or `All`. The `Security` type only generates findings
|
681
|
+
# related to security. The `All` type generates both security findings
|
682
|
+
# and quality findings.
|
683
|
+
# @return [String]
|
684
|
+
#
|
685
|
+
# @!attribute [rw] created_at
|
686
|
+
# The time the scan was created.
|
687
|
+
# @return [Time]
|
688
|
+
#
|
689
|
+
# @!attribute [rw] number_of_revisions
|
690
|
+
# The number of times a scan has been re-run on a revised resource.
|
691
|
+
# @return [Integer]
|
692
|
+
#
|
693
|
+
# @!attribute [rw] run_id
|
694
|
+
# UUID that identifies the individual scan run.
|
695
|
+
# @return [String]
|
696
|
+
#
|
697
|
+
# @!attribute [rw] scan_name
|
698
|
+
# The name of the scan.
|
699
|
+
# @return [String]
|
700
|
+
#
|
701
|
+
# @!attribute [rw] scan_name_arn
|
702
|
+
# The ARN for the scan name.
|
703
|
+
# @return [String]
|
704
|
+
#
|
705
|
+
# @!attribute [rw] scan_state
|
706
|
+
# The current state of the scan. Pass either `InProgress`,
|
707
|
+
# `Successful`, or `Failed`.
|
708
|
+
# @return [String]
|
709
|
+
#
|
710
|
+
# @!attribute [rw] updated_at
|
711
|
+
# The time when the scan was last updated. Only available for
|
712
|
+
# `STANDARD` scan types.
|
713
|
+
# @return [Time]
|
714
|
+
#
|
715
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/GetScanResponse AWS API Documentation
|
716
|
+
#
|
717
|
+
class GetScanResponse < Struct.new(
|
718
|
+
:analysis_type,
|
719
|
+
:created_at,
|
720
|
+
:number_of_revisions,
|
721
|
+
:run_id,
|
722
|
+
:scan_name,
|
723
|
+
:scan_name_arn,
|
724
|
+
:scan_state,
|
725
|
+
:updated_at)
|
726
|
+
SENSITIVE = []
|
727
|
+
include Aws::Structure
|
728
|
+
end
|
729
|
+
|
730
|
+
# The server encountered an internal error and is unable to complete the
|
731
|
+
# request.
|
732
|
+
#
|
733
|
+
# @!attribute [rw] error
|
734
|
+
# The internal error encountered by the server.
|
735
|
+
# @return [String]
|
736
|
+
#
|
737
|
+
# @!attribute [rw] message
|
738
|
+
# Description of the error.
|
739
|
+
# @return [String]
|
740
|
+
#
|
741
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/InternalServerException AWS API Documentation
|
742
|
+
#
|
743
|
+
class InternalServerException < Struct.new(
|
744
|
+
:error,
|
745
|
+
:message)
|
746
|
+
SENSITIVE = []
|
747
|
+
include Aws::Structure
|
748
|
+
end
|
749
|
+
|
750
|
+
# @!attribute [rw] end_date
|
751
|
+
# The end date of the interval which you want to retrieve metrics
|
752
|
+
# from.
|
753
|
+
# @return [Time]
|
754
|
+
#
|
755
|
+
# @!attribute [rw] max_results
|
756
|
+
# The maximum number of results to return in the response. Use this
|
757
|
+
# parameter when paginating results. If additional results exist
|
758
|
+
# beyond the number you specify, the `nextToken` element is returned
|
759
|
+
# in the response. Use `nextToken` in a subsequent request to retrieve
|
760
|
+
# additional results.
|
761
|
+
# @return [Integer]
|
762
|
+
#
|
763
|
+
# @!attribute [rw] next_token
|
764
|
+
# A token to use for paginating results that are returned in the
|
765
|
+
# response. Set the value of this parameter to null for the first
|
766
|
+
# request. For subsequent calls, use the `nextToken` value returned
|
767
|
+
# from the previous request to continue listing results after the
|
768
|
+
# first page.
|
769
|
+
# @return [String]
|
770
|
+
#
|
771
|
+
# @!attribute [rw] start_date
|
772
|
+
# The start date of the interval which you want to retrieve metrics
|
773
|
+
# from.
|
774
|
+
# @return [Time]
|
775
|
+
#
|
776
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ListFindingsMetricsRequest AWS API Documentation
|
777
|
+
#
|
778
|
+
class ListFindingsMetricsRequest < Struct.new(
|
779
|
+
:end_date,
|
780
|
+
:max_results,
|
781
|
+
:next_token,
|
782
|
+
:start_date)
|
783
|
+
SENSITIVE = []
|
784
|
+
include Aws::Structure
|
785
|
+
end
|
786
|
+
|
787
|
+
# @!attribute [rw] findings_metrics
|
788
|
+
# A list of `AccountFindingsMetric` objects retrieved from the
|
789
|
+
# specified time interval.
|
790
|
+
# @return [Array<Types::AccountFindingsMetric>]
|
791
|
+
#
|
792
|
+
# @!attribute [rw] next_token
|
793
|
+
# A pagination token. You can use this in future calls to
|
794
|
+
# `ListFindingMetrics` to continue listing results after the current
|
795
|
+
# page.
|
796
|
+
# @return [String]
|
797
|
+
#
|
798
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ListFindingsMetricsResponse AWS API Documentation
|
799
|
+
#
|
800
|
+
class ListFindingsMetricsResponse < Struct.new(
|
801
|
+
:findings_metrics,
|
802
|
+
:next_token)
|
803
|
+
SENSITIVE = []
|
804
|
+
include Aws::Structure
|
805
|
+
end
|
806
|
+
|
807
|
+
# @!attribute [rw] max_results
|
808
|
+
# The maximum number of results to return in the response. Use this
|
809
|
+
# parameter when paginating results. If additional results exist
|
810
|
+
# beyond the number you specify, the `nextToken` element is returned
|
811
|
+
# in the response. Use `nextToken` in a subsequent request to retrieve
|
812
|
+
# additional results.
|
813
|
+
# @return [Integer]
|
814
|
+
#
|
815
|
+
# @!attribute [rw] next_token
|
816
|
+
# A token to use for paginating results that are returned in the
|
817
|
+
# response. Set the value of this parameter to null for the first
|
818
|
+
# request. For subsequent calls, use the `nextToken` value returned
|
819
|
+
# from the previous request to continue listing results after the
|
820
|
+
# first page.
|
821
|
+
# @return [String]
|
822
|
+
#
|
823
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ListScansRequest AWS API Documentation
|
824
|
+
#
|
825
|
+
class ListScansRequest < Struct.new(
|
826
|
+
:max_results,
|
827
|
+
:next_token)
|
828
|
+
SENSITIVE = []
|
829
|
+
include Aws::Structure
|
830
|
+
end
|
831
|
+
|
832
|
+
# @!attribute [rw] next_token
|
833
|
+
# A pagination token. You can use this in future calls to `ListScans`
|
834
|
+
# to continue listing results after the current page.
|
835
|
+
# @return [String]
|
836
|
+
#
|
837
|
+
# @!attribute [rw] summaries
|
838
|
+
# A list of `ScanSummary` objects with information about all scans in
|
839
|
+
# an account.
|
840
|
+
# @return [Array<Types::ScanSummary>]
|
841
|
+
#
|
842
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ListScansResponse AWS API Documentation
|
843
|
+
#
|
844
|
+
class ListScansResponse < Struct.new(
|
845
|
+
:next_token,
|
846
|
+
:summaries)
|
847
|
+
SENSITIVE = []
|
848
|
+
include Aws::Structure
|
849
|
+
end
|
850
|
+
|
851
|
+
# @!attribute [rw] resource_arn
|
852
|
+
# The ARN of the `ScanName` object. You can retrieve this ARN by
|
853
|
+
# calling `ListScans` or `GetScan`.
|
854
|
+
# @return [String]
|
855
|
+
#
|
856
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ListTagsForResourceRequest AWS API Documentation
|
857
|
+
#
|
858
|
+
class ListTagsForResourceRequest < Struct.new(
|
859
|
+
:resource_arn)
|
860
|
+
SENSITIVE = []
|
861
|
+
include Aws::Structure
|
862
|
+
end
|
863
|
+
|
864
|
+
# @!attribute [rw] tags
|
865
|
+
# An array of key-value pairs used to tag an existing scan. A tag is a
|
866
|
+
# custom attribute label with two parts:
|
867
|
+
#
|
868
|
+
# * A tag key. For example, `CostCenter`, `Environment`, or `Secret`.
|
869
|
+
# Tag keys are case sensitive.
|
870
|
+
#
|
871
|
+
# * An optional tag value field. For example, `111122223333`,
|
872
|
+
# `Production`, or a team name. Omitting the tag value is the same
|
873
|
+
# as using an empty string. Tag values are case sensitive.
|
874
|
+
# @return [Hash<String,String>]
|
875
|
+
#
|
876
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ListTagsForResourceResponse AWS API Documentation
|
877
|
+
#
|
878
|
+
class ListTagsForResourceResponse < Struct.new(
|
879
|
+
:tags)
|
880
|
+
SENSITIVE = []
|
881
|
+
include Aws::Structure
|
882
|
+
end
|
883
|
+
|
884
|
+
# Information about summary metrics in an account.
|
885
|
+
#
|
886
|
+
# @!attribute [rw] categories_with_most_findings
|
887
|
+
# A list of `CategoryWithFindingNum` objects for the top 5 finding
|
888
|
+
# categories with the most open findings in an account.
|
889
|
+
# @return [Array<Types::CategoryWithFindingNum>]
|
890
|
+
#
|
891
|
+
# @!attribute [rw] date
|
892
|
+
# The date from which the metrics summary information was retrieved.
|
893
|
+
# @return [Time]
|
894
|
+
#
|
895
|
+
# @!attribute [rw] open_findings
|
896
|
+
# The number of open findings of each severity in an account.
|
897
|
+
# @return [Types::FindingMetricsValuePerSeverity]
|
898
|
+
#
|
899
|
+
# @!attribute [rw] scans_with_most_open_critical_findings
|
900
|
+
# A list of `ScanNameWithFindingNum` objects for the top 3 scans with
|
901
|
+
# the most number of open findings in an account.
|
902
|
+
# @return [Array<Types::ScanNameWithFindingNum>]
|
903
|
+
#
|
904
|
+
# @!attribute [rw] scans_with_most_open_findings
|
905
|
+
# A list of `ScanNameWithFindingNum` objects for the top 3 scans with
|
906
|
+
# the most number of open critical findings in an account.
|
907
|
+
# @return [Array<Types::ScanNameWithFindingNum>]
|
908
|
+
#
|
909
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/MetricsSummary AWS API Documentation
|
910
|
+
#
|
911
|
+
class MetricsSummary < Struct.new(
|
912
|
+
:categories_with_most_findings,
|
913
|
+
:date,
|
914
|
+
:open_findings,
|
915
|
+
:scans_with_most_open_critical_findings,
|
916
|
+
:scans_with_most_open_findings)
|
917
|
+
SENSITIVE = []
|
918
|
+
include Aws::Structure
|
919
|
+
end
|
920
|
+
|
921
|
+
# Information about the recommended course of action to remediate a
|
922
|
+
# finding.
|
923
|
+
#
|
924
|
+
# @!attribute [rw] text
|
925
|
+
# The recommended course of action to remediate the finding.
|
926
|
+
# @return [String]
|
927
|
+
#
|
928
|
+
# @!attribute [rw] url
|
929
|
+
# The URL address to the recommendation for remediating the finding.
|
930
|
+
# @return [String]
|
931
|
+
#
|
932
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/Recommendation AWS API Documentation
|
933
|
+
#
|
934
|
+
class Recommendation < Struct.new(
|
935
|
+
:text,
|
936
|
+
:url)
|
937
|
+
SENSITIVE = []
|
938
|
+
include Aws::Structure
|
939
|
+
end
|
940
|
+
|
941
|
+
# Information about how to remediate a finding.
|
942
|
+
#
|
943
|
+
# @!attribute [rw] recommendation
|
944
|
+
# An object that contains information about the recommended course of
|
945
|
+
# action to remediate a finding.
|
946
|
+
# @return [Types::Recommendation]
|
947
|
+
#
|
948
|
+
# @!attribute [rw] suggested_fixes
|
949
|
+
# A list of `SuggestedFix` objects. Each object contains information
|
950
|
+
# about a suggested code fix to remediate the finding.
|
951
|
+
# @return [Array<Types::SuggestedFix>]
|
952
|
+
#
|
953
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/Remediation AWS API Documentation
|
954
|
+
#
|
955
|
+
class Remediation < Struct.new(
|
956
|
+
:recommendation,
|
957
|
+
:suggested_fixes)
|
958
|
+
SENSITIVE = []
|
959
|
+
include Aws::Structure
|
960
|
+
end
|
961
|
+
|
962
|
+
# Information about a resource, such as an Amazon S3 bucket or AWS
|
963
|
+
# Lambda function, that contains a finding.
|
964
|
+
#
|
965
|
+
# @!attribute [rw] id
|
966
|
+
# The identifier for the resource.
|
967
|
+
# @return [String]
|
968
|
+
#
|
969
|
+
# @!attribute [rw] sub_resource_id
|
970
|
+
# The identifier for a section of the resource, such as an AWS Lambda
|
971
|
+
# layer.
|
972
|
+
# @return [String]
|
973
|
+
#
|
974
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/Resource AWS API Documentation
|
975
|
+
#
|
976
|
+
class Resource < Struct.new(
|
977
|
+
:id,
|
978
|
+
:sub_resource_id)
|
979
|
+
SENSITIVE = []
|
980
|
+
include Aws::Structure
|
981
|
+
end
|
982
|
+
|
983
|
+
# The identifier for a resource object that contains resources where a
|
984
|
+
# finding was detected.
|
985
|
+
#
|
986
|
+
# @note ResourceId is a union - when making an API calls you must set exactly one of the members.
|
987
|
+
#
|
988
|
+
# @note ResourceId is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ResourceId corresponding to the set member.
|
989
|
+
#
|
990
|
+
# @!attribute [rw] code_artifact_id
|
991
|
+
# The identifier for the code file uploaded to the resource where a
|
992
|
+
# finding was detected.
|
993
|
+
# @return [String]
|
994
|
+
#
|
995
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ResourceId AWS API Documentation
|
996
|
+
#
|
997
|
+
class ResourceId < Struct.new(
|
998
|
+
:code_artifact_id,
|
999
|
+
:unknown)
|
1000
|
+
SENSITIVE = []
|
1001
|
+
include Aws::Structure
|
1002
|
+
include Aws::Structure::Union
|
1003
|
+
|
1004
|
+
class CodeArtifactId < ResourceId; end
|
1005
|
+
class Unknown < ResourceId; end
|
1006
|
+
end
|
1007
|
+
|
1008
|
+
# The resource specified in the request was not found.
|
1009
|
+
#
|
1010
|
+
# @!attribute [rw] error_code
|
1011
|
+
# The identifier for the error.
|
1012
|
+
# @return [String]
|
1013
|
+
#
|
1014
|
+
# @!attribute [rw] message
|
1015
|
+
# Description of the error.
|
1016
|
+
# @return [String]
|
1017
|
+
#
|
1018
|
+
# @!attribute [rw] resource_id
|
1019
|
+
# The identifier for the resource that was not found.
|
1020
|
+
# @return [String]
|
1021
|
+
#
|
1022
|
+
# @!attribute [rw] resource_type
|
1023
|
+
# The type of resource that was not found.
|
1024
|
+
# @return [String]
|
1025
|
+
#
|
1026
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ResourceNotFoundException AWS API Documentation
|
1027
|
+
#
|
1028
|
+
class ResourceNotFoundException < Struct.new(
|
1029
|
+
:error_code,
|
1030
|
+
:message,
|
1031
|
+
:resource_id,
|
1032
|
+
:resource_type)
|
1033
|
+
SENSITIVE = []
|
1034
|
+
include Aws::Structure
|
1035
|
+
end
|
1036
|
+
|
1037
|
+
# Information about a scan with open findings.
|
1038
|
+
#
|
1039
|
+
# @!attribute [rw] finding_number
|
1040
|
+
# The number of open findings generated by a scan.
|
1041
|
+
# @return [Integer]
|
1042
|
+
#
|
1043
|
+
# @!attribute [rw] scan_name
|
1044
|
+
# The name of the scan.
|
1045
|
+
# @return [String]
|
1046
|
+
#
|
1047
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ScanNameWithFindingNum AWS API Documentation
|
1048
|
+
#
|
1049
|
+
class ScanNameWithFindingNum < Struct.new(
|
1050
|
+
:finding_number,
|
1051
|
+
:scan_name)
|
1052
|
+
SENSITIVE = []
|
1053
|
+
include Aws::Structure
|
1054
|
+
end
|
1055
|
+
|
1056
|
+
# Information about a scan.
|
1057
|
+
#
|
1058
|
+
# @!attribute [rw] created_at
|
1059
|
+
# The time when the scan was created.
|
1060
|
+
# @return [Time]
|
1061
|
+
#
|
1062
|
+
# @!attribute [rw] run_id
|
1063
|
+
# The identifier for the scan run.
|
1064
|
+
# @return [String]
|
1065
|
+
#
|
1066
|
+
# @!attribute [rw] scan_name
|
1067
|
+
# The name of the scan.
|
1068
|
+
# @return [String]
|
1069
|
+
#
|
1070
|
+
# @!attribute [rw] scan_name_arn
|
1071
|
+
# The ARN for the scan name.
|
1072
|
+
# @return [String]
|
1073
|
+
#
|
1074
|
+
# @!attribute [rw] scan_state
|
1075
|
+
# The state of the scan. A scan can be `In Progress`, `Complete`, or
|
1076
|
+
# `Failed`.
|
1077
|
+
# @return [String]
|
1078
|
+
#
|
1079
|
+
# @!attribute [rw] updated_at
|
1080
|
+
# The time the scan was last updated. A scan is updated when it is
|
1081
|
+
# re-run.
|
1082
|
+
# @return [Time]
|
1083
|
+
#
|
1084
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ScanSummary AWS API Documentation
|
1085
|
+
#
|
1086
|
+
class ScanSummary < Struct.new(
|
1087
|
+
:created_at,
|
1088
|
+
:run_id,
|
1089
|
+
:scan_name,
|
1090
|
+
:scan_name_arn,
|
1091
|
+
:scan_state,
|
1092
|
+
:updated_at)
|
1093
|
+
SENSITIVE = []
|
1094
|
+
include Aws::Structure
|
1095
|
+
end
|
1096
|
+
|
1097
|
+
# Information about the suggested code fix to remediate a finding.
|
1098
|
+
#
|
1099
|
+
# @!attribute [rw] code
|
1100
|
+
# The suggested code to add to your file.
|
1101
|
+
# @return [String]
|
1102
|
+
#
|
1103
|
+
# @!attribute [rw] description
|
1104
|
+
# A description of the suggested code fix and why it is being
|
1105
|
+
# suggested.
|
1106
|
+
# @return [String]
|
1107
|
+
#
|
1108
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/SuggestedFix AWS API Documentation
|
1109
|
+
#
|
1110
|
+
class SuggestedFix < Struct.new(
|
1111
|
+
:code,
|
1112
|
+
:description)
|
1113
|
+
SENSITIVE = []
|
1114
|
+
include Aws::Structure
|
1115
|
+
end
|
1116
|
+
|
1117
|
+
# @!attribute [rw] resource_arn
|
1118
|
+
# The ARN of the `ScanName` object. You can retrieve this ARN by
|
1119
|
+
# calling `ListScans` or `GetScan`.
|
1120
|
+
# @return [String]
|
1121
|
+
#
|
1122
|
+
# @!attribute [rw] tags
|
1123
|
+
# An array of key-value pairs used to tag an existing scan. A tag is a
|
1124
|
+
# custom attribute label with two parts:
|
1125
|
+
#
|
1126
|
+
# * A tag key. For example, `CostCenter`, `Environment`, or `Secret`.
|
1127
|
+
# Tag keys are case sensitive.
|
1128
|
+
#
|
1129
|
+
# * An optional tag value field. For example, `111122223333`,
|
1130
|
+
# `Production`, or a team name. Omitting the tag value is the same
|
1131
|
+
# as using an empty string. Tag values are case sensitive.
|
1132
|
+
# @return [Hash<String,String>]
|
1133
|
+
#
|
1134
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/TagResourceRequest AWS API Documentation
|
1135
|
+
#
|
1136
|
+
class TagResourceRequest < Struct.new(
|
1137
|
+
:resource_arn,
|
1138
|
+
:tags)
|
1139
|
+
SENSITIVE = []
|
1140
|
+
include Aws::Structure
|
1141
|
+
end
|
1142
|
+
|
1143
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/TagResourceResponse AWS API Documentation
|
1144
|
+
#
|
1145
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
1146
|
+
|
1147
|
+
# The request was denied due to request throttling.
|
1148
|
+
#
|
1149
|
+
# @!attribute [rw] error_code
|
1150
|
+
# The identifier for the error.
|
1151
|
+
# @return [String]
|
1152
|
+
#
|
1153
|
+
# @!attribute [rw] message
|
1154
|
+
# Description of the error.
|
1155
|
+
# @return [String]
|
1156
|
+
#
|
1157
|
+
# @!attribute [rw] quota_code
|
1158
|
+
# The identifier for the originating quota.
|
1159
|
+
# @return [String]
|
1160
|
+
#
|
1161
|
+
# @!attribute [rw] service_code
|
1162
|
+
# The identifier for the originating service.
|
1163
|
+
# @return [String]
|
1164
|
+
#
|
1165
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ThrottlingException AWS API Documentation
|
1166
|
+
#
|
1167
|
+
class ThrottlingException < Struct.new(
|
1168
|
+
:error_code,
|
1169
|
+
:message,
|
1170
|
+
:quota_code,
|
1171
|
+
:service_code)
|
1172
|
+
SENSITIVE = []
|
1173
|
+
include Aws::Structure
|
1174
|
+
end
|
1175
|
+
|
1176
|
+
# @!attribute [rw] resource_arn
|
1177
|
+
# The ARN of the `ScanName` object. You can retrieve this ARN by
|
1178
|
+
# calling `ListScans` or `GetScan`.
|
1179
|
+
# @return [String]
|
1180
|
+
#
|
1181
|
+
# @!attribute [rw] tag_keys
|
1182
|
+
# A list of keys for each tag you want to remove from a scan.
|
1183
|
+
# @return [Array<String>]
|
1184
|
+
#
|
1185
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/UntagResourceRequest AWS API Documentation
|
1186
|
+
#
|
1187
|
+
class UntagResourceRequest < Struct.new(
|
1188
|
+
:resource_arn,
|
1189
|
+
:tag_keys)
|
1190
|
+
SENSITIVE = []
|
1191
|
+
include Aws::Structure
|
1192
|
+
end
|
1193
|
+
|
1194
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/UntagResourceResponse AWS API Documentation
|
1195
|
+
#
|
1196
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
1197
|
+
|
1198
|
+
# @!attribute [rw] encryption_config
|
1199
|
+
# The KMS key ARN you want to use for encryption. Defaults to
|
1200
|
+
# service-side encryption if missing.
|
1201
|
+
# @return [Types::EncryptionConfig]
|
1202
|
+
#
|
1203
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/UpdateAccountConfigurationRequest AWS API Documentation
|
1204
|
+
#
|
1205
|
+
class UpdateAccountConfigurationRequest < Struct.new(
|
1206
|
+
:encryption_config)
|
1207
|
+
SENSITIVE = []
|
1208
|
+
include Aws::Structure
|
1209
|
+
end
|
1210
|
+
|
1211
|
+
# @!attribute [rw] encryption_config
|
1212
|
+
# An `EncryptionConfig` object that contains the KMS key ARN to use
|
1213
|
+
# for encryption.
|
1214
|
+
# @return [Types::EncryptionConfig]
|
1215
|
+
#
|
1216
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/UpdateAccountConfigurationResponse AWS API Documentation
|
1217
|
+
#
|
1218
|
+
class UpdateAccountConfigurationResponse < Struct.new(
|
1219
|
+
:encryption_config)
|
1220
|
+
SENSITIVE = []
|
1221
|
+
include Aws::Structure
|
1222
|
+
end
|
1223
|
+
|
1224
|
+
# The input fails to satisfy the specified constraints.
|
1225
|
+
#
|
1226
|
+
# @!attribute [rw] error_code
|
1227
|
+
# The identifier for the error.
|
1228
|
+
# @return [String]
|
1229
|
+
#
|
1230
|
+
# @!attribute [rw] field_list
|
1231
|
+
# The field that caused the error, if applicable.
|
1232
|
+
# @return [Array<Types::ValidationExceptionField>]
|
1233
|
+
#
|
1234
|
+
# @!attribute [rw] message
|
1235
|
+
# Description of the error.
|
1236
|
+
# @return [String]
|
1237
|
+
#
|
1238
|
+
# @!attribute [rw] reason
|
1239
|
+
# The reason the request failed validation.
|
1240
|
+
# @return [String]
|
1241
|
+
#
|
1242
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ValidationException AWS API Documentation
|
1243
|
+
#
|
1244
|
+
class ValidationException < Struct.new(
|
1245
|
+
:error_code,
|
1246
|
+
:field_list,
|
1247
|
+
:message,
|
1248
|
+
:reason)
|
1249
|
+
SENSITIVE = []
|
1250
|
+
include Aws::Structure
|
1251
|
+
end
|
1252
|
+
|
1253
|
+
# Information about a validation exception.
|
1254
|
+
#
|
1255
|
+
# @!attribute [rw] message
|
1256
|
+
# Describes the exception.
|
1257
|
+
# @return [String]
|
1258
|
+
#
|
1259
|
+
# @!attribute [rw] name
|
1260
|
+
# The name of the exception.
|
1261
|
+
# @return [String]
|
1262
|
+
#
|
1263
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ValidationExceptionField AWS API Documentation
|
1264
|
+
#
|
1265
|
+
class ValidationExceptionField < Struct.new(
|
1266
|
+
:message,
|
1267
|
+
:name)
|
1268
|
+
SENSITIVE = []
|
1269
|
+
include Aws::Structure
|
1270
|
+
end
|
1271
|
+
|
1272
|
+
# Information about a security vulnerability that Amazon CodeGuru
|
1273
|
+
# Security detected.
|
1274
|
+
#
|
1275
|
+
# @!attribute [rw] file_path
|
1276
|
+
# An object that describes the location of the detected security
|
1277
|
+
# vulnerability in your code.
|
1278
|
+
# @return [Types::FilePath]
|
1279
|
+
#
|
1280
|
+
# @!attribute [rw] id
|
1281
|
+
# The identifier for the vulnerability.
|
1282
|
+
# @return [String]
|
1283
|
+
#
|
1284
|
+
# @!attribute [rw] item_count
|
1285
|
+
# The number of times the vulnerability appears in your code.
|
1286
|
+
# @return [Integer]
|
1287
|
+
#
|
1288
|
+
# @!attribute [rw] reference_urls
|
1289
|
+
# One or more URL addresses that contain details about a
|
1290
|
+
# vulnerability.
|
1291
|
+
# @return [Array<String>]
|
1292
|
+
#
|
1293
|
+
# @!attribute [rw] related_vulnerabilities
|
1294
|
+
# One or more vulnerabilities that are related to the vulnerability
|
1295
|
+
# being described.
|
1296
|
+
# @return [Array<String>]
|
1297
|
+
#
|
1298
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/Vulnerability AWS API Documentation
|
1299
|
+
#
|
1300
|
+
class Vulnerability < Struct.new(
|
1301
|
+
:file_path,
|
1302
|
+
:id,
|
1303
|
+
:item_count,
|
1304
|
+
:reference_urls,
|
1305
|
+
:related_vulnerabilities)
|
1306
|
+
SENSITIVE = []
|
1307
|
+
include Aws::Structure
|
1308
|
+
end
|
1309
|
+
|
1310
|
+
end
|
1311
|
+
end
|