aws-sdk-workspaces 1.106.0 → 1.107.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -126,6 +126,25 @@ module Aws::WorkSpaces
126
126
  include Aws::Structure
127
127
  end
128
128
 
129
+ # Information about the Active Directory config.
130
+ #
131
+ # @!attribute [rw] domain_name
132
+ # The name of the domain.
133
+ # @return [String]
134
+ #
135
+ # @!attribute [rw] service_account_secret_arn
136
+ # Indicates the secret ARN on the service account.
137
+ # @return [String]
138
+ #
139
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ActiveDirectoryConfig AWS API Documentation
140
+ #
141
+ class ActiveDirectoryConfig < Struct.new(
142
+ :domain_name,
143
+ :service_account_secret_arn)
144
+ SENSITIVE = []
145
+ include Aws::Structure
146
+ end
147
+
129
148
  # The specified application is not supported.
130
149
  #
131
150
  # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ApplicationNotSupportedException AWS API Documentation
@@ -177,6 +196,60 @@ module Aws::WorkSpaces
177
196
  include Aws::Structure
178
197
  end
179
198
 
199
+ # The persistent application settings for users of a WorkSpaces pool.
200
+ #
201
+ # @!attribute [rw] status
202
+ # Enables or disables persistent application settings for users during
203
+ # their pool sessions.
204
+ # @return [String]
205
+ #
206
+ # @!attribute [rw] settings_group
207
+ # The path prefix for the S3 bucket where users’ persistent
208
+ # application settings are stored. You can allow the same persistent
209
+ # application settings to be used across multiple pools by specifying
210
+ # the same settings group for each pool.
211
+ # @return [String]
212
+ #
213
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ApplicationSettingsRequest AWS API Documentation
214
+ #
215
+ class ApplicationSettingsRequest < Struct.new(
216
+ :status,
217
+ :settings_group)
218
+ SENSITIVE = []
219
+ include Aws::Structure
220
+ end
221
+
222
+ # Describes the persistent application settings for users of a
223
+ # WorkSpaces pool.
224
+ #
225
+ # @!attribute [rw] status
226
+ # Specifies whether persistent application settings are enabled for
227
+ # users during their pool sessions.
228
+ # @return [String]
229
+ #
230
+ # @!attribute [rw] settings_group
231
+ # The path prefix for the S3 bucket where users’ persistent
232
+ # application settings are stored.
233
+ # @return [String]
234
+ #
235
+ # @!attribute [rw] s3_bucket_name
236
+ # The S3 bucket where users’ persistent application settings are
237
+ # stored. When persistent application settings are enabled for the
238
+ # first time for an account in an Amazon Web Services Region, an S3
239
+ # bucket is created. The bucket is unique to the Amazon Web Services
240
+ # account and the Region.
241
+ # @return [String]
242
+ #
243
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ApplicationSettingsResponse AWS API Documentation
244
+ #
245
+ class ApplicationSettingsResponse < Struct.new(
246
+ :status,
247
+ :settings_group,
248
+ :s3_bucket_name)
249
+ SENSITIVE = []
250
+ include Aws::Structure
251
+ end
252
+
180
253
  # @!attribute [rw] alias_id
181
254
  # The identifier of the connection alias.
182
255
  # @return [String]
@@ -346,6 +419,55 @@ module Aws::WorkSpaces
346
419
  include Aws::Structure
347
420
  end
348
421
 
422
+ # Describes the user capacity for a WorkSpaces pool.
423
+ #
424
+ # @!attribute [rw] desired_user_sessions
425
+ # The desired number of user sessions for a multi-session pool. This
426
+ # is not allowed for single-session pools.
427
+ # @return [Integer]
428
+ #
429
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/Capacity AWS API Documentation
430
+ #
431
+ class Capacity < Struct.new(
432
+ :desired_user_sessions)
433
+ SENSITIVE = []
434
+ include Aws::Structure
435
+ end
436
+
437
+ # Describes the capacity status for a WorkSpaces pool
438
+ #
439
+ # @!attribute [rw] available_user_sessions
440
+ # The number of user sessions currently being used for pool sessions.
441
+ # This only applies to multi-session pools.
442
+ # @return [Integer]
443
+ #
444
+ # @!attribute [rw] desired_user_sessions
445
+ # The total number of sessions slots that are either running or
446
+ # pending. This represents the total number of concurrent streaming
447
+ # sessions your pool can support in a steady state.
448
+ # @return [Integer]
449
+ #
450
+ # @!attribute [rw] actual_user_sessions
451
+ # The total number of session slots that are available for WorkSpaces
452
+ # pools.
453
+ # @return [Integer]
454
+ #
455
+ # @!attribute [rw] active_user_sessions
456
+ # The number of user sessions currently being used for pool sessions.
457
+ # This only applies to multi-session pools.
458
+ # @return [Integer]
459
+ #
460
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CapacityStatus AWS API Documentation
461
+ #
462
+ class CapacityStatus < Struct.new(
463
+ :available_user_sessions,
464
+ :desired_user_sessions,
465
+ :actual_user_sessions,
466
+ :active_user_sessions)
467
+ SENSITIVE = []
468
+ include Aws::Structure
469
+ end
470
+
349
471
  # Describes the properties of the certificate-based authentication you
350
472
  # want to use with your WorkSpaces.
351
473
  #
@@ -1012,6 +1134,65 @@ module Aws::WorkSpaces
1012
1134
  include Aws::Structure
1013
1135
  end
1014
1136
 
1137
+ # @!attribute [rw] pool_name
1138
+ # The name of the WorkSpaces pool.
1139
+ # @return [String]
1140
+ #
1141
+ # @!attribute [rw] description
1142
+ # The WorkSpaces pool description.
1143
+ # @return [String]
1144
+ #
1145
+ # @!attribute [rw] bundle_id
1146
+ # The identifier of the bundle for the WorkSpaces pool.
1147
+ # @return [String]
1148
+ #
1149
+ # @!attribute [rw] directory_id
1150
+ # The identifier of the directory for the WorkSpaces pool.
1151
+ # @return [String]
1152
+ #
1153
+ # @!attribute [rw] capacity
1154
+ # The user capacity of the WorkSpaces pool.
1155
+ # @return [Types::Capacity]
1156
+ #
1157
+ # @!attribute [rw] tags
1158
+ # The tags for the WorkSpaces pool.
1159
+ # @return [Array<Types::Tag>]
1160
+ #
1161
+ # @!attribute [rw] application_settings
1162
+ # Indicates the application settings of the WorkSpaces pool.
1163
+ # @return [Types::ApplicationSettingsRequest]
1164
+ #
1165
+ # @!attribute [rw] timeout_settings
1166
+ # Indicates the timeout settings of the WorkSpaces pool.
1167
+ # @return [Types::TimeoutSettings]
1168
+ #
1169
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspacesPoolRequest AWS API Documentation
1170
+ #
1171
+ class CreateWorkspacesPoolRequest < Struct.new(
1172
+ :pool_name,
1173
+ :description,
1174
+ :bundle_id,
1175
+ :directory_id,
1176
+ :capacity,
1177
+ :tags,
1178
+ :application_settings,
1179
+ :timeout_settings)
1180
+ SENSITIVE = []
1181
+ include Aws::Structure
1182
+ end
1183
+
1184
+ # @!attribute [rw] workspaces_pool
1185
+ # Indicates the WorkSpaces pool to create.
1186
+ # @return [Types::WorkspacesPool]
1187
+ #
1188
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspacesPoolResult AWS API Documentation
1189
+ #
1190
+ class CreateWorkspacesPoolResult < Struct.new(
1191
+ :workspaces_pool)
1192
+ SENSITIVE = []
1193
+ include Aws::Structure
1194
+ end
1195
+
1015
1196
  # @!attribute [rw] workspaces
1016
1197
  # The WorkSpaces to create. You can specify up to 25 WorkSpaces.
1017
1198
  # @return [Array<Types::WorkspaceRequest>]
@@ -1250,6 +1431,10 @@ module Aws::WorkSpaces
1250
1431
  # [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html
1251
1432
  # @return [Boolean]
1252
1433
  #
1434
+ # @!attribute [rw] instance_iam_role_arn
1435
+ # Indicates the IAM role ARN of the instance.
1436
+ # @return [String]
1437
+ #
1253
1438
  # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DefaultWorkspaceCreationProperties AWS API Documentation
1254
1439
  #
1255
1440
  class DefaultWorkspaceCreationProperties < Struct.new(
@@ -1258,7 +1443,8 @@ module Aws::WorkSpaces
1258
1443
  :default_ou,
1259
1444
  :custom_security_group_id,
1260
1445
  :user_enabled_as_local_administrator,
1261
- :enable_maintenance_mode)
1446
+ :enable_maintenance_mode,
1447
+ :instance_iam_role_arn)
1262
1448
  SENSITIVE = []
1263
1449
  include Aws::Structure
1264
1450
  end
@@ -2060,6 +2246,10 @@ module Aws::WorkSpaces
2060
2246
  # directories are retrieved.
2061
2247
  # @return [Array<String>]
2062
2248
  #
2249
+ # @!attribute [rw] workspace_directory_names
2250
+ # The names of the WorkSpace directories.
2251
+ # @return [Array<String>]
2252
+ #
2063
2253
  # @!attribute [rw] limit
2064
2254
  # The maximum number of directories to return.
2065
2255
  # @return [Integer]
@@ -2073,6 +2263,7 @@ module Aws::WorkSpaces
2073
2263
  #
2074
2264
  class DescribeWorkspaceDirectoriesRequest < Struct.new(
2075
2265
  :directory_ids,
2266
+ :workspace_directory_names,
2076
2267
  :limit,
2077
2268
  :next_token)
2078
2269
  SENSITIVE = []
@@ -2259,6 +2450,122 @@ module Aws::WorkSpaces
2259
2450
  include Aws::Structure
2260
2451
  end
2261
2452
 
2453
+ # @!attribute [rw] pool_id
2454
+ # The identifier of the WorkSpaces pool.
2455
+ # @return [String]
2456
+ #
2457
+ # @!attribute [rw] user_id
2458
+ # The identifier of the user.
2459
+ # @return [String]
2460
+ #
2461
+ # @!attribute [rw] limit
2462
+ # The maximum number of items to return.
2463
+ # @return [Integer]
2464
+ #
2465
+ # @!attribute [rw] next_token
2466
+ # If you received a `NextToken` from a previous call that was
2467
+ # paginated, provide this token to receive the next set of results.
2468
+ # @return [String]
2469
+ #
2470
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesPoolSessionsRequest AWS API Documentation
2471
+ #
2472
+ class DescribeWorkspacesPoolSessionsRequest < Struct.new(
2473
+ :pool_id,
2474
+ :user_id,
2475
+ :limit,
2476
+ :next_token)
2477
+ SENSITIVE = []
2478
+ include Aws::Structure
2479
+ end
2480
+
2481
+ # @!attribute [rw] sessions
2482
+ # Describes the WorkSpaces pool sessions.
2483
+ # @return [Array<Types::WorkspacesPoolSession>]
2484
+ #
2485
+ # @!attribute [rw] next_token
2486
+ # If you received a `NextToken` from a previous call that was
2487
+ # paginated, provide this token to receive the next set of results.
2488
+ # @return [String]
2489
+ #
2490
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesPoolSessionsResult AWS API Documentation
2491
+ #
2492
+ class DescribeWorkspacesPoolSessionsResult < Struct.new(
2493
+ :sessions,
2494
+ :next_token)
2495
+ SENSITIVE = []
2496
+ include Aws::Structure
2497
+ end
2498
+
2499
+ # Describes the filter conditions for the WorkSpaces pool to return.
2500
+ #
2501
+ # @!attribute [rw] name
2502
+ # The name of the pool to filter.
2503
+ # @return [String]
2504
+ #
2505
+ # @!attribute [rw] values
2506
+ # The values for filtering WorkSpaces pools.
2507
+ # @return [Array<String>]
2508
+ #
2509
+ # @!attribute [rw] operator
2510
+ # The operator values for filtering WorkSpaces pools.
2511
+ # @return [String]
2512
+ #
2513
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesPoolsFilter AWS API Documentation
2514
+ #
2515
+ class DescribeWorkspacesPoolsFilter < Struct.new(
2516
+ :name,
2517
+ :values,
2518
+ :operator)
2519
+ SENSITIVE = []
2520
+ include Aws::Structure
2521
+ end
2522
+
2523
+ # @!attribute [rw] pool_ids
2524
+ # The identifier of the WorkSpaces pool.
2525
+ # @return [Array<String>]
2526
+ #
2527
+ # @!attribute [rw] filters
2528
+ # The filter conditions for the WorkSpaces pool to return.
2529
+ # @return [Array<Types::DescribeWorkspacesPoolsFilter>]
2530
+ #
2531
+ # @!attribute [rw] limit
2532
+ # The maximum number of items to return.
2533
+ # @return [Integer]
2534
+ #
2535
+ # @!attribute [rw] next_token
2536
+ # If you received a `NextToken` from a previous call that was
2537
+ # paginated, provide this token to receive the next set of results.
2538
+ # @return [String]
2539
+ #
2540
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesPoolsRequest AWS API Documentation
2541
+ #
2542
+ class DescribeWorkspacesPoolsRequest < Struct.new(
2543
+ :pool_ids,
2544
+ :filters,
2545
+ :limit,
2546
+ :next_token)
2547
+ SENSITIVE = []
2548
+ include Aws::Structure
2549
+ end
2550
+
2551
+ # @!attribute [rw] workspaces_pools
2552
+ # Information about the WorkSpaces pools.
2553
+ # @return [Array<Types::WorkspacesPool>]
2554
+ #
2555
+ # @!attribute [rw] next_token
2556
+ # If you received a `NextToken` from a previous call that was
2557
+ # paginated, provide this token to receive the next set of results.
2558
+ # @return [String]
2559
+ #
2560
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesPoolsResult AWS API Documentation
2561
+ #
2562
+ class DescribeWorkspacesPoolsResult < Struct.new(
2563
+ :workspaces_pools,
2564
+ :next_token)
2565
+ SENSITIVE = []
2566
+ include Aws::Structure
2567
+ end
2568
+
2262
2569
  # @!attribute [rw] workspace_ids
2263
2570
  # The identifiers of the WorkSpaces. You cannot combine this parameter
2264
2571
  # with any other filter.
@@ -3288,6 +3595,27 @@ module Aws::WorkSpaces
3288
3595
  #
3289
3596
  class ModifySelfservicePermissionsResult < Aws::EmptyStructure; end
3290
3597
 
3598
+ # @!attribute [rw] resource_id
3599
+ # The identifier of the resource.
3600
+ # @return [String]
3601
+ #
3602
+ # @!attribute [rw] streaming_properties
3603
+ # The streaming properties to configure.
3604
+ # @return [Types::StreamingProperties]
3605
+ #
3606
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyStreamingPropertiesRequest AWS API Documentation
3607
+ #
3608
+ class ModifyStreamingPropertiesRequest < Struct.new(
3609
+ :resource_id,
3610
+ :streaming_properties)
3611
+ SENSITIVE = []
3612
+ include Aws::Structure
3613
+ end
3614
+
3615
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyStreamingPropertiesResult AWS API Documentation
3616
+ #
3617
+ class ModifyStreamingPropertiesResult < Aws::EmptyStructure; end
3618
+
3291
3619
  # @!attribute [rw] resource_id
3292
3620
  # The identifier of the directory.
3293
3621
  # @return [String]
@@ -3378,6 +3706,28 @@ module Aws::WorkSpaces
3378
3706
  #
3379
3707
  class ModifyWorkspaceStateResult < Aws::EmptyStructure; end
3380
3708
 
3709
+ # Describes the network details of a WorkSpaces pool.
3710
+ #
3711
+ # @!attribute [rw] eni_private_ip_address
3712
+ # The private IP address of the elastic network interface that is
3713
+ # attached to instances in your VPC.
3714
+ # @return [String]
3715
+ #
3716
+ # @!attribute [rw] eni_id
3717
+ # The resource identifier of the elastic network interface that is
3718
+ # attached to instances in your VPC. All network interfaces have the
3719
+ # eni-xxxxxxxx resource identifier.
3720
+ # @return [String]
3721
+ #
3722
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/NetworkAccessConfiguration AWS API Documentation
3723
+ #
3724
+ class NetworkAccessConfiguration < Struct.new(
3725
+ :eni_private_ip_address,
3726
+ :eni_id)
3727
+ SENSITIVE = []
3728
+ include Aws::Structure
3729
+ end
3730
+
3381
3731
  # The operating system that the image is running.
3382
3732
  #
3383
3733
  # @!attribute [rw] type
@@ -3594,6 +3944,27 @@ module Aws::WorkSpaces
3594
3944
  # The tags associated with the directory.
3595
3945
  # @return [Array<Types::Tag>]
3596
3946
  #
3947
+ # @!attribute [rw] workspace_directory_name
3948
+ # The name of the directory to register.
3949
+ # @return [String]
3950
+ #
3951
+ # @!attribute [rw] workspace_directory_description
3952
+ # Description of the directory to register.
3953
+ # @return [String]
3954
+ #
3955
+ # @!attribute [rw] user_identity_type
3956
+ # The type of identity management the user is using.
3957
+ # @return [String]
3958
+ #
3959
+ # @!attribute [rw] workspace_type
3960
+ # Indicates whether the directory's WorkSpace type is personal or
3961
+ # pools.
3962
+ # @return [String]
3963
+ #
3964
+ # @!attribute [rw] active_directory_config
3965
+ # The active directory config of the directory.
3966
+ # @return [Types::ActiveDirectoryConfig]
3967
+ #
3597
3968
  # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RegisterWorkspaceDirectoryRequest AWS API Documentation
3598
3969
  #
3599
3970
  class RegisterWorkspaceDirectoryRequest < Struct.new(
@@ -3602,14 +3973,32 @@ module Aws::WorkSpaces
3602
3973
  :enable_work_docs,
3603
3974
  :enable_self_service,
3604
3975
  :tenancy,
3605
- :tags)
3976
+ :tags,
3977
+ :workspace_directory_name,
3978
+ :workspace_directory_description,
3979
+ :user_identity_type,
3980
+ :workspace_type,
3981
+ :active_directory_config)
3606
3982
  SENSITIVE = []
3607
3983
  include Aws::Structure
3608
3984
  end
3609
3985
 
3986
+ # @!attribute [rw] directory_id
3987
+ # The identifier of the directory.
3988
+ # @return [String]
3989
+ #
3990
+ # @!attribute [rw] state
3991
+ # The registration status of the WorkSpace directory.
3992
+ # @return [String]
3993
+ #
3610
3994
  # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RegisterWorkspaceDirectoryResult AWS API Documentation
3611
3995
  #
3612
- class RegisterWorkspaceDirectoryResult < Aws::EmptyStructure; end
3996
+ class RegisterWorkspaceDirectoryResult < Struct.new(
3997
+ :directory_id,
3998
+ :state)
3999
+ SENSITIVE = []
4000
+ include Aws::Structure
4001
+ end
3613
4002
 
3614
4003
  # @!attribute [rw] link_id
3615
4004
  # The identifier of the account link
@@ -4017,6 +4406,22 @@ module Aws::WorkSpaces
4017
4406
  include Aws::Structure
4018
4407
  end
4019
4408
 
4409
+ # @!attribute [rw] pool_id
4410
+ # The identifier of the WorkSpaces pool.
4411
+ # @return [String]
4412
+ #
4413
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StartWorkspacesPoolRequest AWS API Documentation
4414
+ #
4415
+ class StartWorkspacesPoolRequest < Struct.new(
4416
+ :pool_id)
4417
+ SENSITIVE = []
4418
+ include Aws::Structure
4419
+ end
4420
+
4421
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StartWorkspacesPoolResult AWS API Documentation
4422
+ #
4423
+ class StartWorkspacesPoolResult < Aws::EmptyStructure; end
4424
+
4020
4425
  # @!attribute [rw] start_workspace_requests
4021
4426
  # The WorkSpaces to start. You can specify up to 25 WorkSpaces.
4022
4427
  # @return [Array<Types::StartRequest>]
@@ -4055,6 +4460,22 @@ module Aws::WorkSpaces
4055
4460
  include Aws::Structure
4056
4461
  end
4057
4462
 
4463
+ # @!attribute [rw] pool_id
4464
+ # The identifier of the WorkSpaces pool.
4465
+ # @return [String]
4466
+ #
4467
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StopWorkspacesPoolRequest AWS API Documentation
4468
+ #
4469
+ class StopWorkspacesPoolRequest < Struct.new(
4470
+ :pool_id)
4471
+ SENSITIVE = []
4472
+ include Aws::Structure
4473
+ end
4474
+
4475
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StopWorkspacesPoolResult AWS API Documentation
4476
+ #
4477
+ class StopWorkspacesPoolResult < Aws::EmptyStructure; end
4478
+
4058
4479
  # @!attribute [rw] stop_workspace_requests
4059
4480
  # The WorkSpaces to stop. You can specify up to 25 WorkSpaces.
4060
4481
  # @return [Array<Types::StopRequest>]
@@ -4079,6 +4500,50 @@ module Aws::WorkSpaces
4079
4500
  include Aws::Structure
4080
4501
  end
4081
4502
 
4503
+ # Describes the storage connector.
4504
+ #
4505
+ # @!attribute [rw] connector_type
4506
+ # The type of connector used to save user files.
4507
+ # @return [String]
4508
+ #
4509
+ # @!attribute [rw] status
4510
+ # Indicates if the storage connetor is enabled or disabled.
4511
+ # @return [String]
4512
+ #
4513
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StorageConnector AWS API Documentation
4514
+ #
4515
+ class StorageConnector < Struct.new(
4516
+ :connector_type,
4517
+ :status)
4518
+ SENSITIVE = []
4519
+ include Aws::Structure
4520
+ end
4521
+
4522
+ # Describes the streaming properties.
4523
+ #
4524
+ # @!attribute [rw] streaming_experience_preferred_protocol
4525
+ # Indicates the type of preferred protocol for the streaming
4526
+ # experience.
4527
+ # @return [String]
4528
+ #
4529
+ # @!attribute [rw] user_settings
4530
+ # Indicates the permission settings asscoiated with the user.
4531
+ # @return [Array<Types::UserSetting>]
4532
+ #
4533
+ # @!attribute [rw] storage_connectors
4534
+ # Indicates the storage connector used
4535
+ # @return [Array<Types::StorageConnector>]
4536
+ #
4537
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StreamingProperties AWS API Documentation
4538
+ #
4539
+ class StreamingProperties < Struct.new(
4540
+ :streaming_experience_preferred_protocol,
4541
+ :user_settings,
4542
+ :storage_connectors)
4543
+ SENSITIVE = []
4544
+ include Aws::Structure
4545
+ end
4546
+
4082
4547
  # Describes a tag.
4083
4548
  #
4084
4549
  # @!attribute [rw] key
@@ -4112,6 +4577,38 @@ module Aws::WorkSpaces
4112
4577
  include Aws::Structure
4113
4578
  end
4114
4579
 
4580
+ # @!attribute [rw] pool_id
4581
+ # The identifier of the WorkSpaces pool.
4582
+ # @return [String]
4583
+ #
4584
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/TerminateWorkspacesPoolRequest AWS API Documentation
4585
+ #
4586
+ class TerminateWorkspacesPoolRequest < Struct.new(
4587
+ :pool_id)
4588
+ SENSITIVE = []
4589
+ include Aws::Structure
4590
+ end
4591
+
4592
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/TerminateWorkspacesPoolResult AWS API Documentation
4593
+ #
4594
+ class TerminateWorkspacesPoolResult < Aws::EmptyStructure; end
4595
+
4596
+ # @!attribute [rw] session_id
4597
+ # The identifier of the WorkSpaces pool session.
4598
+ # @return [String]
4599
+ #
4600
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/TerminateWorkspacesPoolSessionRequest AWS API Documentation
4601
+ #
4602
+ class TerminateWorkspacesPoolSessionRequest < Struct.new(
4603
+ :session_id)
4604
+ SENSITIVE = []
4605
+ include Aws::Structure
4606
+ end
4607
+
4608
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/TerminateWorkspacesPoolSessionResult AWS API Documentation
4609
+ #
4610
+ class TerminateWorkspacesPoolSessionResult < Aws::EmptyStructure; end
4611
+
4115
4612
  # @!attribute [rw] terminate_workspace_requests
4116
4613
  # The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.
4117
4614
  # @return [Array<Types::TerminateRequest>]
@@ -4136,6 +4633,41 @@ module Aws::WorkSpaces
4136
4633
  include Aws::Structure
4137
4634
  end
4138
4635
 
4636
+ # Describes the timeout settings for a WorkSpaces pool.
4637
+ #
4638
+ # @!attribute [rw] disconnect_timeout_in_seconds
4639
+ # Specifies the amount of time, in seconds, that a streaming session
4640
+ # remains active after users disconnect. If users try to reconnect to
4641
+ # the streaming session after a disconnection or network interruption
4642
+ # within the time set, they are connected to their previous session.
4643
+ # Otherwise, they are connected to a new session with a new streaming
4644
+ # instance.
4645
+ # @return [Integer]
4646
+ #
4647
+ # @!attribute [rw] idle_disconnect_timeout_in_seconds
4648
+ # The amount of time in seconds a connection will stay active while
4649
+ # idle.
4650
+ # @return [Integer]
4651
+ #
4652
+ # @!attribute [rw] max_user_duration_in_seconds
4653
+ # Specifies the maximum amount of time, in seconds, that a streaming
4654
+ # session can remain active. If users are still connected to a
4655
+ # streaming instance five minutes before this limit is reached, they
4656
+ # are prompted to save any open documents before being disconnected.
4657
+ # After this time elapses, the instance is terminated and replaced by
4658
+ # a new instance.
4659
+ # @return [Integer]
4660
+ #
4661
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/TimeoutSettings AWS API Documentation
4662
+ #
4663
+ class TimeoutSettings < Struct.new(
4664
+ :disconnect_timeout_in_seconds,
4665
+ :idle_disconnect_timeout_in_seconds,
4666
+ :max_user_duration_in_seconds)
4667
+ SENSITIVE = []
4668
+ include Aws::Structure
4669
+ end
4670
+
4139
4671
  # The configuration of this network is not supported for this operation,
4140
4672
  # or your network configuration conflicts with the Amazon WorkSpaces
4141
4673
  # management network IP range. For more information, see [ Configure a
@@ -4329,6 +4861,85 @@ module Aws::WorkSpaces
4329
4861
  #
4330
4862
  class UpdateWorkspaceImagePermissionResult < Aws::EmptyStructure; end
4331
4863
 
4864
+ # @!attribute [rw] pool_id
4865
+ # The identifier of the specified WorkSpaces pool to update.
4866
+ # @return [String]
4867
+ #
4868
+ # @!attribute [rw] description
4869
+ # Describes the specified WorkSpaces pool to update.
4870
+ # @return [String]
4871
+ #
4872
+ # @!attribute [rw] bundle_id
4873
+ # The identifier of the bundle.
4874
+ # @return [String]
4875
+ #
4876
+ # @!attribute [rw] directory_id
4877
+ # The identifier of the directory.
4878
+ # @return [String]
4879
+ #
4880
+ # @!attribute [rw] capacity
4881
+ # The desired capacity for the WorkSpaces pool.
4882
+ # @return [Types::Capacity]
4883
+ #
4884
+ # @!attribute [rw] application_settings
4885
+ # The persistent application settings for users in the pool.
4886
+ # @return [Types::ApplicationSettingsRequest]
4887
+ #
4888
+ # @!attribute [rw] timeout_settings
4889
+ # Indicates the timeout settings of the specified WorkSpaces pool.
4890
+ # @return [Types::TimeoutSettings]
4891
+ #
4892
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateWorkspacesPoolRequest AWS API Documentation
4893
+ #
4894
+ class UpdateWorkspacesPoolRequest < Struct.new(
4895
+ :pool_id,
4896
+ :description,
4897
+ :bundle_id,
4898
+ :directory_id,
4899
+ :capacity,
4900
+ :application_settings,
4901
+ :timeout_settings)
4902
+ SENSITIVE = []
4903
+ include Aws::Structure
4904
+ end
4905
+
4906
+ # @!attribute [rw] workspaces_pool
4907
+ # Describes the specified WorkSpaces pool.
4908
+ # @return [Types::WorkspacesPool]
4909
+ #
4910
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateWorkspacesPoolResult AWS API Documentation
4911
+ #
4912
+ class UpdateWorkspacesPoolResult < Struct.new(
4913
+ :workspaces_pool)
4914
+ SENSITIVE = []
4915
+ include Aws::Structure
4916
+ end
4917
+
4918
+ # Information about the user's permission settings.
4919
+ #
4920
+ # @!attribute [rw] action
4921
+ # Indicates the type of action.
4922
+ # @return [String]
4923
+ #
4924
+ # @!attribute [rw] permission
4925
+ # Indicates if the setting is enabled or disabled.
4926
+ # @return [String]
4927
+ #
4928
+ # @!attribute [rw] maximum_length
4929
+ # Indicates the maximum character length for the specified user
4930
+ # setting.
4931
+ # @return [Integer]
4932
+ #
4933
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UserSetting AWS API Documentation
4934
+ #
4935
+ class UserSetting < Struct.new(
4936
+ :action,
4937
+ :permission,
4938
+ :maximum_length)
4939
+ SENSITIVE = []
4940
+ include Aws::Structure
4941
+ end
4942
+
4332
4943
  # Describes the user volume for a WorkSpace bundle.
4333
4944
  #
4334
4945
  # @!attribute [rw] capacity
@@ -4834,6 +5445,10 @@ module Aws::WorkSpaces
4834
5445
  # [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html
4835
5446
  # @return [Boolean]
4836
5447
  #
5448
+ # @!attribute [rw] instance_iam_role_arn
5449
+ # Indicates the IAM role ARN of the instance.
5450
+ # @return [String]
5451
+ #
4837
5452
  # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceCreationProperties AWS API Documentation
4838
5453
  #
4839
5454
  class WorkspaceCreationProperties < Struct.new(
@@ -4842,7 +5457,8 @@ module Aws::WorkSpaces
4842
5457
  :default_ou,
4843
5458
  :custom_security_group_id,
4844
5459
  :user_enabled_as_local_administrator,
4845
- :enable_maintenance_mode)
5460
+ :enable_maintenance_mode,
5461
+ :instance_iam_role_arn)
4846
5462
  SENSITIVE = []
4847
5463
  include Aws::Structure
4848
5464
  end
@@ -4949,6 +5565,35 @@ module Aws::WorkSpaces
4949
5565
  # for WorkSpaces login.
4950
5566
  # @return [Types::CertificateBasedAuthProperties]
4951
5567
  #
5568
+ # @!attribute [rw] workspace_directory_name
5569
+ # The name fo the WorkSpace directory.
5570
+ # @return [String]
5571
+ #
5572
+ # @!attribute [rw] workspace_directory_description
5573
+ # The description of the WorkSpace directory
5574
+ # @return [String]
5575
+ #
5576
+ # @!attribute [rw] user_identity_type
5577
+ # Indicates the identity type of the specifired user.
5578
+ # @return [String]
5579
+ #
5580
+ # @!attribute [rw] workspace_type
5581
+ # Indicates whether the directory's WorkSpace type is personal or
5582
+ # pools.
5583
+ # @return [String]
5584
+ #
5585
+ # @!attribute [rw] active_directory_config
5586
+ # Information about the Active Directory config.
5587
+ # @return [Types::ActiveDirectoryConfig]
5588
+ #
5589
+ # @!attribute [rw] streaming_properties
5590
+ # The streaming properties to configure.
5591
+ # @return [Types::StreamingProperties]
5592
+ #
5593
+ # @!attribute [rw] error_message
5594
+ # The error message returned.
5595
+ # @return [String]
5596
+ #
4952
5597
  # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceDirectory AWS API Documentation
4953
5598
  #
4954
5599
  class WorkspaceDirectory < Struct.new(
@@ -4969,7 +5614,14 @@ module Aws::WorkSpaces
4969
5614
  :tenancy,
4970
5615
  :selfservice_permissions,
4971
5616
  :saml_properties,
4972
- :certificate_based_auth_properties)
5617
+ :certificate_based_auth_properties,
5618
+ :workspace_directory_name,
5619
+ :workspace_directory_description,
5620
+ :user_identity_type,
5621
+ :workspace_type,
5622
+ :active_directory_config,
5623
+ :streaming_properties,
5624
+ :error_message)
4973
5625
  SENSITIVE = []
4974
5626
  include Aws::Structure
4975
5627
  end
@@ -5301,5 +5953,152 @@ module Aws::WorkSpaces
5301
5953
  include Aws::Structure
5302
5954
  end
5303
5955
 
5956
+ # Describes a WorkSpaces pool.
5957
+ #
5958
+ # @!attribute [rw] pool_id
5959
+ # The identifier of a WorkSpaces pool.
5960
+ # @return [String]
5961
+ #
5962
+ # @!attribute [rw] pool_arn
5963
+ # The Amazon Resource Name (ARN) for the WorkSpaces pool.
5964
+ # @return [String]
5965
+ #
5966
+ # @!attribute [rw] capacity_status
5967
+ # The capacity status for the pool
5968
+ # @return [Types::CapacityStatus]
5969
+ #
5970
+ # @!attribute [rw] pool_name
5971
+ # The name of the pool,
5972
+ # @return [String]
5973
+ #
5974
+ # @!attribute [rw] description
5975
+ # The description of the pool.
5976
+ # @return [String]
5977
+ #
5978
+ # @!attribute [rw] state
5979
+ # The current state of the pool.
5980
+ # @return [String]
5981
+ #
5982
+ # @!attribute [rw] created_at
5983
+ # The time the pool was created.
5984
+ # @return [Time]
5985
+ #
5986
+ # @!attribute [rw] bundle_id
5987
+ # The identifier of the bundle used by the pool.
5988
+ # @return [String]
5989
+ #
5990
+ # @!attribute [rw] directory_id
5991
+ # The identifier of the directory used by the pool.
5992
+ # @return [String]
5993
+ #
5994
+ # @!attribute [rw] errors
5995
+ # The pool errors.
5996
+ # @return [Array<Types::WorkspacesPoolError>]
5997
+ #
5998
+ # @!attribute [rw] application_settings
5999
+ # The persistent application settings for users of the pool.
6000
+ # @return [Types::ApplicationSettingsResponse]
6001
+ #
6002
+ # @!attribute [rw] timeout_settings
6003
+ # The amount of time that a pool session remains active after users
6004
+ # disconnect. If they try to reconnect to the pool session after a
6005
+ # disconnection or network interruption within this time interval,
6006
+ # they are connected to their previous session. Otherwise, they are
6007
+ # connected to a new session with a new pool instance.
6008
+ # @return [Types::TimeoutSettings]
6009
+ #
6010
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspacesPool AWS API Documentation
6011
+ #
6012
+ class WorkspacesPool < Struct.new(
6013
+ :pool_id,
6014
+ :pool_arn,
6015
+ :capacity_status,
6016
+ :pool_name,
6017
+ :description,
6018
+ :state,
6019
+ :created_at,
6020
+ :bundle_id,
6021
+ :directory_id,
6022
+ :errors,
6023
+ :application_settings,
6024
+ :timeout_settings)
6025
+ SENSITIVE = []
6026
+ include Aws::Structure
6027
+ end
6028
+
6029
+ # Describes a WorkSpaces pool error.
6030
+ #
6031
+ # @!attribute [rw] error_code
6032
+ # The error code.
6033
+ # @return [String]
6034
+ #
6035
+ # @!attribute [rw] error_message
6036
+ # The error message.
6037
+ # @return [String]
6038
+ #
6039
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspacesPoolError AWS API Documentation
6040
+ #
6041
+ class WorkspacesPoolError < Struct.new(
6042
+ :error_code,
6043
+ :error_message)
6044
+ SENSITIVE = []
6045
+ include Aws::Structure
6046
+ end
6047
+
6048
+ # Describes a WorkSpaces pool session.
6049
+ #
6050
+ # @!attribute [rw] authentication_type
6051
+ # The authentication method. The user is authenticated using a
6052
+ # WorkSpaces pool URL (API) or SAML 2.0 federation (SAML).
6053
+ # @return [String]
6054
+ #
6055
+ # @!attribute [rw] connection_state
6056
+ # Specifies whether a user is connected to the pool session.
6057
+ # @return [String]
6058
+ #
6059
+ # @!attribute [rw] session_id
6060
+ # The identifier of the session.
6061
+ # @return [String]
6062
+ #
6063
+ # @!attribute [rw] instance_id
6064
+ # The identifier for the instance hosting the session.
6065
+ # @return [String]
6066
+ #
6067
+ # @!attribute [rw] pool_id
6068
+ # The identifier of the pool.
6069
+ # @return [String]
6070
+ #
6071
+ # @!attribute [rw] expiration_time
6072
+ # The time that the pool session ended.
6073
+ # @return [Time]
6074
+ #
6075
+ # @!attribute [rw] network_access_configuration
6076
+ # Describes the network details of the pool.
6077
+ # @return [Types::NetworkAccessConfiguration]
6078
+ #
6079
+ # @!attribute [rw] start_time
6080
+ # The time that the pool sission started.
6081
+ # @return [Time]
6082
+ #
6083
+ # @!attribute [rw] user_id
6084
+ # The identifier of the user.
6085
+ # @return [String]
6086
+ #
6087
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspacesPoolSession AWS API Documentation
6088
+ #
6089
+ class WorkspacesPoolSession < Struct.new(
6090
+ :authentication_type,
6091
+ :connection_state,
6092
+ :session_id,
6093
+ :instance_id,
6094
+ :pool_id,
6095
+ :expiration_time,
6096
+ :network_access_configuration,
6097
+ :start_time,
6098
+ :user_id)
6099
+ SENSITIVE = []
6100
+ include Aws::Structure
6101
+ end
6102
+
5304
6103
  end
5305
6104
  end