aws-sdk-workspaces 1.0.0 → 1.1.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 +4 -4
- data/lib/aws-sdk-workspaces.rb +1 -1
- data/lib/aws-sdk-workspaces/client.rb +101 -117
- data/lib/aws-sdk-workspaces/client_api.rb +21 -0
- data/lib/aws-sdk-workspaces/types.rb +216 -204
- metadata +5 -3
@@ -61,6 +61,10 @@ module Aws::WorkSpaces
|
|
61
61
|
InvalidResourceStateException = Shapes::StructureShape.new(name: 'InvalidResourceStateException')
|
62
62
|
IpAddress = Shapes::StringShape.new(name: 'IpAddress')
|
63
63
|
Limit = Shapes::IntegerShape.new(name: 'Limit')
|
64
|
+
ModificationResourceEnum = Shapes::StringShape.new(name: 'ModificationResourceEnum')
|
65
|
+
ModificationState = Shapes::StructureShape.new(name: 'ModificationState')
|
66
|
+
ModificationStateEnum = Shapes::StringShape.new(name: 'ModificationStateEnum')
|
67
|
+
ModificationStateList = Shapes::ListShape.new(name: 'ModificationStateList')
|
64
68
|
ModifyWorkspacePropertiesRequest = Shapes::StructureShape.new(name: 'ModifyWorkspacePropertiesRequest')
|
65
69
|
ModifyWorkspacePropertiesResult = Shapes::StructureShape.new(name: 'ModifyWorkspacePropertiesResult')
|
66
70
|
NonEmptyString = Shapes::StringShape.new(name: 'NonEmptyString')
|
@@ -78,6 +82,8 @@ module Aws::WorkSpaces
|
|
78
82
|
ResourceLimitExceededException = Shapes::StructureShape.new(name: 'ResourceLimitExceededException')
|
79
83
|
ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
|
80
84
|
ResourceUnavailableException = Shapes::StructureShape.new(name: 'ResourceUnavailableException')
|
85
|
+
RootStorage = Shapes::StructureShape.new(name: 'RootStorage')
|
86
|
+
RootVolumeSizeGib = Shapes::IntegerShape.new(name: 'RootVolumeSizeGib')
|
81
87
|
RunningMode = Shapes::StringShape.new(name: 'RunningMode')
|
82
88
|
RunningModeAutoStopTimeoutInMinutes = Shapes::IntegerShape.new(name: 'RunningModeAutoStopTimeoutInMinutes')
|
83
89
|
SecurityGroupId = Shapes::StringShape.new(name: 'SecurityGroupId')
|
@@ -104,6 +110,7 @@ module Aws::WorkSpaces
|
|
104
110
|
UnsupportedWorkspaceConfigurationException = Shapes::StructureShape.new(name: 'UnsupportedWorkspaceConfigurationException')
|
105
111
|
UserName = Shapes::StringShape.new(name: 'UserName')
|
106
112
|
UserStorage = Shapes::StructureShape.new(name: 'UserStorage')
|
113
|
+
UserVolumeSizeGib = Shapes::IntegerShape.new(name: 'UserVolumeSizeGib')
|
107
114
|
VolumeEncryptionKey = Shapes::StringShape.new(name: 'VolumeEncryptionKey')
|
108
115
|
Workspace = Shapes::StructureShape.new(name: 'Workspace')
|
109
116
|
WorkspaceBundle = Shapes::StructureShape.new(name: 'WorkspaceBundle')
|
@@ -225,6 +232,12 @@ module Aws::WorkSpaces
|
|
225
232
|
FailedWorkspaceChangeRequest.add_member(:error_message, Shapes::ShapeRef.new(shape: Description, location_name: "ErrorMessage"))
|
226
233
|
FailedWorkspaceChangeRequest.struct_class = Types::FailedWorkspaceChangeRequest
|
227
234
|
|
235
|
+
ModificationState.add_member(:resource, Shapes::ShapeRef.new(shape: ModificationResourceEnum, location_name: "Resource"))
|
236
|
+
ModificationState.add_member(:state, Shapes::ShapeRef.new(shape: ModificationStateEnum, location_name: "State"))
|
237
|
+
ModificationState.struct_class = Types::ModificationState
|
238
|
+
|
239
|
+
ModificationStateList.member = Shapes::ShapeRef.new(shape: ModificationState)
|
240
|
+
|
228
241
|
ModifyWorkspacePropertiesRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location_name: "WorkspaceId"))
|
229
242
|
ModifyWorkspacePropertiesRequest.add_member(:workspace_properties, Shapes::ShapeRef.new(shape: WorkspaceProperties, required: true, location_name: "WorkspaceProperties"))
|
230
243
|
ModifyWorkspacePropertiesRequest.struct_class = Types::ModifyWorkspacePropertiesRequest
|
@@ -253,6 +266,9 @@ module Aws::WorkSpaces
|
|
253
266
|
RebuildWorkspacesResult.add_member(:failed_requests, Shapes::ShapeRef.new(shape: FailedRebuildWorkspaceRequests, location_name: "FailedRequests"))
|
254
267
|
RebuildWorkspacesResult.struct_class = Types::RebuildWorkspacesResult
|
255
268
|
|
269
|
+
RootStorage.add_member(:capacity, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "Capacity"))
|
270
|
+
RootStorage.struct_class = Types::RootStorage
|
271
|
+
|
256
272
|
StartRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, location_name: "WorkspaceId"))
|
257
273
|
StartRequest.struct_class = Types::StartRequest
|
258
274
|
|
@@ -313,12 +329,14 @@ module Aws::WorkSpaces
|
|
313
329
|
Workspace.add_member(:user_volume_encryption_enabled, Shapes::ShapeRef.new(shape: BooleanObject, location_name: "UserVolumeEncryptionEnabled"))
|
314
330
|
Workspace.add_member(:root_volume_encryption_enabled, Shapes::ShapeRef.new(shape: BooleanObject, location_name: "RootVolumeEncryptionEnabled"))
|
315
331
|
Workspace.add_member(:workspace_properties, Shapes::ShapeRef.new(shape: WorkspaceProperties, location_name: "WorkspaceProperties"))
|
332
|
+
Workspace.add_member(:modification_states, Shapes::ShapeRef.new(shape: ModificationStateList, location_name: "ModificationStates"))
|
316
333
|
Workspace.struct_class = Types::Workspace
|
317
334
|
|
318
335
|
WorkspaceBundle.add_member(:bundle_id, Shapes::ShapeRef.new(shape: BundleId, location_name: "BundleId"))
|
319
336
|
WorkspaceBundle.add_member(:name, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "Name"))
|
320
337
|
WorkspaceBundle.add_member(:owner, Shapes::ShapeRef.new(shape: BundleOwner, location_name: "Owner"))
|
321
338
|
WorkspaceBundle.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
|
339
|
+
WorkspaceBundle.add_member(:root_storage, Shapes::ShapeRef.new(shape: RootStorage, location_name: "RootStorage"))
|
322
340
|
WorkspaceBundle.add_member(:user_storage, Shapes::ShapeRef.new(shape: UserStorage, location_name: "UserStorage"))
|
323
341
|
WorkspaceBundle.add_member(:compute_type, Shapes::ShapeRef.new(shape: ComputeType, location_name: "ComputeType"))
|
324
342
|
WorkspaceBundle.struct_class = Types::WorkspaceBundle
|
@@ -351,6 +369,9 @@ module Aws::WorkSpaces
|
|
351
369
|
|
352
370
|
WorkspaceProperties.add_member(:running_mode, Shapes::ShapeRef.new(shape: RunningMode, location_name: "RunningMode"))
|
353
371
|
WorkspaceProperties.add_member(:running_mode_auto_stop_timeout_in_minutes, Shapes::ShapeRef.new(shape: RunningModeAutoStopTimeoutInMinutes, location_name: "RunningModeAutoStopTimeoutInMinutes"))
|
372
|
+
WorkspaceProperties.add_member(:root_volume_size_gib, Shapes::ShapeRef.new(shape: RootVolumeSizeGib, location_name: "RootVolumeSizeGib"))
|
373
|
+
WorkspaceProperties.add_member(:user_volume_size_gib, Shapes::ShapeRef.new(shape: UserVolumeSizeGib, location_name: "UserVolumeSizeGib"))
|
374
|
+
WorkspaceProperties.add_member(:compute_type_name, Shapes::ShapeRef.new(shape: Compute, location_name: "ComputeTypeName"))
|
354
375
|
WorkspaceProperties.struct_class = Types::WorkspaceProperties
|
355
376
|
|
356
377
|
WorkspaceRequest.add_member(:directory_id, Shapes::ShapeRef.new(shape: DirectoryId, required: true, location_name: "DirectoryId"))
|
@@ -8,10 +8,10 @@
|
|
8
8
|
module Aws::WorkSpaces
|
9
9
|
module Types
|
10
10
|
|
11
|
-
#
|
11
|
+
# Information about the compute type.
|
12
12
|
#
|
13
13
|
# @!attribute [rw] name
|
14
|
-
# The
|
14
|
+
# The compute type.
|
15
15
|
# @return [String]
|
16
16
|
#
|
17
17
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ComputeType AWS API Documentation
|
@@ -21,8 +21,6 @@ module Aws::WorkSpaces
|
|
21
21
|
include Aws::Structure
|
22
22
|
end
|
23
23
|
|
24
|
-
# The request of the CreateTags operation.
|
25
|
-
#
|
26
24
|
# @note When making an API call, you may pass CreateTagsRequest
|
27
25
|
# data as a hash:
|
28
26
|
#
|
@@ -37,11 +35,11 @@ module Aws::WorkSpaces
|
|
37
35
|
# }
|
38
36
|
#
|
39
37
|
# @!attribute [rw] resource_id
|
40
|
-
# The
|
38
|
+
# The ID of the resource.
|
41
39
|
# @return [String]
|
42
40
|
#
|
43
41
|
# @!attribute [rw] tags
|
44
|
-
# The tags of
|
42
|
+
# The tags. Each resource can have a maximum of 50 tags.
|
45
43
|
# @return [Array<Types::Tag>]
|
46
44
|
#
|
47
45
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateTagsRequest AWS API Documentation
|
@@ -52,14 +50,10 @@ module Aws::WorkSpaces
|
|
52
50
|
include Aws::Structure
|
53
51
|
end
|
54
52
|
|
55
|
-
# The result of the CreateTags operation.
|
56
|
-
#
|
57
53
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateTagsResult AWS API Documentation
|
58
54
|
#
|
59
55
|
class CreateTagsResult < Aws::EmptyStructure; end
|
60
56
|
|
61
|
-
# Contains the inputs for the CreateWorkspaces operation.
|
62
|
-
#
|
63
57
|
# @note When making an API call, you may pass CreateWorkspacesRequest
|
64
58
|
# data as a hash:
|
65
59
|
#
|
@@ -75,6 +69,9 @@ module Aws::WorkSpaces
|
|
75
69
|
# workspace_properties: {
|
76
70
|
# running_mode: "AUTO_STOP", # accepts AUTO_STOP, ALWAYS_ON
|
77
71
|
# running_mode_auto_stop_timeout_in_minutes: 1,
|
72
|
+
# root_volume_size_gib: 1,
|
73
|
+
# user_volume_size_gib: 1,
|
74
|
+
# compute_type_name: "VALUE", # accepts VALUE, STANDARD, PERFORMANCE, POWER, GRAPHICS
|
78
75
|
# },
|
79
76
|
# tags: [
|
80
77
|
# {
|
@@ -87,7 +84,7 @@ module Aws::WorkSpaces
|
|
87
84
|
# }
|
88
85
|
#
|
89
86
|
# @!attribute [rw] workspaces
|
90
|
-
#
|
87
|
+
# Information about the WorkSpaces to create.
|
91
88
|
# @return [Array<Types::WorkspaceRequest>]
|
92
89
|
#
|
93
90
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspacesRequest AWS API Documentation
|
@@ -97,21 +94,17 @@ module Aws::WorkSpaces
|
|
97
94
|
include Aws::Structure
|
98
95
|
end
|
99
96
|
|
100
|
-
# Contains the result of the CreateWorkspaces operation.
|
101
|
-
#
|
102
97
|
# @!attribute [rw] failed_requests
|
103
|
-
#
|
104
|
-
# be created.
|
98
|
+
# Information about the WorkSpaces that could not be created.
|
105
99
|
# @return [Array<Types::FailedCreateWorkspaceRequest>]
|
106
100
|
#
|
107
101
|
# @!attribute [rw] pending_requests
|
108
|
-
#
|
109
|
-
# created.
|
102
|
+
# Information about the WorkSpaces that were created.
|
110
103
|
#
|
111
|
-
# Because this operation is asynchronous, the identifier
|
112
|
-
#
|
113
|
-
#
|
114
|
-
# returned.
|
104
|
+
# Because this operation is asynchronous, the identifier returned is
|
105
|
+
# not immediately available for use with other operations. For
|
106
|
+
# example, if you call DescribeWorkspaces before the WorkSpace is
|
107
|
+
# created, the information returned can be incomplete.
|
115
108
|
# @return [Array<Types::Workspace>]
|
116
109
|
#
|
117
110
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspacesResult AWS API Documentation
|
@@ -122,29 +115,30 @@ module Aws::WorkSpaces
|
|
122
115
|
include Aws::Structure
|
123
116
|
end
|
124
117
|
|
125
|
-
#
|
118
|
+
# Information about defaults used to create a WorkSpace.
|
126
119
|
#
|
127
120
|
# @!attribute [rw] enable_work_docs
|
128
|
-
#
|
121
|
+
# Indicates whether the directory is enabled for Amazon WorkDocs.
|
129
122
|
# @return [Boolean]
|
130
123
|
#
|
131
124
|
# @!attribute [rw] enable_internet_access
|
132
|
-
#
|
133
|
-
#
|
125
|
+
# The public IP address to attach to all WorkSpaces that are created
|
126
|
+
# or rebuilt.
|
134
127
|
# @return [Boolean]
|
135
128
|
#
|
136
129
|
# @!attribute [rw] default_ou
|
137
|
-
# The organizational unit (OU) in the directory
|
138
|
-
# machine accounts
|
130
|
+
# The organizational unit (OU) in the directory for the WorkSpace
|
131
|
+
# machine accounts.
|
139
132
|
# @return [String]
|
140
133
|
#
|
141
134
|
# @!attribute [rw] custom_security_group_id
|
142
|
-
# The identifier of any
|
143
|
-
#
|
135
|
+
# The identifier of any security groups to apply to WorkSpaces when
|
136
|
+
# they are created.
|
144
137
|
# @return [String]
|
145
138
|
#
|
146
139
|
# @!attribute [rw] user_enabled_as_local_administrator
|
147
|
-
#
|
140
|
+
# Indicates whether the WorkSpace user is an administrator on the
|
141
|
+
# WorkSpace.
|
148
142
|
# @return [Boolean]
|
149
143
|
#
|
150
144
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DefaultWorkspaceCreationProperties AWS API Documentation
|
@@ -158,8 +152,6 @@ module Aws::WorkSpaces
|
|
158
152
|
include Aws::Structure
|
159
153
|
end
|
160
154
|
|
161
|
-
# The request of the DeleteTags operation.
|
162
|
-
#
|
163
155
|
# @note When making an API call, you may pass DeleteTagsRequest
|
164
156
|
# data as a hash:
|
165
157
|
#
|
@@ -169,11 +161,11 @@ module Aws::WorkSpaces
|
|
169
161
|
# }
|
170
162
|
#
|
171
163
|
# @!attribute [rw] resource_id
|
172
|
-
# The
|
164
|
+
# The ID of the resource.
|
173
165
|
# @return [String]
|
174
166
|
#
|
175
167
|
# @!attribute [rw] tag_keys
|
176
|
-
# The tag keys
|
168
|
+
# The tag keys.
|
177
169
|
# @return [Array<String>]
|
178
170
|
#
|
179
171
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteTagsRequest AWS API Documentation
|
@@ -184,14 +176,10 @@ module Aws::WorkSpaces
|
|
184
176
|
include Aws::Structure
|
185
177
|
end
|
186
178
|
|
187
|
-
# The result of the DeleteTags operation.
|
188
|
-
#
|
189
179
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteTagsResult AWS API Documentation
|
190
180
|
#
|
191
181
|
class DeleteTagsResult < Aws::EmptyStructure; end
|
192
182
|
|
193
|
-
# The request of the DescribeTags operation.
|
194
|
-
#
|
195
183
|
# @note When making an API call, you may pass DescribeTagsRequest
|
196
184
|
# data as a hash:
|
197
185
|
#
|
@@ -200,7 +188,7 @@ module Aws::WorkSpaces
|
|
200
188
|
# }
|
201
189
|
#
|
202
190
|
# @!attribute [rw] resource_id
|
203
|
-
# The
|
191
|
+
# The ID of the resource.
|
204
192
|
# @return [String]
|
205
193
|
#
|
206
194
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeTagsRequest AWS API Documentation
|
@@ -210,10 +198,8 @@ module Aws::WorkSpaces
|
|
210
198
|
include Aws::Structure
|
211
199
|
end
|
212
200
|
|
213
|
-
# The result of the DescribeTags operation.
|
214
|
-
#
|
215
201
|
# @!attribute [rw] tag_list
|
216
|
-
# The
|
202
|
+
# The tags.
|
217
203
|
# @return [Array<Types::Tag>]
|
218
204
|
#
|
219
205
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeTagsResult AWS API Documentation
|
@@ -223,8 +209,6 @@ module Aws::WorkSpaces
|
|
223
209
|
include Aws::Structure
|
224
210
|
end
|
225
211
|
|
226
|
-
# Contains the inputs for the DescribeWorkspaceBundles operation.
|
227
|
-
#
|
228
212
|
# @note When making an API call, you may pass DescribeWorkspaceBundlesRequest
|
229
213
|
# data as a hash:
|
230
214
|
#
|
@@ -235,26 +219,21 @@ module Aws::WorkSpaces
|
|
235
219
|
# }
|
236
220
|
#
|
237
221
|
# @!attribute [rw] bundle_ids
|
238
|
-
#
|
239
|
-
#
|
240
|
-
# parameter.
|
222
|
+
# The IDs of the bundles. This parameter cannot be combined with any
|
223
|
+
# other filter.
|
241
224
|
# @return [Array<String>]
|
242
225
|
#
|
243
226
|
# @!attribute [rw] owner
|
244
|
-
# The owner of the bundles
|
245
|
-
#
|
246
|
-
#
|
247
|
-
# This contains one of the following values:
|
227
|
+
# The owner of the bundles. This parameter cannot be combined with any
|
228
|
+
# other filter.
|
248
229
|
#
|
249
|
-
#
|
250
|
-
#
|
251
|
-
#
|
252
|
-
# * `AMAZON`- Retrieves the bundles that are provided by AWS.
|
230
|
+
# Specify `AMAZON` to describe the bundles provided by AWS or null to
|
231
|
+
# describe the bundles that belong to your account.
|
253
232
|
# @return [String]
|
254
233
|
#
|
255
234
|
# @!attribute [rw] next_token
|
256
|
-
# The
|
257
|
-
#
|
235
|
+
# The token for the next set of results. (You received this token from
|
236
|
+
# a previous call.)
|
258
237
|
# @return [String]
|
259
238
|
#
|
260
239
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceBundlesRequest AWS API Documentation
|
@@ -266,17 +245,14 @@ module Aws::WorkSpaces
|
|
266
245
|
include Aws::Structure
|
267
246
|
end
|
268
247
|
|
269
|
-
# Contains the results of the DescribeWorkspaceBundles operation.
|
270
|
-
#
|
271
248
|
# @!attribute [rw] bundles
|
272
|
-
#
|
249
|
+
# Information about the bundles.
|
273
250
|
# @return [Array<Types::WorkspaceBundle>]
|
274
251
|
#
|
275
252
|
# @!attribute [rw] next_token
|
276
|
-
#
|
277
|
-
#
|
278
|
-
#
|
279
|
-
# must be used within that time frame.
|
253
|
+
# The token to use to retrieve the next set of results, or null if
|
254
|
+
# there are no more results available. This token is valid for one day
|
255
|
+
# and must be used within that time frame.
|
280
256
|
# @return [String]
|
281
257
|
#
|
282
258
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceBundlesResult AWS API Documentation
|
@@ -287,8 +263,6 @@ module Aws::WorkSpaces
|
|
287
263
|
include Aws::Structure
|
288
264
|
end
|
289
265
|
|
290
|
-
# Contains the inputs for the DescribeWorkspaceDirectories operation.
|
291
|
-
#
|
292
266
|
# @note When making an API call, you may pass DescribeWorkspaceDirectoriesRequest
|
293
267
|
# data as a hash:
|
294
268
|
#
|
@@ -298,14 +272,13 @@ module Aws::WorkSpaces
|
|
298
272
|
# }
|
299
273
|
#
|
300
274
|
# @!attribute [rw] directory_ids
|
301
|
-
#
|
302
|
-
#
|
303
|
-
# are retrieved.
|
275
|
+
# The identifiers of the directories. If the value is null, all
|
276
|
+
# directories are retrieved.
|
304
277
|
# @return [Array<String>]
|
305
278
|
#
|
306
279
|
# @!attribute [rw] next_token
|
307
|
-
# The
|
308
|
-
#
|
280
|
+
# The token for the next set of results. (You received this token from
|
281
|
+
# a previous call.)
|
309
282
|
# @return [String]
|
310
283
|
#
|
311
284
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceDirectoriesRequest AWS API Documentation
|
@@ -316,18 +289,14 @@ module Aws::WorkSpaces
|
|
316
289
|
include Aws::Structure
|
317
290
|
end
|
318
291
|
|
319
|
-
# Contains the results of the DescribeWorkspaceDirectories operation.
|
320
|
-
#
|
321
292
|
# @!attribute [rw] directories
|
322
|
-
#
|
323
|
-
# directories.
|
293
|
+
# Information about the directories.
|
324
294
|
# @return [Array<Types::WorkspaceDirectory>]
|
325
295
|
#
|
326
296
|
# @!attribute [rw] next_token
|
327
|
-
#
|
328
|
-
#
|
329
|
-
#
|
330
|
-
# must be used within that time frame.
|
297
|
+
# The token to use to retrieve the next set of results, or null if
|
298
|
+
# there are no more results available. This token is valid for one day
|
299
|
+
# and must be used within that time frame.
|
331
300
|
# @return [String]
|
332
301
|
#
|
333
302
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceDirectoriesResult AWS API Documentation
|
@@ -347,11 +316,12 @@ module Aws::WorkSpaces
|
|
347
316
|
# }
|
348
317
|
#
|
349
318
|
# @!attribute [rw] workspace_ids
|
350
|
-
#
|
319
|
+
# The identifiers of the WorkSpaces.
|
351
320
|
# @return [Array<String>]
|
352
321
|
#
|
353
322
|
# @!attribute [rw] next_token
|
354
|
-
# The next
|
323
|
+
# The token for the next set of results. (You received this token from
|
324
|
+
# a previous call.)
|
355
325
|
# @return [String]
|
356
326
|
#
|
357
327
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesConnectionStatusRequest AWS API Documentation
|
@@ -363,11 +333,12 @@ module Aws::WorkSpaces
|
|
363
333
|
end
|
364
334
|
|
365
335
|
# @!attribute [rw] workspaces_connection_status
|
366
|
-
#
|
336
|
+
# Information about the connection status of the WorkSpace.
|
367
337
|
# @return [Array<Types::WorkspaceConnectionStatus>]
|
368
338
|
#
|
369
339
|
# @!attribute [rw] next_token
|
370
|
-
# The next
|
340
|
+
# The token to use to retrieve the next set of results, or null if
|
341
|
+
# there are no more results available.
|
371
342
|
# @return [String]
|
372
343
|
#
|
373
344
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesConnectionStatusResult AWS API Documentation
|
@@ -378,8 +349,6 @@ module Aws::WorkSpaces
|
|
378
349
|
include Aws::Structure
|
379
350
|
end
|
380
351
|
|
381
|
-
# Contains the inputs for the DescribeWorkspaces operation.
|
382
|
-
#
|
383
352
|
# @note When making an API call, you may pass DescribeWorkspacesRequest
|
384
353
|
# data as a hash:
|
385
354
|
#
|
@@ -393,9 +362,8 @@ module Aws::WorkSpaces
|
|
393
362
|
# }
|
394
363
|
#
|
395
364
|
# @!attribute [rw] workspace_ids
|
396
|
-
#
|
397
|
-
#
|
398
|
-
# with any other filter parameter.
|
365
|
+
# The IDs of the WorkSpaces. This parameter cannot be combined with
|
366
|
+
# any other filter.
|
399
367
|
#
|
400
368
|
# Because the CreateWorkspaces operation is asynchronous, the
|
401
369
|
# identifier it returns is not immediately available. If you
|
@@ -404,21 +372,20 @@ module Aws::WorkSpaces
|
|
404
372
|
# @return [Array<String>]
|
405
373
|
#
|
406
374
|
# @!attribute [rw] directory_id
|
407
|
-
#
|
408
|
-
#
|
409
|
-
#
|
410
|
-
# other filter parameter.
|
375
|
+
# The ID of the directory. In addition, you can optionally specify a
|
376
|
+
# specific directory user (see `UserName`). This parameter cannot be
|
377
|
+
# combined with any other filter.
|
411
378
|
# @return [String]
|
412
379
|
#
|
413
380
|
# @!attribute [rw] user_name
|
414
|
-
#
|
415
|
-
#
|
381
|
+
# The name of the directory user. You must specify this parameter with
|
382
|
+
# `DirectoryId`.
|
416
383
|
# @return [String]
|
417
384
|
#
|
418
385
|
# @!attribute [rw] bundle_id
|
419
|
-
# The
|
420
|
-
#
|
421
|
-
#
|
386
|
+
# The ID of the bundle. All WorkSpaces that are created from this
|
387
|
+
# bundle are retrieved. This parameter cannot be combined with any
|
388
|
+
# other filter.
|
422
389
|
# @return [String]
|
423
390
|
#
|
424
391
|
# @!attribute [rw] limit
|
@@ -426,8 +393,8 @@ module Aws::WorkSpaces
|
|
426
393
|
# @return [Integer]
|
427
394
|
#
|
428
395
|
# @!attribute [rw] next_token
|
429
|
-
# The
|
430
|
-
#
|
396
|
+
# The token for the next set of results. (You received this token from
|
397
|
+
# a previous call.)
|
431
398
|
# @return [String]
|
432
399
|
#
|
433
400
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesRequest AWS API Documentation
|
@@ -442,21 +409,17 @@ module Aws::WorkSpaces
|
|
442
409
|
include Aws::Structure
|
443
410
|
end
|
444
411
|
|
445
|
-
# Contains the results for the DescribeWorkspaces operation.
|
446
|
-
#
|
447
412
|
# @!attribute [rw] workspaces
|
448
|
-
#
|
449
|
-
# WorkSpaces.
|
413
|
+
# Information about the WorkSpaces.
|
450
414
|
#
|
451
|
-
# Because
|
452
|
-
# information
|
415
|
+
# Because CreateWorkspaces is an asynchronous operation, some of the
|
416
|
+
# returned information could be incomplete.
|
453
417
|
# @return [Array<Types::Workspace>]
|
454
418
|
#
|
455
419
|
# @!attribute [rw] next_token
|
456
|
-
#
|
457
|
-
#
|
458
|
-
#
|
459
|
-
# must be used within that time frame.
|
420
|
+
# The token to use to retrieve the next set of results, or null if
|
421
|
+
# there are no more results available. This token is valid for one day
|
422
|
+
# and must be used within that time frame.
|
460
423
|
# @return [String]
|
461
424
|
#
|
462
425
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesResult AWS API Documentation
|
@@ -467,11 +430,10 @@ module Aws::WorkSpaces
|
|
467
430
|
include Aws::Structure
|
468
431
|
end
|
469
432
|
|
470
|
-
#
|
433
|
+
# Information about a WorkSpace that could not be created.
|
471
434
|
#
|
472
435
|
# @!attribute [rw] workspace_request
|
473
|
-
#
|
474
|
-
# the information about the WorkSpace that could not be created.
|
436
|
+
# Information about the WorkSpace.
|
475
437
|
# @return [Types::WorkspaceRequest]
|
476
438
|
#
|
477
439
|
# @!attribute [rw] error_code
|
@@ -491,7 +453,7 @@ module Aws::WorkSpaces
|
|
491
453
|
include Aws::Structure
|
492
454
|
end
|
493
455
|
|
494
|
-
#
|
456
|
+
# Information about a WorkSpace that could not be rebooted
|
495
457
|
# (RebootWorkspaces), rebuilt (RebuildWorkspaces), terminated
|
496
458
|
# (TerminateWorkspaces), started (StartWorkspaces), or stopped
|
497
459
|
# (StopWorkspaces).
|
@@ -517,6 +479,24 @@ module Aws::WorkSpaces
|
|
517
479
|
include Aws::Structure
|
518
480
|
end
|
519
481
|
|
482
|
+
# Information about a WorkSpace modification.
|
483
|
+
#
|
484
|
+
# @!attribute [rw] resource
|
485
|
+
# The resource.
|
486
|
+
# @return [String]
|
487
|
+
#
|
488
|
+
# @!attribute [rw] state
|
489
|
+
# The modification state.
|
490
|
+
# @return [String]
|
491
|
+
#
|
492
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModificationState AWS API Documentation
|
493
|
+
#
|
494
|
+
class ModificationState < Struct.new(
|
495
|
+
:resource,
|
496
|
+
:state)
|
497
|
+
include Aws::Structure
|
498
|
+
end
|
499
|
+
|
520
500
|
# @note When making an API call, you may pass ModifyWorkspacePropertiesRequest
|
521
501
|
# data as a hash:
|
522
502
|
#
|
@@ -525,6 +505,9 @@ module Aws::WorkSpaces
|
|
525
505
|
# workspace_properties: { # required
|
526
506
|
# running_mode: "AUTO_STOP", # accepts AUTO_STOP, ALWAYS_ON
|
527
507
|
# running_mode_auto_stop_timeout_in_minutes: 1,
|
508
|
+
# root_volume_size_gib: 1,
|
509
|
+
# user_volume_size_gib: 1,
|
510
|
+
# compute_type_name: "VALUE", # accepts VALUE, STANDARD, PERFORMANCE, POWER, GRAPHICS
|
528
511
|
# },
|
529
512
|
# }
|
530
513
|
#
|
@@ -533,7 +516,7 @@ module Aws::WorkSpaces
|
|
533
516
|
# @return [String]
|
534
517
|
#
|
535
518
|
# @!attribute [rw] workspace_properties
|
536
|
-
# The
|
519
|
+
# The properties of the WorkSpace.
|
537
520
|
# @return [Types::WorkspaceProperties]
|
538
521
|
#
|
539
522
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspacePropertiesRequest AWS API Documentation
|
@@ -548,8 +531,7 @@ module Aws::WorkSpaces
|
|
548
531
|
#
|
549
532
|
class ModifyWorkspacePropertiesResult < Aws::EmptyStructure; end
|
550
533
|
|
551
|
-
#
|
552
|
-
# reboot a WorkSpace.
|
534
|
+
# Information used to reboot a WorkSpace.
|
553
535
|
#
|
554
536
|
# @note When making an API call, you may pass RebootRequest
|
555
537
|
# data as a hash:
|
@@ -559,7 +541,7 @@ module Aws::WorkSpaces
|
|
559
541
|
# }
|
560
542
|
#
|
561
543
|
# @!attribute [rw] workspace_id
|
562
|
-
# The identifier of the WorkSpace
|
544
|
+
# The identifier of the WorkSpace.
|
563
545
|
# @return [String]
|
564
546
|
#
|
565
547
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebootRequest AWS API Documentation
|
@@ -569,8 +551,6 @@ module Aws::WorkSpaces
|
|
569
551
|
include Aws::Structure
|
570
552
|
end
|
571
553
|
|
572
|
-
# Contains the inputs for the RebootWorkspaces operation.
|
573
|
-
#
|
574
554
|
# @note When making an API call, you may pass RebootWorkspacesRequest
|
575
555
|
# data as a hash:
|
576
556
|
#
|
@@ -583,7 +563,7 @@ module Aws::WorkSpaces
|
|
583
563
|
# }
|
584
564
|
#
|
585
565
|
# @!attribute [rw] reboot_workspace_requests
|
586
|
-
#
|
566
|
+
# The WorkSpaces to reboot.
|
587
567
|
# @return [Array<Types::RebootRequest>]
|
588
568
|
#
|
589
569
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebootWorkspacesRequest AWS API Documentation
|
@@ -593,11 +573,8 @@ module Aws::WorkSpaces
|
|
593
573
|
include Aws::Structure
|
594
574
|
end
|
595
575
|
|
596
|
-
# Contains the results of the RebootWorkspaces operation.
|
597
|
-
#
|
598
576
|
# @!attribute [rw] failed_requests
|
599
|
-
#
|
600
|
-
# rebooted.
|
577
|
+
# Information about the WorkSpaces that could not be rebooted.
|
601
578
|
# @return [Array<Types::FailedWorkspaceChangeRequest>]
|
602
579
|
#
|
603
580
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebootWorkspacesResult AWS API Documentation
|
@@ -607,8 +584,7 @@ module Aws::WorkSpaces
|
|
607
584
|
include Aws::Structure
|
608
585
|
end
|
609
586
|
|
610
|
-
#
|
611
|
-
# rebuild a WorkSpace.
|
587
|
+
# Information used to rebuild a WorkSpace.
|
612
588
|
#
|
613
589
|
# @note When making an API call, you may pass RebuildRequest
|
614
590
|
# data as a hash:
|
@@ -618,7 +594,7 @@ module Aws::WorkSpaces
|
|
618
594
|
# }
|
619
595
|
#
|
620
596
|
# @!attribute [rw] workspace_id
|
621
|
-
# The identifier of the WorkSpace
|
597
|
+
# The identifier of the WorkSpace.
|
622
598
|
# @return [String]
|
623
599
|
#
|
624
600
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebuildRequest AWS API Documentation
|
@@ -628,8 +604,6 @@ module Aws::WorkSpaces
|
|
628
604
|
include Aws::Structure
|
629
605
|
end
|
630
606
|
|
631
|
-
# Contains the inputs for the RebuildWorkspaces operation.
|
632
|
-
#
|
633
607
|
# @note When making an API call, you may pass RebuildWorkspacesRequest
|
634
608
|
# data as a hash:
|
635
609
|
#
|
@@ -642,7 +616,7 @@ module Aws::WorkSpaces
|
|
642
616
|
# }
|
643
617
|
#
|
644
618
|
# @!attribute [rw] rebuild_workspace_requests
|
645
|
-
#
|
619
|
+
# The WorkSpaces to rebuild.
|
646
620
|
# @return [Array<Types::RebuildRequest>]
|
647
621
|
#
|
648
622
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebuildWorkspacesRequest AWS API Documentation
|
@@ -652,11 +626,8 @@ module Aws::WorkSpaces
|
|
652
626
|
include Aws::Structure
|
653
627
|
end
|
654
628
|
|
655
|
-
# Contains the results of the RebuildWorkspaces operation.
|
656
|
-
#
|
657
629
|
# @!attribute [rw] failed_requests
|
658
|
-
#
|
659
|
-
# rebuilt.
|
630
|
+
# Information about the WorkSpaces that could not be rebuilt.
|
660
631
|
# @return [Array<Types::FailedWorkspaceChangeRequest>]
|
661
632
|
#
|
662
633
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RebuildWorkspacesResult AWS API Documentation
|
@@ -666,7 +637,20 @@ module Aws::WorkSpaces
|
|
666
637
|
include Aws::Structure
|
667
638
|
end
|
668
639
|
|
669
|
-
#
|
640
|
+
# Information about the root volume for a WorkSpace bundle.
|
641
|
+
#
|
642
|
+
# @!attribute [rw] capacity
|
643
|
+
# The size of the root volume.
|
644
|
+
# @return [String]
|
645
|
+
#
|
646
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RootStorage AWS API Documentation
|
647
|
+
#
|
648
|
+
class RootStorage < Struct.new(
|
649
|
+
:capacity)
|
650
|
+
include Aws::Structure
|
651
|
+
end
|
652
|
+
|
653
|
+
# Information used to start a WorkSpace.
|
670
654
|
#
|
671
655
|
# @note When making an API call, you may pass StartRequest
|
672
656
|
# data as a hash:
|
@@ -698,7 +682,7 @@ module Aws::WorkSpaces
|
|
698
682
|
# }
|
699
683
|
#
|
700
684
|
# @!attribute [rw] start_workspace_requests
|
701
|
-
# The
|
685
|
+
# The WorkSpaces to start.
|
702
686
|
# @return [Array<Types::StartRequest>]
|
703
687
|
#
|
704
688
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StartWorkspacesRequest AWS API Documentation
|
@@ -709,7 +693,7 @@ module Aws::WorkSpaces
|
|
709
693
|
end
|
710
694
|
|
711
695
|
# @!attribute [rw] failed_requests
|
712
|
-
#
|
696
|
+
# Information about the WorkSpaces that could not be started.
|
713
697
|
# @return [Array<Types::FailedWorkspaceChangeRequest>]
|
714
698
|
#
|
715
699
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StartWorkspacesResult AWS API Documentation
|
@@ -719,7 +703,7 @@ module Aws::WorkSpaces
|
|
719
703
|
include Aws::Structure
|
720
704
|
end
|
721
705
|
|
722
|
-
#
|
706
|
+
# Information used to stop a WorkSpace.
|
723
707
|
#
|
724
708
|
# @note When making an API call, you may pass StopRequest
|
725
709
|
# data as a hash:
|
@@ -751,7 +735,7 @@ module Aws::WorkSpaces
|
|
751
735
|
# }
|
752
736
|
#
|
753
737
|
# @!attribute [rw] stop_workspace_requests
|
754
|
-
# The
|
738
|
+
# The WorkSpaces to stop.
|
755
739
|
# @return [Array<Types::StopRequest>]
|
756
740
|
#
|
757
741
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StopWorkspacesRequest AWS API Documentation
|
@@ -762,7 +746,7 @@ module Aws::WorkSpaces
|
|
762
746
|
end
|
763
747
|
|
764
748
|
# @!attribute [rw] failed_requests
|
765
|
-
#
|
749
|
+
# Information about the WorkSpaces that could not be stopped.
|
766
750
|
# @return [Array<Types::FailedWorkspaceChangeRequest>]
|
767
751
|
#
|
768
752
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StopWorkspacesResult AWS API Documentation
|
@@ -772,7 +756,7 @@ module Aws::WorkSpaces
|
|
772
756
|
include Aws::Structure
|
773
757
|
end
|
774
758
|
|
775
|
-
#
|
759
|
+
# Information about a tag.
|
776
760
|
#
|
777
761
|
# @note When making an API call, you may pass Tag
|
778
762
|
# data as a hash:
|
@@ -798,8 +782,7 @@ module Aws::WorkSpaces
|
|
798
782
|
include Aws::Structure
|
799
783
|
end
|
800
784
|
|
801
|
-
#
|
802
|
-
# terminate a WorkSpace.
|
785
|
+
# Information used to terminate a WorkSpace.
|
803
786
|
#
|
804
787
|
# @note When making an API call, you may pass TerminateRequest
|
805
788
|
# data as a hash:
|
@@ -809,7 +792,7 @@ module Aws::WorkSpaces
|
|
809
792
|
# }
|
810
793
|
#
|
811
794
|
# @!attribute [rw] workspace_id
|
812
|
-
# The identifier of the WorkSpace
|
795
|
+
# The identifier of the WorkSpace.
|
813
796
|
# @return [String]
|
814
797
|
#
|
815
798
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/TerminateRequest AWS API Documentation
|
@@ -819,8 +802,6 @@ module Aws::WorkSpaces
|
|
819
802
|
include Aws::Structure
|
820
803
|
end
|
821
804
|
|
822
|
-
# Contains the inputs for the TerminateWorkspaces operation.
|
823
|
-
#
|
824
805
|
# @note When making an API call, you may pass TerminateWorkspacesRequest
|
825
806
|
# data as a hash:
|
826
807
|
#
|
@@ -833,7 +814,7 @@ module Aws::WorkSpaces
|
|
833
814
|
# }
|
834
815
|
#
|
835
816
|
# @!attribute [rw] terminate_workspace_requests
|
836
|
-
#
|
817
|
+
# The WorkSpaces to terminate.
|
837
818
|
# @return [Array<Types::TerminateRequest>]
|
838
819
|
#
|
839
820
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/TerminateWorkspacesRequest AWS API Documentation
|
@@ -843,11 +824,8 @@ module Aws::WorkSpaces
|
|
843
824
|
include Aws::Structure
|
844
825
|
end
|
845
826
|
|
846
|
-
# Contains the results of the TerminateWorkspaces operation.
|
847
|
-
#
|
848
827
|
# @!attribute [rw] failed_requests
|
849
|
-
#
|
850
|
-
# terminated.
|
828
|
+
# Information about the WorkSpaces that could not be terminated.
|
851
829
|
# @return [Array<Types::FailedWorkspaceChangeRequest>]
|
852
830
|
#
|
853
831
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/TerminateWorkspacesResult AWS API Documentation
|
@@ -857,10 +835,10 @@ module Aws::WorkSpaces
|
|
857
835
|
include Aws::Structure
|
858
836
|
end
|
859
837
|
|
860
|
-
#
|
838
|
+
# Information about the user storage for a WorkSpace bundle.
|
861
839
|
#
|
862
840
|
# @!attribute [rw] capacity
|
863
|
-
# The
|
841
|
+
# The size of the user storage.
|
864
842
|
# @return [String]
|
865
843
|
#
|
866
844
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UserStorage AWS API Documentation
|
@@ -870,19 +848,19 @@ module Aws::WorkSpaces
|
|
870
848
|
include Aws::Structure
|
871
849
|
end
|
872
850
|
|
873
|
-
#
|
851
|
+
# Information about a WorkSpace.
|
874
852
|
#
|
875
853
|
# @!attribute [rw] workspace_id
|
876
854
|
# The identifier of the WorkSpace.
|
877
855
|
# @return [String]
|
878
856
|
#
|
879
857
|
# @!attribute [rw] directory_id
|
880
|
-
# The identifier of the AWS Directory Service directory
|
881
|
-
# WorkSpace
|
858
|
+
# The identifier of the AWS Directory Service directory for the
|
859
|
+
# WorkSpace.
|
882
860
|
# @return [String]
|
883
861
|
#
|
884
862
|
# @!attribute [rw] user_name
|
885
|
-
# The user
|
863
|
+
# The user for the WorkSpace.
|
886
864
|
# @return [String]
|
887
865
|
#
|
888
866
|
# @!attribute [rw] ip_address
|
@@ -894,24 +872,24 @@ module Aws::WorkSpaces
|
|
894
872
|
# @return [String]
|
895
873
|
#
|
896
874
|
# @!attribute [rw] bundle_id
|
897
|
-
# The identifier of the bundle
|
875
|
+
# The identifier of the bundle used to create the WorkSpace.
|
898
876
|
# @return [String]
|
899
877
|
#
|
900
878
|
# @!attribute [rw] subnet_id
|
901
|
-
# The identifier of the subnet
|
879
|
+
# The identifier of the subnet for the WorkSpace.
|
902
880
|
# @return [String]
|
903
881
|
#
|
904
882
|
# @!attribute [rw] error_message
|
905
|
-
# If the WorkSpace could not be created,
|
883
|
+
# If the WorkSpace could not be created, contains a textual error
|
906
884
|
# message that describes the failure.
|
907
885
|
# @return [String]
|
908
886
|
#
|
909
887
|
# @!attribute [rw] error_code
|
910
|
-
# If the WorkSpace could not be created,
|
888
|
+
# If the WorkSpace could not be created, contains the error code.
|
911
889
|
# @return [String]
|
912
890
|
#
|
913
891
|
# @!attribute [rw] computer_name
|
914
|
-
# The name of the WorkSpace as seen by the operating system.
|
892
|
+
# The name of the WorkSpace, as seen by the operating system.
|
915
893
|
# @return [String]
|
916
894
|
#
|
917
895
|
# @!attribute [rw] volume_encryption_key
|
@@ -919,19 +897,21 @@ module Aws::WorkSpaces
|
|
919
897
|
# @return [String]
|
920
898
|
#
|
921
899
|
# @!attribute [rw] user_volume_encryption_enabled
|
922
|
-
#
|
923
|
-
# is encrypted.
|
900
|
+
# Indicates whether the data stored on the user volume is encrypted.
|
924
901
|
# @return [Boolean]
|
925
902
|
#
|
926
903
|
# @!attribute [rw] root_volume_encryption_enabled
|
927
|
-
#
|
928
|
-
# is encrypted.
|
904
|
+
# Indicates whether the data stored on the root volume is encrypted.
|
929
905
|
# @return [Boolean]
|
930
906
|
#
|
931
907
|
# @!attribute [rw] workspace_properties
|
932
|
-
#
|
908
|
+
# The properties of the WorkSpace.
|
933
909
|
# @return [Types::WorkspaceProperties]
|
934
910
|
#
|
911
|
+
# @!attribute [rw] modification_states
|
912
|
+
# The modification states of the WorkSpace.
|
913
|
+
# @return [Array<Types::ModificationState>]
|
914
|
+
#
|
935
915
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/Workspace AWS API Documentation
|
936
916
|
#
|
937
917
|
class Workspace < Struct.new(
|
@@ -948,11 +928,12 @@ module Aws::WorkSpaces
|
|
948
928
|
:volume_encryption_key,
|
949
929
|
:user_volume_encryption_enabled,
|
950
930
|
:root_volume_encryption_enabled,
|
951
|
-
:workspace_properties
|
931
|
+
:workspace_properties,
|
932
|
+
:modification_states)
|
952
933
|
include Aws::Structure
|
953
934
|
end
|
954
935
|
|
955
|
-
#
|
936
|
+
# Information about a WorkSpace bundle.
|
956
937
|
#
|
957
938
|
# @!attribute [rw] bundle_id
|
958
939
|
# The bundle identifier.
|
@@ -963,21 +944,29 @@ module Aws::WorkSpaces
|
|
963
944
|
# @return [String]
|
964
945
|
#
|
965
946
|
# @!attribute [rw] owner
|
966
|
-
# The owner of the bundle. This
|
967
|
-
#
|
947
|
+
# The owner of the bundle. This is the account identifier of the
|
948
|
+
# owner, or `AMAZON` if the bundle is provided by AWS.
|
968
949
|
# @return [String]
|
969
950
|
#
|
970
951
|
# @!attribute [rw] description
|
971
|
-
#
|
952
|
+
# A description.
|
972
953
|
# @return [String]
|
973
954
|
#
|
955
|
+
# @!attribute [rw] root_storage
|
956
|
+
# The size of the root volume.
|
957
|
+
# @return [Types::RootStorage]
|
958
|
+
#
|
974
959
|
# @!attribute [rw] user_storage
|
975
|
-
#
|
976
|
-
# the bundle contains.
|
960
|
+
# The size of the user storage.
|
977
961
|
# @return [Types::UserStorage]
|
978
962
|
#
|
979
963
|
# @!attribute [rw] compute_type
|
980
|
-
#
|
964
|
+
# The compute type. For more information, see [Amazon WorkSpaces
|
965
|
+
# Bundles][1].
|
966
|
+
#
|
967
|
+
#
|
968
|
+
#
|
969
|
+
# [1]: http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles
|
981
970
|
# @return [Types::ComputeType]
|
982
971
|
#
|
983
972
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceBundle AWS API Documentation
|
@@ -987,6 +976,7 @@ module Aws::WorkSpaces
|
|
987
976
|
:name,
|
988
977
|
:owner,
|
989
978
|
:description,
|
979
|
+
:root_storage,
|
990
980
|
:user_storage,
|
991
981
|
:compute_type)
|
992
982
|
include Aws::Structure
|
@@ -999,8 +989,8 @@ module Aws::WorkSpaces
|
|
999
989
|
# @return [String]
|
1000
990
|
#
|
1001
991
|
# @!attribute [rw] connection_state
|
1002
|
-
# The connection state of the WorkSpace.
|
1003
|
-
#
|
992
|
+
# The connection state of the WorkSpace. The connection state is
|
993
|
+
# unknown if the WorkSpace is stopped.
|
1004
994
|
# @return [String]
|
1005
995
|
#
|
1006
996
|
# @!attribute [rw] connection_state_check_timestamp
|
@@ -1043,13 +1033,11 @@ module Aws::WorkSpaces
|
|
1043
1033
|
# @return [String]
|
1044
1034
|
#
|
1045
1035
|
# @!attribute [rw] subnet_ids
|
1046
|
-
#
|
1047
|
-
# used with the directory.
|
1036
|
+
# The identifiers of the subnets used with the directory.
|
1048
1037
|
# @return [Array<String>]
|
1049
1038
|
#
|
1050
1039
|
# @!attribute [rw] dns_ip_addresses
|
1051
|
-
#
|
1052
|
-
# servers for the directory.
|
1040
|
+
# The IP addresses of the DNS servers for the directory.
|
1053
1041
|
# @return [Array<String>]
|
1054
1042
|
#
|
1055
1043
|
# @!attribute [rw] customer_user_name
|
@@ -1076,8 +1064,7 @@ module Aws::WorkSpaces
|
|
1076
1064
|
# @return [String]
|
1077
1065
|
#
|
1078
1066
|
# @!attribute [rw] workspace_creation_properties
|
1079
|
-
#
|
1080
|
-
# WorkSpaces in the directory.
|
1067
|
+
# The default creation properties for all WorkSpaces in the directory.
|
1081
1068
|
# @return [Types::DefaultWorkspaceCreationProperties]
|
1082
1069
|
#
|
1083
1070
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceDirectory AWS API Documentation
|
@@ -1098,7 +1085,7 @@ module Aws::WorkSpaces
|
|
1098
1085
|
include Aws::Structure
|
1099
1086
|
end
|
1100
1087
|
|
1101
|
-
#
|
1088
|
+
# Information about a WorkSpace.
|
1102
1089
|
#
|
1103
1090
|
# @note When making an API call, you may pass WorkspaceProperties
|
1104
1091
|
# data as a hash:
|
@@ -1106,12 +1093,18 @@ module Aws::WorkSpaces
|
|
1106
1093
|
# {
|
1107
1094
|
# running_mode: "AUTO_STOP", # accepts AUTO_STOP, ALWAYS_ON
|
1108
1095
|
# running_mode_auto_stop_timeout_in_minutes: 1,
|
1096
|
+
# root_volume_size_gib: 1,
|
1097
|
+
# user_volume_size_gib: 1,
|
1098
|
+
# compute_type_name: "VALUE", # accepts VALUE, STANDARD, PERFORMANCE, POWER, GRAPHICS
|
1109
1099
|
# }
|
1110
1100
|
#
|
1111
1101
|
# @!attribute [rw] running_mode
|
1112
|
-
# The running mode
|
1113
|
-
#
|
1114
|
-
#
|
1102
|
+
# The running mode. For more information, see [Manage the WorkSpace
|
1103
|
+
# Running Mode][1].
|
1104
|
+
#
|
1105
|
+
#
|
1106
|
+
#
|
1107
|
+
# [1]: http://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html
|
1115
1108
|
# @return [String]
|
1116
1109
|
#
|
1117
1110
|
# @!attribute [rw] running_mode_auto_stop_timeout_in_minutes
|
@@ -1119,15 +1112,35 @@ module Aws::WorkSpaces
|
|
1119
1112
|
# stopped. Configured in 60 minute intervals.
|
1120
1113
|
# @return [Integer]
|
1121
1114
|
#
|
1115
|
+
# @!attribute [rw] root_volume_size_gib
|
1116
|
+
# The size of the root volume.
|
1117
|
+
# @return [Integer]
|
1118
|
+
#
|
1119
|
+
# @!attribute [rw] user_volume_size_gib
|
1120
|
+
# The size of the user storage.
|
1121
|
+
# @return [Integer]
|
1122
|
+
#
|
1123
|
+
# @!attribute [rw] compute_type_name
|
1124
|
+
# The compute type. For more information, see [Amazon WorkSpaces
|
1125
|
+
# Bundles][1].
|
1126
|
+
#
|
1127
|
+
#
|
1128
|
+
#
|
1129
|
+
# [1]: http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles
|
1130
|
+
# @return [String]
|
1131
|
+
#
|
1122
1132
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceProperties AWS API Documentation
|
1123
1133
|
#
|
1124
1134
|
class WorkspaceProperties < Struct.new(
|
1125
1135
|
:running_mode,
|
1126
|
-
:running_mode_auto_stop_timeout_in_minutes
|
1136
|
+
:running_mode_auto_stop_timeout_in_minutes,
|
1137
|
+
:root_volume_size_gib,
|
1138
|
+
:user_volume_size_gib,
|
1139
|
+
:compute_type_name)
|
1127
1140
|
include Aws::Structure
|
1128
1141
|
end
|
1129
1142
|
|
1130
|
-
#
|
1143
|
+
# Information used to create a WorkSpace.
|
1131
1144
|
#
|
1132
1145
|
# @note When making an API call, you may pass WorkspaceRequest
|
1133
1146
|
# data as a hash:
|
@@ -1142,6 +1155,9 @@ module Aws::WorkSpaces
|
|
1142
1155
|
# workspace_properties: {
|
1143
1156
|
# running_mode: "AUTO_STOP", # accepts AUTO_STOP, ALWAYS_ON
|
1144
1157
|
# running_mode_auto_stop_timeout_in_minutes: 1,
|
1158
|
+
# root_volume_size_gib: 1,
|
1159
|
+
# user_volume_size_gib: 1,
|
1160
|
+
# compute_type_name: "VALUE", # accepts VALUE, STANDARD, PERFORMANCE, POWER, GRAPHICS
|
1145
1161
|
# },
|
1146
1162
|
# tags: [
|
1147
1163
|
# {
|
@@ -1152,21 +1168,19 @@ module Aws::WorkSpaces
|
|
1152
1168
|
# }
|
1153
1169
|
#
|
1154
1170
|
# @!attribute [rw] directory_id
|
1155
|
-
# The identifier of the AWS Directory Service directory
|
1156
|
-
# WorkSpace
|
1157
|
-
#
|
1171
|
+
# The identifier of the AWS Directory Service directory for the
|
1172
|
+
# WorkSpace. You can use DescribeWorkspaceDirectories to list the
|
1173
|
+
# available directories.
|
1158
1174
|
# @return [String]
|
1159
1175
|
#
|
1160
1176
|
# @!attribute [rw] user_name
|
1161
|
-
# The username
|
1162
|
-
#
|
1163
|
-
# `DirectoryId` member.
|
1177
|
+
# The username of the user for the WorkSpace. This username must exist
|
1178
|
+
# in the AWS Directory Service directory for the WorkSpace.
|
1164
1179
|
# @return [String]
|
1165
1180
|
#
|
1166
1181
|
# @!attribute [rw] bundle_id
|
1167
|
-
# The identifier of the bundle
|
1168
|
-
#
|
1169
|
-
# bundles that are available.
|
1182
|
+
# The identifier of the bundle for the WorkSpace. You can use
|
1183
|
+
# DescribeWorkspaceBundles to list the available bundles.
|
1170
1184
|
# @return [String]
|
1171
1185
|
#
|
1172
1186
|
# @!attribute [rw] volume_encryption_key
|
@@ -1174,21 +1188,19 @@ module Aws::WorkSpaces
|
|
1174
1188
|
# @return [String]
|
1175
1189
|
#
|
1176
1190
|
# @!attribute [rw] user_volume_encryption_enabled
|
1177
|
-
#
|
1178
|
-
# is encrypted.
|
1191
|
+
# Indicates whether the data stored on the user volume is encrypted.
|
1179
1192
|
# @return [Boolean]
|
1180
1193
|
#
|
1181
1194
|
# @!attribute [rw] root_volume_encryption_enabled
|
1182
|
-
#
|
1183
|
-
# is encrypted.
|
1195
|
+
# Indicates whether the data stored on the root volume is encrypted.
|
1184
1196
|
# @return [Boolean]
|
1185
1197
|
#
|
1186
1198
|
# @!attribute [rw] workspace_properties
|
1187
|
-
#
|
1199
|
+
# The WorkSpace properties.
|
1188
1200
|
# @return [Types::WorkspaceProperties]
|
1189
1201
|
#
|
1190
1202
|
# @!attribute [rw] tags
|
1191
|
-
# The tags
|
1203
|
+
# The tags for the WorkSpace.
|
1192
1204
|
# @return [Array<Types::Tag>]
|
1193
1205
|
#
|
1194
1206
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceRequest AWS API Documentation
|