aws-sdk-support 1.17.0 → 1.18.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 1d906fefaa7dcfc2f17c2e0f0b9cd980c4c391a1
4
- data.tar.gz: 8f8548802aa737b18e6d807880d9441156047356
3
+ metadata.gz: aff2ac1184b30e73c0928562cb25cc55adfb16ea
4
+ data.tar.gz: eff10ed9ccee91ef3cab2e2de4516345faff75ae
5
5
  SHA512:
6
- metadata.gz: 99ee66d841bade7d9c739e31ca186ca2ac03f65d137ccb3612ae1a75d6b97921f618c647f6c4948519d3da43450e4efdcdd51a824c2960160c69f2333f754db6
7
- data.tar.gz: ba19f60a2a73481a984b406b82b5a70a480067427fe753467b9051542d41cb2eb79dc413db67a71ed2ed1a3bfef612b9e65233c45807a0b05e3d0621eecce13e
6
+ metadata.gz: eebefd28b214211ae4c861e1d19085b12da3c0eecef9ab28b0e63cd459a6fdb14d2e42fe19c2e076a89701dd29cb1a2e4348d331a4b3dda6d342fdbe3a1336fb
7
+ data.tar.gz: a752e7cc55e502b86140523d963ac14ac97ad0e8c89980e71ce5f403f6d86eaa28895a903c915ed75b7b1ba45ac15c237fdb75aed6722e37c0b9e96f611e2512
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-support/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # support = Aws::Support::Client.new
28
+ # resp = support.add_attachments_to_set(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from AWS Support all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from AWS Support 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::Support::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all AWS Support API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-support/customizations'
42
45
  # @service
43
46
  module Aws::Support
44
47
 
45
- GEM_VERSION = '1.17.0'
48
+ GEM_VERSION = '1.18.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(:support)
31
31
 
32
32
  module Aws::Support
33
+ # An API client for Support. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::Support::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::Support
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::Support
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::Support
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::Support
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::Support
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::Support
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`.
@@ -1127,7 +1178,7 @@ module Aws::Support
1127
1178
  params: params,
1128
1179
  config: config)
1129
1180
  context[:gem_name] = 'aws-sdk-support'
1130
- context[:gem_version] = '1.17.0'
1181
+ context[:gem_version] = '1.18.0'
1131
1182
  Seahorse::Client::Request.new(handlers, context)
1132
1183
  end
1133
1184
 
@@ -6,6 +6,37 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::Support
9
+
10
+ # When Support returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::Support::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all Support errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::Support::Errors::ServiceError
18
+ # # rescues all Support 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
+ # * {AttachmentIdNotFound}
29
+ # * {AttachmentLimitExceeded}
30
+ # * {AttachmentSetExpired}
31
+ # * {AttachmentSetIdNotFound}
32
+ # * {AttachmentSetSizeLimitExceeded}
33
+ # * {CaseCreationLimitExceeded}
34
+ # * {CaseIdNotFound}
35
+ # * {DescribeAttachmentLimitExceeded}
36
+ # * {InternalServerError}
37
+ #
38
+ # Additionally, error classes are dynamically generated for service errors based on the error code
39
+ # if they are not defined above.
9
40
  module Errors
10
41
 
11
42
  extend Aws::Errors::DynamicErrors
@@ -23,7 +54,6 @@ module Aws::Support
23
54
  def message
24
55
  @message || @data[:message]
25
56
  end
26
-
27
57
  end
28
58
 
29
59
  class AttachmentLimitExceeded < ServiceError
@@ -39,7 +69,6 @@ module Aws::Support
39
69
  def message
40
70
  @message || @data[:message]
41
71
  end
42
-
43
72
  end
44
73
 
45
74
  class AttachmentSetExpired < ServiceError
@@ -55,7 +84,6 @@ module Aws::Support
55
84
  def message
56
85
  @message || @data[:message]
57
86
  end
58
-
59
87
  end
60
88
 
61
89
  class AttachmentSetIdNotFound < ServiceError
@@ -71,7 +99,6 @@ module Aws::Support
71
99
  def message
72
100
  @message || @data[:message]
73
101
  end
74
-
75
102
  end
76
103
 
77
104
  class AttachmentSetSizeLimitExceeded < ServiceError
@@ -87,7 +114,6 @@ module Aws::Support
87
114
  def message
88
115
  @message || @data[:message]
89
116
  end
90
-
91
117
  end
92
118
 
93
119
  class CaseCreationLimitExceeded < ServiceError
@@ -103,7 +129,6 @@ module Aws::Support
103
129
  def message
104
130
  @message || @data[:message]
105
131
  end
106
-
107
132
  end
108
133
 
109
134
  class CaseIdNotFound < ServiceError
@@ -119,7 +144,6 @@ module Aws::Support
119
144
  def message
120
145
  @message || @data[:message]
121
146
  end
122
-
123
147
  end
124
148
 
125
149
  class DescribeAttachmentLimitExceeded < ServiceError
@@ -135,7 +159,6 @@ module Aws::Support
135
159
  def message
136
160
  @message || @data[:message]
137
161
  end
138
-
139
162
  end
140
163
 
141
164
  class InternalServerError < ServiceError
@@ -151,7 +174,6 @@ module Aws::Support
151
174
  def message
152
175
  @message || @data[:message]
153
176
  end
154
-
155
177
  end
156
178
 
157
179
  end
@@ -6,6 +6,13 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::Support
9
+ # This class provides a resource oriented interface for Support.
10
+ # To create a resource object:
11
+ # resource = Aws::Support::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::Support::Client.new(region: 'us-west-2')
15
+ # resource = Aws::Support::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-support
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-31 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