aws-sdk-workspaces 1.0.0.rc1 → 1.0.0.rc2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-workspaces.rb +2 -2
- data/lib/aws-sdk-workspaces/client.rb +810 -688
- data/lib/aws-sdk-workspaces/client_api.rb +480 -482
- data/lib/aws-sdk-workspaces/errors.rb +4 -13
- data/lib/aws-sdk-workspaces/resource.rb +12 -14
- data/lib/aws-sdk-workspaces/types.rb +1199 -1010
- metadata +2 -2
@@ -1,23 +1,14 @@
|
|
1
1
|
# WARNING ABOUT GENERATED CODE
|
2
2
|
#
|
3
|
-
# This file is generated. See the contributing for
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
4
|
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
5
|
#
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
7
7
|
|
8
|
-
module Aws
|
9
|
-
module
|
10
|
-
module Errors
|
8
|
+
module Aws::WorkSpaces
|
9
|
+
module Errors
|
11
10
|
|
12
|
-
|
11
|
+
extend Aws::Errors::DynamicErrors
|
13
12
|
|
14
|
-
# Raised when calling #load or #data on a resource class that can not be
|
15
|
-
# loaded. This can happen when:
|
16
|
-
#
|
17
|
-
# * A resource class has identifiers, but no data attributes.
|
18
|
-
# * Resource data is only available when making an API call that
|
19
|
-
# enumerates all resources of that type.
|
20
|
-
class ResourceNotLoadable < RuntimeError; end
|
21
|
-
end
|
22
13
|
end
|
23
14
|
end
|
@@ -1,25 +1,23 @@
|
|
1
1
|
# WARNING ABOUT GENERATED CODE
|
2
2
|
#
|
3
|
-
# This file is generated. See the contributing for
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
4
|
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
5
|
#
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
7
7
|
|
8
|
-
module Aws
|
9
|
-
|
10
|
-
class Resource
|
8
|
+
module Aws::WorkSpaces
|
9
|
+
class Resource
|
11
10
|
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
# @return [Client]
|
19
|
-
def client
|
20
|
-
@client
|
21
|
-
end
|
11
|
+
# @param options ({})
|
12
|
+
# @option options [Client] :client
|
13
|
+
def initialize(options = {})
|
14
|
+
@client = options[:client] || Client.new(options)
|
15
|
+
end
|
22
16
|
|
17
|
+
# @return [Client]
|
18
|
+
def client
|
19
|
+
@client
|
23
20
|
end
|
21
|
+
|
24
22
|
end
|
25
23
|
end
|
@@ -1,1020 +1,1209 @@
|
|
1
1
|
# WARNING ABOUT GENERATED CODE
|
2
2
|
#
|
3
|
-
# This file is generated. See the contributing for
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
4
|
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
5
|
#
|
6
6
|
# WARNING ABOUT GENERATED CODE
|
7
7
|
|
8
|
-
module Aws
|
9
|
-
module
|
10
|
-
module Types
|
11
|
-
|
12
|
-
# Contains information about the compute type of a WorkSpace bundle.
|
13
|
-
# @!attribute [rw] name
|
14
|
-
# The name of the compute type for the bundle.
|
15
|
-
# @return [String]
|
16
|
-
class ComputeType < Struct.new(
|
17
|
-
:name)
|
18
|
-
include Aws::Structure
|
19
|
-
end
|
20
|
-
|
21
|
-
# The request of the CreateTags operation.
|
22
|
-
# @note When making an API call, pass CreateTagsRequest
|
23
|
-
# data as a hash:
|
24
|
-
#
|
25
|
-
# {
|
26
|
-
# resource_id: "NonEmptyString", # required
|
27
|
-
# tags: [ # required
|
28
|
-
# {
|
29
|
-
# key: "TagKey", # required
|
30
|
-
# value: "TagValue",
|
31
|
-
# },
|
32
|
-
# ],
|
33
|
-
# }
|
34
|
-
# @!attribute [rw] resource_id
|
35
|
-
# The resource ID of the request.
|
36
|
-
# @return [String]
|
37
|
-
#
|
38
|
-
# @!attribute [rw] tags
|
39
|
-
# The tags of the request.
|
40
|
-
# @return [Array<Types::Tag>]
|
41
|
-
class CreateTagsRequest < Struct.new(
|
42
|
-
:resource_id,
|
43
|
-
:tags)
|
44
|
-
include Aws::Structure
|
45
|
-
end
|
46
|
-
|
47
|
-
# The result of the CreateTags operation.
|
48
|
-
class CreateTagsResult < Aws::EmptyStructure; end
|
49
|
-
|
50
|
-
# Contains the inputs for the CreateWorkspaces operation.
|
51
|
-
# @note When making an API call, pass CreateWorkspacesRequest
|
52
|
-
# data as a hash:
|
53
|
-
#
|
54
|
-
# {
|
55
|
-
# workspaces: [ # required
|
56
|
-
# {
|
57
|
-
# directory_id: "DirectoryId", # required
|
58
|
-
# user_name: "UserName", # required
|
59
|
-
# bundle_id: "BundleId", # required
|
60
|
-
# volume_encryption_key: "VolumeEncryptionKey",
|
61
|
-
# user_volume_encryption_enabled: false,
|
62
|
-
# root_volume_encryption_enabled: false,
|
63
|
-
# workspace_properties: {
|
64
|
-
# running_mode: "AUTO_STOP", # accepts AUTO_STOP, ALWAYS_ON
|
65
|
-
# running_mode_auto_stop_timeout_in_minutes: 1,
|
66
|
-
# },
|
67
|
-
# tags: [
|
68
|
-
# {
|
69
|
-
# key: "TagKey", # required
|
70
|
-
# value: "TagValue",
|
71
|
-
# },
|
72
|
-
# ],
|
73
|
-
# },
|
74
|
-
# ],
|
75
|
-
# }
|
76
|
-
# @!attribute [rw] workspaces
|
77
|
-
# An array of structures that specify the WorkSpaces to create.
|
78
|
-
# @return [Array<Types::WorkspaceRequest>]
|
79
|
-
class CreateWorkspacesRequest < Struct.new(
|
80
|
-
:workspaces)
|
81
|
-
include Aws::Structure
|
82
|
-
end
|
83
|
-
|
84
|
-
# Contains the result of the CreateWorkspaces operation.
|
85
|
-
# @!attribute [rw] failed_requests
|
86
|
-
# An array of structures that represent the WorkSpaces that could not
|
87
|
-
# be created.
|
88
|
-
# @return [Array<Types::FailedCreateWorkspaceRequest>]
|
89
|
-
#
|
90
|
-
# @!attribute [rw] pending_requests
|
91
|
-
# An array of structures that represent the WorkSpaces that were
|
92
|
-
# created.
|
93
|
-
#
|
94
|
-
# Because this operation is asynchronous, the identifier in
|
95
|
-
# `WorkspaceId` is not immediately available. If you immediately call
|
96
|
-
# DescribeWorkspaces with this identifier, no information will be
|
97
|
-
# returned.
|
98
|
-
# @return [Array<Types::Workspace>]
|
99
|
-
class CreateWorkspacesResult < Struct.new(
|
100
|
-
:failed_requests,
|
101
|
-
:pending_requests)
|
102
|
-
include Aws::Structure
|
103
|
-
end
|
104
|
-
|
105
|
-
# Contains default WorkSpace creation information.
|
106
|
-
# @!attribute [rw] enable_work_docs
|
107
|
-
# Specifies if the directory is enabled for Amazon WorkDocs.
|
108
|
-
# @return [Boolean]
|
109
|
-
#
|
110
|
-
# @!attribute [rw] enable_internet_access
|
111
|
-
# A public IP address will be attached to all WorkSpaces that are
|
112
|
-
# created or rebuilt.
|
113
|
-
# @return [Boolean]
|
114
|
-
#
|
115
|
-
# @!attribute [rw] default_ou
|
116
|
-
# The organizational unit (OU) in the directory that the WorkSpace
|
117
|
-
# machine accounts are placed in.
|
118
|
-
# @return [String]
|
119
|
-
#
|
120
|
-
# @!attribute [rw] custom_security_group_id
|
121
|
-
# The identifier of any custom security groups that are applied to the
|
122
|
-
# WorkSpaces when they are created.
|
123
|
-
# @return [String]
|
124
|
-
#
|
125
|
-
# @!attribute [rw] user_enabled_as_local_administrator
|
126
|
-
# The WorkSpace user is an administrator on the WorkSpace.
|
127
|
-
# @return [Boolean]
|
128
|
-
class DefaultWorkspaceCreationProperties < Struct.new(
|
129
|
-
:enable_work_docs,
|
130
|
-
:enable_internet_access,
|
131
|
-
:default_ou,
|
132
|
-
:custom_security_group_id,
|
133
|
-
:user_enabled_as_local_administrator)
|
134
|
-
include Aws::Structure
|
135
|
-
end
|
136
|
-
|
137
|
-
# The request of the DeleteTags operation.
|
138
|
-
# @note When making an API call, pass DeleteTagsRequest
|
139
|
-
# data as a hash:
|
140
|
-
#
|
141
|
-
# {
|
142
|
-
# resource_id: "NonEmptyString", # required
|
143
|
-
# tag_keys: ["NonEmptyString"], # required
|
144
|
-
# }
|
145
|
-
# @!attribute [rw] resource_id
|
146
|
-
# The resource ID of the request.
|
147
|
-
# @return [String]
|
148
|
-
#
|
149
|
-
# @!attribute [rw] tag_keys
|
150
|
-
# The tag keys of the request.
|
151
|
-
# @return [Array<String>]
|
152
|
-
class DeleteTagsRequest < Struct.new(
|
153
|
-
:resource_id,
|
154
|
-
:tag_keys)
|
155
|
-
include Aws::Structure
|
156
|
-
end
|
157
|
-
|
158
|
-
# The result of the DeleteTags operation.
|
159
|
-
class DeleteTagsResult < Aws::EmptyStructure; end
|
160
|
-
|
161
|
-
# The request of the DescribeTags operation.
|
162
|
-
# @note When making an API call, pass DescribeTagsRequest
|
163
|
-
# data as a hash:
|
164
|
-
#
|
165
|
-
# {
|
166
|
-
# resource_id: "NonEmptyString", # required
|
167
|
-
# }
|
168
|
-
# @!attribute [rw] resource_id
|
169
|
-
# The resource ID of the request.
|
170
|
-
# @return [String]
|
171
|
-
class DescribeTagsRequest < Struct.new(
|
172
|
-
:resource_id)
|
173
|
-
include Aws::Structure
|
174
|
-
end
|
175
|
-
|
176
|
-
# The result of the DescribeTags operation.
|
177
|
-
# @!attribute [rw] tag_list
|
178
|
-
# The list of tags.
|
179
|
-
# @return [Array<Types::Tag>]
|
180
|
-
class DescribeTagsResult < Struct.new(
|
181
|
-
:tag_list)
|
182
|
-
include Aws::Structure
|
183
|
-
end
|
184
|
-
|
185
|
-
# Contains the inputs for the DescribeWorkspaceBundles operation.
|
186
|
-
# @note When making an API call, pass DescribeWorkspaceBundlesRequest
|
187
|
-
# data as a hash:
|
188
|
-
#
|
189
|
-
# {
|
190
|
-
# bundle_ids: ["BundleId"],
|
191
|
-
# owner: "BundleOwner",
|
192
|
-
# next_token: "PaginationToken",
|
193
|
-
# }
|
194
|
-
# @!attribute [rw] bundle_ids
|
195
|
-
# An array of strings that contains the identifiers of the bundles to
|
196
|
-
# retrieve. This parameter cannot be combined with any other filter
|
197
|
-
# parameter.
|
198
|
-
# @return [Array<String>]
|
199
|
-
#
|
200
|
-
# @!attribute [rw] owner
|
201
|
-
# The owner of the bundles to retrieve. This parameter cannot be
|
202
|
-
# combined with any other filter parameter.
|
203
|
-
#
|
204
|
-
# This contains one of the following values:
|
205
|
-
#
|
206
|
-
# * null- Retrieves the bundles that belong to the account making the
|
207
|
-
# call.
|
208
|
-
#
|
209
|
-
# * `AMAZON`- Retrieves the bundles that are provided by AWS.
|
210
|
-
# @return [String]
|
211
|
-
#
|
212
|
-
# @!attribute [rw] next_token
|
213
|
-
# The `NextToken` value from a previous call to this operation. Pass
|
214
|
-
# null if this is the first call.
|
215
|
-
# @return [String]
|
216
|
-
class DescribeWorkspaceBundlesRequest < Struct.new(
|
217
|
-
:bundle_ids,
|
218
|
-
:owner,
|
219
|
-
:next_token)
|
220
|
-
include Aws::Structure
|
221
|
-
end
|
222
|
-
|
223
|
-
# Contains the results of the DescribeWorkspaceBundles operation.
|
224
|
-
# @!attribute [rw] bundles
|
225
|
-
# An array of structures that contain information about the bundles.
|
226
|
-
# @return [Array<Types::WorkspaceBundle>]
|
227
|
-
#
|
228
|
-
# @!attribute [rw] next_token
|
229
|
-
# If not null, more results are available. Pass this value for the
|
230
|
-
# `NextToken` parameter in a subsequent call to this operation to
|
231
|
-
# retrieve the next set of items. This token is valid for one day and
|
232
|
-
# must be used within that time frame.
|
233
|
-
# @return [String]
|
234
|
-
class DescribeWorkspaceBundlesResult < Struct.new(
|
235
|
-
:bundles,
|
236
|
-
:next_token)
|
237
|
-
include Aws::Structure
|
238
|
-
end
|
239
|
-
|
240
|
-
# Contains the inputs for the DescribeWorkspaceDirectories operation.
|
241
|
-
# @note When making an API call, pass DescribeWorkspaceDirectoriesRequest
|
242
|
-
# data as a hash:
|
243
|
-
#
|
244
|
-
# {
|
245
|
-
# directory_ids: ["DirectoryId"],
|
246
|
-
# next_token: "PaginationToken",
|
247
|
-
# }
|
248
|
-
# @!attribute [rw] directory_ids
|
249
|
-
# An array of strings that contains the directory identifiers to
|
250
|
-
# retrieve information for. If this member is null, all directories
|
251
|
-
# are retrieved.
|
252
|
-
# @return [Array<String>]
|
253
|
-
#
|
254
|
-
# @!attribute [rw] next_token
|
255
|
-
# The `NextToken` value from a previous call to this operation. Pass
|
256
|
-
# null if this is the first call.
|
257
|
-
# @return [String]
|
258
|
-
class DescribeWorkspaceDirectoriesRequest < Struct.new(
|
259
|
-
:directory_ids,
|
260
|
-
:next_token)
|
261
|
-
include Aws::Structure
|
262
|
-
end
|
263
|
-
|
264
|
-
# Contains the results of the DescribeWorkspaceDirectories operation.
|
265
|
-
# @!attribute [rw] directories
|
266
|
-
# An array of structures that contain information about the
|
267
|
-
# directories.
|
268
|
-
# @return [Array<Types::WorkspaceDirectory>]
|
269
|
-
#
|
270
|
-
# @!attribute [rw] next_token
|
271
|
-
# If not null, more results are available. Pass this value for the
|
272
|
-
# `NextToken` parameter in a subsequent call to this operation to
|
273
|
-
# retrieve the next set of items. This token is valid for one day and
|
274
|
-
# must be used within that time frame.
|
275
|
-
# @return [String]
|
276
|
-
class DescribeWorkspaceDirectoriesResult < Struct.new(
|
277
|
-
:directories,
|
278
|
-
:next_token)
|
279
|
-
include Aws::Structure
|
280
|
-
end
|
281
|
-
|
282
|
-
# @note When making an API call, pass DescribeWorkspacesConnectionStatusRequest
|
283
|
-
# data as a hash:
|
284
|
-
#
|
285
|
-
# {
|
286
|
-
# workspace_ids: ["WorkspaceId"],
|
287
|
-
# next_token: "PaginationToken",
|
288
|
-
# }
|
289
|
-
# @!attribute [rw] workspace_ids
|
290
|
-
# An array of strings that contain the identifiers of the WorkSpaces.
|
291
|
-
# @return [Array<String>]
|
292
|
-
#
|
293
|
-
# @!attribute [rw] next_token
|
294
|
-
# The next token of the request.
|
295
|
-
# @return [String]
|
296
|
-
class DescribeWorkspacesConnectionStatusRequest < Struct.new(
|
297
|
-
:workspace_ids,
|
298
|
-
:next_token)
|
299
|
-
include Aws::Structure
|
300
|
-
end
|
301
|
-
|
302
|
-
# @!attribute [rw] workspaces_connection_status
|
303
|
-
# The connection status of the WorkSpace.
|
304
|
-
# @return [Array<Types::WorkspaceConnectionStatus>]
|
305
|
-
#
|
306
|
-
# @!attribute [rw] next_token
|
307
|
-
# The next token of the result.
|
308
|
-
# @return [String]
|
309
|
-
class DescribeWorkspacesConnectionStatusResult < Struct.new(
|
310
|
-
:workspaces_connection_status,
|
311
|
-
:next_token)
|
312
|
-
include Aws::Structure
|
313
|
-
end
|
314
|
-
|
315
|
-
# Contains the inputs for the DescribeWorkspaces operation.
|
316
|
-
# @note When making an API call, pass DescribeWorkspacesRequest
|
317
|
-
# data as a hash:
|
318
|
-
#
|
319
|
-
# {
|
320
|
-
# workspace_ids: ["WorkspaceId"],
|
321
|
-
# directory_id: "DirectoryId",
|
322
|
-
# user_name: "UserName",
|
323
|
-
# bundle_id: "BundleId",
|
324
|
-
# limit: 1,
|
325
|
-
# next_token: "PaginationToken",
|
326
|
-
# }
|
327
|
-
# @!attribute [rw] workspace_ids
|
328
|
-
# An array of strings that contain the identifiers of the WorkSpaces
|
329
|
-
# for which to retrieve information. This parameter cannot be combined
|
330
|
-
# with any other filter parameter.
|
331
|
-
#
|
332
|
-
# Because the CreateWorkspaces operation is asynchronous, the
|
333
|
-
# identifier it returns is not immediately available. If you
|
334
|
-
# immediately call DescribeWorkspaces with this identifier, no
|
335
|
-
# information is returned.
|
336
|
-
# @return [Array<String>]
|
337
|
-
#
|
338
|
-
# @!attribute [rw] directory_id
|
339
|
-
# Specifies the directory identifier to which to limit the WorkSpaces.
|
340
|
-
# Optionally, you can specify a specific directory user with the
|
341
|
-
# `UserName` parameter. This parameter cannot be combined with any
|
342
|
-
# other filter parameter.
|
343
|
-
# @return [String]
|
344
|
-
#
|
345
|
-
# @!attribute [rw] user_name
|
346
|
-
# Used with the `DirectoryId` parameter to specify the directory user
|
347
|
-
# for whom to obtain the WorkSpace.
|
348
|
-
# @return [String]
|
349
|
-
#
|
350
|
-
# @!attribute [rw] bundle_id
|
351
|
-
# The identifier of a bundle to obtain the WorkSpaces for. All
|
352
|
-
# WorkSpaces that are created from this bundle will be retrieved. This
|
353
|
-
# parameter cannot be combined with any other filter parameter.
|
354
|
-
# @return [String]
|
355
|
-
#
|
356
|
-
# @!attribute [rw] limit
|
357
|
-
# The maximum number of items to return.
|
358
|
-
# @return [Integer]
|
359
|
-
#
|
360
|
-
# @!attribute [rw] next_token
|
361
|
-
# The `NextToken` value from a previous call to this operation. Pass
|
362
|
-
# null if this is the first call.
|
363
|
-
# @return [String]
|
364
|
-
class DescribeWorkspacesRequest < Struct.new(
|
365
|
-
:workspace_ids,
|
366
|
-
:directory_id,
|
367
|
-
:user_name,
|
368
|
-
:bundle_id,
|
369
|
-
:limit,
|
370
|
-
:next_token)
|
371
|
-
include Aws::Structure
|
372
|
-
end
|
373
|
-
|
374
|
-
# Contains the results for the DescribeWorkspaces operation.
|
375
|
-
# @!attribute [rw] workspaces
|
376
|
-
# An array of structures that contain the information about the
|
377
|
-
# WorkSpaces.
|
378
|
-
#
|
379
|
-
# Because the CreateWorkspaces operation is asynchronous, some of this
|
380
|
-
# information may be incomplete for a newly-created WorkSpace.
|
381
|
-
# @return [Array<Types::Workspace>]
|
382
|
-
#
|
383
|
-
# @!attribute [rw] next_token
|
384
|
-
# If not null, more results are available. Pass this value for the
|
385
|
-
# `NextToken` parameter in a subsequent call to this operation to
|
386
|
-
# retrieve the next set of items. This token is valid for one day and
|
387
|
-
# must be used within that time frame.
|
388
|
-
# @return [String]
|
389
|
-
class DescribeWorkspacesResult < Struct.new(
|
390
|
-
:workspaces,
|
391
|
-
:next_token)
|
392
|
-
include Aws::Structure
|
393
|
-
end
|
394
|
-
|
395
|
-
# Contains information about a WorkSpace that could not be created.
|
396
|
-
# @!attribute [rw] workspace_request
|
397
|
-
# A FailedCreateWorkspaceRequest$WorkspaceRequest object that contains
|
398
|
-
# the information about the WorkSpace that could not be created.
|
399
|
-
# @return [Types::WorkspaceRequest]
|
400
|
-
#
|
401
|
-
# @!attribute [rw] error_code
|
402
|
-
# The error code.
|
403
|
-
# @return [String]
|
404
|
-
#
|
405
|
-
# @!attribute [rw] error_message
|
406
|
-
# The textual error message.
|
407
|
-
# @return [String]
|
408
|
-
class FailedCreateWorkspaceRequest < Struct.new(
|
409
|
-
:workspace_request,
|
410
|
-
:error_code,
|
411
|
-
:error_message)
|
412
|
-
include Aws::Structure
|
413
|
-
end
|
414
|
-
|
415
|
-
# Contains information about a WorkSpace that could not be rebooted
|
416
|
-
# (RebootWorkspaces), rebuilt (RebuildWorkspaces), terminated
|
417
|
-
# (TerminateWorkspaces), started (StartWorkspaces), or stopped
|
418
|
-
# (StopWorkspaces).
|
419
|
-
# @!attribute [rw] workspace_id
|
420
|
-
# The identifier of the WorkSpace.
|
421
|
-
# @return [String]
|
422
|
-
#
|
423
|
-
# @!attribute [rw] error_code
|
424
|
-
# The error code.
|
425
|
-
# @return [String]
|
426
|
-
#
|
427
|
-
# @!attribute [rw] error_message
|
428
|
-
# The textual error message.
|
429
|
-
# @return [String]
|
430
|
-
class FailedWorkspaceChangeRequest < Struct.new(
|
431
|
-
:workspace_id,
|
432
|
-
:error_code,
|
433
|
-
:error_message)
|
434
|
-
include Aws::Structure
|
435
|
-
end
|
436
|
-
|
437
|
-
# @note When making an API call, pass ModifyWorkspacePropertiesRequest
|
438
|
-
# data as a hash:
|
439
|
-
#
|
440
|
-
# {
|
441
|
-
# workspace_id: "WorkspaceId", # required
|
442
|
-
# workspace_properties: { # required
|
443
|
-
# running_mode: "AUTO_STOP", # accepts AUTO_STOP, ALWAYS_ON
|
444
|
-
# running_mode_auto_stop_timeout_in_minutes: 1,
|
445
|
-
# },
|
446
|
-
# }
|
447
|
-
# @!attribute [rw] workspace_id
|
448
|
-
# The ID of the WorkSpace.
|
449
|
-
# @return [String]
|
450
|
-
#
|
451
|
-
# @!attribute [rw] workspace_properties
|
452
|
-
# The WorkSpace properties of the request.
|
453
|
-
# @return [Types::WorkspaceProperties]
|
454
|
-
class ModifyWorkspacePropertiesRequest < Struct.new(
|
455
|
-
:workspace_id,
|
456
|
-
:workspace_properties)
|
457
|
-
include Aws::Structure
|
458
|
-
end
|
459
|
-
|
460
|
-
class ModifyWorkspacePropertiesResult < Aws::EmptyStructure; end
|
461
|
-
|
462
|
-
# Contains information used with the RebootWorkspaces operation to
|
463
|
-
# reboot a WorkSpace.
|
464
|
-
# @note When making an API call, pass RebootRequest
|
465
|
-
# data as a hash:
|
466
|
-
#
|
467
|
-
# {
|
468
|
-
# workspace_id: "WorkspaceId", # required
|
469
|
-
# }
|
470
|
-
# @!attribute [rw] workspace_id
|
471
|
-
# The identifier of the WorkSpace to reboot.
|
472
|
-
# @return [String]
|
473
|
-
class RebootRequest < Struct.new(
|
474
|
-
:workspace_id)
|
475
|
-
include Aws::Structure
|
476
|
-
end
|
477
|
-
|
478
|
-
# Contains the inputs for the RebootWorkspaces operation.
|
479
|
-
# @note When making an API call, pass RebootWorkspacesRequest
|
480
|
-
# data as a hash:
|
481
|
-
#
|
482
|
-
# {
|
483
|
-
# reboot_workspace_requests: [ # required
|
484
|
-
# {
|
485
|
-
# workspace_id: "WorkspaceId", # required
|
486
|
-
# },
|
487
|
-
# ],
|
488
|
-
# }
|
489
|
-
# @!attribute [rw] reboot_workspace_requests
|
490
|
-
# An array of structures that specify the WorkSpaces to reboot.
|
491
|
-
# @return [Array<Types::RebootRequest>]
|
492
|
-
class RebootWorkspacesRequest < Struct.new(
|
493
|
-
:reboot_workspace_requests)
|
494
|
-
include Aws::Structure
|
495
|
-
end
|
496
|
-
|
497
|
-
# Contains the results of the RebootWorkspaces operation.
|
498
|
-
# @!attribute [rw] failed_requests
|
499
|
-
# An array of structures representing any WorkSpaces that could not be
|
500
|
-
# rebooted.
|
501
|
-
# @return [Array<Types::FailedWorkspaceChangeRequest>]
|
502
|
-
class RebootWorkspacesResult < Struct.new(
|
503
|
-
:failed_requests)
|
504
|
-
include Aws::Structure
|
505
|
-
end
|
506
|
-
|
507
|
-
# Contains information used with the RebuildWorkspaces operation to
|
508
|
-
# rebuild a WorkSpace.
|
509
|
-
# @note When making an API call, pass RebuildRequest
|
510
|
-
# data as a hash:
|
511
|
-
#
|
512
|
-
# {
|
513
|
-
# workspace_id: "WorkspaceId", # required
|
514
|
-
# }
|
515
|
-
# @!attribute [rw] workspace_id
|
516
|
-
# The identifier of the WorkSpace to rebuild.
|
517
|
-
# @return [String]
|
518
|
-
class RebuildRequest < Struct.new(
|
519
|
-
:workspace_id)
|
520
|
-
include Aws::Structure
|
521
|
-
end
|
522
|
-
|
523
|
-
# Contains the inputs for the RebuildWorkspaces operation.
|
524
|
-
# @note When making an API call, pass RebuildWorkspacesRequest
|
525
|
-
# data as a hash:
|
526
|
-
#
|
527
|
-
# {
|
528
|
-
# rebuild_workspace_requests: [ # required
|
529
|
-
# {
|
530
|
-
# workspace_id: "WorkspaceId", # required
|
531
|
-
# },
|
532
|
-
# ],
|
533
|
-
# }
|
534
|
-
# @!attribute [rw] rebuild_workspace_requests
|
535
|
-
# An array of structures that specify the WorkSpaces to rebuild.
|
536
|
-
# @return [Array<Types::RebuildRequest>]
|
537
|
-
class RebuildWorkspacesRequest < Struct.new(
|
538
|
-
:rebuild_workspace_requests)
|
539
|
-
include Aws::Structure
|
540
|
-
end
|
541
|
-
|
542
|
-
# Contains the results of the RebuildWorkspaces operation.
|
543
|
-
# @!attribute [rw] failed_requests
|
544
|
-
# An array of structures representing any WorkSpaces that could not be
|
545
|
-
# rebuilt.
|
546
|
-
# @return [Array<Types::FailedWorkspaceChangeRequest>]
|
547
|
-
class RebuildWorkspacesResult < Struct.new(
|
548
|
-
:failed_requests)
|
549
|
-
include Aws::Structure
|
550
|
-
end
|
551
|
-
|
552
|
-
# Describes the start request.
|
553
|
-
# @note When making an API call, pass StartRequest
|
554
|
-
# data as a hash:
|
555
|
-
#
|
556
|
-
# {
|
557
|
-
# workspace_id: "WorkspaceId",
|
558
|
-
# }
|
559
|
-
# @!attribute [rw] workspace_id
|
560
|
-
# The ID of the WorkSpace.
|
561
|
-
# @return [String]
|
562
|
-
class StartRequest < Struct.new(
|
563
|
-
:workspace_id)
|
564
|
-
include Aws::Structure
|
565
|
-
end
|
566
|
-
|
567
|
-
# @note When making an API call, pass StartWorkspacesRequest
|
568
|
-
# data as a hash:
|
569
|
-
#
|
570
|
-
# {
|
571
|
-
# start_workspace_requests: [ # required
|
572
|
-
# {
|
573
|
-
# workspace_id: "WorkspaceId",
|
574
|
-
# },
|
575
|
-
# ],
|
576
|
-
# }
|
577
|
-
# @!attribute [rw] start_workspace_requests
|
578
|
-
# The requests.
|
579
|
-
# @return [Array<Types::StartRequest>]
|
580
|
-
class StartWorkspacesRequest < Struct.new(
|
581
|
-
:start_workspace_requests)
|
582
|
-
include Aws::Structure
|
583
|
-
end
|
584
|
-
|
585
|
-
# @!attribute [rw] failed_requests
|
586
|
-
# The failed requests.
|
587
|
-
# @return [Array<Types::FailedWorkspaceChangeRequest>]
|
588
|
-
class StartWorkspacesResult < Struct.new(
|
589
|
-
:failed_requests)
|
590
|
-
include Aws::Structure
|
591
|
-
end
|
592
|
-
|
593
|
-
# Describes the stop request.
|
594
|
-
# @note When making an API call, pass StopRequest
|
595
|
-
# data as a hash:
|
596
|
-
#
|
597
|
-
# {
|
598
|
-
# workspace_id: "WorkspaceId",
|
599
|
-
# }
|
600
|
-
# @!attribute [rw] workspace_id
|
601
|
-
# The ID of the WorkSpace.
|
602
|
-
# @return [String]
|
603
|
-
class StopRequest < Struct.new(
|
604
|
-
:workspace_id)
|
605
|
-
include Aws::Structure
|
606
|
-
end
|
607
|
-
|
608
|
-
# @note When making an API call, pass StopWorkspacesRequest
|
609
|
-
# data as a hash:
|
610
|
-
#
|
611
|
-
# {
|
612
|
-
# stop_workspace_requests: [ # required
|
613
|
-
# {
|
614
|
-
# workspace_id: "WorkspaceId",
|
615
|
-
# },
|
616
|
-
# ],
|
617
|
-
# }
|
618
|
-
# @!attribute [rw] stop_workspace_requests
|
619
|
-
# The requests.
|
620
|
-
# @return [Array<Types::StopRequest>]
|
621
|
-
class StopWorkspacesRequest < Struct.new(
|
622
|
-
:stop_workspace_requests)
|
623
|
-
include Aws::Structure
|
624
|
-
end
|
625
|
-
|
626
|
-
# @!attribute [rw] failed_requests
|
627
|
-
# The failed requests.
|
628
|
-
# @return [Array<Types::FailedWorkspaceChangeRequest>]
|
629
|
-
class StopWorkspacesResult < Struct.new(
|
630
|
-
:failed_requests)
|
631
|
-
include Aws::Structure
|
632
|
-
end
|
633
|
-
|
634
|
-
# Describes the tag of the WorkSpace.
|
635
|
-
# @note When making an API call, pass Tag
|
636
|
-
# data as a hash:
|
637
|
-
#
|
638
|
-
# {
|
639
|
-
# key: "TagKey", # required
|
640
|
-
# value: "TagValue",
|
641
|
-
# }
|
642
|
-
# @!attribute [rw] key
|
643
|
-
# The key of the tag.
|
644
|
-
# @return [String]
|
645
|
-
#
|
646
|
-
# @!attribute [rw] value
|
647
|
-
# The value of the tag.
|
648
|
-
# @return [String]
|
649
|
-
class Tag < Struct.new(
|
650
|
-
:key,
|
651
|
-
:value)
|
652
|
-
include Aws::Structure
|
653
|
-
end
|
654
|
-
|
655
|
-
# Contains information used with the TerminateWorkspaces operation to
|
656
|
-
# terminate a WorkSpace.
|
657
|
-
# @note When making an API call, pass TerminateRequest
|
658
|
-
# data as a hash:
|
659
|
-
#
|
660
|
-
# {
|
661
|
-
# workspace_id: "WorkspaceId", # required
|
662
|
-
# }
|
663
|
-
# @!attribute [rw] workspace_id
|
664
|
-
# The identifier of the WorkSpace to terminate.
|
665
|
-
# @return [String]
|
666
|
-
class TerminateRequest < Struct.new(
|
667
|
-
:workspace_id)
|
668
|
-
include Aws::Structure
|
669
|
-
end
|
670
|
-
|
671
|
-
# Contains the inputs for the TerminateWorkspaces operation.
|
672
|
-
# @note When making an API call, pass TerminateWorkspacesRequest
|
673
|
-
# data as a hash:
|
674
|
-
#
|
675
|
-
# {
|
676
|
-
# terminate_workspace_requests: [ # required
|
677
|
-
# {
|
678
|
-
# workspace_id: "WorkspaceId", # required
|
679
|
-
# },
|
680
|
-
# ],
|
681
|
-
# }
|
682
|
-
# @!attribute [rw] terminate_workspace_requests
|
683
|
-
# An array of structures that specify the WorkSpaces to terminate.
|
684
|
-
# @return [Array<Types::TerminateRequest>]
|
685
|
-
class TerminateWorkspacesRequest < Struct.new(
|
686
|
-
:terminate_workspace_requests)
|
687
|
-
include Aws::Structure
|
688
|
-
end
|
689
|
-
|
690
|
-
# Contains the results of the TerminateWorkspaces operation.
|
691
|
-
# @!attribute [rw] failed_requests
|
692
|
-
# An array of structures representing any WorkSpaces that could not be
|
693
|
-
# terminated.
|
694
|
-
# @return [Array<Types::FailedWorkspaceChangeRequest>]
|
695
|
-
class TerminateWorkspacesResult < Struct.new(
|
696
|
-
:failed_requests)
|
697
|
-
include Aws::Structure
|
698
|
-
end
|
699
|
-
|
700
|
-
# Contains information about the user storage for a WorkSpace bundle.
|
701
|
-
# @!attribute [rw] capacity
|
702
|
-
# The amount of user storage for the bundle.
|
703
|
-
# @return [String]
|
704
|
-
class UserStorage < Struct.new(
|
705
|
-
:capacity)
|
706
|
-
include Aws::Structure
|
707
|
-
end
|
708
|
-
|
709
|
-
# Contains information about a WorkSpace.
|
710
|
-
# @!attribute [rw] workspace_id
|
711
|
-
# The identifier of the WorkSpace.
|
712
|
-
# @return [String]
|
713
|
-
#
|
714
|
-
# @!attribute [rw] directory_id
|
715
|
-
# The identifier of the AWS Directory Service directory that the
|
716
|
-
# WorkSpace belongs to.
|
717
|
-
# @return [String]
|
718
|
-
#
|
719
|
-
# @!attribute [rw] user_name
|
720
|
-
# The user that the WorkSpace is assigned to.
|
721
|
-
# @return [String]
|
722
|
-
#
|
723
|
-
# @!attribute [rw] ip_address
|
724
|
-
# The IP address of the WorkSpace.
|
725
|
-
# @return [String]
|
726
|
-
#
|
727
|
-
# @!attribute [rw] state
|
728
|
-
# The operational state of the WorkSpace.
|
729
|
-
# @return [String]
|
730
|
-
#
|
731
|
-
# @!attribute [rw] bundle_id
|
732
|
-
# The identifier of the bundle that the WorkSpace was created from.
|
733
|
-
# @return [String]
|
734
|
-
#
|
735
|
-
# @!attribute [rw] subnet_id
|
736
|
-
# The identifier of the subnet that the WorkSpace is in.
|
737
|
-
# @return [String]
|
738
|
-
#
|
739
|
-
# @!attribute [rw] error_message
|
740
|
-
# If the WorkSpace could not be created, this contains a textual error
|
741
|
-
# message that describes the failure.
|
742
|
-
# @return [String]
|
743
|
-
#
|
744
|
-
# @!attribute [rw] error_code
|
745
|
-
# If the WorkSpace could not be created, this contains the error code.
|
746
|
-
# @return [String]
|
747
|
-
#
|
748
|
-
# @!attribute [rw] computer_name
|
749
|
-
# The name of the WorkSpace as seen by the operating system.
|
750
|
-
# @return [String]
|
751
|
-
#
|
752
|
-
# @!attribute [rw] volume_encryption_key
|
753
|
-
# The KMS key used to encrypt data stored on your WorkSpace.
|
754
|
-
# @return [String]
|
755
|
-
#
|
756
|
-
# @!attribute [rw] user_volume_encryption_enabled
|
757
|
-
# Specifies whether the data stored on the user volume, or D: drive,
|
758
|
-
# is encrypted.
|
759
|
-
# @return [Boolean]
|
760
|
-
#
|
761
|
-
# @!attribute [rw] root_volume_encryption_enabled
|
762
|
-
# Specifies whether the data stored on the root volume, or C: drive,
|
763
|
-
# is encrypted.
|
764
|
-
# @return [Boolean]
|
765
|
-
#
|
766
|
-
# @!attribute [rw] workspace_properties
|
767
|
-
# Describes the properties of a WorkSpace.
|
768
|
-
# @return [Types::WorkspaceProperties]
|
769
|
-
class Workspace < Struct.new(
|
770
|
-
:workspace_id,
|
771
|
-
:directory_id,
|
772
|
-
:user_name,
|
773
|
-
:ip_address,
|
774
|
-
:state,
|
775
|
-
:bundle_id,
|
776
|
-
:subnet_id,
|
777
|
-
:error_message,
|
778
|
-
:error_code,
|
779
|
-
:computer_name,
|
780
|
-
:volume_encryption_key,
|
781
|
-
:user_volume_encryption_enabled,
|
782
|
-
:root_volume_encryption_enabled,
|
783
|
-
:workspace_properties)
|
784
|
-
include Aws::Structure
|
785
|
-
end
|
786
|
-
|
787
|
-
# Contains information about a WorkSpace bundle.
|
788
|
-
# @!attribute [rw] bundle_id
|
789
|
-
# The bundle identifier.
|
790
|
-
# @return [String]
|
791
|
-
#
|
792
|
-
# @!attribute [rw] name
|
793
|
-
# The name of the bundle.
|
794
|
-
# @return [String]
|
795
|
-
#
|
796
|
-
# @!attribute [rw] owner
|
797
|
-
# The owner of the bundle. This contains the owner's account
|
798
|
-
# identifier, or `AMAZON` if the bundle is provided by AWS.
|
799
|
-
# @return [String]
|
800
|
-
#
|
801
|
-
# @!attribute [rw] description
|
802
|
-
# The bundle description.
|
803
|
-
# @return [String]
|
804
|
-
#
|
805
|
-
# @!attribute [rw] user_storage
|
806
|
-
# A UserStorage object that specifies the amount of user storage that
|
807
|
-
# the bundle contains.
|
808
|
-
# @return [Types::UserStorage]
|
809
|
-
#
|
810
|
-
# @!attribute [rw] compute_type
|
811
|
-
# A ComputeType object that specifies the compute type for the bundle.
|
812
|
-
# @return [Types::ComputeType]
|
813
|
-
class WorkspaceBundle < Struct.new(
|
814
|
-
:bundle_id,
|
815
|
-
:name,
|
816
|
-
:owner,
|
817
|
-
:description,
|
818
|
-
:user_storage,
|
819
|
-
:compute_type)
|
820
|
-
include Aws::Structure
|
821
|
-
end
|
822
|
-
|
823
|
-
# Describes the connection status of a WorkSpace.
|
824
|
-
# @!attribute [rw] workspace_id
|
825
|
-
# The ID of the WorkSpace.
|
826
|
-
# @return [String]
|
827
|
-
#
|
828
|
-
# @!attribute [rw] connection_state
|
829
|
-
# The connection state of the WorkSpace. Returns UNKOWN if the
|
830
|
-
# WorkSpace is in a Stopped state.
|
831
|
-
# @return [String]
|
832
|
-
#
|
833
|
-
# @!attribute [rw] connection_state_check_timestamp
|
834
|
-
# The timestamp of the connection state check.
|
835
|
-
# @return [Time]
|
836
|
-
#
|
837
|
-
# @!attribute [rw] last_known_user_connection_timestamp
|
838
|
-
# The timestamp of the last known user connection.
|
839
|
-
# @return [Time]
|
840
|
-
class WorkspaceConnectionStatus < Struct.new(
|
841
|
-
:workspace_id,
|
842
|
-
:connection_state,
|
843
|
-
:connection_state_check_timestamp,
|
844
|
-
:last_known_user_connection_timestamp)
|
845
|
-
include Aws::Structure
|
846
|
-
end
|
847
|
-
|
848
|
-
# Contains information about an AWS Directory Service directory for use
|
849
|
-
# with Amazon WorkSpaces.
|
850
|
-
# @!attribute [rw] directory_id
|
851
|
-
# The directory identifier.
|
852
|
-
# @return [String]
|
853
|
-
#
|
854
|
-
# @!attribute [rw] alias
|
855
|
-
# The directory alias.
|
856
|
-
# @return [String]
|
857
|
-
#
|
858
|
-
# @!attribute [rw] directory_name
|
859
|
-
# The name of the directory.
|
860
|
-
# @return [String]
|
861
|
-
#
|
862
|
-
# @!attribute [rw] registration_code
|
863
|
-
# The registration code for the directory. This is the code that users
|
864
|
-
# enter in their Amazon WorkSpaces client application to connect to
|
865
|
-
# the directory.
|
866
|
-
# @return [String]
|
867
|
-
#
|
868
|
-
# @!attribute [rw] subnet_ids
|
869
|
-
# An array of strings that contains the identifiers of the subnets
|
870
|
-
# used with the directory.
|
871
|
-
# @return [Array<String>]
|
872
|
-
#
|
873
|
-
# @!attribute [rw] dns_ip_addresses
|
874
|
-
# An array of strings that contains the IP addresses of the DNS
|
875
|
-
# servers for the directory.
|
876
|
-
# @return [Array<String>]
|
877
|
-
#
|
878
|
-
# @!attribute [rw] customer_user_name
|
879
|
-
# The user name for the service account.
|
880
|
-
# @return [String]
|
881
|
-
#
|
882
|
-
# @!attribute [rw] iam_role_id
|
883
|
-
# The identifier of the IAM role. This is the role that allows Amazon
|
884
|
-
# WorkSpaces to make calls to other services, such as Amazon EC2, on
|
885
|
-
# your behalf.
|
886
|
-
# @return [String]
|
887
|
-
#
|
888
|
-
# @!attribute [rw] directory_type
|
889
|
-
# The directory type.
|
890
|
-
# @return [String]
|
891
|
-
#
|
892
|
-
# @!attribute [rw] workspace_security_group_id
|
893
|
-
# The identifier of the security group that is assigned to new
|
894
|
-
# WorkSpaces.
|
895
|
-
# @return [String]
|
896
|
-
#
|
897
|
-
# @!attribute [rw] state
|
898
|
-
# The state of the directory's registration with Amazon WorkSpaces
|
899
|
-
# @return [String]
|
900
|
-
#
|
901
|
-
# @!attribute [rw] workspace_creation_properties
|
902
|
-
# A structure that specifies the default creation properties for all
|
903
|
-
# WorkSpaces in the directory.
|
904
|
-
# @return [Types::DefaultWorkspaceCreationProperties]
|
905
|
-
class WorkspaceDirectory < Struct.new(
|
906
|
-
:directory_id,
|
907
|
-
:alias,
|
908
|
-
:directory_name,
|
909
|
-
:registration_code,
|
910
|
-
:subnet_ids,
|
911
|
-
:dns_ip_addresses,
|
912
|
-
:customer_user_name,
|
913
|
-
:iam_role_id,
|
914
|
-
:directory_type,
|
915
|
-
:workspace_security_group_id,
|
916
|
-
:state,
|
917
|
-
:workspace_creation_properties)
|
918
|
-
include Aws::Structure
|
919
|
-
end
|
920
|
-
|
921
|
-
# Describes the properties of a WorkSpace.
|
922
|
-
# @note When making an API call, pass WorkspaceProperties
|
923
|
-
# data as a hash:
|
924
|
-
#
|
925
|
-
# {
|
926
|
-
# running_mode: "AUTO_STOP", # accepts AUTO_STOP, ALWAYS_ON
|
927
|
-
# running_mode_auto_stop_timeout_in_minutes: 1,
|
928
|
-
# }
|
929
|
-
# @!attribute [rw] running_mode
|
930
|
-
# The running mode of the WorkSpace. AlwaysOn WorkSpaces are billed
|
931
|
-
# monthly. AutoStop WorkSpaces are billed by the hour and stopped when
|
932
|
-
# no longer being used in order to save on costs.
|
933
|
-
# @return [String]
|
934
|
-
#
|
935
|
-
# @!attribute [rw] running_mode_auto_stop_timeout_in_minutes
|
936
|
-
# The time after a user logs off when WorkSpaces are automatically
|
937
|
-
# stopped. Configured in 60 minute intervals.
|
938
|
-
# @return [Integer]
|
939
|
-
class WorkspaceProperties < Struct.new(
|
940
|
-
:running_mode,
|
941
|
-
:running_mode_auto_stop_timeout_in_minutes)
|
942
|
-
include Aws::Structure
|
943
|
-
end
|
944
|
-
|
945
|
-
# Contains information about a WorkSpace creation request.
|
946
|
-
# @note When making an API call, pass WorkspaceRequest
|
947
|
-
# data as a hash:
|
948
|
-
#
|
949
|
-
# {
|
950
|
-
# directory_id: "DirectoryId", # required
|
951
|
-
# user_name: "UserName", # required
|
952
|
-
# bundle_id: "BundleId", # required
|
953
|
-
# volume_encryption_key: "VolumeEncryptionKey",
|
954
|
-
# user_volume_encryption_enabled: false,
|
955
|
-
# root_volume_encryption_enabled: false,
|
956
|
-
# workspace_properties: {
|
957
|
-
# running_mode: "AUTO_STOP", # accepts AUTO_STOP, ALWAYS_ON
|
958
|
-
# running_mode_auto_stop_timeout_in_minutes: 1,
|
959
|
-
# },
|
960
|
-
# tags: [
|
961
|
-
# {
|
962
|
-
# key: "TagKey", # required
|
963
|
-
# value: "TagValue",
|
964
|
-
# },
|
965
|
-
# ],
|
966
|
-
# }
|
967
|
-
# @!attribute [rw] directory_id
|
968
|
-
# The identifier of the AWS Directory Service directory to create the
|
969
|
-
# WorkSpace in. You can use the DescribeWorkspaceDirectories operation
|
970
|
-
# to obtain a list of the directories that are available.
|
971
|
-
# @return [String]
|
972
|
-
#
|
973
|
-
# @!attribute [rw] user_name
|
974
|
-
# The username that the WorkSpace is assigned to. This username must
|
975
|
-
# exist in the AWS Directory Service directory specified by the
|
976
|
-
# `DirectoryId` member.
|
977
|
-
# @return [String]
|
978
|
-
#
|
979
|
-
# @!attribute [rw] bundle_id
|
980
|
-
# The identifier of the bundle to create the WorkSpace from. You can
|
981
|
-
# use the DescribeWorkspaceBundles operation to obtain a list of the
|
982
|
-
# bundles that are available.
|
983
|
-
# @return [String]
|
984
|
-
#
|
985
|
-
# @!attribute [rw] volume_encryption_key
|
986
|
-
# The KMS key used to encrypt data stored on your WorkSpace.
|
987
|
-
# @return [String]
|
988
|
-
#
|
989
|
-
# @!attribute [rw] user_volume_encryption_enabled
|
990
|
-
# Specifies whether the data stored on the user volume, or D: drive,
|
991
|
-
# is encrypted.
|
992
|
-
# @return [Boolean]
|
993
|
-
#
|
994
|
-
# @!attribute [rw] root_volume_encryption_enabled
|
995
|
-
# Specifies whether the data stored on the root volume, or C: drive,
|
996
|
-
# is encrypted.
|
997
|
-
# @return [Boolean]
|
998
|
-
#
|
999
|
-
# @!attribute [rw] workspace_properties
|
1000
|
-
# Describes the properties of a WorkSpace.
|
1001
|
-
# @return [Types::WorkspaceProperties]
|
1002
|
-
#
|
1003
|
-
# @!attribute [rw] tags
|
1004
|
-
# The tags of the WorkSpace request.
|
1005
|
-
# @return [Array<Types::Tag>]
|
1006
|
-
class WorkspaceRequest < Struct.new(
|
1007
|
-
:directory_id,
|
1008
|
-
:user_name,
|
1009
|
-
:bundle_id,
|
1010
|
-
:volume_encryption_key,
|
1011
|
-
:user_volume_encryption_enabled,
|
1012
|
-
:root_volume_encryption_enabled,
|
1013
|
-
:workspace_properties,
|
1014
|
-
:tags)
|
1015
|
-
include Aws::Structure
|
1016
|
-
end
|
8
|
+
module Aws::WorkSpaces
|
9
|
+
module Types
|
1017
10
|
|
11
|
+
# Contains information about the compute type of a WorkSpace bundle.
|
12
|
+
#
|
13
|
+
# @!attribute [rw] name
|
14
|
+
# The name of the compute type for the bundle.
|
15
|
+
# @return [String]
|
16
|
+
#
|
17
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ComputeType AWS API Documentation
|
18
|
+
#
|
19
|
+
class ComputeType < Struct.new(
|
20
|
+
:name)
|
21
|
+
include Aws::Structure
|
1018
22
|
end
|
23
|
+
|
24
|
+
# The request of the CreateTags operation.
|
25
|
+
#
|
26
|
+
# @note When making an API call, you may pass CreateTagsRequest
|
27
|
+
# data as a hash:
|
28
|
+
#
|
29
|
+
# {
|
30
|
+
# resource_id: "NonEmptyString", # required
|
31
|
+
# tags: [ # required
|
32
|
+
# {
|
33
|
+
# key: "TagKey", # required
|
34
|
+
# value: "TagValue",
|
35
|
+
# },
|
36
|
+
# ],
|
37
|
+
# }
|
38
|
+
#
|
39
|
+
# @!attribute [rw] resource_id
|
40
|
+
# The resource ID of the request.
|
41
|
+
# @return [String]
|
42
|
+
#
|
43
|
+
# @!attribute [rw] tags
|
44
|
+
# The tags of the request.
|
45
|
+
# @return [Array<Types::Tag>]
|
46
|
+
#
|
47
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateTagsRequest AWS API Documentation
|
48
|
+
#
|
49
|
+
class CreateTagsRequest < Struct.new(
|
50
|
+
:resource_id,
|
51
|
+
:tags)
|
52
|
+
include Aws::Structure
|
53
|
+
end
|
54
|
+
|
55
|
+
# The result of the CreateTags operation.
|
56
|
+
#
|
57
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateTagsResult AWS API Documentation
|
58
|
+
#
|
59
|
+
class CreateTagsResult < Aws::EmptyStructure; end
|
60
|
+
|
61
|
+
# Contains the inputs for the CreateWorkspaces operation.
|
62
|
+
#
|
63
|
+
# @note When making an API call, you may pass CreateWorkspacesRequest
|
64
|
+
# data as a hash:
|
65
|
+
#
|
66
|
+
# {
|
67
|
+
# workspaces: [ # required
|
68
|
+
# {
|
69
|
+
# directory_id: "DirectoryId", # required
|
70
|
+
# user_name: "UserName", # required
|
71
|
+
# bundle_id: "BundleId", # required
|
72
|
+
# volume_encryption_key: "VolumeEncryptionKey",
|
73
|
+
# user_volume_encryption_enabled: false,
|
74
|
+
# root_volume_encryption_enabled: false,
|
75
|
+
# workspace_properties: {
|
76
|
+
# running_mode: "AUTO_STOP", # accepts AUTO_STOP, ALWAYS_ON
|
77
|
+
# running_mode_auto_stop_timeout_in_minutes: 1,
|
78
|
+
# },
|
79
|
+
# tags: [
|
80
|
+
# {
|
81
|
+
# key: "TagKey", # required
|
82
|
+
# value: "TagValue",
|
83
|
+
# },
|
84
|
+
# ],
|
85
|
+
# },
|
86
|
+
# ],
|
87
|
+
# }
|
88
|
+
#
|
89
|
+
# @!attribute [rw] workspaces
|
90
|
+
# An array of structures that specify the WorkSpaces to create.
|
91
|
+
# @return [Array<Types::WorkspaceRequest>]
|
92
|
+
#
|
93
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspacesRequest AWS API Documentation
|
94
|
+
#
|
95
|
+
class CreateWorkspacesRequest < Struct.new(
|
96
|
+
:workspaces)
|
97
|
+
include Aws::Structure
|
98
|
+
end
|
99
|
+
|
100
|
+
# Contains the result of the CreateWorkspaces operation.
|
101
|
+
#
|
102
|
+
# @!attribute [rw] failed_requests
|
103
|
+
# An array of structures that represent the WorkSpaces that could not
|
104
|
+
# be created.
|
105
|
+
# @return [Array<Types::FailedCreateWorkspaceRequest>]
|
106
|
+
#
|
107
|
+
# @!attribute [rw] pending_requests
|
108
|
+
# An array of structures that represent the WorkSpaces that were
|
109
|
+
# created.
|
110
|
+
#
|
111
|
+
# Because this operation is asynchronous, the identifier in
|
112
|
+
# `WorkspaceId` is not immediately available. If you immediately call
|
113
|
+
# DescribeWorkspaces with this identifier, no information will be
|
114
|
+
# returned.
|
115
|
+
# @return [Array<Types::Workspace>]
|
116
|
+
#
|
117
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspacesResult AWS API Documentation
|
118
|
+
#
|
119
|
+
class CreateWorkspacesResult < Struct.new(
|
120
|
+
:failed_requests,
|
121
|
+
:pending_requests)
|
122
|
+
include Aws::Structure
|
123
|
+
end
|
124
|
+
|
125
|
+
# Contains default WorkSpace creation information.
|
126
|
+
#
|
127
|
+
# @!attribute [rw] enable_work_docs
|
128
|
+
# Specifies if the directory is enabled for Amazon WorkDocs.
|
129
|
+
# @return [Boolean]
|
130
|
+
#
|
131
|
+
# @!attribute [rw] enable_internet_access
|
132
|
+
# A public IP address will be attached to all WorkSpaces that are
|
133
|
+
# created or rebuilt.
|
134
|
+
# @return [Boolean]
|
135
|
+
#
|
136
|
+
# @!attribute [rw] default_ou
|
137
|
+
# The organizational unit (OU) in the directory that the WorkSpace
|
138
|
+
# machine accounts are placed in.
|
139
|
+
# @return [String]
|
140
|
+
#
|
141
|
+
# @!attribute [rw] custom_security_group_id
|
142
|
+
# The identifier of any custom security groups that are applied to the
|
143
|
+
# WorkSpaces when they are created.
|
144
|
+
# @return [String]
|
145
|
+
#
|
146
|
+
# @!attribute [rw] user_enabled_as_local_administrator
|
147
|
+
# The WorkSpace user is an administrator on the WorkSpace.
|
148
|
+
# @return [Boolean]
|
149
|
+
#
|
150
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DefaultWorkspaceCreationProperties AWS API Documentation
|
151
|
+
#
|
152
|
+
class DefaultWorkspaceCreationProperties < Struct.new(
|
153
|
+
:enable_work_docs,
|
154
|
+
:enable_internet_access,
|
155
|
+
:default_ou,
|
156
|
+
:custom_security_group_id,
|
157
|
+
:user_enabled_as_local_administrator)
|
158
|
+
include Aws::Structure
|
159
|
+
end
|
160
|
+
|
161
|
+
# The request of the DeleteTags operation.
|
162
|
+
#
|
163
|
+
# @note When making an API call, you may pass DeleteTagsRequest
|
164
|
+
# data as a hash:
|
165
|
+
#
|
166
|
+
# {
|
167
|
+
# resource_id: "NonEmptyString", # required
|
168
|
+
# tag_keys: ["NonEmptyString"], # required
|
169
|
+
# }
|
170
|
+
#
|
171
|
+
# @!attribute [rw] resource_id
|
172
|
+
# The resource ID of the request.
|
173
|
+
# @return [String]
|
174
|
+
#
|
175
|
+
# @!attribute [rw] tag_keys
|
176
|
+
# The tag keys of the request.
|
177
|
+
# @return [Array<String>]
|
178
|
+
#
|
179
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteTagsRequest AWS API Documentation
|
180
|
+
#
|
181
|
+
class DeleteTagsRequest < Struct.new(
|
182
|
+
:resource_id,
|
183
|
+
:tag_keys)
|
184
|
+
include Aws::Structure
|
185
|
+
end
|
186
|
+
|
187
|
+
# The result of the DeleteTags operation.
|
188
|
+
#
|
189
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteTagsResult AWS API Documentation
|
190
|
+
#
|
191
|
+
class DeleteTagsResult < Aws::EmptyStructure; end
|
192
|
+
|
193
|
+
# The request of the DescribeTags operation.
|
194
|
+
#
|
195
|
+
# @note When making an API call, you may pass DescribeTagsRequest
|
196
|
+
# data as a hash:
|
197
|
+
#
|
198
|
+
# {
|
199
|
+
# resource_id: "NonEmptyString", # required
|
200
|
+
# }
|
201
|
+
#
|
202
|
+
# @!attribute [rw] resource_id
|
203
|
+
# The resource ID of the request.
|
204
|
+
# @return [String]
|
205
|
+
#
|
206
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeTagsRequest AWS API Documentation
|
207
|
+
#
|
208
|
+
class DescribeTagsRequest < Struct.new(
|
209
|
+
:resource_id)
|
210
|
+
include Aws::Structure
|
211
|
+
end
|
212
|
+
|
213
|
+
# The result of the DescribeTags operation.
|
214
|
+
#
|
215
|
+
# @!attribute [rw] tag_list
|
216
|
+
# The list of tags.
|
217
|
+
# @return [Array<Types::Tag>]
|
218
|
+
#
|
219
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeTagsResult AWS API Documentation
|
220
|
+
#
|
221
|
+
class DescribeTagsResult < Struct.new(
|
222
|
+
:tag_list)
|
223
|
+
include Aws::Structure
|
224
|
+
end
|
225
|
+
|
226
|
+
# Contains the inputs for the DescribeWorkspaceBundles operation.
|
227
|
+
#
|
228
|
+
# @note When making an API call, you may pass DescribeWorkspaceBundlesRequest
|
229
|
+
# data as a hash:
|
230
|
+
#
|
231
|
+
# {
|
232
|
+
# bundle_ids: ["BundleId"],
|
233
|
+
# owner: "BundleOwner",
|
234
|
+
# next_token: "PaginationToken",
|
235
|
+
# }
|
236
|
+
#
|
237
|
+
# @!attribute [rw] bundle_ids
|
238
|
+
# An array of strings that contains the identifiers of the bundles to
|
239
|
+
# retrieve. This parameter cannot be combined with any other filter
|
240
|
+
# parameter.
|
241
|
+
# @return [Array<String>]
|
242
|
+
#
|
243
|
+
# @!attribute [rw] owner
|
244
|
+
# The owner of the bundles to retrieve. This parameter cannot be
|
245
|
+
# combined with any other filter parameter.
|
246
|
+
#
|
247
|
+
# This contains one of the following values:
|
248
|
+
#
|
249
|
+
# * null- Retrieves the bundles that belong to the account making the
|
250
|
+
# call.
|
251
|
+
#
|
252
|
+
# * `AMAZON`- Retrieves the bundles that are provided by AWS.
|
253
|
+
# @return [String]
|
254
|
+
#
|
255
|
+
# @!attribute [rw] next_token
|
256
|
+
# The `NextToken` value from a previous call to this operation. Pass
|
257
|
+
# null if this is the first call.
|
258
|
+
# @return [String]
|
259
|
+
#
|
260
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceBundlesRequest AWS API Documentation
|
261
|
+
#
|
262
|
+
class DescribeWorkspaceBundlesRequest < Struct.new(
|
263
|
+
:bundle_ids,
|
264
|
+
:owner,
|
265
|
+
:next_token)
|
266
|
+
include Aws::Structure
|
267
|
+
end
|
268
|
+
|
269
|
+
# Contains the results of the DescribeWorkspaceBundles operation.
|
270
|
+
#
|
271
|
+
# @!attribute [rw] bundles
|
272
|
+
# An array of structures that contain information about the bundles.
|
273
|
+
# @return [Array<Types::WorkspaceBundle>]
|
274
|
+
#
|
275
|
+
# @!attribute [rw] next_token
|
276
|
+
# If not null, more results are available. Pass this value for the
|
277
|
+
# `NextToken` parameter in a subsequent call to this operation to
|
278
|
+
# retrieve the next set of items. This token is valid for one day and
|
279
|
+
# must be used within that time frame.
|
280
|
+
# @return [String]
|
281
|
+
#
|
282
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceBundlesResult AWS API Documentation
|
283
|
+
#
|
284
|
+
class DescribeWorkspaceBundlesResult < Struct.new(
|
285
|
+
:bundles,
|
286
|
+
:next_token)
|
287
|
+
include Aws::Structure
|
288
|
+
end
|
289
|
+
|
290
|
+
# Contains the inputs for the DescribeWorkspaceDirectories operation.
|
291
|
+
#
|
292
|
+
# @note When making an API call, you may pass DescribeWorkspaceDirectoriesRequest
|
293
|
+
# data as a hash:
|
294
|
+
#
|
295
|
+
# {
|
296
|
+
# directory_ids: ["DirectoryId"],
|
297
|
+
# next_token: "PaginationToken",
|
298
|
+
# }
|
299
|
+
#
|
300
|
+
# @!attribute [rw] directory_ids
|
301
|
+
# An array of strings that contains the directory identifiers to
|
302
|
+
# retrieve information for. If this member is null, all directories
|
303
|
+
# are retrieved.
|
304
|
+
# @return [Array<String>]
|
305
|
+
#
|
306
|
+
# @!attribute [rw] next_token
|
307
|
+
# The `NextToken` value from a previous call to this operation. Pass
|
308
|
+
# null if this is the first call.
|
309
|
+
# @return [String]
|
310
|
+
#
|
311
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceDirectoriesRequest AWS API Documentation
|
312
|
+
#
|
313
|
+
class DescribeWorkspaceDirectoriesRequest < Struct.new(
|
314
|
+
:directory_ids,
|
315
|
+
:next_token)
|
316
|
+
include Aws::Structure
|
317
|
+
end
|
318
|
+
|
319
|
+
# Contains the results of the DescribeWorkspaceDirectories operation.
|
320
|
+
#
|
321
|
+
# @!attribute [rw] directories
|
322
|
+
# An array of structures that contain information about the
|
323
|
+
# directories.
|
324
|
+
# @return [Array<Types::WorkspaceDirectory>]
|
325
|
+
#
|
326
|
+
# @!attribute [rw] next_token
|
327
|
+
# If not null, more results are available. Pass this value for the
|
328
|
+
# `NextToken` parameter in a subsequent call to this operation to
|
329
|
+
# retrieve the next set of items. This token is valid for one day and
|
330
|
+
# must be used within that time frame.
|
331
|
+
# @return [String]
|
332
|
+
#
|
333
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceDirectoriesResult AWS API Documentation
|
334
|
+
#
|
335
|
+
class DescribeWorkspaceDirectoriesResult < Struct.new(
|
336
|
+
:directories,
|
337
|
+
:next_token)
|
338
|
+
include Aws::Structure
|
339
|
+
end
|
340
|
+
|
341
|
+
# @note When making an API call, you may pass DescribeWorkspacesConnectionStatusRequest
|
342
|
+
# data as a hash:
|
343
|
+
#
|
344
|
+
# {
|
345
|
+
# workspace_ids: ["WorkspaceId"],
|
346
|
+
# next_token: "PaginationToken",
|
347
|
+
# }
|
348
|
+
#
|
349
|
+
# @!attribute [rw] workspace_ids
|
350
|
+
# An array of strings that contain the identifiers of the WorkSpaces.
|
351
|
+
# @return [Array<String>]
|
352
|
+
#
|
353
|
+
# @!attribute [rw] next_token
|
354
|
+
# The next token of the request.
|
355
|
+
# @return [String]
|
356
|
+
#
|
357
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesConnectionStatusRequest AWS API Documentation
|
358
|
+
#
|
359
|
+
class DescribeWorkspacesConnectionStatusRequest < Struct.new(
|
360
|
+
:workspace_ids,
|
361
|
+
:next_token)
|
362
|
+
include Aws::Structure
|
363
|
+
end
|
364
|
+
|
365
|
+
# @!attribute [rw] workspaces_connection_status
|
366
|
+
# The connection status of the WorkSpace.
|
367
|
+
# @return [Array<Types::WorkspaceConnectionStatus>]
|
368
|
+
#
|
369
|
+
# @!attribute [rw] next_token
|
370
|
+
# The next token of the result.
|
371
|
+
# @return [String]
|
372
|
+
#
|
373
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesConnectionStatusResult AWS API Documentation
|
374
|
+
#
|
375
|
+
class DescribeWorkspacesConnectionStatusResult < Struct.new(
|
376
|
+
:workspaces_connection_status,
|
377
|
+
:next_token)
|
378
|
+
include Aws::Structure
|
379
|
+
end
|
380
|
+
|
381
|
+
# Contains the inputs for the DescribeWorkspaces operation.
|
382
|
+
#
|
383
|
+
# @note When making an API call, you may pass DescribeWorkspacesRequest
|
384
|
+
# data as a hash:
|
385
|
+
#
|
386
|
+
# {
|
387
|
+
# workspace_ids: ["WorkspaceId"],
|
388
|
+
# directory_id: "DirectoryId",
|
389
|
+
# user_name: "UserName",
|
390
|
+
# bundle_id: "BundleId",
|
391
|
+
# limit: 1,
|
392
|
+
# next_token: "PaginationToken",
|
393
|
+
# }
|
394
|
+
#
|
395
|
+
# @!attribute [rw] workspace_ids
|
396
|
+
# An array of strings that contain the identifiers of the WorkSpaces
|
397
|
+
# for which to retrieve information. This parameter cannot be combined
|
398
|
+
# with any other filter parameter.
|
399
|
+
#
|
400
|
+
# Because the CreateWorkspaces operation is asynchronous, the
|
401
|
+
# identifier it returns is not immediately available. If you
|
402
|
+
# immediately call DescribeWorkspaces with this identifier, no
|
403
|
+
# information is returned.
|
404
|
+
# @return [Array<String>]
|
405
|
+
#
|
406
|
+
# @!attribute [rw] directory_id
|
407
|
+
# Specifies the directory identifier to which to limit the WorkSpaces.
|
408
|
+
# Optionally, you can specify a specific directory user with the
|
409
|
+
# `UserName` parameter. This parameter cannot be combined with any
|
410
|
+
# other filter parameter.
|
411
|
+
# @return [String]
|
412
|
+
#
|
413
|
+
# @!attribute [rw] user_name
|
414
|
+
# Used with the `DirectoryId` parameter to specify the directory user
|
415
|
+
# for whom to obtain the WorkSpace.
|
416
|
+
# @return [String]
|
417
|
+
#
|
418
|
+
# @!attribute [rw] bundle_id
|
419
|
+
# The identifier of a bundle to obtain the WorkSpaces for. All
|
420
|
+
# WorkSpaces that are created from this bundle will be retrieved. This
|
421
|
+
# parameter cannot be combined with any other filter parameter.
|
422
|
+
# @return [String]
|
423
|
+
#
|
424
|
+
# @!attribute [rw] limit
|
425
|
+
# The maximum number of items to return.
|
426
|
+
# @return [Integer]
|
427
|
+
#
|
428
|
+
# @!attribute [rw] next_token
|
429
|
+
# The `NextToken` value from a previous call to this operation. Pass
|
430
|
+
# null if this is the first call.
|
431
|
+
# @return [String]
|
432
|
+
#
|
433
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesRequest AWS API Documentation
|
434
|
+
#
|
435
|
+
class DescribeWorkspacesRequest < Struct.new(
|
436
|
+
:workspace_ids,
|
437
|
+
:directory_id,
|
438
|
+
:user_name,
|
439
|
+
:bundle_id,
|
440
|
+
:limit,
|
441
|
+
:next_token)
|
442
|
+
include Aws::Structure
|
443
|
+
end
|
444
|
+
|
445
|
+
# Contains the results for the DescribeWorkspaces operation.
|
446
|
+
#
|
447
|
+
# @!attribute [rw] workspaces
|
448
|
+
# An array of structures that contain the information about the
|
449
|
+
# WorkSpaces.
|
450
|
+
#
|
451
|
+
# Because the CreateWorkspaces operation is asynchronous, some of this
|
452
|
+
# information may be incomplete for a newly-created WorkSpace.
|
453
|
+
# @return [Array<Types::Workspace>]
|
454
|
+
#
|
455
|
+
# @!attribute [rw] next_token
|
456
|
+
# If not null, more results are available. Pass this value for the
|
457
|
+
# `NextToken` parameter in a subsequent call to this operation to
|
458
|
+
# retrieve the next set of items. This token is valid for one day and
|
459
|
+
# must be used within that time frame.
|
460
|
+
# @return [String]
|
461
|
+
#
|
462
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesResult AWS API Documentation
|
463
|
+
#
|
464
|
+
class DescribeWorkspacesResult < Struct.new(
|
465
|
+
:workspaces,
|
466
|
+
:next_token)
|
467
|
+
include Aws::Structure
|
468
|
+
end
|
469
|
+
|
470
|
+
# Contains information about a WorkSpace that could not be created.
|
471
|
+
#
|
472
|
+
# @!attribute [rw] workspace_request
|
473
|
+
# A FailedCreateWorkspaceRequest$WorkspaceRequest object that contains
|
474
|
+
# the information about the WorkSpace that could not be created.
|
475
|
+
# @return [Types::WorkspaceRequest]
|
476
|
+
#
|
477
|
+
# @!attribute [rw] error_code
|
478
|
+
# The error code.
|
479
|
+
# @return [String]
|
480
|
+
#
|
481
|
+
# @!attribute [rw] error_message
|
482
|
+
# The textual error message.
|
483
|
+
# @return [String]
|
484
|
+
#
|
485
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/FailedCreateWorkspaceRequest AWS API Documentation
|
486
|
+
#
|
487
|
+
class FailedCreateWorkspaceRequest < Struct.new(
|
488
|
+
:workspace_request,
|
489
|
+
:error_code,
|
490
|
+
:error_message)
|
491
|
+
include Aws::Structure
|
492
|
+
end
|
493
|
+
|
494
|
+
# Contains information about a WorkSpace that could not be rebooted
|
495
|
+
# (RebootWorkspaces), rebuilt (RebuildWorkspaces), terminated
|
496
|
+
# (TerminateWorkspaces), started (StartWorkspaces), or stopped
|
497
|
+
# (StopWorkspaces).
|
498
|
+
#
|
499
|
+
# @!attribute [rw] workspace_id
|
500
|
+
# The identifier of the WorkSpace.
|
501
|
+
# @return [String]
|
502
|
+
#
|
503
|
+
# @!attribute [rw] error_code
|
504
|
+
# The error code.
|
505
|
+
# @return [String]
|
506
|
+
#
|
507
|
+
# @!attribute [rw] error_message
|
508
|
+
# The textual error message.
|
509
|
+
# @return [String]
|
510
|
+
#
|
511
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/FailedWorkspaceChangeRequest AWS API Documentation
|
512
|
+
#
|
513
|
+
class FailedWorkspaceChangeRequest < Struct.new(
|
514
|
+
:workspace_id,
|
515
|
+
:error_code,
|
516
|
+
:error_message)
|
517
|
+
include Aws::Structure
|
518
|
+
end
|
519
|
+
|
520
|
+
# @note When making an API call, you may pass ModifyWorkspacePropertiesRequest
|
521
|
+
# data as a hash:
|
522
|
+
#
|
523
|
+
# {
|
524
|
+
# workspace_id: "WorkspaceId", # required
|
525
|
+
# workspace_properties: { # required
|
526
|
+
# running_mode: "AUTO_STOP", # accepts AUTO_STOP, ALWAYS_ON
|
527
|
+
# running_mode_auto_stop_timeout_in_minutes: 1,
|
528
|
+
# },
|
529
|
+
# }
|
530
|
+
#
|
531
|
+
# @!attribute [rw] workspace_id
|
532
|
+
# The ID of the WorkSpace.
|
533
|
+
# @return [String]
|
534
|
+
#
|
535
|
+
# @!attribute [rw] workspace_properties
|
536
|
+
# The WorkSpace properties of the request.
|
537
|
+
# @return [Types::WorkspaceProperties]
|
538
|
+
#
|
539
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspacePropertiesRequest AWS API Documentation
|
540
|
+
#
|
541
|
+
class ModifyWorkspacePropertiesRequest < Struct.new(
|
542
|
+
:workspace_id,
|
543
|
+
:workspace_properties)
|
544
|
+
include Aws::Structure
|
545
|
+
end
|
546
|
+
|
547
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspacePropertiesResult AWS API Documentation
|
548
|
+
#
|
549
|
+
class ModifyWorkspacePropertiesResult < Aws::EmptyStructure; end
|
550
|
+
|
551
|
+
# Contains information used with the RebootWorkspaces operation to
|
552
|
+
# reboot a WorkSpace.
|
553
|
+
#
|
554
|
+
# @note When making an API call, you may pass RebootRequest
|
555
|
+
# data as a hash:
|
556
|
+
#
|
557
|
+
# {
|
558
|
+
# workspace_id: "WorkspaceId", # required
|
559
|
+
# }
|
560
|
+
#
|
561
|
+
# @!attribute [rw] workspace_id
|
562
|
+
# The identifier of the WorkSpace to reboot.
|
563
|
+
# @return [String]
|
564
|
+
#
|
565
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebootRequest AWS API Documentation
|
566
|
+
#
|
567
|
+
class RebootRequest < Struct.new(
|
568
|
+
:workspace_id)
|
569
|
+
include Aws::Structure
|
570
|
+
end
|
571
|
+
|
572
|
+
# Contains the inputs for the RebootWorkspaces operation.
|
573
|
+
#
|
574
|
+
# @note When making an API call, you may pass RebootWorkspacesRequest
|
575
|
+
# data as a hash:
|
576
|
+
#
|
577
|
+
# {
|
578
|
+
# reboot_workspace_requests: [ # required
|
579
|
+
# {
|
580
|
+
# workspace_id: "WorkspaceId", # required
|
581
|
+
# },
|
582
|
+
# ],
|
583
|
+
# }
|
584
|
+
#
|
585
|
+
# @!attribute [rw] reboot_workspace_requests
|
586
|
+
# An array of structures that specify the WorkSpaces to reboot.
|
587
|
+
# @return [Array<Types::RebootRequest>]
|
588
|
+
#
|
589
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebootWorkspacesRequest AWS API Documentation
|
590
|
+
#
|
591
|
+
class RebootWorkspacesRequest < Struct.new(
|
592
|
+
:reboot_workspace_requests)
|
593
|
+
include Aws::Structure
|
594
|
+
end
|
595
|
+
|
596
|
+
# Contains the results of the RebootWorkspaces operation.
|
597
|
+
#
|
598
|
+
# @!attribute [rw] failed_requests
|
599
|
+
# An array of structures representing any WorkSpaces that could not be
|
600
|
+
# rebooted.
|
601
|
+
# @return [Array<Types::FailedWorkspaceChangeRequest>]
|
602
|
+
#
|
603
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebootWorkspacesResult AWS API Documentation
|
604
|
+
#
|
605
|
+
class RebootWorkspacesResult < Struct.new(
|
606
|
+
:failed_requests)
|
607
|
+
include Aws::Structure
|
608
|
+
end
|
609
|
+
|
610
|
+
# Contains information used with the RebuildWorkspaces operation to
|
611
|
+
# rebuild a WorkSpace.
|
612
|
+
#
|
613
|
+
# @note When making an API call, you may pass RebuildRequest
|
614
|
+
# data as a hash:
|
615
|
+
#
|
616
|
+
# {
|
617
|
+
# workspace_id: "WorkspaceId", # required
|
618
|
+
# }
|
619
|
+
#
|
620
|
+
# @!attribute [rw] workspace_id
|
621
|
+
# The identifier of the WorkSpace to rebuild.
|
622
|
+
# @return [String]
|
623
|
+
#
|
624
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebuildRequest AWS API Documentation
|
625
|
+
#
|
626
|
+
class RebuildRequest < Struct.new(
|
627
|
+
:workspace_id)
|
628
|
+
include Aws::Structure
|
629
|
+
end
|
630
|
+
|
631
|
+
# Contains the inputs for the RebuildWorkspaces operation.
|
632
|
+
#
|
633
|
+
# @note When making an API call, you may pass RebuildWorkspacesRequest
|
634
|
+
# data as a hash:
|
635
|
+
#
|
636
|
+
# {
|
637
|
+
# rebuild_workspace_requests: [ # required
|
638
|
+
# {
|
639
|
+
# workspace_id: "WorkspaceId", # required
|
640
|
+
# },
|
641
|
+
# ],
|
642
|
+
# }
|
643
|
+
#
|
644
|
+
# @!attribute [rw] rebuild_workspace_requests
|
645
|
+
# An array of structures that specify the WorkSpaces to rebuild.
|
646
|
+
# @return [Array<Types::RebuildRequest>]
|
647
|
+
#
|
648
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebuildWorkspacesRequest AWS API Documentation
|
649
|
+
#
|
650
|
+
class RebuildWorkspacesRequest < Struct.new(
|
651
|
+
:rebuild_workspace_requests)
|
652
|
+
include Aws::Structure
|
653
|
+
end
|
654
|
+
|
655
|
+
# Contains the results of the RebuildWorkspaces operation.
|
656
|
+
#
|
657
|
+
# @!attribute [rw] failed_requests
|
658
|
+
# An array of structures representing any WorkSpaces that could not be
|
659
|
+
# rebuilt.
|
660
|
+
# @return [Array<Types::FailedWorkspaceChangeRequest>]
|
661
|
+
#
|
662
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebuildWorkspacesResult AWS API Documentation
|
663
|
+
#
|
664
|
+
class RebuildWorkspacesResult < Struct.new(
|
665
|
+
:failed_requests)
|
666
|
+
include Aws::Structure
|
667
|
+
end
|
668
|
+
|
669
|
+
# Describes the start request.
|
670
|
+
#
|
671
|
+
# @note When making an API call, you may pass StartRequest
|
672
|
+
# data as a hash:
|
673
|
+
#
|
674
|
+
# {
|
675
|
+
# workspace_id: "WorkspaceId",
|
676
|
+
# }
|
677
|
+
#
|
678
|
+
# @!attribute [rw] workspace_id
|
679
|
+
# The ID of the WorkSpace.
|
680
|
+
# @return [String]
|
681
|
+
#
|
682
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StartRequest AWS API Documentation
|
683
|
+
#
|
684
|
+
class StartRequest < Struct.new(
|
685
|
+
:workspace_id)
|
686
|
+
include Aws::Structure
|
687
|
+
end
|
688
|
+
|
689
|
+
# @note When making an API call, you may pass StartWorkspacesRequest
|
690
|
+
# data as a hash:
|
691
|
+
#
|
692
|
+
# {
|
693
|
+
# start_workspace_requests: [ # required
|
694
|
+
# {
|
695
|
+
# workspace_id: "WorkspaceId",
|
696
|
+
# },
|
697
|
+
# ],
|
698
|
+
# }
|
699
|
+
#
|
700
|
+
# @!attribute [rw] start_workspace_requests
|
701
|
+
# The requests.
|
702
|
+
# @return [Array<Types::StartRequest>]
|
703
|
+
#
|
704
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StartWorkspacesRequest AWS API Documentation
|
705
|
+
#
|
706
|
+
class StartWorkspacesRequest < Struct.new(
|
707
|
+
:start_workspace_requests)
|
708
|
+
include Aws::Structure
|
709
|
+
end
|
710
|
+
|
711
|
+
# @!attribute [rw] failed_requests
|
712
|
+
# The failed requests.
|
713
|
+
# @return [Array<Types::FailedWorkspaceChangeRequest>]
|
714
|
+
#
|
715
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StartWorkspacesResult AWS API Documentation
|
716
|
+
#
|
717
|
+
class StartWorkspacesResult < Struct.new(
|
718
|
+
:failed_requests)
|
719
|
+
include Aws::Structure
|
720
|
+
end
|
721
|
+
|
722
|
+
# Describes the stop request.
|
723
|
+
#
|
724
|
+
# @note When making an API call, you may pass StopRequest
|
725
|
+
# data as a hash:
|
726
|
+
#
|
727
|
+
# {
|
728
|
+
# workspace_id: "WorkspaceId",
|
729
|
+
# }
|
730
|
+
#
|
731
|
+
# @!attribute [rw] workspace_id
|
732
|
+
# The ID of the WorkSpace.
|
733
|
+
# @return [String]
|
734
|
+
#
|
735
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StopRequest AWS API Documentation
|
736
|
+
#
|
737
|
+
class StopRequest < Struct.new(
|
738
|
+
:workspace_id)
|
739
|
+
include Aws::Structure
|
740
|
+
end
|
741
|
+
|
742
|
+
# @note When making an API call, you may pass StopWorkspacesRequest
|
743
|
+
# data as a hash:
|
744
|
+
#
|
745
|
+
# {
|
746
|
+
# stop_workspace_requests: [ # required
|
747
|
+
# {
|
748
|
+
# workspace_id: "WorkspaceId",
|
749
|
+
# },
|
750
|
+
# ],
|
751
|
+
# }
|
752
|
+
#
|
753
|
+
# @!attribute [rw] stop_workspace_requests
|
754
|
+
# The requests.
|
755
|
+
# @return [Array<Types::StopRequest>]
|
756
|
+
#
|
757
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StopWorkspacesRequest AWS API Documentation
|
758
|
+
#
|
759
|
+
class StopWorkspacesRequest < Struct.new(
|
760
|
+
:stop_workspace_requests)
|
761
|
+
include Aws::Structure
|
762
|
+
end
|
763
|
+
|
764
|
+
# @!attribute [rw] failed_requests
|
765
|
+
# The failed requests.
|
766
|
+
# @return [Array<Types::FailedWorkspaceChangeRequest>]
|
767
|
+
#
|
768
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StopWorkspacesResult AWS API Documentation
|
769
|
+
#
|
770
|
+
class StopWorkspacesResult < Struct.new(
|
771
|
+
:failed_requests)
|
772
|
+
include Aws::Structure
|
773
|
+
end
|
774
|
+
|
775
|
+
# Describes the tag of the WorkSpace.
|
776
|
+
#
|
777
|
+
# @note When making an API call, you may pass Tag
|
778
|
+
# data as a hash:
|
779
|
+
#
|
780
|
+
# {
|
781
|
+
# key: "TagKey", # required
|
782
|
+
# value: "TagValue",
|
783
|
+
# }
|
784
|
+
#
|
785
|
+
# @!attribute [rw] key
|
786
|
+
# The key of the tag.
|
787
|
+
# @return [String]
|
788
|
+
#
|
789
|
+
# @!attribute [rw] value
|
790
|
+
# The value of the tag.
|
791
|
+
# @return [String]
|
792
|
+
#
|
793
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/Tag AWS API Documentation
|
794
|
+
#
|
795
|
+
class Tag < Struct.new(
|
796
|
+
:key,
|
797
|
+
:value)
|
798
|
+
include Aws::Structure
|
799
|
+
end
|
800
|
+
|
801
|
+
# Contains information used with the TerminateWorkspaces operation to
|
802
|
+
# terminate a WorkSpace.
|
803
|
+
#
|
804
|
+
# @note When making an API call, you may pass TerminateRequest
|
805
|
+
# data as a hash:
|
806
|
+
#
|
807
|
+
# {
|
808
|
+
# workspace_id: "WorkspaceId", # required
|
809
|
+
# }
|
810
|
+
#
|
811
|
+
# @!attribute [rw] workspace_id
|
812
|
+
# The identifier of the WorkSpace to terminate.
|
813
|
+
# @return [String]
|
814
|
+
#
|
815
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/TerminateRequest AWS API Documentation
|
816
|
+
#
|
817
|
+
class TerminateRequest < Struct.new(
|
818
|
+
:workspace_id)
|
819
|
+
include Aws::Structure
|
820
|
+
end
|
821
|
+
|
822
|
+
# Contains the inputs for the TerminateWorkspaces operation.
|
823
|
+
#
|
824
|
+
# @note When making an API call, you may pass TerminateWorkspacesRequest
|
825
|
+
# data as a hash:
|
826
|
+
#
|
827
|
+
# {
|
828
|
+
# terminate_workspace_requests: [ # required
|
829
|
+
# {
|
830
|
+
# workspace_id: "WorkspaceId", # required
|
831
|
+
# },
|
832
|
+
# ],
|
833
|
+
# }
|
834
|
+
#
|
835
|
+
# @!attribute [rw] terminate_workspace_requests
|
836
|
+
# An array of structures that specify the WorkSpaces to terminate.
|
837
|
+
# @return [Array<Types::TerminateRequest>]
|
838
|
+
#
|
839
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/TerminateWorkspacesRequest AWS API Documentation
|
840
|
+
#
|
841
|
+
class TerminateWorkspacesRequest < Struct.new(
|
842
|
+
:terminate_workspace_requests)
|
843
|
+
include Aws::Structure
|
844
|
+
end
|
845
|
+
|
846
|
+
# Contains the results of the TerminateWorkspaces operation.
|
847
|
+
#
|
848
|
+
# @!attribute [rw] failed_requests
|
849
|
+
# An array of structures representing any WorkSpaces that could not be
|
850
|
+
# terminated.
|
851
|
+
# @return [Array<Types::FailedWorkspaceChangeRequest>]
|
852
|
+
#
|
853
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/TerminateWorkspacesResult AWS API Documentation
|
854
|
+
#
|
855
|
+
class TerminateWorkspacesResult < Struct.new(
|
856
|
+
:failed_requests)
|
857
|
+
include Aws::Structure
|
858
|
+
end
|
859
|
+
|
860
|
+
# Contains information about the user storage for a WorkSpace bundle.
|
861
|
+
#
|
862
|
+
# @!attribute [rw] capacity
|
863
|
+
# The amount of user storage for the bundle.
|
864
|
+
# @return [String]
|
865
|
+
#
|
866
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UserStorage AWS API Documentation
|
867
|
+
#
|
868
|
+
class UserStorage < Struct.new(
|
869
|
+
:capacity)
|
870
|
+
include Aws::Structure
|
871
|
+
end
|
872
|
+
|
873
|
+
# Contains information about a WorkSpace.
|
874
|
+
#
|
875
|
+
# @!attribute [rw] workspace_id
|
876
|
+
# The identifier of the WorkSpace.
|
877
|
+
# @return [String]
|
878
|
+
#
|
879
|
+
# @!attribute [rw] directory_id
|
880
|
+
# The identifier of the AWS Directory Service directory that the
|
881
|
+
# WorkSpace belongs to.
|
882
|
+
# @return [String]
|
883
|
+
#
|
884
|
+
# @!attribute [rw] user_name
|
885
|
+
# The user that the WorkSpace is assigned to.
|
886
|
+
# @return [String]
|
887
|
+
#
|
888
|
+
# @!attribute [rw] ip_address
|
889
|
+
# The IP address of the WorkSpace.
|
890
|
+
# @return [String]
|
891
|
+
#
|
892
|
+
# @!attribute [rw] state
|
893
|
+
# The operational state of the WorkSpace.
|
894
|
+
# @return [String]
|
895
|
+
#
|
896
|
+
# @!attribute [rw] bundle_id
|
897
|
+
# The identifier of the bundle that the WorkSpace was created from.
|
898
|
+
# @return [String]
|
899
|
+
#
|
900
|
+
# @!attribute [rw] subnet_id
|
901
|
+
# The identifier of the subnet that the WorkSpace is in.
|
902
|
+
# @return [String]
|
903
|
+
#
|
904
|
+
# @!attribute [rw] error_message
|
905
|
+
# If the WorkSpace could not be created, this contains a textual error
|
906
|
+
# message that describes the failure.
|
907
|
+
# @return [String]
|
908
|
+
#
|
909
|
+
# @!attribute [rw] error_code
|
910
|
+
# If the WorkSpace could not be created, this contains the error code.
|
911
|
+
# @return [String]
|
912
|
+
#
|
913
|
+
# @!attribute [rw] computer_name
|
914
|
+
# The name of the WorkSpace as seen by the operating system.
|
915
|
+
# @return [String]
|
916
|
+
#
|
917
|
+
# @!attribute [rw] volume_encryption_key
|
918
|
+
# The KMS key used to encrypt data stored on your WorkSpace.
|
919
|
+
# @return [String]
|
920
|
+
#
|
921
|
+
# @!attribute [rw] user_volume_encryption_enabled
|
922
|
+
# Specifies whether the data stored on the user volume, or D: drive,
|
923
|
+
# is encrypted.
|
924
|
+
# @return [Boolean]
|
925
|
+
#
|
926
|
+
# @!attribute [rw] root_volume_encryption_enabled
|
927
|
+
# Specifies whether the data stored on the root volume, or C: drive,
|
928
|
+
# is encrypted.
|
929
|
+
# @return [Boolean]
|
930
|
+
#
|
931
|
+
# @!attribute [rw] workspace_properties
|
932
|
+
# Describes the properties of a WorkSpace.
|
933
|
+
# @return [Types::WorkspaceProperties]
|
934
|
+
#
|
935
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/Workspace AWS API Documentation
|
936
|
+
#
|
937
|
+
class Workspace < Struct.new(
|
938
|
+
:workspace_id,
|
939
|
+
:directory_id,
|
940
|
+
:user_name,
|
941
|
+
:ip_address,
|
942
|
+
:state,
|
943
|
+
:bundle_id,
|
944
|
+
:subnet_id,
|
945
|
+
:error_message,
|
946
|
+
:error_code,
|
947
|
+
:computer_name,
|
948
|
+
:volume_encryption_key,
|
949
|
+
:user_volume_encryption_enabled,
|
950
|
+
:root_volume_encryption_enabled,
|
951
|
+
:workspace_properties)
|
952
|
+
include Aws::Structure
|
953
|
+
end
|
954
|
+
|
955
|
+
# Contains information about a WorkSpace bundle.
|
956
|
+
#
|
957
|
+
# @!attribute [rw] bundle_id
|
958
|
+
# The bundle identifier.
|
959
|
+
# @return [String]
|
960
|
+
#
|
961
|
+
# @!attribute [rw] name
|
962
|
+
# The name of the bundle.
|
963
|
+
# @return [String]
|
964
|
+
#
|
965
|
+
# @!attribute [rw] owner
|
966
|
+
# The owner of the bundle. This contains the owner's account
|
967
|
+
# identifier, or `AMAZON` if the bundle is provided by AWS.
|
968
|
+
# @return [String]
|
969
|
+
#
|
970
|
+
# @!attribute [rw] description
|
971
|
+
# The bundle description.
|
972
|
+
# @return [String]
|
973
|
+
#
|
974
|
+
# @!attribute [rw] user_storage
|
975
|
+
# A UserStorage object that specifies the amount of user storage that
|
976
|
+
# the bundle contains.
|
977
|
+
# @return [Types::UserStorage]
|
978
|
+
#
|
979
|
+
# @!attribute [rw] compute_type
|
980
|
+
# A ComputeType object that specifies the compute type for the bundle.
|
981
|
+
# @return [Types::ComputeType]
|
982
|
+
#
|
983
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceBundle AWS API Documentation
|
984
|
+
#
|
985
|
+
class WorkspaceBundle < Struct.new(
|
986
|
+
:bundle_id,
|
987
|
+
:name,
|
988
|
+
:owner,
|
989
|
+
:description,
|
990
|
+
:user_storage,
|
991
|
+
:compute_type)
|
992
|
+
include Aws::Structure
|
993
|
+
end
|
994
|
+
|
995
|
+
# Describes the connection status of a WorkSpace.
|
996
|
+
#
|
997
|
+
# @!attribute [rw] workspace_id
|
998
|
+
# The ID of the WorkSpace.
|
999
|
+
# @return [String]
|
1000
|
+
#
|
1001
|
+
# @!attribute [rw] connection_state
|
1002
|
+
# The connection state of the WorkSpace. Returns UNKOWN if the
|
1003
|
+
# WorkSpace is in a Stopped state.
|
1004
|
+
# @return [String]
|
1005
|
+
#
|
1006
|
+
# @!attribute [rw] connection_state_check_timestamp
|
1007
|
+
# The timestamp of the connection state check.
|
1008
|
+
# @return [Time]
|
1009
|
+
#
|
1010
|
+
# @!attribute [rw] last_known_user_connection_timestamp
|
1011
|
+
# The timestamp of the last known user connection.
|
1012
|
+
# @return [Time]
|
1013
|
+
#
|
1014
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceConnectionStatus AWS API Documentation
|
1015
|
+
#
|
1016
|
+
class WorkspaceConnectionStatus < Struct.new(
|
1017
|
+
:workspace_id,
|
1018
|
+
:connection_state,
|
1019
|
+
:connection_state_check_timestamp,
|
1020
|
+
:last_known_user_connection_timestamp)
|
1021
|
+
include Aws::Structure
|
1022
|
+
end
|
1023
|
+
|
1024
|
+
# Contains information about an AWS Directory Service directory for use
|
1025
|
+
# with Amazon WorkSpaces.
|
1026
|
+
#
|
1027
|
+
# @!attribute [rw] directory_id
|
1028
|
+
# The directory identifier.
|
1029
|
+
# @return [String]
|
1030
|
+
#
|
1031
|
+
# @!attribute [rw] alias
|
1032
|
+
# The directory alias.
|
1033
|
+
# @return [String]
|
1034
|
+
#
|
1035
|
+
# @!attribute [rw] directory_name
|
1036
|
+
# The name of the directory.
|
1037
|
+
# @return [String]
|
1038
|
+
#
|
1039
|
+
# @!attribute [rw] registration_code
|
1040
|
+
# The registration code for the directory. This is the code that users
|
1041
|
+
# enter in their Amazon WorkSpaces client application to connect to
|
1042
|
+
# the directory.
|
1043
|
+
# @return [String]
|
1044
|
+
#
|
1045
|
+
# @!attribute [rw] subnet_ids
|
1046
|
+
# An array of strings that contains the identifiers of the subnets
|
1047
|
+
# used with the directory.
|
1048
|
+
# @return [Array<String>]
|
1049
|
+
#
|
1050
|
+
# @!attribute [rw] dns_ip_addresses
|
1051
|
+
# An array of strings that contains the IP addresses of the DNS
|
1052
|
+
# servers for the directory.
|
1053
|
+
# @return [Array<String>]
|
1054
|
+
#
|
1055
|
+
# @!attribute [rw] customer_user_name
|
1056
|
+
# The user name for the service account.
|
1057
|
+
# @return [String]
|
1058
|
+
#
|
1059
|
+
# @!attribute [rw] iam_role_id
|
1060
|
+
# The identifier of the IAM role. This is the role that allows Amazon
|
1061
|
+
# WorkSpaces to make calls to other services, such as Amazon EC2, on
|
1062
|
+
# your behalf.
|
1063
|
+
# @return [String]
|
1064
|
+
#
|
1065
|
+
# @!attribute [rw] directory_type
|
1066
|
+
# The directory type.
|
1067
|
+
# @return [String]
|
1068
|
+
#
|
1069
|
+
# @!attribute [rw] workspace_security_group_id
|
1070
|
+
# The identifier of the security group that is assigned to new
|
1071
|
+
# WorkSpaces.
|
1072
|
+
# @return [String]
|
1073
|
+
#
|
1074
|
+
# @!attribute [rw] state
|
1075
|
+
# The state of the directory's registration with Amazon WorkSpaces
|
1076
|
+
# @return [String]
|
1077
|
+
#
|
1078
|
+
# @!attribute [rw] workspace_creation_properties
|
1079
|
+
# A structure that specifies the default creation properties for all
|
1080
|
+
# WorkSpaces in the directory.
|
1081
|
+
# @return [Types::DefaultWorkspaceCreationProperties]
|
1082
|
+
#
|
1083
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceDirectory AWS API Documentation
|
1084
|
+
#
|
1085
|
+
class WorkspaceDirectory < Struct.new(
|
1086
|
+
:directory_id,
|
1087
|
+
:alias,
|
1088
|
+
:directory_name,
|
1089
|
+
:registration_code,
|
1090
|
+
:subnet_ids,
|
1091
|
+
:dns_ip_addresses,
|
1092
|
+
:customer_user_name,
|
1093
|
+
:iam_role_id,
|
1094
|
+
:directory_type,
|
1095
|
+
:workspace_security_group_id,
|
1096
|
+
:state,
|
1097
|
+
:workspace_creation_properties)
|
1098
|
+
include Aws::Structure
|
1099
|
+
end
|
1100
|
+
|
1101
|
+
# Describes the properties of a WorkSpace.
|
1102
|
+
#
|
1103
|
+
# @note When making an API call, you may pass WorkspaceProperties
|
1104
|
+
# data as a hash:
|
1105
|
+
#
|
1106
|
+
# {
|
1107
|
+
# running_mode: "AUTO_STOP", # accepts AUTO_STOP, ALWAYS_ON
|
1108
|
+
# running_mode_auto_stop_timeout_in_minutes: 1,
|
1109
|
+
# }
|
1110
|
+
#
|
1111
|
+
# @!attribute [rw] running_mode
|
1112
|
+
# The running mode of the WorkSpace. AlwaysOn WorkSpaces are billed
|
1113
|
+
# monthly. AutoStop WorkSpaces are billed by the hour and stopped when
|
1114
|
+
# no longer being used in order to save on costs.
|
1115
|
+
# @return [String]
|
1116
|
+
#
|
1117
|
+
# @!attribute [rw] running_mode_auto_stop_timeout_in_minutes
|
1118
|
+
# The time after a user logs off when WorkSpaces are automatically
|
1119
|
+
# stopped. Configured in 60 minute intervals.
|
1120
|
+
# @return [Integer]
|
1121
|
+
#
|
1122
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceProperties AWS API Documentation
|
1123
|
+
#
|
1124
|
+
class WorkspaceProperties < Struct.new(
|
1125
|
+
:running_mode,
|
1126
|
+
:running_mode_auto_stop_timeout_in_minutes)
|
1127
|
+
include Aws::Structure
|
1128
|
+
end
|
1129
|
+
|
1130
|
+
# Contains information about a WorkSpace creation request.
|
1131
|
+
#
|
1132
|
+
# @note When making an API call, you may pass WorkspaceRequest
|
1133
|
+
# data as a hash:
|
1134
|
+
#
|
1135
|
+
# {
|
1136
|
+
# directory_id: "DirectoryId", # required
|
1137
|
+
# user_name: "UserName", # required
|
1138
|
+
# bundle_id: "BundleId", # required
|
1139
|
+
# volume_encryption_key: "VolumeEncryptionKey",
|
1140
|
+
# user_volume_encryption_enabled: false,
|
1141
|
+
# root_volume_encryption_enabled: false,
|
1142
|
+
# workspace_properties: {
|
1143
|
+
# running_mode: "AUTO_STOP", # accepts AUTO_STOP, ALWAYS_ON
|
1144
|
+
# running_mode_auto_stop_timeout_in_minutes: 1,
|
1145
|
+
# },
|
1146
|
+
# tags: [
|
1147
|
+
# {
|
1148
|
+
# key: "TagKey", # required
|
1149
|
+
# value: "TagValue",
|
1150
|
+
# },
|
1151
|
+
# ],
|
1152
|
+
# }
|
1153
|
+
#
|
1154
|
+
# @!attribute [rw] directory_id
|
1155
|
+
# The identifier of the AWS Directory Service directory to create the
|
1156
|
+
# WorkSpace in. You can use the DescribeWorkspaceDirectories operation
|
1157
|
+
# to obtain a list of the directories that are available.
|
1158
|
+
# @return [String]
|
1159
|
+
#
|
1160
|
+
# @!attribute [rw] user_name
|
1161
|
+
# The username that the WorkSpace is assigned to. This username must
|
1162
|
+
# exist in the AWS Directory Service directory specified by the
|
1163
|
+
# `DirectoryId` member.
|
1164
|
+
# @return [String]
|
1165
|
+
#
|
1166
|
+
# @!attribute [rw] bundle_id
|
1167
|
+
# The identifier of the bundle to create the WorkSpace from. You can
|
1168
|
+
# use the DescribeWorkspaceBundles operation to obtain a list of the
|
1169
|
+
# bundles that are available.
|
1170
|
+
# @return [String]
|
1171
|
+
#
|
1172
|
+
# @!attribute [rw] volume_encryption_key
|
1173
|
+
# The KMS key used to encrypt data stored on your WorkSpace.
|
1174
|
+
# @return [String]
|
1175
|
+
#
|
1176
|
+
# @!attribute [rw] user_volume_encryption_enabled
|
1177
|
+
# Specifies whether the data stored on the user volume, or D: drive,
|
1178
|
+
# is encrypted.
|
1179
|
+
# @return [Boolean]
|
1180
|
+
#
|
1181
|
+
# @!attribute [rw] root_volume_encryption_enabled
|
1182
|
+
# Specifies whether the data stored on the root volume, or C: drive,
|
1183
|
+
# is encrypted.
|
1184
|
+
# @return [Boolean]
|
1185
|
+
#
|
1186
|
+
# @!attribute [rw] workspace_properties
|
1187
|
+
# Describes the properties of a WorkSpace.
|
1188
|
+
# @return [Types::WorkspaceProperties]
|
1189
|
+
#
|
1190
|
+
# @!attribute [rw] tags
|
1191
|
+
# The tags of the WorkSpace request.
|
1192
|
+
# @return [Array<Types::Tag>]
|
1193
|
+
#
|
1194
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceRequest AWS API Documentation
|
1195
|
+
#
|
1196
|
+
class WorkspaceRequest < Struct.new(
|
1197
|
+
:directory_id,
|
1198
|
+
:user_name,
|
1199
|
+
:bundle_id,
|
1200
|
+
:volume_encryption_key,
|
1201
|
+
:user_volume_encryption_enabled,
|
1202
|
+
:root_volume_encryption_enabled,
|
1203
|
+
:workspace_properties,
|
1204
|
+
:tags)
|
1205
|
+
include Aws::Structure
|
1206
|
+
end
|
1207
|
+
|
1019
1208
|
end
|
1020
1209
|
end
|