aws-sdk-workspaces 1.30.0 → 1.31.0
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 +1 -1
- data/lib/aws-sdk-workspaces/client.rb +244 -9
- data/lib/aws-sdk-workspaces/client_api.rb +145 -0
- data/lib/aws-sdk-workspaces/errors.rb +32 -0
- data/lib/aws-sdk-workspaces/types.rb +508 -17
- metadata +2 -2
@@ -196,6 +196,22 @@ module Aws::WorkSpaces
|
|
196
196
|
|
197
197
|
end
|
198
198
|
|
199
|
+
class UnsupportedNetworkConfigurationException < ServiceError
|
200
|
+
|
201
|
+
# @param [Seahorse::Client::RequestContext] context
|
202
|
+
# @param [String] message
|
203
|
+
# @param [Aws::WorkSpaces::Types::UnsupportedNetworkConfigurationException] data
|
204
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
205
|
+
super(context, message, data)
|
206
|
+
end
|
207
|
+
|
208
|
+
# @return [String]
|
209
|
+
def message
|
210
|
+
@message || @data[:message]
|
211
|
+
end
|
212
|
+
|
213
|
+
end
|
214
|
+
|
199
215
|
class UnsupportedWorkspaceConfigurationException < ServiceError
|
200
216
|
|
201
217
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -212,5 +228,21 @@ module Aws::WorkSpaces
|
|
212
228
|
|
213
229
|
end
|
214
230
|
|
231
|
+
class WorkspacesDefaultRoleNotFoundException < ServiceError
|
232
|
+
|
233
|
+
# @param [Seahorse::Client::RequestContext] context
|
234
|
+
# @param [String] message
|
235
|
+
# @param [Aws::WorkSpaces::Types::WorkspacesDefaultRoleNotFoundException] data
|
236
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
237
|
+
super(context, message, data)
|
238
|
+
end
|
239
|
+
|
240
|
+
# @return [String]
|
241
|
+
def message
|
242
|
+
@message || @data[:message]
|
243
|
+
end
|
244
|
+
|
245
|
+
end
|
246
|
+
|
215
247
|
end
|
216
248
|
end
|
@@ -20,8 +20,8 @@ module Aws::WorkSpaces
|
|
20
20
|
include Aws::Structure
|
21
21
|
end
|
22
22
|
|
23
|
-
# Describes a modification to the configuration of
|
24
|
-
#
|
23
|
+
# Describes a modification to the configuration of Bring Your Own
|
24
|
+
# License (BYOL) for the specified account.
|
25
25
|
#
|
26
26
|
# @!attribute [rw] modification_state
|
27
27
|
# The state of the modification to the configuration of BYOL.
|
@@ -388,7 +388,13 @@ module Aws::WorkSpaces
|
|
388
388
|
include Aws::Structure
|
389
389
|
end
|
390
390
|
|
391
|
-
# Describes the default values used to create
|
391
|
+
# Describes the default values that are used to create WorkSpaces. For
|
392
|
+
# more information, see [Update Directory Details for Your
|
393
|
+
# WorkSpaces][1].
|
394
|
+
#
|
395
|
+
#
|
396
|
+
#
|
397
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html
|
392
398
|
#
|
393
399
|
# @!attribute [rw] enable_work_docs
|
394
400
|
# Specifies whether the directory is enabled for Amazon WorkDocs.
|
@@ -423,8 +429,17 @@ module Aws::WorkSpaces
|
|
423
429
|
# @return [String]
|
424
430
|
#
|
425
431
|
# @!attribute [rw] user_enabled_as_local_administrator
|
426
|
-
# Specifies whether
|
427
|
-
#
|
432
|
+
# Specifies whether WorkSpace users are local administrators on their
|
433
|
+
# WorkSpaces.
|
434
|
+
# @return [Boolean]
|
435
|
+
#
|
436
|
+
# @!attribute [rw] enable_maintenance_mode
|
437
|
+
# Specifies whether maintenance mode is enabled for WorkSpaces. For
|
438
|
+
# more information, see [WorkSpace Maintenance][1].
|
439
|
+
#
|
440
|
+
#
|
441
|
+
#
|
442
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html
|
428
443
|
# @return [Boolean]
|
429
444
|
#
|
430
445
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DefaultWorkspaceCreationProperties AWS API Documentation
|
@@ -434,7 +449,8 @@ module Aws::WorkSpaces
|
|
434
449
|
:enable_internet_access,
|
435
450
|
:default_ou,
|
436
451
|
:custom_security_group_id,
|
437
|
-
:user_enabled_as_local_administrator
|
452
|
+
:user_enabled_as_local_administrator,
|
453
|
+
:enable_maintenance_mode)
|
438
454
|
include Aws::Structure
|
439
455
|
end
|
440
456
|
|
@@ -512,6 +528,31 @@ module Aws::WorkSpaces
|
|
512
528
|
#
|
513
529
|
class DeleteWorkspaceImageResult < Aws::EmptyStructure; end
|
514
530
|
|
531
|
+
# @note When making an API call, you may pass DeregisterWorkspaceDirectoryRequest
|
532
|
+
# data as a hash:
|
533
|
+
#
|
534
|
+
# {
|
535
|
+
# directory_id: "DirectoryId", # required
|
536
|
+
# }
|
537
|
+
#
|
538
|
+
# @!attribute [rw] directory_id
|
539
|
+
# The identifier of the directory. If any WorkSpaces are registered to
|
540
|
+
# this directory, you must remove them before you deregister the
|
541
|
+
# directory, or you will receive an OperationNotSupportedException
|
542
|
+
# error.
|
543
|
+
# @return [String]
|
544
|
+
#
|
545
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeregisterWorkspaceDirectoryRequest AWS API Documentation
|
546
|
+
#
|
547
|
+
class DeregisterWorkspaceDirectoryRequest < Struct.new(
|
548
|
+
:directory_id)
|
549
|
+
include Aws::Structure
|
550
|
+
end
|
551
|
+
|
552
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeregisterWorkspaceDirectoryResult AWS API Documentation
|
553
|
+
#
|
554
|
+
class DeregisterWorkspaceDirectoryResult < Aws::EmptyStructure; end
|
555
|
+
|
515
556
|
# @note When making an API call, you may pass DescribeAccountModificationsRequest
|
516
557
|
# data as a hash:
|
517
558
|
#
|
@@ -743,6 +784,7 @@ module Aws::WorkSpaces
|
|
743
784
|
#
|
744
785
|
# {
|
745
786
|
# directory_ids: ["DirectoryId"],
|
787
|
+
# limit: 1,
|
746
788
|
# next_token: "PaginationToken",
|
747
789
|
# }
|
748
790
|
#
|
@@ -751,6 +793,10 @@ module Aws::WorkSpaces
|
|
751
793
|
# directories are retrieved.
|
752
794
|
# @return [Array<String>]
|
753
795
|
#
|
796
|
+
# @!attribute [rw] limit
|
797
|
+
# The maximum number of directories to return.
|
798
|
+
# @return [Integer]
|
799
|
+
#
|
754
800
|
# @!attribute [rw] next_token
|
755
801
|
# If you received a `NextToken` from a previous call that was
|
756
802
|
# paginated, provide this token to receive the next set of results.
|
@@ -760,6 +806,7 @@ module Aws::WorkSpaces
|
|
760
806
|
#
|
761
807
|
class DescribeWorkspaceDirectoriesRequest < Struct.new(
|
762
808
|
:directory_ids,
|
809
|
+
:limit,
|
763
810
|
:next_token)
|
764
811
|
include Aws::Structure
|
765
812
|
end
|
@@ -1309,6 +1356,111 @@ module Aws::WorkSpaces
|
|
1309
1356
|
#
|
1310
1357
|
class ModifyClientPropertiesResult < Aws::EmptyStructure; end
|
1311
1358
|
|
1359
|
+
# @note When making an API call, you may pass ModifySelfservicePermissionsRequest
|
1360
|
+
# data as a hash:
|
1361
|
+
#
|
1362
|
+
# {
|
1363
|
+
# resource_id: "DirectoryId", # required
|
1364
|
+
# selfservice_permissions: { # required
|
1365
|
+
# restart_workspace: "ENABLED", # accepts ENABLED, DISABLED
|
1366
|
+
# increase_volume_size: "ENABLED", # accepts ENABLED, DISABLED
|
1367
|
+
# change_compute_type: "ENABLED", # accepts ENABLED, DISABLED
|
1368
|
+
# switch_running_mode: "ENABLED", # accepts ENABLED, DISABLED
|
1369
|
+
# rebuild_workspace: "ENABLED", # accepts ENABLED, DISABLED
|
1370
|
+
# },
|
1371
|
+
# }
|
1372
|
+
#
|
1373
|
+
# @!attribute [rw] resource_id
|
1374
|
+
# The identifier of the directory.
|
1375
|
+
# @return [String]
|
1376
|
+
#
|
1377
|
+
# @!attribute [rw] selfservice_permissions
|
1378
|
+
# The permissions to enable or disable self-service capabilities.
|
1379
|
+
# @return [Types::SelfservicePermissions]
|
1380
|
+
#
|
1381
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifySelfservicePermissionsRequest AWS API Documentation
|
1382
|
+
#
|
1383
|
+
class ModifySelfservicePermissionsRequest < Struct.new(
|
1384
|
+
:resource_id,
|
1385
|
+
:selfservice_permissions)
|
1386
|
+
include Aws::Structure
|
1387
|
+
end
|
1388
|
+
|
1389
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifySelfservicePermissionsResult AWS API Documentation
|
1390
|
+
#
|
1391
|
+
class ModifySelfservicePermissionsResult < Aws::EmptyStructure; end
|
1392
|
+
|
1393
|
+
# @note When making an API call, you may pass ModifyWorkspaceAccessPropertiesRequest
|
1394
|
+
# data as a hash:
|
1395
|
+
#
|
1396
|
+
# {
|
1397
|
+
# resource_id: "DirectoryId", # required
|
1398
|
+
# workspace_access_properties: { # required
|
1399
|
+
# device_type_windows: "ALLOW", # accepts ALLOW, DENY
|
1400
|
+
# device_type_osx: "ALLOW", # accepts ALLOW, DENY
|
1401
|
+
# device_type_web: "ALLOW", # accepts ALLOW, DENY
|
1402
|
+
# device_type_ios: "ALLOW", # accepts ALLOW, DENY
|
1403
|
+
# device_type_android: "ALLOW", # accepts ALLOW, DENY
|
1404
|
+
# device_type_chrome_os: "ALLOW", # accepts ALLOW, DENY
|
1405
|
+
# device_type_zero_client: "ALLOW", # accepts ALLOW, DENY
|
1406
|
+
# },
|
1407
|
+
# }
|
1408
|
+
#
|
1409
|
+
# @!attribute [rw] resource_id
|
1410
|
+
# The identifier of the directory.
|
1411
|
+
# @return [String]
|
1412
|
+
#
|
1413
|
+
# @!attribute [rw] workspace_access_properties
|
1414
|
+
# The device types and operating systems to enable or disable for
|
1415
|
+
# access.
|
1416
|
+
# @return [Types::WorkspaceAccessProperties]
|
1417
|
+
#
|
1418
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceAccessPropertiesRequest AWS API Documentation
|
1419
|
+
#
|
1420
|
+
class ModifyWorkspaceAccessPropertiesRequest < Struct.new(
|
1421
|
+
:resource_id,
|
1422
|
+
:workspace_access_properties)
|
1423
|
+
include Aws::Structure
|
1424
|
+
end
|
1425
|
+
|
1426
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceAccessPropertiesResult AWS API Documentation
|
1427
|
+
#
|
1428
|
+
class ModifyWorkspaceAccessPropertiesResult < Aws::EmptyStructure; end
|
1429
|
+
|
1430
|
+
# @note When making an API call, you may pass ModifyWorkspaceCreationPropertiesRequest
|
1431
|
+
# data as a hash:
|
1432
|
+
#
|
1433
|
+
# {
|
1434
|
+
# resource_id: "DirectoryId", # required
|
1435
|
+
# workspace_creation_properties: { # required
|
1436
|
+
# enable_internet_access: false,
|
1437
|
+
# default_ou: "DefaultOu",
|
1438
|
+
# custom_security_group_id: "SecurityGroupId",
|
1439
|
+
# user_enabled_as_local_administrator: false,
|
1440
|
+
# enable_maintenance_mode: false,
|
1441
|
+
# },
|
1442
|
+
# }
|
1443
|
+
#
|
1444
|
+
# @!attribute [rw] resource_id
|
1445
|
+
# The identifier of the directory.
|
1446
|
+
# @return [String]
|
1447
|
+
#
|
1448
|
+
# @!attribute [rw] workspace_creation_properties
|
1449
|
+
# The default properties for creating WorkSpaces.
|
1450
|
+
# @return [Types::WorkspaceCreationProperties]
|
1451
|
+
#
|
1452
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceCreationPropertiesRequest AWS API Documentation
|
1453
|
+
#
|
1454
|
+
class ModifyWorkspaceCreationPropertiesRequest < Struct.new(
|
1455
|
+
:resource_id,
|
1456
|
+
:workspace_creation_properties)
|
1457
|
+
include Aws::Structure
|
1458
|
+
end
|
1459
|
+
|
1460
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifyWorkspaceCreationPropertiesResult AWS API Documentation
|
1461
|
+
#
|
1462
|
+
class ModifyWorkspaceCreationPropertiesResult < Aws::EmptyStructure; end
|
1463
|
+
|
1312
1464
|
# @note When making an API call, you may pass ModifyWorkspacePropertiesRequest
|
1313
1465
|
# data as a hash:
|
1314
1466
|
#
|
@@ -1515,6 +1667,86 @@ module Aws::WorkSpaces
|
|
1515
1667
|
include Aws::Structure
|
1516
1668
|
end
|
1517
1669
|
|
1670
|
+
# @note When making an API call, you may pass RegisterWorkspaceDirectoryRequest
|
1671
|
+
# data as a hash:
|
1672
|
+
#
|
1673
|
+
# {
|
1674
|
+
# directory_id: "DirectoryId", # required
|
1675
|
+
# subnet_ids: ["SubnetId"],
|
1676
|
+
# enable_work_docs: false, # required
|
1677
|
+
# enable_self_service: false,
|
1678
|
+
# tenancy: "DEDICATED", # accepts DEDICATED, SHARED
|
1679
|
+
# tags: [
|
1680
|
+
# {
|
1681
|
+
# key: "TagKey", # required
|
1682
|
+
# value: "TagValue",
|
1683
|
+
# },
|
1684
|
+
# ],
|
1685
|
+
# }
|
1686
|
+
#
|
1687
|
+
# @!attribute [rw] directory_id
|
1688
|
+
# The identifier of the directory. You cannot register a directory if
|
1689
|
+
# it does not have a status of Active. If the directory does not have
|
1690
|
+
# a status of Active, you will receive an
|
1691
|
+
# InvalidResourceStateException error. If you have already registered
|
1692
|
+
# the maximum number of directories that you can register with Amazon
|
1693
|
+
# WorkSpaces, you will receive a ResourceLimitExceededException error.
|
1694
|
+
# Deregister directories that you are not using for WorkSpaces, and
|
1695
|
+
# try again.
|
1696
|
+
# @return [String]
|
1697
|
+
#
|
1698
|
+
# @!attribute [rw] subnet_ids
|
1699
|
+
# The identifiers of the subnets for your virtual private cloud (VPC).
|
1700
|
+
# Make sure that the subnets are in supported Availability Zones. The
|
1701
|
+
# subnets must also be in separate Availability Zones. If these
|
1702
|
+
# conditions are not met, you will receive an
|
1703
|
+
# OperationNotSupportedException error.
|
1704
|
+
# @return [Array<String>]
|
1705
|
+
#
|
1706
|
+
# @!attribute [rw] enable_work_docs
|
1707
|
+
# Indicates whether Amazon WorkDocs is enabled or disabled. If you
|
1708
|
+
# have enabled this parameter and WorkDocs is not available in the
|
1709
|
+
# Region, you will receive an OperationNotSupportedException error.
|
1710
|
+
# Set `EnableWorkDocs` to disabled, and try again.
|
1711
|
+
# @return [Boolean]
|
1712
|
+
#
|
1713
|
+
# @!attribute [rw] enable_self_service
|
1714
|
+
# Indicates whether self-service capabilities are enabled or disabled.
|
1715
|
+
# @return [Boolean]
|
1716
|
+
#
|
1717
|
+
# @!attribute [rw] tenancy
|
1718
|
+
# Indicates whether your WorkSpace directory is dedicated or shared.
|
1719
|
+
# To use Bring Your Own License (BYOL) images, this value must be set
|
1720
|
+
# to `DEDICATED` and your AWS account must be enabled for BYOL. If
|
1721
|
+
# your account has not been enabled for BYOL, you will receive an
|
1722
|
+
# InvalidParameterValuesException error. For more information about
|
1723
|
+
# BYOL images, see [Bring Your Own Windows Desktop Images][1].
|
1724
|
+
#
|
1725
|
+
#
|
1726
|
+
#
|
1727
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html
|
1728
|
+
# @return [String]
|
1729
|
+
#
|
1730
|
+
# @!attribute [rw] tags
|
1731
|
+
# The tags associated with the directory.
|
1732
|
+
# @return [Array<Types::Tag>]
|
1733
|
+
#
|
1734
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RegisterWorkspaceDirectoryRequest AWS API Documentation
|
1735
|
+
#
|
1736
|
+
class RegisterWorkspaceDirectoryRequest < Struct.new(
|
1737
|
+
:directory_id,
|
1738
|
+
:subnet_ids,
|
1739
|
+
:enable_work_docs,
|
1740
|
+
:enable_self_service,
|
1741
|
+
:tenancy,
|
1742
|
+
:tags)
|
1743
|
+
include Aws::Structure
|
1744
|
+
end
|
1745
|
+
|
1746
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RegisterWorkspaceDirectoryResult AWS API Documentation
|
1747
|
+
#
|
1748
|
+
class RegisterWorkspaceDirectoryResult < Aws::EmptyStructure; end
|
1749
|
+
|
1518
1750
|
# The specified resource already exists.
|
1519
1751
|
#
|
1520
1752
|
# @!attribute [rw] message
|
@@ -1663,6 +1895,60 @@ module Aws::WorkSpaces
|
|
1663
1895
|
include Aws::Structure
|
1664
1896
|
end
|
1665
1897
|
|
1898
|
+
# Describes the self-service permissions for a directory. For more
|
1899
|
+
# information, see [Enable Self-Service WorkSpace Management
|
1900
|
+
# Capabilities for Your Users][1].
|
1901
|
+
#
|
1902
|
+
#
|
1903
|
+
#
|
1904
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/enable-user-self-service-workspace-management.html
|
1905
|
+
#
|
1906
|
+
# @note When making an API call, you may pass SelfservicePermissions
|
1907
|
+
# data as a hash:
|
1908
|
+
#
|
1909
|
+
# {
|
1910
|
+
# restart_workspace: "ENABLED", # accepts ENABLED, DISABLED
|
1911
|
+
# increase_volume_size: "ENABLED", # accepts ENABLED, DISABLED
|
1912
|
+
# change_compute_type: "ENABLED", # accepts ENABLED, DISABLED
|
1913
|
+
# switch_running_mode: "ENABLED", # accepts ENABLED, DISABLED
|
1914
|
+
# rebuild_workspace: "ENABLED", # accepts ENABLED, DISABLED
|
1915
|
+
# }
|
1916
|
+
#
|
1917
|
+
# @!attribute [rw] restart_workspace
|
1918
|
+
# Specifies whether users can restart their WorkSpace.
|
1919
|
+
# @return [String]
|
1920
|
+
#
|
1921
|
+
# @!attribute [rw] increase_volume_size
|
1922
|
+
# Specifies whether users can increase the volume size of the drives
|
1923
|
+
# on their WorkSpace.
|
1924
|
+
# @return [String]
|
1925
|
+
#
|
1926
|
+
# @!attribute [rw] change_compute_type
|
1927
|
+
# Specifies whether users can change the compute type (bundle) for
|
1928
|
+
# their WorkSpace.
|
1929
|
+
# @return [String]
|
1930
|
+
#
|
1931
|
+
# @!attribute [rw] switch_running_mode
|
1932
|
+
# Specifies whether users can switch the running mode of their
|
1933
|
+
# WorkSpace.
|
1934
|
+
# @return [String]
|
1935
|
+
#
|
1936
|
+
# @!attribute [rw] rebuild_workspace
|
1937
|
+
# Specifies whether users can rebuild the operating system of a
|
1938
|
+
# WorkSpace to its original state.
|
1939
|
+
# @return [String]
|
1940
|
+
#
|
1941
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/SelfservicePermissions AWS API Documentation
|
1942
|
+
#
|
1943
|
+
class SelfservicePermissions < Struct.new(
|
1944
|
+
:restart_workspace,
|
1945
|
+
:increase_volume_size,
|
1946
|
+
:change_compute_type,
|
1947
|
+
:switch_running_mode,
|
1948
|
+
:rebuild_workspace)
|
1949
|
+
include Aws::Structure
|
1950
|
+
end
|
1951
|
+
|
1666
1952
|
# Describes a snapshot.
|
1667
1953
|
#
|
1668
1954
|
# @!attribute [rw] snapshot_time
|
@@ -1861,13 +2147,32 @@ module Aws::WorkSpaces
|
|
1861
2147
|
include Aws::Structure
|
1862
2148
|
end
|
1863
2149
|
|
2150
|
+
# The configuration of this network is not supported for this operation,
|
2151
|
+
# or your network configuration conflicts with the Amazon WorkSpaces
|
2152
|
+
# management network IP range. For more information, see [ Configure a
|
2153
|
+
# VPC for Amazon WorkSpaces][1].
|
2154
|
+
#
|
2155
|
+
#
|
2156
|
+
#
|
2157
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-vpc.html
|
2158
|
+
#
|
2159
|
+
# @!attribute [rw] message
|
2160
|
+
# @return [String]
|
2161
|
+
#
|
2162
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UnsupportedNetworkConfigurationException AWS API Documentation
|
2163
|
+
#
|
2164
|
+
class UnsupportedNetworkConfigurationException < Struct.new(
|
2165
|
+
:message)
|
2166
|
+
include Aws::Structure
|
2167
|
+
end
|
2168
|
+
|
1864
2169
|
# The configuration of this WorkSpace is not supported for this
|
1865
|
-
# operation. For more information, see
|
1866
|
-
#
|
2170
|
+
# operation. For more information, see [Required Configuration and
|
2171
|
+
# Service Components for WorkSpaces ][1].
|
1867
2172
|
#
|
1868
2173
|
#
|
1869
2174
|
#
|
1870
|
-
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/
|
2175
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/required-service-components.html
|
1871
2176
|
#
|
1872
2177
|
# @!attribute [rw] message
|
1873
2178
|
# @return [String]
|
@@ -2010,6 +2315,89 @@ module Aws::WorkSpaces
|
|
2010
2315
|
include Aws::Structure
|
2011
2316
|
end
|
2012
2317
|
|
2318
|
+
# The device types and operating systems that can be used to access a
|
2319
|
+
# WorkSpace. For more information, see [Amazon WorkSpaces Client Network
|
2320
|
+
# Requirements][1].
|
2321
|
+
#
|
2322
|
+
#
|
2323
|
+
#
|
2324
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-network-requirements.html
|
2325
|
+
#
|
2326
|
+
# @note When making an API call, you may pass WorkspaceAccessProperties
|
2327
|
+
# data as a hash:
|
2328
|
+
#
|
2329
|
+
# {
|
2330
|
+
# device_type_windows: "ALLOW", # accepts ALLOW, DENY
|
2331
|
+
# device_type_osx: "ALLOW", # accepts ALLOW, DENY
|
2332
|
+
# device_type_web: "ALLOW", # accepts ALLOW, DENY
|
2333
|
+
# device_type_ios: "ALLOW", # accepts ALLOW, DENY
|
2334
|
+
# device_type_android: "ALLOW", # accepts ALLOW, DENY
|
2335
|
+
# device_type_chrome_os: "ALLOW", # accepts ALLOW, DENY
|
2336
|
+
# device_type_zero_client: "ALLOW", # accepts ALLOW, DENY
|
2337
|
+
# }
|
2338
|
+
#
|
2339
|
+
# @!attribute [rw] device_type_windows
|
2340
|
+
# Indicates whether users can use Windows clients to access their
|
2341
|
+
# WorkSpaces. To restrict WorkSpaces access to trusted devices (also
|
2342
|
+
# known as managed devices) with valid certificates, specify a value
|
2343
|
+
# of `TRUST`. For more information, see [Restrict WorkSpaces Access to
|
2344
|
+
# Trusted Devices][1].
|
2345
|
+
#
|
2346
|
+
#
|
2347
|
+
#
|
2348
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/trusted-devices.html
|
2349
|
+
# @return [String]
|
2350
|
+
#
|
2351
|
+
# @!attribute [rw] device_type_osx
|
2352
|
+
# Indicates whether users can use macOS clients to access their
|
2353
|
+
# WorkSpaces. To restrict WorkSpaces access to trusted devices (also
|
2354
|
+
# known as managed devices) with valid certificates, specify a value
|
2355
|
+
# of `TRUST`. For more information, see [Restrict WorkSpaces Access to
|
2356
|
+
# Trusted Devices][1].
|
2357
|
+
#
|
2358
|
+
#
|
2359
|
+
#
|
2360
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/trusted-devices.html
|
2361
|
+
# @return [String]
|
2362
|
+
#
|
2363
|
+
# @!attribute [rw] device_type_web
|
2364
|
+
# Indicates whether users can access their WorkSpaces through a web
|
2365
|
+
# browser.
|
2366
|
+
# @return [String]
|
2367
|
+
#
|
2368
|
+
# @!attribute [rw] device_type_ios
|
2369
|
+
# Indicates whether users can use iOS devices to access their
|
2370
|
+
# WorkSpaces.
|
2371
|
+
# @return [String]
|
2372
|
+
#
|
2373
|
+
# @!attribute [rw] device_type_android
|
2374
|
+
# Indicates whether users can use Android devices to access their
|
2375
|
+
# WorkSpaces.
|
2376
|
+
# @return [String]
|
2377
|
+
#
|
2378
|
+
# @!attribute [rw] device_type_chrome_os
|
2379
|
+
# Indicates whether users can use Chromebooks to access their
|
2380
|
+
# WorkSpaces.
|
2381
|
+
# @return [String]
|
2382
|
+
#
|
2383
|
+
# @!attribute [rw] device_type_zero_client
|
2384
|
+
# Indicates whether users can use zero client devices to access their
|
2385
|
+
# WorkSpaces.
|
2386
|
+
# @return [String]
|
2387
|
+
#
|
2388
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceAccessProperties AWS API Documentation
|
2389
|
+
#
|
2390
|
+
class WorkspaceAccessProperties < Struct.new(
|
2391
|
+
:device_type_windows,
|
2392
|
+
:device_type_osx,
|
2393
|
+
:device_type_web,
|
2394
|
+
:device_type_ios,
|
2395
|
+
:device_type_android,
|
2396
|
+
:device_type_chrome_os,
|
2397
|
+
:device_type_zero_client)
|
2398
|
+
include Aws::Structure
|
2399
|
+
end
|
2400
|
+
|
2013
2401
|
# Describes a WorkSpace bundle.
|
2014
2402
|
#
|
2015
2403
|
# @!attribute [rw] bundle_id
|
@@ -2088,8 +2476,63 @@ module Aws::WorkSpaces
|
|
2088
2476
|
include Aws::Structure
|
2089
2477
|
end
|
2090
2478
|
|
2091
|
-
# Describes
|
2092
|
-
# WorkSpaces.
|
2479
|
+
# Describes the default properties that are used for creating
|
2480
|
+
# WorkSpaces. For more information, see [Update Directory Details for
|
2481
|
+
# Your WorkSpaces][1].
|
2482
|
+
#
|
2483
|
+
#
|
2484
|
+
#
|
2485
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html
|
2486
|
+
#
|
2487
|
+
# @note When making an API call, you may pass WorkspaceCreationProperties
|
2488
|
+
# data as a hash:
|
2489
|
+
#
|
2490
|
+
# {
|
2491
|
+
# enable_internet_access: false,
|
2492
|
+
# default_ou: "DefaultOu",
|
2493
|
+
# custom_security_group_id: "SecurityGroupId",
|
2494
|
+
# user_enabled_as_local_administrator: false,
|
2495
|
+
# enable_maintenance_mode: false,
|
2496
|
+
# }
|
2497
|
+
#
|
2498
|
+
# @!attribute [rw] enable_internet_access
|
2499
|
+
# Indicates whether internet access is enabled for your WorkSpaces.
|
2500
|
+
# @return [Boolean]
|
2501
|
+
#
|
2502
|
+
# @!attribute [rw] default_ou
|
2503
|
+
# The default organizational unit (OU) for your WorkSpace directories.
|
2504
|
+
# @return [String]
|
2505
|
+
#
|
2506
|
+
# @!attribute [rw] custom_security_group_id
|
2507
|
+
# The identifier of your custom security group.
|
2508
|
+
# @return [String]
|
2509
|
+
#
|
2510
|
+
# @!attribute [rw] user_enabled_as_local_administrator
|
2511
|
+
# Indicates whether users are local administrators of their
|
2512
|
+
# WorkSpaces.
|
2513
|
+
# @return [Boolean]
|
2514
|
+
#
|
2515
|
+
# @!attribute [rw] enable_maintenance_mode
|
2516
|
+
# Indicates whether maintenance mode is enabled for your WorkSpaces.
|
2517
|
+
# For more information, see [WorkSpace Maintenance][1].
|
2518
|
+
#
|
2519
|
+
#
|
2520
|
+
#
|
2521
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html
|
2522
|
+
# @return [Boolean]
|
2523
|
+
#
|
2524
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceCreationProperties AWS API Documentation
|
2525
|
+
#
|
2526
|
+
class WorkspaceCreationProperties < Struct.new(
|
2527
|
+
:enable_internet_access,
|
2528
|
+
:default_ou,
|
2529
|
+
:custom_security_group_id,
|
2530
|
+
:user_enabled_as_local_administrator,
|
2531
|
+
:enable_maintenance_mode)
|
2532
|
+
include Aws::Structure
|
2533
|
+
end
|
2534
|
+
|
2535
|
+
# Describes a directory that is used with Amazon WorkSpaces.
|
2093
2536
|
#
|
2094
2537
|
# @!attribute [rw] directory_id
|
2095
2538
|
# The directory identifier.
|
@@ -2137,7 +2580,7 @@ module Aws::WorkSpaces
|
|
2137
2580
|
# @return [String]
|
2138
2581
|
#
|
2139
2582
|
# @!attribute [rw] state
|
2140
|
-
# The state of the directory's registration with Amazon WorkSpaces
|
2583
|
+
# The state of the directory's registration with Amazon WorkSpaces.
|
2141
2584
|
# @return [String]
|
2142
2585
|
#
|
2143
2586
|
# @!attribute [rw] workspace_creation_properties
|
@@ -2149,6 +2592,26 @@ module Aws::WorkSpaces
|
|
2149
2592
|
# directory.
|
2150
2593
|
# @return [Array<String>]
|
2151
2594
|
#
|
2595
|
+
# @!attribute [rw] workspace_access_properties
|
2596
|
+
# The devices and operating systems that users can use to access
|
2597
|
+
# Workspaces.
|
2598
|
+
# @return [Types::WorkspaceAccessProperties]
|
2599
|
+
#
|
2600
|
+
# @!attribute [rw] tenancy
|
2601
|
+
# Specifies whether the directory is dedicated or shared. To use Bring
|
2602
|
+
# Your Own License (BYOL), this value must be set to `DEDICATED`. For
|
2603
|
+
# more information, see [Bring Your Own Windows Desktop Images][1].
|
2604
|
+
#
|
2605
|
+
#
|
2606
|
+
#
|
2607
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html
|
2608
|
+
# @return [String]
|
2609
|
+
#
|
2610
|
+
# @!attribute [rw] selfservice_permissions
|
2611
|
+
# The default self-service permissions for WorkSpaces in the
|
2612
|
+
# directory.
|
2613
|
+
# @return [Types::SelfservicePermissions]
|
2614
|
+
#
|
2152
2615
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceDirectory AWS API Documentation
|
2153
2616
|
#
|
2154
2617
|
class WorkspaceDirectory < Struct.new(
|
@@ -2164,7 +2627,10 @@ module Aws::WorkSpaces
|
|
2164
2627
|
:workspace_security_group_id,
|
2165
2628
|
:state,
|
2166
2629
|
:workspace_creation_properties,
|
2167
|
-
:ip_group_ids
|
2630
|
+
:ip_group_ids,
|
2631
|
+
:workspace_access_properties,
|
2632
|
+
:tenancy,
|
2633
|
+
:selfservice_permissions)
|
2168
2634
|
include Aws::Structure
|
2169
2635
|
end
|
2170
2636
|
|
@@ -2192,8 +2658,13 @@ module Aws::WorkSpaces
|
|
2192
2658
|
#
|
2193
2659
|
# @!attribute [rw] required_tenancy
|
2194
2660
|
# Specifies whether the image is running on dedicated hardware. When
|
2195
|
-
#
|
2196
|
-
# DEDICATED
|
2661
|
+
# Bring Your Own License (BYOL) is enabled, this value is set to
|
2662
|
+
# `DEDICATED`. For more information, see [Bring Your Own Windows
|
2663
|
+
# Desktop Images][1].
|
2664
|
+
#
|
2665
|
+
#
|
2666
|
+
#
|
2667
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html
|
2197
2668
|
# @return [String]
|
2198
2669
|
#
|
2199
2670
|
# @!attribute [rw] error_code
|
@@ -2307,8 +2778,8 @@ module Aws::WorkSpaces
|
|
2307
2778
|
# @return [String]
|
2308
2779
|
#
|
2309
2780
|
# @!attribute [rw] user_name
|
2310
|
-
# The
|
2311
|
-
# in the AWS Directory Service directory for the WorkSpace.
|
2781
|
+
# The user name of the user for the WorkSpace. This user name must
|
2782
|
+
# exist in the AWS Directory Service directory for the WorkSpace.
|
2312
2783
|
# @return [String]
|
2313
2784
|
#
|
2314
2785
|
# @!attribute [rw] bundle_id
|
@@ -2350,6 +2821,26 @@ module Aws::WorkSpaces
|
|
2350
2821
|
include Aws::Structure
|
2351
2822
|
end
|
2352
2823
|
|
2824
|
+
# The workspaces\_DefaultRole role could not be found. If this is the
|
2825
|
+
# first time you are registering a directory, you will need to create
|
2826
|
+
# the workspaces\_DefaultRole role before you can register a directory.
|
2827
|
+
# For more information, see [Creating the workspaces\_DefaultRole
|
2828
|
+
# Role][1].
|
2829
|
+
#
|
2830
|
+
#
|
2831
|
+
#
|
2832
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-access-control.html#create-default-role
|
2833
|
+
#
|
2834
|
+
# @!attribute [rw] message
|
2835
|
+
# @return [String]
|
2836
|
+
#
|
2837
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspacesDefaultRoleNotFoundException AWS API Documentation
|
2838
|
+
#
|
2839
|
+
class WorkspacesDefaultRoleNotFoundException < Struct.new(
|
2840
|
+
:message)
|
2841
|
+
include Aws::Structure
|
2842
|
+
end
|
2843
|
+
|
2353
2844
|
# Describes an IP access control group.
|
2354
2845
|
#
|
2355
2846
|
# @!attribute [rw] group_id
|