client.rb in aws-sdk-codegurusecurity-1.13.0

- old
+ new

@@ -299,12 +299,13 @@
     #       in the future.
     #
     #
     #   @option options [String] :sdk_ua_app_id
     #     A unique and opaque application ID that is appended to the
-    #     User-Agent header as app/<sdk_ua_app_id>. It should have a
-    #     maximum length of 50.
+    #     User-Agent header as app/sdk_ua_app_id. It should have a
+    #     maximum length of 50. This variable is sourced from environment
+    #     variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
     #
     #   @option options [String] :secret_access_key
     #
     #   @option options [String] :session_token
     #
@@ -410,11 +411,11 @@
       super
     end
 
     # @!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
     #   `scanName` and a `findingId`. You retrieve the `findingId` when you
     #   call `GetFindings`.
@@ -485,11 +486,11 @@
     def batch_get_findings(params = {}, options = {})
       req = build_request(:batch_get_findings, params)
       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
     #   scan, either `Security` or `All`. The `Security` type only generates
     #   findings related to security. The `All` type generates both security
@@ -502,16 +503,16 @@
     #
     #   **A suitable default value is auto-generated.** You should normally
     #   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
     #   `Standard` type if missing.
     #
@@ -569,15 +570,15 @@
     def create_scan(params = {}, options = {})
       req = build_request(:create_scan, params)
       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
     #   Security uses the unique scan name to track revisions across multiple
     #   scans of the same resource. Use this `scanName` when you call
@@ -609,11 +610,11 @@
     def create_upload_url(params = {}, options = {})
       req = build_request(:create_upload_url, params)
       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:
     #
     #   * {Types::GetAccountConfigurationResponse#encryption_config #encryption_config} => Types::EncryptionConfig
     #
@@ -635,11 +636,11 @@
     # @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
     #   response. Set the value of this parameter to null for the first
     #   request. For subsequent calls, use the `nextToken` value returned from
@@ -714,20 +715,18 @@
     def get_findings(params = {}, options = {})
       req = build_request(:get_findings, params)
       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:
     #
     #   * {Types::GetMetricsSummaryResponse#metrics_summary #metrics_summary} => Types::MetricsSummary
     #
@@ -777,10 +776,11 @@
     #
     # @return [Types::GetScanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {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
     #   * {Types::GetScanResponse#scan_name_arn #scan_name_arn} => String
     #   * {Types::GetScanResponse#scan_state #scan_state} => String
@@ -795,10 +795,11 @@
     #
     # @example Response structure
     #
     #   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
     #   resp.scan_name_arn #=> String
     #   resp.scan_state #=> String, one of "InProgress", "Successful", "Failed"
@@ -816,27 +817,28 @@
     # Returns metrics about all findings in an account within a specified
     # time range.
     #
     # @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
     #   response. Set the value of this parameter to null for the first
     #   request. For subsequent calls, use the `nextToken` value returned from
     #   the previous request to continue listing results after the first page.
     #
     # @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:
     #
     #   * {Types::ListFindingsMetricsResponse#findings_metrics #findings_metrics} => Array&lt;Types::AccountFindingsMetric&gt;
     #   * {Types::ListFindingsMetricsResponse#next_token #next_token} => String
@@ -885,19 +887,19 @@
     def list_findings_metrics(params = {}, options = {})
       req = build_request(:list_findings_metrics, params)
       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
     #   response. Set the value of this parameter to null for the first
     #   request. For subsequent calls, use the `nextToken` value returned from
@@ -939,11 +941,11 @@
 
     # Returns a list of all tags associated with a scan.
     #
     # @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:
     #
     #   * {Types::ListTagsForResourceResponse#tags #tags} => Hash&lt;String,String&gt;
     #
@@ -969,11 +971,11 @@
 
     # Use to add one or more tags to an existing scan.
     #
     # @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
     #   custom attribute label with two parts:
     #
@@ -1006,11 +1008,11 @@
 
     # Use to remove one or more tags from an existing scan.
     #
     # @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.
     #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
@@ -1029,15 +1031,18 @@
     def untag_resource(params = {}, options = {})
       req = build_request(:untag_resource, params)
       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:
     #
     #   * {Types::UpdateAccountConfigurationResponse#encryption_config #encryption_config} => Types::EncryptionConfig
     #
@@ -1073,10 +1078,10 @@
         operation: config.api.operation(operation_name),
         client: self,
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-codegurusecurity'
-      context[:gem_version] = '1.11.0'
+      context[:gem_version] = '1.13.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 
     # @api private
     # @deprecated