aws-sdk-quicksight 1.17.1 → 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: 4c38ce2f48d8fb5ab1ce40146f8d785eb561ac71
4
- data.tar.gz: d8a6ea917615112080612d7d0a9106534eb54b08
3
+ metadata.gz: df2445835f0fab194c5698138d3ec1f7466e1e8e
4
+ data.tar.gz: 52be9e14ffb9c95bd907fac5e40e572d7a167c23
5
5
  SHA512:
6
- metadata.gz: 5e749b7eb81156d04642249c39994f0a85e57e356c3abaccc0a5a48dfe72a72b7d69d6e08597648559c6084ab338fe965189b32ecc77c1dbd2fbd8a5816f378d
7
- data.tar.gz: cd51eb3d432de8a8a235bba006daf452fac08e47813cd8fbf2c1f600e0258bd86fb0047e9b9ffc0bcb4ccefec12b02be92bef80b25b43c49086df5237d4e6d21
6
+ metadata.gz: 437a5503dfbbbabad88d48c0fee025aa5ca79614e8adf2fee60c442bd67df8d6065140c0eb55da19e026af33f3c98a621a871f7677ad3bcccbbc62fabb3f331e
7
+ data.tar.gz: 3081af083e6001b441ba6be4822d684c17383ebffcccfe0f0cdd7ff18190077a1eedeafa5a2eac89465dfe856b3a84da1714174c66f756ff9b24b22c89480119
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-quicksight/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # quick_sight = Aws::QuickSight::Client.new
28
+ # resp = quick_sight.cancel_ingestion(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from Amazon QuickSight all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from Amazon QuickSight 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::QuickSight::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all Amazon QuickSight API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-quicksight/customizations'
42
45
  # @service
43
46
  module Aws::QuickSight
44
47
 
45
- GEM_VERSION = '1.17.1'
48
+ GEM_VERSION = '1.18.0'
46
49
 
47
50
  end
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
30
30
  Aws::Plugins::GlobalConfiguration.add_identifier(:quicksight)
31
31
 
32
32
  module Aws::QuickSight
33
+ # An API client for QuickSight. To construct a client, you need to configure a `:region` and `:credentials`.
34
+ #
35
+ # client = Aws::QuickSight::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::QuickSight
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::QuickSight
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::QuickSight
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::QuickSight
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
  #
@@ -209,16 +260,16 @@ module Aws::QuickSight
209
260
  # requests through. Formatted like 'http://proxy.com:123'.
210
261
  #
211
262
  # @option options [Float] :http_open_timeout (15) The number of
212
- # seconds to wait when opening a HTTP session before rasing a
263
+ # seconds to wait when opening a HTTP session before raising a
213
264
  # `Timeout::Error`.
214
265
  #
215
266
  # @option options [Integer] :http_read_timeout (60) The default
216
267
  # number of seconds to wait for response data. This value can
217
268
  # safely be set
218
- # per-request on the session yeidled by {#session_for}.
269
+ # per-request on the session yielded by {#session_for}.
219
270
  #
220
271
  # @option options [Float] :http_idle_timeout (5) The number of
221
- # seconds a connection is allowed to sit idble before it is
272
+ # seconds a connection is allowed to sit idle before it is
222
273
  # considered stale. Stale connections are closed and removed
223
274
  # from the pool before making a request.
224
275
  #
@@ -227,7 +278,7 @@ module Aws::QuickSight
227
278
  # request body. This option has no effect unless the request has
228
279
  # "Expect" header set to "100-continue". Defaults to `nil` which
229
280
  # disables this behaviour. This value can safely be set per
230
- # request on the session yeidled by {#session_for}.
281
+ # request on the session yielded by {#session_for}.
231
282
  #
232
283
  # @option options [Boolean] :http_wire_trace (false) When `true`,
233
284
  # HTTP debug output will be sent to the `:logger`.
@@ -4651,7 +4702,7 @@ module Aws::QuickSight
4651
4702
  params: params,
4652
4703
  config: config)
4653
4704
  context[:gem_name] = 'aws-sdk-quicksight'
4654
- context[:gem_version] = '1.17.1'
4705
+ context[:gem_version] = '1.18.0'
4655
4706
  Seahorse::Client::Request.new(handlers, context)
4656
4707
  end
4657
4708
 
@@ -6,6 +6,45 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::QuickSight
9
+
10
+ # When QuickSight returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::QuickSight::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all QuickSight errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::QuickSight::Errors::ServiceError
18
+ # # rescues all QuickSight 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
+ # * {ConcurrentUpdatingException}
30
+ # * {ConflictException}
31
+ # * {DomainNotWhitelistedException}
32
+ # * {IdentityTypeNotSupportedException}
33
+ # * {InternalFailureException}
34
+ # * {InvalidNextTokenException}
35
+ # * {InvalidParameterValueException}
36
+ # * {LimitExceededException}
37
+ # * {PreconditionNotMetException}
38
+ # * {QuickSightUserNotFoundException}
39
+ # * {ResourceExistsException}
40
+ # * {ResourceNotFoundException}
41
+ # * {ResourceUnavailableException}
42
+ # * {SessionLifetimeInMinutesInvalidException}
43
+ # * {ThrottlingException}
44
+ # * {UnsupportedUserEditionException}
45
+ #
46
+ # Additionally, error classes are dynamically generated for service errors based on the error code
47
+ # if they are not defined above.
9
48
  module Errors
10
49
 
11
50
  extend Aws::Errors::DynamicErrors
@@ -28,7 +67,6 @@ module Aws::QuickSight
28
67
  def request_id
29
68
  @data[:request_id]
30
69
  end
31
-
32
70
  end
33
71
 
34
72
  class ConcurrentUpdatingException < ServiceError
@@ -49,7 +87,6 @@ module Aws::QuickSight
49
87
  def request_id
50
88
  @data[:request_id]
51
89
  end
52
-
53
90
  end
54
91
 
55
92
  class ConflictException < ServiceError
@@ -70,7 +107,6 @@ module Aws::QuickSight
70
107
  def request_id
71
108
  @data[:request_id]
72
109
  end
73
-
74
110
  end
75
111
 
76
112
  class DomainNotWhitelistedException < ServiceError
@@ -91,7 +127,6 @@ module Aws::QuickSight
91
127
  def request_id
92
128
  @data[:request_id]
93
129
  end
94
-
95
130
  end
96
131
 
97
132
  class IdentityTypeNotSupportedException < ServiceError
@@ -112,7 +147,6 @@ module Aws::QuickSight
112
147
  def request_id
113
148
  @data[:request_id]
114
149
  end
115
-
116
150
  end
117
151
 
118
152
  class InternalFailureException < ServiceError
@@ -133,7 +167,6 @@ module Aws::QuickSight
133
167
  def request_id
134
168
  @data[:request_id]
135
169
  end
136
-
137
170
  end
138
171
 
139
172
  class InvalidNextTokenException < ServiceError
@@ -154,7 +187,6 @@ module Aws::QuickSight
154
187
  def request_id
155
188
  @data[:request_id]
156
189
  end
157
-
158
190
  end
159
191
 
160
192
  class InvalidParameterValueException < ServiceError
@@ -175,7 +207,6 @@ module Aws::QuickSight
175
207
  def request_id
176
208
  @data[:request_id]
177
209
  end
178
-
179
210
  end
180
211
 
181
212
  class LimitExceededException < ServiceError
@@ -201,7 +232,6 @@ module Aws::QuickSight
201
232
  def request_id
202
233
  @data[:request_id]
203
234
  end
204
-
205
235
  end
206
236
 
207
237
  class PreconditionNotMetException < ServiceError
@@ -222,7 +252,6 @@ module Aws::QuickSight
222
252
  def request_id
223
253
  @data[:request_id]
224
254
  end
225
-
226
255
  end
227
256
 
228
257
  class QuickSightUserNotFoundException < ServiceError
@@ -243,7 +272,6 @@ module Aws::QuickSight
243
272
  def request_id
244
273
  @data[:request_id]
245
274
  end
246
-
247
275
  end
248
276
 
249
277
  class ResourceExistsException < ServiceError
@@ -269,7 +297,6 @@ module Aws::QuickSight
269
297
  def request_id
270
298
  @data[:request_id]
271
299
  end
272
-
273
300
  end
274
301
 
275
302
  class ResourceNotFoundException < ServiceError
@@ -295,7 +322,6 @@ module Aws::QuickSight
295
322
  def request_id
296
323
  @data[:request_id]
297
324
  end
298
-
299
325
  end
300
326
 
301
327
  class ResourceUnavailableException < ServiceError
@@ -321,7 +347,6 @@ module Aws::QuickSight
321
347
  def request_id
322
348
  @data[:request_id]
323
349
  end
324
-
325
350
  end
326
351
 
327
352
  class SessionLifetimeInMinutesInvalidException < ServiceError
@@ -342,7 +367,6 @@ module Aws::QuickSight
342
367
  def request_id
343
368
  @data[:request_id]
344
369
  end
345
-
346
370
  end
347
371
 
348
372
  class ThrottlingException < ServiceError
@@ -363,7 +387,6 @@ module Aws::QuickSight
363
387
  def request_id
364
388
  @data[:request_id]
365
389
  end
366
-
367
390
  end
368
391
 
369
392
  class UnsupportedUserEditionException < ServiceError
@@ -384,7 +407,6 @@ module Aws::QuickSight
384
407
  def request_id
385
408
  @data[:request_id]
386
409
  end
387
-
388
410
  end
389
411
 
390
412
  end
@@ -6,6 +6,13 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::QuickSight
9
+ # This class provides a resource oriented interface for QuickSight.
10
+ # To create a resource object:
11
+ # resource = Aws::QuickSight::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::QuickSight::Client.new(region: 'us-west-2')
15
+ # resource = Aws::QuickSight::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-quicksight
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.17.1
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: 2020-03-02 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