aws-sdk-swf 1.17.0 → 1.18.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: 3dea98d06d2f2e3e0fc13bb9ea4d8f13c29788c9
4
- data.tar.gz: 38f89aec6fefe53a3d56a74141c4acfbec22a255
3
+ metadata.gz: 924ac335b1168eb0515ac11776a630ae6a96f3b6
4
+ data.tar.gz: b83802a1994b1cf0d275c1c3e9e4948f5ac50611
5
5
  SHA512:
6
- metadata.gz: 648c62e2cd02c36a82f3725dc7eac60c02256d6900acfbba571971a5976ddff67f8445490510a70a688a5d5dad508bfd0e6de9f3a561c36d400310132d135ab5
7
- data.tar.gz: a9951369eb5917815e309584abacf3549047e0184764588e4735947c0275aa4752ed66c629fbf9d893d5d6f246ed6c916fc8b62598f73122a5f5d2ae11a24b97
6
+ metadata.gz: 95c9e2f4d8d900a3f86a2d1d9824111a75b8e076cd583e1c105cb561075e970c615d2dd1a5f48467600d2e287125993cc06b1d3e0622b934e4c322ee6344c75c
7
+ data.tar.gz: b0727e8ced4046cc203fb98dad1350f019b09ec44afa9e65fb3f9416029c878236804a3f2348e0988e95dc3a0f50bcc64ac2abbcc1e5acaf037f92f178677689
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-swf/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # swf = Aws::SWF::Client.new
28
+ # resp = swf.count_closed_workflow_executions(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from Amazon Simple Workflow Service all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from Amazon Simple Workflow Service 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::SWF::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all Amazon Simple Workflow Service API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-swf/customizations'
42
45
  # @service
43
46
  module Aws::SWF
44
47
 
45
- GEM_VERSION = '1.17.0'
48
+ GEM_VERSION = '1.18.0'
46
49
 
47
50
  end
@@ -31,6 +31,18 @@ require 'aws-sdk-swf/plugins/read_timeouts.rb'
31
31
  Aws::Plugins::GlobalConfiguration.add_identifier(:swf)
32
32
 
33
33
  module Aws::SWF
34
+ # An API client for SWF. To construct a client, you need to configure a `:region` and `:credentials`.
35
+ #
36
+ # client = Aws::SWF::Client.new(
37
+ # region: region_name,
38
+ # credentials: credentials,
39
+ # # ...
40
+ # )
41
+ #
42
+ # For details on configuring region and credentials see
43
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
44
+ #
45
+ # See {#initialize} for a full list of supported configuration options.
34
46
  class Client < Seahorse::Client::Base
35
47
 
36
48
  include Aws::ClientStubs
@@ -110,6 +122,12 @@ module Aws::SWF
110
122
  # When set to `true`, a thread polling for endpoints will be running in
111
123
  # the background every 60 secs (default). Defaults to `false`.
112
124
  #
125
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
126
+ # Used only in `adaptive` retry mode. When true, the request will sleep
127
+ # until there is sufficent client side capacity to retry the request.
128
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
129
+ # not retry instead of sleeping.
130
+ #
113
131
  # @option options [Boolean] :client_side_monitoring (false)
114
132
  # When `true`, client-side metrics will be collected for all API requests from
115
133
  # this client.
@@ -134,6 +152,10 @@ module Aws::SWF
134
152
  # When `true`, an attempt is made to coerce request parameters into
135
153
  # the required types.
136
154
  #
155
+ # @option options [Boolean] :correct_clock_skew (true)
156
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
157
+ # a clock skew correction and retry requests with skewed client clocks.
158
+ #
137
159
  # @option options [Boolean] :disable_host_prefix_injection (false)
138
160
  # Set to true to disable SDK automatically adding host prefix
139
161
  # to default service endpoint when available.
@@ -168,15 +190,29 @@ module Aws::SWF
168
190
  # The Logger instance to send log messages to. If this option
169
191
  # is not set, logging will be disabled.
170
192
  #
193
+ # @option options [Integer] :max_attempts (3)
194
+ # An integer representing the maximum number attempts that will be made for
195
+ # a single request, including the initial attempt. For example,
196
+ # setting this value to 5 will result in a request being retried up to
197
+ # 4 times. Used in `standard` and `adaptive` retry modes.
198
+ #
171
199
  # @option options [String] :profile ("default")
172
200
  # Used when loading credentials from the shared credentials file
173
201
  # at HOME/.aws/credentials. When not specified, 'default' is used.
174
202
  #
203
+ # @option options [Proc] :retry_backoff
204
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
205
+ # This option is only used in the `legacy` retry mode.
206
+ #
175
207
  # @option options [Float] :retry_base_delay (0.3)
176
- # The base delay in seconds used by the default backoff function.
208
+ # The base delay in seconds used by the default backoff function. This option
209
+ # is only used in the `legacy` retry mode.
177
210
  #
178
211
  # @option options [Symbol] :retry_jitter (:none)
179
- # 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.
212
+ # A delay randomiser function used by the default backoff function.
213
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
214
+ # otherwise a Proc that takes and returns a number. This option is only used
215
+ # in the `legacy` retry mode.
180
216
  #
181
217
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
182
218
  #
@@ -184,11 +220,26 @@ module Aws::SWF
184
220
  # The maximum number of times to retry failed requests. Only
185
221
  # ~ 500 level server errors and certain ~ 400 level client errors
186
222
  # are retried. Generally, these are throttling errors, data
187
- # checksum errors, networking errors, timeout errors and auth
188
- # errors from expired credentials.
223
+ # checksum errors, networking errors, timeout errors, auth errors,
224
+ # endpoint discovery, and errors from expired credentials.
225
+ # This option is only used in the `legacy` retry mode.
189
226
  #
190
227
  # @option options [Integer] :retry_max_delay (0)
191
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
228
+ # The maximum number of seconds to delay between retries (0 for no limit)
229
+ # used by the default backoff function. This option is only used in the
230
+ # `legacy` retry mode.
231
+ #
232
+ # @option options [String] :retry_mode ("legacy")
233
+ # Specifies which retry algorithm to use. Values are:
234
+ # * `legacy` - The pre-existing retry behavior. This is default value if
235
+ # no retry mode is provided.
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
+ # * `adaptive` - An experimental retry mode that includes all the
240
+ # functionality of `standard` mode along with automatic client side
241
+ # throttling. This is a provisional mode that may change behavior
242
+ # in the future.
192
243
  #
193
244
  # @option options [String] :secret_access_key
194
245
  #
@@ -221,16 +272,16 @@ module Aws::SWF
221
272
  # requests through. Formatted like 'http://proxy.com:123'.
222
273
  #
223
274
  # @option options [Float] :http_open_timeout (15) The number of
224
- # seconds to wait when opening a HTTP session before rasing a
275
+ # seconds to wait when opening a HTTP session before raising a
225
276
  # `Timeout::Error`.
226
277
  #
227
278
  # @option options [Integer] :http_read_timeout (60) The default
228
279
  # number of seconds to wait for response data. This value can
229
280
  # safely be set
230
- # per-request on the session yeidled by {#session_for}.
281
+ # per-request on the session yielded by {#session_for}.
231
282
  #
232
283
  # @option options [Float] :http_idle_timeout (5) The number of
233
- # seconds a connection is allowed to sit idble before it is
284
+ # seconds a connection is allowed to sit idle before it is
234
285
  # considered stale. Stale connections are closed and removed
235
286
  # from the pool before making a request.
236
287
  #
@@ -239,7 +290,7 @@ module Aws::SWF
239
290
  # request body. This option has no effect unless the request has
240
291
  # "Expect" header set to "100-continue". Defaults to `nil` which
241
292
  # disables this behaviour. This value can safely be set per
242
- # request on the session yeidled by {#session_for}.
293
+ # request on the session yielded by {#session_for}.
243
294
  #
244
295
  # @option options [Boolean] :http_wire_trace (false) When `true`,
245
296
  # HTTP debug output will be sent to the `:logger`.
@@ -4201,7 +4252,7 @@ module Aws::SWF
4201
4252
  params: params,
4202
4253
  config: config)
4203
4254
  context[:gem_name] = 'aws-sdk-swf'
4204
- context[:gem_version] = '1.17.0'
4255
+ context[:gem_version] = '1.18.0'
4205
4256
  Seahorse::Client::Request.new(handlers, context)
4206
4257
  end
4207
4258
 
@@ -6,6 +6,38 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::SWF
9
+
10
+ # When SWF returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::SWF::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all SWF errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::SWF::Errors::ServiceError
18
+ # # rescues all SWF 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
+ # * {DefaultUndefinedFault}
29
+ # * {DomainAlreadyExistsFault}
30
+ # * {DomainDeprecatedFault}
31
+ # * {LimitExceededFault}
32
+ # * {OperationNotPermittedFault}
33
+ # * {TooManyTagsFault}
34
+ # * {TypeAlreadyExistsFault}
35
+ # * {TypeDeprecatedFault}
36
+ # * {UnknownResourceFault}
37
+ # * {WorkflowExecutionAlreadyStartedFault}
38
+ #
39
+ # Additionally, error classes are dynamically generated for service errors based on the error code
40
+ # if they are not defined above.
9
41
  module Errors
10
42
 
11
43
  extend Aws::Errors::DynamicErrors
@@ -23,7 +55,6 @@ module Aws::SWF
23
55
  def message
24
56
  @message || @data[:message]
25
57
  end
26
-
27
58
  end
28
59
 
29
60
  class DomainAlreadyExistsFault < ServiceError
@@ -39,7 +70,6 @@ module Aws::SWF
39
70
  def message
40
71
  @message || @data[:message]
41
72
  end
42
-
43
73
  end
44
74
 
45
75
  class DomainDeprecatedFault < ServiceError
@@ -55,7 +85,6 @@ module Aws::SWF
55
85
  def message
56
86
  @message || @data[:message]
57
87
  end
58
-
59
88
  end
60
89
 
61
90
  class LimitExceededFault < ServiceError
@@ -71,7 +100,6 @@ module Aws::SWF
71
100
  def message
72
101
  @message || @data[:message]
73
102
  end
74
-
75
103
  end
76
104
 
77
105
  class OperationNotPermittedFault < ServiceError
@@ -87,7 +115,6 @@ module Aws::SWF
87
115
  def message
88
116
  @message || @data[:message]
89
117
  end
90
-
91
118
  end
92
119
 
93
120
  class TooManyTagsFault < ServiceError
@@ -103,7 +130,6 @@ module Aws::SWF
103
130
  def message
104
131
  @message || @data[:message]
105
132
  end
106
-
107
133
  end
108
134
 
109
135
  class TypeAlreadyExistsFault < ServiceError
@@ -119,7 +145,6 @@ module Aws::SWF
119
145
  def message
120
146
  @message || @data[:message]
121
147
  end
122
-
123
148
  end
124
149
 
125
150
  class TypeDeprecatedFault < ServiceError
@@ -135,7 +160,6 @@ module Aws::SWF
135
160
  def message
136
161
  @message || @data[:message]
137
162
  end
138
-
139
163
  end
140
164
 
141
165
  class UnknownResourceFault < ServiceError
@@ -151,7 +175,6 @@ module Aws::SWF
151
175
  def message
152
176
  @message || @data[:message]
153
177
  end
154
-
155
178
  end
156
179
 
157
180
  class WorkflowExecutionAlreadyStartedFault < ServiceError
@@ -167,7 +190,6 @@ module Aws::SWF
167
190
  def message
168
191
  @message || @data[:message]
169
192
  end
170
-
171
193
  end
172
194
 
173
195
  end
@@ -6,6 +6,13 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::SWF
9
+ # This class provides a resource oriented interface for SWF.
10
+ # To create a resource object:
11
+ # resource = Aws::SWF::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::SWF::Client.new(region: 'us-west-2')
15
+ # resource = Aws::SWF::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-swf
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.17.0
4
+ version: 1.18.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