aws-sdk-sso 1.1.1 → 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: fd628c39fbee98bad02ffeb8889374c0e7ea4a66
4
- data.tar.gz: f0d04954c20c25b8b5c4bfc48b99d3bae40a3a53
3
+ metadata.gz: 9cfc932ae4c2ea188cfa84656b3387de83240471
4
+ data.tar.gz: 7650ad546e77d25c002d0f73d2f360998b53c0d5
5
5
  SHA512:
6
- metadata.gz: bcd1fa02f659c89733e25dc479a2e6b597bfcc12fbe98cd6213bf8bf22d000fd30116fa0d9e0d9ac6c778ebabadb3fc3630bb9cbea7d229112bf4da12e9deb89
7
- data.tar.gz: 8ac1b10982689e708b038550e096a8a87b6c1640080b0b3e7c6e3692d51eb1d91e640081816b7f2da5dd030add61b7fba36346d28bf9d2c54bc3426552e4cb9b
6
+ metadata.gz: c7a7c1d0528f7cc3bfa87c2bd934c5fdf54ec18acd3b56b90bf7fc5b4ff61533d8c427a855c1ea4759f0750bf7b0d641711861c912e1203e1d66a0fe4c6f1ada
7
+ data.tar.gz: 7c0a10087fa0acff24c578a2e3fe7e8fe7710912981dea4d90ed89201837aa50e6dad7fafb88a55b595c7b40a3e4ee1b918579c9ca2714a2d8ebcf808aca9ebb
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-sso/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # sso = Aws::SSO::Client.new
28
+ # resp = sso.get_role_credentials(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from AWS Single Sign-On all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from AWS Single Sign-On 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::SSO::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all AWS Single Sign-On API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-sso/customizations'
42
45
  # @service
43
46
  module Aws::SSO
44
47
 
45
- GEM_VERSION = '1.1.1'
48
+ GEM_VERSION = '1.2.0'
46
49
 
47
50
  end
@@ -31,6 +31,18 @@ require 'aws-sdk-sso/plugins/content_type.rb'
31
31
  Aws::Plugins::GlobalConfiguration.add_identifier(:sso)
32
32
 
33
33
  module Aws::SSO
34
+ # An API client for SSO. To construct a client, you need to configure a `:region` and `:credentials`.
35
+ #
36
+ # client = Aws::SSO::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::SSO
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::SSO
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::SSO
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::SSO
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
  #
@@ -211,16 +262,16 @@ module Aws::SSO
211
262
  # requests through. Formatted like 'http://proxy.com:123'.
212
263
  #
213
264
  # @option options [Float] :http_open_timeout (15) The number of
214
- # seconds to wait when opening a HTTP session before rasing a
265
+ # seconds to wait when opening a HTTP session before raising a
215
266
  # `Timeout::Error`.
216
267
  #
217
268
  # @option options [Integer] :http_read_timeout (60) The default
218
269
  # number of seconds to wait for response data. This value can
219
270
  # safely be set
220
- # per-request on the session yeidled by {#session_for}.
271
+ # per-request on the session yielded by {#session_for}.
221
272
  #
222
273
  # @option options [Float] :http_idle_timeout (5) The number of
223
- # seconds a connection is allowed to sit idble before it is
274
+ # seconds a connection is allowed to sit idle before it is
224
275
  # considered stale. Stale connections are closed and removed
225
276
  # from the pool before making a request.
226
277
  #
@@ -229,7 +280,7 @@ module Aws::SSO
229
280
  # request body. This option has no effect unless the request has
230
281
  # "Expect" header set to "100-continue". Defaults to `nil` which
231
282
  # disables this behaviour. This value can safely be set per
232
- # request on the session yeidled by {#session_for}.
283
+ # request on the session yielded by {#session_for}.
233
284
  #
234
285
  # @option options [Boolean] :http_wire_trace (false) When `true`,
235
286
  # HTTP debug output will be sent to the `:logger`.
@@ -446,7 +497,7 @@ module Aws::SSO
446
497
  params: params,
447
498
  config: config)
448
499
  context[:gem_name] = 'aws-sdk-sso'
449
- context[:gem_version] = '1.1.1'
500
+ context[:gem_version] = '1.2.0'
450
501
  Seahorse::Client::Request.new(handlers, context)
451
502
  end
452
503
 
@@ -6,6 +6,32 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::SSO
9
+
10
+ # When SSO returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::SSO::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all SSO errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::SSO::Errors::ServiceError
18
+ # # rescues all SSO 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
+ # * {InvalidRequestException}
29
+ # * {ResourceNotFoundException}
30
+ # * {TooManyRequestsException}
31
+ # * {UnauthorizedException}
32
+ #
33
+ # Additionally, error classes are dynamically generated for service errors based on the error code
34
+ # if they are not defined above.
9
35
  module Errors
10
36
 
11
37
  extend Aws::Errors::DynamicErrors
@@ -23,7 +49,6 @@ module Aws::SSO
23
49
  def message
24
50
  @message || @data[:message]
25
51
  end
26
-
27
52
  end
28
53
 
29
54
  class ResourceNotFoundException < ServiceError
@@ -39,7 +64,6 @@ module Aws::SSO
39
64
  def message
40
65
  @message || @data[:message]
41
66
  end
42
-
43
67
  end
44
68
 
45
69
  class TooManyRequestsException < ServiceError
@@ -55,7 +79,6 @@ module Aws::SSO
55
79
  def message
56
80
  @message || @data[:message]
57
81
  end
58
-
59
82
  end
60
83
 
61
84
  class UnauthorizedException < ServiceError
@@ -71,7 +94,6 @@ module Aws::SSO
71
94
  def message
72
95
  @message || @data[:message]
73
96
  end
74
-
75
97
  end
76
98
 
77
99
  end
@@ -6,6 +6,13 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::SSO
9
+ # This class provides a resource oriented interface for SSO.
10
+ # To create a resource object:
11
+ # resource = Aws::SSO::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::SSO::Client.new(region: 'us-west-2')
15
+ # resource = Aws::SSO::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-sso
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.1.1
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-01-14 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