aws-sdk-workspaces 1.40.0 → 1.45.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 +3 -3
- data/lib/aws-sdk-workspaces/client.rb +496 -19
- data/lib/aws-sdk-workspaces/client_api.rb +258 -0
- data/lib/aws-sdk-workspaces/types.rb +621 -12
- metadata +2 -2
@@ -67,6 +67,46 @@ module Aws::WorkSpaces
|
|
67
67
|
include Aws::Structure
|
68
68
|
end
|
69
69
|
|
70
|
+
# @note When making an API call, you may pass AssociateConnectionAliasRequest
|
71
|
+
# data as a hash:
|
72
|
+
#
|
73
|
+
# {
|
74
|
+
# alias_id: "ConnectionAliasId", # required
|
75
|
+
# resource_id: "NonEmptyString", # required
|
76
|
+
# }
|
77
|
+
#
|
78
|
+
# @!attribute [rw] alias_id
|
79
|
+
# The identifier of the connection alias.
|
80
|
+
# @return [String]
|
81
|
+
#
|
82
|
+
# @!attribute [rw] resource_id
|
83
|
+
# The identifier of the directory to associate the connection alias
|
84
|
+
# with.
|
85
|
+
# @return [String]
|
86
|
+
#
|
87
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/AssociateConnectionAliasRequest AWS API Documentation
|
88
|
+
#
|
89
|
+
class AssociateConnectionAliasRequest < Struct.new(
|
90
|
+
:alias_id,
|
91
|
+
:resource_id)
|
92
|
+
SENSITIVE = []
|
93
|
+
include Aws::Structure
|
94
|
+
end
|
95
|
+
|
96
|
+
# @!attribute [rw] connection_identifier
|
97
|
+
# The identifier of the connection alias association. You use the
|
98
|
+
# connection identifier in the DNS TXT record when you're configuring
|
99
|
+
# your DNS routing policies.
|
100
|
+
# @return [String]
|
101
|
+
#
|
102
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/AssociateConnectionAliasResult AWS API Documentation
|
103
|
+
#
|
104
|
+
class AssociateConnectionAliasResult < Struct.new(
|
105
|
+
:connection_identifier)
|
106
|
+
SENSITIVE = []
|
107
|
+
include Aws::Structure
|
108
|
+
end
|
109
|
+
|
70
110
|
# @note When making an API call, you may pass AssociateIpGroupsRequest
|
71
111
|
# data as a hash:
|
72
112
|
#
|
@@ -186,6 +226,121 @@ module Aws::WorkSpaces
|
|
186
226
|
include Aws::Structure
|
187
227
|
end
|
188
228
|
|
229
|
+
# Describes a connection alias. Connection aliases are used for
|
230
|
+
# cross-Region redirection. For more information, see [ Cross-Region
|
231
|
+
# Redirection for Amazon WorkSpaces][1].
|
232
|
+
#
|
233
|
+
#
|
234
|
+
#
|
235
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html
|
236
|
+
#
|
237
|
+
# @!attribute [rw] connection_string
|
238
|
+
# The connection string specified for the connection alias. The
|
239
|
+
# connection string must be in the form of a fully qualified domain
|
240
|
+
# name (FQDN), such as `www.example.com`.
|
241
|
+
# @return [String]
|
242
|
+
#
|
243
|
+
# @!attribute [rw] alias_id
|
244
|
+
# The identifier of the connection alias.
|
245
|
+
# @return [String]
|
246
|
+
#
|
247
|
+
# @!attribute [rw] state
|
248
|
+
# The current state of the connection alias.
|
249
|
+
# @return [String]
|
250
|
+
#
|
251
|
+
# @!attribute [rw] owner_account_id
|
252
|
+
# The identifier of the AWS account that owns the connection alias.
|
253
|
+
# @return [String]
|
254
|
+
#
|
255
|
+
# @!attribute [rw] associations
|
256
|
+
# The association status of the connection alias.
|
257
|
+
# @return [Array<Types::ConnectionAliasAssociation>]
|
258
|
+
#
|
259
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ConnectionAlias AWS API Documentation
|
260
|
+
#
|
261
|
+
class ConnectionAlias < Struct.new(
|
262
|
+
:connection_string,
|
263
|
+
:alias_id,
|
264
|
+
:state,
|
265
|
+
:owner_account_id,
|
266
|
+
:associations)
|
267
|
+
SENSITIVE = []
|
268
|
+
include Aws::Structure
|
269
|
+
end
|
270
|
+
|
271
|
+
# Describes a connection alias association that is used for cross-Region
|
272
|
+
# redirection. For more information, see [ Cross-Region Redirection for
|
273
|
+
# Amazon WorkSpaces][1].
|
274
|
+
#
|
275
|
+
#
|
276
|
+
#
|
277
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html
|
278
|
+
#
|
279
|
+
# @!attribute [rw] association_status
|
280
|
+
# The association status of the connection alias.
|
281
|
+
# @return [String]
|
282
|
+
#
|
283
|
+
# @!attribute [rw] associated_account_id
|
284
|
+
# The identifier of the AWS account that associated the connection
|
285
|
+
# alias with a directory.
|
286
|
+
# @return [String]
|
287
|
+
#
|
288
|
+
# @!attribute [rw] resource_id
|
289
|
+
# The identifier of the directory associated with a connection alias.
|
290
|
+
# @return [String]
|
291
|
+
#
|
292
|
+
# @!attribute [rw] connection_identifier
|
293
|
+
# The identifier of the connection alias association. You use the
|
294
|
+
# connection identifier in the DNS TXT record when you're configuring
|
295
|
+
# your DNS routing policies.
|
296
|
+
# @return [String]
|
297
|
+
#
|
298
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ConnectionAliasAssociation AWS API Documentation
|
299
|
+
#
|
300
|
+
class ConnectionAliasAssociation < Struct.new(
|
301
|
+
:association_status,
|
302
|
+
:associated_account_id,
|
303
|
+
:resource_id,
|
304
|
+
:connection_identifier)
|
305
|
+
SENSITIVE = []
|
306
|
+
include Aws::Structure
|
307
|
+
end
|
308
|
+
|
309
|
+
# Describes the permissions for a connection alias. Connection aliases
|
310
|
+
# are used for cross-Region redirection. For more information, see [
|
311
|
+
# Cross-Region Redirection for Amazon WorkSpaces][1].
|
312
|
+
#
|
313
|
+
#
|
314
|
+
#
|
315
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html
|
316
|
+
#
|
317
|
+
# @note When making an API call, you may pass ConnectionAliasPermission
|
318
|
+
# data as a hash:
|
319
|
+
#
|
320
|
+
# {
|
321
|
+
# shared_account_id: "AwsAccount", # required
|
322
|
+
# allow_association: false, # required
|
323
|
+
# }
|
324
|
+
#
|
325
|
+
# @!attribute [rw] shared_account_id
|
326
|
+
# The identifier of the AWS account that the connection alias is
|
327
|
+
# shared with.
|
328
|
+
# @return [String]
|
329
|
+
#
|
330
|
+
# @!attribute [rw] allow_association
|
331
|
+
# Indicates whether the specified AWS account is allowed to associate
|
332
|
+
# the connection alias with a directory.
|
333
|
+
# @return [Boolean]
|
334
|
+
#
|
335
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ConnectionAliasPermission AWS API Documentation
|
336
|
+
#
|
337
|
+
class ConnectionAliasPermission < Struct.new(
|
338
|
+
:shared_account_id,
|
339
|
+
:allow_association)
|
340
|
+
SENSITIVE = []
|
341
|
+
include Aws::Structure
|
342
|
+
end
|
343
|
+
|
189
344
|
# @note When making an API call, you may pass CopyWorkspaceImageRequest
|
190
345
|
# data as a hash:
|
191
346
|
#
|
@@ -246,6 +401,55 @@ module Aws::WorkSpaces
|
|
246
401
|
include Aws::Structure
|
247
402
|
end
|
248
403
|
|
404
|
+
# @note When making an API call, you may pass CreateConnectionAliasRequest
|
405
|
+
# data as a hash:
|
406
|
+
#
|
407
|
+
# {
|
408
|
+
# connection_string: "ConnectionString", # required
|
409
|
+
# tags: [
|
410
|
+
# {
|
411
|
+
# key: "TagKey", # required
|
412
|
+
# value: "TagValue",
|
413
|
+
# },
|
414
|
+
# ],
|
415
|
+
# }
|
416
|
+
#
|
417
|
+
# @!attribute [rw] connection_string
|
418
|
+
# A connection string in the form of a fully qualified domain name
|
419
|
+
# (FQDN), such as `www.example.com`.
|
420
|
+
#
|
421
|
+
# After you create a connection string, it is always associated to
|
422
|
+
# your AWS account. You cannot recreate the same connection string
|
423
|
+
# with a different account, even if you delete all instances of it
|
424
|
+
# from the original account. The connection string is globally
|
425
|
+
# reserved for your account.
|
426
|
+
# @return [String]
|
427
|
+
#
|
428
|
+
# @!attribute [rw] tags
|
429
|
+
# The tags to associate with the connection alias.
|
430
|
+
# @return [Array<Types::Tag>]
|
431
|
+
#
|
432
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateConnectionAliasRequest AWS API Documentation
|
433
|
+
#
|
434
|
+
class CreateConnectionAliasRequest < Struct.new(
|
435
|
+
:connection_string,
|
436
|
+
:tags)
|
437
|
+
SENSITIVE = []
|
438
|
+
include Aws::Structure
|
439
|
+
end
|
440
|
+
|
441
|
+
# @!attribute [rw] alias_id
|
442
|
+
# The identifier of the connection alias.
|
443
|
+
# @return [String]
|
444
|
+
#
|
445
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateConnectionAliasResult AWS API Documentation
|
446
|
+
#
|
447
|
+
class CreateConnectionAliasResult < Struct.new(
|
448
|
+
:alias_id)
|
449
|
+
SENSITIVE = []
|
450
|
+
include Aws::Structure
|
451
|
+
end
|
452
|
+
|
249
453
|
# @note When making an API call, you may pass CreateIpGroupRequest
|
250
454
|
# data as a hash:
|
251
455
|
#
|
@@ -321,7 +525,7 @@ module Aws::WorkSpaces
|
|
321
525
|
# @!attribute [rw] resource_id
|
322
526
|
# The identifier of the WorkSpaces resource. The supported resource
|
323
527
|
# types are WorkSpaces, registered directories, images, custom
|
324
|
-
# bundles,
|
528
|
+
# bundles, IP access control groups, and connection aliases.
|
325
529
|
# @return [String]
|
326
530
|
#
|
327
531
|
# @!attribute [rw] tags
|
@@ -442,8 +646,13 @@ module Aws::WorkSpaces
|
|
442
646
|
# @return [String]
|
443
647
|
#
|
444
648
|
# @!attribute [rw] custom_security_group_id
|
445
|
-
# The identifier of
|
446
|
-
# they are created.
|
649
|
+
# The identifier of the default security group to apply to WorkSpaces
|
650
|
+
# when they are created. For more information, see [ Security Groups
|
651
|
+
# for Your WorkSpaces][1].
|
652
|
+
#
|
653
|
+
#
|
654
|
+
#
|
655
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-security-groups.html
|
447
656
|
# @return [String]
|
448
657
|
#
|
449
658
|
# @!attribute [rw] user_enabled_as_local_administrator
|
@@ -473,6 +682,29 @@ module Aws::WorkSpaces
|
|
473
682
|
include Aws::Structure
|
474
683
|
end
|
475
684
|
|
685
|
+
# @note When making an API call, you may pass DeleteConnectionAliasRequest
|
686
|
+
# data as a hash:
|
687
|
+
#
|
688
|
+
# {
|
689
|
+
# alias_id: "ConnectionAliasId", # required
|
690
|
+
# }
|
691
|
+
#
|
692
|
+
# @!attribute [rw] alias_id
|
693
|
+
# The identifier of the connection alias to delete.
|
694
|
+
# @return [String]
|
695
|
+
#
|
696
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteConnectionAliasRequest AWS API Documentation
|
697
|
+
#
|
698
|
+
class DeleteConnectionAliasRequest < Struct.new(
|
699
|
+
:alias_id)
|
700
|
+
SENSITIVE = []
|
701
|
+
include Aws::Structure
|
702
|
+
end
|
703
|
+
|
704
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteConnectionAliasResult AWS API Documentation
|
705
|
+
#
|
706
|
+
class DeleteConnectionAliasResult < Aws::EmptyStructure; end
|
707
|
+
|
476
708
|
# @note When making an API call, you may pass DeleteIpGroupRequest
|
477
709
|
# data as a hash:
|
478
710
|
#
|
@@ -507,7 +739,7 @@ module Aws::WorkSpaces
|
|
507
739
|
# @!attribute [rw] resource_id
|
508
740
|
# The identifier of the WorkSpaces resource. The supported resource
|
509
741
|
# types are WorkSpaces, registered directories, images, custom
|
510
|
-
# bundles,
|
742
|
+
# bundles, IP access control groups, and connection aliases.
|
511
743
|
# @return [String]
|
512
744
|
#
|
513
745
|
# @!attribute [rw] tag_keys
|
@@ -674,6 +906,118 @@ module Aws::WorkSpaces
|
|
674
906
|
include Aws::Structure
|
675
907
|
end
|
676
908
|
|
909
|
+
# @note When making an API call, you may pass DescribeConnectionAliasPermissionsRequest
|
910
|
+
# data as a hash:
|
911
|
+
#
|
912
|
+
# {
|
913
|
+
# alias_id: "ConnectionAliasId", # required
|
914
|
+
# next_token: "PaginationToken",
|
915
|
+
# max_results: 1,
|
916
|
+
# }
|
917
|
+
#
|
918
|
+
# @!attribute [rw] alias_id
|
919
|
+
# The identifier of the connection alias.
|
920
|
+
# @return [String]
|
921
|
+
#
|
922
|
+
# @!attribute [rw] next_token
|
923
|
+
# If you received a `NextToken` from a previous call that was
|
924
|
+
# paginated, provide this token to receive the next set of results.
|
925
|
+
# @return [String]
|
926
|
+
#
|
927
|
+
# @!attribute [rw] max_results
|
928
|
+
# The maximum number of results to return.
|
929
|
+
# @return [Integer]
|
930
|
+
#
|
931
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectionAliasPermissionsRequest AWS API Documentation
|
932
|
+
#
|
933
|
+
class DescribeConnectionAliasPermissionsRequest < Struct.new(
|
934
|
+
:alias_id,
|
935
|
+
:next_token,
|
936
|
+
:max_results)
|
937
|
+
SENSITIVE = []
|
938
|
+
include Aws::Structure
|
939
|
+
end
|
940
|
+
|
941
|
+
# @!attribute [rw] alias_id
|
942
|
+
# The identifier of the connection alias.
|
943
|
+
# @return [String]
|
944
|
+
#
|
945
|
+
# @!attribute [rw] connection_alias_permissions
|
946
|
+
# The permissions associated with a connection alias.
|
947
|
+
# @return [Array<Types::ConnectionAliasPermission>]
|
948
|
+
#
|
949
|
+
# @!attribute [rw] next_token
|
950
|
+
# The token to use to retrieve the next set of results, or null if no
|
951
|
+
# more results are available.
|
952
|
+
# @return [String]
|
953
|
+
#
|
954
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectionAliasPermissionsResult AWS API Documentation
|
955
|
+
#
|
956
|
+
class DescribeConnectionAliasPermissionsResult < Struct.new(
|
957
|
+
:alias_id,
|
958
|
+
:connection_alias_permissions,
|
959
|
+
:next_token)
|
960
|
+
SENSITIVE = []
|
961
|
+
include Aws::Structure
|
962
|
+
end
|
963
|
+
|
964
|
+
# @note When making an API call, you may pass DescribeConnectionAliasesRequest
|
965
|
+
# data as a hash:
|
966
|
+
#
|
967
|
+
# {
|
968
|
+
# alias_ids: ["ConnectionAliasId"],
|
969
|
+
# resource_id: "NonEmptyString",
|
970
|
+
# limit: 1,
|
971
|
+
# next_token: "PaginationToken",
|
972
|
+
# }
|
973
|
+
#
|
974
|
+
# @!attribute [rw] alias_ids
|
975
|
+
# The identifiers of the connection aliases to describe.
|
976
|
+
# @return [Array<String>]
|
977
|
+
#
|
978
|
+
# @!attribute [rw] resource_id
|
979
|
+
# The identifier of the directory associated with the connection
|
980
|
+
# alias.
|
981
|
+
# @return [String]
|
982
|
+
#
|
983
|
+
# @!attribute [rw] limit
|
984
|
+
# The maximum number of connection aliases to return.
|
985
|
+
# @return [Integer]
|
986
|
+
#
|
987
|
+
# @!attribute [rw] next_token
|
988
|
+
# If you received a `NextToken` from a previous call that was
|
989
|
+
# paginated, provide this token to receive the next set of results.
|
990
|
+
# @return [String]
|
991
|
+
#
|
992
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectionAliasesRequest AWS API Documentation
|
993
|
+
#
|
994
|
+
class DescribeConnectionAliasesRequest < Struct.new(
|
995
|
+
:alias_ids,
|
996
|
+
:resource_id,
|
997
|
+
:limit,
|
998
|
+
:next_token)
|
999
|
+
SENSITIVE = []
|
1000
|
+
include Aws::Structure
|
1001
|
+
end
|
1002
|
+
|
1003
|
+
# @!attribute [rw] connection_aliases
|
1004
|
+
# Information about the specified connection aliases.
|
1005
|
+
# @return [Array<Types::ConnectionAlias>]
|
1006
|
+
#
|
1007
|
+
# @!attribute [rw] next_token
|
1008
|
+
# The token to use to retrieve the next set of results, or null if no
|
1009
|
+
# more results are available.
|
1010
|
+
# @return [String]
|
1011
|
+
#
|
1012
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectionAliasesResult AWS API Documentation
|
1013
|
+
#
|
1014
|
+
class DescribeConnectionAliasesResult < Struct.new(
|
1015
|
+
:connection_aliases,
|
1016
|
+
:next_token)
|
1017
|
+
SENSITIVE = []
|
1018
|
+
include Aws::Structure
|
1019
|
+
end
|
1020
|
+
|
677
1021
|
# @note When making an API call, you may pass DescribeIpGroupsRequest
|
678
1022
|
# data as a hash:
|
679
1023
|
#
|
@@ -734,7 +1078,7 @@ module Aws::WorkSpaces
|
|
734
1078
|
# @!attribute [rw] resource_id
|
735
1079
|
# The identifier of the WorkSpaces resource. The supported resource
|
736
1080
|
# types are WorkSpaces, registered directories, images, custom
|
737
|
-
# bundles,
|
1081
|
+
# bundles, IP access control groups, and connection aliases.
|
738
1082
|
# @return [String]
|
739
1083
|
#
|
740
1084
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeTagsRequest AWS API Documentation
|
@@ -864,11 +1208,68 @@ module Aws::WorkSpaces
|
|
864
1208
|
include Aws::Structure
|
865
1209
|
end
|
866
1210
|
|
1211
|
+
# @note When making an API call, you may pass DescribeWorkspaceImagePermissionsRequest
|
1212
|
+
# data as a hash:
|
1213
|
+
#
|
1214
|
+
# {
|
1215
|
+
# image_id: "WorkspaceImageId", # required
|
1216
|
+
# next_token: "PaginationToken",
|
1217
|
+
# max_results: 1,
|
1218
|
+
# }
|
1219
|
+
#
|
1220
|
+
# @!attribute [rw] image_id
|
1221
|
+
# The identifier of the image.
|
1222
|
+
# @return [String]
|
1223
|
+
#
|
1224
|
+
# @!attribute [rw] next_token
|
1225
|
+
# If you received a `NextToken` from a previous call that was
|
1226
|
+
# paginated, provide this token to receive the next set of results.
|
1227
|
+
# @return [String]
|
1228
|
+
#
|
1229
|
+
# @!attribute [rw] max_results
|
1230
|
+
# The maximum number of items to return.
|
1231
|
+
# @return [Integer]
|
1232
|
+
#
|
1233
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceImagePermissionsRequest AWS API Documentation
|
1234
|
+
#
|
1235
|
+
class DescribeWorkspaceImagePermissionsRequest < Struct.new(
|
1236
|
+
:image_id,
|
1237
|
+
:next_token,
|
1238
|
+
:max_results)
|
1239
|
+
SENSITIVE = []
|
1240
|
+
include Aws::Structure
|
1241
|
+
end
|
1242
|
+
|
1243
|
+
# @!attribute [rw] image_id
|
1244
|
+
# The identifier of the image.
|
1245
|
+
# @return [String]
|
1246
|
+
#
|
1247
|
+
# @!attribute [rw] image_permissions
|
1248
|
+
# The identifiers of the AWS accounts that the image has been shared
|
1249
|
+
# with.
|
1250
|
+
# @return [Array<Types::ImagePermission>]
|
1251
|
+
#
|
1252
|
+
# @!attribute [rw] next_token
|
1253
|
+
# The token to use to retrieve the next set of results, or null if no
|
1254
|
+
# more results are available.
|
1255
|
+
# @return [String]
|
1256
|
+
#
|
1257
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceImagePermissionsResult AWS API Documentation
|
1258
|
+
#
|
1259
|
+
class DescribeWorkspaceImagePermissionsResult < Struct.new(
|
1260
|
+
:image_id,
|
1261
|
+
:image_permissions,
|
1262
|
+
:next_token)
|
1263
|
+
SENSITIVE = []
|
1264
|
+
include Aws::Structure
|
1265
|
+
end
|
1266
|
+
|
867
1267
|
# @note When making an API call, you may pass DescribeWorkspaceImagesRequest
|
868
1268
|
# data as a hash:
|
869
1269
|
#
|
870
1270
|
# {
|
871
1271
|
# image_ids: ["WorkspaceImageId"],
|
1272
|
+
# image_type: "OWNED", # accepts OWNED, SHARED
|
872
1273
|
# next_token: "PaginationToken",
|
873
1274
|
# max_results: 1,
|
874
1275
|
# }
|
@@ -877,6 +1278,10 @@ module Aws::WorkSpaces
|
|
877
1278
|
# The identifier of the image.
|
878
1279
|
# @return [Array<String>]
|
879
1280
|
#
|
1281
|
+
# @!attribute [rw] image_type
|
1282
|
+
# The type (owned or shared) of the image.
|
1283
|
+
# @return [String]
|
1284
|
+
#
|
880
1285
|
# @!attribute [rw] next_token
|
881
1286
|
# If you received a `NextToken` from a previous call that was
|
882
1287
|
# paginated, provide this token to receive the next set of results.
|
@@ -890,6 +1295,7 @@ module Aws::WorkSpaces
|
|
890
1295
|
#
|
891
1296
|
class DescribeWorkspaceImagesRequest < Struct.new(
|
892
1297
|
:image_ids,
|
1298
|
+
:image_type,
|
893
1299
|
:next_token,
|
894
1300
|
:max_results)
|
895
1301
|
SENSITIVE = []
|
@@ -1080,6 +1486,29 @@ module Aws::WorkSpaces
|
|
1080
1486
|
include Aws::Structure
|
1081
1487
|
end
|
1082
1488
|
|
1489
|
+
# @note When making an API call, you may pass DisassociateConnectionAliasRequest
|
1490
|
+
# data as a hash:
|
1491
|
+
#
|
1492
|
+
# {
|
1493
|
+
# alias_id: "ConnectionAliasId", # required
|
1494
|
+
# }
|
1495
|
+
#
|
1496
|
+
# @!attribute [rw] alias_id
|
1497
|
+
# The identifier of the connection alias to disassociate.
|
1498
|
+
# @return [String]
|
1499
|
+
#
|
1500
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DisassociateConnectionAliasRequest AWS API Documentation
|
1501
|
+
#
|
1502
|
+
class DisassociateConnectionAliasRequest < Struct.new(
|
1503
|
+
:alias_id)
|
1504
|
+
SENSITIVE = []
|
1505
|
+
include Aws::Structure
|
1506
|
+
end
|
1507
|
+
|
1508
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DisassociateConnectionAliasResult AWS API Documentation
|
1509
|
+
#
|
1510
|
+
class DisassociateConnectionAliasResult < Aws::EmptyStructure; end
|
1511
|
+
|
1083
1512
|
# @note When making an API call, you may pass DisassociateIpGroupsRequest
|
1084
1513
|
# data as a hash:
|
1085
1514
|
#
|
@@ -1162,6 +1591,22 @@ module Aws::WorkSpaces
|
|
1162
1591
|
include Aws::Structure
|
1163
1592
|
end
|
1164
1593
|
|
1594
|
+
# Describes the AWS accounts that have been granted permission to use a
|
1595
|
+
# shared image.
|
1596
|
+
#
|
1597
|
+
# @!attribute [rw] shared_account_id
|
1598
|
+
# The identifier of the AWS account that an image has been shared
|
1599
|
+
# with.
|
1600
|
+
# @return [String]
|
1601
|
+
#
|
1602
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ImagePermission AWS API Documentation
|
1603
|
+
#
|
1604
|
+
class ImagePermission < Struct.new(
|
1605
|
+
:shared_account_id)
|
1606
|
+
SENSITIVE = []
|
1607
|
+
include Aws::Structure
|
1608
|
+
end
|
1609
|
+
|
1165
1610
|
# @note When making an API call, you may pass ImportWorkspaceImageRequest
|
1166
1611
|
# data as a hash:
|
1167
1612
|
#
|
@@ -1176,6 +1621,7 @@ module Aws::WorkSpaces
|
|
1176
1621
|
# value: "TagValue",
|
1177
1622
|
# },
|
1178
1623
|
# ],
|
1624
|
+
# applications: ["Microsoft_Office_2016"], # accepts Microsoft_Office_2016, Microsoft_Office_2019
|
1179
1625
|
# }
|
1180
1626
|
#
|
1181
1627
|
# @!attribute [rw] ec2_image_id
|
@@ -1183,7 +1629,9 @@ module Aws::WorkSpaces
|
|
1183
1629
|
# @return [String]
|
1184
1630
|
#
|
1185
1631
|
# @!attribute [rw] ingestion_process
|
1186
|
-
# The ingestion process to be used when importing the image.
|
1632
|
+
# The ingestion process to be used when importing the image. For
|
1633
|
+
# non-GPU-enabled bundles (bundles other than Graphics or
|
1634
|
+
# GraphicsPro), specify `BYOL_REGULAR`.
|
1187
1635
|
# @return [String]
|
1188
1636
|
#
|
1189
1637
|
# @!attribute [rw] image_name
|
@@ -1198,6 +1646,22 @@ module Aws::WorkSpaces
|
|
1198
1646
|
# The tags. Each WorkSpaces resource can have a maximum of 50 tags.
|
1199
1647
|
# @return [Array<Types::Tag>]
|
1200
1648
|
#
|
1649
|
+
# @!attribute [rw] applications
|
1650
|
+
# If specified, the version of Microsoft Office to subscribe to. Valid
|
1651
|
+
# only for Windows 10 BYOL images. For more information about
|
1652
|
+
# subscribing to Office for BYOL images, see [ Bring Your Own Windows
|
1653
|
+
# Desktop Licenses][1].
|
1654
|
+
#
|
1655
|
+
# <note markdown="1"> Although this parameter is an array, only one item is allowed at
|
1656
|
+
# this time.
|
1657
|
+
#
|
1658
|
+
# </note>
|
1659
|
+
#
|
1660
|
+
#
|
1661
|
+
#
|
1662
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html
|
1663
|
+
# @return [Array<String>]
|
1664
|
+
#
|
1201
1665
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ImportWorkspaceImageRequest AWS API Documentation
|
1202
1666
|
#
|
1203
1667
|
class ImportWorkspaceImageRequest < Struct.new(
|
@@ -1205,7 +1669,8 @@ module Aws::WorkSpaces
|
|
1205
1669
|
:ingestion_process,
|
1206
1670
|
:image_name,
|
1207
1671
|
:image_description,
|
1208
|
-
:tags
|
1672
|
+
:tags,
|
1673
|
+
:applications)
|
1209
1674
|
SENSITIVE = []
|
1210
1675
|
include Aws::Structure
|
1211
1676
|
end
|
@@ -1537,6 +2002,7 @@ module Aws::WorkSpaces
|
|
1537
2002
|
# {
|
1538
2003
|
# resource_id: "DirectoryId", # required
|
1539
2004
|
# workspace_creation_properties: { # required
|
2005
|
+
# enable_work_docs: false,
|
1540
2006
|
# enable_internet_access: false,
|
1541
2007
|
# default_ou: "DefaultOu",
|
1542
2008
|
# custom_security_group_id: "SecurityGroupId",
|
@@ -2324,6 +2790,40 @@ module Aws::WorkSpaces
|
|
2324
2790
|
include Aws::Structure
|
2325
2791
|
end
|
2326
2792
|
|
2793
|
+
# @note When making an API call, you may pass UpdateConnectionAliasPermissionRequest
|
2794
|
+
# data as a hash:
|
2795
|
+
#
|
2796
|
+
# {
|
2797
|
+
# alias_id: "ConnectionAliasId", # required
|
2798
|
+
# connection_alias_permission: { # required
|
2799
|
+
# shared_account_id: "AwsAccount", # required
|
2800
|
+
# allow_association: false, # required
|
2801
|
+
# },
|
2802
|
+
# }
|
2803
|
+
#
|
2804
|
+
# @!attribute [rw] alias_id
|
2805
|
+
# The identifier of the connection alias that you want to update
|
2806
|
+
# permissions for.
|
2807
|
+
# @return [String]
|
2808
|
+
#
|
2809
|
+
# @!attribute [rw] connection_alias_permission
|
2810
|
+
# Indicates whether to share or unshare the connection alias with the
|
2811
|
+
# specified AWS account.
|
2812
|
+
# @return [Types::ConnectionAliasPermission]
|
2813
|
+
#
|
2814
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateConnectionAliasPermissionRequest AWS API Documentation
|
2815
|
+
#
|
2816
|
+
class UpdateConnectionAliasPermissionRequest < Struct.new(
|
2817
|
+
:alias_id,
|
2818
|
+
:connection_alias_permission)
|
2819
|
+
SENSITIVE = []
|
2820
|
+
include Aws::Structure
|
2821
|
+
end
|
2822
|
+
|
2823
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateConnectionAliasPermissionResult AWS API Documentation
|
2824
|
+
#
|
2825
|
+
class UpdateConnectionAliasPermissionResult < Aws::EmptyStructure; end
|
2826
|
+
|
2327
2827
|
# @note When making an API call, you may pass UpdateRulesOfIpGroupRequest
|
2328
2828
|
# data as a hash:
|
2329
2829
|
#
|
@@ -2358,6 +2858,43 @@ module Aws::WorkSpaces
|
|
2358
2858
|
#
|
2359
2859
|
class UpdateRulesOfIpGroupResult < Aws::EmptyStructure; end
|
2360
2860
|
|
2861
|
+
# @note When making an API call, you may pass UpdateWorkspaceImagePermissionRequest
|
2862
|
+
# data as a hash:
|
2863
|
+
#
|
2864
|
+
# {
|
2865
|
+
# image_id: "WorkspaceImageId", # required
|
2866
|
+
# allow_copy_image: false, # required
|
2867
|
+
# shared_account_id: "AwsAccount", # required
|
2868
|
+
# }
|
2869
|
+
#
|
2870
|
+
# @!attribute [rw] image_id
|
2871
|
+
# The identifier of the image.
|
2872
|
+
# @return [String]
|
2873
|
+
#
|
2874
|
+
# @!attribute [rw] allow_copy_image
|
2875
|
+
# The permission to copy the image. This permission can be revoked
|
2876
|
+
# only after an image has been shared.
|
2877
|
+
# @return [Boolean]
|
2878
|
+
#
|
2879
|
+
# @!attribute [rw] shared_account_id
|
2880
|
+
# The identifier of the AWS account to share or unshare the image
|
2881
|
+
# with.
|
2882
|
+
# @return [String]
|
2883
|
+
#
|
2884
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateWorkspaceImagePermissionRequest AWS API Documentation
|
2885
|
+
#
|
2886
|
+
class UpdateWorkspaceImagePermissionRequest < Struct.new(
|
2887
|
+
:image_id,
|
2888
|
+
:allow_copy_image,
|
2889
|
+
:shared_account_id)
|
2890
|
+
SENSITIVE = []
|
2891
|
+
include Aws::Structure
|
2892
|
+
end
|
2893
|
+
|
2894
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateWorkspaceImagePermissionResult AWS API Documentation
|
2895
|
+
#
|
2896
|
+
class UpdateWorkspaceImagePermissionResult < Aws::EmptyStructure; end
|
2897
|
+
|
2361
2898
|
# Describes the user storage for a WorkSpace bundle.
|
2362
2899
|
#
|
2363
2900
|
# @!attribute [rw] capacity
|
@@ -2413,7 +2950,13 @@ module Aws::WorkSpaces
|
|
2413
2950
|
# @return [String]
|
2414
2951
|
#
|
2415
2952
|
# @!attribute [rw] computer_name
|
2416
|
-
# The name of the WorkSpace, as seen by the operating system.
|
2953
|
+
# The name of the WorkSpace, as seen by the operating system. The
|
2954
|
+
# format of this name varies. For more information, see [ Launch a
|
2955
|
+
# WorkSpace][1].
|
2956
|
+
#
|
2957
|
+
#
|
2958
|
+
#
|
2959
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/launch-workspaces-tutorials.html
|
2417
2960
|
# @return [String]
|
2418
2961
|
#
|
2419
2962
|
# @!attribute [rw] volume_encryption_key
|
@@ -2646,6 +3189,7 @@ module Aws::WorkSpaces
|
|
2646
3189
|
# data as a hash:
|
2647
3190
|
#
|
2648
3191
|
# {
|
3192
|
+
# enable_work_docs: false,
|
2649
3193
|
# enable_internet_access: false,
|
2650
3194
|
# default_ou: "DefaultOu",
|
2651
3195
|
# custom_security_group_id: "SecurityGroupId",
|
@@ -2653,12 +3197,52 @@ module Aws::WorkSpaces
|
|
2653
3197
|
# enable_maintenance_mode: false,
|
2654
3198
|
# }
|
2655
3199
|
#
|
3200
|
+
# @!attribute [rw] enable_work_docs
|
3201
|
+
# Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.
|
3202
|
+
#
|
3203
|
+
# <note markdown="1"> If WorkDocs is already enabled for a WorkSpaces directory and you
|
3204
|
+
# disable it, new WorkSpaces launched in the directory will not have
|
3205
|
+
# WorkDocs enabled. However, WorkDocs remains enabled for any existing
|
3206
|
+
# WorkSpaces, unless you either disable users' access to WorkDocs or
|
3207
|
+
# you delete the WorkDocs site. To disable users' access to WorkDocs,
|
3208
|
+
# see [Disabling Users][1] in the *Amazon WorkDocs Administration
|
3209
|
+
# Guide*. To delete a WorkDocs site, see [Deleting a Site][2] in the
|
3210
|
+
# *Amazon WorkDocs Administration Guide*.
|
3211
|
+
#
|
3212
|
+
# If you enable WorkDocs on a directory that already has existing
|
3213
|
+
# WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are
|
3214
|
+
# launched in the directory will have WorkDocs enabled.
|
3215
|
+
#
|
3216
|
+
# </note>
|
3217
|
+
#
|
3218
|
+
#
|
3219
|
+
#
|
3220
|
+
# [1]: https://docs.aws.amazon.com/workdocs/latest/adminguide/inactive-user.html
|
3221
|
+
# [2]: https://docs.aws.amazon.com/workdocs/latest/adminguide/manage-sites.html
|
3222
|
+
# @return [Boolean]
|
3223
|
+
#
|
2656
3224
|
# @!attribute [rw] enable_internet_access
|
2657
3225
|
# Indicates whether internet access is enabled for your WorkSpaces.
|
2658
3226
|
# @return [Boolean]
|
2659
3227
|
#
|
2660
3228
|
# @!attribute [rw] default_ou
|
2661
|
-
# The default organizational unit (OU) for your
|
3229
|
+
# The default organizational unit (OU) for your WorkSpaces
|
3230
|
+
# directories. This string must be the full Lightweight Directory
|
3231
|
+
# Access Protocol (LDAP) distinguished name for the target domain and
|
3232
|
+
# OU. It must be in the form `"OU=value,DC=value,DC=value"`, where
|
3233
|
+
# *value* is any string of characters, and the number of domain
|
3234
|
+
# components (DCs) is two or more. For example,
|
3235
|
+
# `OU=WorkSpaces_machines,DC=machines,DC=example,DC=com`.
|
3236
|
+
#
|
3237
|
+
# * To avoid errors, certain characters in the distinguished name must
|
3238
|
+
# be escaped. For more information, see [ Distinguished Names][1] in
|
3239
|
+
# the Microsoft documentation.
|
3240
|
+
#
|
3241
|
+
# * The API doesn't validate whether the OU exists.
|
3242
|
+
#
|
3243
|
+
#
|
3244
|
+
#
|
3245
|
+
# [1]: https://docs.microsoft.com/previous-versions/windows/desktop/ldap/distinguished-names
|
2662
3246
|
# @return [String]
|
2663
3247
|
#
|
2664
3248
|
# @!attribute [rw] custom_security_group_id
|
@@ -2682,6 +3266,7 @@ module Aws::WorkSpaces
|
|
2682
3266
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceCreationProperties AWS API Documentation
|
2683
3267
|
#
|
2684
3268
|
class WorkspaceCreationProperties < Struct.new(
|
3269
|
+
:enable_work_docs,
|
2685
3270
|
:enable_internet_access,
|
2686
3271
|
:default_ou,
|
2687
3272
|
:custom_security_group_id,
|
@@ -2835,6 +3420,16 @@ module Aws::WorkSpaces
|
|
2835
3420
|
# The text of the error message that is returned for the image.
|
2836
3421
|
# @return [String]
|
2837
3422
|
#
|
3423
|
+
# @!attribute [rw] created
|
3424
|
+
# The date when the image was created. If the image has been shared,
|
3425
|
+
# the AWS account that the image has been shared with sees the
|
3426
|
+
# original creation date of the image.
|
3427
|
+
# @return [Time]
|
3428
|
+
#
|
3429
|
+
# @!attribute [rw] owner_account_id
|
3430
|
+
# The identifier of the AWS account that owns the image.
|
3431
|
+
# @return [String]
|
3432
|
+
#
|
2838
3433
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceImage AWS API Documentation
|
2839
3434
|
#
|
2840
3435
|
class WorkspaceImage < Struct.new(
|
@@ -2845,7 +3440,9 @@ module Aws::WorkSpaces
|
|
2845
3440
|
:state,
|
2846
3441
|
:required_tenancy,
|
2847
3442
|
:error_code,
|
2848
|
-
:error_message
|
3443
|
+
:error_message,
|
3444
|
+
:created,
|
3445
|
+
:owner_account_id)
|
2849
3446
|
SENSITIVE = []
|
2850
3447
|
include Aws::Structure
|
2851
3448
|
end
|
@@ -2878,11 +3475,23 @@ module Aws::WorkSpaces
|
|
2878
3475
|
# @return [Integer]
|
2879
3476
|
#
|
2880
3477
|
# @!attribute [rw] root_volume_size_gib
|
2881
|
-
# The size of the root volume.
|
3478
|
+
# The size of the root volume. For important information about how to
|
3479
|
+
# modify the size of the root and user volumes, see [Modify a
|
3480
|
+
# WorkSpace][1].
|
3481
|
+
#
|
3482
|
+
#
|
3483
|
+
#
|
3484
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html
|
2882
3485
|
# @return [Integer]
|
2883
3486
|
#
|
2884
3487
|
# @!attribute [rw] user_volume_size_gib
|
2885
|
-
# The size of the user storage.
|
3488
|
+
# The size of the user storage. For important information about how to
|
3489
|
+
# modify the size of the root and user volumes, see [Modify a
|
3490
|
+
# WorkSpace][1].
|
3491
|
+
#
|
3492
|
+
#
|
3493
|
+
#
|
3494
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html
|
2886
3495
|
# @return [Integer]
|
2887
3496
|
#
|
2888
3497
|
# @!attribute [rw] compute_type_name
|