forked from aws/aws-sdk-js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathworkspaces-2015-04-08.normal.json
1235 lines (1235 loc) · 45.2 KB
/
workspaces-2015-04-08.normal.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":{
"uid":"workspaces-2015-04-08",
"apiVersion":"2015-04-08",
"endpointPrefix":"workspaces",
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"Amazon WorkSpaces",
"signatureVersion":"v4",
"targetPrefix":"WorkspacesService"
},
"operations":{
"CreateTags":{
"name":"CreateTags",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateTagsRequest"},
"output":{"shape":"CreateTagsResult"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValuesException"},
{"shape":"ResourceLimitExceededException"}
],
"documentation":"<p>Creates tags for a WorkSpace.</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> <note> <p>This operation is asynchronous and returns before the WorkSpaces are created.</p> </note>"
},
"DeleteTags":{
"name":"DeleteTags",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteTagsRequest"},
"output":{"shape":"DeleteTagsResult"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValuesException"}
],
"documentation":"<p>Deletes tags from a WorkSpace.</p>"
},
"DescribeTags":{
"name":"DescribeTags",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeTagsRequest"},
"output":{"shape":"DescribeTagsResult"},
"errors":[
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Describes tags for a WorkSpace.</p>"
},
"DescribeWorkspaceBundles":{
"name":"DescribeWorkspaceBundles",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeWorkspaceBundlesRequest"},
"output":{"shape":"DescribeWorkspaceBundlesResult"},
"errors":[
{"shape":"InvalidParameterValuesException"}
],
"documentation":"<p>Obtains information about the WorkSpace bundles that are available to your account in the specified region.</p> <p>You can filter the results with either the <code>BundleIds</code> parameter, or the <code>Owner</code> parameter, but not both.</p> <p>This operation supports pagination with the use of the <code>NextToken</code> request and response parameters. If more results are available, the <code>NextToken</code> response member contains a token that you pass in the next call to this operation to retrieve the next set of items.</p>"
},
"DescribeWorkspaceDirectories":{
"name":"DescribeWorkspaceDirectories",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeWorkspaceDirectoriesRequest"},
"output":{"shape":"DescribeWorkspaceDirectoriesResult"},
"errors":[
{"shape":"InvalidParameterValuesException"}
],
"documentation":"<p>Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account.</p> <p>This operation supports pagination with the use of the <code>NextToken</code> request and response parameters. If more results are available, the <code>NextToken</code> response member contains a token that you pass in the next call to this operation to retrieve the next set of items.</p>"
},
"DescribeWorkspaces":{
"name":"DescribeWorkspaces",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeWorkspacesRequest"},
"output":{"shape":"DescribeWorkspacesResult"},
"errors":[
{"shape":"InvalidParameterValuesException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Obtains information about the specified WorkSpaces.</p> <p>Only one of the filter parameters, such as <code>BundleId</code>, <code>DirectoryId</code>, or <code>WorkspaceIds</code>, can be specified at a time.</p> <p>This operation supports pagination with the use of the <code>NextToken</code> request and response parameters. If more results are available, the <code>NextToken</code> response member contains a token that you pass in the next call to this operation to retrieve the next set of items.</p>"
},
"DescribeWorkspacesConnectionStatus":{
"name":"DescribeWorkspacesConnectionStatus",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeWorkspacesConnectionStatusRequest"},
"output":{"shape":"DescribeWorkspacesConnectionStatusResult"},
"errors":[
{"shape":"InvalidParameterValuesException"}
],
"documentation":"<p>Describes the connection status of a specified WorkSpace.</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 WorkSpace properties, including the RunningMode and AutoStop time.</p>"
},
"RebootWorkspaces":{
"name":"RebootWorkspaces",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RebootWorkspacesRequest"},
"output":{"shape":"RebootWorkspacesResult"},
"documentation":"<p>Reboots the specified WorkSpaces.</p> <p>To be able to reboot a WorkSpace, the WorkSpace must have a <b>State</b> of <code>AVAILABLE</code>, <code>IMPAIRED</code>, or <code>INOPERABLE</code>.</p> <note> <p>This operation is asynchronous and returns before the WorkSpaces have rebooted.</p> </note>"
},
"RebuildWorkspaces":{
"name":"RebuildWorkspaces",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RebuildWorkspacesRequest"},
"output":{"shape":"RebuildWorkspacesResult"},
"documentation":"<p>Rebuilds the specified WorkSpaces.</p> <p>Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. Rebuilding a WorkSpace causes the following to occur:</p> <ul> <li> <p>The system is restored to the image of the bundle that the WorkSpace is created from. Any applications that have been installed, or system settings that have been made since the WorkSpace was created will be lost.</p> </li> <li> <p>The data drive (D drive) is re-created from the last automatic snapshot taken of the data drive. The current contents of the data drive are overwritten. Automatic snapshots of the data drive are taken every 12 hours, so the snapshot can be as much as 12 hours old.</p> </li> </ul> <p>To be able to rebuild a WorkSpace, the WorkSpace must have a <b>State</b> of <code>AVAILABLE</code> or <code>ERROR</code>.</p> <note> <p>This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.</p> </note>"
},
"StartWorkspaces":{
"name":"StartWorkspaces",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartWorkspacesRequest"},
"output":{"shape":"StartWorkspacesResult"},
"documentation":"<p>Starts the specified WorkSpaces. The API only works with WorkSpaces that have RunningMode configured as AutoStop and the State set to “STOPPED.”</p>"
},
"StopWorkspaces":{
"name":"StopWorkspaces",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StopWorkspacesRequest"},
"output":{"shape":"StopWorkspacesResult"},
"documentation":"<p> Stops the specified WorkSpaces. The API only works with WorkSpaces that have RunningMode configured as AutoStop and the State set to AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.</p>"
},
"TerminateWorkspaces":{
"name":"TerminateWorkspaces",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"TerminateWorkspacesRequest"},
"output":{"shape":"TerminateWorkspacesResult"},
"documentation":"<p>Terminates the specified WorkSpaces.</p> <p>Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is not maintained and will be destroyed. If you need to archive any user data, contact Amazon Web Services before terminating the WorkSpace.</p> <p>You can terminate a WorkSpace that is in any state except <code>SUSPENDED</code>.</p> <note> <p>This operation is asynchronous and returns before the WorkSpaces have been completely terminated.</p> </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"}
},
"exception":true
},
"Alias":{"type":"string"},
"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"},
"Compute":{
"type":"string",
"enum":[
"VALUE",
"STANDARD",
"PERFORMANCE"
]
},
"ComputeType":{
"type":"structure",
"members":{
"Name":{
"shape":"Compute",
"documentation":"<p>The name of the compute type for the bundle.</p>"
}
},
"documentation":"<p>Contains information about the compute type of a WorkSpace bundle.</p>"
},
"ComputerName":{"type":"string"},
"ConnectionState":{
"type":"string",
"enum":[
"CONNECTED",
"DISCONNECTED",
"UNKNOWN"
]
},
"CreateTagsRequest":{
"type":"structure",
"required":[
"ResourceId",
"Tags"
],
"members":{
"ResourceId":{
"shape":"NonEmptyString",
"documentation":"<p>The resource ID of the request.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags of the request.</p>"
}
},
"documentation":"<p>The request of the <a>CreateTags</a> operation.</p>"
},
"CreateTagsResult":{
"type":"structure",
"members":{
},
"documentation":"<p>The result of the <a>CreateTags</a> operation.</p>"
},
"CreateWorkspacesRequest":{
"type":"structure",
"required":["Workspaces"],
"members":{
"Workspaces":{
"shape":"WorkspaceRequestList",
"documentation":"<p>An array of structures that specify the WorkSpaces to create.</p>"
}
},
"documentation":"<p>Contains the inputs for the <a>CreateWorkspaces</a> operation.</p>"
},
"CreateWorkspacesResult":{
"type":"structure",
"members":{
"FailedRequests":{
"shape":"FailedCreateWorkspaceRequests",
"documentation":"<p>An array of structures that represent the WorkSpaces that could not be created.</p>"
},
"PendingRequests":{
"shape":"WorkspaceList",
"documentation":"<p>An array of structures that represent the WorkSpaces that were created.</p> <p>Because this operation is asynchronous, the identifier in <code>WorkspaceId</code> is not immediately available. If you immediately call <a>DescribeWorkspaces</a> with this identifier, no information will be returned.</p>"
}
},
"documentation":"<p>Contains the result of the <a>CreateWorkspaces</a> operation.</p>"
},
"DefaultOu":{"type":"string"},
"DefaultWorkspaceCreationProperties":{
"type":"structure",
"members":{
"EnableWorkDocs":{
"shape":"BooleanObject",
"documentation":"<p>Specifies if the directory is enabled for Amazon WorkDocs.</p>"
},
"EnableInternetAccess":{
"shape":"BooleanObject",
"documentation":"<p>A public IP address will be attached to all WorkSpaces that are created or rebuilt.</p>"
},
"DefaultOu":{
"shape":"DefaultOu",
"documentation":"<p>The organizational unit (OU) in the directory that the WorkSpace machine accounts are placed in.</p>"
},
"CustomSecurityGroupId":{
"shape":"SecurityGroupId",
"documentation":"<p>The identifier of any custom security groups that are applied to the WorkSpaces when they are created.</p>"
},
"UserEnabledAsLocalAdministrator":{
"shape":"BooleanObject",
"documentation":"<p>The WorkSpace user is an administrator on the WorkSpace.</p>"
}
},
"documentation":"<p>Contains default WorkSpace creation information.</p>"
},
"DeleteTagsRequest":{
"type":"structure",
"required":[
"ResourceId",
"TagKeys"
],
"members":{
"ResourceId":{
"shape":"NonEmptyString",
"documentation":"<p>The resource ID of the request.</p>"
},
"TagKeys":{
"shape":"TagKeyList",
"documentation":"<p>The tag keys of the request.</p>"
}
},
"documentation":"<p>The request of the <a>DeleteTags</a> operation.</p>"
},
"DeleteTagsResult":{
"type":"structure",
"members":{
},
"documentation":"<p>The result of the <a>DeleteTags</a> operation.</p>"
},
"DescribeTagsRequest":{
"type":"structure",
"required":["ResourceId"],
"members":{
"ResourceId":{
"shape":"NonEmptyString",
"documentation":"<p>The resource ID of the request.</p>"
}
},
"documentation":"<p>The request of the <a>DescribeTags</a> operation.</p>"
},
"DescribeTagsResult":{
"type":"structure",
"members":{
"TagList":{
"shape":"TagList",
"documentation":"<p>The list of tags.</p>"
}
},
"documentation":"<p>The result of the <a>DescribeTags</a> operation.</p>"
},
"DescribeWorkspaceBundlesRequest":{
"type":"structure",
"members":{
"BundleIds":{
"shape":"BundleIdList",
"documentation":"<p>An array of strings that contains the identifiers of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.</p>"
},
"Owner":{
"shape":"BundleOwner",
"documentation":"<p>The owner of the bundles to retrieve. This parameter cannot be combined with any other filter parameter.</p> <p>This contains one of the following values:</p> <ul> <li> <p>null- Retrieves the bundles that belong to the account making the call.</p> </li> <li> <p> <code>AMAZON</code>- Retrieves the bundles that are provided by AWS.</p> </li> </ul>"
},
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>The <code>NextToken</code> value from a previous call to this operation. Pass null if this is the first call.</p>"
}
},
"documentation":"<p>Contains the inputs for the <a>DescribeWorkspaceBundles</a> operation.</p>"
},
"DescribeWorkspaceBundlesResult":{
"type":"structure",
"members":{
"Bundles":{
"shape":"BundleList",
"documentation":"<p>An array of structures that contain information about the bundles.</p>"
},
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>If not null, more results are available. Pass this value for the <code>NextToken</code> parameter in a subsequent call to this operation to retrieve the next set of items. This token is valid for one day and must be used within that time frame.</p>"
}
},
"documentation":"<p>Contains the results of the <a>DescribeWorkspaceBundles</a> operation.</p>"
},
"DescribeWorkspaceDirectoriesRequest":{
"type":"structure",
"members":{
"DirectoryIds":{
"shape":"DirectoryIdList",
"documentation":"<p>An array of strings that contains the directory identifiers to retrieve information for. If this member is null, all directories are retrieved.</p>"
},
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>The <code>NextToken</code> value from a previous call to this operation. Pass null if this is the first call.</p>"
}
},
"documentation":"<p>Contains the inputs for the <a>DescribeWorkspaceDirectories</a> operation.</p>"
},
"DescribeWorkspaceDirectoriesResult":{
"type":"structure",
"members":{
"Directories":{
"shape":"DirectoryList",
"documentation":"<p>An array of structures that contain information about the directories.</p>"
},
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>If not null, more results are available. Pass this value for the <code>NextToken</code> parameter in a subsequent call to this operation to retrieve the next set of items. This token is valid for one day and must be used within that time frame.</p>"
}
},
"documentation":"<p>Contains the results of the <a>DescribeWorkspaceDirectories</a> operation.</p>"
},
"DescribeWorkspacesConnectionStatusRequest":{
"type":"structure",
"members":{
"WorkspaceIds":{
"shape":"WorkspaceIdList",
"documentation":"<p>An array of strings that contain the identifiers of the WorkSpaces.</p>"
},
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>The next token of the request.</p>"
}
}
},
"DescribeWorkspacesConnectionStatusResult":{
"type":"structure",
"members":{
"WorkspacesConnectionStatus":{
"shape":"WorkspaceConnectionStatusList",
"documentation":"<p>The connection status of the WorkSpace.</p>"
},
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>The next token of the result.</p>"
}
}
},
"DescribeWorkspacesRequest":{
"type":"structure",
"members":{
"WorkspaceIds":{
"shape":"WorkspaceIdList",
"documentation":"<p>An array of strings that contain the identifiers of the WorkSpaces for which to retrieve information. This parameter cannot be combined with any other filter parameter.</p> <p>Because the <a>CreateWorkspaces</a> operation is asynchronous, the identifier it returns is not immediately available. If you immediately call <a>DescribeWorkspaces</a> with this identifier, no information is returned.</p>"
},
"DirectoryId":{
"shape":"DirectoryId",
"documentation":"<p>Specifies the directory identifier to which to limit the WorkSpaces. Optionally, you can specify a specific directory user with the <code>UserName</code> parameter. This parameter cannot be combined with any other filter parameter.</p>"
},
"UserName":{
"shape":"UserName",
"documentation":"<p>Used with the <code>DirectoryId</code> parameter to specify the directory user for whom to obtain the WorkSpace.</p>"
},
"BundleId":{
"shape":"BundleId",
"documentation":"<p>The identifier of a bundle to obtain the WorkSpaces for. All WorkSpaces that are created from this bundle will be retrieved. This parameter cannot be combined with any other filter parameter.</p>"
},
"Limit":{
"shape":"Limit",
"documentation":"<p>The maximum number of items to return.</p>"
},
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>The <code>NextToken</code> value from a previous call to this operation. Pass null if this is the first call.</p>"
}
},
"documentation":"<p>Contains the inputs for the <a>DescribeWorkspaces</a> operation.</p>"
},
"DescribeWorkspacesResult":{
"type":"structure",
"members":{
"Workspaces":{
"shape":"WorkspaceList",
"documentation":"<p>An array of structures that contain the information about the WorkSpaces.</p> <p>Because the <a>CreateWorkspaces</a> operation is asynchronous, some of this information may be incomplete for a newly-created WorkSpace.</p>"
},
"NextToken":{
"shape":"PaginationToken",
"documentation":"<p>If not null, more results are available. Pass this value for the <code>NextToken</code> parameter in a subsequent call to this operation to retrieve the next set of items. This token is valid for one day and must be used within that time frame.</p>"
}
},
"documentation":"<p>Contains the results for the <a>DescribeWorkspaces</a> operation.</p>"
},
"Description":{"type":"string"},
"DirectoryId":{
"type":"string",
"pattern":"^d-[0-9a-f]{8,63}$"
},
"DirectoryIdList":{
"type":"list",
"member":{"shape":"DirectoryId"},
"max":25,
"min":1
},
"DirectoryList":{
"type":"list",
"member":{"shape":"WorkspaceDirectory"}
},
"DirectoryName":{"type":"string"},
"DnsIpAddresses":{
"type":"list",
"member":{"shape":"IpAddress"}
},
"ErrorType":{"type":"string"},
"ExceptionMessage":{"type":"string"},
"FailedCreateWorkspaceRequest":{
"type":"structure",
"members":{
"WorkspaceRequest":{
"shape":"WorkspaceRequest",
"documentation":"<p>A <a>FailedCreateWorkspaceRequest$WorkspaceRequest</a> object that contains the information about the WorkSpace that could not be created.</p>"
},
"ErrorCode":{
"shape":"ErrorType",
"documentation":"<p>The error code.</p>"
},
"ErrorMessage":{
"shape":"Description",
"documentation":"<p>The textual error message.</p>"
}
},
"documentation":"<p>Contains information about a WorkSpace that could not be created.</p>"
},
"FailedCreateWorkspaceRequests":{
"type":"list",
"member":{"shape":"FailedCreateWorkspaceRequest"}
},
"FailedRebootWorkspaceRequests":{
"type":"list",
"member":{"shape":"FailedWorkspaceChangeRequest"}
},
"FailedRebuildWorkspaceRequests":{
"type":"list",
"member":{"shape":"FailedWorkspaceChangeRequest"}
},
"FailedStartWorkspaceRequests":{
"type":"list",
"member":{"shape":"FailedWorkspaceChangeRequest"}
},
"FailedStopWorkspaceRequests":{
"type":"list",
"member":{"shape":"FailedWorkspaceChangeRequest"}
},
"FailedTerminateWorkspaceRequests":{
"type":"list",
"member":{"shape":"FailedWorkspaceChangeRequest"}
},
"FailedWorkspaceChangeRequest":{
"type":"structure",
"members":{
"WorkspaceId":{
"shape":"WorkspaceId",
"documentation":"<p>The identifier of the WorkSpace.</p>"
},
"ErrorCode":{
"shape":"ErrorType",
"documentation":"<p>The error code.</p>"
},
"ErrorMessage":{
"shape":"Description",
"documentation":"<p>The textual error message.</p>"
}
},
"documentation":"<p>Contains information about a WorkSpace that could not be rebooted (<a>RebootWorkspaces</a>), rebuilt (<a>RebuildWorkspaces</a>), terminated (<a>TerminateWorkspaces</a>), started (<a>StartWorkspaces</a>), or stopped (<a>StopWorkspaces</a>).</p>"
},
"InvalidParameterValuesException":{
"type":"structure",
"members":{
"message":{
"shape":"ExceptionMessage",
"documentation":"<p>The exception error message.</p>"
}
},
"documentation":"<p>One or more parameter values are not valid.</p>",
"exception":true
},
"InvalidResourceStateException":{
"type":"structure",
"members":{
"message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>The specified WorkSpace has an invalid state for this operation.</p>",
"exception":true
},
"IpAddress":{"type":"string"},
"Limit":{
"type":"integer",
"max":25,
"min":1
},
"ModifyWorkspacePropertiesRequest":{
"type":"structure",
"required":[
"WorkspaceId",
"WorkspaceProperties"
],
"members":{
"WorkspaceId":{
"shape":"WorkspaceId",
"documentation":"<p>The ID of the WorkSpace.</p>"
},
"WorkspaceProperties":{
"shape":"WorkspaceProperties",
"documentation":"<p>The WorkSpace properties of the request.</p>"
}
}
},
"ModifyWorkspacePropertiesResult":{
"type":"structure",
"members":{
}
},
"NonEmptyString":{
"type":"string",
"min":1
},
"OperationInProgressException":{
"type":"structure",
"members":{
"message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>The properties of this WorkSpace are currently being modified. Try again in a moment.</p>",
"exception":true
},
"PaginationToken":{
"type":"string",
"max":63,
"min":1
},
"RebootRequest":{
"type":"structure",
"required":["WorkspaceId"],
"members":{
"WorkspaceId":{
"shape":"WorkspaceId",
"documentation":"<p>The identifier of the WorkSpace to reboot.</p>"
}
},
"documentation":"<p>Contains information used with the <a>RebootWorkspaces</a> operation to reboot a WorkSpace.</p>"
},
"RebootWorkspaceRequests":{
"type":"list",
"member":{"shape":"RebootRequest"},
"max":25,
"min":1
},
"RebootWorkspacesRequest":{
"type":"structure",
"required":["RebootWorkspaceRequests"],
"members":{
"RebootWorkspaceRequests":{
"shape":"RebootWorkspaceRequests",
"documentation":"<p>An array of structures that specify the WorkSpaces to reboot.</p>"
}
},
"documentation":"<p>Contains the inputs for the <a>RebootWorkspaces</a> operation.</p>"
},
"RebootWorkspacesResult":{
"type":"structure",
"members":{
"FailedRequests":{
"shape":"FailedRebootWorkspaceRequests",
"documentation":"<p>An array of structures representing any WorkSpaces that could not be rebooted.</p>"
}
},
"documentation":"<p>Contains the results of the <a>RebootWorkspaces</a> operation.</p>"
},
"RebuildRequest":{
"type":"structure",
"required":["WorkspaceId"],
"members":{
"WorkspaceId":{
"shape":"WorkspaceId",
"documentation":"<p>The identifier of the WorkSpace to rebuild.</p>"
}
},
"documentation":"<p>Contains information used with the <a>RebuildWorkspaces</a> operation to rebuild a WorkSpace.</p>"
},
"RebuildWorkspaceRequests":{
"type":"list",
"member":{"shape":"RebuildRequest"},
"max":1,
"min":1
},
"RebuildWorkspacesRequest":{
"type":"structure",
"required":["RebuildWorkspaceRequests"],
"members":{
"RebuildWorkspaceRequests":{
"shape":"RebuildWorkspaceRequests",
"documentation":"<p>An array of structures that specify the WorkSpaces to rebuild.</p>"
}
},
"documentation":"<p>Contains the inputs for the <a>RebuildWorkspaces</a> operation.</p>"
},
"RebuildWorkspacesResult":{
"type":"structure",
"members":{
"FailedRequests":{
"shape":"FailedRebuildWorkspaceRequests",
"documentation":"<p>An array of structures representing any WorkSpaces that could not be rebuilt.</p>"
}
},
"documentation":"<p>Contains the results of the <a>RebuildWorkspaces</a> operation.</p>"
},
"RegistrationCode":{
"type":"string",
"max":20,
"min":1
},
"ResourceLimitExceededException":{
"type":"structure",
"members":{
"message":{
"shape":"ExceptionMessage",
"documentation":"<p>The exception error message.</p>"
}
},
"documentation":"<p>Your resource limits have been exceeded.</p>",
"exception":true
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"message":{
"shape":"ExceptionMessage",
"documentation":"<p>The resource could not be found.</p>"
},
"ResourceId":{
"shape":"NonEmptyString",
"documentation":"<p>The resource could not be found.</p>"
}
},
"documentation":"<p>The resource could not be found.</p>",
"exception":true
},
"ResourceUnavailableException":{
"type":"structure",
"members":{
"message":{
"shape":"ExceptionMessage",
"documentation":"<p>The exception error message.</p>"
},
"ResourceId":{
"shape":"NonEmptyString",
"documentation":"<p>The identifier of the resource that is not available.</p>"
}
},
"documentation":"<p>The specified resource is not available.</p>",
"exception":true
},
"RunningMode":{
"type":"string",
"enum":[
"AUTO_STOP",
"ALWAYS_ON"
]
},
"RunningModeAutoStopTimeoutInMinutes":{"type":"integer"},
"SecurityGroupId":{
"type":"string",
"pattern":"^(sg-[0-9a-f]{8})$"
},
"StartRequest":{
"type":"structure",
"members":{
"WorkspaceId":{
"shape":"WorkspaceId",
"documentation":"<p>The ID of the WorkSpace.</p>"
}
},
"documentation":"<p>Describes the start request.</p>"
},
"StartWorkspaceRequests":{
"type":"list",
"member":{"shape":"StartRequest"},
"max":25,
"min":1
},
"StartWorkspacesRequest":{
"type":"structure",
"required":["StartWorkspaceRequests"],
"members":{
"StartWorkspaceRequests":{
"shape":"StartWorkspaceRequests",
"documentation":"<p>The requests.</p>"
}
}
},
"StartWorkspacesResult":{
"type":"structure",
"members":{
"FailedRequests":{
"shape":"FailedStartWorkspaceRequests",
"documentation":"<p>The failed requests.</p>"
}
}
},
"StopRequest":{
"type":"structure",
"members":{
"WorkspaceId":{
"shape":"WorkspaceId",
"documentation":"<p>The ID of the WorkSpace.</p>"
}
},
"documentation":"<p>Describes the stop request.</p>"
},
"StopWorkspaceRequests":{
"type":"list",
"member":{"shape":"StopRequest"},
"max":25,
"min":1
},
"StopWorkspacesRequest":{
"type":"structure",
"required":["StopWorkspaceRequests"],
"members":{
"StopWorkspaceRequests":{
"shape":"StopWorkspaceRequests",
"documentation":"<p>The requests.</p>"
}
}
},
"StopWorkspacesResult":{
"type":"structure",
"members":{
"FailedRequests":{
"shape":"FailedStopWorkspaceRequests",
"documentation":"<p>The failed requests.</p>"
}
}
},
"SubnetId":{
"type":"string",
"pattern":"^(subnet-[0-9a-f]{8})$"
},
"SubnetIds":{
"type":"list",
"member":{"shape":"SubnetId"}
},
"Tag":{
"type":"structure",
"required":["Key"],
"members":{
"Key":{
"shape":"TagKey",
"documentation":"<p>The key of the tag.</p>"
},
"Value":{
"shape":"TagValue",
"documentation":"<p>The value of the tag.</p>"
}
},
"documentation":"<p>Describes the tag of the WorkSpace.</p>"
},
"TagKey":{
"type":"string",
"max":127,
"min":1
},
"TagKeyList":{
"type":"list",
"member":{"shape":"NonEmptyString"}
},
"TagList":{
"type":"list",
"member":{"shape":"Tag"}
},
"TagValue":{
"type":"string",
"max":255
},
"TerminateRequest":{
"type":"structure",
"required":["WorkspaceId"],
"members":{
"WorkspaceId":{
"shape":"WorkspaceId",
"documentation":"<p>The identifier of the WorkSpace to terminate.</p>"
}
},
"documentation":"<p>Contains information used with the <a>TerminateWorkspaces</a> operation to terminate a WorkSpace.</p>"
},
"TerminateWorkspaceRequests":{
"type":"list",
"member":{"shape":"TerminateRequest"},
"max":25,
"min":1
},
"TerminateWorkspacesRequest":{
"type":"structure",
"required":["TerminateWorkspaceRequests"],
"members":{
"TerminateWorkspaceRequests":{
"shape":"TerminateWorkspaceRequests",
"documentation":"<p>An array of structures that specify the WorkSpaces to terminate.</p>"
}
},
"documentation":"<p>Contains the inputs for the <a>TerminateWorkspaces</a> operation.</p>"
},
"TerminateWorkspacesResult":{
"type":"structure",
"members":{
"FailedRequests":{
"shape":"FailedTerminateWorkspaceRequests",
"documentation":"<p>An array of structures representing any WorkSpaces that could not be terminated.</p>"
}
},
"documentation":"<p>Contains the results of the <a>TerminateWorkspaces</a> operation.</p>"
},
"Timestamp":{"type":"timestamp"},
"UnsupportedWorkspaceConfigurationException":{
"type":"structure",
"members":{
"message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>The WorkSpace does not have the supported configuration for this operation. For more information, see the <a href=\"http://docs.aws.amazon.com/workspaces/latest/adminguide\">Amazon WorkSpaces Administration Guide</a>. </p>",
"exception":true
},
"UserName":{
"type":"string",
"max":63,
"min":1
},
"UserStorage":{
"type":"structure",
"members":{
"Capacity":{
"shape":"NonEmptyString",
"documentation":"<p>The amount of user storage for the bundle.</p>"
}
},
"documentation":"<p>Contains information about the user storage for a WorkSpace bundle.</p>"
},
"VolumeEncryptionKey":{"type":"string"},
"Workspace":{
"type":"structure",
"members":{
"WorkspaceId":{
"shape":"WorkspaceId",
"documentation":"<p>The identifier of the WorkSpace.</p>"
},
"DirectoryId":{
"shape":"DirectoryId",
"documentation":"<p>The identifier of the AWS Directory Service directory that the WorkSpace belongs to.</p>"
},
"UserName":{
"shape":"UserName",
"documentation":"<p>The user that the WorkSpace is assigned to.</p>"
},
"IpAddress":{
"shape":"IpAddress",
"documentation":"<p>The IP address of the WorkSpace.</p>"
},
"State":{
"shape":"WorkspaceState",
"documentation":"<p>The operational state of the WorkSpace.</p>"
},
"BundleId":{
"shape":"BundleId",
"documentation":"<p>The identifier of the bundle that the WorkSpace was created from.</p>"
},
"SubnetId":{
"shape":"SubnetId",
"documentation":"<p>The identifier of the subnet that the WorkSpace is in.</p>"
},
"ErrorMessage":{
"shape":"Description",
"documentation":"<p>If the WorkSpace could not be created, this contains a textual error message that describes the failure.</p>"
},
"ErrorCode":{
"shape":"WorkspaceErrorCode",
"documentation":"<p>If the WorkSpace could not be created, this contains the error code.</p>"
},
"ComputerName":{
"shape":"ComputerName",
"documentation":"<p>The name of the WorkSpace as seen by the operating system.</p>"
},
"VolumeEncryptionKey":{
"shape":"VolumeEncryptionKey",
"documentation":"<p>The KMS key used to encrypt data stored on your WorkSpace.</p>"
},
"UserVolumeEncryptionEnabled":{