aws-sdk-appstream 1.0.0.rc2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/aws-sdk-appstream.rb +48 -0
- data/lib/aws-sdk-appstream/client.rb +891 -0
- data/lib/aws-sdk-appstream/client_api.rb +522 -0
- data/lib/aws-sdk-appstream/customizations.rb +0 -0
- data/lib/aws-sdk-appstream/errors.rb +23 -0
- data/lib/aws-sdk-appstream/resource.rb +25 -0
- data/lib/aws-sdk-appstream/types.rb +967 -0
- data/lib/aws-sdk-appstream/waiters.rb +114 -0
- metadata +81 -0
File without changes
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module AppStream
|
10
|
+
module Errors
|
11
|
+
|
12
|
+
extend Aws::Errors::DynamicErrors
|
13
|
+
|
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
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module AppStream
|
10
|
+
class Resource
|
11
|
+
|
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
|
22
|
+
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
@@ -0,0 +1,967 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
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
|
964
|
+
|
965
|
+
end
|
966
|
+
end
|
967
|
+
end
|