aws-sdk-codegurusecurity 1.12.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f383918f8ada5f7d35336ca4f9d5b00111803ebbdef0a5b1e83f086a8707d170
-  data.tar.gz: 9f2bdc5af34480c3d9de15850bb9c74f80ff9188acc897a31c45da6ff015b001
+  metadata.gz: 6c362af04c626d21e889d226a31e1fae252a81dcf072003289801c7ab6bbb2f9
+  data.tar.gz: e81336e6d6fb556968887025382ad4c1eb642c6ade3482ee00c17defd407bbbf
 SHA512:
-  metadata.gz: 3860920c5060dd9e939ee83199e2cbf9fa131ee28183a951f1e56058da39eb29ba2ad4b38a748e7fb64ef25731cb6655e47e196d0c670b1761a9a3da91fd86d7
-  data.tar.gz: 16cfa17e1f07dc81a2c9ae60fe4e2a58f6ca5d61f7598dd7e5f6babf734e37367587e716c6fda1aac63f5879910b518fbef432e4b1c4e8d51b0a2cbd4bacc0f8
+  metadata.gz: 4c6a7709a7c2bc594039f093dda60c8fba1ae932c859a39cc1df65328fe5e75d0a4b54423c1b6be97971dafe8caedcb20c48f16ea0ea84cade72a265b807b262
+  data.tar.gz: f7209f9bd4ceae708c4294ae3df9fa4738406e731518abe600884d2fd41f863232cda355259a7dd6561c3087aada6bd04d9c3c9d7a71201bf45cd8fc70c96913

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.13.0 (2024-05-31)
+------------------
+
+* Feature - This release includes minor model updates and documentation updates.
+
 1.12.0 (2024-05-13)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.12.0
+1.13.0

data/lib/aws-sdk-codegurusecurity/client.rb

@@ -413,7 +413,7 @@ module Aws::CodeGuruSecurity
 
     # @!group API Operations
 
-    # Returns a list of all requested findings.
+    # Returns a list of requested findings from standard scans.
     #
     # @option params [required, Array<Types::FindingIdentifier>] :finding_identifiers
     #   A list of finding identifiers. Each identifier consists of a
@@ -488,7 +488,7 @@ module Aws::CodeGuruSecurity
       req.send_request(options)
     end
 
-    # Use to create a scan using code uploaded to an S3 bucket.
+    # Use to create a scan using code uploaded to an Amazon S3 bucket.
     #
     # @option params [String] :analysis_type
     #   The type of analysis you want CodeGuru Security to perform in the
@@ -505,12 +505,12 @@ module Aws::CodeGuruSecurity
     #   not need to pass this option.**
     #
     # @option params [required, Types::ResourceId] :resource_id
-    #   The identifier for an input resource used to create a scan.
+    #   The identifier for the resource object to be scanned.
     #
     # @option params [required, String] :scan_name
     #   The unique name that CodeGuru Security uses to track revisions across
     #   multiple scans of the same resource. Only allowed for a `STANDARD`
-    #   scan type. If not specified, it will be auto generated.
+    #   scan type.
     #
     # @option params [String] :scan_type
     #   The type of scan, either `Standard` or `Express`. Defaults to
@@ -572,11 +572,11 @@ module Aws::CodeGuruSecurity
       req.send_request(options)
     end
 
-    # Generates a pre-signed URL and request headers used to upload a code
-    # resource.
+    # Generates a pre-signed URL, request headers used to upload a code
+    # resource, and code artifact identifier for the uploaded resource.
     #
-    # You can upload your code resource to the URL and add the request
-    # headers using any HTTP client.
+    # You can upload your code resource to the URL with the request headers
+    # using any HTTP client.
     #
     # @option params [required, String] :scan_name
     #   The name of the scan that will use the uploaded resource. CodeGuru
@@ -612,7 +612,7 @@ module Aws::CodeGuruSecurity
       req.send_request(options)
     end
 
-    # Use to get account level configuration.
+    # Use to get the encryption configuration for an account.
     #
     # @return [Types::GetAccountConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -638,7 +638,7 @@ module Aws::CodeGuruSecurity
     #   parameter when paginating results. If additional results exist beyond
     #   the number you specify, the `nextToken` element is returned in the
     #   response. Use `nextToken` in a subsequent request to retrieve
-    #   additional results.
+    #   additional results. If not specified, returns 1000 results.
     #
     # @option params [String] :next_token
     #   A token to use for paginating results that are returned in the
@@ -717,16 +717,14 @@ module Aws::CodeGuruSecurity
       req.send_request(options)
     end
 
-    # Returns top level metrics about an account from a specified date,
+    # Returns a summary of metrics for an account from a specified date,
     # including number of open findings, the categories with most findings,
     # the scans with most open findings, and scans with most open critical
     # findings.
     #
     # @option params [required, Time,DateTime,Date,Integer,String] :date
     #   The date you want to retrieve summary metrics from, rounded to the
-    #   nearest day. The date must be within the past two years since metrics
-    #   data is only stored for two years. If a date outside of this range is
-    #   passed, the response will be empty.
+    #   nearest day. The date must be within the past two years.
     #
     # @return [Types::GetMetricsSummaryResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -780,6 +778,7 @@ module Aws::CodeGuruSecurity
     #
     #   * {Types::GetScanResponse#analysis_type #analysis_type} => String
     #   * {Types::GetScanResponse#created_at #created_at} => Time
+    #   * {Types::GetScanResponse#error_message #error_message} => String
     #   * {Types::GetScanResponse#number_of_revisions #number_of_revisions} => Integer
     #   * {Types::GetScanResponse#run_id #run_id} => String
     #   * {Types::GetScanResponse#scan_name #scan_name} => String
@@ -798,6 +797,7 @@ module Aws::CodeGuruSecurity
     #
     #   resp.analysis_type #=> String, one of "Security", "All"
     #   resp.created_at #=> Time
+    #   resp.error_message #=> String
     #   resp.number_of_revisions #=> Integer
     #   resp.run_id #=> String
     #   resp.scan_name #=> String
@@ -819,13 +819,14 @@ module Aws::CodeGuruSecurity
     #
     # @option params [required, Time,DateTime,Date,Integer,String] :end_date
     #   The end date of the interval which you want to retrieve metrics from.
+    #   Round to the nearest day.
     #
     # @option params [Integer] :max_results
     #   The maximum number of results to return in the response. Use this
     #   parameter when paginating results. If additional results exist beyond
     #   the number you specify, the `nextToken` element is returned in the
     #   response. Use `nextToken` in a subsequent request to retrieve
-    #   additional results.
+    #   additional results. If not specified, returns 1000 results.
     #
     # @option params [String] :next_token
     #   A token to use for paginating results that are returned in the
@@ -835,7 +836,7 @@ module Aws::CodeGuruSecurity
     #
     # @option params [required, Time,DateTime,Date,Integer,String] :start_date
     #   The start date of the interval which you want to retrieve metrics
-    #   from.
+    #   from. Rounds to the nearest day.
     #
     # @return [Types::ListFindingsMetricsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -888,15 +889,15 @@ module Aws::CodeGuruSecurity
       req.send_request(options)
     end
 
-    # Returns a list of all the standard scans in an account. Does not
-    # return express scans.
+    # Returns a list of all scans in an account. Does not return `EXPRESS`
+    # scans.
     #
     # @option params [Integer] :max_results
     #   The maximum number of results to return in the response. Use this
     #   parameter when paginating results. If additional results exist beyond
     #   the number you specify, the `nextToken` element is returned in the
     #   response. Use `nextToken` in a subsequent request to retrieve
-    #   additional results.
+    #   additional results. If not specified, returns 100 results.
     #
     # @option params [String] :next_token
     #   A token to use for paginating results that are returned in the
@@ -942,7 +943,7 @@ module Aws::CodeGuruSecurity
     #
     # @option params [required, String] :resource_arn
     #   The ARN of the `ScanName` object. You can retrieve this ARN by calling
-    #   `ListScans` or `GetScan`.
+    #   `CreateScan`, `ListScans`, or `GetScan`.
     #
     # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -972,7 +973,7 @@ module Aws::CodeGuruSecurity
     #
     # @option params [required, String] :resource_arn
     #   The ARN of the `ScanName` object. You can retrieve this ARN by calling
-    #   `ListScans` or `GetScan`.
+    #   `CreateScan`, `ListScans`, or `GetScan`.
     #
     # @option params [required, Hash<String,String>] :tags
     #   An array of key-value pairs used to tag an existing scan. A tag is a
@@ -1009,7 +1010,7 @@ module Aws::CodeGuruSecurity
     #
     # @option params [required, String] :resource_arn
     #   The ARN of the `ScanName` object. You can retrieve this ARN by calling
-    #   `ListScans` or `GetScan`.
+    #   `CreateScan`, `ListScans`, or `GetScan`.
     #
     # @option params [required, Array<String>] :tag_keys
     #   A list of keys for each tag you want to remove from a scan.
@@ -1032,11 +1033,14 @@ module Aws::CodeGuruSecurity
       req.send_request(options)
     end
 
-    # Use to update account-level configuration with an encryption key.
+    # Use to update the encryption configuration for an account.
     #
     # @option params [required, Types::EncryptionConfig] :encryption_config
-    #   The KMS key ARN you want to use for encryption. Defaults to
-    #   service-side encryption if missing.
+    #   The customer-managed KMS key ARN you want to use for encryption. If
+    #   not specified, CodeGuru Security will use an AWS-managed key for
+    #   encryption. If you previously specified a customer-managed KMS key and
+    #   want CodeGuru Security to use an AWS-managed key for encryption
+    #   instead, pass nothing.
     #
     # @return [Types::UpdateAccountConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -1076,7 +1080,7 @@ module Aws::CodeGuruSecurity
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-codegurusecurity'
-      context[:gem_version] = '1.12.0'
+      context[:gem_version] = '1.13.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-codegurusecurity/client_api.rb

@@ -34,6 +34,7 @@ module Aws::CodeGuruSecurity
     Double = Shapes::FloatShape.new(name: 'Double')
     EncryptionConfig = Shapes::StructureShape.new(name: 'EncryptionConfig')
     ErrorCode = Shapes::StringShape.new(name: 'ErrorCode')
+    ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
     FilePath = Shapes::StructureShape.new(name: 'FilePath')
     Finding = Shapes::StructureShape.new(name: 'Finding')
     FindingIdentifier = Shapes::StructureShape.new(name: 'FindingIdentifier')
@@ -251,6 +252,7 @@ module Aws::CodeGuruSecurity
 
     GetScanResponse.add_member(:analysis_type, Shapes::ShapeRef.new(shape: AnalysisType, required: true, location_name: "analysisType"))
     GetScanResponse.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "createdAt"))
+    GetScanResponse.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "errorMessage"))
     GetScanResponse.add_member(:number_of_revisions, Shapes::ShapeRef.new(shape: Long, location_name: "numberOfRevisions"))
     GetScanResponse.add_member(:run_id, Shapes::ShapeRef.new(shape: Uuid, required: true, location_name: "runId"))
     GetScanResponse.add_member(:scan_name, Shapes::ShapeRef.new(shape: ScanName, required: true, location_name: "scanName"))
@@ -392,7 +394,7 @@ module Aws::CodeGuruSecurity
 
     Vulnerability.add_member(:file_path, Shapes::ShapeRef.new(shape: FilePath, location_name: "filePath"))
     Vulnerability.add_member(:id, Shapes::ShapeRef.new(shape: String, location_name: "id"))
-    Vulnerability.add_member(:item_count, Shapes::ShapeRef.new(shape: Integer, location_name: "itemCount"))
+    Vulnerability.add_member(:item_count, Shapes::ShapeRef.new(shape: Integer, deprecated: true, location_name: "itemCount", metadata: {"deprecatedMessage"=>"This shape is not used."}))
     Vulnerability.add_member(:reference_urls, Shapes::ShapeRef.new(shape: ReferenceUrls, location_name: "referenceUrls"))
     Vulnerability.add_member(:related_vulnerabilities, Shapes::ShapeRef.new(shape: RelatedVulnerabilities, location_name: "relatedVulnerabilities"))
     Vulnerability.struct_class = Types::Vulnerability
@@ -408,6 +410,7 @@ module Aws::CodeGuruSecurity
         "endpointPrefix" => "codeguru-security",
         "jsonVersion" => "1.1",
         "protocol" => "rest-json",
+        "protocols" => ["rest-json"],
         "serviceFullName" => "Amazon CodeGuru Security",
         "serviceId" => "CodeGuru Security",
         "signatureVersion" => "v4",
@@ -506,6 +509,7 @@ module Aws::CodeGuruSecurity
         o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
         o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
         o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
         o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
       end)
 

data/lib/aws-sdk-codegurusecurity/endpoint_provider.rb

@@ -32,7 +32,7 @@ module Aws::CodeGuruSecurity
             raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
           end
           if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
-            if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
+            if Aws::Endpoints::Matchers.boolean_equals?(Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"), true)
               return Aws::Endpoints::Endpoint.new(url: "https://codeguru-security-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
             end
             raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"

data/lib/aws-sdk-codegurusecurity/types.rb

@@ -39,30 +39,29 @@ module Aws::CodeGuruSecurity
       include Aws::Structure
     end
 
-    # A summary of findings metrics in an account.
+    # A summary of findings metrics for an account on a specified date.
     #
     # @!attribute [rw] closed_findings
-    #   The number of closed findings of each severity in an account on the
-    #   specified date.
+    #   The number of closed findings of each severity on the specified
+    #   date.
     #   @return [Types::FindingMetricsValuePerSeverity]
     #
     # @!attribute [rw] date
-    #   The date from which the finding metrics were retrieved.
+    #   The date from which the findings metrics were retrieved.
     #   @return [Time]
     #
     # @!attribute [rw] mean_time_to_close
-    #   The average time it takes to close findings of each severity in
-    #   days.
+    #   The average time in days it takes to close findings of each severity
+    #   as of a specified date.
     #   @return [Types::FindingMetricsValuePerSeverity]
     #
     # @!attribute [rw] new_findings
-    #   The number of new findings of each severity in account on the
-    #   specified date.
+    #   The number of new findings of each severity on the specified date.
     #   @return [Types::FindingMetricsValuePerSeverity]
     #
     # @!attribute [rw] open_findings
-    #   The number of open findings of each severity in an account as of the
-    #   specified date.
+    #   The number of open findings of each severity as of the specified
+    #   date.
     #   @return [Types::FindingMetricsValuePerSeverity]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/AccountFindingsMetric AWS API Documentation
@@ -128,7 +127,7 @@ module Aws::CodeGuruSecurity
     #   @return [Array<Types::BatchGetFindingsError>]
     #
     # @!attribute [rw] findings
-    #   A list of all requested findings.
+    #   A list of all findings which were successfully fetched.
     #   @return [Array<Types::Finding>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/BatchGetFindingsResponse AWS API Documentation
@@ -228,13 +227,13 @@ module Aws::CodeGuruSecurity
     #   @return [String]
     #
     # @!attribute [rw] resource_id
-    #   The identifier for an input resource used to create a scan.
+    #   The identifier for the resource object to be scanned.
     #   @return [Types::ResourceId]
     #
     # @!attribute [rw] scan_name
     #   The unique name that CodeGuru Security uses to track revisions
     #   across multiple scans of the same resource. Only allowed for a
-    #   `STANDARD` scan type. If not specified, it will be auto generated.
+    #   `STANDARD` scan type.
     #   @return [String]
     #
     # @!attribute [rw] scan_type
@@ -322,7 +321,8 @@ module Aws::CodeGuruSecurity
     end
 
     # @!attribute [rw] code_artifact_id
-    #   The identifier for the uploaded code resource.
+    #   The identifier for the uploaded code resource. Pass this to
+    #   `CreateScan` to use the uploaded resources.
     #   @return [String]
     #
     # @!attribute [rw] request_headers
@@ -332,7 +332,7 @@ module Aws::CodeGuruSecurity
     #
     # @!attribute [rw] s3_url
     #   A pre-signed S3 URL. You can upload the code file you want to scan
-    #   and add the required `requestHeaders` using any HTTP client.
+    #   with the required `requestHeaders` using any HTTP client.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/CreateUploadUrlResponse AWS API Documentation
@@ -345,11 +345,12 @@ module Aws::CodeGuruSecurity
       include Aws::Structure
     end
 
-    # Information about account-level configuration.
+    # Information about the encryption configuration for an account.
+    # Required to call `UpdateAccountConfiguration`.
     #
     # @!attribute [rw] kms_key_arn
-    #   The KMS key ARN to use for encryption. This must be provided as a
-    #   header when uploading your code resource.
+    #   The KMS key ARN that is used for encryption. If an AWS-managed key
+    #   is used for encryption, returns empty.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/EncryptionConfig AWS API Documentation
@@ -427,7 +428,7 @@ module Aws::CodeGuruSecurity
     #
     # @!attribute [rw] generator_id
     #   The identifier for the component that generated a finding such as
-    #   AWSCodeGuruSecurity or AWSInspector.
+    #   AmazonCodeGuruSecurity.
     #   @return [String]
     #
     # @!attribute [rw] id
@@ -448,7 +449,13 @@ module Aws::CodeGuruSecurity
     #   @return [String]
     #
     # @!attribute [rw] severity
-    #   The severity of the finding.
+    #   The severity of the finding. Severity can be critical, high, medium,
+    #   low, or informational. For information on severity levels, see
+    #   [Finding severity][1] in the *Amazon CodeGuru Security User Guide*.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/codeguru/latest/security-ug/findings-overview.html#severity-distribution
     #   @return [String]
     #
     # @!attribute [rw] status
@@ -515,31 +522,28 @@ module Aws::CodeGuruSecurity
       include Aws::Structure
     end
 
-    # The severity of the issue in the code that generated a finding.
+    # A numeric value corresponding to the severity of a finding, such as
+    # the number of open findings or the average time it takes to close
+    # findings of a given severity.
     #
     # @!attribute [rw] critical
-    #   The severity of the finding is critical and should be addressed
-    #   immediately.
+    #   A numeric value corresponding to a critical finding.
     #   @return [Float]
     #
     # @!attribute [rw] high
-    #   The severity of the finding is high and should be addressed as a
-    #   near-term priority.
+    #   A numeric value corresponding to a high severity finding.
     #   @return [Float]
     #
     # @!attribute [rw] info
-    #   The finding is related to quality or readability improvements and
-    #   not considered actionable.
+    #   A numeric value corresponding to an informational finding.
     #   @return [Float]
     #
     # @!attribute [rw] low
-    #   The severity of the finding is low and does require action on its
-    #   own.
+    #   A numeric value corresponding to a low severity finding.
     #   @return [Float]
     #
     # @!attribute [rw] medium
-    #   The severity of the finding is medium and should be addressed as a
-    #   mid-term priority.
+    #   A numeric value corresponding to a medium severity finding.
     #   @return [Float]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/FindingMetricsValuePerSeverity AWS API Documentation
@@ -561,10 +565,11 @@ module Aws::CodeGuruSecurity
     class GetAccountConfigurationRequest < Aws::EmptyStructure; end
 
     # @!attribute [rw] encryption_config
-    #   An `EncryptionConfig` object that contains the KMS key ARN to use
-    #   for encryption. By default, CodeGuru Security uses an AWS-managed
-    #   key for encryption. To specify your own key, call
-    #   `UpdateAccountConfiguration`.
+    #   An `EncryptionConfig` object that contains the KMS key ARN that is
+    #   used for encryption. By default, CodeGuru Security uses an
+    #   AWS-managed key for encryption. To specify your own key, call
+    #   `UpdateAccountConfiguration`. If you do not specify a
+    #   customer-managed key, returns empty.
     #   @return [Types::EncryptionConfig]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/GetAccountConfigurationResponse AWS API Documentation
@@ -580,7 +585,7 @@ module Aws::CodeGuruSecurity
     #   parameter when paginating results. If additional results exist
     #   beyond the number you specify, the `nextToken` element is returned
     #   in the response. Use `nextToken` in a subsequent request to retrieve
-    #   additional results.
+    #   additional results. If not specified, returns 1000 results.
     #   @return [Integer]
     #
     # @!attribute [rw] next_token
@@ -631,9 +636,7 @@ module Aws::CodeGuruSecurity
 
     # @!attribute [rw] date
     #   The date you want to retrieve summary metrics from, rounded to the
-    #   nearest day. The date must be within the past two years since
-    #   metrics data is only stored for two years. If a date outside of this
-    #   range is passed, the response will be empty.
+    #   nearest day. The date must be within the past two years.
     #   @return [Time]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/GetMetricsSummaryRequest AWS API Documentation
@@ -686,6 +689,10 @@ module Aws::CodeGuruSecurity
     #   The time the scan was created.
     #   @return [Time]
     #
+    # @!attribute [rw] error_message
+    #   Details about the error that causes a scan to fail to be retrieved.
+    #   @return [String]
+    #
     # @!attribute [rw] number_of_revisions
     #   The number of times a scan has been re-run on a revised resource.
     #   @return [Integer]
@@ -703,7 +710,7 @@ module Aws::CodeGuruSecurity
     #   @return [String]
     #
     # @!attribute [rw] scan_state
-    #   The current state of the scan. Pass either `InProgress`,
+    #   The current state of the scan. Returns either `InProgress`,
     #   `Successful`, or `Failed`.
     #   @return [String]
     #
@@ -717,6 +724,7 @@ module Aws::CodeGuruSecurity
     class GetScanResponse < Struct.new(
       :analysis_type,
       :created_at,
+      :error_message,
       :number_of_revisions,
       :run_id,
       :scan_name,
@@ -749,7 +757,7 @@ module Aws::CodeGuruSecurity
 
     # @!attribute [rw] end_date
     #   The end date of the interval which you want to retrieve metrics
-    #   from.
+    #   from. Round to the nearest day.
     #   @return [Time]
     #
     # @!attribute [rw] max_results
@@ -757,7 +765,7 @@ module Aws::CodeGuruSecurity
     #   parameter when paginating results. If additional results exist
     #   beyond the number you specify, the `nextToken` element is returned
     #   in the response. Use `nextToken` in a subsequent request to retrieve
-    #   additional results.
+    #   additional results. If not specified, returns 1000 results.
     #   @return [Integer]
     #
     # @!attribute [rw] next_token
@@ -770,7 +778,7 @@ module Aws::CodeGuruSecurity
     #
     # @!attribute [rw] start_date
     #   The start date of the interval which you want to retrieve metrics
-    #   from.
+    #   from. Rounds to the nearest day.
     #   @return [Time]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ListFindingsMetricsRequest AWS API Documentation
@@ -809,7 +817,7 @@ module Aws::CodeGuruSecurity
     #   parameter when paginating results. If additional results exist
     #   beyond the number you specify, the `nextToken` element is returned
     #   in the response. Use `nextToken` in a subsequent request to retrieve
-    #   additional results.
+    #   additional results. If not specified, returns 100 results.
     #   @return [Integer]
     #
     # @!attribute [rw] next_token
@@ -850,7 +858,7 @@ module Aws::CodeGuruSecurity
 
     # @!attribute [rw] resource_arn
     #   The ARN of the `ScanName` object. You can retrieve this ARN by
-    #   calling `ListScans` or `GetScan`.
+    #   calling `CreateScan`, `ListScans`, or `GetScan`.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ListTagsForResourceRequest AWS API Documentation
@@ -881,11 +889,11 @@ module Aws::CodeGuruSecurity
       include Aws::Structure
     end
 
-    # Information about summary metrics in an account.
+    # A summary of metrics for an account as of a specified date.
     #
     # @!attribute [rw] categories_with_most_findings
     #   A list of `CategoryWithFindingNum` objects for the top 5 finding
-    #   categories with the most open findings in an account.
+    #   categories with the most findings.
     #   @return [Array<Types::CategoryWithFindingNum>]
     #
     # @!attribute [rw] date
@@ -893,17 +901,17 @@ module Aws::CodeGuruSecurity
     #   @return [Time]
     #
     # @!attribute [rw] open_findings
-    #   The number of open findings of each severity in an account.
+    #   The number of open findings of each severity.
     #   @return [Types::FindingMetricsValuePerSeverity]
     #
     # @!attribute [rw] scans_with_most_open_critical_findings
     #   A list of `ScanNameWithFindingNum` objects for the top 3 scans with
-    #   the most number of open findings in an account.
+    #   the most number of open critical findings.
     #   @return [Array<Types::ScanNameWithFindingNum>]
     #
     # @!attribute [rw] scans_with_most_open_findings
     #   A list of `ScanNameWithFindingNum` objects for the top 3 scans with
-    #   the most number of open critical findings in an account.
+    #   the most number of open findings.
     #   @return [Array<Types::ScanNameWithFindingNum>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/MetricsSummary AWS API Documentation
@@ -959,16 +967,14 @@ module Aws::CodeGuruSecurity
       include Aws::Structure
     end
 
-    # Information about a resource, such as an Amazon S3 bucket or AWS
-    # Lambda function, that contains a finding.
+    # Information about a resource that contains a finding.
     #
     # @!attribute [rw] id
-    #   The identifier for the resource.
+    #   The `scanName` of the scan that was run on the resource.
     #   @return [String]
     #
     # @!attribute [rw] sub_resource_id
-    #   The identifier for a section of the resource, such as an AWS Lambda
-    #   layer.
+    #   The identifier for a section of the resource.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/Resource AWS API Documentation
@@ -980,16 +986,17 @@ module Aws::CodeGuruSecurity
       include Aws::Structure
     end
 
-    # The identifier for a resource object that contains resources where a
-    # finding was detected.
+    # The identifier for a resource object that contains resources to scan.
+    # Specifying a codeArtifactId is required to create a scan.
     #
     # @note ResourceId is a union - when making an API calls you must set exactly one of the members.
     #
     # @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.
     #
     # @!attribute [rw] code_artifact_id
-    #   The identifier for the code file uploaded to the resource where a
-    #   finding was detected.
+    #   The identifier for the code file uploaded to the resource object.
+    #   Returned by `CreateUploadUrl` when you upload resources to be
+    #   scanned.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ResourceId AWS API Documentation
@@ -1034,10 +1041,10 @@ module Aws::CodeGuruSecurity
       include Aws::Structure
     end
 
-    # Information about a scan with open findings.
+    # Information about the number of findings generated by a scan.
     #
     # @!attribute [rw] finding_number
-    #   The number of open findings generated by a scan.
+    #   The number of findings generated by a scan.
     #   @return [Integer]
     #
     # @!attribute [rw] scan_name
@@ -1097,7 +1104,8 @@ module Aws::CodeGuruSecurity
     # Information about the suggested code fix to remediate a finding.
     #
     # @!attribute [rw] code
-    #   The suggested code to add to your file.
+    #   The suggested code fix. If applicable, includes code patch to
+    #   replace your source code.
     #   @return [String]
     #
     # @!attribute [rw] description
@@ -1116,7 +1124,7 @@ module Aws::CodeGuruSecurity
 
     # @!attribute [rw] resource_arn
     #   The ARN of the `ScanName` object. You can retrieve this ARN by
-    #   calling `ListScans` or `GetScan`.
+    #   calling `CreateScan`, `ListScans`, or `GetScan`.
     #   @return [String]
     #
     # @!attribute [rw] tags
@@ -1175,7 +1183,7 @@ module Aws::CodeGuruSecurity
 
     # @!attribute [rw] resource_arn
     #   The ARN of the `ScanName` object. You can retrieve this ARN by
-    #   calling `ListScans` or `GetScan`.
+    #   calling `CreateScan`, `ListScans`, or `GetScan`.
     #   @return [String]
     #
     # @!attribute [rw] tag_keys
@@ -1196,8 +1204,11 @@ module Aws::CodeGuruSecurity
     class UntagResourceResponse < Aws::EmptyStructure; end
 
     # @!attribute [rw] encryption_config
-    #   The KMS key ARN you want to use for encryption. Defaults to
-    #   service-side encryption if missing.
+    #   The customer-managed KMS key ARN you want to use for encryption. If
+    #   not specified, CodeGuru Security will use an AWS-managed key for
+    #   encryption. If you previously specified a customer-managed KMS key
+    #   and want CodeGuru Security to use an AWS-managed key for encryption
+    #   instead, pass nothing.
     #   @return [Types::EncryptionConfig]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/UpdateAccountConfigurationRequest AWS API Documentation
@@ -1209,8 +1220,9 @@ module Aws::CodeGuruSecurity
     end
 
     # @!attribute [rw] encryption_config
-    #   An `EncryptionConfig` object that contains the KMS key ARN to use
-    #   for encryption.
+    #   An `EncryptionConfig` object that contains the KMS key ARN that is
+    #   used for encryption. If you did not specify a customer-managed KMS
+    #   key in the request, returns empty.
     #   @return [Types::EncryptionConfig]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/UpdateAccountConfigurationResponse AWS API Documentation

data/lib/aws-sdk-codegurusecurity.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-codegurusecurity/customizations'
 # @!group service
 module Aws::CodeGuruSecurity
 
-  GEM_VERSION = '1.12.0'
+  GEM_VERSION = '1.13.0'
 
 end

data/sig/client.rbs

@@ -158,6 +158,7 @@ module Aws
         include ::Seahorse::Client::_ResponseSuccess[Types::GetScanResponse]
         def analysis_type: () -> ("Security" | "All")
         def created_at: () -> ::Time
+        def error_message: () -> ::String
         def number_of_revisions: () -> ::Integer
         def run_id: () -> ::String
         def scan_name: () -> ::String

data/sig/types.rbs

@@ -185,6 +185,7 @@ module Aws::CodeGuruSecurity
     class GetScanResponse
       attr_accessor analysis_type: ("Security" | "All")
       attr_accessor created_at: ::Time
+      attr_accessor error_message: ::String
       attr_accessor number_of_revisions: ::Integer
       attr_accessor run_id: ::String
       attr_accessor scan_name: ::String

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-codegurusecurity
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.13.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-13 00:00:00.000000000 Z
+date: 2024-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core