/
service-2.json
3435 lines (3435 loc) · 134 KB
/
service-2.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version":"2.0",
"metadata":{
"apiVersion":"2015-04-08",
"endpointPrefix":"workspaces",
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"Amazon WorkSpaces",
"serviceId":"WorkSpaces",
"signatureVersion":"v4",
"targetPrefix":"WorkspacesService",
"uid":"workspaces-2015-04-08"
},
"operations":{
"AssociateConnectionAlias":{
"name":"AssociateConnectionAlias",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AssociateConnectionAliasRequest"},
"output":{"shape":"AssociateConnectionAliasResult"},
"errors":[
{"shape":"ResourceAssociatedException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValuesException"},
{"shape":"InvalidResourceStateException"},
{"shape":"OperationNotSupportedException"}
],
"documentation":"<p>Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html\"> Cross-Region Redirection for Amazon WorkSpaces</a>.</p> <note> <p>Before performing this operation, call <a href=\"https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html\"> DescribeConnectionAliases</a> to make sure that the current state of the connection alias is <code>CREATED</code>.</p> </note>"
},
"AssociateIpGroups":{
"name":"AssociateIpGroups",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AssociateIpGroupsRequest"},
"output":{"shape":"AssociateIpGroupsResult"},
"errors":[
{"shape":"InvalidParameterValuesException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceLimitExceededException"},
{"shape":"InvalidResourceStateException"},
{"shape":"AccessDeniedException"},
{"shape":"OperationNotSupportedException"}
],
"documentation":"<p>Associates the specified IP access control group with the specified directory.</p>"
},
"AuthorizeIpRules":{
"name":"AuthorizeIpRules",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AuthorizeIpRulesRequest"},
"output":{"shape":"AuthorizeIpRulesResult"},
"errors":[
{"shape":"InvalidParameterValuesException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceLimitExceededException"},
{"shape":"InvalidResourceStateException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Adds one or more rules to the specified IP access control group.</p> <p>This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.</p>"
},
"CopyWorkspaceImage":{
"name":"CopyWorkspaceImage",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CopyWorkspaceImageRequest"},
"output":{"shape":"CopyWorkspaceImageResult"},
"errors":[
{"shape":"ResourceLimitExceededException"},
{"shape":"ResourceAlreadyExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceUnavailableException"},
{"shape":"OperationNotSupportedException"},
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValuesException"}
],
"documentation":"<p>Copies the specified image from the specified Region to the current Region. For more information about copying images, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/copy-custom-image.html\"> Copy a Custom WorkSpaces Image</a>.</p> <important> <p>Before copying a shared image, be sure to verify that it has been shared from the correct AWS account. To determine if an image has been shared and to see the AWS account ID that owns an image, use the <a href=\"https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImages.html\">DescribeWorkSpaceImages</a> and <a href=\"https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImagePermissions.html\">DescribeWorkspaceImagePermissions</a> API operations. </p> </important>"
},
"CreateConnectionAlias":{
"name":"CreateConnectionAlias",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateConnectionAliasRequest"},
"output":{"shape":"CreateConnectionAliasResult"},
"errors":[
{"shape":"ResourceAlreadyExistsException"},
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValuesException"},
{"shape":"ResourceLimitExceededException"},
{"shape":"InvalidResourceStateException"},
{"shape":"OperationNotSupportedException"}
],
"documentation":"<p>Creates the specified connection alias for use with cross-Region redirection. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html\"> Cross-Region Redirection for Amazon WorkSpaces</a>.</p>"
},
"CreateIpGroup":{
"name":"CreateIpGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateIpGroupRequest"},
"output":{"shape":"CreateIpGroupResult"},
"errors":[
{"shape":"InvalidParameterValuesException"},
{"shape":"ResourceLimitExceededException"},
{"shape":"ResourceAlreadyExistsException"},
{"shape":"ResourceCreationFailedException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Creates an IP access control group.</p> <p>An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using <a>AuthorizeIpRules</a>.</p> <p>There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.</p>"
},
"CreateTags":{
"name":"CreateTags",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateTagsRequest"},
"output":{"shape":"CreateTagsResult"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValuesException"},
{"shape":"ResourceLimitExceededException"}
],
"documentation":"<p>Creates the specified tags for the specified WorkSpaces resource.</p>"
},
"CreateWorkspaces":{
"name":"CreateWorkspaces",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateWorkspacesRequest"},
"output":{"shape":"CreateWorkspacesResult"},
"errors":[
{"shape":"ResourceLimitExceededException"},
{"shape":"InvalidParameterValuesException"}
],
"documentation":"<p>Creates one or more WorkSpaces.</p> <p>This operation is asynchronous and returns before the WorkSpaces are created.</p>"
},
"DeleteConnectionAlias":{
"name":"DeleteConnectionAlias",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteConnectionAliasRequest"},
"output":{"shape":"DeleteConnectionAliasResult"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceAssociatedException"},
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValuesException"},
{"shape":"InvalidResourceStateException"},
{"shape":"OperationNotSupportedException"}
],
"documentation":"<p>Deletes the specified connection alias. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html\"> Cross-Region Redirection for Amazon WorkSpaces</a>.</p> <important> <p> <b>If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues.</b> For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html#cross-region-redirection-security-considerations\"> Security Considerations if You Stop Using Cross-Region Redirection</a>.</p> </important> <note> <p>To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.</p> </note>"
},
"DeleteIpGroup":{
"name":"DeleteIpGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteIpGroupRequest"},
"output":{"shape":"DeleteIpGroupResult"},
"errors":[
{"shape":"InvalidParameterValuesException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceAssociatedException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Deletes the specified IP access control group.</p> <p>You cannot delete an IP access control group that is associated with a directory.</p>"
},
"DeleteTags":{
"name":"DeleteTags",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteTagsRequest"},
"output":{"shape":"DeleteTagsResult"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValuesException"}
],
"documentation":"<p>Deletes the specified tags from the specified WorkSpaces resource.</p>"
},
"DeleteWorkspaceImage":{
"name":"DeleteWorkspaceImage",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteWorkspaceImageRequest"},
"output":{"shape":"DeleteWorkspaceImageResult"},
"errors":[
{"shape":"ResourceAssociatedException"},
{"shape":"InvalidResourceStateException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and unshare the image if it is shared with other accounts. </p>"
},
"DeregisterWorkspaceDirectory":{
"name":"DeregisterWorkspaceDirectory",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeregisterWorkspaceDirectoryRequest"},
"output":{"shape":"DeregisterWorkspaceDirectoryResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValuesException"},
{"shape":"OperationNotSupportedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidResourceStateException"}
],
"documentation":"<p>Deregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister the directory.</p>"
},
"DescribeAccount":{
"name":"DescribeAccount",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeAccountRequest"},
"output":{"shape":"DescribeAccountResult"},
"errors":[
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.</p>"
},
"DescribeAccountModifications":{
"name":"DescribeAccountModifications",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeAccountModificationsRequest"},
"output":{"shape":"DescribeAccountModificationsResult"},
"errors":[
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.</p>"
},
"DescribeClientProperties":{
"name":"DescribeClientProperties",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeClientPropertiesRequest"},
"output":{"shape":"DescribeClientPropertiesResult"},
"errors":[
{"shape":"InvalidParameterValuesException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Retrieves a list that describes one or more specified Amazon WorkSpaces clients.</p>"
},
"DescribeConnectionAliasPermissions":{
"name":"DescribeConnectionAliasPermissions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeConnectionAliasPermissionsRequest"},
"output":{"shape":"DescribeConnectionAliasPermissionsResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValuesException"},
{"shape":"ResourceNotFoundException"},
{"shape":"OperationNotSupportedException"}
],
"documentation":"<p>Describes the permissions that the owner of a connection alias has granted to another AWS account for the specified connection alias. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html\"> Cross-Region Redirection for Amazon WorkSpaces</a>.</p>"
},
"DescribeConnectionAliases":{
"name":"DescribeConnectionAliases",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeConnectionAliasesRequest"},
"output":{"shape":"DescribeConnectionAliasesResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValuesException"},
{"shape":"OperationNotSupportedException"}
],
"documentation":"<p>Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html\"> Cross-Region Redirection for Amazon WorkSpaces</a>.</p>"
},
"DescribeIpGroups":{
"name":"DescribeIpGroups",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeIpGroupsRequest"},
"output":{"shape":"DescribeIpGroupsResult"},
"errors":[
{"shape":"InvalidParameterValuesException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Describes one or more of your IP access control groups.</p>"
},
"DescribeTags":{
"name":"DescribeTags",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeTagsRequest"},
"output":{"shape":"DescribeTagsResult"},
"errors":[
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Describes the specified tags for the specified WorkSpaces resource.</p>"
},
"DescribeWorkspaceBundles":{
"name":"DescribeWorkspaceBundles",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeWorkspaceBundlesRequest"},
"output":{"shape":"DescribeWorkspaceBundlesResult"},
"errors":[
{"shape":"InvalidParameterValuesException"}
],
"documentation":"<p>Retrieves a list that describes the available WorkSpace bundles.</p> <p>You can filter the results using either bundle ID or owner, but not both.</p>"
},
"DescribeWorkspaceDirectories":{
"name":"DescribeWorkspaceDirectories",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeWorkspaceDirectoriesRequest"},
"output":{"shape":"DescribeWorkspaceDirectoriesResult"},
"errors":[
{"shape":"InvalidParameterValuesException"}
],
"documentation":"<p>Describes the available directories that are registered with Amazon WorkSpaces.</p>"
},
"DescribeWorkspaceImagePermissions":{
"name":"DescribeWorkspaceImagePermissions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeWorkspaceImagePermissionsRequest"},
"output":{"shape":"DescribeWorkspaceImagePermissionsResult"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValuesException"}
],
"documentation":"<p>Describes the permissions that the owner of an image has granted to other AWS accounts for an image.</p>"
},
"DescribeWorkspaceImages":{
"name":"DescribeWorkspaceImages",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeWorkspaceImagesRequest"},
"output":{"shape":"DescribeWorkspaceImagesResult"},
"errors":[
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described. </p>"
},
"DescribeWorkspaceSnapshots":{
"name":"DescribeWorkspaceSnapshots",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeWorkspaceSnapshotsRequest"},
"output":{"shape":"DescribeWorkspaceSnapshotsResult"},
"errors":[
{"shape":"InvalidParameterValuesException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Describes the snapshots for the specified WorkSpace.</p>"
},
"DescribeWorkspaces":{
"name":"DescribeWorkspaces",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeWorkspacesRequest"},
"output":{"shape":"DescribeWorkspacesResult"},
"errors":[
{"shape":"InvalidParameterValuesException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Describes the specified WorkSpaces.</p> <p>You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.</p>"
},
"DescribeWorkspacesConnectionStatus":{
"name":"DescribeWorkspacesConnectionStatus",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeWorkspacesConnectionStatusRequest"},
"output":{"shape":"DescribeWorkspacesConnectionStatusResult"},
"errors":[
{"shape":"InvalidParameterValuesException"}
],
"documentation":"<p>Describes the connection status of the specified WorkSpaces.</p>"
},
"DisassociateConnectionAlias":{
"name":"DisassociateConnectionAlias",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisassociateConnectionAliasRequest"},
"output":{"shape":"DisassociateConnectionAliasResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValuesException"},
{"shape":"InvalidResourceStateException"},
{"shape":"OperationNotSupportedException"}
],
"documentation":"<p>Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different AWS Regions. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html\"> Cross-Region Redirection for Amazon WorkSpaces</a>.</p> <note> <p>Before performing this operation, call <a href=\"https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html\"> DescribeConnectionAliases</a> to make sure that the current state of the connection alias is <code>CREATED</code>.</p> </note>"
},
"DisassociateIpGroups":{
"name":"DisassociateIpGroups",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisassociateIpGroupsRequest"},
"output":{"shape":"DisassociateIpGroupsResult"},
"errors":[
{"shape":"InvalidParameterValuesException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidResourceStateException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Disassociates the specified IP access control group from the specified directory.</p>"
},
"ImportWorkspaceImage":{
"name":"ImportWorkspaceImage",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ImportWorkspaceImageRequest"},
"output":{"shape":"ImportWorkspaceImageResult"},
"errors":[
{"shape":"ResourceLimitExceededException"},
{"shape":"ResourceAlreadyExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"OperationNotSupportedException"},
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValuesException"}
],
"documentation":"<p>Imports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your AWS account, and you must own the image. For more information about creating BYOL images, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html\"> Bring Your Own Windows Desktop Licenses</a>.</p>"
},
"ListAvailableManagementCidrRanges":{
"name":"ListAvailableManagementCidrRanges",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListAvailableManagementCidrRangesRequest"},
"output":{"shape":"ListAvailableManagementCidrRangesResult"},
"errors":[
{"shape":"InvalidParameterValuesException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL). </p> <p>This operation can be run only by AWS accounts that are enabled for BYOL. If your account isn't enabled for BYOL, you'll receive an <code>AccessDeniedException</code> error.</p> <p>The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.</p>"
},
"MigrateWorkspace":{
"name":"MigrateWorkspace",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"MigrateWorkspaceRequest"},
"output":{"shape":"MigrateWorkspaceResult"},
"errors":[
{"shape":"InvalidParameterValuesException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"OperationNotSupportedException"},
{"shape":"OperationInProgressException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.</p> <p>The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the user volume from the last available snapshot of the original WorkSpace. During migration, the original <code>D:\\Users\\%USERNAME%</code> user profile folder is renamed to <code>D:\\Users\\%USERNAME%MMddyyTHHmmss%.NotMigrated</code>. A new <code>D:\\Users\\%USERNAME%\\</code> folder is generated by the new OS. Certain files in the old user profile are moved to the new user profile.</p> <p>For available migration scenarios, details about what happens during migration, and best practices, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/migrate-workspaces.html\">Migrate a WorkSpace</a>.</p>"
},
"ModifyAccount":{
"name":"ModifyAccount",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyAccountRequest"},
"output":{"shape":"ModifyAccountResult"},
"errors":[
{"shape":"InvalidParameterValuesException"},
{"shape":"AccessDeniedException"},
{"shape":"InvalidResourceStateException"},
{"shape":"ResourceUnavailableException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Modifies the configuration of Bring Your Own License (BYOL) for the specified account.</p>"
},
"ModifyClientProperties":{
"name":"ModifyClientProperties",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyClientPropertiesRequest"},
"output":{"shape":"ModifyClientPropertiesResult"},
"errors":[
{"shape":"InvalidParameterValuesException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Modifies the properties of the specified Amazon WorkSpaces clients.</p>"
},
"ModifySelfservicePermissions":{
"name":"ModifySelfservicePermissions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifySelfservicePermissionsRequest"},
"output":{"shape":"ModifySelfservicePermissionsResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValuesException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Modifies the self-service WorkSpace management capabilities for your users. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/enable-user-self-service-workspace-management.html\">Enable Self-Service WorkSpace Management Capabilities for Your Users</a>.</p>"
},
"ModifyWorkspaceAccessProperties":{
"name":"ModifyWorkspaceAccessProperties",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyWorkspaceAccessPropertiesRequest"},
"output":{"shape":"ModifyWorkspaceAccessPropertiesResult"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html#control-device-access\"> Control Device Access</a>.</p>"
},
"ModifyWorkspaceCreationProperties":{
"name":"ModifyWorkspaceCreationProperties",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyWorkspaceCreationPropertiesRequest"},
"output":{"shape":"ModifyWorkspaceCreationPropertiesResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValuesException"},
{"shape":"ResourceNotFoundException"},
{"shape":"OperationNotSupportedException"}
],
"documentation":"<p>Modify the default properties used to create WorkSpaces.</p>"
},
"ModifyWorkspaceProperties":{
"name":"ModifyWorkspaceProperties",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyWorkspacePropertiesRequest"},
"output":{"shape":"ModifyWorkspacePropertiesResult"},
"errors":[
{"shape":"InvalidParameterValuesException"},
{"shape":"InvalidResourceStateException"},
{"shape":"OperationInProgressException"},
{"shape":"UnsupportedWorkspaceConfigurationException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html\"> Modify a WorkSpace</a>. </p>"
},
"ModifyWorkspaceState":{
"name":"ModifyWorkspaceState",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyWorkspaceStateRequest"},
"output":{"shape":"ModifyWorkspaceStateResult"},
"errors":[
{"shape":"InvalidParameterValuesException"},
{"shape":"InvalidResourceStateException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Sets the state of the specified WorkSpace.</p> <p>To maintain a WorkSpace without being interrupted, set the WorkSpace state to <code>ADMIN_MAINTENANCE</code>. WorkSpaces in this state do not respond to requests to reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not stopped. Users cannot log into a WorkSpace in the <code>ADMIN_MAINTENANCE</code> state.</p>"
},
"RebootWorkspaces":{
"name":"RebootWorkspaces",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RebootWorkspacesRequest"},
"output":{"shape":"RebootWorkspacesResult"},
"documentation":"<p>Reboots the specified WorkSpaces.</p> <p>You cannot reboot a WorkSpace unless its state is <code>AVAILABLE</code> or <code>UNHEALTHY</code>.</p> <p>This operation is asynchronous and returns before the WorkSpaces have rebooted.</p>"
},
"RebuildWorkspaces":{
"name":"RebuildWorkspaces",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RebuildWorkspacesRequest"},
"output":{"shape":"RebuildWorkspacesResult"},
"documentation":"<p>Rebuilds the specified WorkSpace.</p> <p>You cannot rebuild a WorkSpace unless its state is <code>AVAILABLE</code>, <code>ERROR</code>, <code>UNHEALTHY</code>, <code>STOPPED</code>, or <code>REBOOTING</code>.</p> <p>Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/reset-workspace.html\">Rebuild a WorkSpace</a>.</p> <p>This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.</p>"
},
"RegisterWorkspaceDirectory":{
"name":"RegisterWorkspaceDirectory",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RegisterWorkspaceDirectoryRequest"},
"output":{"shape":"RegisterWorkspaceDirectoryResult"},
"errors":[
{"shape":"InvalidParameterValuesException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceLimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"WorkspacesDefaultRoleNotFoundException"},
{"shape":"InvalidResourceStateException"},
{"shape":"UnsupportedNetworkConfigurationException"},
{"shape":"OperationNotSupportedException"}
],
"documentation":"<p>Registers the specified directory. This operation is asynchronous and returns before the WorkSpace directory is registered. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-access-control.html#create-default-role\"> Creating the workspaces_DefaultRole Role</a>.</p>"
},
"RestoreWorkspace":{
"name":"RestoreWorkspace",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RestoreWorkspaceRequest"},
"output":{"shape":"RestoreWorkspaceResult"},
"errors":[
{"shape":"InvalidParameterValuesException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Restores the specified WorkSpace to its last known healthy state.</p> <p>You cannot restore a WorkSpace unless its state is <code> AVAILABLE</code>, <code>ERROR</code>, <code>UNHEALTHY</code>, or <code>STOPPED</code>.</p> <p>Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/restore-workspace.html\">Restore a WorkSpace</a>.</p> <p>This operation is asynchronous and returns before the WorkSpace is completely restored.</p>"
},
"RevokeIpRules":{
"name":"RevokeIpRules",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RevokeIpRulesRequest"},
"output":{"shape":"RevokeIpRulesResult"},
"errors":[
{"shape":"InvalidParameterValuesException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidResourceStateException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Removes one or more rules from the specified IP access control group.</p>"
},
"StartWorkspaces":{
"name":"StartWorkspaces",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartWorkspacesRequest"},
"output":{"shape":"StartWorkspacesResult"},
"documentation":"<p>Starts the specified WorkSpaces.</p> <p>You cannot start a WorkSpace unless it has a running mode of <code>AutoStop</code> and a state of <code>STOPPED</code>.</p>"
},
"StopWorkspaces":{
"name":"StopWorkspaces",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StopWorkspacesRequest"},
"output":{"shape":"StopWorkspacesResult"},
"documentation":"<p> Stops the specified WorkSpaces.</p> <p>You cannot stop a WorkSpace unless it has a running mode of <code>AutoStop</code> and a state of <code>AVAILABLE</code>, <code>IMPAIRED</code>, <code>UNHEALTHY</code>, or <code>ERROR</code>.</p>"
},
"TerminateWorkspaces":{
"name":"TerminateWorkspaces",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"TerminateWorkspacesRequest"},
"output":{"shape":"TerminateWorkspacesResult"},
"documentation":"<p>Terminates the specified WorkSpaces.</p> <important> <p>Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact AWS Support before terminating the WorkSpace.</p> </important> <p>You can terminate a WorkSpace that is in any state except <code>SUSPENDED</code>.</p> <p>This operation is asynchronous and returns before the WorkSpaces have been completely terminated. After a WorkSpace is terminated, the <code>TERMINATED</code> state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using <a href=\"https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html\"> DescribeWorkSpaces</a>. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.</p>"
},
"UpdateConnectionAliasPermission":{
"name":"UpdateConnectionAliasPermission",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateConnectionAliasPermissionRequest"},
"output":{"shape":"UpdateConnectionAliasPermissionResult"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValuesException"},
{"shape":"ResourceLimitExceededException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceAssociatedException"},
{"shape":"InvalidResourceStateException"},
{"shape":"OperationNotSupportedException"}
],
"documentation":"<p>Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html\"> Cross-Region Redirection for Amazon WorkSpaces</a>.</p> <note> <ul> <li> <p>Before performing this operation, call <a href=\"https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html\"> DescribeConnectionAliases</a> to make sure that the current state of the connection alias is <code>CREATED</code>.</p> </li> <li> <p>To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.</p> </li> </ul> </note>"
},
"UpdateRulesOfIpGroup":{
"name":"UpdateRulesOfIpGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateRulesOfIpGroupRequest"},
"output":{"shape":"UpdateRulesOfIpGroupResult"},
"errors":[
{"shape":"InvalidParameterValuesException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceLimitExceededException"},
{"shape":"InvalidResourceStateException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Replaces the current rules of the specified IP access control group with the specified rules.</p>"
},
"UpdateWorkspaceImagePermission":{
"name":"UpdateWorkspaceImagePermission",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateWorkspaceImagePermissionRequest"},
"output":{"shape":"UpdateWorkspaceImagePermissionResult"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceUnavailableException"},
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValuesException"},
{"shape":"OperationNotSupportedException"}
],
"documentation":"<p>Shares or unshares an image with one account by specifying whether that account has permission to copy the image. If the copy image permission is granted, the image is shared with that account. If the copy image permission is revoked, the image is unshared with the account. For more information about sharing images, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/share-custom-image.html\"> Share or Unshare a Custom WorkSpaces Image</a>.</p> <note> <ul> <li> <p>To delete an image that has been shared, you must unshare the image before you delete it.</p> </li> <li> <p>Sharing Bring Your Own License (BYOL) images across AWS accounts isn't supported at this time in the AWS GovCloud (US-West) Region. To share BYOL images across accounts in the AWS GovCloud (US-West) Region, contact AWS Support.</p> </li> </ul> </note>"
}
},
"shapes":{
"ARN":{
"type":"string",
"pattern":"^arn:aws:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-za-z0-9_/.-]{0,127}$"
},
"AccessDeniedException":{
"type":"structure",
"members":{
"message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>The user is not authorized to access a resource.</p>",
"exception":true
},
"AccessPropertyValue":{
"type":"string",
"enum":[
"ALLOW",
"DENY"
]
},
"AccountModification":{
"type":"structure",
"members":{
"ModificationState":{
"shape":"DedicatedTenancyModificationStateEnum",
"documentation":"<p>The state of the modification to the configuration of BYOL.</p>"
},
"DedicatedTenancySupport":{
"shape":"DedicatedTenancySupportResultEnum",
"documentation":"<p>The status of BYOL (whether BYOL is being enabled or disabled).</p>"
},
"DedicatedTenancyManagementCidrRange":{
"shape":"DedicatedTenancyManagementCidrRange",
"documentation":"<p>The IP address range, specified as an IPv4 CIDR block, for the management network interface used for the account.</p>"
},
"StartTime":{
"shape":"Timestamp",
"documentation":"<p>The timestamp when the modification of the BYOL configuration was started.</p>"
},
"ErrorCode":{
"shape":"WorkspaceErrorCode",
"documentation":"<p>The error code that is returned if the configuration of BYOL cannot be modified.</p>"
},
"ErrorMessage":{
"shape":"Description",
"documentation":"<p>The text of the error message that is returned if the configuration of BYOL cannot be modified.</p>"
}
},
"documentation":"<p>Describes a modification to the configuration of Bring Your Own License (BYOL) for the specified account. </p>"
},
"AccountModificationList":{
"type":"list",
"member":{"shape":"AccountModification"}
},
"Alias":{"type":"string"},
"Application":{
"type":"string",
"enum":[
"Microsoft_Office_2016",
"Microsoft_Office_2019"
]
},
"ApplicationList":{
"type":"list",
"member":{"shape":"Application"},
"max":5,
"min":1
},
"AssociateConnectionAliasRequest":{
"type":"structure",
"required":[
"AliasId",
"ResourceId"
],
"members":{
"AliasId":{
"shape":"ConnectionAliasId",
"documentation":"<p>The identifier of the connection alias.</p>"
},
"ResourceId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the directory to associate the connection alias with.</p>"
}
}
},
"AssociateConnectionAliasResult":{
"type":"structure",
"members":{
"ConnectionIdentifier":{
"shape":"ConnectionIdentifier",
"documentation":"<p>The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you're configuring your DNS routing policies. </p>"
}
}
},
"AssociateIpGroupsRequest":{
"type":"structure",
"required":[
"DirectoryId",
"GroupIds"
],
"members":{
"DirectoryId":{
"shape":"DirectoryId",
"documentation":"<p>The identifier of the directory.</p>"
},
"GroupIds":{
"shape":"IpGroupIdList",
"documentation":"<p>The identifiers of one or more IP access control groups.</p>"
}
}
},
"AssociateIpGroupsResult":{
"type":"structure",
"members":{
}
},
"AssociationStatus":{
"type":"string",
"enum":[
"NOT_ASSOCIATED",
"ASSOCIATED_WITH_OWNER_ACCOUNT",
"ASSOCIATED_WITH_SHARED_ACCOUNT",
"PENDING_ASSOCIATION",
"PENDING_DISASSOCIATION"
]
},
"AuthorizeIpRulesRequest":{
"type":"structure",
"required":[
"GroupId",
"UserRules"
],
"members":{
"GroupId":{
"shape":"IpGroupId",
"documentation":"<p>The identifier of the group.</p>"
},
"UserRules":{
"shape":"IpRuleList",
"documentation":"<p>The rules to add to the group.</p>"
}
}
},
"AuthorizeIpRulesResult":{
"type":"structure",
"members":{
}
},
"AwsAccount":{
"type":"string",
"pattern":"^\\d{12}$"
},
"BooleanObject":{"type":"boolean"},
"BundleId":{
"type":"string",
"pattern":"^wsb-[0-9a-z]{8,63}$"
},
"BundleIdList":{
"type":"list",
"member":{"shape":"BundleId"},
"max":25,
"min":1
},
"BundleList":{
"type":"list",
"member":{"shape":"WorkspaceBundle"}
},
"BundleOwner":{"type":"string"},
"ClientProperties":{
"type":"structure",
"members":{
"ReconnectEnabled":{
"shape":"ReconnectEnum",
"documentation":"<p>Specifies whether users can cache their credentials on the Amazon WorkSpaces client. When enabled, users can choose to reconnect to their WorkSpaces without re-entering their credentials. </p>"
}
},
"documentation":"<p>Describes an Amazon WorkSpaces client.</p>"
},
"ClientPropertiesList":{
"type":"list",
"member":{"shape":"ClientPropertiesResult"}
},
"ClientPropertiesResult":{
"type":"structure",
"members":{
"ResourceId":{
"shape":"NonEmptyString",
"documentation":"<p>The resource identifier, in the form of a directory ID.</p>"
},
"ClientProperties":{
"shape":"ClientProperties",
"documentation":"<p>Information about the Amazon WorkSpaces client.</p>"
}
},
"documentation":"<p>Information about the Amazon WorkSpaces client.</p>"
},
"Compute":{
"type":"string",
"enum":[
"VALUE",
"STANDARD",
"PERFORMANCE",
"POWER",
"GRAPHICS",
"POWERPRO",
"GRAPHICSPRO"
]
},
"ComputeType":{
"type":"structure",
"members":{
"Name":{
"shape":"Compute",
"documentation":"<p>The compute type.</p>"
}
},
"documentation":"<p>Describes the compute type.</p>"
},
"ComputerName":{"type":"string"},
"ConnectionAlias":{
"type":"structure",
"members":{
"ConnectionString":{
"shape":"ConnectionString",
"documentation":"<p>The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as <code>www.example.com</code>.</p>"
},