aws-sdk-appstream 1.0.0.rc2 → 1.0.0.rc3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,23 +1,14 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
- module Aws
9
- module AppStream
10
- module Errors
8
+ module Aws::AppStream
9
+ module Errors
11
10
 
12
- extend Aws::Errors::DynamicErrors
11
+ extend Aws::Errors::DynamicErrors
13
12
 
14
- # Raised when calling #load or #data on a resource class that can not be
15
- # loaded. This can happen when:
16
- #
17
- # * A resource class has identifiers, but no data attributes.
18
- # * Resource data is only available when making an API call that
19
- # enumerates all resources of that type.
20
- class ResourceNotLoadable < RuntimeError; end
21
- end
22
13
  end
23
14
  end
@@ -1,25 +1,23 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
- module Aws
9
- module AppStream
10
- class Resource
8
+ module Aws::AppStream
9
+ class Resource
11
10
 
12
- # @param options ({})
13
- # @option options [Client] :client
14
- def initialize(options = {})
15
- @client = options[:client] || Client.new(options)
16
- end
17
-
18
- # @return [Client]
19
- def client
20
- @client
21
- end
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
22
16
 
17
+ # @return [Client]
18
+ def client
19
+ @client
23
20
  end
21
+
24
22
  end
25
23
  end
@@ -1,967 +1,1168 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
- module Aws
9
- module AppStream
10
- module Types
11
-
12
- # An entry for a single application in the application catalog.
13
- # @!attribute [rw] name
14
- # The unique identifier for the application.
15
- # @return [String]
16
- #
17
- # @!attribute [rw] display_name
18
- # The name of the application shown to the end users.
19
- # @return [String]
20
- #
21
- # @!attribute [rw] icon_url
22
- # The URL for the application icon. This URL may be time-limited.
23
- # @return [String]
24
- #
25
- # @!attribute [rw] launch_path
26
- # The path to the application executable in the instance.
27
- # @return [String]
28
- #
29
- # @!attribute [rw] launch_parameters
30
- # A list of arguments that are passed to the application at launch.
31
- # @return [String]
32
- #
33
- # @!attribute [rw] enabled
34
- # An application can be disabled after image creation if there is a
35
- # problem.
36
- # @return [Boolean]
37
- #
38
- # @!attribute [rw] metadata
39
- # Additional attributes that describes the application.
40
- # @return [Hash<String,String>]
41
- class Application < Struct.new(
42
- :name,
43
- :display_name,
44
- :icon_url,
45
- :launch_path,
46
- :launch_parameters,
47
- :enabled,
48
- :metadata)
49
- include Aws::Structure
50
- end
51
-
52
- # @note When making an API call, pass AssociateFleetRequest
53
- # data as a hash:
54
- #
55
- # {
56
- # fleet_name: "String", # required
57
- # stack_name: "String", # required
58
- # }
59
- # @!attribute [rw] fleet_name
60
- # The name of the fleet to associate.
61
- # @return [String]
62
- #
63
- # @!attribute [rw] stack_name
64
- # The name of the stack to which the fleet is associated.
65
- # @return [String]
66
- class AssociateFleetRequest < Struct.new(
67
- :fleet_name,
68
- :stack_name)
69
- include Aws::Structure
70
- end
71
-
72
- class AssociateFleetResult < Aws::EmptyStructure; end
73
-
74
- # The capacity configuration for the fleet.
75
- # @note When making an API call, pass ComputeCapacity
76
- # data as a hash:
77
- #
78
- # {
79
- # desired_instances: 1, # required
80
- # }
81
- # @!attribute [rw] desired_instances
82
- # The desired number of streaming instances.
83
- # @return [Integer]
84
- class ComputeCapacity < Struct.new(
85
- :desired_instances)
86
- include Aws::Structure
87
- end
88
-
89
- # The capacity information for the fleet.
90
- # @!attribute [rw] desired
91
- # The desired number of streaming instances.
92
- # @return [Integer]
93
- #
94
- # @!attribute [rw] running
95
- # The total number of simultaneous streaming instances that are
96
- # running.
97
- # @return [Integer]
98
- #
99
- # @!attribute [rw] in_use
100
- # The number of instances that are being used for streaming.
101
- # @return [Integer]
102
- #
103
- # @!attribute [rw] available
104
- # The number of currently available instances that can be used to
105
- # stream sessions.
106
- # @return [Integer]
107
- class ComputeCapacityStatus < Struct.new(
108
- :desired,
109
- :running,
110
- :in_use,
111
- :available)
112
- include Aws::Structure
113
- end
114
-
115
- # Contains the parameters for the new fleet to create.
116
- # @note When making an API call, pass CreateFleetRequest
117
- # data as a hash:
118
- #
119
- # {
120
- # name: "Name", # required
121
- # image_name: "String", # required
122
- # instance_type: "String", # required
123
- # compute_capacity: { # required
124
- # desired_instances: 1, # required
125
- # },
126
- # vpc_config: {
127
- # subnet_ids: ["String"], # required
128
- # },
129
- # max_user_duration_in_seconds: 1,
130
- # disconnect_timeout_in_seconds: 1,
131
- # description: "Description",
132
- # display_name: "DisplayName",
133
- # }
134
- # @!attribute [rw] name
135
- # A unique identifier for the fleet.
136
- # @return [String]
137
- #
138
- # @!attribute [rw] image_name
139
- # Unique name of the image used by the fleet.
140
- # @return [String]
141
- #
142
- # @!attribute [rw] instance_type
143
- # The instance type of compute resources for the fleet. Fleet
144
- # instances are launched from this instance type.
145
- # @return [String]
146
- #
147
- # @!attribute [rw] compute_capacity
148
- # The parameters for the capacity allocated to the fleet.
149
- # @return [Types::ComputeCapacity]
150
- #
151
- # @!attribute [rw] vpc_config
152
- # The VPC configuration for the fleet.
153
- # @return [Types::VpcConfig]
154
- #
155
- # @!attribute [rw] max_user_duration_in_seconds
156
- # The maximum time up to which a streaming session can run.
157
- # @return [Integer]
158
- #
159
- # @!attribute [rw] disconnect_timeout_in_seconds
160
- # The time after disconnection when a session is considered to have
161
- # ended. If a user who got disconnected reconnects within this timeout
162
- # interval, the user is connected back to his/her previous session.
163
- # @return [Integer]
164
- #
165
- # @!attribute [rw] description
166
- # The description of the fleet.
167
- # @return [String]
168
- #
169
- # @!attribute [rw] display_name
170
- # The display name of the fleet.
171
- # @return [String]
172
- class CreateFleetRequest < Struct.new(
173
- :name,
174
- :image_name,
175
- :instance_type,
176
- :compute_capacity,
177
- :vpc_config,
178
- :max_user_duration_in_seconds,
179
- :disconnect_timeout_in_seconds,
180
- :description,
181
- :display_name)
182
- include Aws::Structure
183
- end
184
-
185
- # @!attribute [rw] fleet
186
- # The details for the created fleet.
187
- # @return [Types::Fleet]
188
- class CreateFleetResult < Struct.new(
189
- :fleet)
190
- include Aws::Structure
191
- end
192
-
193
- # @note When making an API call, pass CreateStackRequest
194
- # data as a hash:
195
- #
196
- # {
197
- # name: "String", # required
198
- # description: "Description",
199
- # display_name: "DisplayName",
200
- # }
201
- # @!attribute [rw] name
202
- # The unique identifier for this stack.
203
- # @return [String]
204
- #
205
- # @!attribute [rw] description
206
- # The description displayed to end users on the AppStream 2.0 portal.
207
- # @return [String]
208
- #
209
- # @!attribute [rw] display_name
210
- # The name displayed to end users on the AppStream 2.0 portal.
211
- # @return [String]
212
- class CreateStackRequest < Struct.new(
213
- :name,
214
- :description,
215
- :display_name)
216
- include Aws::Structure
217
- end
218
-
219
- # @!attribute [rw] stack
220
- # The details for the created stack.
221
- # @return [Types::Stack]
222
- class CreateStackResult < Struct.new(
223
- :stack)
224
- include Aws::Structure
225
- end
226
-
227
- # @note When making an API call, pass CreateStreamingURLRequest
228
- # data as a hash:
229
- #
230
- # {
231
- # stack_name: "String", # required
232
- # fleet_name: "String", # required
233
- # user_id: "UserId", # required
234
- # application_id: "String",
235
- # validity: 1,
236
- # session_context: "String",
237
- # }
238
- # @!attribute [rw] stack_name
239
- # The stack for which the URL is generated.
240
- # @return [String]
241
- #
242
- # @!attribute [rw] fleet_name
243
- # The fleet for which the URL is generated.
244
- # @return [String]
245
- #
246
- # @!attribute [rw] user_id
247
- # A unique user ID for whom the URL is generated.
248
- # @return [String]
249
- #
250
- # @!attribute [rw] application_id
251
- # The ID of the application that must be launched after the session
252
- # starts.
253
- # @return [String]
254
- #
255
- # @!attribute [rw] validity
256
- # The validity duration of the URL in seconds. After this duration,
257
- # the URL returned by this operation becomes invalid.
258
- # @return [Integer]
259
- #
260
- # @!attribute [rw] session_context
261
- # The sessionContext of the streaming URL.
262
- # @return [String]
263
- class CreateStreamingURLRequest < Struct.new(
264
- :stack_name,
265
- :fleet_name,
266
- :user_id,
267
- :application_id,
268
- :validity,
269
- :session_context)
270
- include Aws::Structure
271
- end
272
-
273
- # @!attribute [rw] streaming_url
274
- # The URL to start the AppStream 2.0 streaming session.
275
- # @return [String]
276
- #
277
- # @!attribute [rw] expires
278
- # Elapsed seconds after the Unix epoch, at which time this URL
279
- # expires.
280
- # @return [Time]
281
- class CreateStreamingURLResult < Struct.new(
282
- :streaming_url,
283
- :expires)
284
- include Aws::Structure
285
- end
286
-
287
- # @note When making an API call, pass DeleteFleetRequest
288
- # data as a hash:
289
- #
290
- # {
291
- # name: "String", # required
292
- # }
293
- # @!attribute [rw] name
294
- # The name of the fleet to be deleted.
295
- # @return [String]
296
- class DeleteFleetRequest < Struct.new(
297
- :name)
298
- include Aws::Structure
299
- end
300
-
301
- class DeleteFleetResult < Aws::EmptyStructure; end
302
-
303
- # @note When making an API call, pass DeleteStackRequest
304
- # data as a hash:
305
- #
306
- # {
307
- # name: "String", # required
308
- # }
309
- # @!attribute [rw] name
310
- # The name of the stack to delete.
311
- # @return [String]
312
- class DeleteStackRequest < Struct.new(
313
- :name)
314
- include Aws::Structure
315
- end
316
-
317
- class DeleteStackResult < Aws::EmptyStructure; end
318
-
319
- # @note When making an API call, pass DescribeFleetsRequest
320
- # data as a hash:
321
- #
322
- # {
323
- # names: ["String"],
324
- # next_token: "String",
325
- # }
326
- # @!attribute [rw] names
327
- # The fleet names to describe. Use null to describe all the fleets for
328
- # the AWS account.
329
- # @return [Array<String>]
330
- #
331
- # @!attribute [rw] next_token
332
- # The pagination token to use to retrieve the next page of results for
333
- # this operation. If this value is null, it retrieves the first page.
334
- # @return [String]
335
- class DescribeFleetsRequest < Struct.new(
336
- :names,
337
- :next_token)
338
- include Aws::Structure
339
- end
340
-
341
- # @!attribute [rw] fleets
342
- # The list of fleet details.
343
- # @return [Array<Types::Fleet>]
344
- #
345
- # @!attribute [rw] next_token
346
- # The pagination token to use to retrieve the next page of results for
347
- # this operation. If there are no more pages, this value is null.
348
- # @return [String]
349
- class DescribeFleetsResult < Struct.new(
350
- :fleets,
351
- :next_token)
352
- include Aws::Structure
353
- end
354
-
355
- # @note When making an API call, pass DescribeImagesRequest
356
- # data as a hash:
357
- #
358
- # {
359
- # names: ["String"],
360
- # }
361
- # @!attribute [rw] names
362
- # A specific list of images to describe.
363
- # @return [Array<String>]
364
- class DescribeImagesRequest < Struct.new(
365
- :names)
366
- include Aws::Structure
367
- end
368
-
369
- # @!attribute [rw] images
370
- # The list of images.
371
- # @return [Array<Types::Image>]
372
- class DescribeImagesResult < Struct.new(
373
- :images)
374
- include Aws::Structure
375
- end
376
-
377
- # @note When making an API call, pass DescribeSessionsRequest
378
- # data as a hash:
379
- #
380
- # {
381
- # stack_name: "String", # required
382
- # fleet_name: "String", # required
383
- # user_id: "UserId",
384
- # next_token: "String",
385
- # limit: 1,
386
- # }
387
- # @!attribute [rw] stack_name
388
- # The name of the stack for which to list sessions.
389
- # @return [String]
390
- #
391
- # @!attribute [rw] fleet_name
392
- # The name of the fleet for which to list sessions.
393
- # @return [String]
394
- #
395
- # @!attribute [rw] user_id
396
- # The user for whom to list sessions. Use null to describe all the
397
- # sessions for the stack and fleet.
398
- # @return [String]
399
- #
400
- # @!attribute [rw] next_token
401
- # The pagination token to use to retrieve the next page of results for
402
- # this operation. If this value is null, it retrieves the first page.
403
- # @return [String]
404
- #
405
- # @!attribute [rw] limit
406
- # The size of each page of results. The default value is 20 and the
407
- # maximum supported value is 50.
408
- # @return [Integer]
409
- class DescribeSessionsRequest < Struct.new(
410
- :stack_name,
411
- :fleet_name,
412
- :user_id,
413
- :next_token,
414
- :limit)
415
- include Aws::Structure
416
- end
417
-
418
- # @!attribute [rw] sessions
419
- # The list of streaming sessions.
420
- # @return [Array<Types::Session>]
421
- #
422
- # @!attribute [rw] next_token
423
- # The pagination token to use to retrieve the next page of results for
424
- # this operation. If there are no more pages, this value is null.
425
- # @return [String]
426
- class DescribeSessionsResult < Struct.new(
427
- :sessions,
428
- :next_token)
429
- include Aws::Structure
430
- end
431
-
432
- # @note When making an API call, pass DescribeStacksRequest
433
- # data as a hash:
434
- #
435
- # {
436
- # names: ["String"],
437
- # next_token: "String",
438
- # }
439
- # @!attribute [rw] names
440
- # The stack names to describe. Use null to describe all the stacks for
441
- # the AWS account.
442
- # @return [Array<String>]
443
- #
444
- # @!attribute [rw] next_token
445
- # The pagination token to use to retrieve the next page of results for
446
- # this operation. If this value is null, it retrieves the first page.
447
- # @return [String]
448
- class DescribeStacksRequest < Struct.new(
449
- :names,
450
- :next_token)
451
- include Aws::Structure
452
- end
453
-
454
- # @!attribute [rw] stacks
455
- # The list of stack details.
456
- # @return [Array<Types::Stack>]
457
- #
458
- # @!attribute [rw] next_token
459
- # The pagination token to use to retrieve the next page of results for
460
- # this operation. If there are no more pages, this value is null.
461
- # @return [String]
462
- class DescribeStacksResult < Struct.new(
463
- :stacks,
464
- :next_token)
465
- include Aws::Structure
466
- end
467
-
468
- # @note When making an API call, pass DisassociateFleetRequest
469
- # data as a hash:
470
- #
471
- # {
472
- # fleet_name: "String", # required
473
- # stack_name: "String", # required
474
- # }
475
- # @!attribute [rw] fleet_name
476
- # The name of the fleet to disassociate.
477
- # @return [String]
478
- #
479
- # @!attribute [rw] stack_name
480
- # The name of the stack with which the fleet is associated.
481
- # @return [String]
482
- class DisassociateFleetRequest < Struct.new(
483
- :fleet_name,
484
- :stack_name)
485
- include Aws::Structure
486
- end
487
-
488
- class DisassociateFleetResult < Aws::EmptyStructure; end
489
-
490
- # @note When making an API call, pass ExpireSessionRequest
491
- # data as a hash:
492
- #
493
- # {
494
- # session_id: "String", # required
495
- # }
496
- # @!attribute [rw] session_id
497
- # The unique identifier of the streaming session to be stopped.
498
- # @return [String]
499
- class ExpireSessionRequest < Struct.new(
500
- :session_id)
501
- include Aws::Structure
502
- end
503
-
504
- class ExpireSessionResult < Aws::EmptyStructure; end
505
-
506
- # Contains the parameters for a fleet.
507
- # @!attribute [rw] arn
508
- # The ARN for the fleet.
509
- # @return [String]
510
- #
511
- # @!attribute [rw] name
512
- # The name of the fleet.
513
- # @return [String]
514
- #
515
- # @!attribute [rw] display_name
516
- # The name displayed to end users on the AppStream 2.0 portal.
517
- # @return [String]
518
- #
519
- # @!attribute [rw] description
520
- # The description displayed to end users on the AppStream 2.0 portal.
521
- # @return [String]
522
- #
523
- # @!attribute [rw] image_name
524
- # The image used by the fleet.
525
- # @return [String]
526
- #
527
- # @!attribute [rw] instance_type
528
- # The instance type of compute resources for the fleet. The fleet
529
- # instances are launched from this instance type.
530
- # @return [String]
531
- #
532
- # @!attribute [rw] compute_capacity_status
533
- # The capacity information for the fleet.
534
- # @return [Types::ComputeCapacityStatus]
535
- #
536
- # @!attribute [rw] max_user_duration_in_seconds
537
- # The maximum time during which a streaming session can run.
538
- # @return [Integer]
539
- #
540
- # @!attribute [rw] disconnect_timeout_in_seconds
541
- # The time after disconnection when a session is considered to have
542
- # ended. When a user reconnects after a disconnection, the user is
543
- # connected to the same session and instance within this time
544
- # interval.
545
- # @return [Integer]
546
- #
547
- # @!attribute [rw] state
548
- # The current state for the fleet.
549
- # @return [String]
550
- #
551
- # @!attribute [rw] vpc_config
552
- # The VPC configuration for the fleet.
553
- # @return [Types::VpcConfig]
554
- #
555
- # @!attribute [rw] created_time
556
- # The time at which the fleet was created.
557
- # @return [Time]
558
- #
559
- # @!attribute [rw] fleet_errors
560
- # The list of fleet errors is appended to this list.
561
- # @return [Array<Types::FleetError>]
562
- class Fleet < Struct.new(
563
- :arn,
564
- :name,
565
- :display_name,
566
- :description,
567
- :image_name,
568
- :instance_type,
569
- :compute_capacity_status,
570
- :max_user_duration_in_seconds,
571
- :disconnect_timeout_in_seconds,
572
- :state,
573
- :vpc_config,
574
- :created_time,
575
- :fleet_errors)
576
- include Aws::Structure
577
- end
578
-
579
- # The details of the fleet error.
580
- # @!attribute [rw] error_code
581
- # The error code for the fleet error.
582
- # @return [String]
583
- #
584
- # @!attribute [rw] error_message
585
- # The error message generated when the fleet has errors.
586
- # @return [String]
587
- class FleetError < Struct.new(
588
- :error_code,
589
- :error_message)
590
- include Aws::Structure
591
- end
592
-
593
- # New streaming instances are booted from images. The image stores the
594
- # application catalog and is connected to fleets.
595
- # @!attribute [rw] name
596
- # The unique identifier for the image.
597
- # @return [String]
598
- #
599
- # @!attribute [rw] arn
600
- # The ARN for the image.
601
- # @return [String]
602
- #
603
- # @!attribute [rw] base_image_arn
604
- # The source image ARN from which this image was created.
605
- # @return [String]
606
- #
607
- # @!attribute [rw] display_name
608
- # The display name for the image.
609
- # @return [String]
610
- #
611
- # @!attribute [rw] state
612
- # The image starts in the **PENDING** state, and then moves to
613
- # **AVAILABLE** if image creation succeeds and **FAILED** if image
614
- # creation has failed.
615
- # @return [String]
616
- #
617
- # @!attribute [rw] visibility
618
- # The visibility of an image to the user; images can be public or
619
- # private.
620
- # @return [String]
621
- #
622
- # @!attribute [rw] platform
623
- # The operating system platform of the image.
624
- # @return [String]
625
- #
626
- # @!attribute [rw] description
627
- # A meaningful description for the image.
628
- # @return [String]
629
- #
630
- # @!attribute [rw] state_change_reason
631
- # The reason why the last state change occurred.
632
- # @return [Types::ImageStateChangeReason]
633
- #
634
- # @!attribute [rw] applications
635
- # The applications associated with an image.
636
- # @return [Array<Types::Application>]
637
- #
638
- # @!attribute [rw] created_time
639
- # The timestamp when the image was created.
640
- # @return [Time]
641
- class Image < Struct.new(
642
- :name,
643
- :arn,
644
- :base_image_arn,
645
- :display_name,
646
- :state,
647
- :visibility,
648
- :platform,
649
- :description,
650
- :state_change_reason,
651
- :applications,
652
- :created_time)
653
- include Aws::Structure
654
- end
655
-
656
- # The reason why the last state change occurred.
657
- # @!attribute [rw] code
658
- # The state change reason code of the image.
659
- # @return [String]
660
- #
661
- # @!attribute [rw] message
662
- # The state change reason message to the end user.
663
- # @return [String]
664
- class ImageStateChangeReason < Struct.new(
665
- :code,
666
- :message)
667
- include Aws::Structure
668
- end
669
-
670
- # @note When making an API call, pass ListAssociatedFleetsRequest
671
- # data as a hash:
672
- #
673
- # {
674
- # stack_name: "String", # required
675
- # next_token: "String",
676
- # }
677
- # @!attribute [rw] stack_name
678
- # The name of the stack whose associated fleets are listed.
679
- # @return [String]
680
- #
681
- # @!attribute [rw] next_token
682
- # The pagination token to use to retrieve the next page of results for
683
- # this operation. If this value is null, it retrieves the first page.
684
- # @return [String]
685
- class ListAssociatedFleetsRequest < Struct.new(
686
- :stack_name,
687
- :next_token)
688
- include Aws::Structure
689
- end
690
-
691
- # The response from a successful operation.
692
- # @!attribute [rw] names
693
- # The names of associated fleets.
694
- # @return [Array<String>]
695
- #
696
- # @!attribute [rw] next_token
697
- # The pagination token to use to retrieve the next page of results for
698
- # this operation. If there are no more pages, this value is null.
699
- # @return [String]
700
- class ListAssociatedFleetsResult < Struct.new(
701
- :names,
702
- :next_token)
703
- include Aws::Structure
704
- end
705
-
706
- # @note When making an API call, pass ListAssociatedStacksRequest
707
- # data as a hash:
708
- #
709
- # {
710
- # fleet_name: "String", # required
711
- # next_token: "String",
712
- # }
713
- # @!attribute [rw] fleet_name
714
- # The name of the fleet whose associated stacks are listed.
715
- # @return [String]
716
- #
717
- # @!attribute [rw] next_token
718
- # The pagination token to use to retrieve the next page of results for
719
- # this operation. If this value is null, it retrieves the first page.
720
- # @return [String]
721
- class ListAssociatedStacksRequest < Struct.new(
722
- :fleet_name,
723
- :next_token)
724
- include Aws::Structure
725
- end
726
-
727
- # The response from a successful operation.
728
- # @!attribute [rw] names
729
- # The names of associated stacks.
730
- # @return [Array<String>]
731
- #
732
- # @!attribute [rw] next_token
733
- # The pagination token to use to retrieve the next page of results for
734
- # this operation. If there are no more pages, this value is null.
735
- # @return [String]
736
- class ListAssociatedStacksResult < Struct.new(
737
- :names,
738
- :next_token)
739
- include Aws::Structure
740
- end
741
-
742
- # Contains the parameters for a streaming session.
743
- # @!attribute [rw] id
744
- # The unique ID for a streaming session.
745
- # @return [String]
746
- #
747
- # @!attribute [rw] user_id
748
- # The identifier of the user for whom the session was created.
749
- # @return [String]
750
- #
751
- # @!attribute [rw] stack_name
752
- # The name of the stack for which the streaming session was created.
753
- # @return [String]
754
- #
755
- # @!attribute [rw] fleet_name
756
- # The name of the fleet for which the streaming session was created.
757
- # @return [String]
758
- #
759
- # @!attribute [rw] state
760
- # The current state of the streaming session.
761
- # @return [String]
762
- class Session < Struct.new(
763
- :id,
764
- :user_id,
765
- :stack_name,
766
- :fleet_name,
767
- :state)
768
- include Aws::Structure
769
- end
770
-
771
- # Details about a stack.
772
- # @!attribute [rw] arn
773
- # The ARN of the stack.
774
- # @return [String]
775
- #
776
- # @!attribute [rw] name
777
- # The unique identifier of the stack.
778
- # @return [String]
779
- #
780
- # @!attribute [rw] description
781
- # A meaningful description for the stack.
782
- # @return [String]
783
- #
784
- # @!attribute [rw] display_name
785
- # A display name for the stack.
786
- # @return [String]
787
- #
788
- # @!attribute [rw] created_time
789
- # The timestamp when the stack was created.
790
- # @return [Time]
791
- class Stack < Struct.new(
792
- :arn,
793
- :name,
794
- :description,
795
- :display_name,
796
- :created_time)
797
- include Aws::Structure
798
- end
799
-
800
- # @note When making an API call, pass StartFleetRequest
801
- # data as a hash:
802
- #
803
- # {
804
- # name: "String", # required
805
- # }
806
- # @!attribute [rw] name
807
- # The name of the fleet to start.
808
- # @return [String]
809
- class StartFleetRequest < Struct.new(
810
- :name)
811
- include Aws::Structure
812
- end
813
-
814
- class StartFleetResult < Aws::EmptyStructure; end
815
-
816
- # @note When making an API call, pass StopFleetRequest
817
- # data as a hash:
818
- #
819
- # {
820
- # name: "String", # required
821
- # }
822
- # @!attribute [rw] name
823
- # The name of the fleet to stop.
824
- # @return [String]
825
- class StopFleetRequest < Struct.new(
826
- :name)
827
- include Aws::Structure
828
- end
829
-
830
- class StopFleetResult < Aws::EmptyStructure; end
831
-
832
- # @note When making an API call, pass UpdateFleetRequest
833
- # data as a hash:
834
- #
835
- # {
836
- # image_name: "String",
837
- # name: "String", # required
838
- # instance_type: "String",
839
- # compute_capacity: {
840
- # desired_instances: 1, # required
841
- # },
842
- # vpc_config: {
843
- # subnet_ids: ["String"], # required
844
- # },
845
- # max_user_duration_in_seconds: 1,
846
- # disconnect_timeout_in_seconds: 1,
847
- # delete_vpc_config: false,
848
- # description: "Description",
849
- # display_name: "DisplayName",
850
- # }
851
- # @!attribute [rw] image_name
852
- # The image name from which a fleet is created.
853
- # @return [String]
854
- #
855
- # @!attribute [rw] name
856
- # The name of the fleet.
857
- # @return [String]
858
- #
859
- # @!attribute [rw] instance_type
860
- # The instance type of compute resources for the fleet. Fleet
861
- # instances are launched from this instance type.
862
- # @return [String]
863
- #
864
- # @!attribute [rw] compute_capacity
865
- # The parameters for the capacity allocated to the fleet.
866
- # @return [Types::ComputeCapacity]
867
- #
868
- # @!attribute [rw] vpc_config
869
- # The VPC configuration for the fleet.
870
- # @return [Types::VpcConfig]
871
- #
872
- # @!attribute [rw] max_user_duration_in_seconds
873
- # The maximum time during which a streaming session can run.
874
- # @return [Integer]
875
- #
876
- # @!attribute [rw] disconnect_timeout_in_seconds
877
- # The time after disconnection when a session is considered to have
878
- # ended. When the user reconnects after a disconnection, the user is
879
- # connected to the same instance within this time interval.
880
- # @return [Integer]
881
- #
882
- # @!attribute [rw] delete_vpc_config
883
- # Delete the VPC association for the specified fleet.
884
- # @return [Boolean]
885
- #
886
- # @!attribute [rw] description
887
- # The description displayed to end users on the AppStream 2.0 portal.
888
- # @return [String]
889
- #
890
- # @!attribute [rw] display_name
891
- # The name displayed to end users on the AppStream 2.0 portal.
892
- # @return [String]
893
- class UpdateFleetRequest < Struct.new(
894
- :image_name,
895
- :name,
896
- :instance_type,
897
- :compute_capacity,
898
- :vpc_config,
899
- :max_user_duration_in_seconds,
900
- :disconnect_timeout_in_seconds,
901
- :delete_vpc_config,
902
- :description,
903
- :display_name)
904
- include Aws::Structure
905
- end
906
-
907
- # @!attribute [rw] fleet
908
- # A list of fleet details.
909
- # @return [Types::Fleet]
910
- class UpdateFleetResult < Struct.new(
911
- :fleet)
912
- include Aws::Structure
913
- end
914
-
915
- # @note When making an API call, pass UpdateStackRequest
916
- # data as a hash:
917
- #
918
- # {
919
- # display_name: "DisplayName",
920
- # description: "Description",
921
- # name: "String", # required
922
- # }
923
- # @!attribute [rw] display_name
924
- # The name displayed to end users on the AppStream 2.0 portal.
925
- # @return [String]
926
- #
927
- # @!attribute [rw] description
928
- # The description displayed to end users on the AppStream 2.0 portal.
929
- # @return [String]
930
- #
931
- # @!attribute [rw] name
932
- # The name of the stack to update.
933
- # @return [String]
934
- class UpdateStackRequest < Struct.new(
935
- :display_name,
936
- :description,
937
- :name)
938
- include Aws::Structure
939
- end
940
-
941
- # @!attribute [rw] stack
942
- # A list of stack details.
943
- # @return [Types::Stack]
944
- class UpdateStackResult < Struct.new(
945
- :stack)
946
- include Aws::Structure
947
- end
948
-
949
- # The VPC in which the fleet is launched.
950
- # @note When making an API call, pass VpcConfig
951
- # data as a hash:
952
- #
953
- # {
954
- # subnet_ids: ["String"], # required
955
- # }
956
- # @!attribute [rw] subnet_ids
957
- # The list of subnets to which a network interface is established from
958
- # the fleet instance.
959
- # @return [Array<String>]
960
- class VpcConfig < Struct.new(
961
- :subnet_ids)
962
- include Aws::Structure
963
- end
8
+ module Aws::AppStream
9
+ module Types
964
10
 
11
+ # An entry for a single application in the application catalog.
12
+ #
13
+ # @!attribute [rw] name
14
+ # The unique identifier for the application.
15
+ # @return [String]
16
+ #
17
+ # @!attribute [rw] display_name
18
+ # The name of the application shown to the end users.
19
+ # @return [String]
20
+ #
21
+ # @!attribute [rw] icon_url
22
+ # The URL for the application icon. This URL may be time-limited.
23
+ # @return [String]
24
+ #
25
+ # @!attribute [rw] launch_path
26
+ # The path to the application executable in the instance.
27
+ # @return [String]
28
+ #
29
+ # @!attribute [rw] launch_parameters
30
+ # A list of arguments that are passed to the application at launch.
31
+ # @return [String]
32
+ #
33
+ # @!attribute [rw] enabled
34
+ # An application can be disabled after image creation if there is a
35
+ # problem.
36
+ # @return [Boolean]
37
+ #
38
+ # @!attribute [rw] metadata
39
+ # Additional attributes that describes the application.
40
+ # @return [Hash<String,String>]
41
+ #
42
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/Application AWS API Documentation
43
+ #
44
+ class Application < Struct.new(
45
+ :name,
46
+ :display_name,
47
+ :icon_url,
48
+ :launch_path,
49
+ :launch_parameters,
50
+ :enabled,
51
+ :metadata)
52
+ include Aws::Structure
965
53
  end
54
+
55
+ # @note When making an API call, you may pass AssociateFleetRequest
56
+ # data as a hash:
57
+ #
58
+ # {
59
+ # fleet_name: "String", # required
60
+ # stack_name: "String", # required
61
+ # }
62
+ #
63
+ # @!attribute [rw] fleet_name
64
+ # The name of the fleet to associate.
65
+ # @return [String]
66
+ #
67
+ # @!attribute [rw] stack_name
68
+ # The name of the stack to which the fleet is associated.
69
+ # @return [String]
70
+ #
71
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/AssociateFleetRequest AWS API Documentation
72
+ #
73
+ class AssociateFleetRequest < Struct.new(
74
+ :fleet_name,
75
+ :stack_name)
76
+ include Aws::Structure
77
+ end
78
+
79
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/AssociateFleetResult AWS API Documentation
80
+ #
81
+ class AssociateFleetResult < Aws::EmptyStructure; end
82
+
83
+ # The capacity configuration for the fleet.
84
+ #
85
+ # @note When making an API call, you may pass ComputeCapacity
86
+ # data as a hash:
87
+ #
88
+ # {
89
+ # desired_instances: 1, # required
90
+ # }
91
+ #
92
+ # @!attribute [rw] desired_instances
93
+ # The desired number of streaming instances.
94
+ # @return [Integer]
95
+ #
96
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/ComputeCapacity AWS API Documentation
97
+ #
98
+ class ComputeCapacity < Struct.new(
99
+ :desired_instances)
100
+ include Aws::Structure
101
+ end
102
+
103
+ # The capacity information for the fleet.
104
+ #
105
+ # @!attribute [rw] desired
106
+ # The desired number of streaming instances.
107
+ # @return [Integer]
108
+ #
109
+ # @!attribute [rw] running
110
+ # The total number of simultaneous streaming instances that are
111
+ # running.
112
+ # @return [Integer]
113
+ #
114
+ # @!attribute [rw] in_use
115
+ # The number of instances that are being used for streaming.
116
+ # @return [Integer]
117
+ #
118
+ # @!attribute [rw] available
119
+ # The number of currently available instances that can be used to
120
+ # stream sessions.
121
+ # @return [Integer]
122
+ #
123
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/ComputeCapacityStatus AWS API Documentation
124
+ #
125
+ class ComputeCapacityStatus < Struct.new(
126
+ :desired,
127
+ :running,
128
+ :in_use,
129
+ :available)
130
+ include Aws::Structure
131
+ end
132
+
133
+ # Contains the parameters for the new fleet to create.
134
+ #
135
+ # @note When making an API call, you may pass CreateFleetRequest
136
+ # data as a hash:
137
+ #
138
+ # {
139
+ # name: "Name", # required
140
+ # image_name: "String", # required
141
+ # instance_type: "String", # required
142
+ # compute_capacity: { # required
143
+ # desired_instances: 1, # required
144
+ # },
145
+ # vpc_config: {
146
+ # subnet_ids: ["String"], # required
147
+ # },
148
+ # max_user_duration_in_seconds: 1,
149
+ # disconnect_timeout_in_seconds: 1,
150
+ # description: "Description",
151
+ # display_name: "DisplayName",
152
+ # enable_default_internet_access: false,
153
+ # }
154
+ #
155
+ # @!attribute [rw] name
156
+ # A unique identifier for the fleet.
157
+ # @return [String]
158
+ #
159
+ # @!attribute [rw] image_name
160
+ # Unique name of the image used by the fleet.
161
+ # @return [String]
162
+ #
163
+ # @!attribute [rw] instance_type
164
+ # The instance type of compute resources for the fleet. Fleet
165
+ # instances are launched from this instance type.
166
+ # @return [String]
167
+ #
168
+ # @!attribute [rw] compute_capacity
169
+ # The parameters for the capacity allocated to the fleet.
170
+ # @return [Types::ComputeCapacity]
171
+ #
172
+ # @!attribute [rw] vpc_config
173
+ # The VPC configuration for the fleet.
174
+ # @return [Types::VpcConfig]
175
+ #
176
+ # @!attribute [rw] max_user_duration_in_seconds
177
+ # The maximum time up to which a streaming session can run.
178
+ # @return [Integer]
179
+ #
180
+ # @!attribute [rw] disconnect_timeout_in_seconds
181
+ # The time after disconnection when a session is considered to have
182
+ # ended. If a user who got disconnected reconnects within this timeout
183
+ # interval, the user is connected back to his/her previous session.
184
+ # @return [Integer]
185
+ #
186
+ # @!attribute [rw] description
187
+ # The description of the fleet.
188
+ # @return [String]
189
+ #
190
+ # @!attribute [rw] display_name
191
+ # The display name of the fleet.
192
+ # @return [String]
193
+ #
194
+ # @!attribute [rw] enable_default_internet_access
195
+ # Enable/Disable default Internet access from fleet.
196
+ # @return [Boolean]
197
+ #
198
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/CreateFleetRequest AWS API Documentation
199
+ #
200
+ class CreateFleetRequest < Struct.new(
201
+ :name,
202
+ :image_name,
203
+ :instance_type,
204
+ :compute_capacity,
205
+ :vpc_config,
206
+ :max_user_duration_in_seconds,
207
+ :disconnect_timeout_in_seconds,
208
+ :description,
209
+ :display_name,
210
+ :enable_default_internet_access)
211
+ include Aws::Structure
212
+ end
213
+
214
+ # @!attribute [rw] fleet
215
+ # The details for the created fleet.
216
+ # @return [Types::Fleet]
217
+ #
218
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/CreateFleetResult AWS API Documentation
219
+ #
220
+ class CreateFleetResult < Struct.new(
221
+ :fleet)
222
+ include Aws::Structure
223
+ end
224
+
225
+ # @note When making an API call, you may pass CreateStackRequest
226
+ # data as a hash:
227
+ #
228
+ # {
229
+ # name: "String", # required
230
+ # description: "Description",
231
+ # display_name: "DisplayName",
232
+ # }
233
+ #
234
+ # @!attribute [rw] name
235
+ # The unique identifier for this stack.
236
+ # @return [String]
237
+ #
238
+ # @!attribute [rw] description
239
+ # The description displayed to end users on the AppStream 2.0 portal.
240
+ # @return [String]
241
+ #
242
+ # @!attribute [rw] display_name
243
+ # The name displayed to end users on the AppStream 2.0 portal.
244
+ # @return [String]
245
+ #
246
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/CreateStackRequest AWS API Documentation
247
+ #
248
+ class CreateStackRequest < Struct.new(
249
+ :name,
250
+ :description,
251
+ :display_name)
252
+ include Aws::Structure
253
+ end
254
+
255
+ # @!attribute [rw] stack
256
+ # The details for the created stack.
257
+ # @return [Types::Stack]
258
+ #
259
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/CreateStackResult AWS API Documentation
260
+ #
261
+ class CreateStackResult < Struct.new(
262
+ :stack)
263
+ include Aws::Structure
264
+ end
265
+
266
+ # @note When making an API call, you may pass CreateStreamingURLRequest
267
+ # data as a hash:
268
+ #
269
+ # {
270
+ # stack_name: "String", # required
271
+ # fleet_name: "String", # required
272
+ # user_id: "UserId", # required
273
+ # application_id: "String",
274
+ # validity: 1,
275
+ # session_context: "String",
276
+ # }
277
+ #
278
+ # @!attribute [rw] stack_name
279
+ # The stack for which the URL is generated.
280
+ # @return [String]
281
+ #
282
+ # @!attribute [rw] fleet_name
283
+ # The fleet for which the URL is generated.
284
+ # @return [String]
285
+ #
286
+ # @!attribute [rw] user_id
287
+ # A unique user ID for whom the URL is generated.
288
+ # @return [String]
289
+ #
290
+ # @!attribute [rw] application_id
291
+ # The ID of the application that must be launched after the session
292
+ # starts.
293
+ # @return [String]
294
+ #
295
+ # @!attribute [rw] validity
296
+ # The validity duration of the URL in seconds. After this duration,
297
+ # the URL returned by this operation becomes invalid.
298
+ # @return [Integer]
299
+ #
300
+ # @!attribute [rw] session_context
301
+ # The sessionContext of the streaming URL.
302
+ # @return [String]
303
+ #
304
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/CreateStreamingURLRequest AWS API Documentation
305
+ #
306
+ class CreateStreamingURLRequest < Struct.new(
307
+ :stack_name,
308
+ :fleet_name,
309
+ :user_id,
310
+ :application_id,
311
+ :validity,
312
+ :session_context)
313
+ include Aws::Structure
314
+ end
315
+
316
+ # @!attribute [rw] streaming_url
317
+ # The URL to start the AppStream 2.0 streaming session.
318
+ # @return [String]
319
+ #
320
+ # @!attribute [rw] expires
321
+ # Elapsed seconds after the Unix epoch, at which time this URL
322
+ # expires.
323
+ # @return [Time]
324
+ #
325
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/CreateStreamingURLResult AWS API Documentation
326
+ #
327
+ class CreateStreamingURLResult < Struct.new(
328
+ :streaming_url,
329
+ :expires)
330
+ include Aws::Structure
331
+ end
332
+
333
+ # @note When making an API call, you may pass DeleteFleetRequest
334
+ # data as a hash:
335
+ #
336
+ # {
337
+ # name: "String", # required
338
+ # }
339
+ #
340
+ # @!attribute [rw] name
341
+ # The name of the fleet to be deleted.
342
+ # @return [String]
343
+ #
344
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DeleteFleetRequest AWS API Documentation
345
+ #
346
+ class DeleteFleetRequest < Struct.new(
347
+ :name)
348
+ include Aws::Structure
349
+ end
350
+
351
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DeleteFleetResult AWS API Documentation
352
+ #
353
+ class DeleteFleetResult < Aws::EmptyStructure; end
354
+
355
+ # @note When making an API call, you may pass DeleteStackRequest
356
+ # data as a hash:
357
+ #
358
+ # {
359
+ # name: "String", # required
360
+ # }
361
+ #
362
+ # @!attribute [rw] name
363
+ # The name of the stack to delete.
364
+ # @return [String]
365
+ #
366
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DeleteStackRequest AWS API Documentation
367
+ #
368
+ class DeleteStackRequest < Struct.new(
369
+ :name)
370
+ include Aws::Structure
371
+ end
372
+
373
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DeleteStackResult AWS API Documentation
374
+ #
375
+ class DeleteStackResult < Aws::EmptyStructure; end
376
+
377
+ # @note When making an API call, you may pass DescribeFleetsRequest
378
+ # data as a hash:
379
+ #
380
+ # {
381
+ # names: ["String"],
382
+ # next_token: "String",
383
+ # }
384
+ #
385
+ # @!attribute [rw] names
386
+ # The fleet names to describe. Use null to describe all the fleets for
387
+ # the AWS account.
388
+ # @return [Array<String>]
389
+ #
390
+ # @!attribute [rw] next_token
391
+ # The pagination token to use to retrieve the next page of results for
392
+ # this operation. If this value is null, it retrieves the first page.
393
+ # @return [String]
394
+ #
395
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeFleetsRequest AWS API Documentation
396
+ #
397
+ class DescribeFleetsRequest < Struct.new(
398
+ :names,
399
+ :next_token)
400
+ include Aws::Structure
401
+ end
402
+
403
+ # @!attribute [rw] fleets
404
+ # The list of fleet details.
405
+ # @return [Array<Types::Fleet>]
406
+ #
407
+ # @!attribute [rw] next_token
408
+ # The pagination token to use to retrieve the next page of results for
409
+ # this operation. If there are no more pages, this value is null.
410
+ # @return [String]
411
+ #
412
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeFleetsResult AWS API Documentation
413
+ #
414
+ class DescribeFleetsResult < Struct.new(
415
+ :fleets,
416
+ :next_token)
417
+ include Aws::Structure
418
+ end
419
+
420
+ # @note When making an API call, you may pass DescribeImagesRequest
421
+ # data as a hash:
422
+ #
423
+ # {
424
+ # names: ["String"],
425
+ # }
426
+ #
427
+ # @!attribute [rw] names
428
+ # A specific list of images to describe.
429
+ # @return [Array<String>]
430
+ #
431
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeImagesRequest AWS API Documentation
432
+ #
433
+ class DescribeImagesRequest < Struct.new(
434
+ :names)
435
+ include Aws::Structure
436
+ end
437
+
438
+ # @!attribute [rw] images
439
+ # The list of images.
440
+ # @return [Array<Types::Image>]
441
+ #
442
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeImagesResult AWS API Documentation
443
+ #
444
+ class DescribeImagesResult < Struct.new(
445
+ :images)
446
+ include Aws::Structure
447
+ end
448
+
449
+ # @note When making an API call, you may pass DescribeSessionsRequest
450
+ # data as a hash:
451
+ #
452
+ # {
453
+ # stack_name: "String", # required
454
+ # fleet_name: "String", # required
455
+ # user_id: "UserId",
456
+ # next_token: "String",
457
+ # limit: 1,
458
+ # authentication_type: "API", # accepts API, SAML
459
+ # }
460
+ #
461
+ # @!attribute [rw] stack_name
462
+ # The name of the stack for which to list sessions.
463
+ # @return [String]
464
+ #
465
+ # @!attribute [rw] fleet_name
466
+ # The name of the fleet for which to list sessions.
467
+ # @return [String]
468
+ #
469
+ # @!attribute [rw] user_id
470
+ # The user for whom to list sessions. Use null to describe all the
471
+ # sessions for the stack and fleet.
472
+ # @return [String]
473
+ #
474
+ # @!attribute [rw] next_token
475
+ # The pagination token to use to retrieve the next page of results for
476
+ # this operation. If this value is null, it retrieves the first page.
477
+ # @return [String]
478
+ #
479
+ # @!attribute [rw] limit
480
+ # The size of each page of results. The default value is 20 and the
481
+ # maximum supported value is 50.
482
+ # @return [Integer]
483
+ #
484
+ # @!attribute [rw] authentication_type
485
+ # The authentication method of the user. It can be `API` for a user
486
+ # authenticated using a streaming url or `SAML` for a SAML federated
487
+ # user. If an authentication type is not provided, the operation
488
+ # defaults to users authenticated using a streaming url.
489
+ # @return [String]
490
+ #
491
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeSessionsRequest AWS API Documentation
492
+ #
493
+ class DescribeSessionsRequest < Struct.new(
494
+ :stack_name,
495
+ :fleet_name,
496
+ :user_id,
497
+ :next_token,
498
+ :limit,
499
+ :authentication_type)
500
+ include Aws::Structure
501
+ end
502
+
503
+ # @!attribute [rw] sessions
504
+ # The list of streaming sessions.
505
+ # @return [Array<Types::Session>]
506
+ #
507
+ # @!attribute [rw] next_token
508
+ # The pagination token to use to retrieve the next page of results for
509
+ # this operation. If there are no more pages, this value is null.
510
+ # @return [String]
511
+ #
512
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeSessionsResult AWS API Documentation
513
+ #
514
+ class DescribeSessionsResult < Struct.new(
515
+ :sessions,
516
+ :next_token)
517
+ include Aws::Structure
518
+ end
519
+
520
+ # @note When making an API call, you may pass DescribeStacksRequest
521
+ # data as a hash:
522
+ #
523
+ # {
524
+ # names: ["String"],
525
+ # next_token: "String",
526
+ # }
527
+ #
528
+ # @!attribute [rw] names
529
+ # The stack names to describe. Use null to describe all the stacks for
530
+ # the AWS account.
531
+ # @return [Array<String>]
532
+ #
533
+ # @!attribute [rw] next_token
534
+ # The pagination token to use to retrieve the next page of results for
535
+ # this operation. If this value is null, it retrieves the first page.
536
+ # @return [String]
537
+ #
538
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeStacksRequest AWS API Documentation
539
+ #
540
+ class DescribeStacksRequest < Struct.new(
541
+ :names,
542
+ :next_token)
543
+ include Aws::Structure
544
+ end
545
+
546
+ # @!attribute [rw] stacks
547
+ # The list of stack details.
548
+ # @return [Array<Types::Stack>]
549
+ #
550
+ # @!attribute [rw] next_token
551
+ # The pagination token to use to retrieve the next page of results for
552
+ # this operation. If there are no more pages, this value is null.
553
+ # @return [String]
554
+ #
555
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DescribeStacksResult AWS API Documentation
556
+ #
557
+ class DescribeStacksResult < Struct.new(
558
+ :stacks,
559
+ :next_token)
560
+ include Aws::Structure
561
+ end
562
+
563
+ # @note When making an API call, you may pass DisassociateFleetRequest
564
+ # data as a hash:
565
+ #
566
+ # {
567
+ # fleet_name: "String", # required
568
+ # stack_name: "String", # required
569
+ # }
570
+ #
571
+ # @!attribute [rw] fleet_name
572
+ # The name of the fleet to disassociate.
573
+ # @return [String]
574
+ #
575
+ # @!attribute [rw] stack_name
576
+ # The name of the stack with which the fleet is associated.
577
+ # @return [String]
578
+ #
579
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DisassociateFleetRequest AWS API Documentation
580
+ #
581
+ class DisassociateFleetRequest < Struct.new(
582
+ :fleet_name,
583
+ :stack_name)
584
+ include Aws::Structure
585
+ end
586
+
587
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/DisassociateFleetResult AWS API Documentation
588
+ #
589
+ class DisassociateFleetResult < Aws::EmptyStructure; end
590
+
591
+ # @note When making an API call, you may pass ExpireSessionRequest
592
+ # data as a hash:
593
+ #
594
+ # {
595
+ # session_id: "String", # required
596
+ # }
597
+ #
598
+ # @!attribute [rw] session_id
599
+ # The unique identifier of the streaming session to be stopped.
600
+ # @return [String]
601
+ #
602
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/ExpireSessionRequest AWS API Documentation
603
+ #
604
+ class ExpireSessionRequest < Struct.new(
605
+ :session_id)
606
+ include Aws::Structure
607
+ end
608
+
609
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/ExpireSessionResult AWS API Documentation
610
+ #
611
+ class ExpireSessionResult < Aws::EmptyStructure; end
612
+
613
+ # Contains the parameters for a fleet.
614
+ #
615
+ # @!attribute [rw] arn
616
+ # The ARN for the fleet.
617
+ # @return [String]
618
+ #
619
+ # @!attribute [rw] name
620
+ # The name of the fleet.
621
+ # @return [String]
622
+ #
623
+ # @!attribute [rw] display_name
624
+ # The name displayed to end users on the AppStream 2.0 portal.
625
+ # @return [String]
626
+ #
627
+ # @!attribute [rw] description
628
+ # The description displayed to end users on the AppStream 2.0 portal.
629
+ # @return [String]
630
+ #
631
+ # @!attribute [rw] image_name
632
+ # The image used by the fleet.
633
+ # @return [String]
634
+ #
635
+ # @!attribute [rw] instance_type
636
+ # The instance type of compute resources for the fleet. The fleet
637
+ # instances are launched from this instance type.
638
+ # @return [String]
639
+ #
640
+ # @!attribute [rw] compute_capacity_status
641
+ # The capacity information for the fleet.
642
+ # @return [Types::ComputeCapacityStatus]
643
+ #
644
+ # @!attribute [rw] max_user_duration_in_seconds
645
+ # The maximum time during which a streaming session can run.
646
+ # @return [Integer]
647
+ #
648
+ # @!attribute [rw] disconnect_timeout_in_seconds
649
+ # The time after disconnection when a session is considered to have
650
+ # ended. When a user reconnects after a disconnection, the user is
651
+ # connected to the same session and instance within this time
652
+ # interval.
653
+ # @return [Integer]
654
+ #
655
+ # @!attribute [rw] state
656
+ # The current state for the fleet.
657
+ # @return [String]
658
+ #
659
+ # @!attribute [rw] vpc_config
660
+ # The VPC configuration for the fleet.
661
+ # @return [Types::VpcConfig]
662
+ #
663
+ # @!attribute [rw] created_time
664
+ # The time at which the fleet was created.
665
+ # @return [Time]
666
+ #
667
+ # @!attribute [rw] fleet_errors
668
+ # The list of fleet errors is appended to this list.
669
+ # @return [Array<Types::FleetError>]
670
+ #
671
+ # @!attribute [rw] enable_default_internet_access
672
+ # Default Internet access from the fleet. True (Enabled), False
673
+ # (Disabled).
674
+ # @return [Boolean]
675
+ #
676
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/Fleet AWS API Documentation
677
+ #
678
+ class Fleet < Struct.new(
679
+ :arn,
680
+ :name,
681
+ :display_name,
682
+ :description,
683
+ :image_name,
684
+ :instance_type,
685
+ :compute_capacity_status,
686
+ :max_user_duration_in_seconds,
687
+ :disconnect_timeout_in_seconds,
688
+ :state,
689
+ :vpc_config,
690
+ :created_time,
691
+ :fleet_errors,
692
+ :enable_default_internet_access)
693
+ include Aws::Structure
694
+ end
695
+
696
+ # The details of the fleet error.
697
+ #
698
+ # @!attribute [rw] error_code
699
+ # The error code for the fleet error.
700
+ # @return [String]
701
+ #
702
+ # @!attribute [rw] error_message
703
+ # The error message generated when the fleet has errors.
704
+ # @return [String]
705
+ #
706
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/FleetError AWS API Documentation
707
+ #
708
+ class FleetError < Struct.new(
709
+ :error_code,
710
+ :error_message)
711
+ include Aws::Structure
712
+ end
713
+
714
+ # New streaming instances are booted from images. The image stores the
715
+ # application catalog and is connected to fleets.
716
+ #
717
+ # @!attribute [rw] name
718
+ # The unique identifier for the image.
719
+ # @return [String]
720
+ #
721
+ # @!attribute [rw] arn
722
+ # The ARN for the image.
723
+ # @return [String]
724
+ #
725
+ # @!attribute [rw] base_image_arn
726
+ # The source image ARN from which this image was created.
727
+ # @return [String]
728
+ #
729
+ # @!attribute [rw] display_name
730
+ # The display name for the image.
731
+ # @return [String]
732
+ #
733
+ # @!attribute [rw] state
734
+ # The image starts in the **PENDING** state, and then moves to
735
+ # **AVAILABLE** if image creation succeeds and **FAILED** if image
736
+ # creation has failed.
737
+ # @return [String]
738
+ #
739
+ # @!attribute [rw] visibility
740
+ # The visibility of an image to the user; images can be public or
741
+ # private.
742
+ # @return [String]
743
+ #
744
+ # @!attribute [rw] image_builder_supported
745
+ # Indicates whether an image builder can be launched from this image.
746
+ # @return [Boolean]
747
+ #
748
+ # @!attribute [rw] platform
749
+ # The operating system platform of the image.
750
+ # @return [String]
751
+ #
752
+ # @!attribute [rw] description
753
+ # A meaningful description for the image.
754
+ # @return [String]
755
+ #
756
+ # @!attribute [rw] state_change_reason
757
+ # The reason why the last state change occurred.
758
+ # @return [Types::ImageStateChangeReason]
759
+ #
760
+ # @!attribute [rw] applications
761
+ # The applications associated with an image.
762
+ # @return [Array<Types::Application>]
763
+ #
764
+ # @!attribute [rw] created_time
765
+ # The timestamp when the image was created.
766
+ # @return [Time]
767
+ #
768
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/Image AWS API Documentation
769
+ #
770
+ class Image < Struct.new(
771
+ :name,
772
+ :arn,
773
+ :base_image_arn,
774
+ :display_name,
775
+ :state,
776
+ :visibility,
777
+ :image_builder_supported,
778
+ :platform,
779
+ :description,
780
+ :state_change_reason,
781
+ :applications,
782
+ :created_time)
783
+ include Aws::Structure
784
+ end
785
+
786
+ # The reason why the last state change occurred.
787
+ #
788
+ # @!attribute [rw] code
789
+ # The state change reason code of the image.
790
+ # @return [String]
791
+ #
792
+ # @!attribute [rw] message
793
+ # The state change reason message to the end user.
794
+ # @return [String]
795
+ #
796
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/ImageStateChangeReason AWS API Documentation
797
+ #
798
+ class ImageStateChangeReason < Struct.new(
799
+ :code,
800
+ :message)
801
+ include Aws::Structure
802
+ end
803
+
804
+ # @note When making an API call, you may pass ListAssociatedFleetsRequest
805
+ # data as a hash:
806
+ #
807
+ # {
808
+ # stack_name: "String", # required
809
+ # next_token: "String",
810
+ # }
811
+ #
812
+ # @!attribute [rw] stack_name
813
+ # The name of the stack whose associated fleets are listed.
814
+ # @return [String]
815
+ #
816
+ # @!attribute [rw] next_token
817
+ # The pagination token to use to retrieve the next page of results for
818
+ # this operation. If this value is null, it retrieves the first page.
819
+ # @return [String]
820
+ #
821
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/ListAssociatedFleetsRequest AWS API Documentation
822
+ #
823
+ class ListAssociatedFleetsRequest < Struct.new(
824
+ :stack_name,
825
+ :next_token)
826
+ include Aws::Structure
827
+ end
828
+
829
+ # The response from a successful operation.
830
+ #
831
+ # @!attribute [rw] names
832
+ # The names of associated fleets.
833
+ # @return [Array<String>]
834
+ #
835
+ # @!attribute [rw] next_token
836
+ # The pagination token to use to retrieve the next page of results for
837
+ # this operation. If there are no more pages, this value is null.
838
+ # @return [String]
839
+ #
840
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/ListAssociatedFleetsResult AWS API Documentation
841
+ #
842
+ class ListAssociatedFleetsResult < Struct.new(
843
+ :names,
844
+ :next_token)
845
+ include Aws::Structure
846
+ end
847
+
848
+ # @note When making an API call, you may pass ListAssociatedStacksRequest
849
+ # data as a hash:
850
+ #
851
+ # {
852
+ # fleet_name: "String", # required
853
+ # next_token: "String",
854
+ # }
855
+ #
856
+ # @!attribute [rw] fleet_name
857
+ # The name of the fleet whose associated stacks are listed.
858
+ # @return [String]
859
+ #
860
+ # @!attribute [rw] next_token
861
+ # The pagination token to use to retrieve the next page of results for
862
+ # this operation. If this value is null, it retrieves the first page.
863
+ # @return [String]
864
+ #
865
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/ListAssociatedStacksRequest AWS API Documentation
866
+ #
867
+ class ListAssociatedStacksRequest < Struct.new(
868
+ :fleet_name,
869
+ :next_token)
870
+ include Aws::Structure
871
+ end
872
+
873
+ # The response from a successful operation.
874
+ #
875
+ # @!attribute [rw] names
876
+ # The names of associated stacks.
877
+ # @return [Array<String>]
878
+ #
879
+ # @!attribute [rw] next_token
880
+ # The pagination token to use to retrieve the next page of results for
881
+ # this operation. If there are no more pages, this value is null.
882
+ # @return [String]
883
+ #
884
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/ListAssociatedStacksResult AWS API Documentation
885
+ #
886
+ class ListAssociatedStacksResult < Struct.new(
887
+ :names,
888
+ :next_token)
889
+ include Aws::Structure
890
+ end
891
+
892
+ # Contains the parameters for a streaming session.
893
+ #
894
+ # @!attribute [rw] id
895
+ # The unique ID for a streaming session.
896
+ # @return [String]
897
+ #
898
+ # @!attribute [rw] user_id
899
+ # The identifier of the user for whom the session was created.
900
+ # @return [String]
901
+ #
902
+ # @!attribute [rw] stack_name
903
+ # The name of the stack for which the streaming session was created.
904
+ # @return [String]
905
+ #
906
+ # @!attribute [rw] fleet_name
907
+ # The name of the fleet for which the streaming session was created.
908
+ # @return [String]
909
+ #
910
+ # @!attribute [rw] state
911
+ # The current state of the streaming session.
912
+ # @return [String]
913
+ #
914
+ # @!attribute [rw] authentication_type
915
+ # The authentication method of the user for whom the session was
916
+ # created. It can be `API` for a user authenticated using a streaming
917
+ # url or `SAML` for a SAML federated user.
918
+ # @return [String]
919
+ #
920
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/Session AWS API Documentation
921
+ #
922
+ class Session < Struct.new(
923
+ :id,
924
+ :user_id,
925
+ :stack_name,
926
+ :fleet_name,
927
+ :state,
928
+ :authentication_type)
929
+ include Aws::Structure
930
+ end
931
+
932
+ # Details about a stack.
933
+ #
934
+ # @!attribute [rw] arn
935
+ # The ARN of the stack.
936
+ # @return [String]
937
+ #
938
+ # @!attribute [rw] name
939
+ # The unique identifier of the stack.
940
+ # @return [String]
941
+ #
942
+ # @!attribute [rw] description
943
+ # A meaningful description for the stack.
944
+ # @return [String]
945
+ #
946
+ # @!attribute [rw] display_name
947
+ # A display name for the stack.
948
+ # @return [String]
949
+ #
950
+ # @!attribute [rw] created_time
951
+ # The timestamp when the stack was created.
952
+ # @return [Time]
953
+ #
954
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/Stack AWS API Documentation
955
+ #
956
+ class Stack < Struct.new(
957
+ :arn,
958
+ :name,
959
+ :description,
960
+ :display_name,
961
+ :created_time)
962
+ include Aws::Structure
963
+ end
964
+
965
+ # @note When making an API call, you may pass StartFleetRequest
966
+ # data as a hash:
967
+ #
968
+ # {
969
+ # name: "String", # required
970
+ # }
971
+ #
972
+ # @!attribute [rw] name
973
+ # The name of the fleet to start.
974
+ # @return [String]
975
+ #
976
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/StartFleetRequest AWS API Documentation
977
+ #
978
+ class StartFleetRequest < Struct.new(
979
+ :name)
980
+ include Aws::Structure
981
+ end
982
+
983
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/StartFleetResult AWS API Documentation
984
+ #
985
+ class StartFleetResult < Aws::EmptyStructure; end
986
+
987
+ # @note When making an API call, you may pass StopFleetRequest
988
+ # data as a hash:
989
+ #
990
+ # {
991
+ # name: "String", # required
992
+ # }
993
+ #
994
+ # @!attribute [rw] name
995
+ # The name of the fleet to stop.
996
+ # @return [String]
997
+ #
998
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/StopFleetRequest AWS API Documentation
999
+ #
1000
+ class StopFleetRequest < Struct.new(
1001
+ :name)
1002
+ include Aws::Structure
1003
+ end
1004
+
1005
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/StopFleetResult AWS API Documentation
1006
+ #
1007
+ class StopFleetResult < Aws::EmptyStructure; end
1008
+
1009
+ # @note When making an API call, you may pass UpdateFleetRequest
1010
+ # data as a hash:
1011
+ #
1012
+ # {
1013
+ # image_name: "String",
1014
+ # name: "String", # required
1015
+ # instance_type: "String",
1016
+ # compute_capacity: {
1017
+ # desired_instances: 1, # required
1018
+ # },
1019
+ # vpc_config: {
1020
+ # subnet_ids: ["String"], # required
1021
+ # },
1022
+ # max_user_duration_in_seconds: 1,
1023
+ # disconnect_timeout_in_seconds: 1,
1024
+ # delete_vpc_config: false,
1025
+ # description: "Description",
1026
+ # display_name: "DisplayName",
1027
+ # enable_default_internet_access: false,
1028
+ # }
1029
+ #
1030
+ # @!attribute [rw] image_name
1031
+ # The image name from which a fleet is created.
1032
+ # @return [String]
1033
+ #
1034
+ # @!attribute [rw] name
1035
+ # The name of the fleet.
1036
+ # @return [String]
1037
+ #
1038
+ # @!attribute [rw] instance_type
1039
+ # The instance type of compute resources for the fleet. Fleet
1040
+ # instances are launched from this instance type.
1041
+ # @return [String]
1042
+ #
1043
+ # @!attribute [rw] compute_capacity
1044
+ # The parameters for the capacity allocated to the fleet.
1045
+ # @return [Types::ComputeCapacity]
1046
+ #
1047
+ # @!attribute [rw] vpc_config
1048
+ # The VPC configuration for the fleet.
1049
+ # @return [Types::VpcConfig]
1050
+ #
1051
+ # @!attribute [rw] max_user_duration_in_seconds
1052
+ # The maximum time during which a streaming session can run.
1053
+ # @return [Integer]
1054
+ #
1055
+ # @!attribute [rw] disconnect_timeout_in_seconds
1056
+ # The time after disconnection when a session is considered to have
1057
+ # ended. When the user reconnects after a disconnection, the user is
1058
+ # connected to the same instance within this time interval.
1059
+ # @return [Integer]
1060
+ #
1061
+ # @!attribute [rw] delete_vpc_config
1062
+ # Delete the VPC association for the specified fleet.
1063
+ # @return [Boolean]
1064
+ #
1065
+ # @!attribute [rw] description
1066
+ # The description displayed to end users on the AppStream 2.0 portal.
1067
+ # @return [String]
1068
+ #
1069
+ # @!attribute [rw] display_name
1070
+ # The name displayed to end users on the AppStream 2.0 portal.
1071
+ # @return [String]
1072
+ #
1073
+ # @!attribute [rw] enable_default_internet_access
1074
+ # Enable/Disable default Internet access from fleet.
1075
+ # @return [Boolean]
1076
+ #
1077
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/UpdateFleetRequest AWS API Documentation
1078
+ #
1079
+ class UpdateFleetRequest < Struct.new(
1080
+ :image_name,
1081
+ :name,
1082
+ :instance_type,
1083
+ :compute_capacity,
1084
+ :vpc_config,
1085
+ :max_user_duration_in_seconds,
1086
+ :disconnect_timeout_in_seconds,
1087
+ :delete_vpc_config,
1088
+ :description,
1089
+ :display_name,
1090
+ :enable_default_internet_access)
1091
+ include Aws::Structure
1092
+ end
1093
+
1094
+ # @!attribute [rw] fleet
1095
+ # A list of fleet details.
1096
+ # @return [Types::Fleet]
1097
+ #
1098
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/UpdateFleetResult AWS API Documentation
1099
+ #
1100
+ class UpdateFleetResult < Struct.new(
1101
+ :fleet)
1102
+ include Aws::Structure
1103
+ end
1104
+
1105
+ # @note When making an API call, you may pass UpdateStackRequest
1106
+ # data as a hash:
1107
+ #
1108
+ # {
1109
+ # display_name: "DisplayName",
1110
+ # description: "Description",
1111
+ # name: "String", # required
1112
+ # }
1113
+ #
1114
+ # @!attribute [rw] display_name
1115
+ # The name displayed to end users on the AppStream 2.0 portal.
1116
+ # @return [String]
1117
+ #
1118
+ # @!attribute [rw] description
1119
+ # The description displayed to end users on the AppStream 2.0 portal.
1120
+ # @return [String]
1121
+ #
1122
+ # @!attribute [rw] name
1123
+ # The name of the stack to update.
1124
+ # @return [String]
1125
+ #
1126
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/UpdateStackRequest AWS API Documentation
1127
+ #
1128
+ class UpdateStackRequest < Struct.new(
1129
+ :display_name,
1130
+ :description,
1131
+ :name)
1132
+ include Aws::Structure
1133
+ end
1134
+
1135
+ # @!attribute [rw] stack
1136
+ # A list of stack details.
1137
+ # @return [Types::Stack]
1138
+ #
1139
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/UpdateStackResult AWS API Documentation
1140
+ #
1141
+ class UpdateStackResult < Struct.new(
1142
+ :stack)
1143
+ include Aws::Structure
1144
+ end
1145
+
1146
+ # VPC configuration information.
1147
+ #
1148
+ # @note When making an API call, you may pass VpcConfig
1149
+ # data as a hash:
1150
+ #
1151
+ # {
1152
+ # subnet_ids: ["String"], # required
1153
+ # }
1154
+ #
1155
+ # @!attribute [rw] subnet_ids
1156
+ # The list of subnets to which a network interface is established from
1157
+ # the fleet instance.
1158
+ # @return [Array<String>]
1159
+ #
1160
+ # @see http://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/VpcConfig AWS API Documentation
1161
+ #
1162
+ class VpcConfig < Struct.new(
1163
+ :subnet_ids)
1164
+ include Aws::Structure
1165
+ end
1166
+
966
1167
  end
967
1168
  end