lib/aws-sdk-securityhub/client.rb in aws-sdk-securityhub-1.19.0 vs lib/aws-sdk-securityhub/client.rb in aws-sdk-securityhub-1.21.0
- old
+ new
@@ -28,10 +28,22 @@
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
Aws::Plugins::GlobalConfiguration.add_identifier(:securityhub)
module Aws::SecurityHub
+ # An API client for SecurityHub. To construct a client, you need to configure a `:region` and `:credentials`.
+ #
+ # client = Aws::SecurityHub::Client.new(
+ # region: region_name,
+ # credentials: credentials,
+ # # ...
+ # )
+ #
+ # For details on configuring region and credentials see
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
+ #
+ # See {#initialize} for a full list of supported configuration options.
class Client < Seahorse::Client::Base
include Aws::ClientStubs
@identifier = :securityhub
@@ -106,10 +118,16 @@
#
# @option options [Boolean] :active_endpoint_cache (false)
# When set to `true`, a thread polling for endpoints will be running in
# the background every 60 secs (default). Defaults to `false`.
#
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (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.
+ #
# @option options [Boolean] :client_side_monitoring (false)
# When `true`, client-side metrics will be collected for all API requests from
# this client.
#
# @option options [String] :client_side_monitoring_client_id ("")
@@ -130,10 +148,14 @@
#
# @option options [Boolean] :convert_params (true)
# When `true`, an attempt is made to coerce request parameters into
# the required types.
#
+ # @option options [Boolean] :correct_clock_skew (true)
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
+ # a clock skew correction and retry requests with skewed client clocks.
+ #
# @option options [Boolean] :disable_host_prefix_injection (false)
# Set to true to disable SDK automatically adding host prefix
# to default service endpoint when available.
#
# @option options [String] :endpoint
@@ -164,32 +186,65 @@
#
# @option options [Logger] :logger
# The Logger instance to send log messages to. If this option
# is not set, logging will be disabled.
#
+ # @option options [Integer] :max_attempts (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.
+ #
# @option options [String] :profile ("default")
# Used when loading credentials from the shared credentials file
# at HOME/.aws/credentials. When not specified, 'default' is used.
#
+ # @option options [Proc] :retry_backoff
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
+ # This option is only used in the `legacy` retry mode.
+ #
# @option options [Float] :retry_base_delay (0.3)
- # The base delay in seconds used by the default backoff function.
+ # The base delay in seconds used by the default backoff function. This option
+ # is only used in the `legacy` retry mode.
#
# @option options [Symbol] :retry_jitter (: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.
+ # 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
#
# @option options [Integer] :retry_limit (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 and auth
- # errors from expired credentials.
+ # 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.
#
# @option options [Integer] :retry_max_delay (0)
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
+ # 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.
#
+ # @option options [String] :retry_mode ("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.
+ #
+ #
# @option options [String] :secret_access_key
#
# @option options [String] :session_token
#
# @option options [Boolean] :stub_responses (false)
@@ -207,29 +262,29 @@
#
# @option options [URI::HTTP,String] :http_proxy A proxy to send
# requests through. Formatted like 'http://proxy.com:123'.
#
# @option options [Float] :http_open_timeout (15) The number of
- # seconds to wait when opening a HTTP session before rasing a
+ # seconds to wait when opening a HTTP session before raising a
# `Timeout::Error`.
#
# @option options [Integer] :http_read_timeout (60) The default
# number of seconds to wait for response data. This value can
# safely be set
- # per-request on the session yeidled by {#session_for}.
+ # per-request on the session yielded by {#session_for}.
#
# @option options [Float] :http_idle_timeout (5) The number of
- # seconds a connection is allowed to sit idble before it is
+ # 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.
#
# @option options [Float] :http_continue_timeout (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 yeidled by {#session_for}.
+ # request on the session yielded by {#session_for}.
#
# @option options [Boolean] :http_wire_trace (false) When `true`,
# HTTP debug output will be sent to the `:logger`.
#
# @option options [Boolean] :ssl_verify_peer (true) When `true`,
@@ -413,11 +468,12 @@
# last_observed_at: "NonEmptyString",
# created_at: "NonEmptyString", # required
# updated_at: "NonEmptyString", # required
# severity: { # required
# product: 1.0,
- # normalized: 1, # required
+ # label: "INFORMATIONAL", # accepts INFORMATIONAL, LOW, MEDIUM, HIGH, CRITICAL
+ # normalized: 1,
# },
# confidence: 1,
# criticality: 1,
# title: "NonEmptyString", # required
# description: "NonEmptyString", # required
@@ -678,11 +734,30 @@
# },
# },
# aws_s3_bucket: {
# owner_id: "NonEmptyString",
# owner_name: "NonEmptyString",
+ # created_at: "NonEmptyString",
+ # server_side_encryption_configuration: {
+ # rules: [
+ # {
+ # apply_server_side_encryption_by_default: {
+ # sse_algorithm: "NonEmptyString",
+ # kms_master_key_id: "NonEmptyString",
+ # },
+ # },
+ # ],
+ # },
# },
+ # aws_s3_object: {
+ # last_modified: "NonEmptyString",
+ # etag: "NonEmptyString",
+ # version_id: "NonEmptyString",
+ # content_type: "NonEmptyString",
+ # server_side_encryption: "NonEmptyString",
+ # ssekms_key_id: "NonEmptyString",
+ # },
# aws_iam_access_key: {
# user_name: "NonEmptyString",
# status: "Active", # accepts Active, Inactive
# created_at: "NonEmptyString",
# principal_id: "NonEmptyString",
@@ -848,10 +923,13 @@
# status: "PASSED", # accepts PASSED, WARNING, FAILED, NOT_AVAILABLE
# related_requirements: ["NonEmptyString"],
# },
# verification_state: "UNKNOWN", # accepts UNKNOWN, TRUE_POSITIVE, FALSE_POSITIVE, BENIGN_POSITIVE
# workflow_state: "NEW", # accepts NEW, ASSIGNED, IN_PROGRESS, DEFERRED, RESOLVED
+ # workflow: {
+ # status: "NEW", # accepts NEW, NOTIFIED, RESOLVED, SUPPRESSED
+ # },
# record_state: "ACTIVE", # accepts ACTIVE, ARCHIVED
# related_findings: [
# {
# product_arn: "NonEmptyString", # required
# id: "NonEmptyString", # required
@@ -1451,10 +1529,16 @@
# {
# value: "NonEmptyString",
# comparison: "EQUALS", # accepts EQUALS, PREFIX
# },
# ],
+ # workflow_status: [
+ # {
+ # value: "NonEmptyString",
+ # comparison: "EQUALS", # accepts EQUALS, PREFIX
+ # },
+ # ],
# record_state: [
# {
# value: "NonEmptyString",
# comparison: "EQUALS", # accepts EQUALS, PREFIX
# },
@@ -2705,10 +2789,16 @@
# {
# value: "NonEmptyString",
# comparison: "EQUALS", # accepts EQUALS, PREFIX
# },
# ],
+ # workflow_status: [
+ # {
+ # value: "NonEmptyString",
+ # comparison: "EQUALS", # accepts EQUALS, PREFIX
+ # },
+ # ],
# record_state: [
# {
# value: "NonEmptyString",
# comparison: "EQUALS", # accepts EQUALS, PREFIX
# },
@@ -2776,10 +2866,11 @@
# resp.findings[0].first_observed_at #=> String
# resp.findings[0].last_observed_at #=> String
# resp.findings[0].created_at #=> String
# resp.findings[0].updated_at #=> String
# resp.findings[0].severity.product #=> Float
+ # resp.findings[0].severity.label #=> String, one of "INFORMATIONAL", "LOW", "MEDIUM", "HIGH", "CRITICAL"
# resp.findings[0].severity.normalized #=> Integer
# resp.findings[0].confidence #=> Integer
# resp.findings[0].criticality #=> Integer
# resp.findings[0].title #=> String
# resp.findings[0].description #=> String
@@ -2950,10 +3041,20 @@
# resp.findings[0].resources[0].details.aws_elasticsearch_domain.vpc_options.subnet_ids #=> Array
# resp.findings[0].resources[0].details.aws_elasticsearch_domain.vpc_options.subnet_ids[0] #=> String
# resp.findings[0].resources[0].details.aws_elasticsearch_domain.vpc_options.vpc_id #=> String
# resp.findings[0].resources[0].details.aws_s3_bucket.owner_id #=> String
# resp.findings[0].resources[0].details.aws_s3_bucket.owner_name #=> String
+ # resp.findings[0].resources[0].details.aws_s3_bucket.created_at #=> String
+ # resp.findings[0].resources[0].details.aws_s3_bucket.server_side_encryption_configuration.rules #=> Array
+ # resp.findings[0].resources[0].details.aws_s3_bucket.server_side_encryption_configuration.rules[0].apply_server_side_encryption_by_default.sse_algorithm #=> String
+ # resp.findings[0].resources[0].details.aws_s3_bucket.server_side_encryption_configuration.rules[0].apply_server_side_encryption_by_default.kms_master_key_id #=> String
+ # resp.findings[0].resources[0].details.aws_s3_object.last_modified #=> String
+ # resp.findings[0].resources[0].details.aws_s3_object.etag #=> String
+ # resp.findings[0].resources[0].details.aws_s3_object.version_id #=> String
+ # resp.findings[0].resources[0].details.aws_s3_object.content_type #=> String
+ # resp.findings[0].resources[0].details.aws_s3_object.server_side_encryption #=> String
+ # resp.findings[0].resources[0].details.aws_s3_object.ssekms_key_id #=> String
# resp.findings[0].resources[0].details.aws_iam_access_key.user_name #=> String
# resp.findings[0].resources[0].details.aws_iam_access_key.status #=> String, one of "Active", "Inactive"
# resp.findings[0].resources[0].details.aws_iam_access_key.created_at #=> String
# resp.findings[0].resources[0].details.aws_iam_access_key.principal_id #=> String
# resp.findings[0].resources[0].details.aws_iam_access_key.principal_type #=> String
@@ -3060,10 +3161,11 @@
# resp.findings[0].compliance.status #=> String, one of "PASSED", "WARNING", "FAILED", "NOT_AVAILABLE"
# resp.findings[0].compliance.related_requirements #=> Array
# resp.findings[0].compliance.related_requirements[0] #=> String
# resp.findings[0].verification_state #=> String, one of "UNKNOWN", "TRUE_POSITIVE", "FALSE_POSITIVE", "BENIGN_POSITIVE"
# resp.findings[0].workflow_state #=> String, one of "NEW", "ASSIGNED", "IN_PROGRESS", "DEFERRED", "RESOLVED"
+ # resp.findings[0].workflow.status #=> String, one of "NEW", "NOTIFIED", "RESOLVED", "SUPPRESSED"
# resp.findings[0].record_state #=> String, one of "ACTIVE", "ARCHIVED"
# resp.findings[0].related_findings #=> Array
# resp.findings[0].related_findings[0].product_arn #=> String
# resp.findings[0].related_findings[0].id #=> String
# resp.findings[0].note.text #=> String
@@ -3114,11 +3216,13 @@
end
# Lists and describes insights for the specified insight ARNs.
#
# @option params [Array<String>] :insight_arns
- # The ARNs of the insights to describe.
+ # The ARNs of the insights to describe. If you do not provide any
+ # insight ARNs, then `GetInsights` returns all of your custom insights.
+ # It does not return any managed insights.
#
# @option params [String] :next_token
# The token that is required for pagination. On your first call to the
# `GetInsights` operation, set the value of this parameter to `NULL`.
#
@@ -3399,10 +3503,13 @@
# resp.insights[0].filters.verification_state[0].value #=> String
# resp.insights[0].filters.verification_state[0].comparison #=> String, one of "EQUALS", "PREFIX"
# resp.insights[0].filters.workflow_state #=> Array
# resp.insights[0].filters.workflow_state[0].value #=> String
# resp.insights[0].filters.workflow_state[0].comparison #=> String, one of "EQUALS", "PREFIX"
+ # resp.insights[0].filters.workflow_status #=> Array
+ # resp.insights[0].filters.workflow_status[0].value #=> String
+ # resp.insights[0].filters.workflow_status[0].comparison #=> String, one of "EQUALS", "PREFIX"
# resp.insights[0].filters.record_state #=> Array
# resp.insights[0].filters.record_state[0].value #=> String
# resp.insights[0].filters.record_state[0].comparison #=> String, one of "EQUALS", "PREFIX"
# resp.insights[0].filters.related_findings_product_arn #=> Array
# resp.insights[0].filters.related_findings_product_arn[0].value #=> String
@@ -4339,10 +4446,16 @@
# {
# value: "NonEmptyString",
# comparison: "EQUALS", # accepts EQUALS, PREFIX
# },
# ],
+ # workflow_status: [
+ # {
+ # value: "NonEmptyString",
+ # comparison: "EQUALS", # accepts EQUALS, PREFIX
+ # },
+ # ],
# record_state: [
# {
# value: "NonEmptyString",
# comparison: "EQUALS", # accepts EQUALS, PREFIX
# },
@@ -4926,10 +5039,16 @@
# {
# value: "NonEmptyString",
# comparison: "EQUALS", # accepts EQUALS, PREFIX
# },
# ],
+ # workflow_status: [
+ # {
+ # value: "NonEmptyString",
+ # comparison: "EQUALS", # accepts EQUALS, PREFIX
+ # },
+ # ],
# record_state: [
# {
# value: "NonEmptyString",
# comparison: "EQUALS", # accepts EQUALS, PREFIX
# },
@@ -5029,10 +5148,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-securityhub'
- context[:gem_version] = '1.19.0'
+ context[:gem_version] = '1.21.0'
Seahorse::Client::Request.new(handlers, context)
end
# @api private
# @deprecated