/
docs-2.json
1573 lines (1573 loc) · 94.2 KB
/
docs-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",
"service": "<fullname>Amazon AppStream 2.0</fullname> <p>This is the <i>Amazon AppStream 2.0 API Reference</i>. This documentation provides descriptions and syntax for each of the actions and data types in AppStream 2.0. AppStream 2.0 is a fully managed, secure application streaming service that lets you stream desktop applications to users without rewriting applications. AppStream 2.0 manages the AWS resources that are required to host and run your applications, scales automatically, and provides access to your users on demand. </p> <note> <p>You can call the AppStream 2.0 API operations by using an interface VPC endpoint (interface endpoint). For more information, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/access-api-cli-through-interface-vpc-endpoint.html\">Access AppStream 2.0 API Operations and CLI Commands Through an Interface VPC Endpoint</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p> </note> <p>To learn more about AppStream 2.0, see the following resources:</p> <ul> <li> <p> <a href=\"http://aws.amazon.com/appstream2\">Amazon AppStream 2.0 product page</a> </p> </li> <li> <p> <a href=\"http://aws.amazon.com/documentation/appstream2\">Amazon AppStream 2.0 documentation</a> </p> </li> </ul>",
"operations": {
"AssociateFleet": "<p>Associates the specified fleet with the specified stack.</p>",
"BatchAssociateUserStack": "<p>Associates the specified users with the specified stacks. Users in a user pool cannot be assigned to stacks with fleets that are joined to an Active Directory domain.</p>",
"BatchDisassociateUserStack": "<p>Disassociates the specified users from the specified stacks.</p>",
"CopyImage": "<p>Copies the image within the same region or to a new region within the same AWS account. Note that any tags you added to the image will not be copied.</p>",
"CreateDirectoryConfig": "<p>Creates a Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.</p>",
"CreateFleet": "<p>Creates a fleet. A fleet consists of streaming instances that run a specified image.</p>",
"CreateImageBuilder": "<p>Creates an image builder. An image builder is a virtual machine that is used to create an image.</p> <p>The initial state of the builder is <code>PENDING</code>. When it is ready, the state is <code>RUNNING</code>.</p>",
"CreateImageBuilderStreamingURL": "<p>Creates a URL to start an image builder streaming session.</p>",
"CreateStack": "<p>Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations. </p>",
"CreateStreamingURL": "<p>Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user. A streaming URL enables application streaming to be tested without user setup. </p>",
"CreateUsageReportSubscription": "<p>Creates a usage report subscription. Usage reports are generated daily.</p>",
"CreateUser": "<p>Creates a new user in the user pool.</p>",
"DeleteDirectoryConfig": "<p>Deletes the specified Directory Config object from AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain.</p>",
"DeleteFleet": "<p>Deletes the specified fleet.</p>",
"DeleteImage": "<p>Deletes the specified image. You cannot delete an image when it is in use. After you delete an image, you cannot provision new capacity using the image.</p>",
"DeleteImageBuilder": "<p>Deletes the specified image builder and releases the capacity.</p>",
"DeleteImagePermissions": "<p>Deletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions can no longer use the image.</p>",
"DeleteStack": "<p>Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released.</p>",
"DeleteUsageReportSubscription": "<p>Disables usage report generation.</p>",
"DeleteUser": "<p>Deletes a user from the user pool.</p>",
"DescribeDirectoryConfigs": "<p>Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the configuration information required to join fleets and image builders to Microsoft Active Directory domains. </p> <p>Although the response syntax in this topic includes the account password, this password is not returned in the actual response.</p>",
"DescribeFleets": "<p>Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.</p>",
"DescribeImageBuilders": "<p>Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described.</p>",
"DescribeImagePermissions": "<p>Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own. </p>",
"DescribeImages": "<p>Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described.</p>",
"DescribeSessions": "<p>Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a UserId is provided for the stack and fleet, only streaming sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL.</p>",
"DescribeStacks": "<p>Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.</p>",
"DescribeUsageReportSubscriptions": "<p>Retrieves a list that describes one or more usage report subscriptions.</p>",
"DescribeUserStackAssociations": "<p>Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following:</p> <ul> <li> <p>The stack name</p> </li> <li> <p>The user name (email address of the user associated with the stack) and the authentication type for the user</p> </li> </ul>",
"DescribeUsers": "<p>Retrieves a list that describes one or more specified users in the user pool.</p>",
"DisableUser": "<p>Disables the specified user in the user pool. Users can't sign in to AppStream 2.0 until they are re-enabled. This action does not delete the user. </p>",
"DisassociateFleet": "<p>Disassociates the specified fleet from the specified stack.</p>",
"EnableUser": "<p>Enables a user in the user pool. After being enabled, users can sign in to AppStream 2.0 and open applications from the stacks to which they are assigned.</p>",
"ExpireSession": "<p>Immediately stops the specified streaming session.</p>",
"ListAssociatedFleets": "<p>Retrieves the name of the fleet that is associated with the specified stack.</p>",
"ListAssociatedStacks": "<p>Retrieves the name of the stack with which the specified fleet is associated.</p>",
"ListTagsForResource": "<p>Retrieves a list of all tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>",
"StartFleet": "<p>Starts the specified fleet.</p>",
"StartImageBuilder": "<p>Starts the specified image builder.</p>",
"StopFleet": "<p>Stops the specified fleet.</p>",
"StopImageBuilder": "<p>Stops the specified image builder.</p>",
"TagResource": "<p>Adds or overwrites one or more tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.</p> <p>Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value.</p> <p>To list the current tags for your resources, use <a>ListTagsForResource</a>. To disassociate tags from your resources, use <a>UntagResource</a>.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>",
"UntagResource": "<p>Disassociates one or more specified tags from the specified AppStream 2.0 resource.</p> <p>To list the current tags for your resources, use <a>ListTagsForResource</a>.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>",
"UpdateDirectoryConfig": "<p>Updates the specified Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.</p>",
"UpdateFleet": "<p>Updates the specified fleet.</p> <p>If the fleet is in the <code>STOPPED</code> state, you can update any attribute except the fleet name. If the fleet is in the <code>RUNNING</code> state, you can update the <code>DisplayName</code>, <code>ComputeCapacity</code>, <code>ImageARN</code>, <code>ImageName</code>, <code>IdleDisconnectTimeoutInSeconds</code>, and <code>DisconnectTimeoutInSeconds</code> attributes. If the fleet is in the <code>STARTING</code> or <code>STOPPING</code> state, you can't update it.</p>",
"UpdateImagePermissions": "<p>Adds or updates permissions for the specified private image. </p>",
"UpdateStack": "<p>Updates the specified fields for the specified stack.</p>"
},
"shapes": {
"AccessEndpoint": {
"base": "<p>Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.</p>",
"refs": {
"AccessEndpointList$member": null
}
},
"AccessEndpointList": {
"base": null,
"refs": {
"CreateImageBuilderRequest$AccessEndpoints": "<p>The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.</p>",
"CreateStackRequest$AccessEndpoints": "<p>The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.</p>",
"ImageBuilder$AccessEndpoints": "<p>The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.</p>",
"Stack$AccessEndpoints": "<p>The list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints. </p>",
"UpdateStackRequest$AccessEndpoints": "<p>The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.</p>"
}
},
"AccessEndpointType": {
"base": null,
"refs": {
"AccessEndpoint$EndpointType": "<p>The type of interface endpoint.</p>"
}
},
"AccountName": {
"base": null,
"refs": {
"ServiceAccountCredentials$AccountName": "<p>The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.</p>"
}
},
"AccountPassword": {
"base": null,
"refs": {
"ServiceAccountCredentials$AccountPassword": "<p>The password for the account.</p>"
}
},
"Action": {
"base": null,
"refs": {
"UserSetting$Action": "<p>The action that is enabled or disabled.</p>"
}
},
"Application": {
"base": "<p>Describes an application in the application catalog.</p>",
"refs": {
"Applications$member": null
}
},
"ApplicationSettings": {
"base": "<p>The persistent application settings for users of a stack.</p>",
"refs": {
"CreateStackRequest$ApplicationSettings": "<p>The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.</p>",
"UpdateStackRequest$ApplicationSettings": "<p>The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.</p>"
}
},
"ApplicationSettingsResponse": {
"base": "<p>Describes the persistent application settings for users of a stack.</p>",
"refs": {
"Stack$ApplicationSettings": "<p>The persistent application settings for users of the stack.</p>"
}
},
"Applications": {
"base": null,
"refs": {
"Image$Applications": "<p>The applications associated with the image.</p>"
}
},
"AppstreamAgentVersion": {
"base": null,
"refs": {
"CreateImageBuilderRequest$AppstreamAgentVersion": "<p>The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST]. </p>",
"Image$AppstreamAgentVersion": "<p>The version of the AppStream 2.0 agent to use for instances that are launched from this image. </p>",
"ImageBuilder$AppstreamAgentVersion": "<p>The version of the AppStream 2.0 agent that is currently being used by the image builder. </p>",
"StartImageBuilderRequest$AppstreamAgentVersion": "<p>The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST]. </p>"
}
},
"Arn": {
"base": null,
"refs": {
"ArnList$member": null,
"CreateFleetRequest$ImageArn": "<p>The ARN of the public, private, or shared image to use.</p>",
"CreateFleetRequest$IamRoleArn": "<p>The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the <b>AppStream_Machine_Role</b> credential profile on the instance.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html\">Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>",
"CreateImageBuilderRequest$ImageArn": "<p>The ARN of the public, private, or shared image to use.</p>",
"CreateImageBuilderRequest$IamRoleArn": "<p>The Amazon Resource Name (ARN) of the IAM role to apply to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the <b>AppStream_Machine_Role</b> credential profile on the instance.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html\">Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>",
"Fleet$Arn": "<p>The Amazon Resource Name (ARN) for the fleet.</p>",
"Fleet$ImageArn": "<p>The ARN for the public, private, or shared image.</p>",
"Fleet$IamRoleArn": "<p>The ARN of the IAM role that is applied to the fleet. To assume a role, the fleet instance calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the <b>AppStream_Machine_Role</b> credential profile on the instance.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html\">Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>",
"Image$Arn": "<p>The ARN of the image.</p>",
"Image$BaseImageArn": "<p>The ARN of the image from which this image was created.</p>",
"ImageBuilder$Arn": "<p>The ARN for the image builder.</p>",
"ImageBuilder$ImageArn": "<p>The ARN of the image from which this builder was created.</p>",
"ImageBuilder$IamRoleArn": "<p>The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the <b>AppStream_Machine_Role</b> credential profile on the instance.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html\">Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>",
"ListTagsForResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>",
"Stack$Arn": "<p>The ARN of the stack.</p>",
"TagResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>",
"UntagResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>",
"UpdateFleetRequest$ImageArn": "<p>The ARN of the public, private, or shared image to use.</p>",
"UpdateFleetRequest$IamRoleArn": "<p>The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) <code>AssumeRole</code> API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the <b>AppStream_Machine_Role</b> credential profile on the instance.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/using-iam-roles-to-grant-permissions-to-applications-scripts-streaming-instances.html\">Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances</a> in the <i>Amazon AppStream 2.0 Administration Guide</i>.</p>",
"User$Arn": "<p>The ARN of the user.</p>"
}
},
"ArnList": {
"base": null,
"refs": {
"DescribeImagesRequest$Arns": "<p>The ARNs of the public, private, and shared images to describe.</p>"
}
},
"AssociateFleetRequest": {
"base": null,
"refs": {
}
},
"AssociateFleetResult": {
"base": null,
"refs": {
}
},
"AuthenticationType": {
"base": null,
"refs": {
"CreateUserRequest$AuthenticationType": "<p>The authentication type for the user. You must specify USERPOOL. </p>",
"DeleteUserRequest$AuthenticationType": "<p>The authentication type for the user. You must specify USERPOOL.</p>",
"DescribeSessionsRequest$AuthenticationType": "<p>The authentication method. Specify <code>API</code> for a user authenticated using a streaming URL or <code>SAML</code> for a SAML federated user. The default is to authenticate users using a streaming URL.</p>",
"DescribeUserStackAssociationsRequest$AuthenticationType": "<p>The authentication type for the user who is associated with the stack. You must specify USERPOOL.</p>",
"DescribeUsersRequest$AuthenticationType": "<p>The authentication type for the users in the user pool to describe. You must specify USERPOOL.</p>",
"DisableUserRequest$AuthenticationType": "<p>The authentication type for the user. You must specify USERPOOL.</p>",
"EnableUserRequest$AuthenticationType": "<p>The authentication type for the user. You must specify USERPOOL.</p>",
"Session$AuthenticationType": "<p>The authentication method. The user is authenticated using a streaming URL (<code>API</code>) or SAML 2.0 federation (<code>SAML</code>).</p>",
"User$AuthenticationType": "<p>The authentication type for the user.</p>",
"UserStackAssociation$AuthenticationType": "<p>The authentication type for the user.</p>"
}
},
"AwsAccountId": {
"base": null,
"refs": {
"AwsAccountIdList$member": null,
"DeleteImagePermissionsRequest$SharedAccountId": "<p>The 12-digit identifier of the AWS account for which to delete image permissions.</p>",
"SharedImagePermissions$sharedAccountId": "<p>The 12-digit identifier of the AWS account with which the image is shared.</p>",
"UpdateImagePermissionsRequest$SharedAccountId": "<p>The 12-digit identifier of the AWS account for which you want add or update image permissions.</p>"
}
},
"AwsAccountIdList": {
"base": null,
"refs": {
"DescribeImagePermissionsRequest$SharedAwsAccountIds": "<p>The 12-digit identifier of one or more AWS accounts with which the image is shared.</p>"
}
},
"BatchAssociateUserStackRequest": {
"base": null,
"refs": {
}
},
"BatchAssociateUserStackResult": {
"base": null,
"refs": {
}
},
"BatchDisassociateUserStackRequest": {
"base": null,
"refs": {
}
},
"BatchDisassociateUserStackResult": {
"base": null,
"refs": {
}
},
"Boolean": {
"base": null,
"refs": {
"Application$Enabled": "<p>If there is a problem, the application can be disabled after image creation.</p>",
"ApplicationSettings$Enabled": "<p>Enables or disables persistent application settings for users during their streaming sessions. </p>",
"ApplicationSettingsResponse$Enabled": "<p>Specifies whether persistent application settings are enabled for users during their streaming sessions.</p>",
"Image$ImageBuilderSupported": "<p>Indicates whether an image builder can be launched from this image.</p>",
"UpdateFleetRequest$DeleteVpcConfig": "<p>Deletes the VPC association for the specified fleet.</p>",
"UpdateStackRequest$DeleteStorageConnectors": "<p>Deletes the storage connectors currently enabled for the stack.</p>",
"User$Enabled": "<p>Specifies whether the user in the user pool is enabled.</p>",
"UserStackAssociation$SendEmailNotification": "<p>Specifies whether a welcome email is sent to a user after the user is created in the user pool.</p>"
}
},
"BooleanObject": {
"base": null,
"refs": {
"CreateFleetRequest$EnableDefaultInternetAccess": "<p>Enables or disables default internet access for the fleet.</p>",
"CreateImageBuilderRequest$EnableDefaultInternetAccess": "<p>Enables or disables default internet access for the image builder.</p>",
"Fleet$EnableDefaultInternetAccess": "<p>Indicates whether default internet access is enabled for the fleet.</p>",
"ImageBuilder$EnableDefaultInternetAccess": "<p>Enables or disables default internet access for the image builder.</p>",
"ImagePermissions$allowFleet": "<p>Indicates whether the image can be used for a fleet.</p>",
"ImagePermissions$allowImageBuilder": "<p>Indicates whether the image can be used for an image builder.</p>",
"UpdateFleetRequest$EnableDefaultInternetAccess": "<p>Enables or disables default internet access for the fleet.</p>"
}
},
"ComputeCapacity": {
"base": "<p>Describes the capacity for a fleet.</p>",
"refs": {
"CreateFleetRequest$ComputeCapacity": "<p>The desired capacity for the fleet.</p>",
"UpdateFleetRequest$ComputeCapacity": "<p>The desired capacity for the fleet.</p>"
}
},
"ComputeCapacityStatus": {
"base": "<p>Describes the capacity status for a fleet.</p>",
"refs": {
"Fleet$ComputeCapacityStatus": "<p>The capacity status for the fleet.</p>"
}
},
"ConcurrentModificationException": {
"base": "<p>An API error occurred. Wait a few minutes and try again.</p>",
"refs": {
}
},
"CopyImageRequest": {
"base": null,
"refs": {
}
},
"CopyImageResponse": {
"base": null,
"refs": {
}
},
"CreateDirectoryConfigRequest": {
"base": null,
"refs": {
}
},
"CreateDirectoryConfigResult": {
"base": null,
"refs": {
}
},
"CreateFleetRequest": {
"base": null,
"refs": {
}
},
"CreateFleetResult": {
"base": null,
"refs": {
}
},
"CreateImageBuilderRequest": {
"base": null,
"refs": {
}
},
"CreateImageBuilderResult": {
"base": null,
"refs": {
}
},
"CreateImageBuilderStreamingURLRequest": {
"base": null,
"refs": {
}
},
"CreateImageBuilderStreamingURLResult": {
"base": null,
"refs": {
}
},
"CreateStackRequest": {
"base": null,
"refs": {
}
},
"CreateStackResult": {
"base": null,
"refs": {
}
},
"CreateStreamingURLRequest": {
"base": null,
"refs": {
}
},
"CreateStreamingURLResult": {
"base": null,
"refs": {
}
},
"CreateUsageReportSubscriptionRequest": {
"base": null,
"refs": {
}
},
"CreateUsageReportSubscriptionResult": {
"base": null,
"refs": {
}
},
"CreateUserRequest": {
"base": null,
"refs": {
}
},
"CreateUserResult": {
"base": null,
"refs": {
}
},
"DeleteDirectoryConfigRequest": {
"base": null,
"refs": {
}
},
"DeleteDirectoryConfigResult": {
"base": null,
"refs": {
}
},
"DeleteFleetRequest": {
"base": null,
"refs": {
}
},
"DeleteFleetResult": {
"base": null,
"refs": {
}
},
"DeleteImageBuilderRequest": {
"base": null,
"refs": {
}
},
"DeleteImageBuilderResult": {
"base": null,
"refs": {
}
},
"DeleteImagePermissionsRequest": {
"base": null,
"refs": {
}
},
"DeleteImagePermissionsResult": {
"base": null,
"refs": {
}
},
"DeleteImageRequest": {
"base": null,
"refs": {
}
},
"DeleteImageResult": {
"base": null,
"refs": {
}
},
"DeleteStackRequest": {
"base": null,
"refs": {
}
},
"DeleteStackResult": {
"base": null,
"refs": {
}
},
"DeleteUsageReportSubscriptionRequest": {
"base": null,
"refs": {
}
},
"DeleteUsageReportSubscriptionResult": {
"base": null,
"refs": {
}
},
"DeleteUserRequest": {
"base": null,
"refs": {
}
},
"DeleteUserResult": {
"base": null,
"refs": {
}
},
"DescribeDirectoryConfigsRequest": {
"base": null,
"refs": {
}
},
"DescribeDirectoryConfigsResult": {
"base": null,
"refs": {
}
},
"DescribeFleetsRequest": {
"base": null,
"refs": {
}
},
"DescribeFleetsResult": {
"base": null,
"refs": {
}
},
"DescribeImageBuildersRequest": {
"base": null,
"refs": {
}
},
"DescribeImageBuildersResult": {
"base": null,
"refs": {
}
},
"DescribeImagePermissionsRequest": {
"base": null,
"refs": {
}
},
"DescribeImagePermissionsResult": {
"base": null,
"refs": {
}
},
"DescribeImagesMaxResults": {
"base": null,
"refs": {
"DescribeImagesRequest$MaxResults": "<p>The maximum size of each page of results.</p>"
}
},
"DescribeImagesRequest": {
"base": null,
"refs": {
}
},
"DescribeImagesResult": {
"base": null,
"refs": {
}
},
"DescribeSessionsRequest": {
"base": null,
"refs": {
}
},
"DescribeSessionsResult": {
"base": null,
"refs": {
}
},
"DescribeStacksRequest": {
"base": null,
"refs": {
}
},
"DescribeStacksResult": {
"base": null,
"refs": {
}
},
"DescribeUsageReportSubscriptionsRequest": {
"base": null,
"refs": {
}
},
"DescribeUsageReportSubscriptionsResult": {
"base": null,
"refs": {
}
},
"DescribeUserStackAssociationsRequest": {
"base": null,
"refs": {
}
},
"DescribeUserStackAssociationsResult": {
"base": null,
"refs": {
}
},
"DescribeUsersRequest": {
"base": null,
"refs": {
}
},
"DescribeUsersResult": {
"base": null,
"refs": {
}
},
"Description": {
"base": null,
"refs": {
"CopyImageRequest$DestinationImageDescription": "<p>The description that the image will have when it is copied to the destination.</p>",
"CreateFleetRequest$Description": "<p>The description to display.</p>",
"CreateImageBuilderRequest$Description": "<p>The description to display.</p>",
"CreateStackRequest$Description": "<p>The description to display.</p>",
"UpdateFleetRequest$Description": "<p>The description to display.</p>",
"UpdateStackRequest$Description": "<p>The description to display.</p>"
}
},
"DirectoryConfig": {
"base": "<p>Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.</p>",
"refs": {
"CreateDirectoryConfigResult$DirectoryConfig": "<p>Information about the directory configuration.</p>",
"DirectoryConfigList$member": null,
"UpdateDirectoryConfigResult$DirectoryConfig": "<p>Information about the Directory Config object.</p>"
}
},
"DirectoryConfigList": {
"base": null,
"refs": {
"DescribeDirectoryConfigsResult$DirectoryConfigs": "<p>Information about the directory configurations. Note that although the response syntax in this topic includes the account password, this password is not returned in the actual response. </p>"
}
},
"DirectoryName": {
"base": null,
"refs": {
"CreateDirectoryConfigRequest$DirectoryName": "<p>The fully qualified name of the directory (for example, corp.example.com).</p>",
"DeleteDirectoryConfigRequest$DirectoryName": "<p>The name of the directory configuration.</p>",
"DirectoryConfig$DirectoryName": "<p>The fully qualified name of the directory (for example, corp.example.com).</p>",
"DirectoryNameList$member": null,
"DomainJoinInfo$DirectoryName": "<p>The fully qualified name of the directory (for example, corp.example.com).</p>",
"UpdateDirectoryConfigRequest$DirectoryName": "<p>The name of the Directory Config object.</p>"
}
},
"DirectoryNameList": {
"base": null,
"refs": {
"DescribeDirectoryConfigsRequest$DirectoryNames": "<p>The directory names.</p>"
}
},
"DisableUserRequest": {
"base": null,
"refs": {
}
},
"DisableUserResult": {
"base": null,
"refs": {
}
},
"DisassociateFleetRequest": {
"base": null,
"refs": {
}
},
"DisassociateFleetResult": {
"base": null,
"refs": {
}
},
"DisplayName": {
"base": null,
"refs": {
"CreateFleetRequest$DisplayName": "<p>The fleet name to display.</p>",
"CreateImageBuilderRequest$DisplayName": "<p>The image builder name to display.</p>",
"CreateStackRequest$DisplayName": "<p>The stack name to display.</p>",
"UpdateFleetRequest$DisplayName": "<p>The fleet name to display.</p>",
"UpdateStackRequest$DisplayName": "<p>The stack name to display.</p>"
}
},
"Domain": {
"base": "GSuite domain for GDrive integration.",
"refs": {
"DomainList$member": null
}
},
"DomainJoinInfo": {
"base": "<p>Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.</p>",
"refs": {
"CreateFleetRequest$DomainJoinInfo": "<p>The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. </p>",
"CreateImageBuilderRequest$DomainJoinInfo": "<p>The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. </p>",
"Fleet$DomainJoinInfo": "<p>The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. </p>",
"ImageBuilder$DomainJoinInfo": "<p>The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. </p>",
"UpdateFleetRequest$DomainJoinInfo": "<p>The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. </p>"
}
},
"DomainList": {
"base": null,
"refs": {
"StorageConnector$Domains": "<p>The names of the domains for the account.</p>"
}
},
"EmbedHostDomain": {
"base": "Specifies a valid domain that can embed AppStream. Valid examples include: [\"testorigin.tt--com\", \"testingorigin.com.us\", \"test.com.us\"] Invalid examples include: [\"test,com\", \".com\", \"h*llo.com\". \"\"]",
"refs": {
"EmbedHostDomains$member": null
}
},
"EmbedHostDomains": {
"base": null,
"refs": {
"CreateStackRequest$EmbedHostDomains": "<p>The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.</p>",
"Stack$EmbedHostDomains": "<p>The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.</p>",
"UpdateStackRequest$EmbedHostDomains": "<p>The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.</p>"
}
},
"EnableUserRequest": {
"base": null,
"refs": {
}
},
"EnableUserResult": {
"base": null,
"refs": {
}
},
"ErrorMessage": {
"base": "<p>The error message in the exception.</p>",
"refs": {
"ConcurrentModificationException$Message": null,
"IncompatibleImageException$Message": null,
"InvalidAccountStatusException$Message": null,
"InvalidParameterCombinationException$Message": null,
"InvalidRoleException$Message": null,
"LimitExceededException$Message": null,
"OperationNotPermittedException$Message": null,
"ResourceAlreadyExistsException$Message": null,
"ResourceInUseException$Message": null,
"ResourceNotAvailableException$Message": null,
"ResourceNotFoundException$Message": null
}
},
"ExpireSessionRequest": {
"base": null,
"refs": {
}
},
"ExpireSessionResult": {
"base": null,
"refs": {
}
},
"FeedbackURL": {
"base": null,
"refs": {
"CreateStackRequest$FeedbackURL": "<p>The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.</p>",
"Stack$FeedbackURL": "<p>The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.</p>",
"UpdateStackRequest$FeedbackURL": "<p>The URL that users are redirected to after they choose the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.</p>"
}
},
"Fleet": {
"base": "<p>Describes a fleet.</p>",
"refs": {
"CreateFleetResult$Fleet": "<p>Information about the fleet.</p>",
"FleetList$member": null,
"UpdateFleetResult$Fleet": "<p>Information about the fleet.</p>"
}
},
"FleetAttribute": {
"base": "<p>The fleet attribute.</p>",
"refs": {
"FleetAttributes$member": null
}
},
"FleetAttributes": {
"base": "<p>The fleet attributes.</p>",
"refs": {
"UpdateFleetRequest$AttributesToDelete": "<p>The fleet attributes to delete.</p>"
}
},
"FleetError": {
"base": "<p>Describes a fleet error.</p>",
"refs": {
"FleetErrors$member": null
}
},
"FleetErrorCode": {
"base": null,
"refs": {
"FleetError$ErrorCode": "<p>The error code.</p>",
"ResourceError$ErrorCode": "<p>The error code.</p>"
}
},
"FleetErrors": {
"base": null,
"refs": {
"Fleet$FleetErrors": "<p>The fleet errors.</p>"
}
},
"FleetList": {
"base": "<p>The fleets.</p>",
"refs": {
"DescribeFleetsResult$Fleets": "<p>Information about the fleets.</p>"
}
},
"FleetState": {
"base": null,
"refs": {
"Fleet$State": "<p>The current state for the fleet.</p>"
}
},
"FleetType": {
"base": null,
"refs": {
"CreateFleetRequest$FleetType": "<p>The fleet type.</p> <dl> <dt>ALWAYS_ON</dt> <dd> <p>Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.</p> </dd> <dt>ON_DEMAND</dt> <dd> <p>Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.</p> </dd> </dl>",
"Fleet$FleetType": "<p>The fleet type.</p> <dl> <dt>ALWAYS_ON</dt> <dd> <p>Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.</p> </dd> <dt>ON_DEMAND</dt> <dd> <p>Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.</p> </dd> </dl>"
}
},
"Image": {
"base": "<p>Describes an image.</p>",
"refs": {
"DeleteImageResult$Image": "<p>Information about the image.</p>",
"ImageList$member": null
}
},
"ImageBuilder": {
"base": "<p>Describes a virtual machine that is used to create an image. </p>",
"refs": {
"CreateImageBuilderResult$ImageBuilder": "<p>Information about the image builder.</p>",
"DeleteImageBuilderResult$ImageBuilder": "<p>Information about the image builder.</p>",
"ImageBuilderList$member": null,
"StartImageBuilderResult$ImageBuilder": "<p>Information about the image builder.</p>",
"StopImageBuilderResult$ImageBuilder": "<p>Information about the image builder.</p>"
}
},
"ImageBuilderList": {
"base": null,
"refs": {
"DescribeImageBuildersResult$ImageBuilders": "<p>Information about the image builders.</p>"
}
},
"ImageBuilderState": {
"base": null,
"refs": {
"ImageBuilder$State": "<p>The state of the image builder.</p>"
}
},
"ImageBuilderStateChangeReason": {
"base": "<p>Describes the reason why the last image builder state change occurred.</p>",
"refs": {
"ImageBuilder$StateChangeReason": "<p>The reason why the last state change occurred.</p>"
}
},
"ImageBuilderStateChangeReasonCode": {
"base": null,
"refs": {
"ImageBuilderStateChangeReason$Code": "<p>The state change reason code.</p>"
}
},
"ImageList": {
"base": null,
"refs": {
"DescribeImagesResult$Images": "<p>Information about the images.</p>"
}
},
"ImagePermissions": {
"base": "<p>Describes the permissions for an image. </p>",
"refs": {
"Image$ImagePermissions": "<p>The permissions to provide to the destination AWS account for the specified image.</p>",
"SharedImagePermissions$imagePermissions": "<p>Describes the permissions for a shared image.</p>",
"UpdateImagePermissionsRequest$ImagePermissions": "<p>The permissions for the image.</p>"
}
},
"ImageState": {
"base": null,
"refs": {
"Image$State": "<p>The image starts in the <code>PENDING</code> state. If image creation succeeds, the state is <code>AVAILABLE</code>. If image creation fails, the state is <code>FAILED</code>.</p>"
}
},
"ImageStateChangeReason": {
"base": "<p>Describes the reason why the last image state change occurred.</p>",
"refs": {
"Image$StateChangeReason": "<p>The reason why the last state change occurred.</p>"
}
},
"ImageStateChangeReasonCode": {
"base": null,
"refs": {
"ImageStateChangeReason$Code": "<p>The state change reason code.</p>"
}
},
"IncompatibleImageException": {
"base": "<p>The image does not support storage connectors.</p>",
"refs": {
}
},
"Integer": {
"base": null,
"refs": {
"ComputeCapacity$DesiredInstances": "<p>The desired number of streaming instances.</p>",
"ComputeCapacityStatus$Desired": "<p>The desired number of streaming instances.</p>",
"ComputeCapacityStatus$Running": "<p>The total number of simultaneous streaming instances that are running.</p>",
"ComputeCapacityStatus$InUse": "<p>The number of instances in use for streaming.</p>",
"ComputeCapacityStatus$Available": "<p>The number of currently available instances that can be used to stream sessions.</p>",
"CreateFleetRequest$MaxUserDurationInSeconds": "<p>The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.</p> <p>Specify a value between 600 and 360000.</p>",
"CreateFleetRequest$DisconnectTimeoutInSeconds": "<p>The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance. </p> <p>Specify a value between 60 and 360000.</p>",
"CreateFleetRequest$IdleDisconnectTimeoutInSeconds": "<p>The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the <code>DisconnectTimeoutInSeconds</code> time interval begins. Users are notified before they are disconnected due to inactivity. If they try to reconnect to the streaming session before the time interval specified in <code>DisconnectTimeoutInSeconds</code> elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in <code>IdleDisconnectTimeoutInSeconds</code> elapses, they are disconnected.</p> <p>To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.</p> <note> <p>If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity. </p> </note>",
"DescribeDirectoryConfigsRequest$MaxResults": "<p>The maximum size of each page of results.</p>",
"DescribeImageBuildersRequest$MaxResults": "<p>The maximum size of each page of results.</p>",
"DescribeSessionsRequest$Limit": "<p>The size of each page of results. The default value is 20 and the maximum value is 50.</p>",
"DescribeUsageReportSubscriptionsRequest$MaxResults": "<p>The maximum size of each page of results.</p>",
"DescribeUsersRequest$MaxResults": "<p>The maximum size of each page of results.</p>",
"Fleet$MaxUserDurationInSeconds": "<p>The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance. </p> <p>Specify a value between 600 and 360000.</p>",
"Fleet$DisconnectTimeoutInSeconds": "<p>The amount of time that a streaming session remains active after users disconnect. If they try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.</p> <p>Specify a value between 60 and 360000.</p>",
"Fleet$IdleDisconnectTimeoutInSeconds": "<p>The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the <code>DisconnectTimeoutInSeconds</code> time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in <code>DisconnectTimeoutInSeconds</code> elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in <code>IdleDisconnectTimeoutInSeconds</code> elapses, they are disconnected.</p> <p>To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.</p> <note> <p>If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity. </p> </note>",
"UpdateFleetRequest$MaxUserDurationInSeconds": "<p>The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.</p> <p>Specify a value between 600 and 360000.</p>",
"UpdateFleetRequest$DisconnectTimeoutInSeconds": "<p>The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance. </p> <p>Specify a value between 60 and 360000.</p>",
"UpdateFleetRequest$IdleDisconnectTimeoutInSeconds": "<p>The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the <code>DisconnectTimeoutInSeconds</code> time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in <code>DisconnectTimeoutInSeconds</code> elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in <code>IdleDisconnectTimeoutInSeconds</code> elapses, they are disconnected. </p> <p>To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.</p> <note> <p>If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity. </p> </note>"
}
},
"InvalidAccountStatusException": {
"base": "<p>The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support. </p>",
"refs": {
}
},
"InvalidParameterCombinationException": {
"base": "<p>Indicates an incorrect combination of parameters, or a missing parameter.</p>",
"refs": {
}
},
"InvalidRoleException": {
"base": "<p>The specified role is invalid.</p>",
"refs": {
}
},
"LastReportGenerationExecutionError": {
"base": "<p>Describes the error that is returned when a usage report can't be generated.</p>",
"refs": {
"LastReportGenerationExecutionErrors$member": null
}
},
"LastReportGenerationExecutionErrors": {
"base": null,
"refs": {
"UsageReportSubscription$SubscriptionErrors": "<p>The errors that were returned if usage reports couldn't be generated.</p>"
}
},
"LimitExceededException": {
"base": "<p>The requested limit exceeds the permitted limit for an account.</p>",
"refs": {
}
},
"ListAssociatedFleetsRequest": {
"base": null,
"refs": {
}
},
"ListAssociatedFleetsResult": {
"base": null,
"refs": {
}
},
"ListAssociatedStacksRequest": {
"base": null,
"refs": {
}
},
"ListAssociatedStacksResult": {
"base": null,
"refs": {
}
},
"ListTagsForResourceRequest": {
"base": null,
"refs": {
}
},
"ListTagsForResourceResponse": {
"base": null,
"refs": {
}
},
"Long": {
"base": null,
"refs": {
"CreateImageBuilderStreamingURLRequest$Validity": "<p>The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 3600 seconds.</p>",
"CreateStreamingURLRequest$Validity": "<p>The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 60 seconds.</p>"
}
},
"MaxResults": {
"base": null,
"refs": {
"DescribeImagePermissionsRequest$MaxResults": "<p>The maximum size of each page of results.</p>",
"DescribeUserStackAssociationsRequest$MaxResults": "<p>The maximum size of each page of results.</p>"
}
},
"MessageAction": {
"base": null,
"refs": {
"CreateUserRequest$MessageAction": "<p>The action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent. </p> <note> <p>The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.</p> </note>"
}
},
"Metadata": {
"base": null,
"refs": {
"Application$Metadata": "<p>Additional attributes that describe the application.</p>"
}
},
"Name": {
"base": null,
"refs": {
"CopyImageRequest$SourceImageName": "<p>The name of the image to copy.</p>",
"CopyImageRequest$DestinationImageName": "<p>The name that the image will have when it is copied to the destination.</p>",
"CopyImageResponse$DestinationImageName": "<p>The name of the destination image.</p>",
"CreateFleetRequest$Name": "<p>A unique name for the fleet.</p>",
"CreateImageBuilderRequest$Name": "<p>A unique name for the image builder.</p>",
"CreateStackRequest$Name": "<p>The name of the stack.</p>",
"DeleteImageBuilderRequest$Name": "<p>The name of the image builder.</p>",
"DeleteImagePermissionsRequest$Name": "<p>The name of the private image.</p>",
"DeleteImageRequest$Name": "<p>The name of the image.</p>",
"DescribeImagePermissionsRequest$Name": "<p>The name of the private image for which to describe permissions. The image must be one that you own. </p>",
"DescribeImagePermissionsResult$Name": "<p>The name of the private image.</p>",
"UpdateImagePermissionsRequest$Name": "<p>The name of the private image.</p>"
}
},
"NetworkAccessConfiguration": {
"base": "<p>Describes the network details of the fleet or image builder instance.</p>",
"refs": {
"ImageBuilder$NetworkAccessConfiguration": null,
"Session$NetworkAccessConfiguration": "<p>The network details for the streaming session.</p>"
}
},
"OperationNotPermittedException": {
"base": "<p>The attempted operation is not permitted.</p>",
"refs": {
}
},
"OrganizationalUnitDistinguishedName": {
"base": null,
"refs": {
"DomainJoinInfo$OrganizationalUnitDistinguishedName": "<p>The distinguished name of the organizational unit for computer accounts.</p>",
"OrganizationalUnitDistinguishedNamesList$member": null
}
},
"OrganizationalUnitDistinguishedNamesList": {
"base": null,
"refs": {
"CreateDirectoryConfigRequest$OrganizationalUnitDistinguishedNames": "<p>The distinguished names of the organizational units for computer accounts.</p>",
"DirectoryConfig$OrganizationalUnitDistinguishedNames": "<p>The distinguished names of the organizational units for computer accounts.</p>",
"UpdateDirectoryConfigRequest$OrganizationalUnitDistinguishedNames": "<p>The distinguished names of the organizational units for computer accounts.</p>"
}
},
"Permission": {
"base": null,
"refs": {
"UserSetting$Permission": "<p>Indicates whether the action is enabled or disabled.</p>"
}
},
"PlatformType": {
"base": null,
"refs": {
"Image$Platform": "<p>The operating system platform of the image.</p>",
"ImageBuilder$Platform": "<p>The operating system platform of the image builder.</p>"
}
},
"RedirectURL": {
"base": null,
"refs": {
"CreateStackRequest$RedirectURL": "<p>The URL that users are redirected to after their streaming session ends.</p>",
"Stack$RedirectURL": "<p>The URL that users are redirected to after their streaming session ends.</p>",
"UpdateStackRequest$RedirectURL": "<p>The URL that users are redirected to after their streaming session ends.</p>"