Class: Aws::CodeGuruSecurity::Client

Inherits:
Seahorse::Client::Base show all
Includes:
Aws::ClientStubs
Defined in:
gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb

Overview

An API client for CodeGuruSecurity. To construct a client, you need to configure a :region and :credentials.

client = Aws::CodeGuruSecurity::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from Aws::ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    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. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling Aws::ClientStubs#stub_responses. See Aws::ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::CodeGuruSecurity::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::CodeGuruSecurity::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



467
468
469
 
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 467

def initialize(*args)
  super
end

Instance Method Details

#batch_get_findings(params = {}) ⇒ Types::BatchGetFindingsResponse

Returns a list of requested findings from standard scans.

Examples:

Request syntax with placeholder values


resp = client.batch_get_findings({
  finding_identifiers: [ # required
    {
      finding_id: "String", # required
      scan_name: "String", # required
    },
  ],
})

Response structure


resp.failed_findings #=> Array
resp.failed_findings[0].error_code #=> String, one of "DUPLICATE_IDENTIFIER", "ITEM_DOES_NOT_EXIST", "INTERNAL_ERROR", "INVALID_FINDING_ID", "INVALID_SCAN_NAME"
resp.failed_findings[0].finding_id #=> String
resp.failed_findings[0].message #=> String
resp.failed_findings[0].scan_name #=> String
resp.findings #=> Array
resp.findings[0].created_at #=> Time
resp.findings[0].description #=> String
resp.findings[0].detector_id #=> String
resp.findings[0].detector_name #=> String
resp.findings[0].detector_tags #=> Array
resp.findings[0].detector_tags[0] #=> String
resp.findings[0].generator_id #=> String
resp.findings[0].id #=> String
resp.findings[0].remediation.recommendation.text #=> String
resp.findings[0].remediation.recommendation.url #=> String
resp.findings[0].remediation.suggested_fixes #=> Array
resp.findings[0].remediation.suggested_fixes[0].code #=> String
resp.findings[0].remediation.suggested_fixes[0].description #=> String
resp.findings[0].resource.id #=> String
resp.findings[0].resource.sub_resource_id #=> String
resp.findings[0].rule_id #=> String
resp.findings[0].severity #=> String, one of "Critical", "High", "Medium", "Low", "Info"
resp.findings[0].status #=> String, one of "Closed", "Open", "All"
resp.findings[0].title #=> String
resp.findings[0].type #=> String
resp.findings[0].updated_at #=> Time
resp.findings[0].vulnerability.file_path.code_snippet #=> Array
resp.findings[0].vulnerability.file_path.code_snippet[0].content #=> String
resp.findings[0].vulnerability.file_path.code_snippet[0].number #=> Integer
resp.findings[0].vulnerability.file_path.end_line #=> Integer
resp.findings[0].vulnerability.file_path.name #=> String
resp.findings[0].vulnerability.file_path.path #=> String
resp.findings[0].vulnerability.file_path.start_line #=> Integer
resp.findings[0].vulnerability.id #=> String
resp.findings[0].vulnerability.item_count #=> Integer
resp.findings[0].vulnerability.reference_urls #=> Array
resp.findings[0].vulnerability.reference_urls[0] #=> String
resp.findings[0].vulnerability.related_vulnerabilities #=> Array
resp.findings[0].vulnerability.related_vulnerabilities[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :finding_identifiers (required, Array<Types::FindingIdentifier>) —

    A list of finding identifiers. Each identifier consists of a scanName and a findingId. You retrieve the findingId when you call GetFindings.

Returns:

See Also:



543
544
545
546
 
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 543

def batch_get_findings(params = {}, options = {})
  req = build_request(:batch_get_findings, params)
  req.send_request(options)
end

#create_scan(params = {}) ⇒ Types::CreateScanResponse

Use to create a scan using code uploaded to an Amazon S3 bucket.

Examples:

Request syntax with placeholder values


resp = client.create_scan({
  analysis_type: "Security", # accepts Security, All
  client_token: "ClientToken",
  resource_id: { # required
    code_artifact_id: "Uuid",
  },
  scan_name: "ScanName", # required
  scan_type: "Standard", # accepts Standard, Express
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.resource_id.code_artifact_id #=> String
resp.run_id #=> String
resp.scan_name #=> String
resp.scan_name_arn #=> String
resp.scan_state #=> String, one of "InProgress", "Successful", "Failed"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :analysis_type (String) —

    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 findings and quality findings. Defaults to Security type if missing.

  • :client_token (String) —

    The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :resource_id (required, Types::ResourceId) —

    The identifier for the resource object to be scanned.

  • :scan_name (required, String) —

    The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a STANDARD scan type.

  • :scan_type (String) —

    The type of scan, either Standard or Express. Defaults to Standard type if missing.

    Express scans run on limited resources and use a limited set of detectors to analyze your code in near-real time. Standard scans have standard resource limits and use the full set of detectors to analyze your code.

  • :tags (Hash<String,String>) —

    An array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts:

    • A tag key. For example, CostCenter, Environment, or Secret. Tag keys are case sensitive.

    • An optional tag value field. For example, 111122223333, Production, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.

Returns:

See Also:



627
628
629
630
 
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 627

def create_scan(params = {}, options = {})
  req = build_request(:create_scan, params)
  req.send_request(options)
end

#create_upload_url(params = {}) ⇒ Types::CreateUploadUrlResponse

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 with the request headers using any HTTP client.

Examples:

Request syntax with placeholder values


resp = client.create_upload_url({
  scan_name: "ScanName", # required
})

Response structure


resp.code_artifact_id #=> String
resp.request_headers #=> Hash
resp.request_headers["HeaderKey"] #=> String
resp.s3_url #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :scan_name (required, String) —

    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 CreateScan on the code resource you upload to this URL.

Returns:

See Also:



667
668
669
670
 
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 667

def create_upload_url(params = {}, options = {})
  req = build_request(:create_upload_url, params)
  req.send_request(options)
end

#get_account_configuration(params = {}) ⇒ Types::GetAccountConfigurationResponse

Use to get the encryption configuration for an account.

Examples:

Response structure


resp.encryption_config.kms_key_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



686
687
688
689
 
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 686

def (params = {}, options = {})
  req = build_request(:get_account_configuration, params)
  req.send_request(options)
end

#get_findings(params = {}) ⇒ Types::GetFindingsResponse

Returns a list of all findings generated by a particular scan.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_findings({
  max_results: 1,
  next_token: "NextToken",
  scan_name: "ScanName", # required
  status: "Closed", # accepts Closed, Open, All
})

Response structure


resp.findings #=> Array
resp.findings[0].created_at #=> Time
resp.findings[0].description #=> String
resp.findings[0].detector_id #=> String
resp.findings[0].detector_name #=> String
resp.findings[0].detector_tags #=> Array
resp.findings[0].detector_tags[0] #=> String
resp.findings[0].generator_id #=> String
resp.findings[0].id #=> String
resp.findings[0].remediation.recommendation.text #=> String
resp.findings[0].remediation.recommendation.url #=> String
resp.findings[0].remediation.suggested_fixes #=> Array
resp.findings[0].remediation.suggested_fixes[0].code #=> String
resp.findings[0].remediation.suggested_fixes[0].description #=> String
resp.findings[0].resource.id #=> String
resp.findings[0].resource.sub_resource_id #=> String
resp.findings[0].rule_id #=> String
resp.findings[0].severity #=> String, one of "Critical", "High", "Medium", "Low", "Info"
resp.findings[0].status #=> String, one of "Closed", "Open", "All"
resp.findings[0].title #=> String
resp.findings[0].type #=> String
resp.findings[0].updated_at #=> Time
resp.findings[0].vulnerability.file_path.code_snippet #=> Array
resp.findings[0].vulnerability.file_path.code_snippet[0].content #=> String
resp.findings[0].vulnerability.file_path.code_snippet[0].number #=> Integer
resp.findings[0].vulnerability.file_path.end_line #=> Integer
resp.findings[0].vulnerability.file_path.name #=> String
resp.findings[0].vulnerability.file_path.path #=> String
resp.findings[0].vulnerability.file_path.start_line #=> Integer
resp.findings[0].vulnerability.id #=> String
resp.findings[0].vulnerability.item_count #=> Integer
resp.findings[0].vulnerability.reference_urls #=> Array
resp.findings[0].vulnerability.reference_urls[0] #=> String
resp.findings[0].vulnerability.related_vulnerabilities #=> Array
resp.findings[0].vulnerability.related_vulnerabilities[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    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. If not specified, returns 1000 results.

  • :next_token (String) —

    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.

  • :scan_name (required, String) —

    The name of the scan you want to retrieve findings from.

  • :status (String) —

    The status of the findings you want to get. Pass either Open, Closed, or All.

Returns:

See Also:



772
773
774
775
 
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 772

def get_findings(params = {}, options = {})
  req = build_request(:get_findings, params)
  req.send_request(options)
end

#get_metrics_summary(params = {}) ⇒ Types::GetMetricsSummaryResponse

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.

Examples:

Request syntax with placeholder values


resp = client.get_metrics_summary({
  date: Time.now, # required
})

Response structure


resp.metrics_summary.categories_with_most_findings #=> Array
resp.metrics_summary.categories_with_most_findings[0].category_name #=> String
resp.metrics_summary.categories_with_most_findings[0].finding_number #=> Integer
resp.metrics_summary.date #=> Time
resp.metrics_summary.open_findings.critical #=> Float
resp.metrics_summary.open_findings.high #=> Float
resp.metrics_summary.open_findings.info #=> Float
resp.metrics_summary.open_findings.low #=> Float
resp.metrics_summary.open_findings.medium #=> Float
resp.metrics_summary.scans_with_most_open_critical_findings #=> Array
resp.metrics_summary.scans_with_most_open_critical_findings[0].finding_number #=> Integer
resp.metrics_summary.scans_with_most_open_critical_findings[0].scan_name #=> String
resp.metrics_summary.scans_with_most_open_findings #=> Array
resp.metrics_summary.scans_with_most_open_findings[0].finding_number #=> Integer
resp.metrics_summary.scans_with_most_open_findings[0].scan_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :date (required, Time, DateTime, Date, Integer, String) —

    The date you want to retrieve summary metrics from, rounded to the nearest day. The date must be within the past two years.

Returns:

See Also:



818
819
820
821
 
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 818

def get_metrics_summary(params = {}, options = {})
  req = build_request(:get_metrics_summary, params)
  req.send_request(options)
end

#get_scan(params = {}) ⇒ Types::GetScanResponse

Returns details about a scan, including whether or not a scan has completed.

Examples:

Request syntax with placeholder values


resp = client.get_scan({
  run_id: "Uuid",
  scan_name: "ScanName", # required
})

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"
resp.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :run_id (String) —

    UUID that identifies the individual scan run you want to view details about. You retrieve this when you call the CreateScan operation. Defaults to the latest scan run if missing.

  • :scan_name (required, String) —

    The name of the scan you want to view details about.

Returns:

See Also:



869
870
871
872
 
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 869

def get_scan(params = {}, options = {})
  req = build_request(:get_scan, params)
  req.send_request(options)
end

#list_findings_metrics(params = {}) ⇒ Types::ListFindingsMetricsResponse

Returns metrics about all findings in an account within a specified time range.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_findings_metrics({
  end_date: Time.now, # required
  max_results: 1,
  next_token: "NextToken",
  start_date: Time.now, # required
})

Response structure


resp.findings_metrics #=> Array
resp.findings_metrics[0].closed_findings.critical #=> Float
resp.findings_metrics[0].closed_findings.high #=> Float
resp.findings_metrics[0].closed_findings.info #=> Float
resp.findings_metrics[0].closed_findings.low #=> Float
resp.findings_metrics[0].closed_findings.medium #=> Float
resp.findings_metrics[0].date #=> Time
resp.findings_metrics[0].mean_time_to_close.critical #=> Float
resp.findings_metrics[0].mean_time_to_close.high #=> Float
resp.findings_metrics[0].mean_time_to_close.info #=> Float
resp.findings_metrics[0].mean_time_to_close.low #=> Float
resp.findings_metrics[0].mean_time_to_close.medium #=> Float
resp.findings_metrics[0].new_findings.critical #=> Float
resp.findings_metrics[0].new_findings.high #=> Float
resp.findings_metrics[0].new_findings.info #=> Float
resp.findings_metrics[0].new_findings.low #=> Float
resp.findings_metrics[0].new_findings.medium #=> Float
resp.findings_metrics[0].open_findings.critical #=> Float
resp.findings_metrics[0].open_findings.high #=> Float
resp.findings_metrics[0].open_findings.info #=> Float
resp.findings_metrics[0].open_findings.low #=> Float
resp.findings_metrics[0].open_findings.medium #=> Float
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :end_date (required, Time, DateTime, Date, Integer, String) —

    The end date of the interval which you want to retrieve metrics from. Round to the nearest day.

  • :max_results (Integer) —

    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. If not specified, returns 1000 results.

  • :next_token (String) —

    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.

  • :start_date (required, Time, DateTime, Date, Integer, String) —

    The start date of the interval which you want to retrieve metrics from. Rounds to the nearest day.

Returns:

See Also:



944
945
946
947
 
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 944

def list_findings_metrics(params = {}, options = {})
  req = build_request(:list_findings_metrics, params)
  req.send_request(options)
end

#list_scans(params = {}) ⇒ Types::ListScansResponse

Returns a list of all scans in an account. Does not return EXPRESS scans.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_scans({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.summaries #=> Array
resp.summaries[0].created_at #=> Time
resp.summaries[0].run_id #=> String
resp.summaries[0].scan_name #=> String
resp.summaries[0].scan_name_arn #=> String
resp.summaries[0].scan_state #=> String, one of "InProgress", "Successful", "Failed"
resp.summaries[0].updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    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. If not specified, returns 100 results.

  • :next_token (String) —

    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.

Returns:

See Also:



994
995
996
997
 
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 994

def list_scans(params = {}, options = {})
  req = build_request(:list_scans, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Returns a list of all tags associated with a scan.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ScanNameArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the ScanName object. You can retrieve this ARN by calling CreateScan, ListScans, or GetScan.

Returns:

See Also:



1024
1025
1026
1027
 
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 1024

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Use to add one or more tags to an existing scan.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ScanNameArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the ScanName object. You can retrieve this ARN by calling CreateScan, ListScans, or GetScan.

  • :tags (required, Hash<String,String>) —

    An array of key-value pairs used to tag an existing scan. A tag is a custom attribute label with two parts:

    • A tag key. For example, CostCenter, Environment, or Secret. Tag keys are case sensitive.

    • An optional tag value field. For example, 111122223333, Production, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1061
1062
1063
1064
 
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 1061

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Use to remove one or more tags from an existing scan.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ScanNameArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the ScanName object. You can retrieve this ARN by calling CreateScan, ListScans, or GetScan.

  • :tag_keys (required, Array<String>) —

    A list of keys for each tag you want to remove from a scan.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1088
1089
1090
1091
 
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 1088

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_account_configuration(params = {}) ⇒ Types::UpdateAccountConfigurationResponse

Use to update the encryption configuration for an account.

Examples:

Request syntax with placeholder values


resp = client.({
  encryption_config: { # required
    kms_key_arn: "KmsKeyArn",
  },
})

Response structure


resp.encryption_config.kms_key_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :encryption_config (required, Types::EncryptionConfig) —

    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.

Returns:

See Also:



1122
1123
1124
1125
 
# File 'gems/aws-sdk-codegurusecurity/lib/aws-sdk-codegurusecurity/client.rb', line 1122

def (params = {}, options = {})
  req = build_request(:update_account_configuration, params)
  req.send_request(options)
end