aws-sdk-workspaces 1.32.0 → 1.37.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 +5 -5
- data/lib/aws-sdk-workspaces.rb +7 -4
- data/lib/aws-sdk-workspaces/client.rb +130 -18
- data/lib/aws-sdk-workspaces/client_api.rb +24 -0
- data/lib/aws-sdk-workspaces/errors.rb +36 -14
- data/lib/aws-sdk-workspaces/resource.rb +1 -0
- data/lib/aws-sdk-workspaces/types.rb +53 -4
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 51c1c350d6c32da55e65c1aa418b7904896d9c334a06866de3ac32b83fa0aa5e
|
4
|
+
data.tar.gz: d29ff4d3dee783d9402d169f46f28b103e12584a764f344d5e2c2486d23daf12
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b49b73d72f43729f4ec1dbbeef28c176f872d6d19d0878cc6f5fe039a0a6a3ec8318c0ce51601099fee99610ee05b9c435d0320f8c0b4a609ce791ec03325468
|
7
|
+
data.tar.gz: 64cf0e0a372dcc9c3a8ac5a1bf673deb5158ed2dd25ef9156723f298b1e96b8ec1cc01c5379d8c6ec98557970191237faf778b2052b05f48184e75eb14fbc781
|
data/lib/aws-sdk-workspaces.rb
CHANGED
@@ -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
|
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
|
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.
|
48
|
+
GEM_VERSION = '1.37.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(:workspaces)
|
31
31
|
|
32
32
|
module Aws::WorkSpaces
|
33
|
+
# An API client for WorkSpaces. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
|
+
#
|
35
|
+
# client = Aws::WorkSpaces::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
|
@@ -93,7 +105,7 @@ module Aws::WorkSpaces
|
|
93
105
|
# @option options [required, String] :region
|
94
106
|
# The AWS region to connect to. The configured `:region` is
|
95
107
|
# used to determine the service `:endpoint`. When not passed,
|
96
|
-
# a default `:region` is
|
108
|
+
# a default `:region` is searched for in the following locations:
|
97
109
|
#
|
98
110
|
# * `Aws.config[:region]`
|
99
111
|
# * `ENV['AWS_REGION']`
|
@@ -108,6 +120,12 @@ module Aws::WorkSpaces
|
|
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::WorkSpaces
|
|
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.
|
@@ -139,7 +161,7 @@ module Aws::WorkSpaces
|
|
139
161
|
# @option options [String] :endpoint
|
140
162
|
# The client endpoint is normally constructed from the `:region`
|
141
163
|
# option. You should only configure an `:endpoint` when connecting
|
142
|
-
# to test endpoints. This should be
|
164
|
+
# to test endpoints. This should be a valid HTTP(S) URI.
|
143
165
|
#
|
144
166
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
145
167
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -154,7 +176,7 @@ module Aws::WorkSpaces
|
|
154
176
|
# requests fetching endpoints information. Defaults to 60 sec.
|
155
177
|
#
|
156
178
|
# @option options [Boolean] :endpoint_discovery (false)
|
157
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
179
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
158
180
|
#
|
159
181
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
160
182
|
# The log formatter.
|
@@ -166,15 +188,29 @@ module Aws::WorkSpaces
|
|
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.
|
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,30 @@ module Aws::WorkSpaces
|
|
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
|
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)
|
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
|
+
#
|
233
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
234
|
+
# no retry mode is provided.
|
235
|
+
#
|
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
|
+
#
|
240
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
241
|
+
# functionality of `standard` mode along with automatic client side
|
242
|
+
# throttling. This is a provisional mode that may change behavior
|
243
|
+
# in the future.
|
244
|
+
#
|
190
245
|
#
|
191
246
|
# @option options [String] :secret_access_key
|
192
247
|
#
|
@@ -219,16 +274,15 @@ module Aws::WorkSpaces
|
|
219
274
|
# requests through. Formatted like 'http://proxy.com:123'.
|
220
275
|
#
|
221
276
|
# @option options [Float] :http_open_timeout (15) The number of
|
222
|
-
# seconds to wait when opening a HTTP session before
|
277
|
+
# seconds to wait when opening a HTTP session before raising a
|
223
278
|
# `Timeout::Error`.
|
224
279
|
#
|
225
280
|
# @option options [Integer] :http_read_timeout (60) The default
|
226
281
|
# 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}.
|
282
|
+
# safely be set per-request on the session.
|
229
283
|
#
|
230
284
|
# @option options [Float] :http_idle_timeout (5) The number of
|
231
|
-
# seconds a connection is allowed to sit
|
285
|
+
# seconds a connection is allowed to sit idle before it is
|
232
286
|
# considered stale. Stale connections are closed and removed
|
233
287
|
# from the pool before making a request.
|
234
288
|
#
|
@@ -237,7 +291,7 @@ module Aws::WorkSpaces
|
|
237
291
|
# request body. This option has no effect unless the request has
|
238
292
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
239
293
|
# disables this behaviour. This value can safely be set per
|
240
|
-
# request on the session
|
294
|
+
# request on the session.
|
241
295
|
#
|
242
296
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
243
297
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -447,7 +501,9 @@ module Aws::WorkSpaces
|
|
447
501
|
# and IP access control groups.
|
448
502
|
#
|
449
503
|
# @option params [required, Array<Types::Tag>] :tags
|
450
|
-
# The tags. Each WorkSpaces resource can have a maximum of 50 tags.
|
504
|
+
# The tags. Each WorkSpaces resource can have a maximum of 50 tags. If
|
505
|
+
# you want to add new tags to a set of existing tags, you must submit
|
506
|
+
# all of the existing tags along with the new ones.
|
451
507
|
#
|
452
508
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
453
509
|
#
|
@@ -862,6 +918,8 @@ module Aws::WorkSpaces
|
|
862
918
|
# * {Types::DescribeWorkspaceBundlesResult#bundles #bundles} => Array<Types::WorkspaceBundle>
|
863
919
|
# * {Types::DescribeWorkspaceBundlesResult#next_token #next_token} => String
|
864
920
|
#
|
921
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
922
|
+
#
|
865
923
|
# @example Request syntax with placeholder values
|
866
924
|
#
|
867
925
|
# resp = client.describe_workspace_bundles({
|
@@ -912,6 +970,8 @@ module Aws::WorkSpaces
|
|
912
970
|
# * {Types::DescribeWorkspaceDirectoriesResult#directories #directories} => Array<Types::WorkspaceDirectory>
|
913
971
|
# * {Types::DescribeWorkspaceDirectoriesResult#next_token #next_token} => String
|
914
972
|
#
|
973
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
974
|
+
#
|
915
975
|
# @example Request syntax with placeholder values
|
916
976
|
#
|
917
977
|
# resp = client.describe_workspace_directories({
|
@@ -1088,6 +1148,8 @@ module Aws::WorkSpaces
|
|
1088
1148
|
# * {Types::DescribeWorkspacesResult#workspaces #workspaces} => Array<Types::Workspace>
|
1089
1149
|
# * {Types::DescribeWorkspacesResult#next_token #next_token} => String
|
1090
1150
|
#
|
1151
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1152
|
+
#
|
1091
1153
|
# @example Request syntax with placeholder values
|
1092
1154
|
#
|
1093
1155
|
# resp = client.describe_workspaces({
|
@@ -1302,6 +1364,56 @@ module Aws::WorkSpaces
|
|
1302
1364
|
req.send_request(options)
|
1303
1365
|
end
|
1304
1366
|
|
1367
|
+
# Migrates a WorkSpace from one operating system or bundle type to
|
1368
|
+
# another, while retaining the data on the user volume.
|
1369
|
+
#
|
1370
|
+
# The migration process recreates the WorkSpace by using a new root
|
1371
|
+
# volume from the target bundle image and the user volume from the last
|
1372
|
+
# available snapshot of the original WorkSpace. During migration, the
|
1373
|
+
# original `D:\Users\%USERNAME%` user profile folder is renamed to
|
1374
|
+
# `D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated`. A new
|
1375
|
+
# `D:\Users\%USERNAME%` folder is generated by the new OS. Certain
|
1376
|
+
# files in the old user profile are moved to the new user profile.
|
1377
|
+
#
|
1378
|
+
# For available migration scenarios, details about what happens during
|
1379
|
+
# migration, and best practices, see [Migrate a WorkSpace][1].
|
1380
|
+
#
|
1381
|
+
#
|
1382
|
+
#
|
1383
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/migrate-workspaces.html
|
1384
|
+
#
|
1385
|
+
# @option params [required, String] :source_workspace_id
|
1386
|
+
# The identifier of the WorkSpace to migrate from.
|
1387
|
+
#
|
1388
|
+
# @option params [required, String] :bundle_id
|
1389
|
+
# The identifier of the target bundle type to migrate the WorkSpace to.
|
1390
|
+
#
|
1391
|
+
# @return [Types::MigrateWorkspaceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1392
|
+
#
|
1393
|
+
# * {Types::MigrateWorkspaceResult#source_workspace_id #source_workspace_id} => String
|
1394
|
+
# * {Types::MigrateWorkspaceResult#target_workspace_id #target_workspace_id} => String
|
1395
|
+
#
|
1396
|
+
# @example Request syntax with placeholder values
|
1397
|
+
#
|
1398
|
+
# resp = client.migrate_workspace({
|
1399
|
+
# source_workspace_id: "WorkspaceId", # required
|
1400
|
+
# bundle_id: "BundleId", # required
|
1401
|
+
# })
|
1402
|
+
#
|
1403
|
+
# @example Response structure
|
1404
|
+
#
|
1405
|
+
# resp.source_workspace_id #=> String
|
1406
|
+
# resp.target_workspace_id #=> String
|
1407
|
+
#
|
1408
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/MigrateWorkspace AWS API Documentation
|
1409
|
+
#
|
1410
|
+
# @overload migrate_workspace(params = {})
|
1411
|
+
# @param [Hash] params ({})
|
1412
|
+
def migrate_workspace(params = {}, options = {})
|
1413
|
+
req = build_request(:migrate_workspace, params)
|
1414
|
+
req.send_request(options)
|
1415
|
+
end
|
1416
|
+
|
1305
1417
|
# Modifies the configuration of Bring Your Own License (BYOL) for the
|
1306
1418
|
# specified account.
|
1307
1419
|
#
|
@@ -1401,7 +1513,7 @@ module Aws::WorkSpaces
|
|
1401
1513
|
end
|
1402
1514
|
|
1403
1515
|
# Specifies which devices and operating systems users can use to access
|
1404
|
-
# their
|
1516
|
+
# their WorkSpaces. For more information, see [ Control Device
|
1405
1517
|
# Access][1].
|
1406
1518
|
#
|
1407
1519
|
#
|
@@ -1581,7 +1693,7 @@ module Aws::WorkSpaces
|
|
1581
1693
|
# Rebuilds the specified WorkSpace.
|
1582
1694
|
#
|
1583
1695
|
# You cannot rebuild a WorkSpace unless its state is `AVAILABLE`,
|
1584
|
-
# `ERROR`, or `
|
1696
|
+
# `ERROR`, `UNHEALTHY`, or `STOPPED`.
|
1585
1697
|
#
|
1586
1698
|
# Rebuilding a WorkSpace is a potentially destructive action that can
|
1587
1699
|
# result in the loss of data. For more information, see [Rebuild a
|
@@ -1708,7 +1820,7 @@ module Aws::WorkSpaces
|
|
1708
1820
|
# Restores the specified WorkSpace to its last known healthy state.
|
1709
1821
|
#
|
1710
1822
|
# You cannot restore a WorkSpace unless its state is ` AVAILABLE`,
|
1711
|
-
# `ERROR`, or `
|
1823
|
+
# `ERROR`, `UNHEALTHY`, or `STOPPED`.
|
1712
1824
|
#
|
1713
1825
|
# Restoring a WorkSpace is a potentially destructive action that can
|
1714
1826
|
# result in the loss of data. For more information, see [Restore a
|
@@ -1932,7 +2044,7 @@ module Aws::WorkSpaces
|
|
1932
2044
|
params: params,
|
1933
2045
|
config: config)
|
1934
2046
|
context[:gem_name] = 'aws-sdk-workspaces'
|
1935
|
-
context[:gem_version] = '1.
|
2047
|
+
context[:gem_version] = '1.37.0'
|
1936
2048
|
Seahorse::Client::Request.new(handlers, context)
|
1937
2049
|
end
|
1938
2050
|
|
@@ -116,6 +116,8 @@ module Aws::WorkSpaces
|
|
116
116
|
ListAvailableManagementCidrRangesResult = Shapes::StructureShape.new(name: 'ListAvailableManagementCidrRangesResult')
|
117
117
|
ManagementCidrRangeConstraint = Shapes::StringShape.new(name: 'ManagementCidrRangeConstraint')
|
118
118
|
ManagementCidrRangeMaxResults = Shapes::IntegerShape.new(name: 'ManagementCidrRangeMaxResults')
|
119
|
+
MigrateWorkspaceRequest = Shapes::StructureShape.new(name: 'MigrateWorkspaceRequest')
|
120
|
+
MigrateWorkspaceResult = Shapes::StructureShape.new(name: 'MigrateWorkspaceResult')
|
119
121
|
ModificationResourceEnum = Shapes::StringShape.new(name: 'ModificationResourceEnum')
|
120
122
|
ModificationState = Shapes::StructureShape.new(name: 'ModificationState')
|
121
123
|
ModificationStateEnum = Shapes::StringShape.new(name: 'ModificationStateEnum')
|
@@ -494,6 +496,14 @@ module Aws::WorkSpaces
|
|
494
496
|
ListAvailableManagementCidrRangesResult.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "NextToken"))
|
495
497
|
ListAvailableManagementCidrRangesResult.struct_class = Types::ListAvailableManagementCidrRangesResult
|
496
498
|
|
499
|
+
MigrateWorkspaceRequest.add_member(:source_workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location_name: "SourceWorkspaceId"))
|
500
|
+
MigrateWorkspaceRequest.add_member(:bundle_id, Shapes::ShapeRef.new(shape: BundleId, required: true, location_name: "BundleId"))
|
501
|
+
MigrateWorkspaceRequest.struct_class = Types::MigrateWorkspaceRequest
|
502
|
+
|
503
|
+
MigrateWorkspaceResult.add_member(:source_workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, location_name: "SourceWorkspaceId"))
|
504
|
+
MigrateWorkspaceResult.add_member(:target_workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, location_name: "TargetWorkspaceId"))
|
505
|
+
MigrateWorkspaceResult.struct_class = Types::MigrateWorkspaceResult
|
506
|
+
|
497
507
|
ModificationState.add_member(:resource, Shapes::ShapeRef.new(shape: ModificationResourceEnum, location_name: "Resource"))
|
498
508
|
ModificationState.add_member(:state, Shapes::ShapeRef.new(shape: ModificationStateEnum, location_name: "State"))
|
499
509
|
ModificationState.struct_class = Types::ModificationState
|
@@ -1104,6 +1114,20 @@ module Aws::WorkSpaces
|
|
1104
1114
|
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1105
1115
|
end)
|
1106
1116
|
|
1117
|
+
api.add_operation(:migrate_workspace, Seahorse::Model::Operation.new.tap do |o|
|
1118
|
+
o.name = "MigrateWorkspace"
|
1119
|
+
o.http_method = "POST"
|
1120
|
+
o.http_request_uri = "/"
|
1121
|
+
o.input = Shapes::ShapeRef.new(shape: MigrateWorkspaceRequest)
|
1122
|
+
o.output = Shapes::ShapeRef.new(shape: MigrateWorkspaceResult)
|
1123
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterValuesException)
|
1124
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1125
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1126
|
+
o.errors << Shapes::ShapeRef.new(shape: OperationNotSupportedException)
|
1127
|
+
o.errors << Shapes::ShapeRef.new(shape: OperationInProgressException)
|
1128
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceUnavailableException)
|
1129
|
+
end)
|
1130
|
+
|
1107
1131
|
api.add_operation(:modify_account, Seahorse::Model::Operation.new.tap do |o|
|
1108
1132
|
o.name = "ModifyAccount"
|
1109
1133
|
o.http_method = "POST"
|
@@ -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
|
@@ -312,7 +312,9 @@ module Aws::WorkSpaces
|
|
312
312
|
# @return [String]
|
313
313
|
#
|
314
314
|
# @!attribute [rw] tags
|
315
|
-
# The tags. Each WorkSpaces resource can have a maximum of 50 tags.
|
315
|
+
# The tags. Each WorkSpaces resource can have a maximum of 50 tags. If
|
316
|
+
# you want to add new tags to a set of existing tags, you must submit
|
317
|
+
# all of the existing tags along with the new ones.
|
316
318
|
# @return [Array<Types::Tag>]
|
317
319
|
#
|
318
320
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateTagsRequest AWS API Documentation
|
@@ -1275,6 +1277,49 @@ module Aws::WorkSpaces
|
|
1275
1277
|
include Aws::Structure
|
1276
1278
|
end
|
1277
1279
|
|
1280
|
+
# @note When making an API call, you may pass MigrateWorkspaceRequest
|
1281
|
+
# data as a hash:
|
1282
|
+
#
|
1283
|
+
# {
|
1284
|
+
# source_workspace_id: "WorkspaceId", # required
|
1285
|
+
# bundle_id: "BundleId", # required
|
1286
|
+
# }
|
1287
|
+
#
|
1288
|
+
# @!attribute [rw] source_workspace_id
|
1289
|
+
# The identifier of the WorkSpace to migrate from.
|
1290
|
+
# @return [String]
|
1291
|
+
#
|
1292
|
+
# @!attribute [rw] bundle_id
|
1293
|
+
# The identifier of the target bundle type to migrate the WorkSpace
|
1294
|
+
# to.
|
1295
|
+
# @return [String]
|
1296
|
+
#
|
1297
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/MigrateWorkspaceRequest AWS API Documentation
|
1298
|
+
#
|
1299
|
+
class MigrateWorkspaceRequest < Struct.new(
|
1300
|
+
:source_workspace_id,
|
1301
|
+
:bundle_id)
|
1302
|
+
include Aws::Structure
|
1303
|
+
end
|
1304
|
+
|
1305
|
+
# @!attribute [rw] source_workspace_id
|
1306
|
+
# The original identifier of the WorkSpace that is being migrated.
|
1307
|
+
# @return [String]
|
1308
|
+
#
|
1309
|
+
# @!attribute [rw] target_workspace_id
|
1310
|
+
# The new identifier of the WorkSpace that is being migrated. If the
|
1311
|
+
# migration does not succeed, the target WorkSpace ID will not be
|
1312
|
+
# used, and the WorkSpace will still have the original WorkSpace ID.
|
1313
|
+
# @return [String]
|
1314
|
+
#
|
1315
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/MigrateWorkspaceResult AWS API Documentation
|
1316
|
+
#
|
1317
|
+
class MigrateWorkspaceResult < Struct.new(
|
1318
|
+
:source_workspace_id,
|
1319
|
+
:target_workspace_id)
|
1320
|
+
include Aws::Structure
|
1321
|
+
end
|
1322
|
+
|
1278
1323
|
# Describes a WorkSpace modification.
|
1279
1324
|
#
|
1280
1325
|
# @!attribute [rw] resource
|
@@ -2275,7 +2320,9 @@ module Aws::WorkSpaces
|
|
2275
2320
|
# @return [String]
|
2276
2321
|
#
|
2277
2322
|
# @!attribute [rw] volume_encryption_key
|
2278
|
-
# The KMS key used to encrypt data
|
2323
|
+
# The symmetric AWS KMS customer master key (CMK) used to encrypt data
|
2324
|
+
# stored on your WorkSpace. Amazon WorkSpaces does not support
|
2325
|
+
# asymmetric CMKs.
|
2279
2326
|
# @return [String]
|
2280
2327
|
#
|
2281
2328
|
# @!attribute [rw] user_volume_encryption_enabled
|
@@ -2604,7 +2651,7 @@ module Aws::WorkSpaces
|
|
2604
2651
|
#
|
2605
2652
|
# @!attribute [rw] workspace_access_properties
|
2606
2653
|
# The devices and operating systems that users can use to access
|
2607
|
-
#
|
2654
|
+
# WorkSpaces.
|
2608
2655
|
# @return [Types::WorkspaceAccessProperties]
|
2609
2656
|
#
|
2610
2657
|
# @!attribute [rw] tenancy
|
@@ -2798,7 +2845,9 @@ module Aws::WorkSpaces
|
|
2798
2845
|
# @return [String]
|
2799
2846
|
#
|
2800
2847
|
# @!attribute [rw] volume_encryption_key
|
2801
|
-
# The KMS key used to encrypt data
|
2848
|
+
# The symmetric AWS KMS customer master key (CMK) used to encrypt data
|
2849
|
+
# stored on your WorkSpace. Amazon WorkSpaces does not support
|
2850
|
+
# asymmetric CMKs.
|
2802
2851
|
# @return [String]
|
2803
2852
|
#
|
2804
2853
|
# @!attribute [rw] user_volume_encryption_enabled
|
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.
|
4
|
+
version: 1.37.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:
|
11
|
+
date: 2020-05-28 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -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.
|
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
|