aws-sdk-workspaces 1.76.0 → 1.78.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/CHANGELOG.md +13 -1
- data/VERSION +1 -1
- data/lib/aws-sdk-workspaces/client.rb +73 -1
- data/lib/aws-sdk-workspaces/client_api.rb +73 -0
- data/lib/aws-sdk-workspaces/endpoint_provider.rb +35 -96
- data/lib/aws-sdk-workspaces/endpoints.rb +14 -0
- data/lib/aws-sdk-workspaces/plugins/endpoints.rb +2 -0
- data/lib/aws-sdk-workspaces/types.rb +172 -941
- data/lib/aws-sdk-workspaces.rb +1 -1
- metadata +2 -2
@@ -67,14 +67,6 @@ 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
70
|
# @!attribute [rw] alias_id
|
79
71
|
# The identifier of the connection alias.
|
80
72
|
# @return [String]
|
@@ -107,14 +99,6 @@ module Aws::WorkSpaces
|
|
107
99
|
include Aws::Structure
|
108
100
|
end
|
109
101
|
|
110
|
-
# @note When making an API call, you may pass AssociateIpGroupsRequest
|
111
|
-
# data as a hash:
|
112
|
-
#
|
113
|
-
# {
|
114
|
-
# directory_id: "DirectoryId", # required
|
115
|
-
# group_ids: ["IpGroupId"], # required
|
116
|
-
# }
|
117
|
-
#
|
118
102
|
# @!attribute [rw] directory_id
|
119
103
|
# The identifier of the directory.
|
120
104
|
# @return [String]
|
@@ -136,19 +120,6 @@ module Aws::WorkSpaces
|
|
136
120
|
#
|
137
121
|
class AssociateIpGroupsResult < Aws::EmptyStructure; end
|
138
122
|
|
139
|
-
# @note When making an API call, you may pass AuthorizeIpRulesRequest
|
140
|
-
# data as a hash:
|
141
|
-
#
|
142
|
-
# {
|
143
|
-
# group_id: "IpGroupId", # required
|
144
|
-
# user_rules: [ # required
|
145
|
-
# {
|
146
|
-
# ip_rule: "IpRule",
|
147
|
-
# rule_desc: "IpRuleDesc",
|
148
|
-
# },
|
149
|
-
# ],
|
150
|
-
# }
|
151
|
-
#
|
152
123
|
# @!attribute [rw] group_id
|
153
124
|
# The identifier of the group.
|
154
125
|
# @return [String]
|
@@ -173,14 +144,6 @@ module Aws::WorkSpaces
|
|
173
144
|
# Describes the properties of the certificate-based authentication you
|
174
145
|
# want to use with your WorkSpaces.
|
175
146
|
#
|
176
|
-
# @note When making an API call, you may pass CertificateBasedAuthProperties
|
177
|
-
# data as a hash:
|
178
|
-
#
|
179
|
-
# {
|
180
|
-
# status: "DISABLED", # accepts DISABLED, ENABLED
|
181
|
-
# certificate_authority_arn: "CertificateAuthorityArn",
|
182
|
-
# }
|
183
|
-
#
|
184
147
|
# @!attribute [rw] status
|
185
148
|
# The status of the certificate-based authentication properties.
|
186
149
|
# @return [String]
|
@@ -201,14 +164,6 @@ module Aws::WorkSpaces
|
|
201
164
|
|
202
165
|
# Describes an Amazon WorkSpaces client.
|
203
166
|
#
|
204
|
-
# @note When making an API call, you may pass ClientProperties
|
205
|
-
# data as a hash:
|
206
|
-
#
|
207
|
-
# {
|
208
|
-
# reconnect_enabled: "ENABLED", # accepts ENABLED, DISABLED
|
209
|
-
# log_upload_enabled: "ENABLED", # accepts ENABLED, DISABLED
|
210
|
-
# }
|
211
|
-
#
|
212
167
|
# @!attribute [rw] reconnect_enabled
|
213
168
|
# Specifies whether users can cache their credentials on the Amazon
|
214
169
|
# WorkSpaces client. When enabled, users can choose to reconnect to
|
@@ -253,13 +208,6 @@ module Aws::WorkSpaces
|
|
253
208
|
|
254
209
|
# Describes the compute type of the bundle.
|
255
210
|
#
|
256
|
-
# @note When making an API call, you may pass ComputeType
|
257
|
-
# data as a hash:
|
258
|
-
#
|
259
|
-
# {
|
260
|
-
# name: "VALUE", # accepts VALUE, STANDARD, PERFORMANCE, POWER, GRAPHICS, POWERPRO, GRAPHICSPRO, GRAPHICS_G4DN, GRAPHICSPRO_G4DN
|
261
|
-
# }
|
262
|
-
#
|
263
211
|
# @!attribute [rw] name
|
264
212
|
# The compute type.
|
265
213
|
# @return [String]
|
@@ -390,14 +338,6 @@ module Aws::WorkSpaces
|
|
390
338
|
#
|
391
339
|
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html
|
392
340
|
#
|
393
|
-
# @note When making an API call, you may pass ConnectionAliasPermission
|
394
|
-
# data as a hash:
|
395
|
-
#
|
396
|
-
# {
|
397
|
-
# shared_account_id: "AwsAccount", # required
|
398
|
-
# allow_association: false, # required
|
399
|
-
# }
|
400
|
-
#
|
401
341
|
# @!attribute [rw] shared_account_id
|
402
342
|
# The identifier of the Amazon Web Services account that the
|
403
343
|
# connection alias is shared with.
|
@@ -417,22 +357,6 @@ module Aws::WorkSpaces
|
|
417
357
|
include Aws::Structure
|
418
358
|
end
|
419
359
|
|
420
|
-
# @note When making an API call, you may pass CopyWorkspaceImageRequest
|
421
|
-
# data as a hash:
|
422
|
-
#
|
423
|
-
# {
|
424
|
-
# name: "WorkspaceImageName", # required
|
425
|
-
# description: "WorkspaceImageDescription",
|
426
|
-
# source_image_id: "WorkspaceImageId", # required
|
427
|
-
# source_region: "Region", # required
|
428
|
-
# tags: [
|
429
|
-
# {
|
430
|
-
# key: "TagKey", # required
|
431
|
-
# value: "TagValue",
|
432
|
-
# },
|
433
|
-
# ],
|
434
|
-
# }
|
435
|
-
#
|
436
360
|
# @!attribute [rw] name
|
437
361
|
# The name of the image.
|
438
362
|
# @return [String]
|
@@ -477,15 +401,6 @@ module Aws::WorkSpaces
|
|
477
401
|
include Aws::Structure
|
478
402
|
end
|
479
403
|
|
480
|
-
# @note When making an API call, you may pass CreateConnectClientAddInRequest
|
481
|
-
# data as a hash:
|
482
|
-
#
|
483
|
-
# {
|
484
|
-
# resource_id: "DirectoryId", # required
|
485
|
-
# name: "AddInName", # required
|
486
|
-
# url: "AddInUrl", # required
|
487
|
-
# }
|
488
|
-
#
|
489
404
|
# @!attribute [rw] resource_id
|
490
405
|
# The directory identifier for which to configure the client add-in.
|
491
406
|
# @return [String]
|
@@ -520,19 +435,6 @@ module Aws::WorkSpaces
|
|
520
435
|
include Aws::Structure
|
521
436
|
end
|
522
437
|
|
523
|
-
# @note When making an API call, you may pass CreateConnectionAliasRequest
|
524
|
-
# data as a hash:
|
525
|
-
#
|
526
|
-
# {
|
527
|
-
# connection_string: "ConnectionString", # required
|
528
|
-
# tags: [
|
529
|
-
# {
|
530
|
-
# key: "TagKey", # required
|
531
|
-
# value: "TagValue",
|
532
|
-
# },
|
533
|
-
# ],
|
534
|
-
# }
|
535
|
-
#
|
536
438
|
# @!attribute [rw] connection_string
|
537
439
|
# A connection string in the form of a fully qualified domain name
|
538
440
|
# (FQDN), such as `www.example.com`.
|
@@ -569,26 +471,6 @@ module Aws::WorkSpaces
|
|
569
471
|
include Aws::Structure
|
570
472
|
end
|
571
473
|
|
572
|
-
# @note When making an API call, you may pass CreateIpGroupRequest
|
573
|
-
# data as a hash:
|
574
|
-
#
|
575
|
-
# {
|
576
|
-
# group_name: "IpGroupName", # required
|
577
|
-
# group_desc: "IpGroupDesc",
|
578
|
-
# user_rules: [
|
579
|
-
# {
|
580
|
-
# ip_rule: "IpRule",
|
581
|
-
# rule_desc: "IpRuleDesc",
|
582
|
-
# },
|
583
|
-
# ],
|
584
|
-
# tags: [
|
585
|
-
# {
|
586
|
-
# key: "TagKey", # required
|
587
|
-
# value: "TagValue",
|
588
|
-
# },
|
589
|
-
# ],
|
590
|
-
# }
|
591
|
-
#
|
592
474
|
# @!attribute [rw] group_name
|
593
475
|
# The name of the group.
|
594
476
|
# @return [String]
|
@@ -628,19 +510,40 @@ module Aws::WorkSpaces
|
|
628
510
|
include Aws::Structure
|
629
511
|
end
|
630
512
|
|
631
|
-
#
|
632
|
-
#
|
513
|
+
# @!attribute [rw] primary_region
|
514
|
+
# The Region of the primary WorkSpace.
|
515
|
+
# @return [String]
|
516
|
+
#
|
517
|
+
# @!attribute [rw] standby_workspaces
|
518
|
+
# Information about the Standby WorkSpace to be created.
|
519
|
+
# @return [Array<Types::StandbyWorkspace>]
|
520
|
+
#
|
521
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateStandbyWorkspacesRequest AWS API Documentation
|
522
|
+
#
|
523
|
+
class CreateStandbyWorkspacesRequest < Struct.new(
|
524
|
+
:primary_region,
|
525
|
+
:standby_workspaces)
|
526
|
+
SENSITIVE = []
|
527
|
+
include Aws::Structure
|
528
|
+
end
|
529
|
+
|
530
|
+
# @!attribute [rw] failed_standby_requests
|
531
|
+
# Information about the Standby WorkSpace that could not be created.
|
532
|
+
# @return [Array<Types::FailedCreateStandbyWorkspacesRequest>]
|
533
|
+
#
|
534
|
+
# @!attribute [rw] pending_standby_requests
|
535
|
+
# Information about the Standby WorkSpace that was created.
|
536
|
+
# @return [Array<Types::PendingCreateStandbyWorkspacesRequest>]
|
633
537
|
#
|
634
|
-
#
|
635
|
-
# resource_id: "NonEmptyString", # required
|
636
|
-
# tags: [ # required
|
637
|
-
# {
|
638
|
-
# key: "TagKey", # required
|
639
|
-
# value: "TagValue",
|
640
|
-
# },
|
641
|
-
# ],
|
642
|
-
# }
|
538
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateStandbyWorkspacesResult AWS API Documentation
|
643
539
|
#
|
540
|
+
class CreateStandbyWorkspacesResult < Struct.new(
|
541
|
+
:failed_standby_requests,
|
542
|
+
:pending_standby_requests)
|
543
|
+
SENSITIVE = []
|
544
|
+
include Aws::Structure
|
545
|
+
end
|
546
|
+
|
644
547
|
# @!attribute [rw] resource_id
|
645
548
|
# The identifier of the WorkSpaces resource. The supported resource
|
646
549
|
# types are WorkSpaces, registered directories, images, custom
|
@@ -664,21 +567,6 @@ module Aws::WorkSpaces
|
|
664
567
|
#
|
665
568
|
class CreateTagsResult < Aws::EmptyStructure; end
|
666
569
|
|
667
|
-
# @note When making an API call, you may pass CreateUpdatedWorkspaceImageRequest
|
668
|
-
# data as a hash:
|
669
|
-
#
|
670
|
-
# {
|
671
|
-
# name: "WorkspaceImageName", # required
|
672
|
-
# description: "WorkspaceImageDescription", # required
|
673
|
-
# source_image_id: "WorkspaceImageId", # required
|
674
|
-
# tags: [
|
675
|
-
# {
|
676
|
-
# key: "TagKey", # required
|
677
|
-
# value: "TagValue",
|
678
|
-
# },
|
679
|
-
# ],
|
680
|
-
# }
|
681
|
-
#
|
682
570
|
# @!attribute [rw] name
|
683
571
|
# The name of the new updated WorkSpace image.
|
684
572
|
# @return [String]
|
@@ -725,30 +613,6 @@ module Aws::WorkSpaces
|
|
725
613
|
include Aws::Structure
|
726
614
|
end
|
727
615
|
|
728
|
-
# @note When making an API call, you may pass CreateWorkspaceBundleRequest
|
729
|
-
# data as a hash:
|
730
|
-
#
|
731
|
-
# {
|
732
|
-
# bundle_name: "WorkspaceBundleName", # required
|
733
|
-
# bundle_description: "WorkspaceBundleDescription", # required
|
734
|
-
# image_id: "WorkspaceImageId", # required
|
735
|
-
# compute_type: { # required
|
736
|
-
# name: "VALUE", # accepts VALUE, STANDARD, PERFORMANCE, POWER, GRAPHICS, POWERPRO, GRAPHICSPRO, GRAPHICS_G4DN, GRAPHICSPRO_G4DN
|
737
|
-
# },
|
738
|
-
# user_storage: { # required
|
739
|
-
# capacity: "NonEmptyString",
|
740
|
-
# },
|
741
|
-
# root_storage: {
|
742
|
-
# capacity: "NonEmptyString",
|
743
|
-
# },
|
744
|
-
# tags: [
|
745
|
-
# {
|
746
|
-
# key: "TagKey", # required
|
747
|
-
# value: "TagValue",
|
748
|
-
# },
|
749
|
-
# ],
|
750
|
-
# }
|
751
|
-
#
|
752
616
|
# @!attribute [rw] bundle_name
|
753
617
|
# The name of the bundle.
|
754
618
|
# @return [String]
|
@@ -809,21 +673,6 @@ module Aws::WorkSpaces
|
|
809
673
|
include Aws::Structure
|
810
674
|
end
|
811
675
|
|
812
|
-
# @note When making an API call, you may pass CreateWorkspaceImageRequest
|
813
|
-
# data as a hash:
|
814
|
-
#
|
815
|
-
# {
|
816
|
-
# name: "WorkspaceImageName", # required
|
817
|
-
# description: "WorkspaceImageDescription", # required
|
818
|
-
# workspace_id: "WorkspaceId", # required
|
819
|
-
# tags: [
|
820
|
-
# {
|
821
|
-
# key: "TagKey", # required
|
822
|
-
# value: "TagValue",
|
823
|
-
# },
|
824
|
-
# ],
|
825
|
-
# }
|
826
|
-
#
|
827
676
|
# @!attribute [rw] name
|
828
677
|
# The name of the new WorkSpace image.
|
829
678
|
# @return [String]
|
@@ -908,36 +757,6 @@ module Aws::WorkSpaces
|
|
908
757
|
include Aws::Structure
|
909
758
|
end
|
910
759
|
|
911
|
-
# @note When making an API call, you may pass CreateWorkspacesRequest
|
912
|
-
# data as a hash:
|
913
|
-
#
|
914
|
-
# {
|
915
|
-
# workspaces: [ # required
|
916
|
-
# {
|
917
|
-
# directory_id: "DirectoryId", # required
|
918
|
-
# user_name: "UserName", # required
|
919
|
-
# bundle_id: "BundleId", # required
|
920
|
-
# volume_encryption_key: "VolumeEncryptionKey",
|
921
|
-
# user_volume_encryption_enabled: false,
|
922
|
-
# root_volume_encryption_enabled: false,
|
923
|
-
# workspace_properties: {
|
924
|
-
# running_mode: "AUTO_STOP", # accepts AUTO_STOP, ALWAYS_ON, MANUAL
|
925
|
-
# running_mode_auto_stop_timeout_in_minutes: 1,
|
926
|
-
# root_volume_size_gib: 1,
|
927
|
-
# user_volume_size_gib: 1,
|
928
|
-
# compute_type_name: "VALUE", # accepts VALUE, STANDARD, PERFORMANCE, POWER, GRAPHICS, POWERPRO, GRAPHICSPRO, GRAPHICS_G4DN, GRAPHICSPRO_G4DN
|
929
|
-
# protocols: ["PCOIP"], # accepts PCOIP, WSP
|
930
|
-
# },
|
931
|
-
# tags: [
|
932
|
-
# {
|
933
|
-
# key: "TagKey", # required
|
934
|
-
# value: "TagValue",
|
935
|
-
# },
|
936
|
-
# ],
|
937
|
-
# },
|
938
|
-
# ],
|
939
|
-
# }
|
940
|
-
#
|
941
760
|
# @!attribute [rw] workspaces
|
942
761
|
# The WorkSpaces to create. You can specify up to 25 WorkSpaces.
|
943
762
|
# @return [Array<Types::WorkspaceRequest>]
|
@@ -1040,19 +859,6 @@ module Aws::WorkSpaces
|
|
1040
859
|
# Client branding attributes are public facing. Ensure that you do not
|
1041
860
|
# include sensitive information.
|
1042
861
|
#
|
1043
|
-
# @note When making an API call, you may pass DefaultImportClientBrandingAttributes
|
1044
|
-
# data as a hash:
|
1045
|
-
#
|
1046
|
-
# {
|
1047
|
-
# logo: "data",
|
1048
|
-
# support_email: "ClientEmail",
|
1049
|
-
# support_link: "ClientUrl",
|
1050
|
-
# forgot_password_link: "ClientUrl",
|
1051
|
-
# login_message: {
|
1052
|
-
# "ClientLocale" => "ClientLoginMessage",
|
1053
|
-
# },
|
1054
|
-
# }
|
1055
|
-
#
|
1056
862
|
# @!attribute [rw] logo
|
1057
863
|
# The logo. The only image format accepted is a binary data object
|
1058
864
|
# that is converted from a `.png` file.
|
@@ -1181,14 +987,6 @@ module Aws::WorkSpaces
|
|
1181
987
|
include Aws::Structure
|
1182
988
|
end
|
1183
989
|
|
1184
|
-
# @note When making an API call, you may pass DeleteClientBrandingRequest
|
1185
|
-
# data as a hash:
|
1186
|
-
#
|
1187
|
-
# {
|
1188
|
-
# resource_id: "DirectoryId", # required
|
1189
|
-
# platforms: ["DeviceTypeWindows"], # required, accepts DeviceTypeWindows, DeviceTypeOsx, DeviceTypeAndroid, DeviceTypeIos, DeviceTypeLinux, DeviceTypeWeb
|
1190
|
-
# }
|
1191
|
-
#
|
1192
990
|
# @!attribute [rw] resource_id
|
1193
991
|
# The directory identifier of the WorkSpace for which you want to
|
1194
992
|
# delete client branding.
|
@@ -1211,14 +1009,6 @@ module Aws::WorkSpaces
|
|
1211
1009
|
#
|
1212
1010
|
class DeleteClientBrandingResult < Aws::EmptyStructure; end
|
1213
1011
|
|
1214
|
-
# @note When making an API call, you may pass DeleteConnectClientAddInRequest
|
1215
|
-
# data as a hash:
|
1216
|
-
#
|
1217
|
-
# {
|
1218
|
-
# add_in_id: "AmazonUuid", # required
|
1219
|
-
# resource_id: "DirectoryId", # required
|
1220
|
-
# }
|
1221
|
-
#
|
1222
1012
|
# @!attribute [rw] add_in_id
|
1223
1013
|
# The identifier of the client add-in to delete.
|
1224
1014
|
# @return [String]
|
@@ -1240,13 +1030,6 @@ module Aws::WorkSpaces
|
|
1240
1030
|
#
|
1241
1031
|
class DeleteConnectClientAddInResult < Aws::EmptyStructure; end
|
1242
1032
|
|
1243
|
-
# @note When making an API call, you may pass DeleteConnectionAliasRequest
|
1244
|
-
# data as a hash:
|
1245
|
-
#
|
1246
|
-
# {
|
1247
|
-
# alias_id: "ConnectionAliasId", # required
|
1248
|
-
# }
|
1249
|
-
#
|
1250
1033
|
# @!attribute [rw] alias_id
|
1251
1034
|
# The identifier of the connection alias to delete.
|
1252
1035
|
# @return [String]
|
@@ -1263,13 +1046,6 @@ module Aws::WorkSpaces
|
|
1263
1046
|
#
|
1264
1047
|
class DeleteConnectionAliasResult < Aws::EmptyStructure; end
|
1265
1048
|
|
1266
|
-
# @note When making an API call, you may pass DeleteIpGroupRequest
|
1267
|
-
# data as a hash:
|
1268
|
-
#
|
1269
|
-
# {
|
1270
|
-
# group_id: "IpGroupId", # required
|
1271
|
-
# }
|
1272
|
-
#
|
1273
1049
|
# @!attribute [rw] group_id
|
1274
1050
|
# The identifier of the IP access control group.
|
1275
1051
|
# @return [String]
|
@@ -1286,14 +1062,6 @@ module Aws::WorkSpaces
|
|
1286
1062
|
#
|
1287
1063
|
class DeleteIpGroupResult < Aws::EmptyStructure; end
|
1288
1064
|
|
1289
|
-
# @note When making an API call, you may pass DeleteTagsRequest
|
1290
|
-
# data as a hash:
|
1291
|
-
#
|
1292
|
-
# {
|
1293
|
-
# resource_id: "NonEmptyString", # required
|
1294
|
-
# tag_keys: ["NonEmptyString"], # required
|
1295
|
-
# }
|
1296
|
-
#
|
1297
1065
|
# @!attribute [rw] resource_id
|
1298
1066
|
# The identifier of the WorkSpaces resource. The supported resource
|
1299
1067
|
# types are WorkSpaces, registered directories, images, custom
|
@@ -1317,13 +1085,6 @@ module Aws::WorkSpaces
|
|
1317
1085
|
#
|
1318
1086
|
class DeleteTagsResult < Aws::EmptyStructure; end
|
1319
1087
|
|
1320
|
-
# @note When making an API call, you may pass DeleteWorkspaceBundleRequest
|
1321
|
-
# data as a hash:
|
1322
|
-
#
|
1323
|
-
# {
|
1324
|
-
# bundle_id: "BundleId",
|
1325
|
-
# }
|
1326
|
-
#
|
1327
1088
|
# @!attribute [rw] bundle_id
|
1328
1089
|
# The identifier of the bundle.
|
1329
1090
|
# @return [String]
|
@@ -1340,13 +1101,6 @@ module Aws::WorkSpaces
|
|
1340
1101
|
#
|
1341
1102
|
class DeleteWorkspaceBundleResult < Aws::EmptyStructure; end
|
1342
1103
|
|
1343
|
-
# @note When making an API call, you may pass DeleteWorkspaceImageRequest
|
1344
|
-
# data as a hash:
|
1345
|
-
#
|
1346
|
-
# {
|
1347
|
-
# image_id: "WorkspaceImageId", # required
|
1348
|
-
# }
|
1349
|
-
#
|
1350
1104
|
# @!attribute [rw] image_id
|
1351
1105
|
# The identifier of the image.
|
1352
1106
|
# @return [String]
|
@@ -1363,13 +1117,6 @@ module Aws::WorkSpaces
|
|
1363
1117
|
#
|
1364
1118
|
class DeleteWorkspaceImageResult < Aws::EmptyStructure; end
|
1365
1119
|
|
1366
|
-
# @note When making an API call, you may pass DeregisterWorkspaceDirectoryRequest
|
1367
|
-
# data as a hash:
|
1368
|
-
#
|
1369
|
-
# {
|
1370
|
-
# directory_id: "DirectoryId", # required
|
1371
|
-
# }
|
1372
|
-
#
|
1373
1120
|
# @!attribute [rw] directory_id
|
1374
1121
|
# The identifier of the directory. If any WorkSpaces are registered to
|
1375
1122
|
# this directory, you must remove them before you deregister the
|
@@ -1389,13 +1136,6 @@ module Aws::WorkSpaces
|
|
1389
1136
|
#
|
1390
1137
|
class DeregisterWorkspaceDirectoryResult < Aws::EmptyStructure; end
|
1391
1138
|
|
1392
|
-
# @note When making an API call, you may pass DescribeAccountModificationsRequest
|
1393
|
-
# data as a hash:
|
1394
|
-
#
|
1395
|
-
# {
|
1396
|
-
# next_token: "PaginationToken",
|
1397
|
-
# }
|
1398
|
-
#
|
1399
1139
|
# @!attribute [rw] next_token
|
1400
1140
|
# If you received a `NextToken` from a previous call that was
|
1401
1141
|
# paginated, provide this token to receive the next set of results.
|
@@ -1456,13 +1196,6 @@ module Aws::WorkSpaces
|
|
1456
1196
|
include Aws::Structure
|
1457
1197
|
end
|
1458
1198
|
|
1459
|
-
# @note When making an API call, you may pass DescribeClientBrandingRequest
|
1460
|
-
# data as a hash:
|
1461
|
-
#
|
1462
|
-
# {
|
1463
|
-
# resource_id: "DirectoryId", # required
|
1464
|
-
# }
|
1465
|
-
#
|
1466
1199
|
# @!attribute [rw] resource_id
|
1467
1200
|
# The directory identifier of the WorkSpace for which you want to view
|
1468
1201
|
# client branding information.
|
@@ -1513,13 +1246,6 @@ module Aws::WorkSpaces
|
|
1513
1246
|
include Aws::Structure
|
1514
1247
|
end
|
1515
1248
|
|
1516
|
-
# @note When making an API call, you may pass DescribeClientPropertiesRequest
|
1517
|
-
# data as a hash:
|
1518
|
-
#
|
1519
|
-
# {
|
1520
|
-
# resource_ids: ["NonEmptyString"], # required
|
1521
|
-
# }
|
1522
|
-
#
|
1523
1249
|
# @!attribute [rw] resource_ids
|
1524
1250
|
# The resource identifier, in the form of directory IDs.
|
1525
1251
|
# @return [Array<String>]
|
@@ -1544,15 +1270,6 @@ module Aws::WorkSpaces
|
|
1544
1270
|
include Aws::Structure
|
1545
1271
|
end
|
1546
1272
|
|
1547
|
-
# @note When making an API call, you may pass DescribeConnectClientAddInsRequest
|
1548
|
-
# data as a hash:
|
1549
|
-
#
|
1550
|
-
# {
|
1551
|
-
# resource_id: "DirectoryId", # required
|
1552
|
-
# next_token: "PaginationToken",
|
1553
|
-
# max_results: 1,
|
1554
|
-
# }
|
1555
|
-
#
|
1556
1273
|
# @!attribute [rw] resource_id
|
1557
1274
|
# The directory identifier for which the client add-in is configured.
|
1558
1275
|
# @return [String]
|
@@ -1594,15 +1311,6 @@ module Aws::WorkSpaces
|
|
1594
1311
|
include Aws::Structure
|
1595
1312
|
end
|
1596
1313
|
|
1597
|
-
# @note When making an API call, you may pass DescribeConnectionAliasPermissionsRequest
|
1598
|
-
# data as a hash:
|
1599
|
-
#
|
1600
|
-
# {
|
1601
|
-
# alias_id: "ConnectionAliasId", # required
|
1602
|
-
# next_token: "PaginationToken",
|
1603
|
-
# max_results: 1,
|
1604
|
-
# }
|
1605
|
-
#
|
1606
1314
|
# @!attribute [rw] alias_id
|
1607
1315
|
# The identifier of the connection alias.
|
1608
1316
|
# @return [String]
|
@@ -1649,16 +1357,6 @@ module Aws::WorkSpaces
|
|
1649
1357
|
include Aws::Structure
|
1650
1358
|
end
|
1651
1359
|
|
1652
|
-
# @note When making an API call, you may pass DescribeConnectionAliasesRequest
|
1653
|
-
# data as a hash:
|
1654
|
-
#
|
1655
|
-
# {
|
1656
|
-
# alias_ids: ["ConnectionAliasId"],
|
1657
|
-
# resource_id: "NonEmptyString",
|
1658
|
-
# limit: 1,
|
1659
|
-
# next_token: "PaginationToken",
|
1660
|
-
# }
|
1661
|
-
#
|
1662
1360
|
# @!attribute [rw] alias_ids
|
1663
1361
|
# The identifiers of the connection aliases to describe.
|
1664
1362
|
# @return [Array<String>]
|
@@ -1706,15 +1404,6 @@ module Aws::WorkSpaces
|
|
1706
1404
|
include Aws::Structure
|
1707
1405
|
end
|
1708
1406
|
|
1709
|
-
# @note When making an API call, you may pass DescribeIpGroupsRequest
|
1710
|
-
# data as a hash:
|
1711
|
-
#
|
1712
|
-
# {
|
1713
|
-
# group_ids: ["IpGroupId"],
|
1714
|
-
# next_token: "PaginationToken",
|
1715
|
-
# max_results: 1,
|
1716
|
-
# }
|
1717
|
-
#
|
1718
1407
|
# @!attribute [rw] group_ids
|
1719
1408
|
# The identifiers of one or more IP access control groups.
|
1720
1409
|
# @return [Array<String>]
|
@@ -1756,13 +1445,6 @@ module Aws::WorkSpaces
|
|
1756
1445
|
include Aws::Structure
|
1757
1446
|
end
|
1758
1447
|
|
1759
|
-
# @note When making an API call, you may pass DescribeTagsRequest
|
1760
|
-
# data as a hash:
|
1761
|
-
#
|
1762
|
-
# {
|
1763
|
-
# resource_id: "NonEmptyString", # required
|
1764
|
-
# }
|
1765
|
-
#
|
1766
1448
|
# @!attribute [rw] resource_id
|
1767
1449
|
# The identifier of the WorkSpaces resource. The supported resource
|
1768
1450
|
# types are WorkSpaces, registered directories, images, custom
|
@@ -1789,15 +1471,6 @@ module Aws::WorkSpaces
|
|
1789
1471
|
include Aws::Structure
|
1790
1472
|
end
|
1791
1473
|
|
1792
|
-
# @note When making an API call, you may pass DescribeWorkspaceBundlesRequest
|
1793
|
-
# data as a hash:
|
1794
|
-
#
|
1795
|
-
# {
|
1796
|
-
# bundle_ids: ["BundleId"],
|
1797
|
-
# owner: "BundleOwner",
|
1798
|
-
# next_token: "PaginationToken",
|
1799
|
-
# }
|
1800
|
-
#
|
1801
1474
|
# @!attribute [rw] bundle_ids
|
1802
1475
|
# The identifiers of the bundles. You cannot combine this parameter
|
1803
1476
|
# with any other filter.
|
@@ -1846,15 +1519,6 @@ module Aws::WorkSpaces
|
|
1846
1519
|
include Aws::Structure
|
1847
1520
|
end
|
1848
1521
|
|
1849
|
-
# @note When making an API call, you may pass DescribeWorkspaceDirectoriesRequest
|
1850
|
-
# data as a hash:
|
1851
|
-
#
|
1852
|
-
# {
|
1853
|
-
# directory_ids: ["DirectoryId"],
|
1854
|
-
# limit: 1,
|
1855
|
-
# next_token: "PaginationToken",
|
1856
|
-
# }
|
1857
|
-
#
|
1858
1522
|
# @!attribute [rw] directory_ids
|
1859
1523
|
# The identifiers of the directories. If the value is null, all
|
1860
1524
|
# directories are retrieved.
|
@@ -1897,15 +1561,6 @@ module Aws::WorkSpaces
|
|
1897
1561
|
include Aws::Structure
|
1898
1562
|
end
|
1899
1563
|
|
1900
|
-
# @note When making an API call, you may pass DescribeWorkspaceImagePermissionsRequest
|
1901
|
-
# data as a hash:
|
1902
|
-
#
|
1903
|
-
# {
|
1904
|
-
# image_id: "WorkspaceImageId", # required
|
1905
|
-
# next_token: "PaginationToken",
|
1906
|
-
# max_results: 1,
|
1907
|
-
# }
|
1908
|
-
#
|
1909
1564
|
# @!attribute [rw] image_id
|
1910
1565
|
# The identifier of the image.
|
1911
1566
|
# @return [String]
|
@@ -1953,16 +1608,6 @@ module Aws::WorkSpaces
|
|
1953
1608
|
include Aws::Structure
|
1954
1609
|
end
|
1955
1610
|
|
1956
|
-
# @note When making an API call, you may pass DescribeWorkspaceImagesRequest
|
1957
|
-
# data as a hash:
|
1958
|
-
#
|
1959
|
-
# {
|
1960
|
-
# image_ids: ["WorkspaceImageId"],
|
1961
|
-
# image_type: "OWNED", # accepts OWNED, SHARED
|
1962
|
-
# next_token: "PaginationToken",
|
1963
|
-
# max_results: 1,
|
1964
|
-
# }
|
1965
|
-
#
|
1966
1611
|
# @!attribute [rw] image_ids
|
1967
1612
|
# The identifier of the image.
|
1968
1613
|
# @return [Array<String>]
|
@@ -2009,13 +1654,6 @@ module Aws::WorkSpaces
|
|
2009
1654
|
include Aws::Structure
|
2010
1655
|
end
|
2011
1656
|
|
2012
|
-
# @note When making an API call, you may pass DescribeWorkspaceSnapshotsRequest
|
2013
|
-
# data as a hash:
|
2014
|
-
#
|
2015
|
-
# {
|
2016
|
-
# workspace_id: "WorkspaceId", # required
|
2017
|
-
# }
|
2018
|
-
#
|
2019
1657
|
# @!attribute [rw] workspace_id
|
2020
1658
|
# The identifier of the WorkSpace.
|
2021
1659
|
# @return [String]
|
@@ -2048,14 +1686,6 @@ module Aws::WorkSpaces
|
|
2048
1686
|
include Aws::Structure
|
2049
1687
|
end
|
2050
1688
|
|
2051
|
-
# @note When making an API call, you may pass DescribeWorkspacesConnectionStatusRequest
|
2052
|
-
# data as a hash:
|
2053
|
-
#
|
2054
|
-
# {
|
2055
|
-
# workspace_ids: ["WorkspaceId"],
|
2056
|
-
# next_token: "PaginationToken",
|
2057
|
-
# }
|
2058
|
-
#
|
2059
1689
|
# @!attribute [rw] workspace_ids
|
2060
1690
|
# The identifiers of the WorkSpaces. You can specify up to 25
|
2061
1691
|
# WorkSpaces.
|
@@ -2093,18 +1723,6 @@ module Aws::WorkSpaces
|
|
2093
1723
|
include Aws::Structure
|
2094
1724
|
end
|
2095
1725
|
|
2096
|
-
# @note When making an API call, you may pass DescribeWorkspacesRequest
|
2097
|
-
# data as a hash:
|
2098
|
-
#
|
2099
|
-
# {
|
2100
|
-
# workspace_ids: ["WorkspaceId"],
|
2101
|
-
# directory_id: "DirectoryId",
|
2102
|
-
# user_name: "UserName",
|
2103
|
-
# bundle_id: "BundleId",
|
2104
|
-
# limit: 1,
|
2105
|
-
# next_token: "PaginationToken",
|
2106
|
-
# }
|
2107
|
-
#
|
2108
1726
|
# @!attribute [rw] workspace_ids
|
2109
1727
|
# The identifiers of the WorkSpaces. You cannot combine this parameter
|
2110
1728
|
# with any other filter.
|
@@ -2175,13 +1793,6 @@ module Aws::WorkSpaces
|
|
2175
1793
|
include Aws::Structure
|
2176
1794
|
end
|
2177
1795
|
|
2178
|
-
# @note When making an API call, you may pass DisassociateConnectionAliasRequest
|
2179
|
-
# data as a hash:
|
2180
|
-
#
|
2181
|
-
# {
|
2182
|
-
# alias_id: "ConnectionAliasId", # required
|
2183
|
-
# }
|
2184
|
-
#
|
2185
1796
|
# @!attribute [rw] alias_id
|
2186
1797
|
# The identifier of the connection alias to disassociate.
|
2187
1798
|
# @return [String]
|
@@ -2198,14 +1809,6 @@ module Aws::WorkSpaces
|
|
2198
1809
|
#
|
2199
1810
|
class DisassociateConnectionAliasResult < Aws::EmptyStructure; end
|
2200
1811
|
|
2201
|
-
# @note When making an API call, you may pass DisassociateIpGroupsRequest
|
2202
|
-
# data as a hash:
|
2203
|
-
#
|
2204
|
-
# {
|
2205
|
-
# directory_id: "DirectoryId", # required
|
2206
|
-
# group_ids: ["IpGroupId"], # required
|
2207
|
-
# }
|
2208
|
-
#
|
2209
1812
|
# @!attribute [rw] directory_id
|
2210
1813
|
# The identifier of the directory.
|
2211
1814
|
# @return [String]
|
@@ -2227,6 +1830,32 @@ module Aws::WorkSpaces
|
|
2227
1830
|
#
|
2228
1831
|
class DisassociateIpGroupsResult < Aws::EmptyStructure; end
|
2229
1832
|
|
1833
|
+
# Describes the Standby WorkSpace that could not be created.
|
1834
|
+
#
|
1835
|
+
# @!attribute [rw] standby_workspace_request
|
1836
|
+
# Information about the Standby WorkSpace that could not be created.
|
1837
|
+
# @return [Types::StandbyWorkspace]
|
1838
|
+
#
|
1839
|
+
# @!attribute [rw] error_code
|
1840
|
+
# The error code that is returned if the Standby WorkSpace could not
|
1841
|
+
# be created.
|
1842
|
+
# @return [String]
|
1843
|
+
#
|
1844
|
+
# @!attribute [rw] error_message
|
1845
|
+
# The text of the error message that is returned if the Standby
|
1846
|
+
# WorkSpace could not be created.
|
1847
|
+
# @return [String]
|
1848
|
+
#
|
1849
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/FailedCreateStandbyWorkspacesRequest AWS API Documentation
|
1850
|
+
#
|
1851
|
+
class FailedCreateStandbyWorkspacesRequest < Struct.new(
|
1852
|
+
:standby_workspace_request,
|
1853
|
+
:error_code,
|
1854
|
+
:error_message)
|
1855
|
+
SENSITIVE = []
|
1856
|
+
include Aws::Structure
|
1857
|
+
end
|
1858
|
+
|
2230
1859
|
# Describes a WorkSpace that cannot be created.
|
2231
1860
|
#
|
2232
1861
|
# @!attribute [rw] workspace_request
|
@@ -2301,69 +1930,6 @@ module Aws::WorkSpaces
|
|
2301
1930
|
include Aws::Structure
|
2302
1931
|
end
|
2303
1932
|
|
2304
|
-
# @note When making an API call, you may pass ImportClientBrandingRequest
|
2305
|
-
# data as a hash:
|
2306
|
-
#
|
2307
|
-
# {
|
2308
|
-
# resource_id: "DirectoryId", # required
|
2309
|
-
# device_type_windows: {
|
2310
|
-
# logo: "data",
|
2311
|
-
# support_email: "ClientEmail",
|
2312
|
-
# support_link: "ClientUrl",
|
2313
|
-
# forgot_password_link: "ClientUrl",
|
2314
|
-
# login_message: {
|
2315
|
-
# "ClientLocale" => "ClientLoginMessage",
|
2316
|
-
# },
|
2317
|
-
# },
|
2318
|
-
# device_type_osx: {
|
2319
|
-
# logo: "data",
|
2320
|
-
# support_email: "ClientEmail",
|
2321
|
-
# support_link: "ClientUrl",
|
2322
|
-
# forgot_password_link: "ClientUrl",
|
2323
|
-
# login_message: {
|
2324
|
-
# "ClientLocale" => "ClientLoginMessage",
|
2325
|
-
# },
|
2326
|
-
# },
|
2327
|
-
# device_type_android: {
|
2328
|
-
# logo: "data",
|
2329
|
-
# support_email: "ClientEmail",
|
2330
|
-
# support_link: "ClientUrl",
|
2331
|
-
# forgot_password_link: "ClientUrl",
|
2332
|
-
# login_message: {
|
2333
|
-
# "ClientLocale" => "ClientLoginMessage",
|
2334
|
-
# },
|
2335
|
-
# },
|
2336
|
-
# device_type_ios: {
|
2337
|
-
# logo: "data",
|
2338
|
-
# logo_2x: "data",
|
2339
|
-
# logo_3x: "data",
|
2340
|
-
# support_email: "ClientEmail",
|
2341
|
-
# support_link: "ClientUrl",
|
2342
|
-
# forgot_password_link: "ClientUrl",
|
2343
|
-
# login_message: {
|
2344
|
-
# "ClientLocale" => "ClientLoginMessage",
|
2345
|
-
# },
|
2346
|
-
# },
|
2347
|
-
# device_type_linux: {
|
2348
|
-
# logo: "data",
|
2349
|
-
# support_email: "ClientEmail",
|
2350
|
-
# support_link: "ClientUrl",
|
2351
|
-
# forgot_password_link: "ClientUrl",
|
2352
|
-
# login_message: {
|
2353
|
-
# "ClientLocale" => "ClientLoginMessage",
|
2354
|
-
# },
|
2355
|
-
# },
|
2356
|
-
# device_type_web: {
|
2357
|
-
# logo: "data",
|
2358
|
-
# support_email: "ClientEmail",
|
2359
|
-
# support_link: "ClientUrl",
|
2360
|
-
# forgot_password_link: "ClientUrl",
|
2361
|
-
# login_message: {
|
2362
|
-
# "ClientLocale" => "ClientLoginMessage",
|
2363
|
-
# },
|
2364
|
-
# },
|
2365
|
-
# }
|
2366
|
-
#
|
2367
1933
|
# @!attribute [rw] resource_id
|
2368
1934
|
# The directory identifier of the WorkSpace for which you want to
|
2369
1935
|
# import client branding.
|
@@ -2444,23 +2010,6 @@ module Aws::WorkSpaces
|
|
2444
2010
|
include Aws::Structure
|
2445
2011
|
end
|
2446
2012
|
|
2447
|
-
# @note When making an API call, you may pass ImportWorkspaceImageRequest
|
2448
|
-
# data as a hash:
|
2449
|
-
#
|
2450
|
-
# {
|
2451
|
-
# ec2_image_id: "Ec2ImageId", # required
|
2452
|
-
# ingestion_process: "BYOL_REGULAR", # required, accepts BYOL_REGULAR, BYOL_GRAPHICS, BYOL_GRAPHICSPRO, BYOL_GRAPHICS_G4DN, BYOL_REGULAR_WSP, BYOL_REGULAR_BYOP, BYOL_GRAPHICS_G4DN_BYOP
|
2453
|
-
# image_name: "WorkspaceImageName", # required
|
2454
|
-
# image_description: "WorkspaceImageDescription", # required
|
2455
|
-
# tags: [
|
2456
|
-
# {
|
2457
|
-
# key: "TagKey", # required
|
2458
|
-
# value: "TagValue",
|
2459
|
-
# },
|
2460
|
-
# ],
|
2461
|
-
# applications: ["Microsoft_Office_2016"], # accepts Microsoft_Office_2016, Microsoft_Office_2019
|
2462
|
-
# }
|
2463
|
-
#
|
2464
2013
|
# @!attribute [rw] ec2_image_id
|
2465
2014
|
# The identifier of the EC2 image.
|
2466
2015
|
# @return [String]
|
@@ -2673,21 +2222,6 @@ module Aws::WorkSpaces
|
|
2673
2222
|
# Client branding attributes are public facing. Ensure you do not
|
2674
2223
|
# include sensitive information.
|
2675
2224
|
#
|
2676
|
-
# @note When making an API call, you may pass IosImportClientBrandingAttributes
|
2677
|
-
# data as a hash:
|
2678
|
-
#
|
2679
|
-
# {
|
2680
|
-
# logo: "data",
|
2681
|
-
# logo_2x: "data",
|
2682
|
-
# logo_3x: "data",
|
2683
|
-
# support_email: "ClientEmail",
|
2684
|
-
# support_link: "ClientUrl",
|
2685
|
-
# forgot_password_link: "ClientUrl",
|
2686
|
-
# login_message: {
|
2687
|
-
# "ClientLocale" => "ClientLoginMessage",
|
2688
|
-
# },
|
2689
|
-
# }
|
2690
|
-
#
|
2691
2225
|
# @!attribute [rw] logo
|
2692
2226
|
# The logo. This is the standard-resolution display that has a 1:1
|
2693
2227
|
# pixel density (or @1x), where one pixel is equal to one point. The
|
@@ -2782,14 +2316,6 @@ module Aws::WorkSpaces
|
|
2782
2316
|
|
2783
2317
|
# Describes a rule for an IP access control group.
|
2784
2318
|
#
|
2785
|
-
# @note When making an API call, you may pass IpRuleItem
|
2786
|
-
# data as a hash:
|
2787
|
-
#
|
2788
|
-
# {
|
2789
|
-
# ip_rule: "IpRule",
|
2790
|
-
# rule_desc: "IpRuleDesc",
|
2791
|
-
# }
|
2792
|
-
#
|
2793
2319
|
# @!attribute [rw] ip_rule
|
2794
2320
|
# The IP address range, in CIDR notation.
|
2795
2321
|
# @return [String]
|
@@ -2807,15 +2333,6 @@ module Aws::WorkSpaces
|
|
2807
2333
|
include Aws::Structure
|
2808
2334
|
end
|
2809
2335
|
|
2810
|
-
# @note When making an API call, you may pass ListAvailableManagementCidrRangesRequest
|
2811
|
-
# data as a hash:
|
2812
|
-
#
|
2813
|
-
# {
|
2814
|
-
# management_cidr_range_constraint: "ManagementCidrRangeConstraint", # required
|
2815
|
-
# max_results: 1,
|
2816
|
-
# next_token: "PaginationToken",
|
2817
|
-
# }
|
2818
|
-
#
|
2819
2336
|
# @!attribute [rw] management_cidr_range_constraint
|
2820
2337
|
# The IP address range to search. Specify an IP address range that is
|
2821
2338
|
# compatible with your network and in CIDR notation (that is, specify
|
@@ -2860,14 +2377,6 @@ module Aws::WorkSpaces
|
|
2860
2377
|
include Aws::Structure
|
2861
2378
|
end
|
2862
2379
|
|
2863
|
-
# @note When making an API call, you may pass MigrateWorkspaceRequest
|
2864
|
-
# data as a hash:
|
2865
|
-
#
|
2866
|
-
# {
|
2867
|
-
# source_workspace_id: "WorkspaceId", # required
|
2868
|
-
# bundle_id: "BundleId", # required
|
2869
|
-
# }
|
2870
|
-
#
|
2871
2380
|
# @!attribute [rw] source_workspace_id
|
2872
2381
|
# The identifier of the WorkSpace to migrate from.
|
2873
2382
|
# @return [String]
|
@@ -2924,14 +2433,6 @@ module Aws::WorkSpaces
|
|
2924
2433
|
include Aws::Structure
|
2925
2434
|
end
|
2926
2435
|
|
2927
|
-
# @note When making an API call, you may pass ModifyAccountRequest
|
2928
|
-
# data as a hash:
|
2929
|
-
#
|
2930
|
-
# {
|
2931
|
-
# dedicated_tenancy_support: "ENABLED", # accepts ENABLED
|
2932
|
-
# dedicated_tenancy_management_cidr_range: "DedicatedTenancyManagementCidrRange",
|
2933
|
-
# }
|
2934
|
-
#
|
2935
2436
|
# @!attribute [rw] dedicated_tenancy_support
|
2936
2437
|
# The status of BYOL.
|
2937
2438
|
# @return [String]
|
@@ -2958,18 +2459,6 @@ module Aws::WorkSpaces
|
|
2958
2459
|
#
|
2959
2460
|
class ModifyAccountResult < Aws::EmptyStructure; end
|
2960
2461
|
|
2961
|
-
# @note When making an API call, you may pass ModifyCertificateBasedAuthPropertiesRequest
|
2962
|
-
# data as a hash:
|
2963
|
-
#
|
2964
|
-
# {
|
2965
|
-
# resource_id: "DirectoryId", # required
|
2966
|
-
# certificate_based_auth_properties: {
|
2967
|
-
# status: "DISABLED", # accepts DISABLED, ENABLED
|
2968
|
-
# certificate_authority_arn: "CertificateAuthorityArn",
|
2969
|
-
# },
|
2970
|
-
# properties_to_delete: ["CERTIFICATE_BASED_AUTH_PROPERTIES_CERTIFICATE_AUTHORITY_ARN"], # accepts CERTIFICATE_BASED_AUTH_PROPERTIES_CERTIFICATE_AUTHORITY_ARN
|
2971
|
-
# }
|
2972
|
-
#
|
2973
2462
|
# @!attribute [rw] resource_id
|
2974
2463
|
# The resource identifiers, in the form of directory IDs.
|
2975
2464
|
# @return [String]
|
@@ -2997,17 +2486,6 @@ module Aws::WorkSpaces
|
|
2997
2486
|
#
|
2998
2487
|
class ModifyCertificateBasedAuthPropertiesResult < Aws::EmptyStructure; end
|
2999
2488
|
|
3000
|
-
# @note When making an API call, you may pass ModifyClientPropertiesRequest
|
3001
|
-
# data as a hash:
|
3002
|
-
#
|
3003
|
-
# {
|
3004
|
-
# resource_id: "NonEmptyString", # required
|
3005
|
-
# client_properties: { # required
|
3006
|
-
# reconnect_enabled: "ENABLED", # accepts ENABLED, DISABLED
|
3007
|
-
# log_upload_enabled: "ENABLED", # accepts ENABLED, DISABLED
|
3008
|
-
# },
|
3009
|
-
# }
|
3010
|
-
#
|
3011
2489
|
# @!attribute [rw] resource_id
|
3012
2490
|
# The resource identifiers, in the form of directory IDs.
|
3013
2491
|
# @return [String]
|
@@ -3029,19 +2507,6 @@ module Aws::WorkSpaces
|
|
3029
2507
|
#
|
3030
2508
|
class ModifyClientPropertiesResult < Aws::EmptyStructure; end
|
3031
2509
|
|
3032
|
-
# @note When making an API call, you may pass ModifySamlPropertiesRequest
|
3033
|
-
# data as a hash:
|
3034
|
-
#
|
3035
|
-
# {
|
3036
|
-
# resource_id: "DirectoryId", # required
|
3037
|
-
# saml_properties: {
|
3038
|
-
# status: "DISABLED", # accepts DISABLED, ENABLED, ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK
|
3039
|
-
# user_access_url: "SamlUserAccessUrl",
|
3040
|
-
# relay_state_parameter_name: "NonEmptyString",
|
3041
|
-
# },
|
3042
|
-
# properties_to_delete: ["SAML_PROPERTIES_USER_ACCESS_URL"], # accepts SAML_PROPERTIES_USER_ACCESS_URL, SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME
|
3043
|
-
# }
|
3044
|
-
#
|
3045
2510
|
# @!attribute [rw] resource_id
|
3046
2511
|
# The directory identifier for which you want to configure SAML
|
3047
2512
|
# properties.
|
@@ -3076,20 +2541,6 @@ module Aws::WorkSpaces
|
|
3076
2541
|
#
|
3077
2542
|
class ModifySamlPropertiesResult < Aws::EmptyStructure; end
|
3078
2543
|
|
3079
|
-
# @note When making an API call, you may pass ModifySelfservicePermissionsRequest
|
3080
|
-
# data as a hash:
|
3081
|
-
#
|
3082
|
-
# {
|
3083
|
-
# resource_id: "DirectoryId", # required
|
3084
|
-
# selfservice_permissions: { # required
|
3085
|
-
# restart_workspace: "ENABLED", # accepts ENABLED, DISABLED
|
3086
|
-
# increase_volume_size: "ENABLED", # accepts ENABLED, DISABLED
|
3087
|
-
# change_compute_type: "ENABLED", # accepts ENABLED, DISABLED
|
3088
|
-
# switch_running_mode: "ENABLED", # accepts ENABLED, DISABLED
|
3089
|
-
# rebuild_workspace: "ENABLED", # accepts ENABLED, DISABLED
|
3090
|
-
# },
|
3091
|
-
# }
|
3092
|
-
#
|
3093
2544
|
# @!attribute [rw] resource_id
|
3094
2545
|
# The identifier of the directory.
|
3095
2546
|
# @return [String]
|
@@ -3111,23 +2562,6 @@ module Aws::WorkSpaces
|
|
3111
2562
|
#
|
3112
2563
|
class ModifySelfservicePermissionsResult < Aws::EmptyStructure; end
|
3113
2564
|
|
3114
|
-
# @note When making an API call, you may pass ModifyWorkspaceAccessPropertiesRequest
|
3115
|
-
# data as a hash:
|
3116
|
-
#
|
3117
|
-
# {
|
3118
|
-
# resource_id: "DirectoryId", # required
|
3119
|
-
# workspace_access_properties: { # required
|
3120
|
-
# device_type_windows: "ALLOW", # accepts ALLOW, DENY
|
3121
|
-
# device_type_osx: "ALLOW", # accepts ALLOW, DENY
|
3122
|
-
# device_type_web: "ALLOW", # accepts ALLOW, DENY
|
3123
|
-
# device_type_ios: "ALLOW", # accepts ALLOW, DENY
|
3124
|
-
# device_type_android: "ALLOW", # accepts ALLOW, DENY
|
3125
|
-
# device_type_chrome_os: "ALLOW", # accepts ALLOW, DENY
|
3126
|
-
# device_type_zero_client: "ALLOW", # accepts ALLOW, DENY
|
3127
|
-
# device_type_linux: "ALLOW", # accepts ALLOW, DENY
|
3128
|
-
# },
|
3129
|
-
# }
|
3130
|
-
#
|
3131
2565
|
# @!attribute [rw] resource_id
|
3132
2566
|
# The identifier of the directory.
|
3133
2567
|
# @return [String]
|
@@ -3150,21 +2584,6 @@ module Aws::WorkSpaces
|
|
3150
2584
|
#
|
3151
2585
|
class ModifyWorkspaceAccessPropertiesResult < Aws::EmptyStructure; end
|
3152
2586
|
|
3153
|
-
# @note When making an API call, you may pass ModifyWorkspaceCreationPropertiesRequest
|
3154
|
-
# data as a hash:
|
3155
|
-
#
|
3156
|
-
# {
|
3157
|
-
# resource_id: "DirectoryId", # required
|
3158
|
-
# workspace_creation_properties: { # required
|
3159
|
-
# enable_work_docs: false,
|
3160
|
-
# enable_internet_access: false,
|
3161
|
-
# default_ou: "DefaultOu",
|
3162
|
-
# custom_security_group_id: "SecurityGroupId",
|
3163
|
-
# user_enabled_as_local_administrator: false,
|
3164
|
-
# enable_maintenance_mode: false,
|
3165
|
-
# },
|
3166
|
-
# }
|
3167
|
-
#
|
3168
2587
|
# @!attribute [rw] resource_id
|
3169
2588
|
# The identifier of the directory.
|
3170
2589
|
# @return [String]
|
@@ -3186,21 +2605,6 @@ module Aws::WorkSpaces
|
|
3186
2605
|
#
|
3187
2606
|
class ModifyWorkspaceCreationPropertiesResult < Aws::EmptyStructure; end
|
3188
2607
|
|
3189
|
-
# @note When making an API call, you may pass ModifyWorkspacePropertiesRequest
|
3190
|
-
# data as a hash:
|
3191
|
-
#
|
3192
|
-
# {
|
3193
|
-
# workspace_id: "WorkspaceId", # required
|
3194
|
-
# workspace_properties: { # required
|
3195
|
-
# running_mode: "AUTO_STOP", # accepts AUTO_STOP, ALWAYS_ON, MANUAL
|
3196
|
-
# running_mode_auto_stop_timeout_in_minutes: 1,
|
3197
|
-
# root_volume_size_gib: 1,
|
3198
|
-
# user_volume_size_gib: 1,
|
3199
|
-
# compute_type_name: "VALUE", # accepts VALUE, STANDARD, PERFORMANCE, POWER, GRAPHICS, POWERPRO, GRAPHICSPRO, GRAPHICS_G4DN, GRAPHICSPRO_G4DN
|
3200
|
-
# protocols: ["PCOIP"], # accepts PCOIP, WSP
|
3201
|
-
# },
|
3202
|
-
# }
|
3203
|
-
#
|
3204
2608
|
# @!attribute [rw] workspace_id
|
3205
2609
|
# The identifier of the WorkSpace.
|
3206
2610
|
# @return [String]
|
@@ -3222,14 +2626,6 @@ module Aws::WorkSpaces
|
|
3222
2626
|
#
|
3223
2627
|
class ModifyWorkspacePropertiesResult < Aws::EmptyStructure; end
|
3224
2628
|
|
3225
|
-
# @note When making an API call, you may pass ModifyWorkspaceStateRequest
|
3226
|
-
# data as a hash:
|
3227
|
-
#
|
3228
|
-
# {
|
3229
|
-
# workspace_id: "WorkspaceId", # required
|
3230
|
-
# workspace_state: "AVAILABLE", # required, accepts AVAILABLE, ADMIN_MAINTENANCE
|
3231
|
-
# }
|
3232
|
-
#
|
3233
2629
|
# @!attribute [rw] workspace_id
|
3234
2630
|
# The identifier of the WorkSpace.
|
3235
2631
|
# @return [String]
|
@@ -3298,14 +2694,45 @@ module Aws::WorkSpaces
|
|
3298
2694
|
include Aws::Structure
|
3299
2695
|
end
|
3300
2696
|
|
3301
|
-
#
|
2697
|
+
# Information about the Standby WorkSpace.
|
2698
|
+
#
|
2699
|
+
# @!attribute [rw] user_name
|
2700
|
+
# Describes the Standby WorkSpace that was created.
|
2701
|
+
#
|
2702
|
+
# Because this operation is asynchronous, the identifier returned is
|
2703
|
+
# not immediately available for use with other operations. For
|
2704
|
+
# example, if you call [ DescribeWorkspaces][1] before the WorkSpace
|
2705
|
+
# is created, the information returned can be incomplete.
|
3302
2706
|
#
|
3303
|
-
# @note When making an API call, you may pass RebootRequest
|
3304
|
-
# data as a hash:
|
3305
2707
|
#
|
3306
|
-
#
|
3307
|
-
#
|
3308
|
-
#
|
2708
|
+
#
|
2709
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html
|
2710
|
+
# @return [String]
|
2711
|
+
#
|
2712
|
+
# @!attribute [rw] directory_id
|
2713
|
+
# The identifier of the directory for the Standby WorkSpace.
|
2714
|
+
# @return [String]
|
2715
|
+
#
|
2716
|
+
# @!attribute [rw] state
|
2717
|
+
# The operational state of the Standby WorkSpace.
|
2718
|
+
# @return [String]
|
2719
|
+
#
|
2720
|
+
# @!attribute [rw] workspace_id
|
2721
|
+
# The identifier of the Standby WorkSpace.
|
2722
|
+
# @return [String]
|
2723
|
+
#
|
2724
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/PendingCreateStandbyWorkspacesRequest AWS API Documentation
|
2725
|
+
#
|
2726
|
+
class PendingCreateStandbyWorkspacesRequest < Struct.new(
|
2727
|
+
:user_name,
|
2728
|
+
:directory_id,
|
2729
|
+
:state,
|
2730
|
+
:workspace_id)
|
2731
|
+
SENSITIVE = []
|
2732
|
+
include Aws::Structure
|
2733
|
+
end
|
2734
|
+
|
2735
|
+
# Describes the information used to reboot a WorkSpace.
|
3309
2736
|
#
|
3310
2737
|
# @!attribute [rw] workspace_id
|
3311
2738
|
# The identifier of the WorkSpace.
|
@@ -3319,17 +2746,6 @@ module Aws::WorkSpaces
|
|
3319
2746
|
include Aws::Structure
|
3320
2747
|
end
|
3321
2748
|
|
3322
|
-
# @note When making an API call, you may pass RebootWorkspacesRequest
|
3323
|
-
# data as a hash:
|
3324
|
-
#
|
3325
|
-
# {
|
3326
|
-
# reboot_workspace_requests: [ # required
|
3327
|
-
# {
|
3328
|
-
# workspace_id: "WorkspaceId", # required
|
3329
|
-
# },
|
3330
|
-
# ],
|
3331
|
-
# }
|
3332
|
-
#
|
3333
2749
|
# @!attribute [rw] reboot_workspace_requests
|
3334
2750
|
# The WorkSpaces to reboot. You can specify up to 25 WorkSpaces.
|
3335
2751
|
# @return [Array<Types::RebootRequest>]
|
@@ -3356,13 +2772,6 @@ module Aws::WorkSpaces
|
|
3356
2772
|
|
3357
2773
|
# Describes the information used to rebuild a WorkSpace.
|
3358
2774
|
#
|
3359
|
-
# @note When making an API call, you may pass RebuildRequest
|
3360
|
-
# data as a hash:
|
3361
|
-
#
|
3362
|
-
# {
|
3363
|
-
# workspace_id: "WorkspaceId", # required
|
3364
|
-
# }
|
3365
|
-
#
|
3366
2775
|
# @!attribute [rw] workspace_id
|
3367
2776
|
# The identifier of the WorkSpace.
|
3368
2777
|
# @return [String]
|
@@ -3375,17 +2784,6 @@ module Aws::WorkSpaces
|
|
3375
2784
|
include Aws::Structure
|
3376
2785
|
end
|
3377
2786
|
|
3378
|
-
# @note When making an API call, you may pass RebuildWorkspacesRequest
|
3379
|
-
# data as a hash:
|
3380
|
-
#
|
3381
|
-
# {
|
3382
|
-
# rebuild_workspace_requests: [ # required
|
3383
|
-
# {
|
3384
|
-
# workspace_id: "WorkspaceId", # required
|
3385
|
-
# },
|
3386
|
-
# ],
|
3387
|
-
# }
|
3388
|
-
#
|
3389
2787
|
# @!attribute [rw] rebuild_workspace_requests
|
3390
2788
|
# The WorkSpace to rebuild. You can specify a single WorkSpace.
|
3391
2789
|
# @return [Array<Types::RebuildRequest>]
|
@@ -3410,23 +2808,6 @@ module Aws::WorkSpaces
|
|
3410
2808
|
include Aws::Structure
|
3411
2809
|
end
|
3412
2810
|
|
3413
|
-
# @note When making an API call, you may pass RegisterWorkspaceDirectoryRequest
|
3414
|
-
# data as a hash:
|
3415
|
-
#
|
3416
|
-
# {
|
3417
|
-
# directory_id: "DirectoryId", # required
|
3418
|
-
# subnet_ids: ["SubnetId"],
|
3419
|
-
# enable_work_docs: false, # required
|
3420
|
-
# enable_self_service: false,
|
3421
|
-
# tenancy: "DEDICATED", # accepts DEDICATED, SHARED
|
3422
|
-
# tags: [
|
3423
|
-
# {
|
3424
|
-
# key: "TagKey", # required
|
3425
|
-
# value: "TagValue",
|
3426
|
-
# },
|
3427
|
-
# ],
|
3428
|
-
# }
|
3429
|
-
#
|
3430
2811
|
# @!attribute [rw] directory_id
|
3431
2812
|
# The identifier of the directory. You cannot register a directory if
|
3432
2813
|
# it does not have a status of Active. If the directory does not have
|
@@ -3492,6 +2873,37 @@ module Aws::WorkSpaces
|
|
3492
2873
|
#
|
3493
2874
|
class RegisterWorkspaceDirectoryResult < Aws::EmptyStructure; end
|
3494
2875
|
|
2876
|
+
# Describes the related WorkSpace. The related WorkSpace could be a
|
2877
|
+
# Standby WorkSpace or Primary WorkSpace related to the specified
|
2878
|
+
# WorkSpace.
|
2879
|
+
#
|
2880
|
+
# @!attribute [rw] workspace_id
|
2881
|
+
# The identifier of the related WorkSpace.
|
2882
|
+
# @return [String]
|
2883
|
+
#
|
2884
|
+
# @!attribute [rw] region
|
2885
|
+
# The Region of the related WorkSpace.
|
2886
|
+
# @return [String]
|
2887
|
+
#
|
2888
|
+
# @!attribute [rw] state
|
2889
|
+
# Indicates the state of the WorkSpace.
|
2890
|
+
# @return [String]
|
2891
|
+
#
|
2892
|
+
# @!attribute [rw] type
|
2893
|
+
# Indicates the type of WorkSpace.
|
2894
|
+
# @return [String]
|
2895
|
+
#
|
2896
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/RelatedWorkspaceProperties AWS API Documentation
|
2897
|
+
#
|
2898
|
+
class RelatedWorkspaceProperties < Struct.new(
|
2899
|
+
:workspace_id,
|
2900
|
+
:region,
|
2901
|
+
:state,
|
2902
|
+
:type)
|
2903
|
+
SENSITIVE = []
|
2904
|
+
include Aws::Structure
|
2905
|
+
end
|
2906
|
+
|
3495
2907
|
# The specified resource already exists.
|
3496
2908
|
#
|
3497
2909
|
# @!attribute [rw] message
|
@@ -3583,13 +2995,6 @@ module Aws::WorkSpaces
|
|
3583
2995
|
include Aws::Structure
|
3584
2996
|
end
|
3585
2997
|
|
3586
|
-
# @note When making an API call, you may pass RestoreWorkspaceRequest
|
3587
|
-
# data as a hash:
|
3588
|
-
#
|
3589
|
-
# {
|
3590
|
-
# workspace_id: "WorkspaceId", # required
|
3591
|
-
# }
|
3592
|
-
#
|
3593
2998
|
# @!attribute [rw] workspace_id
|
3594
2999
|
# The identifier of the WorkSpace.
|
3595
3000
|
# @return [String]
|
@@ -3606,14 +3011,6 @@ module Aws::WorkSpaces
|
|
3606
3011
|
#
|
3607
3012
|
class RestoreWorkspaceResult < Aws::EmptyStructure; end
|
3608
3013
|
|
3609
|
-
# @note When making an API call, you may pass RevokeIpRulesRequest
|
3610
|
-
# data as a hash:
|
3611
|
-
#
|
3612
|
-
# {
|
3613
|
-
# group_id: "IpGroupId", # required
|
3614
|
-
# user_rules: ["IpRule"], # required
|
3615
|
-
# }
|
3616
|
-
#
|
3617
3014
|
# @!attribute [rw] group_id
|
3618
3015
|
# The identifier of the group.
|
3619
3016
|
# @return [String]
|
@@ -3637,13 +3034,6 @@ module Aws::WorkSpaces
|
|
3637
3034
|
|
3638
3035
|
# Describes the root volume for a WorkSpace bundle.
|
3639
3036
|
#
|
3640
|
-
# @note When making an API call, you may pass RootStorage
|
3641
|
-
# data as a hash:
|
3642
|
-
#
|
3643
|
-
# {
|
3644
|
-
# capacity: "NonEmptyString",
|
3645
|
-
# }
|
3646
|
-
#
|
3647
3037
|
# @!attribute [rw] capacity
|
3648
3038
|
# The size of the root volume.
|
3649
3039
|
# @return [String]
|
@@ -3660,15 +3050,6 @@ module Aws::WorkSpaces
|
|
3660
3050
|
# parameter name that are used for configuring federation with an SAML
|
3661
3051
|
# 2.0 identity provider.
|
3662
3052
|
#
|
3663
|
-
# @note When making an API call, you may pass SamlProperties
|
3664
|
-
# data as a hash:
|
3665
|
-
#
|
3666
|
-
# {
|
3667
|
-
# status: "DISABLED", # accepts DISABLED, ENABLED, ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK
|
3668
|
-
# user_access_url: "SamlUserAccessUrl",
|
3669
|
-
# relay_state_parameter_name: "NonEmptyString",
|
3670
|
-
# }
|
3671
|
-
#
|
3672
3053
|
# @!attribute [rw] status
|
3673
3054
|
# Indicates the status of SAML 2.0 authentication. These statuses
|
3674
3055
|
# include the following.
|
@@ -3726,17 +3107,6 @@ module Aws::WorkSpaces
|
|
3726
3107
|
#
|
3727
3108
|
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/enable-user-self-service-workspace-management.html
|
3728
3109
|
#
|
3729
|
-
# @note When making an API call, you may pass SelfservicePermissions
|
3730
|
-
# data as a hash:
|
3731
|
-
#
|
3732
|
-
# {
|
3733
|
-
# restart_workspace: "ENABLED", # accepts ENABLED, DISABLED
|
3734
|
-
# increase_volume_size: "ENABLED", # accepts ENABLED, DISABLED
|
3735
|
-
# change_compute_type: "ENABLED", # accepts ENABLED, DISABLED
|
3736
|
-
# switch_running_mode: "ENABLED", # accepts ENABLED, DISABLED
|
3737
|
-
# rebuild_workspace: "ENABLED", # accepts ENABLED, DISABLED
|
3738
|
-
# }
|
3739
|
-
#
|
3740
3110
|
# @!attribute [rw] restart_workspace
|
3741
3111
|
# Specifies whether users can restart their WorkSpace.
|
3742
3112
|
# @return [String]
|
@@ -3787,14 +3157,36 @@ module Aws::WorkSpaces
|
|
3787
3157
|
include Aws::Structure
|
3788
3158
|
end
|
3789
3159
|
|
3790
|
-
#
|
3160
|
+
# Describes a Standby WorkSpace.
|
3161
|
+
#
|
3162
|
+
# @!attribute [rw] primary_workspace_id
|
3163
|
+
# The identifier of the Standby WorkSpace.
|
3164
|
+
# @return [String]
|
3165
|
+
#
|
3166
|
+
# @!attribute [rw] volume_encryption_key
|
3167
|
+
# The volume encryption key of the Standby WorkSpace.
|
3168
|
+
# @return [String]
|
3169
|
+
#
|
3170
|
+
# @!attribute [rw] directory_id
|
3171
|
+
# The identifier of the directory for the Standby WorkSpace.
|
3172
|
+
# @return [String]
|
3173
|
+
#
|
3174
|
+
# @!attribute [rw] tags
|
3175
|
+
# The tags associated with the Standby WorkSpace.
|
3176
|
+
# @return [Array<Types::Tag>]
|
3791
3177
|
#
|
3792
|
-
# @
|
3793
|
-
# data as a hash:
|
3178
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/StandbyWorkspace AWS API Documentation
|
3794
3179
|
#
|
3795
|
-
|
3796
|
-
|
3797
|
-
|
3180
|
+
class StandbyWorkspace < Struct.new(
|
3181
|
+
:primary_workspace_id,
|
3182
|
+
:volume_encryption_key,
|
3183
|
+
:directory_id,
|
3184
|
+
:tags)
|
3185
|
+
SENSITIVE = []
|
3186
|
+
include Aws::Structure
|
3187
|
+
end
|
3188
|
+
|
3189
|
+
# Information used to start a WorkSpace.
|
3798
3190
|
#
|
3799
3191
|
# @!attribute [rw] workspace_id
|
3800
3192
|
# The identifier of the WorkSpace.
|
@@ -3808,17 +3200,6 @@ module Aws::WorkSpaces
|
|
3808
3200
|
include Aws::Structure
|
3809
3201
|
end
|
3810
3202
|
|
3811
|
-
# @note When making an API call, you may pass StartWorkspacesRequest
|
3812
|
-
# data as a hash:
|
3813
|
-
#
|
3814
|
-
# {
|
3815
|
-
# start_workspace_requests: [ # required
|
3816
|
-
# {
|
3817
|
-
# workspace_id: "WorkspaceId",
|
3818
|
-
# },
|
3819
|
-
# ],
|
3820
|
-
# }
|
3821
|
-
#
|
3822
3203
|
# @!attribute [rw] start_workspace_requests
|
3823
3204
|
# The WorkSpaces to start. You can specify up to 25 WorkSpaces.
|
3824
3205
|
# @return [Array<Types::StartRequest>]
|
@@ -3845,13 +3226,6 @@ module Aws::WorkSpaces
|
|
3845
3226
|
|
3846
3227
|
# Describes the information used to stop a WorkSpace.
|
3847
3228
|
#
|
3848
|
-
# @note When making an API call, you may pass StopRequest
|
3849
|
-
# data as a hash:
|
3850
|
-
#
|
3851
|
-
# {
|
3852
|
-
# workspace_id: "WorkspaceId",
|
3853
|
-
# }
|
3854
|
-
#
|
3855
3229
|
# @!attribute [rw] workspace_id
|
3856
3230
|
# The identifier of the WorkSpace.
|
3857
3231
|
# @return [String]
|
@@ -3864,17 +3238,6 @@ module Aws::WorkSpaces
|
|
3864
3238
|
include Aws::Structure
|
3865
3239
|
end
|
3866
3240
|
|
3867
|
-
# @note When making an API call, you may pass StopWorkspacesRequest
|
3868
|
-
# data as a hash:
|
3869
|
-
#
|
3870
|
-
# {
|
3871
|
-
# stop_workspace_requests: [ # required
|
3872
|
-
# {
|
3873
|
-
# workspace_id: "WorkspaceId",
|
3874
|
-
# },
|
3875
|
-
# ],
|
3876
|
-
# }
|
3877
|
-
#
|
3878
3241
|
# @!attribute [rw] stop_workspace_requests
|
3879
3242
|
# The WorkSpaces to stop. You can specify up to 25 WorkSpaces.
|
3880
3243
|
# @return [Array<Types::StopRequest>]
|
@@ -3901,14 +3264,6 @@ module Aws::WorkSpaces
|
|
3901
3264
|
|
3902
3265
|
# Describes a tag.
|
3903
3266
|
#
|
3904
|
-
# @note When making an API call, you may pass Tag
|
3905
|
-
# data as a hash:
|
3906
|
-
#
|
3907
|
-
# {
|
3908
|
-
# key: "TagKey", # required
|
3909
|
-
# value: "TagValue",
|
3910
|
-
# }
|
3911
|
-
#
|
3912
3267
|
# @!attribute [rw] key
|
3913
3268
|
# The key of the tag.
|
3914
3269
|
# @return [String]
|
@@ -3928,13 +3283,6 @@ module Aws::WorkSpaces
|
|
3928
3283
|
|
3929
3284
|
# Describes the information used to terminate a WorkSpace.
|
3930
3285
|
#
|
3931
|
-
# @note When making an API call, you may pass TerminateRequest
|
3932
|
-
# data as a hash:
|
3933
|
-
#
|
3934
|
-
# {
|
3935
|
-
# workspace_id: "WorkspaceId", # required
|
3936
|
-
# }
|
3937
|
-
#
|
3938
3286
|
# @!attribute [rw] workspace_id
|
3939
3287
|
# The identifier of the WorkSpace.
|
3940
3288
|
# @return [String]
|
@@ -3947,17 +3295,6 @@ module Aws::WorkSpaces
|
|
3947
3295
|
include Aws::Structure
|
3948
3296
|
end
|
3949
3297
|
|
3950
|
-
# @note When making an API call, you may pass TerminateWorkspacesRequest
|
3951
|
-
# data as a hash:
|
3952
|
-
#
|
3953
|
-
# {
|
3954
|
-
# terminate_workspace_requests: [ # required
|
3955
|
-
# {
|
3956
|
-
# workspace_id: "WorkspaceId", # required
|
3957
|
-
# },
|
3958
|
-
# ],
|
3959
|
-
# }
|
3960
|
-
#
|
3961
3298
|
# @!attribute [rw] terminate_workspace_requests
|
3962
3299
|
# The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.
|
3963
3300
|
# @return [Array<Types::TerminateRequest>]
|
@@ -4021,16 +3358,6 @@ module Aws::WorkSpaces
|
|
4021
3358
|
include Aws::Structure
|
4022
3359
|
end
|
4023
3360
|
|
4024
|
-
# @note When making an API call, you may pass UpdateConnectClientAddInRequest
|
4025
|
-
# data as a hash:
|
4026
|
-
#
|
4027
|
-
# {
|
4028
|
-
# add_in_id: "AmazonUuid", # required
|
4029
|
-
# resource_id: "DirectoryId", # required
|
4030
|
-
# name: "AddInName",
|
4031
|
-
# url: "AddInUrl",
|
4032
|
-
# }
|
4033
|
-
#
|
4034
3361
|
# @!attribute [rw] add_in_id
|
4035
3362
|
# The identifier of the client add-in to update.
|
4036
3363
|
# @return [String]
|
@@ -4062,17 +3389,6 @@ module Aws::WorkSpaces
|
|
4062
3389
|
#
|
4063
3390
|
class UpdateConnectClientAddInResult < Aws::EmptyStructure; end
|
4064
3391
|
|
4065
|
-
# @note When making an API call, you may pass UpdateConnectionAliasPermissionRequest
|
4066
|
-
# data as a hash:
|
4067
|
-
#
|
4068
|
-
# {
|
4069
|
-
# alias_id: "ConnectionAliasId", # required
|
4070
|
-
# connection_alias_permission: { # required
|
4071
|
-
# shared_account_id: "AwsAccount", # required
|
4072
|
-
# allow_association: false, # required
|
4073
|
-
# },
|
4074
|
-
# }
|
4075
|
-
#
|
4076
3392
|
# @!attribute [rw] alias_id
|
4077
3393
|
# The identifier of the connection alias that you want to update
|
4078
3394
|
# permissions for.
|
@@ -4123,19 +3439,6 @@ module Aws::WorkSpaces
|
|
4123
3439
|
include Aws::Structure
|
4124
3440
|
end
|
4125
3441
|
|
4126
|
-
# @note When making an API call, you may pass UpdateRulesOfIpGroupRequest
|
4127
|
-
# data as a hash:
|
4128
|
-
#
|
4129
|
-
# {
|
4130
|
-
# group_id: "IpGroupId", # required
|
4131
|
-
# user_rules: [ # required
|
4132
|
-
# {
|
4133
|
-
# ip_rule: "IpRule",
|
4134
|
-
# rule_desc: "IpRuleDesc",
|
4135
|
-
# },
|
4136
|
-
# ],
|
4137
|
-
# }
|
4138
|
-
#
|
4139
3442
|
# @!attribute [rw] group_id
|
4140
3443
|
# The identifier of the group.
|
4141
3444
|
# @return [String]
|
@@ -4157,14 +3460,6 @@ module Aws::WorkSpaces
|
|
4157
3460
|
#
|
4158
3461
|
class UpdateRulesOfIpGroupResult < Aws::EmptyStructure; end
|
4159
3462
|
|
4160
|
-
# @note When making an API call, you may pass UpdateWorkspaceBundleRequest
|
4161
|
-
# data as a hash:
|
4162
|
-
#
|
4163
|
-
# {
|
4164
|
-
# bundle_id: "BundleId",
|
4165
|
-
# image_id: "WorkspaceImageId",
|
4166
|
-
# }
|
4167
|
-
#
|
4168
3463
|
# @!attribute [rw] bundle_id
|
4169
3464
|
# The identifier of the bundle.
|
4170
3465
|
# @return [String]
|
@@ -4186,15 +3481,6 @@ module Aws::WorkSpaces
|
|
4186
3481
|
#
|
4187
3482
|
class UpdateWorkspaceBundleResult < Aws::EmptyStructure; end
|
4188
3483
|
|
4189
|
-
# @note When making an API call, you may pass UpdateWorkspaceImagePermissionRequest
|
4190
|
-
# data as a hash:
|
4191
|
-
#
|
4192
|
-
# {
|
4193
|
-
# image_id: "WorkspaceImageId", # required
|
4194
|
-
# allow_copy_image: false, # required
|
4195
|
-
# shared_account_id: "AwsAccount", # required
|
4196
|
-
# }
|
4197
|
-
#
|
4198
3484
|
# @!attribute [rw] image_id
|
4199
3485
|
# The identifier of the image.
|
4200
3486
|
# @return [String]
|
@@ -4228,13 +3514,6 @@ module Aws::WorkSpaces
|
|
4228
3514
|
|
4229
3515
|
# Describes the user volume for a WorkSpace bundle.
|
4230
3516
|
#
|
4231
|
-
# @note When making an API call, you may pass UserStorage
|
4232
|
-
# data as a hash:
|
4233
|
-
#
|
4234
|
-
# {
|
4235
|
-
# capacity: "NonEmptyString",
|
4236
|
-
# }
|
4237
|
-
#
|
4238
3517
|
# @!attribute [rw] capacity
|
4239
3518
|
# The size of the user volume.
|
4240
3519
|
# @return [String]
|
@@ -4330,6 +3609,11 @@ module Aws::WorkSpaces
|
|
4330
3609
|
# The modification states of the WorkSpace.
|
4331
3610
|
# @return [Array<Types::ModificationState>]
|
4332
3611
|
#
|
3612
|
+
# @!attribute [rw] related_workspaces
|
3613
|
+
# The Standby WorkSpace or Primary WorkSpace related to the specified
|
3614
|
+
# WorkSpace.
|
3615
|
+
# @return [Array<Types::RelatedWorkspaceProperties>]
|
3616
|
+
#
|
4333
3617
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/Workspace AWS API Documentation
|
4334
3618
|
#
|
4335
3619
|
class Workspace < Struct.new(
|
@@ -4347,7 +3631,8 @@ module Aws::WorkSpaces
|
|
4347
3631
|
:user_volume_encryption_enabled,
|
4348
3632
|
:root_volume_encryption_enabled,
|
4349
3633
|
:workspace_properties,
|
4350
|
-
:modification_states
|
3634
|
+
:modification_states,
|
3635
|
+
:related_workspaces)
|
4351
3636
|
SENSITIVE = []
|
4352
3637
|
include Aws::Structure
|
4353
3638
|
end
|
@@ -4360,20 +3645,6 @@ module Aws::WorkSpaces
|
|
4360
3645
|
#
|
4361
3646
|
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-network-requirements.html
|
4362
3647
|
#
|
4363
|
-
# @note When making an API call, you may pass WorkspaceAccessProperties
|
4364
|
-
# data as a hash:
|
4365
|
-
#
|
4366
|
-
# {
|
4367
|
-
# device_type_windows: "ALLOW", # accepts ALLOW, DENY
|
4368
|
-
# device_type_osx: "ALLOW", # accepts ALLOW, DENY
|
4369
|
-
# device_type_web: "ALLOW", # accepts ALLOW, DENY
|
4370
|
-
# device_type_ios: "ALLOW", # accepts ALLOW, DENY
|
4371
|
-
# device_type_android: "ALLOW", # accepts ALLOW, DENY
|
4372
|
-
# device_type_chrome_os: "ALLOW", # accepts ALLOW, DENY
|
4373
|
-
# device_type_zero_client: "ALLOW", # accepts ALLOW, DENY
|
4374
|
-
# device_type_linux: "ALLOW", # accepts ALLOW, DENY
|
4375
|
-
# }
|
4376
|
-
#
|
4377
3648
|
# @!attribute [rw] device_type_windows
|
4378
3649
|
# Indicates whether users can use Windows clients to access their
|
4379
3650
|
# WorkSpaces.
|
@@ -4477,6 +3748,14 @@ module Aws::WorkSpaces
|
|
4477
3748
|
# The time when the bundle was created.
|
4478
3749
|
# @return [Time]
|
4479
3750
|
#
|
3751
|
+
# @!attribute [rw] state
|
3752
|
+
# The state of the WorkSpace bundle.
|
3753
|
+
# @return [String]
|
3754
|
+
#
|
3755
|
+
# @!attribute [rw] bundle_type
|
3756
|
+
# The type of WorkSpace bundle.
|
3757
|
+
# @return [String]
|
3758
|
+
#
|
4480
3759
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceBundle AWS API Documentation
|
4481
3760
|
#
|
4482
3761
|
class WorkspaceBundle < Struct.new(
|
@@ -4489,7 +3768,9 @@ module Aws::WorkSpaces
|
|
4489
3768
|
:user_storage,
|
4490
3769
|
:compute_type,
|
4491
3770
|
:last_updated_time,
|
4492
|
-
:creation_time
|
3771
|
+
:creation_time,
|
3772
|
+
:state,
|
3773
|
+
:bundle_type)
|
4493
3774
|
SENSITIVE = []
|
4494
3775
|
include Aws::Structure
|
4495
3776
|
end
|
@@ -4532,18 +3813,6 @@ module Aws::WorkSpaces
|
|
4532
3813
|
#
|
4533
3814
|
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html
|
4534
3815
|
#
|
4535
|
-
# @note When making an API call, you may pass WorkspaceCreationProperties
|
4536
|
-
# data as a hash:
|
4537
|
-
#
|
4538
|
-
# {
|
4539
|
-
# enable_work_docs: false,
|
4540
|
-
# enable_internet_access: false,
|
4541
|
-
# default_ou: "DefaultOu",
|
4542
|
-
# custom_security_group_id: "SecurityGroupId",
|
4543
|
-
# user_enabled_as_local_administrator: false,
|
4544
|
-
# enable_maintenance_mode: false,
|
4545
|
-
# }
|
4546
|
-
#
|
4547
3816
|
# @!attribute [rw] enable_work_docs
|
4548
3817
|
# Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.
|
4549
3818
|
#
|
@@ -4826,18 +4095,6 @@ module Aws::WorkSpaces
|
|
4826
4095
|
|
4827
4096
|
# Describes a WorkSpace.
|
4828
4097
|
#
|
4829
|
-
# @note When making an API call, you may pass WorkspaceProperties
|
4830
|
-
# data as a hash:
|
4831
|
-
#
|
4832
|
-
# {
|
4833
|
-
# running_mode: "AUTO_STOP", # accepts AUTO_STOP, ALWAYS_ON, MANUAL
|
4834
|
-
# running_mode_auto_stop_timeout_in_minutes: 1,
|
4835
|
-
# root_volume_size_gib: 1,
|
4836
|
-
# user_volume_size_gib: 1,
|
4837
|
-
# compute_type_name: "VALUE", # accepts VALUE, STANDARD, PERFORMANCE, POWER, GRAPHICS, POWERPRO, GRAPHICSPRO, GRAPHICS_G4DN, GRAPHICSPRO_G4DN
|
4838
|
-
# protocols: ["PCOIP"], # accepts PCOIP, WSP
|
4839
|
-
# }
|
4840
|
-
#
|
4841
4098
|
# @!attribute [rw] running_mode
|
4842
4099
|
# The running mode. For more information, see [Manage the WorkSpace
|
4843
4100
|
# Running Mode][1].
|
@@ -4923,32 +4180,6 @@ module Aws::WorkSpaces
|
|
4923
4180
|
|
4924
4181
|
# Describes the information used to create a WorkSpace.
|
4925
4182
|
#
|
4926
|
-
# @note When making an API call, you may pass WorkspaceRequest
|
4927
|
-
# data as a hash:
|
4928
|
-
#
|
4929
|
-
# {
|
4930
|
-
# directory_id: "DirectoryId", # required
|
4931
|
-
# user_name: "UserName", # required
|
4932
|
-
# bundle_id: "BundleId", # required
|
4933
|
-
# volume_encryption_key: "VolumeEncryptionKey",
|
4934
|
-
# user_volume_encryption_enabled: false,
|
4935
|
-
# root_volume_encryption_enabled: false,
|
4936
|
-
# workspace_properties: {
|
4937
|
-
# running_mode: "AUTO_STOP", # accepts AUTO_STOP, ALWAYS_ON, MANUAL
|
4938
|
-
# running_mode_auto_stop_timeout_in_minutes: 1,
|
4939
|
-
# root_volume_size_gib: 1,
|
4940
|
-
# user_volume_size_gib: 1,
|
4941
|
-
# compute_type_name: "VALUE", # accepts VALUE, STANDARD, PERFORMANCE, POWER, GRAPHICS, POWERPRO, GRAPHICSPRO, GRAPHICS_G4DN, GRAPHICSPRO_G4DN
|
4942
|
-
# protocols: ["PCOIP"], # accepts PCOIP, WSP
|
4943
|
-
# },
|
4944
|
-
# tags: [
|
4945
|
-
# {
|
4946
|
-
# key: "TagKey", # required
|
4947
|
-
# value: "TagValue",
|
4948
|
-
# },
|
4949
|
-
# ],
|
4950
|
-
# }
|
4951
|
-
#
|
4952
4183
|
# @!attribute [rw] directory_id
|
4953
4184
|
# The identifier of the Directory Service directory for the WorkSpace.
|
4954
4185
|
# You can use DescribeWorkspaceDirectories to list the available
|