aws-sdk-inspector 1.21.0 → 1.26.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 464cba2d03f4dae9dafe433c64c326ecdea5f0b6
4
- data.tar.gz: e2f528c294251ff6ff5651158943919b6789fb63
2
+ SHA256:
3
+ metadata.gz: 2bbd443200bc119b1f11bb07131a0b3df1b9619b6e56e1370e7cb91e50f8531e
4
+ data.tar.gz: 2e78c87fd6b0ae05b2e469202cdef892145cf6968819878e7c8f2547ec75a0aa
5
5
  SHA512:
6
- metadata.gz: 79e31e054d7a032c9e369bb616cfe0fab326f2c0f9272ed188c67911986f9f0bab775fa8f5b62b2374cf0bf4c7d251db2b2c7242e389b10cb9816bd0ee013c93
7
- data.tar.gz: 8e5017311df93dac837e098454060c9732848c9edb22e7f9090b8bb0c128eb5f8da2676b4c38f0b4f14ab7ec723b6ed85d3d020b0c7ab2c5c1355fbcd5b12e54
6
+ metadata.gz: 2aa36924d0fabe48a7d428aac177d96c64fe54d0dec65ae8b5fe3da6b30e2bba0febe44fa149ff0656970a3261ad7d701be18d81625d334619b04af2118d43d6
7
+ data.tar.gz: d442bc717f5b0722605592b3fea8b074de6d7a1dc5fed93c7b101f8096ba89d6763af0ab8c25d49851b649063551ad8af9563eca0f533238f7f0a0465004c8f4
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-inspector/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # inspector = Aws::Inspector::Client.new
28
+ # resp = inspector.add_attributes_to_findings(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from Amazon Inspector all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from Amazon Inspector are defined in the
35
+ # {Errors} module and all extend {Errors::ServiceError}.
33
36
  #
34
37
  # begin
35
38
  # # do stuff
36
39
  # rescue Aws::Inspector::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all Amazon Inspector API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-inspector/customizations'
42
45
  # @service
43
46
  module Aws::Inspector
44
47
 
45
- GEM_VERSION = '1.21.0'
48
+ GEM_VERSION = '1.26.0'
46
49
 
47
50
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:inspector)
31
31
 
32
32
  module Aws::Inspector
33
+ # An API client for Inspector. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::Inspector::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
+ #
41
+ # For details on configuring region and credentials see
42
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
43
+ #
44
+ # See {#initialize} for a full list of supported configuration options.
33
45
  class Client < Seahorse::Client::Base
34
46
 
35
47
  include Aws::ClientStubs
@@ -93,7 +105,7 @@ module Aws::Inspector
93
105
  # @option options [required, String] :region
94
106
  # The AWS region to connect to. The configured `:region` is
95
107
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
108
+ # a default `:region` is searched for in the following locations:
97
109
  #
98
110
  # * `Aws.config[:region]`
99
111
  # * `ENV['AWS_REGION']`
@@ -108,6 +120,12 @@ module Aws::Inspector
108
120
  # When set to `true`, a thread polling for endpoints will be running in
109
121
  # the background every 60 secs (default). Defaults to `false`.
110
122
  #
123
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
124
+ # Used only in `adaptive` retry mode. When true, the request will sleep
125
+ # until there is sufficent client side capacity to retry the request.
126
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
127
+ # not retry instead of sleeping.
128
+ #
111
129
  # @option options [Boolean] :client_side_monitoring (false)
112
130
  # When `true`, client-side metrics will be collected for all API requests from
113
131
  # this client.
@@ -132,6 +150,10 @@ module Aws::Inspector
132
150
  # When `true`, an attempt is made to coerce request parameters into
133
151
  # the required types.
134
152
  #
153
+ # @option options [Boolean] :correct_clock_skew (true)
154
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
155
+ # a clock skew correction and retry requests with skewed client clocks.
156
+ #
135
157
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
158
  # Set to true to disable SDK automatically adding host prefix
137
159
  # to default service endpoint when available.
@@ -139,7 +161,7 @@ module Aws::Inspector
139
161
  # @option options [String] :endpoint
140
162
  # The client endpoint is normally constructed from the `:region`
141
163
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
164
+ # to test endpoints. This should be a valid HTTP(S) URI.
143
165
  #
144
166
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
167
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +176,7 @@ module Aws::Inspector
154
176
  # requests fetching endpoints information. Defaults to 60 sec.
155
177
  #
156
178
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
179
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
180
  #
159
181
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
182
  # The log formatter.
@@ -166,15 +188,29 @@ module Aws::Inspector
166
188
  # The Logger instance to send log messages to. If this option
167
189
  # is not set, logging will be disabled.
168
190
  #
191
+ # @option options [Integer] :max_attempts (3)
192
+ # An integer representing the maximum number attempts that will be made for
193
+ # a single request, including the initial attempt. For example,
194
+ # setting this value to 5 will result in a request being retried up to
195
+ # 4 times. Used in `standard` and `adaptive` retry modes.
196
+ #
169
197
  # @option options [String] :profile ("default")
170
198
  # Used when loading credentials from the shared credentials file
171
199
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
200
  #
201
+ # @option options [Proc] :retry_backoff
202
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
203
+ # This option is only used in the `legacy` retry mode.
204
+ #
173
205
  # @option options [Float] :retry_base_delay (0.3)
174
- # The base delay in seconds used by the default backoff function.
206
+ # The base delay in seconds used by the default backoff function. This option
207
+ # is only used in the `legacy` retry mode.
175
208
  #
176
209
  # @option options [Symbol] :retry_jitter (:none)
177
- # 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.
210
+ # A delay randomiser function used by the default backoff function.
211
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
212
+ # otherwise a Proc that takes and returns a number. This option is only used
213
+ # in the `legacy` retry mode.
178
214
  #
179
215
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
216
  #
@@ -182,11 +218,30 @@ module Aws::Inspector
182
218
  # The maximum number of times to retry failed requests. Only
183
219
  # ~ 500 level server errors and certain ~ 400 level client errors
184
220
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # errors from expired credentials.
221
+ # checksum errors, networking errors, timeout errors, auth errors,
222
+ # endpoint discovery, and errors from expired credentials.
223
+ # This option is only used in the `legacy` retry mode.
187
224
  #
188
225
  # @option options [Integer] :retry_max_delay (0)
189
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
226
+ # The maximum number of seconds to delay between retries (0 for no limit)
227
+ # used by the default backoff function. This option is only used in the
228
+ # `legacy` retry mode.
229
+ #
230
+ # @option options [String] :retry_mode ("legacy")
231
+ # Specifies which retry algorithm to use. Values are:
232
+ #
233
+ # * `legacy` - The pre-existing retry behavior. This is default value if
234
+ # no retry mode is provided.
235
+ #
236
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
237
+ # This includes support for retry quotas, which limit the number of
238
+ # unsuccessful retries a client can make.
239
+ #
240
+ # * `adaptive` - An experimental retry mode that includes all the
241
+ # functionality of `standard` mode along with automatic client side
242
+ # throttling. This is a provisional mode that may change behavior
243
+ # in the future.
244
+ #
190
245
  #
191
246
  # @option options [String] :secret_access_key
192
247
  #
@@ -219,16 +274,15 @@ module Aws::Inspector
219
274
  # requests through. Formatted like 'http://proxy.com:123'.
220
275
  #
221
276
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
277
+ # seconds to wait when opening a HTTP session before raising a
223
278
  # `Timeout::Error`.
224
279
  #
225
280
  # @option options [Integer] :http_read_timeout (60) The default
226
281
  # number of seconds to wait for response data. This value can
227
- # safely be set
228
- # per-request on the session yeidled by {#session_for}.
282
+ # safely be set per-request on the session.
229
283
  #
230
284
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
285
+ # seconds a connection is allowed to sit idle before it is
232
286
  # considered stale. Stale connections are closed and removed
233
287
  # from the pool before making a request.
234
288
  #
@@ -237,7 +291,7 @@ module Aws::Inspector
237
291
  # request body. This option has no effect unless the request has
238
292
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
293
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
294
+ # request on the session.
241
295
  #
242
296
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
297
  # HTTP debug output will be sent to the `:logger`.
@@ -1392,6 +1446,8 @@ module Aws::Inspector
1392
1446
  # * {Types::GetExclusionsPreviewResponse#exclusion_previews #exclusion_previews} => Array&lt;Types::ExclusionPreview&gt;
1393
1447
  # * {Types::GetExclusionsPreviewResponse#next_token #next_token} => String
1394
1448
  #
1449
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1450
+ #
1395
1451
  # @example Request syntax with placeholder values
1396
1452
  #
1397
1453
  # resp = client.get_exclusions_preview({
@@ -1651,6 +1707,8 @@ module Aws::Inspector
1651
1707
  # * {Types::ListAssessmentRunAgentsResponse#assessment_run_agents #assessment_run_agents} => Array&lt;Types::AssessmentRunAgent&gt;
1652
1708
  # * {Types::ListAssessmentRunAgentsResponse#next_token #next_token} => String
1653
1709
  #
1710
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1711
+ #
1654
1712
  #
1655
1713
  # @example Example: List assessment run agents
1656
1714
  #
@@ -1889,6 +1947,8 @@ module Aws::Inspector
1889
1947
  # * {Types::ListAssessmentRunsResponse#assessment_run_arns #assessment_run_arns} => Array&lt;String&gt;
1890
1948
  # * {Types::ListAssessmentRunsResponse#next_token #next_token} => String
1891
1949
  #
1950
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1951
+ #
1892
1952
  #
1893
1953
  # @example Example: List assessment runs
1894
1954
  #
@@ -1988,6 +2048,8 @@ module Aws::Inspector
1988
2048
  # * {Types::ListAssessmentTargetsResponse#assessment_target_arns #assessment_target_arns} => Array&lt;String&gt;
1989
2049
  # * {Types::ListAssessmentTargetsResponse#next_token #next_token} => String
1990
2050
  #
2051
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2052
+ #
1991
2053
  #
1992
2054
  # @example Example: List assessment targets
1993
2055
  #
@@ -2062,6 +2124,8 @@ module Aws::Inspector
2062
2124
  # * {Types::ListAssessmentTemplatesResponse#assessment_template_arns #assessment_template_arns} => Array&lt;String&gt;
2063
2125
  # * {Types::ListAssessmentTemplatesResponse#next_token #next_token} => String
2064
2126
  #
2127
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2128
+ #
2065
2129
  #
2066
2130
  # @example Example: List assessment templates
2067
2131
  #
@@ -2140,6 +2204,8 @@ module Aws::Inspector
2140
2204
  # * {Types::ListEventSubscriptionsResponse#subscriptions #subscriptions} => Array&lt;Types::Subscription&gt;
2141
2205
  # * {Types::ListEventSubscriptionsResponse#next_token #next_token} => String
2142
2206
  #
2207
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2208
+ #
2143
2209
  #
2144
2210
  # @example Example: List event subscriptions
2145
2211
  #
@@ -2217,6 +2283,8 @@ module Aws::Inspector
2217
2283
  # * {Types::ListExclusionsResponse#exclusion_arns #exclusion_arns} => Array&lt;String&gt;
2218
2284
  # * {Types::ListExclusionsResponse#next_token #next_token} => String
2219
2285
  #
2286
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2287
+ #
2220
2288
  # @example Request syntax with placeholder values
2221
2289
  #
2222
2290
  # resp = client.list_exclusions({
@@ -2272,6 +2340,8 @@ module Aws::Inspector
2272
2340
  # * {Types::ListFindingsResponse#finding_arns #finding_arns} => Array&lt;String&gt;
2273
2341
  # * {Types::ListFindingsResponse#next_token #next_token} => String
2274
2342
  #
2343
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2344
+ #
2275
2345
  #
2276
2346
  # @example Example: List findings
2277
2347
  #
@@ -2358,6 +2428,8 @@ module Aws::Inspector
2358
2428
  # * {Types::ListRulesPackagesResponse#rules_package_arns #rules_package_arns} => Array&lt;String&gt;
2359
2429
  # * {Types::ListRulesPackagesResponse#next_token #next_token} => String
2360
2430
  #
2431
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2432
+ #
2361
2433
  #
2362
2434
  # @example Example: List rules packages
2363
2435
  #
@@ -2473,6 +2545,8 @@ module Aws::Inspector
2473
2545
  # * {Types::PreviewAgentsResponse#agent_previews #agent_previews} => Array&lt;Types::AgentPreview&gt;
2474
2546
  # * {Types::PreviewAgentsResponse#next_token #next_token} => String
2475
2547
  #
2548
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
2549
+ #
2476
2550
  #
2477
2551
  # @example Example: Preview agents
2478
2552
  #
@@ -2904,7 +2978,7 @@ module Aws::Inspector
2904
2978
  params: params,
2905
2979
  config: config)
2906
2980
  context[:gem_name] = 'aws-sdk-inspector'
2907
- context[:gem_version] = '1.21.0'
2981
+ context[:gem_version] = '1.26.0'
2908
2982
  Seahorse::Client::Request.new(handlers, context)
2909
2983
  end
2910
2984
 
@@ -6,6 +6,39 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::Inspector
9
+
10
+ # When Inspector returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::Inspector::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all Inspector errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::Inspector::Errors::ServiceError
18
+ # # rescues all Inspector API errors
19
+ # end
20
+ #
21
+ #
22
+ # ## Request Context
23
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
24
+ # information about the request that generated the error.
25
+ # See {Seahorse::Client::RequestContext} for more information.
26
+ #
27
+ # ## Error Classes
28
+ # * {AccessDeniedException}
29
+ # * {AgentsAlreadyRunningAssessmentException}
30
+ # * {AssessmentRunInProgressException}
31
+ # * {InternalException}
32
+ # * {InvalidCrossAccountRoleException}
33
+ # * {InvalidInputException}
34
+ # * {LimitExceededException}
35
+ # * {NoSuchEntityException}
36
+ # * {PreviewGenerationInProgressException}
37
+ # * {ServiceTemporarilyUnavailableException}
38
+ # * {UnsupportedFeatureException}
39
+ #
40
+ # Additionally, error classes are dynamically generated for service errors based on the error code
41
+ # if they are not defined above.
9
42
  module Errors
10
43
 
11
44
  extend Aws::Errors::DynamicErrors
@@ -33,7 +66,6 @@ module Aws::Inspector
33
66
  def can_retry
34
67
  @data[:can_retry]
35
68
  end
36
-
37
69
  end
38
70
 
39
71
  class AgentsAlreadyRunningAssessmentException < ServiceError
@@ -64,7 +96,6 @@ module Aws::Inspector
64
96
  def can_retry
65
97
  @data[:can_retry]
66
98
  end
67
-
68
99
  end
69
100
 
70
101
  class AssessmentRunInProgressException < ServiceError
@@ -95,7 +126,6 @@ module Aws::Inspector
95
126
  def can_retry
96
127
  @data[:can_retry]
97
128
  end
98
-
99
129
  end
100
130
 
101
131
  class InternalException < ServiceError
@@ -116,7 +146,6 @@ module Aws::Inspector
116
146
  def can_retry
117
147
  @data[:can_retry]
118
148
  end
119
-
120
149
  end
121
150
 
122
151
  class InvalidCrossAccountRoleException < ServiceError
@@ -142,7 +171,6 @@ module Aws::Inspector
142
171
  def can_retry
143
172
  @data[:can_retry]
144
173
  end
145
-
146
174
  end
147
175
 
148
176
  class InvalidInputException < ServiceError
@@ -168,7 +196,6 @@ module Aws::Inspector
168
196
  def can_retry
169
197
  @data[:can_retry]
170
198
  end
171
-
172
199
  end
173
200
 
174
201
  class LimitExceededException < ServiceError
@@ -194,7 +221,6 @@ module Aws::Inspector
194
221
  def can_retry
195
222
  @data[:can_retry]
196
223
  end
197
-
198
224
  end
199
225
 
200
226
  class NoSuchEntityException < ServiceError
@@ -220,7 +246,6 @@ module Aws::Inspector
220
246
  def can_retry
221
247
  @data[:can_retry]
222
248
  end
223
-
224
249
  end
225
250
 
226
251
  class PreviewGenerationInProgressException < ServiceError
@@ -236,7 +261,6 @@ module Aws::Inspector
236
261
  def message
237
262
  @message || @data[:message]
238
263
  end
239
-
240
264
  end
241
265
 
242
266
  class ServiceTemporarilyUnavailableException < ServiceError
@@ -257,7 +281,6 @@ module Aws::Inspector
257
281
  def can_retry
258
282
  @data[:can_retry]
259
283
  end
260
-
261
284
  end
262
285
 
263
286
  class UnsupportedFeatureException < ServiceError
@@ -278,7 +301,6 @@ module Aws::Inspector
278
301
  def can_retry
279
302
  @data[:can_retry]
280
303
  end
281
-
282
304
  end
283
305
 
284
306
  end
@@ -6,6 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::Inspector
9
+
9
10
  class Resource
10
11
 
11
12
  # @param options ({})
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-inspector
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.21.0
4
+ version: 1.26.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-07-01 00:00:00.000000000 Z
11
+ date: 2020-05-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.58.0
22
+ version: 3.71.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.58.0
32
+ version: 3.71.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
81
81
  version: '0'
82
82
  requirements: []
83
83
  rubyforge_project:
84
- rubygems_version: 2.5.2.3
84
+ rubygems_version: 2.7.6.2
85
85
  signing_key:
86
86
  specification_version: 4
87
87
  summary: AWS SDK for Ruby - Amazon Inspector