aws-sdk-codegurusecurity 1.12.0 → 1.13.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f383918f8ada5f7d35336ca4f9d5b00111803ebbdef0a5b1e83f086a8707d170
4
- data.tar.gz: 9f2bdc5af34480c3d9de15850bb9c74f80ff9188acc897a31c45da6ff015b001
3
+ metadata.gz: 6c362af04c626d21e889d226a31e1fae252a81dcf072003289801c7ab6bbb2f9
4
+ data.tar.gz: e81336e6d6fb556968887025382ad4c1eb642c6ade3482ee00c17defd407bbbf
5
5
  SHA512:
6
- metadata.gz: 3860920c5060dd9e939ee83199e2cbf9fa131ee28183a951f1e56058da39eb29ba2ad4b38a748e7fb64ef25731cb6655e47e196d0c670b1761a9a3da91fd86d7
7
- data.tar.gz: 16cfa17e1f07dc81a2c9ae60fe4e2a58f6ca5d61f7598dd7e5f6babf734e37367587e716c6fda1aac63f5879910b518fbef432e4b1c4e8d51b0a2cbd4bacc0f8
6
+ metadata.gz: 4c6a7709a7c2bc594039f093dda60c8fba1ae932c859a39cc1df65328fe5e75d0a4b54423c1b6be97971dafe8caedcb20c48f16ea0ea84cade72a265b807b262
7
+ data.tar.gz: f7209f9bd4ceae708c4294ae3df9fa4738406e731518abe600884d2fd41f863232cda355259a7dd6561c3087aada6bd04d9c3c9d7a71201bf45cd8fc70c96913
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.13.0 (2024-05-31)
5
+ ------------------
6
+
7
+ * Feature - This release includes minor model updates and documentation updates.
8
+
4
9
  1.12.0 (2024-05-13)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.12.0
1
+ 1.13.0
@@ -413,7 +413,7 @@ module Aws::CodeGuruSecurity
413
413
 
414
414
  # @!group API Operations
415
415
 
416
- # Returns a list of all requested findings.
416
+ # Returns a list of requested findings from standard scans.
417
417
  #
418
418
  # @option params [required, Array<Types::FindingIdentifier>] :finding_identifiers
419
419
  # A list of finding identifiers. Each identifier consists of a
@@ -488,7 +488,7 @@ module Aws::CodeGuruSecurity
488
488
  req.send_request(options)
489
489
  end
490
490
 
491
- # Use to create a scan using code uploaded to an S3 bucket.
491
+ # Use to create a scan using code uploaded to an Amazon S3 bucket.
492
492
  #
493
493
  # @option params [String] :analysis_type
494
494
  # The type of analysis you want CodeGuru Security to perform in the
@@ -505,12 +505,12 @@ module Aws::CodeGuruSecurity
505
505
  # not need to pass this option.**
506
506
  #
507
507
  # @option params [required, Types::ResourceId] :resource_id
508
- # The identifier for an input resource used to create a scan.
508
+ # The identifier for the resource object to be scanned.
509
509
  #
510
510
  # @option params [required, String] :scan_name
511
511
  # The unique name that CodeGuru Security uses to track revisions across
512
512
  # multiple scans of the same resource. Only allowed for a `STANDARD`
513
- # scan type. If not specified, it will be auto generated.
513
+ # scan type.
514
514
  #
515
515
  # @option params [String] :scan_type
516
516
  # The type of scan, either `Standard` or `Express`. Defaults to
@@ -572,11 +572,11 @@ module Aws::CodeGuruSecurity
572
572
  req.send_request(options)
573
573
  end
574
574
 
575
- # Generates a pre-signed URL and request headers used to upload a code
576
- # resource.
575
+ # Generates a pre-signed URL, request headers used to upload a code
576
+ # resource, and code artifact identifier for the uploaded resource.
577
577
  #
578
- # You can upload your code resource to the URL and add the request
579
- # headers using any HTTP client.
578
+ # You can upload your code resource to the URL with the request headers
579
+ # using any HTTP client.
580
580
  #
581
581
  # @option params [required, String] :scan_name
582
582
  # The name of the scan that will use the uploaded resource. CodeGuru
@@ -612,7 +612,7 @@ module Aws::CodeGuruSecurity
612
612
  req.send_request(options)
613
613
  end
614
614
 
615
- # Use to get account level configuration.
615
+ # Use to get the encryption configuration for an account.
616
616
  #
617
617
  # @return [Types::GetAccountConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
618
618
  #
@@ -638,7 +638,7 @@ module Aws::CodeGuruSecurity
638
638
  # parameter when paginating results. If additional results exist beyond
639
639
  # the number you specify, the `nextToken` element is returned in the
640
640
  # response. Use `nextToken` in a subsequent request to retrieve
641
- # additional results.
641
+ # additional results. If not specified, returns 1000 results.
642
642
  #
643
643
  # @option params [String] :next_token
644
644
  # A token to use for paginating results that are returned in the
@@ -717,16 +717,14 @@ module Aws::CodeGuruSecurity
717
717
  req.send_request(options)
718
718
  end
719
719
 
720
- # Returns top level metrics about an account from a specified date,
720
+ # Returns a summary of metrics for an account from a specified date,
721
721
  # including number of open findings, the categories with most findings,
722
722
  # the scans with most open findings, and scans with most open critical
723
723
  # findings.
724
724
  #
725
725
  # @option params [required, Time,DateTime,Date,Integer,String] :date
726
726
  # The date you want to retrieve summary metrics from, rounded to the
727
- # nearest day. The date must be within the past two years since metrics
728
- # data is only stored for two years. If a date outside of this range is
729
- # passed, the response will be empty.
727
+ # nearest day. The date must be within the past two years.
730
728
  #
731
729
  # @return [Types::GetMetricsSummaryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
732
730
  #
@@ -780,6 +778,7 @@ module Aws::CodeGuruSecurity
780
778
  #
781
779
  # * {Types::GetScanResponse#analysis_type #analysis_type} => String
782
780
  # * {Types::GetScanResponse#created_at #created_at} => Time
781
+ # * {Types::GetScanResponse#error_message #error_message} => String
783
782
  # * {Types::GetScanResponse#number_of_revisions #number_of_revisions} => Integer
784
783
  # * {Types::GetScanResponse#run_id #run_id} => String
785
784
  # * {Types::GetScanResponse#scan_name #scan_name} => String
@@ -798,6 +797,7 @@ module Aws::CodeGuruSecurity
798
797
  #
799
798
  # resp.analysis_type #=> String, one of "Security", "All"
800
799
  # resp.created_at #=> Time
800
+ # resp.error_message #=> String
801
801
  # resp.number_of_revisions #=> Integer
802
802
  # resp.run_id #=> String
803
803
  # resp.scan_name #=> String
@@ -819,13 +819,14 @@ module Aws::CodeGuruSecurity
819
819
  #
820
820
  # @option params [required, Time,DateTime,Date,Integer,String] :end_date
821
821
  # The end date of the interval which you want to retrieve metrics from.
822
+ # Round to the nearest day.
822
823
  #
823
824
  # @option params [Integer] :max_results
824
825
  # The maximum number of results to return in the response. Use this
825
826
  # parameter when paginating results. If additional results exist beyond
826
827
  # the number you specify, the `nextToken` element is returned in the
827
828
  # response. Use `nextToken` in a subsequent request to retrieve
828
- # additional results.
829
+ # additional results. If not specified, returns 1000 results.
829
830
  #
830
831
  # @option params [String] :next_token
831
832
  # A token to use for paginating results that are returned in the
@@ -835,7 +836,7 @@ module Aws::CodeGuruSecurity
835
836
  #
836
837
  # @option params [required, Time,DateTime,Date,Integer,String] :start_date
837
838
  # The start date of the interval which you want to retrieve metrics
838
- # from.
839
+ # from. Rounds to the nearest day.
839
840
  #
840
841
  # @return [Types::ListFindingsMetricsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
841
842
  #
@@ -888,15 +889,15 @@ module Aws::CodeGuruSecurity
888
889
  req.send_request(options)
889
890
  end
890
891
 
891
- # Returns a list of all the standard scans in an account. Does not
892
- # return express scans.
892
+ # Returns a list of all scans in an account. Does not return `EXPRESS`
893
+ # scans.
893
894
  #
894
895
  # @option params [Integer] :max_results
895
896
  # The maximum number of results to return in the response. Use this
896
897
  # parameter when paginating results. If additional results exist beyond
897
898
  # the number you specify, the `nextToken` element is returned in the
898
899
  # response. Use `nextToken` in a subsequent request to retrieve
899
- # additional results.
900
+ # additional results. If not specified, returns 100 results.
900
901
  #
901
902
  # @option params [String] :next_token
902
903
  # A token to use for paginating results that are returned in the
@@ -942,7 +943,7 @@ module Aws::CodeGuruSecurity
942
943
  #
943
944
  # @option params [required, String] :resource_arn
944
945
  # The ARN of the `ScanName` object. You can retrieve this ARN by calling
945
- # `ListScans` or `GetScan`.
946
+ # `CreateScan`, `ListScans`, or `GetScan`.
946
947
  #
947
948
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
948
949
  #
@@ -972,7 +973,7 @@ module Aws::CodeGuruSecurity
972
973
  #
973
974
  # @option params [required, String] :resource_arn
974
975
  # The ARN of the `ScanName` object. You can retrieve this ARN by calling
975
- # `ListScans` or `GetScan`.
976
+ # `CreateScan`, `ListScans`, or `GetScan`.
976
977
  #
977
978
  # @option params [required, Hash<String,String>] :tags
978
979
  # An array of key-value pairs used to tag an existing scan. A tag is a
@@ -1009,7 +1010,7 @@ module Aws::CodeGuruSecurity
1009
1010
  #
1010
1011
  # @option params [required, String] :resource_arn
1011
1012
  # The ARN of the `ScanName` object. You can retrieve this ARN by calling
1012
- # `ListScans` or `GetScan`.
1013
+ # `CreateScan`, `ListScans`, or `GetScan`.
1013
1014
  #
1014
1015
  # @option params [required, Array<String>] :tag_keys
1015
1016
  # A list of keys for each tag you want to remove from a scan.
@@ -1032,11 +1033,14 @@ module Aws::CodeGuruSecurity
1032
1033
  req.send_request(options)
1033
1034
  end
1034
1035
 
1035
- # Use to update account-level configuration with an encryption key.
1036
+ # Use to update the encryption configuration for an account.
1036
1037
  #
1037
1038
  # @option params [required, Types::EncryptionConfig] :encryption_config
1038
- # The KMS key ARN you want to use for encryption. Defaults to
1039
- # service-side encryption if missing.
1039
+ # The customer-managed KMS key ARN you want to use for encryption. If
1040
+ # not specified, CodeGuru Security will use an AWS-managed key for
1041
+ # encryption. If you previously specified a customer-managed KMS key and
1042
+ # want CodeGuru Security to use an AWS-managed key for encryption
1043
+ # instead, pass nothing.
1040
1044
  #
1041
1045
  # @return [Types::UpdateAccountConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1042
1046
  #
@@ -1076,7 +1080,7 @@ module Aws::CodeGuruSecurity
1076
1080
  params: params,
1077
1081
  config: config)
1078
1082
  context[:gem_name] = 'aws-sdk-codegurusecurity'
1079
- context[:gem_version] = '1.12.0'
1083
+ context[:gem_version] = '1.13.0'
1080
1084
  Seahorse::Client::Request.new(handlers, context)
1081
1085
  end
1082
1086
 
@@ -34,6 +34,7 @@ module Aws::CodeGuruSecurity
34
34
  Double = Shapes::FloatShape.new(name: 'Double')
35
35
  EncryptionConfig = Shapes::StructureShape.new(name: 'EncryptionConfig')
36
36
  ErrorCode = Shapes::StringShape.new(name: 'ErrorCode')
37
+ ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
37
38
  FilePath = Shapes::StructureShape.new(name: 'FilePath')
38
39
  Finding = Shapes::StructureShape.new(name: 'Finding')
39
40
  FindingIdentifier = Shapes::StructureShape.new(name: 'FindingIdentifier')
@@ -251,6 +252,7 @@ module Aws::CodeGuruSecurity
251
252
 
252
253
  GetScanResponse.add_member(:analysis_type, Shapes::ShapeRef.new(shape: AnalysisType, required: true, location_name: "analysisType"))
253
254
  GetScanResponse.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "createdAt"))
255
+ GetScanResponse.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "errorMessage"))
254
256
  GetScanResponse.add_member(:number_of_revisions, Shapes::ShapeRef.new(shape: Long, location_name: "numberOfRevisions"))
255
257
  GetScanResponse.add_member(:run_id, Shapes::ShapeRef.new(shape: Uuid, required: true, location_name: "runId"))
256
258
  GetScanResponse.add_member(:scan_name, Shapes::ShapeRef.new(shape: ScanName, required: true, location_name: "scanName"))
@@ -392,7 +394,7 @@ module Aws::CodeGuruSecurity
392
394
 
393
395
  Vulnerability.add_member(:file_path, Shapes::ShapeRef.new(shape: FilePath, location_name: "filePath"))
394
396
  Vulnerability.add_member(:id, Shapes::ShapeRef.new(shape: String, location_name: "id"))
395
- Vulnerability.add_member(:item_count, Shapes::ShapeRef.new(shape: Integer, location_name: "itemCount"))
397
+ Vulnerability.add_member(:item_count, Shapes::ShapeRef.new(shape: Integer, deprecated: true, location_name: "itemCount", metadata: {"deprecatedMessage"=>"This shape is not used."}))
396
398
  Vulnerability.add_member(:reference_urls, Shapes::ShapeRef.new(shape: ReferenceUrls, location_name: "referenceUrls"))
397
399
  Vulnerability.add_member(:related_vulnerabilities, Shapes::ShapeRef.new(shape: RelatedVulnerabilities, location_name: "relatedVulnerabilities"))
398
400
  Vulnerability.struct_class = Types::Vulnerability
@@ -408,6 +410,7 @@ module Aws::CodeGuruSecurity
408
410
  "endpointPrefix" => "codeguru-security",
409
411
  "jsonVersion" => "1.1",
410
412
  "protocol" => "rest-json",
413
+ "protocols" => ["rest-json"],
411
414
  "serviceFullName" => "Amazon CodeGuru Security",
412
415
  "serviceId" => "CodeGuru Security",
413
416
  "signatureVersion" => "v4",
@@ -506,6 +509,7 @@ module Aws::CodeGuruSecurity
506
509
  o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
507
510
  o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
508
511
  o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
512
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
509
513
  o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
510
514
  end)
511
515
 
@@ -32,7 +32,7 @@ module Aws::CodeGuruSecurity
32
32
  raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
33
33
  end
34
34
  if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
35
- if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
35
+ if Aws::Endpoints::Matchers.boolean_equals?(Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"), true)
36
36
  return Aws::Endpoints::Endpoint.new(url: "https://codeguru-security-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
37
37
  end
38
38
  raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"
@@ -39,30 +39,29 @@ module Aws::CodeGuruSecurity
39
39
  include Aws::Structure
40
40
  end
41
41
 
42
- # A summary of findings metrics in an account.
42
+ # A summary of findings metrics for an account on a specified date.
43
43
  #
44
44
  # @!attribute [rw] closed_findings
45
- # The number of closed findings of each severity in an account on the
46
- # specified date.
45
+ # The number of closed findings of each severity on the specified
46
+ # date.
47
47
  # @return [Types::FindingMetricsValuePerSeverity]
48
48
  #
49
49
  # @!attribute [rw] date
50
- # The date from which the finding metrics were retrieved.
50
+ # The date from which the findings metrics were retrieved.
51
51
  # @return [Time]
52
52
  #
53
53
  # @!attribute [rw] mean_time_to_close
54
- # The average time it takes to close findings of each severity in
55
- # days.
54
+ # The average time in days it takes to close findings of each severity
55
+ # as of a specified date.
56
56
  # @return [Types::FindingMetricsValuePerSeverity]
57
57
  #
58
58
  # @!attribute [rw] new_findings
59
- # The number of new findings of each severity in account on the
60
- # specified date.
59
+ # The number of new findings of each severity on the specified date.
61
60
  # @return [Types::FindingMetricsValuePerSeverity]
62
61
  #
63
62
  # @!attribute [rw] open_findings
64
- # The number of open findings of each severity in an account as of the
65
- # specified date.
63
+ # The number of open findings of each severity as of the specified
64
+ # date.
66
65
  # @return [Types::FindingMetricsValuePerSeverity]
67
66
  #
68
67
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/AccountFindingsMetric AWS API Documentation
@@ -128,7 +127,7 @@ module Aws::CodeGuruSecurity
128
127
  # @return [Array<Types::BatchGetFindingsError>]
129
128
  #
130
129
  # @!attribute [rw] findings
131
- # A list of all requested findings.
130
+ # A list of all findings which were successfully fetched.
132
131
  # @return [Array<Types::Finding>]
133
132
  #
134
133
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/BatchGetFindingsResponse AWS API Documentation
@@ -228,13 +227,13 @@ module Aws::CodeGuruSecurity
228
227
  # @return [String]
229
228
  #
230
229
  # @!attribute [rw] resource_id
231
- # The identifier for an input resource used to create a scan.
230
+ # The identifier for the resource object to be scanned.
232
231
  # @return [Types::ResourceId]
233
232
  #
234
233
  # @!attribute [rw] scan_name
235
234
  # The unique name that CodeGuru Security uses to track revisions
236
235
  # across multiple scans of the same resource. Only allowed for a
237
- # `STANDARD` scan type. If not specified, it will be auto generated.
236
+ # `STANDARD` scan type.
238
237
  # @return [String]
239
238
  #
240
239
  # @!attribute [rw] scan_type
@@ -322,7 +321,8 @@ module Aws::CodeGuruSecurity
322
321
  end
323
322
 
324
323
  # @!attribute [rw] code_artifact_id
325
- # The identifier for the uploaded code resource.
324
+ # The identifier for the uploaded code resource. Pass this to
325
+ # `CreateScan` to use the uploaded resources.
326
326
  # @return [String]
327
327
  #
328
328
  # @!attribute [rw] request_headers
@@ -332,7 +332,7 @@ module Aws::CodeGuruSecurity
332
332
  #
333
333
  # @!attribute [rw] s3_url
334
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.
335
+ # with the required `requestHeaders` using any HTTP client.
336
336
  # @return [String]
337
337
  #
338
338
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/CreateUploadUrlResponse AWS API Documentation
@@ -345,11 +345,12 @@ module Aws::CodeGuruSecurity
345
345
  include Aws::Structure
346
346
  end
347
347
 
348
- # Information about account-level configuration.
348
+ # Information about the encryption configuration for an account.
349
+ # Required to call `UpdateAccountConfiguration`.
349
350
  #
350
351
  # @!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.
352
+ # The KMS key ARN that is used for encryption. If an AWS-managed key
353
+ # is used for encryption, returns empty.
353
354
  # @return [String]
354
355
  #
355
356
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/EncryptionConfig AWS API Documentation
@@ -427,7 +428,7 @@ module Aws::CodeGuruSecurity
427
428
  #
428
429
  # @!attribute [rw] generator_id
429
430
  # The identifier for the component that generated a finding such as
430
- # AWSCodeGuruSecurity or AWSInspector.
431
+ # AmazonCodeGuruSecurity.
431
432
  # @return [String]
432
433
  #
433
434
  # @!attribute [rw] id
@@ -448,7 +449,13 @@ module Aws::CodeGuruSecurity
448
449
  # @return [String]
449
450
  #
450
451
  # @!attribute [rw] severity
451
- # The severity of the finding.
452
+ # The severity of the finding. Severity can be critical, high, medium,
453
+ # low, or informational. For information on severity levels, see
454
+ # [Finding severity][1] in the *Amazon CodeGuru Security User Guide*.
455
+ #
456
+ #
457
+ #
458
+ # [1]: https://docs.aws.amazon.com/codeguru/latest/security-ug/findings-overview.html#severity-distribution
452
459
  # @return [String]
453
460
  #
454
461
  # @!attribute [rw] status
@@ -515,31 +522,28 @@ module Aws::CodeGuruSecurity
515
522
  include Aws::Structure
516
523
  end
517
524
 
518
- # The severity of the issue in the code that generated a finding.
525
+ # A numeric value corresponding to the severity of a finding, such as
526
+ # the number of open findings or the average time it takes to close
527
+ # findings of a given severity.
519
528
  #
520
529
  # @!attribute [rw] critical
521
- # The severity of the finding is critical and should be addressed
522
- # immediately.
530
+ # A numeric value corresponding to a critical finding.
523
531
  # @return [Float]
524
532
  #
525
533
  # @!attribute [rw] high
526
- # The severity of the finding is high and should be addressed as a
527
- # near-term priority.
534
+ # A numeric value corresponding to a high severity finding.
528
535
  # @return [Float]
529
536
  #
530
537
  # @!attribute [rw] info
531
- # The finding is related to quality or readability improvements and
532
- # not considered actionable.
538
+ # A numeric value corresponding to an informational finding.
533
539
  # @return [Float]
534
540
  #
535
541
  # @!attribute [rw] low
536
- # The severity of the finding is low and does require action on its
537
- # own.
542
+ # A numeric value corresponding to a low severity finding.
538
543
  # @return [Float]
539
544
  #
540
545
  # @!attribute [rw] medium
541
- # The severity of the finding is medium and should be addressed as a
542
- # mid-term priority.
546
+ # A numeric value corresponding to a medium severity finding.
543
547
  # @return [Float]
544
548
  #
545
549
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/FindingMetricsValuePerSeverity AWS API Documentation
@@ -561,10 +565,11 @@ module Aws::CodeGuruSecurity
561
565
  class GetAccountConfigurationRequest < Aws::EmptyStructure; end
562
566
 
563
567
  # @!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
+ # An `EncryptionConfig` object that contains the KMS key ARN that is
569
+ # used for encryption. By default, CodeGuru Security uses an
570
+ # AWS-managed key for encryption. To specify your own key, call
571
+ # `UpdateAccountConfiguration`. If you do not specify a
572
+ # customer-managed key, returns empty.
568
573
  # @return [Types::EncryptionConfig]
569
574
  #
570
575
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/GetAccountConfigurationResponse AWS API Documentation
@@ -580,7 +585,7 @@ module Aws::CodeGuruSecurity
580
585
  # parameter when paginating results. If additional results exist
581
586
  # beyond the number you specify, the `nextToken` element is returned
582
587
  # in the response. Use `nextToken` in a subsequent request to retrieve
583
- # additional results.
588
+ # additional results. If not specified, returns 1000 results.
584
589
  # @return [Integer]
585
590
  #
586
591
  # @!attribute [rw] next_token
@@ -631,9 +636,7 @@ module Aws::CodeGuruSecurity
631
636
 
632
637
  # @!attribute [rw] date
633
638
  # 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.
639
+ # nearest day. The date must be within the past two years.
637
640
  # @return [Time]
638
641
  #
639
642
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/GetMetricsSummaryRequest AWS API Documentation
@@ -686,6 +689,10 @@ module Aws::CodeGuruSecurity
686
689
  # The time the scan was created.
687
690
  # @return [Time]
688
691
  #
692
+ # @!attribute [rw] error_message
693
+ # Details about the error that causes a scan to fail to be retrieved.
694
+ # @return [String]
695
+ #
689
696
  # @!attribute [rw] number_of_revisions
690
697
  # The number of times a scan has been re-run on a revised resource.
691
698
  # @return [Integer]
@@ -703,7 +710,7 @@ module Aws::CodeGuruSecurity
703
710
  # @return [String]
704
711
  #
705
712
  # @!attribute [rw] scan_state
706
- # The current state of the scan. Pass either `InProgress`,
713
+ # The current state of the scan. Returns either `InProgress`,
707
714
  # `Successful`, or `Failed`.
708
715
  # @return [String]
709
716
  #
@@ -717,6 +724,7 @@ module Aws::CodeGuruSecurity
717
724
  class GetScanResponse < Struct.new(
718
725
  :analysis_type,
719
726
  :created_at,
727
+ :error_message,
720
728
  :number_of_revisions,
721
729
  :run_id,
722
730
  :scan_name,
@@ -749,7 +757,7 @@ module Aws::CodeGuruSecurity
749
757
 
750
758
  # @!attribute [rw] end_date
751
759
  # The end date of the interval which you want to retrieve metrics
752
- # from.
760
+ # from. Round to the nearest day.
753
761
  # @return [Time]
754
762
  #
755
763
  # @!attribute [rw] max_results
@@ -757,7 +765,7 @@ module Aws::CodeGuruSecurity
757
765
  # parameter when paginating results. If additional results exist
758
766
  # beyond the number you specify, the `nextToken` element is returned
759
767
  # in the response. Use `nextToken` in a subsequent request to retrieve
760
- # additional results.
768
+ # additional results. If not specified, returns 1000 results.
761
769
  # @return [Integer]
762
770
  #
763
771
  # @!attribute [rw] next_token
@@ -770,7 +778,7 @@ module Aws::CodeGuruSecurity
770
778
  #
771
779
  # @!attribute [rw] start_date
772
780
  # The start date of the interval which you want to retrieve metrics
773
- # from.
781
+ # from. Rounds to the nearest day.
774
782
  # @return [Time]
775
783
  #
776
784
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ListFindingsMetricsRequest AWS API Documentation
@@ -809,7 +817,7 @@ module Aws::CodeGuruSecurity
809
817
  # parameter when paginating results. If additional results exist
810
818
  # beyond the number you specify, the `nextToken` element is returned
811
819
  # in the response. Use `nextToken` in a subsequent request to retrieve
812
- # additional results.
820
+ # additional results. If not specified, returns 100 results.
813
821
  # @return [Integer]
814
822
  #
815
823
  # @!attribute [rw] next_token
@@ -850,7 +858,7 @@ module Aws::CodeGuruSecurity
850
858
 
851
859
  # @!attribute [rw] resource_arn
852
860
  # The ARN of the `ScanName` object. You can retrieve this ARN by
853
- # calling `ListScans` or `GetScan`.
861
+ # calling `CreateScan`, `ListScans`, or `GetScan`.
854
862
  # @return [String]
855
863
  #
856
864
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ListTagsForResourceRequest AWS API Documentation
@@ -881,11 +889,11 @@ module Aws::CodeGuruSecurity
881
889
  include Aws::Structure
882
890
  end
883
891
 
884
- # Information about summary metrics in an account.
892
+ # A summary of metrics for an account as of a specified date.
885
893
  #
886
894
  # @!attribute [rw] categories_with_most_findings
887
895
  # A list of `CategoryWithFindingNum` objects for the top 5 finding
888
- # categories with the most open findings in an account.
896
+ # categories with the most findings.
889
897
  # @return [Array<Types::CategoryWithFindingNum>]
890
898
  #
891
899
  # @!attribute [rw] date
@@ -893,17 +901,17 @@ module Aws::CodeGuruSecurity
893
901
  # @return [Time]
894
902
  #
895
903
  # @!attribute [rw] open_findings
896
- # The number of open findings of each severity in an account.
904
+ # The number of open findings of each severity.
897
905
  # @return [Types::FindingMetricsValuePerSeverity]
898
906
  #
899
907
  # @!attribute [rw] scans_with_most_open_critical_findings
900
908
  # A list of `ScanNameWithFindingNum` objects for the top 3 scans with
901
- # the most number of open findings in an account.
909
+ # the most number of open critical findings.
902
910
  # @return [Array<Types::ScanNameWithFindingNum>]
903
911
  #
904
912
  # @!attribute [rw] scans_with_most_open_findings
905
913
  # A list of `ScanNameWithFindingNum` objects for the top 3 scans with
906
- # the most number of open critical findings in an account.
914
+ # the most number of open findings.
907
915
  # @return [Array<Types::ScanNameWithFindingNum>]
908
916
  #
909
917
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/MetricsSummary AWS API Documentation
@@ -959,16 +967,14 @@ module Aws::CodeGuruSecurity
959
967
  include Aws::Structure
960
968
  end
961
969
 
962
- # Information about a resource, such as an Amazon S3 bucket or AWS
963
- # Lambda function, that contains a finding.
970
+ # Information about a resource that contains a finding.
964
971
  #
965
972
  # @!attribute [rw] id
966
- # The identifier for the resource.
973
+ # The `scanName` of the scan that was run on the resource.
967
974
  # @return [String]
968
975
  #
969
976
  # @!attribute [rw] sub_resource_id
970
- # The identifier for a section of the resource, such as an AWS Lambda
971
- # layer.
977
+ # The identifier for a section of the resource.
972
978
  # @return [String]
973
979
  #
974
980
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/Resource AWS API Documentation
@@ -980,16 +986,17 @@ module Aws::CodeGuruSecurity
980
986
  include Aws::Structure
981
987
  end
982
988
 
983
- # The identifier for a resource object that contains resources where a
984
- # finding was detected.
989
+ # The identifier for a resource object that contains resources to scan.
990
+ # Specifying a codeArtifactId is required to create a scan.
985
991
  #
986
992
  # @note ResourceId is a union - when making an API calls you must set exactly one of the members.
987
993
  #
988
994
  # @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
995
  #
990
996
  # @!attribute [rw] code_artifact_id
991
- # The identifier for the code file uploaded to the resource where a
992
- # finding was detected.
997
+ # The identifier for the code file uploaded to the resource object.
998
+ # Returned by `CreateUploadUrl` when you upload resources to be
999
+ # scanned.
993
1000
  # @return [String]
994
1001
  #
995
1002
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ResourceId AWS API Documentation
@@ -1034,10 +1041,10 @@ module Aws::CodeGuruSecurity
1034
1041
  include Aws::Structure
1035
1042
  end
1036
1043
 
1037
- # Information about a scan with open findings.
1044
+ # Information about the number of findings generated by a scan.
1038
1045
  #
1039
1046
  # @!attribute [rw] finding_number
1040
- # The number of open findings generated by a scan.
1047
+ # The number of findings generated by a scan.
1041
1048
  # @return [Integer]
1042
1049
  #
1043
1050
  # @!attribute [rw] scan_name
@@ -1097,7 +1104,8 @@ module Aws::CodeGuruSecurity
1097
1104
  # Information about the suggested code fix to remediate a finding.
1098
1105
  #
1099
1106
  # @!attribute [rw] code
1100
- # The suggested code to add to your file.
1107
+ # The suggested code fix. If applicable, includes code patch to
1108
+ # replace your source code.
1101
1109
  # @return [String]
1102
1110
  #
1103
1111
  # @!attribute [rw] description
@@ -1116,7 +1124,7 @@ module Aws::CodeGuruSecurity
1116
1124
 
1117
1125
  # @!attribute [rw] resource_arn
1118
1126
  # The ARN of the `ScanName` object. You can retrieve this ARN by
1119
- # calling `ListScans` or `GetScan`.
1127
+ # calling `CreateScan`, `ListScans`, or `GetScan`.
1120
1128
  # @return [String]
1121
1129
  #
1122
1130
  # @!attribute [rw] tags
@@ -1175,7 +1183,7 @@ module Aws::CodeGuruSecurity
1175
1183
 
1176
1184
  # @!attribute [rw] resource_arn
1177
1185
  # The ARN of the `ScanName` object. You can retrieve this ARN by
1178
- # calling `ListScans` or `GetScan`.
1186
+ # calling `CreateScan`, `ListScans`, or `GetScan`.
1179
1187
  # @return [String]
1180
1188
  #
1181
1189
  # @!attribute [rw] tag_keys
@@ -1196,8 +1204,11 @@ module Aws::CodeGuruSecurity
1196
1204
  class UntagResourceResponse < Aws::EmptyStructure; end
1197
1205
 
1198
1206
  # @!attribute [rw] encryption_config
1199
- # The KMS key ARN you want to use for encryption. Defaults to
1200
- # service-side encryption if missing.
1207
+ # The customer-managed KMS key ARN you want to use for encryption. If
1208
+ # not specified, CodeGuru Security will use an AWS-managed key for
1209
+ # encryption. If you previously specified a customer-managed KMS key
1210
+ # and want CodeGuru Security to use an AWS-managed key for encryption
1211
+ # instead, pass nothing.
1201
1212
  # @return [Types::EncryptionConfig]
1202
1213
  #
1203
1214
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/UpdateAccountConfigurationRequest AWS API Documentation
@@ -1209,8 +1220,9 @@ module Aws::CodeGuruSecurity
1209
1220
  end
1210
1221
 
1211
1222
  # @!attribute [rw] encryption_config
1212
- # An `EncryptionConfig` object that contains the KMS key ARN to use
1213
- # for encryption.
1223
+ # An `EncryptionConfig` object that contains the KMS key ARN that is
1224
+ # used for encryption. If you did not specify a customer-managed KMS
1225
+ # key in the request, returns empty.
1214
1226
  # @return [Types::EncryptionConfig]
1215
1227
  #
1216
1228
  # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/UpdateAccountConfigurationResponse AWS API Documentation
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-codegurusecurity/customizations'
52
52
  # @!group service
53
53
  module Aws::CodeGuruSecurity
54
54
 
55
- GEM_VERSION = '1.12.0'
55
+ GEM_VERSION = '1.13.0'
56
56
 
57
57
  end
data/sig/client.rbs CHANGED
@@ -158,6 +158,7 @@ module Aws
158
158
  include ::Seahorse::Client::_ResponseSuccess[Types::GetScanResponse]
159
159
  def analysis_type: () -> ("Security" | "All")
160
160
  def created_at: () -> ::Time
161
+ def error_message: () -> ::String
161
162
  def number_of_revisions: () -> ::Integer
162
163
  def run_id: () -> ::String
163
164
  def scan_name: () -> ::String
data/sig/types.rbs CHANGED
@@ -185,6 +185,7 @@ module Aws::CodeGuruSecurity
185
185
  class GetScanResponse
186
186
  attr_accessor analysis_type: ("Security" | "All")
187
187
  attr_accessor created_at: ::Time
188
+ attr_accessor error_message: ::String
188
189
  attr_accessor number_of_revisions: ::Integer
189
190
  attr_accessor run_id: ::String
190
191
  attr_accessor scan_name: ::String
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-codegurusecurity
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.12.0
4
+ version: 1.13.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-05-13 00:00:00.000000000 Z
11
+ date: 2024-05-31 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core