aws-sdk-workspaces 1.33.0 → 1.38.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: deba2a9240b1e1ddcabf0525f93e936d7ecd5b39
4
- data.tar.gz: e9a0632df0de5da5173eab509cc798fd01ac37b4
2
+ SHA256:
3
+ metadata.gz: 130544bb2132bad10bd02bd5d615a229e69734567b9e634fe3c4fc0139797693
4
+ data.tar.gz: f2cf355ad0c70cbb87377dcc067399e11ffe0422c37c74fa3eb98cb430e51918
5
5
  SHA512:
6
- metadata.gz: 6e89afb264a545d5c73056a39216b1ee571e5906e52db07621fe8daa97d736bb8e9356966550d06d53deca579fb7a58d7cb78017e611abe8b8bb0c4ea7f40d81
7
- data.tar.gz: 8f57bffafcf0f422682d7193e2516376b1caf02948f71a3490f16c33d3903f940d4042f04b0fbc1fdb96c495d5f830b375d176ab9fdc6fcbbb20f595c4359b9a
6
+ metadata.gz: f6048b8c08da40f8e2ddb67820ea51d34121251f93026c748c4766e1f93be0aa2f26d8e0130373b44b3a653039fd87a31cf90f5e4aa0b9d989ecf56650769151
7
+ data.tar.gz: 4446ef2bb89d2fe69c064bbed8329d2d045575e3e829bae41d3e45772d5083f76e92980b52448ac61702ff165d19517d19390072a535de78898e4fb357bab39d
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-workspaces/customizations'
24
24
  # methods each accept a hash of request parameters and return a response
25
25
  # structure.
26
26
  #
27
+ # work_spaces = Aws::WorkSpaces::Client.new
28
+ # resp = work_spaces.associate_ip_groups(params)
29
+ #
27
30
  # See {Client} for more information.
28
31
  #
29
32
  # # Errors
30
33
  #
31
- # Errors returned from Amazon WorkSpaces all
32
- # extend {Errors::ServiceError}.
34
+ # Errors returned from Amazon WorkSpaces 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::WorkSpaces::Errors::ServiceError
37
- # # rescues all service API errors
40
+ # # rescues all Amazon WorkSpaces API errors
38
41
  # end
39
42
  #
40
43
  # See {Errors} for more information.
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-workspaces/customizations'
42
45
  # @service
43
46
  module Aws::WorkSpaces
44
47
 
45
- GEM_VERSION = '1.33.0'
48
+ GEM_VERSION = '1.38.1'
46
49
 
47
50
  end
@@ -24,12 +24,25 @@ 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/json_rpc.rb'
29
30
 
30
31
  Aws::Plugins::GlobalConfiguration.add_identifier(:workspaces)
31
32
 
32
33
  module Aws::WorkSpaces
34
+ # An API client for WorkSpaces. To construct a client, you need to configure a `:region` and `:credentials`.
35
+ #
36
+ # client = Aws::WorkSpaces::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.
33
46
  class Client < Seahorse::Client::Base
34
47
 
35
48
  include Aws::ClientStubs
@@ -57,6 +70,7 @@ module Aws::WorkSpaces
57
70
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
58
71
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
59
72
  add_plugin(Aws::Plugins::TransferEncoding)
73
+ add_plugin(Aws::Plugins::HttpChecksum)
60
74
  add_plugin(Aws::Plugins::SignatureV4)
61
75
  add_plugin(Aws::Plugins::Protocols::JsonRpc)
62
76
 
@@ -93,7 +107,7 @@ module Aws::WorkSpaces
93
107
  # @option options [required, String] :region
94
108
  # The AWS region to connect to. The configured `:region` is
95
109
  # used to determine the service `:endpoint`. When not passed,
96
- # a default `:region` is search for in the following locations:
110
+ # a default `:region` is searched for in the following locations:
97
111
  #
98
112
  # * `Aws.config[:region]`
99
113
  # * `ENV['AWS_REGION']`
@@ -108,6 +122,12 @@ module Aws::WorkSpaces
108
122
  # When set to `true`, a thread polling for endpoints will be running in
109
123
  # the background every 60 secs (default). Defaults to `false`.
110
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
+ #
111
131
  # @option options [Boolean] :client_side_monitoring (false)
112
132
  # When `true`, client-side metrics will be collected for all API requests from
113
133
  # this client.
@@ -132,6 +152,10 @@ module Aws::WorkSpaces
132
152
  # When `true`, an attempt is made to coerce request parameters into
133
153
  # the required types.
134
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
+ #
135
159
  # @option options [Boolean] :disable_host_prefix_injection (false)
136
160
  # Set to true to disable SDK automatically adding host prefix
137
161
  # to default service endpoint when available.
@@ -139,7 +163,7 @@ module Aws::WorkSpaces
139
163
  # @option options [String] :endpoint
140
164
  # The client endpoint is normally constructed from the `:region`
141
165
  # option. You should only configure an `:endpoint` when connecting
142
- # to test endpoints. This should be avalid HTTP(S) URI.
166
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
143
167
  #
144
168
  # @option options [Integer] :endpoint_cache_max_entries (1000)
145
169
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -154,7 +178,7 @@ module Aws::WorkSpaces
154
178
  # requests fetching endpoints information. Defaults to 60 sec.
155
179
  #
156
180
  # @option options [Boolean] :endpoint_discovery (false)
157
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
181
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
158
182
  #
159
183
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
160
184
  # The log formatter.
@@ -166,15 +190,29 @@ module Aws::WorkSpaces
166
190
  # The Logger instance to send log messages to. If this option
167
191
  # is not set, logging will be disabled.
168
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
+ #
169
199
  # @option options [String] :profile ("default")
170
200
  # Used when loading credentials from the shared credentials file
171
201
  # at HOME/.aws/credentials. When not specified, 'default' is used.
172
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
+ #
173
207
  # @option options [Float] :retry_base_delay (0.3)
174
- # 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.
175
210
  #
176
211
  # @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.
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.
178
216
  #
179
217
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
180
218
  #
@@ -182,11 +220,30 @@ module Aws::WorkSpaces
182
220
  # The maximum number of times to retry failed requests. Only
183
221
  # ~ 500 level server errors and certain ~ 400 level client errors
184
222
  # are retried. Generally, these are throttling errors, data
185
- # checksum errors, networking errors, timeout errors and auth
186
- # 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.
187
226
  #
188
227
  # @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.
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
+ #
235
+ # * `legacy` - The pre-existing retry behavior. This is default value if
236
+ # no retry mode is provided.
237
+ #
238
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
239
+ # This includes support for retry quotas, which limit the number of
240
+ # unsuccessful retries a client can make.
241
+ #
242
+ # * `adaptive` - An experimental retry mode that includes all the
243
+ # functionality of `standard` mode along with automatic client side
244
+ # throttling. This is a provisional mode that may change behavior
245
+ # in the future.
246
+ #
190
247
  #
191
248
  # @option options [String] :secret_access_key
192
249
  #
@@ -219,16 +276,15 @@ module Aws::WorkSpaces
219
276
  # requests through. Formatted like 'http://proxy.com:123'.
220
277
  #
221
278
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
279
+ # seconds to wait when opening a HTTP session before raising a
223
280
  # `Timeout::Error`.
224
281
  #
225
282
  # @option options [Integer] :http_read_timeout (60) The default
226
283
  # number of seconds to wait for response data. This value can
227
- # safely be set
228
- # per-request on the session yeidled by {#session_for}.
284
+ # safely be set per-request on the session.
229
285
  #
230
286
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
287
+ # seconds a connection is allowed to sit idle before it is
232
288
  # considered stale. Stale connections are closed and removed
233
289
  # from the pool before making a request.
234
290
  #
@@ -237,7 +293,7 @@ module Aws::WorkSpaces
237
293
  # request body. This option has no effect unless the request has
238
294
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
295
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
296
+ # request on the session.
241
297
  #
242
298
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
299
  # HTTP debug output will be sent to the `:logger`.
@@ -864,6 +920,8 @@ module Aws::WorkSpaces
864
920
  # * {Types::DescribeWorkspaceBundlesResult#bundles #bundles} => Array&lt;Types::WorkspaceBundle&gt;
865
921
  # * {Types::DescribeWorkspaceBundlesResult#next_token #next_token} => String
866
922
  #
923
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
924
+ #
867
925
  # @example Request syntax with placeholder values
868
926
  #
869
927
  # resp = client.describe_workspace_bundles({
@@ -914,6 +972,8 @@ module Aws::WorkSpaces
914
972
  # * {Types::DescribeWorkspaceDirectoriesResult#directories #directories} => Array&lt;Types::WorkspaceDirectory&gt;
915
973
  # * {Types::DescribeWorkspaceDirectoriesResult#next_token #next_token} => String
916
974
  #
975
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
976
+ #
917
977
  # @example Request syntax with placeholder values
918
978
  #
919
979
  # resp = client.describe_workspace_directories({
@@ -1090,6 +1150,8 @@ module Aws::WorkSpaces
1090
1150
  # * {Types::DescribeWorkspacesResult#workspaces #workspaces} => Array&lt;Types::Workspace&gt;
1091
1151
  # * {Types::DescribeWorkspacesResult#next_token #next_token} => String
1092
1152
  #
1153
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1154
+ #
1093
1155
  # @example Request syntax with placeholder values
1094
1156
  #
1095
1157
  # resp = client.describe_workspaces({
@@ -1633,7 +1695,7 @@ module Aws::WorkSpaces
1633
1695
  # Rebuilds the specified WorkSpace.
1634
1696
  #
1635
1697
  # You cannot rebuild a WorkSpace unless its state is `AVAILABLE`,
1636
- # `ERROR`, or `UNHEALTHY`.
1698
+ # `ERROR`, `UNHEALTHY`, or `STOPPED`.
1637
1699
  #
1638
1700
  # Rebuilding a WorkSpace is a potentially destructive action that can
1639
1701
  # result in the loss of data. For more information, see [Rebuild a
@@ -1760,7 +1822,7 @@ module Aws::WorkSpaces
1760
1822
  # Restores the specified WorkSpace to its last known healthy state.
1761
1823
  #
1762
1824
  # You cannot restore a WorkSpace unless its state is ` AVAILABLE`,
1763
- # `ERROR`, or `UNHEALTHY`.
1825
+ # `ERROR`, `UNHEALTHY`, or `STOPPED`.
1764
1826
  #
1765
1827
  # Restoring a WorkSpace is a potentially destructive action that can
1766
1828
  # result in the loss of data. For more information, see [Restore a
@@ -1984,7 +2046,7 @@ module Aws::WorkSpaces
1984
2046
  params: params,
1985
2047
  config: config)
1986
2048
  context[:gem_name] = 'aws-sdk-workspaces'
1987
- context[:gem_version] = '1.33.0'
2049
+ context[:gem_version] = '1.38.1'
1988
2050
  Seahorse::Client::Request.new(handlers, context)
1989
2051
  end
1990
2052
 
@@ -6,6 +6,42 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::WorkSpaces
9
+
10
+ # When WorkSpaces returns an error response, the Ruby SDK constructs and raises an error.
11
+ # These errors all extend Aws::WorkSpaces::Errors::ServiceError < {Aws::Errors::ServiceError}
12
+ #
13
+ # You can rescue all WorkSpaces errors using ServiceError:
14
+ #
15
+ # begin
16
+ # # do stuff
17
+ # rescue Aws::WorkSpaces::Errors::ServiceError
18
+ # # rescues all WorkSpaces 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
+ # * {InvalidParameterValuesException}
30
+ # * {InvalidResourceStateException}
31
+ # * {OperationInProgressException}
32
+ # * {OperationNotSupportedException}
33
+ # * {ResourceAlreadyExistsException}
34
+ # * {ResourceAssociatedException}
35
+ # * {ResourceCreationFailedException}
36
+ # * {ResourceLimitExceededException}
37
+ # * {ResourceNotFoundException}
38
+ # * {ResourceUnavailableException}
39
+ # * {UnsupportedNetworkConfigurationException}
40
+ # * {UnsupportedWorkspaceConfigurationException}
41
+ # * {WorkspacesDefaultRoleNotFoundException}
42
+ #
43
+ # Additionally, error classes are dynamically generated for service errors based on the error code
44
+ # if they are not defined above.
9
45
  module Errors
10
46
 
11
47
  extend Aws::Errors::DynamicErrors
@@ -23,7 +59,6 @@ module Aws::WorkSpaces
23
59
  def message
24
60
  @message || @data[:message]
25
61
  end
26
-
27
62
  end
28
63
 
29
64
  class InvalidParameterValuesException < ServiceError
@@ -39,7 +74,6 @@ module Aws::WorkSpaces
39
74
  def message
40
75
  @message || @data[:message]
41
76
  end
42
-
43
77
  end
44
78
 
45
79
  class InvalidResourceStateException < ServiceError
@@ -55,7 +89,6 @@ module Aws::WorkSpaces
55
89
  def message
56
90
  @message || @data[:message]
57
91
  end
58
-
59
92
  end
60
93
 
61
94
  class OperationInProgressException < ServiceError
@@ -71,7 +104,6 @@ module Aws::WorkSpaces
71
104
  def message
72
105
  @message || @data[:message]
73
106
  end
74
-
75
107
  end
76
108
 
77
109
  class OperationNotSupportedException < ServiceError
@@ -87,7 +119,6 @@ module Aws::WorkSpaces
87
119
  def message
88
120
  @message || @data[:message]
89
121
  end
90
-
91
122
  end
92
123
 
93
124
  class ResourceAlreadyExistsException < ServiceError
@@ -103,7 +134,6 @@ module Aws::WorkSpaces
103
134
  def message
104
135
  @message || @data[:message]
105
136
  end
106
-
107
137
  end
108
138
 
109
139
  class ResourceAssociatedException < ServiceError
@@ -119,7 +149,6 @@ module Aws::WorkSpaces
119
149
  def message
120
150
  @message || @data[:message]
121
151
  end
122
-
123
152
  end
124
153
 
125
154
  class ResourceCreationFailedException < ServiceError
@@ -135,7 +164,6 @@ module Aws::WorkSpaces
135
164
  def message
136
165
  @message || @data[:message]
137
166
  end
138
-
139
167
  end
140
168
 
141
169
  class ResourceLimitExceededException < ServiceError
@@ -151,7 +179,6 @@ module Aws::WorkSpaces
151
179
  def message
152
180
  @message || @data[:message]
153
181
  end
154
-
155
182
  end
156
183
 
157
184
  class ResourceNotFoundException < ServiceError
@@ -172,7 +199,6 @@ module Aws::WorkSpaces
172
199
  def resource_id
173
200
  @data[:resource_id]
174
201
  end
175
-
176
202
  end
177
203
 
178
204
  class ResourceUnavailableException < ServiceError
@@ -193,7 +219,6 @@ module Aws::WorkSpaces
193
219
  def resource_id
194
220
  @data[:resource_id]
195
221
  end
196
-
197
222
  end
198
223
 
199
224
  class UnsupportedNetworkConfigurationException < ServiceError
@@ -209,7 +234,6 @@ module Aws::WorkSpaces
209
234
  def message
210
235
  @message || @data[:message]
211
236
  end
212
-
213
237
  end
214
238
 
215
239
  class UnsupportedWorkspaceConfigurationException < ServiceError
@@ -225,7 +249,6 @@ module Aws::WorkSpaces
225
249
  def message
226
250
  @message || @data[:message]
227
251
  end
228
-
229
252
  end
230
253
 
231
254
  class WorkspacesDefaultRoleNotFoundException < ServiceError
@@ -241,7 +264,6 @@ module Aws::WorkSpaces
241
264
  def message
242
265
  @message || @data[:message]
243
266
  end
244
-
245
267
  end
246
268
 
247
269
  end
@@ -6,6 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::WorkSpaces
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-workspaces
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.33.0
4
+ version: 1.38.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
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
81
81
  version: '0'
82
82
  requirements: []
83
83
  rubyforge_project:
84
- rubygems_version: 2.5.2.3
84
+ rubygems_version: 2.7.6.2
85
85
  signing_key:
86
86
  specification_version: 4
87
87
  summary: AWS SDK for Ruby - Amazon WorkSpaces