aws-sdk-wafv2 1.1.0 → 1.2.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: ca8f4cd6356b4a82e5a2ae1940075b1257364b7b
4
- data.tar.gz: 345d69380ddf284f3950a92808f0c741c97c5d93
3
+ metadata.gz: f8717603935e63c74d97f8d18bffeb98bcccee7c
4
+ data.tar.gz: 5ee02ef35e00382ddc04fbdabda11c6d405d385c
5
5
  SHA512:
6
- metadata.gz: 6286f80bb1f3a5ff9336551cbea6ce7117c970a3ea1274474a272bda833ae0efbc5b9f8d9006ee2c5f21db0be774d96e1b9393f5d3ea7e69c43bb198c63df1cd
7
- data.tar.gz: 6988c818e2d346710e7c866a139fc44f5e8432e1bde877843f6d8fb970f2ab908c0605bcdd1717281ba0b2ce23575b7bdabda679f8df3ee42f89596bbf94f8ce
6
+ metadata.gz: f5a9436b80ba35b7b033e7c4bdf57202ddc27c1838e1238b74bc6d1b7c09383794a1d14eaf92ccf24adfc21a1cfc23806386bb08f5e7875831748806162a2e6c
7
+ data.tar.gz: d33d2035c0497bf63ecf39ba8b1c208101f1aedab5014066487d52d85a859dd2e67bc60a832b06600cffab6ca51f521fbf2a7ed5a098bdfca460fad6025ab95c
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-wafv2/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # wafv2 = Aws::WAFV2::Client.new
28
+ # resp = wafv2.associate_web_acl(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from AWS WAFV2 all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from AWS WAFV2 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::WAFV2::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all AWS WAFV2 API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-wafv2/customizations'
42
45
  # @service
43
46
  module Aws::WAFV2
44
47
 
45
- GEM_VERSION = '1.1.0'
48
+ GEM_VERSION = '1.2.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(:wafv2)
31
31
 
32
32
  module Aws::WAFV2
33
+ # An API client for WAFV2. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::WAFV2::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::WAFV2
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::WAFV2
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::WAFV2
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::WAFV2
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::WAFV2
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::WAFV2
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`.
@@ -4094,7 +4145,7 @@ module Aws::WAFV2
4094
4145
  params: params,
4095
4146
  config: config)
4096
4147
  context[:gem_name] = 'aws-sdk-wafv2'
4097
- context[:gem_version] = '1.1.0'
4148
+ context[:gem_version] = '1.2.0'
4098
4149
  Seahorse::Client::Request.new(handlers, context)
4099
4150
  end
4100
4151
 
@@ -6,6 +6,41 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::WAFV2
9
+
10
+ # When WAFV2 returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::WAFV2::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all WAFV2 errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::WAFV2::Errors::ServiceError
18
+ # # rescues all WAFV2 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
+ # * {WAFAssociatedItemException}
29
+ # * {WAFDuplicateItemException}
30
+ # * {WAFInternalErrorException}
31
+ # * {WAFInvalidParameterException}
32
+ # * {WAFInvalidResourceException}
33
+ # * {WAFLimitsExceededException}
34
+ # * {WAFNonexistentItemException}
35
+ # * {WAFOptimisticLockException}
36
+ # * {WAFServiceLinkedRoleErrorException}
37
+ # * {WAFSubscriptionNotFoundException}
38
+ # * {WAFTagOperationException}
39
+ # * {WAFTagOperationInternalErrorException}
40
+ # * {WAFUnavailableEntityException}
41
+ #
42
+ # Additionally, error classes are dynamically generated for service errors based on the error code
43
+ # if they are not defined above.
9
44
  module Errors
10
45
 
11
46
  extend Aws::Errors::DynamicErrors
@@ -23,7 +58,6 @@ module Aws::WAFV2
23
58
  def message
24
59
  @message || @data[:message]
25
60
  end
26
-
27
61
  end
28
62
 
29
63
  class WAFDuplicateItemException < ServiceError
@@ -39,7 +73,6 @@ module Aws::WAFV2
39
73
  def message
40
74
  @message || @data[:message]
41
75
  end
42
-
43
76
  end
44
77
 
45
78
  class WAFInternalErrorException < ServiceError
@@ -55,7 +88,6 @@ module Aws::WAFV2
55
88
  def message
56
89
  @message || @data[:message]
57
90
  end
58
-
59
91
  end
60
92
 
61
93
  class WAFInvalidParameterException < ServiceError
@@ -86,7 +118,6 @@ module Aws::WAFV2
86
118
  def reason
87
119
  @data[:reason]
88
120
  end
89
-
90
121
  end
91
122
 
92
123
  class WAFInvalidResourceException < ServiceError
@@ -102,7 +133,6 @@ module Aws::WAFV2
102
133
  def message
103
134
  @message || @data[:message]
104
135
  end
105
-
106
136
  end
107
137
 
108
138
  class WAFLimitsExceededException < ServiceError
@@ -118,7 +148,6 @@ module Aws::WAFV2
118
148
  def message
119
149
  @message || @data[:message]
120
150
  end
121
-
122
151
  end
123
152
 
124
153
  class WAFNonexistentItemException < ServiceError
@@ -134,7 +163,6 @@ module Aws::WAFV2
134
163
  def message
135
164
  @message || @data[:message]
136
165
  end
137
-
138
166
  end
139
167
 
140
168
  class WAFOptimisticLockException < ServiceError
@@ -150,7 +178,6 @@ module Aws::WAFV2
150
178
  def message
151
179
  @message || @data[:message]
152
180
  end
153
-
154
181
  end
155
182
 
156
183
  class WAFServiceLinkedRoleErrorException < ServiceError
@@ -166,7 +193,6 @@ module Aws::WAFV2
166
193
  def message
167
194
  @message || @data[:message]
168
195
  end
169
-
170
196
  end
171
197
 
172
198
  class WAFSubscriptionNotFoundException < ServiceError
@@ -182,7 +208,6 @@ module Aws::WAFV2
182
208
  def message
183
209
  @message || @data[:message]
184
210
  end
185
-
186
211
  end
187
212
 
188
213
  class WAFTagOperationException < ServiceError
@@ -198,7 +223,6 @@ module Aws::WAFV2
198
223
  def message
199
224
  @message || @data[:message]
200
225
  end
201
-
202
226
  end
203
227
 
204
228
  class WAFTagOperationInternalErrorException < ServiceError
@@ -214,7 +238,6 @@ module Aws::WAFV2
214
238
  def message
215
239
  @message || @data[:message]
216
240
  end
217
-
218
241
  end
219
242
 
220
243
  class WAFUnavailableEntityException < ServiceError
@@ -230,7 +253,6 @@ module Aws::WAFV2
230
253
  def message
231
254
  @message || @data[:message]
232
255
  end
233
-
234
256
  end
235
257
 
236
258
  end
@@ -6,6 +6,13 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::WAFV2
9
+ # This class provides a resource oriented interface for WAFV2.
10
+ # To create a resource object:
11
+ # resource = Aws::WAFV2::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::WAFV2::Client.new(region: 'us-west-2')
15
+ # resource = Aws::WAFV2::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-wafv2
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.0
4
+ version: 1.2.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: 2020-02-21 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