aws-sdk-inspector 1.23.0 → 1.24.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
2
  SHA1:
3
- metadata.gz: a6391a49cd65a3037ce7d45e51b3fbcb5bb2370b
4
- data.tar.gz: 9788a814c345332a6a8945c3509f52133c811167
3
+ metadata.gz: 05e2c882e6c787548d1a7caa33f922a1a3e32ec1
4
+ data.tar.gz: ca666c4fc784f065e55857983a51d8aea4f6bb3b
5
5
  SHA512:
6
- metadata.gz: 8ff248610957468c9329827b39eb25bd2328c27a09921b7a29e771a4a5280cbf2196043f7fc467e6a158746eb9d923fa6a9151b9b31431d9efa8fbe27056f24a
7
- data.tar.gz: 4e6e58d3ba062c69f4a0b65b9540dd167a801e1afb65afd119b200723c151f51140932fd4e33c6946e4ff80fc13f818e0479780ecd829db0b722be81734f3176
6
+ metadata.gz: 51e3924a2c63565913690639eeb285ec2f65fd4f7c6da1297aa93d89c14185407524a9f88902e00b270cd2cf7022c4abea76dcfa14663bdb4cf237d27da97f53
7
+ data.tar.gz: 8fd6a3ffb461e1f9d9694b6ea446930167d41a4192f086f68d2f61ff33bd86ba359b83354c66607cddebb262c9dd1e66886bc6c0e1552003e5e44598b19cfd3a
@@ -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.23.0'
48
+ GEM_VERSION = '1.24.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
@@ -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.
@@ -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,26 @@ 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
+ # * `legacy` - The pre-existing retry behavior. This is default value if
233
+ # no retry mode is provided.
234
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
235
+ # This includes support for retry quotas, which limit the number of
236
+ # unsuccessful retries a client can make.
237
+ # * `adaptive` - An experimental retry mode that includes all the
238
+ # functionality of `standard` mode along with automatic client side
239
+ # throttling. This is a provisional mode that may change behavior
240
+ # in the future.
190
241
  #
191
242
  # @option options [String] :secret_access_key
192
243
  #
@@ -219,16 +270,16 @@ module Aws::Inspector
219
270
  # requests through. Formatted like 'http://proxy.com:123'.
220
271
  #
221
272
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
273
+ # seconds to wait when opening a HTTP session before raising a
223
274
  # `Timeout::Error`.
224
275
  #
225
276
  # @option options [Integer] :http_read_timeout (60) The default
226
277
  # number of seconds to wait for response data. This value can
227
278
  # safely be set
228
- # per-request on the session yeidled by {#session_for}.
279
+ # per-request on the session yielded by {#session_for}.
229
280
  #
230
281
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
282
+ # seconds a connection is allowed to sit idle before it is
232
283
  # considered stale. Stale connections are closed and removed
233
284
  # from the pool before making a request.
234
285
  #
@@ -237,7 +288,7 @@ module Aws::Inspector
237
288
  # request body. This option has no effect unless the request has
238
289
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
290
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
291
+ # request on the session yielded by {#session_for}.
241
292
  #
242
293
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
294
  # HTTP debug output will be sent to the `:logger`.
@@ -2904,7 +2955,7 @@ module Aws::Inspector
2904
2955
  params: params,
2905
2956
  config: config)
2906
2957
  context[:gem_name] = 'aws-sdk-inspector'
2907
- context[:gem_version] = '1.23.0'
2958
+ context[:gem_version] = '1.24.0'
2908
2959
  Seahorse::Client::Request.new(handlers, context)
2909
2960
  end
2910
2961
 
@@ -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,13 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::Inspector
9
+ # This class provides a resource oriented interface for Inspector.
10
+ # To create a resource object:
11
+ # resource = Aws::Inspector::Resource.new(region: 'us-west-2')
12
+ # You can supply a client object with custom configuration that will be used for all resource operations.
13
+ # If you do not pass +:client+, a default client will be constructed.
14
+ # client = Aws::Inspector::Client.new(region: 'us-west-2')
15
+ # resource = Aws::Inspector::Resource.new(client: client)
9
16
  class Resource
10
17
 
11
18
  # @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.23.0
4
+ version: 1.24.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-10-23 00:00:00.000000000 Z
11
+ date: 2020-03-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core