aws-sdk-sso 1.1.0 → 1.5.1

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
- SHA1:
3
- metadata.gz: aa3ade5957cdb033a4628bea0ef1cb946af1bef3
4
- data.tar.gz: 94d3d77eecc5272dad8adb3a341df65351f8cbdb
2
+ SHA256:
3
+ metadata.gz: a796b33c02e4fa03e583be2d92fb751b3e457840ead50a3eb5288bd7cbe5c822
4
+ data.tar.gz: f4609dd4e8a363895c228554369beeb6f664650e5bea48bfd86077d4c62bd68d
5
5
  SHA512:
6
- metadata.gz: 4a00b201ce35f420c7123c7497e89b1759ad639674c9b1f07a755685d6051223343aa2be1ecc927e466c55dc676bda71f064baebd2ad42b2d4e5b46f0cd0597c
7
- data.tar.gz: e66455cbeed06dd03fdeb5da9a9ac8e507d1a0399b6ec4f39050a8a8f8813cf3a2ca0b1b87669dcb7849867c2fd12db3f6a0068364bd5bfe235378c0df79df05
6
+ metadata.gz: 9c4749020579159556dfb4ea75c264c4d65207b5e2e505adbab6e1fb74013cf18142564025ceda6cc118d40af7f22fcd9b989eb2406de1bd084b9e6d3d98bd8d
7
+ data.tar.gz: bba73b7205655d56dff905e95832dc78a1d277959ed05ecc1f08cc3edde869c33300eb92bfb01a02e1808e7f338a24fbbec01001b58da096b8cc18aca2124131
@@ -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.0'
48
+ GEM_VERSION = '1.5.1'
46
49
 
47
50
  end
@@ -24,6 +24,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
24
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
25
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
26
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
27
+ require 'aws-sdk-core/plugins/http_checksum.rb'
27
28
  require 'aws-sdk-core/plugins/signature_v4.rb'
28
29
  require 'aws-sdk-core/plugins/protocols/rest_json.rb'
29
30
  require 'aws-sdk-sso/plugins/content_type.rb'
@@ -31,6 +32,18 @@ require 'aws-sdk-sso/plugins/content_type.rb'
31
32
  Aws::Plugins::GlobalConfiguration.add_identifier(:sso)
32
33
 
33
34
  module Aws::SSO
35
+ # An API client for SSO. To construct a client, you need to configure a `:region` and `:credentials`.
36
+ #
37
+ # client = Aws::SSO::Client.new(
38
+ # region: region_name,
39
+ # credentials: credentials,
40
+ # # ...
41
+ # )
42
+ #
43
+ # For details on configuring region and credentials see
44
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
45
+ #
46
+ # See {#initialize} for a full list of supported configuration options.
34
47
  class Client < Seahorse::Client::Base
35
48
 
36
49
  include Aws::ClientStubs
@@ -58,6 +71,7 @@ module Aws::SSO
58
71
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
59
72
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
60
73
  add_plugin(Aws::Plugins::TransferEncoding)
74
+ add_plugin(Aws::Plugins::HttpChecksum)
61
75
  add_plugin(Aws::Plugins::SignatureV4)
62
76
  add_plugin(Aws::Plugins::Protocols::RestJson)
63
77
  add_plugin(Aws::SSO::Plugins::ContentType)
@@ -95,7 +109,7 @@ module Aws::SSO
95
109
  # @option options [required, String] :region
96
110
  # The AWS region to connect to. The configured `:region` is
97
111
  # used to determine the service `:endpoint`. When not passed,
98
- # a default `:region` is search for in the following locations:
112
+ # a default `:region` is searched for in the following locations:
99
113
  #
100
114
  # * `Aws.config[:region]`
101
115
  # * `ENV['AWS_REGION']`
@@ -110,6 +124,12 @@ module Aws::SSO
110
124
  # When set to `true`, a thread polling for endpoints will be running in
111
125
  # the background every 60 secs (default). Defaults to `false`.
112
126
  #
127
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
128
+ # Used only in `adaptive` retry mode. When true, the request will sleep
129
+ # until there is sufficent client side capacity to retry the request.
130
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
131
+ # not retry instead of sleeping.
132
+ #
113
133
  # @option options [Boolean] :client_side_monitoring (false)
114
134
  # When `true`, client-side metrics will be collected for all API requests from
115
135
  # this client.
@@ -134,6 +154,10 @@ module Aws::SSO
134
154
  # When `true`, an attempt is made to coerce request parameters into
135
155
  # the required types.
136
156
  #
157
+ # @option options [Boolean] :correct_clock_skew (true)
158
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
159
+ # a clock skew correction and retry requests with skewed client clocks.
160
+ #
137
161
  # @option options [Boolean] :disable_host_prefix_injection (false)
138
162
  # Set to true to disable SDK automatically adding host prefix
139
163
  # to default service endpoint when available.
@@ -141,7 +165,7 @@ module Aws::SSO
141
165
  # @option options [String] :endpoint
142
166
  # The client endpoint is normally constructed from the `:region`
143
167
  # option. You should only configure an `:endpoint` when connecting
144
- # to test endpoints. This should be avalid HTTP(S) URI.
168
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
145
169
  #
146
170
  # @option options [Integer] :endpoint_cache_max_entries (1000)
147
171
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -156,7 +180,7 @@ module Aws::SSO
156
180
  # requests fetching endpoints information. Defaults to 60 sec.
157
181
  #
158
182
  # @option options [Boolean] :endpoint_discovery (false)
159
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
183
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
160
184
  #
161
185
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
162
186
  # The log formatter.
@@ -168,15 +192,29 @@ module Aws::SSO
168
192
  # The Logger instance to send log messages to. If this option
169
193
  # is not set, logging will be disabled.
170
194
  #
195
+ # @option options [Integer] :max_attempts (3)
196
+ # An integer representing the maximum number attempts that will be made for
197
+ # a single request, including the initial attempt. For example,
198
+ # setting this value to 5 will result in a request being retried up to
199
+ # 4 times. Used in `standard` and `adaptive` retry modes.
200
+ #
171
201
  # @option options [String] :profile ("default")
172
202
  # Used when loading credentials from the shared credentials file
173
203
  # at HOME/.aws/credentials. When not specified, 'default' is used.
174
204
  #
205
+ # @option options [Proc] :retry_backoff
206
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
207
+ # This option is only used in the `legacy` retry mode.
208
+ #
175
209
  # @option options [Float] :retry_base_delay (0.3)
176
- # The base delay in seconds used by the default backoff function.
210
+ # The base delay in seconds used by the default backoff function. This option
211
+ # is only used in the `legacy` retry mode.
177
212
  #
178
213
  # @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.
214
+ # A delay randomiser function used by the default backoff function.
215
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
216
+ # otherwise a Proc that takes and returns a number. This option is only used
217
+ # in the `legacy` retry mode.
180
218
  #
181
219
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
182
220
  #
@@ -184,11 +222,30 @@ module Aws::SSO
184
222
  # The maximum number of times to retry failed requests. Only
185
223
  # ~ 500 level server errors and certain ~ 400 level client errors
186
224
  # are retried. Generally, these are throttling errors, data
187
- # checksum errors, networking errors, timeout errors and auth
188
- # errors from expired credentials.
225
+ # checksum errors, networking errors, timeout errors, auth errors,
226
+ # endpoint discovery, and errors from expired credentials.
227
+ # This option is only used in the `legacy` retry mode.
189
228
  #
190
229
  # @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.
230
+ # The maximum number of seconds to delay between retries (0 for no limit)
231
+ # used by the default backoff function. This option is only used in the
232
+ # `legacy` retry mode.
233
+ #
234
+ # @option options [String] :retry_mode ("legacy")
235
+ # Specifies which retry algorithm to use. Values are:
236
+ #
237
+ # * `legacy` - The pre-existing retry behavior. This is default value if
238
+ # no retry mode is provided.
239
+ #
240
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
241
+ # This includes support for retry quotas, which limit the number of
242
+ # unsuccessful retries a client can make.
243
+ #
244
+ # * `adaptive` - An experimental retry mode that includes all the
245
+ # functionality of `standard` mode along with automatic client side
246
+ # throttling. This is a provisional mode that may change behavior
247
+ # in the future.
248
+ #
192
249
  #
193
250
  # @option options [String] :secret_access_key
194
251
  #
@@ -211,16 +268,15 @@ module Aws::SSO
211
268
  # requests through. Formatted like 'http://proxy.com:123'.
212
269
  #
213
270
  # @option options [Float] :http_open_timeout (15) The number of
214
- # seconds to wait when opening a HTTP session before rasing a
271
+ # seconds to wait when opening a HTTP session before raising a
215
272
  # `Timeout::Error`.
216
273
  #
217
274
  # @option options [Integer] :http_read_timeout (60) The default
218
275
  # number of seconds to wait for response data. This value can
219
- # safely be set
220
- # per-request on the session yeidled by {#session_for}.
276
+ # safely be set per-request on the session.
221
277
  #
222
278
  # @option options [Float] :http_idle_timeout (5) The number of
223
- # seconds a connection is allowed to sit idble before it is
279
+ # seconds a connection is allowed to sit idle before it is
224
280
  # considered stale. Stale connections are closed and removed
225
281
  # from the pool before making a request.
226
282
  #
@@ -229,7 +285,7 @@ module Aws::SSO
229
285
  # request body. This option has no effect unless the request has
230
286
  # "Expect" header set to "100-continue". Defaults to `nil` which
231
287
  # disables this behaviour. This value can safely be set per
232
- # request on the session yeidled by {#session_for}.
288
+ # request on the session.
233
289
  #
234
290
  # @option options [Boolean] :http_wire_trace (false) When `true`,
235
291
  # HTTP debug output will be sent to the `:logger`.
@@ -326,6 +382,8 @@ module Aws::SSO
326
382
  # * {Types::ListAccountRolesResponse#next_token #next_token} => String
327
383
  # * {Types::ListAccountRolesResponse#role_list #role_list} => Array&lt;Types::RoleInfo&gt;
328
384
  #
385
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
386
+ #
329
387
  # @example Request syntax with placeholder values
330
388
  #
331
389
  # resp = client.list_account_roles({
@@ -380,6 +438,8 @@ module Aws::SSO
380
438
  # * {Types::ListAccountsResponse#next_token #next_token} => String
381
439
  # * {Types::ListAccountsResponse#account_list #account_list} => Array&lt;Types::AccountInfo&gt;
382
440
  #
441
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
442
+ #
383
443
  # @example Request syntax with placeholder values
384
444
  #
385
445
  # resp = client.list_accounts({
@@ -446,7 +506,7 @@ module Aws::SSO
446
506
  params: params,
447
507
  config: config)
448
508
  context[:gem_name] = 'aws-sdk-sso'
449
- context[:gem_version] = '1.1.0'
509
+ context[:gem_version] = '1.5.1'
450
510
  Seahorse::Client::Request.new(handlers, context)
451
511
  end
452
512
 
@@ -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
@@ -4,13 +4,13 @@ module Aws
4
4
  class ContentType < Seahorse::Client::Plugin
5
5
 
6
6
  def add_handlers(handlers, config)
7
- handlers.add(Handler, operations: [:get_role_credentials])
7
+ handlers.add(Handler)
8
8
  end
9
9
 
10
10
  class Handler < Seahorse::Client::Handler
11
11
  def call(context)
12
- # SSO GetRoleCredentials operation breaks when given an empty
13
- # content-type header. The SDK adds this blank content-type header
12
+ # Some SSO operations break when given an empty content-type header.
13
+ # The SDK adds this blank content-type header
14
14
  # since Net::HTTP provides a default that can break services.
15
15
  # We're setting one here even though it's not used or necessary.
16
16
  context.http_request.headers['content-type'] = 'application/json'
@@ -6,6 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::SSO
9
+
9
10
  class Resource
10
11
 
11
12
  # @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.0
4
+ version: 1.5.1
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-10 00:00:00.000000000 Z
11
+ date: 2020-06-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.71.0
22
+ version: 3.99.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.71.0
32
+ version: 3.99.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement
@@ -82,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
82
82
  version: '0'
83
83
  requirements: []
84
84
  rubyforge_project:
85
- rubygems_version: 2.5.2.3
85
+ rubygems_version: 2.7.6.2
86
86
  signing_key:
87
87
  specification_version: 4
88
88
  summary: AWS SDK for Ruby - SSO