aws-sdk-gameliftstreams 1.0.0
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.
- checksums.yaml +7 -0
- data/CHANGELOG.md +8 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-gameliftstreams/client.rb +2617 -0
- data/lib/aws-sdk-gameliftstreams/client_api.rb +904 -0
- data/lib/aws-sdk-gameliftstreams/customizations.rb +0 -0
- data/lib/aws-sdk-gameliftstreams/endpoint_parameters.rb +59 -0
- data/lib/aws-sdk-gameliftstreams/endpoint_provider.rb +32 -0
- data/lib/aws-sdk-gameliftstreams/endpoints.rb +20 -0
- data/lib/aws-sdk-gameliftstreams/errors.rb +162 -0
- data/lib/aws-sdk-gameliftstreams/plugins/endpoints.rb +77 -0
- data/lib/aws-sdk-gameliftstreams/resource.rb +26 -0
- data/lib/aws-sdk-gameliftstreams/types.rb +3334 -0
- data/lib/aws-sdk-gameliftstreams/waiters.rb +299 -0
- data/lib/aws-sdk-gameliftstreams.rb +62 -0
- data/sig/client.rbs +511 -0
- data/sig/errors.rbs +37 -0
- data/sig/resource.rbs +84 -0
- data/sig/types.rbs +503 -0
- data/sig/waiters.rbs +64 -0
- metadata +100 -0
@@ -0,0 +1,3334 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::GameLiftStreams
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# You don't have the required permissions to access this Amazon
|
14
|
+
# GameLift Streams resource. Correct the permissions before you try
|
15
|
+
# again.
|
16
|
+
#
|
17
|
+
# @!attribute [rw] message
|
18
|
+
# Description of the error.
|
19
|
+
# @return [String]
|
20
|
+
#
|
21
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/AccessDeniedException AWS API Documentation
|
22
|
+
#
|
23
|
+
class AccessDeniedException < Struct.new(
|
24
|
+
:message)
|
25
|
+
SENSITIVE = []
|
26
|
+
include Aws::Structure
|
27
|
+
end
|
28
|
+
|
29
|
+
# @!attribute [rw] identifier
|
30
|
+
# A stream group to add the specified locations to.
|
31
|
+
#
|
32
|
+
# This value is a Amazon Resource Name (ARN) that uniquely identifies
|
33
|
+
# the stream group resource. Format example: `1AB2C3De4`.
|
34
|
+
# @return [String]
|
35
|
+
#
|
36
|
+
# @!attribute [rw] location_configurations
|
37
|
+
# A set of one or more locations and the streaming capacity for each
|
38
|
+
# location.
|
39
|
+
# @return [Array<Types::LocationConfiguration>]
|
40
|
+
#
|
41
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/AddStreamGroupLocationsInput AWS API Documentation
|
42
|
+
#
|
43
|
+
class AddStreamGroupLocationsInput < Struct.new(
|
44
|
+
:identifier,
|
45
|
+
:location_configurations)
|
46
|
+
SENSITIVE = []
|
47
|
+
include Aws::Structure
|
48
|
+
end
|
49
|
+
|
50
|
+
# @!attribute [rw] identifier
|
51
|
+
# This value is the Amazon Resource Name (ARN) that uniquely
|
52
|
+
# identifies the stream group resource. Format example: `1AB2C3De4`.
|
53
|
+
# @return [String]
|
54
|
+
#
|
55
|
+
# @!attribute [rw] locations
|
56
|
+
# This value is set of locations, including their name, current
|
57
|
+
# status, and capacities.
|
58
|
+
#
|
59
|
+
# A location can be in one of the following states:
|
60
|
+
#
|
61
|
+
# * **ACTIVATING**: Amazon GameLift Streams is preparing the location.
|
62
|
+
# You cannot stream from, scale the capacity of, or remove this
|
63
|
+
# location yet.
|
64
|
+
#
|
65
|
+
# * **ACTIVE**: The location is provisioned with initial capacity. You
|
66
|
+
# can now stream from, scale the capacity of, or remove this
|
67
|
+
# location.
|
68
|
+
#
|
69
|
+
# * **ERROR**: Amazon GameLift Streams failed to set up this location.
|
70
|
+
# The StatusReason field describes the error. You can remove this
|
71
|
+
# location and try to add it again.
|
72
|
+
#
|
73
|
+
# * **REMOVING**: Amazon GameLift Streams is working to remove this
|
74
|
+
# location. It releases all provisioned capacity for this location
|
75
|
+
# in this stream group.
|
76
|
+
# @return [Array<Types::LocationState>]
|
77
|
+
#
|
78
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/AddStreamGroupLocationsOutput AWS API Documentation
|
79
|
+
#
|
80
|
+
class AddStreamGroupLocationsOutput < Struct.new(
|
81
|
+
:identifier,
|
82
|
+
:locations)
|
83
|
+
SENSITIVE = []
|
84
|
+
include Aws::Structure
|
85
|
+
end
|
86
|
+
|
87
|
+
# Describes an application resource that represents a collection of
|
88
|
+
# content for streaming with Amazon GameLift Streams. To retrieve
|
89
|
+
# additional application details, call GetApplication.
|
90
|
+
#
|
91
|
+
# @!attribute [rw] arn
|
92
|
+
# An Amazon Resource Name (ARN) that's assigned to an application
|
93
|
+
# resource and uniquely identifies the application across all Amazon
|
94
|
+
# Web Services Regions. Format is `arn:aws:gameliftstreams:[AWS
|
95
|
+
# Region]:[AWS account]:application/[resource ID]`.
|
96
|
+
# @return [String]
|
97
|
+
#
|
98
|
+
# @!attribute [rw] created_at
|
99
|
+
# A timestamp that indicates when this resource was created.
|
100
|
+
# Timestamps are expressed using in ISO8601 format, such as:
|
101
|
+
# `2022-12-27T22:29:40+00:00` (UTC).
|
102
|
+
# @return [Time]
|
103
|
+
#
|
104
|
+
# @!attribute [rw] description
|
105
|
+
# A human-readable label for the application. You can edit this value.
|
106
|
+
# @return [String]
|
107
|
+
#
|
108
|
+
# @!attribute [rw] id
|
109
|
+
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies
|
110
|
+
# the application resource. Format example:
|
111
|
+
# ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6`
|
112
|
+
# or ID-`9ZY8X7Wv6`.
|
113
|
+
#
|
114
|
+
#
|
115
|
+
#
|
116
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
117
|
+
# @return [String]
|
118
|
+
#
|
119
|
+
# @!attribute [rw] last_updated_at
|
120
|
+
# A timestamp that indicates when this resource was last updated.
|
121
|
+
# Timestamps are expressed using in ISO8601 format, such as:
|
122
|
+
# `2022-12-27T22:29:40+00:00` (UTC).
|
123
|
+
# @return [Time]
|
124
|
+
#
|
125
|
+
# @!attribute [rw] runtime_environment
|
126
|
+
# A set of configuration settings to run the application on a stream
|
127
|
+
# group. This configures the operating system, and can include
|
128
|
+
# compatibility layers and other drivers.
|
129
|
+
#
|
130
|
+
# A runtime environment can be one of the following:
|
131
|
+
#
|
132
|
+
# * For Linux applications
|
133
|
+
#
|
134
|
+
# * Ubuntu 22.04 LTS(`Type=UBUNTU, Version=22_04_LTS`)
|
135
|
+
#
|
136
|
+
# ^
|
137
|
+
# * For Windows applications
|
138
|
+
#
|
139
|
+
# * Microsoft Windows Server 2022 Base (`Type=WINDOWS,
|
140
|
+
# Version=2022`)
|
141
|
+
#
|
142
|
+
# * Proton 8.0-5 (`Type=PROTON, Version=20241007`)
|
143
|
+
#
|
144
|
+
# * Proton 8.0-2c (`Type=PROTON, Version=20230704`)
|
145
|
+
# @return [Types::RuntimeEnvironment]
|
146
|
+
#
|
147
|
+
# @!attribute [rw] status
|
148
|
+
# The current status of the application resource. Possible statuses
|
149
|
+
# include the following:
|
150
|
+
#
|
151
|
+
# * `INITIALIZED`: Amazon GameLift Streams has received the request
|
152
|
+
# and is initiating the work flow to create an application.
|
153
|
+
#
|
154
|
+
# * `PROCESSING`: The create application work flow is in process.
|
155
|
+
# Amazon GameLift Streams is copying the content and caching for
|
156
|
+
# future deployment in a stream group.
|
157
|
+
#
|
158
|
+
# * `READY`: The application is ready to deploy in a stream group.
|
159
|
+
#
|
160
|
+
# * `ERROR`: An error occurred when setting up the application. See
|
161
|
+
# `StatusReason` for more information.
|
162
|
+
#
|
163
|
+
# * `DELETING`: Amazon GameLift Streams is in the process of deleting
|
164
|
+
# the application.
|
165
|
+
# @return [String]
|
166
|
+
#
|
167
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/ApplicationSummary AWS API Documentation
|
168
|
+
#
|
169
|
+
class ApplicationSummary < Struct.new(
|
170
|
+
:arn,
|
171
|
+
:created_at,
|
172
|
+
:description,
|
173
|
+
:id,
|
174
|
+
:last_updated_at,
|
175
|
+
:runtime_environment,
|
176
|
+
:status)
|
177
|
+
SENSITIVE = []
|
178
|
+
include Aws::Structure
|
179
|
+
end
|
180
|
+
|
181
|
+
# @!attribute [rw] application_identifiers
|
182
|
+
# A set of applications to associate with the stream group.
|
183
|
+
#
|
184
|
+
# This value is a set of either [Amazon Resource Names (ARN)][1] or
|
185
|
+
# IDs that uniquely identify application resources. Format example:
|
186
|
+
# ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6`
|
187
|
+
# or ID-`9ZY8X7Wv6`.
|
188
|
+
#
|
189
|
+
#
|
190
|
+
#
|
191
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
192
|
+
# @return [Array<String>]
|
193
|
+
#
|
194
|
+
# @!attribute [rw] identifier
|
195
|
+
# A stream group to associate to the applications.
|
196
|
+
#
|
197
|
+
# This value is a [Amazon Resource Name (ARN)][1] or ID that uniquely
|
198
|
+
# identifies the stream group resource. Format example:
|
199
|
+
# ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4`
|
200
|
+
# or ID-`1AB2C3De4`.
|
201
|
+
#
|
202
|
+
#
|
203
|
+
#
|
204
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
205
|
+
# @return [String]
|
206
|
+
#
|
207
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/AssociateApplicationsInput AWS API Documentation
|
208
|
+
#
|
209
|
+
class AssociateApplicationsInput < Struct.new(
|
210
|
+
:application_identifiers,
|
211
|
+
:identifier)
|
212
|
+
SENSITIVE = []
|
213
|
+
include Aws::Structure
|
214
|
+
end
|
215
|
+
|
216
|
+
# @!attribute [rw] application_arns
|
217
|
+
# A set of applications that are associated to the stream group.
|
218
|
+
#
|
219
|
+
# This value is a set of either [Amazon Resource Names (ARN)][1] or
|
220
|
+
# IDs that uniquely identify application resources. Format example:
|
221
|
+
# ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6`
|
222
|
+
# or ID-`9ZY8X7Wv6`.
|
223
|
+
#
|
224
|
+
#
|
225
|
+
#
|
226
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
227
|
+
# @return [Array<String>]
|
228
|
+
#
|
229
|
+
# @!attribute [rw] arn
|
230
|
+
# A stream group that is associated to the applications.
|
231
|
+
#
|
232
|
+
# This value is a [Amazon Resource Name (ARN)][1] or ID that uniquely
|
233
|
+
# identifies the stream group resource. Format example:
|
234
|
+
# ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4`
|
235
|
+
# or ID-`1AB2C3De4`.
|
236
|
+
#
|
237
|
+
#
|
238
|
+
#
|
239
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
240
|
+
# @return [String]
|
241
|
+
#
|
242
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/AssociateApplicationsOutput AWS API Documentation
|
243
|
+
#
|
244
|
+
class AssociateApplicationsOutput < Struct.new(
|
245
|
+
:application_arns,
|
246
|
+
:arn)
|
247
|
+
SENSITIVE = []
|
248
|
+
include Aws::Structure
|
249
|
+
end
|
250
|
+
|
251
|
+
# The requested operation would cause a conflict with the current state
|
252
|
+
# of a service resource associated with the request. Resolve the
|
253
|
+
# conflict before retrying this request.
|
254
|
+
#
|
255
|
+
# @!attribute [rw] message
|
256
|
+
# Description of the error.
|
257
|
+
# @return [String]
|
258
|
+
#
|
259
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/ConflictException AWS API Documentation
|
260
|
+
#
|
261
|
+
class ConflictException < Struct.new(
|
262
|
+
:message)
|
263
|
+
SENSITIVE = []
|
264
|
+
include Aws::Structure
|
265
|
+
end
|
266
|
+
|
267
|
+
# @!attribute [rw] application_log_output_uri
|
268
|
+
# An Amazon S3 URI to a bucket where you would like Amazon GameLift
|
269
|
+
# Streams to save application logs. Use the following format for the
|
270
|
+
# URI: `s3://[bucket name]/[prefix]`. Required if you specify one or
|
271
|
+
# more `LogPaths`.
|
272
|
+
#
|
273
|
+
# <note markdown="1"> The log bucket must have permissions that give Amazon GameLift
|
274
|
+
# Streams access to write the log files. For more information, see
|
275
|
+
# **Getting Started** in the Amazon GameLift Streams Developer Guide.
|
276
|
+
#
|
277
|
+
# </note>
|
278
|
+
# @return [String]
|
279
|
+
#
|
280
|
+
# @!attribute [rw] application_log_paths
|
281
|
+
# Locations of log files that your content generates during a stream
|
282
|
+
# session. Enter path values that are relative to the
|
283
|
+
# `ApplicationSourceUri` location. You can specify up to 10 log
|
284
|
+
# locations. Amazon GameLift Streams uploads designated log files to
|
285
|
+
# the Amazon S3 bucket that you specify in `ApplicationLogOutputUri`
|
286
|
+
# at the end of a stream session. To retrieve stored log files, call
|
287
|
+
# GetStreamSession and get the `LogFileLocationUri`.
|
288
|
+
# @return [Array<String>]
|
289
|
+
#
|
290
|
+
# @!attribute [rw] application_source_uri
|
291
|
+
# The location of the content that you want to stream. Enter the URI
|
292
|
+
# of an Amazon S3 location (bucket name and prefixes) that contains
|
293
|
+
# your content. Use the following format for the URI: `s3://[bucket
|
294
|
+
# name]/[prefix]`. The location can have a multi-level prefix
|
295
|
+
# structure, but it must include all the files needed to run the
|
296
|
+
# content. Amazon GameLift Streams copies everything under the
|
297
|
+
# specified location.
|
298
|
+
#
|
299
|
+
# This value is immutable. To designate a different content location,
|
300
|
+
# create a new application.
|
301
|
+
#
|
302
|
+
# <note markdown="1"> The S3 bucket and the Amazon GameLift Streams application must be in
|
303
|
+
# the same Amazon Web Services Region.
|
304
|
+
#
|
305
|
+
# </note>
|
306
|
+
# @return [String]
|
307
|
+
#
|
308
|
+
# @!attribute [rw] client_token
|
309
|
+
# A unique identifier that represents a client request. The request is
|
310
|
+
# idempotent, which ensures that an API request completes only once.
|
311
|
+
# When users send a request, Amazon GameLift Streams automatically
|
312
|
+
# populates this field.
|
313
|
+
#
|
314
|
+
# **A suitable default value is auto-generated.** You should normally
|
315
|
+
# not need to pass this option.
|
316
|
+
# @return [String]
|
317
|
+
#
|
318
|
+
# @!attribute [rw] description
|
319
|
+
# A human-readable label for the application. You can update this
|
320
|
+
# value later.
|
321
|
+
# @return [String]
|
322
|
+
#
|
323
|
+
# @!attribute [rw] executable_path
|
324
|
+
# The path and file name of the executable file that launches the
|
325
|
+
# content for streaming. Enter a path value that is relative to the
|
326
|
+
# location set in `ApplicationSourceUri`.
|
327
|
+
# @return [String]
|
328
|
+
#
|
329
|
+
# @!attribute [rw] runtime_environment
|
330
|
+
# A set of configuration settings to run the application on a stream
|
331
|
+
# group. This configures the operating system, and can include
|
332
|
+
# compatibility layers and other drivers.
|
333
|
+
#
|
334
|
+
# A runtime environment can be one of the following:
|
335
|
+
#
|
336
|
+
# * For Linux applications
|
337
|
+
#
|
338
|
+
# * Ubuntu 22.04 LTS(`Type=UBUNTU, Version=22_04_LTS`)
|
339
|
+
#
|
340
|
+
# ^
|
341
|
+
# * For Windows applications
|
342
|
+
#
|
343
|
+
# * Microsoft Windows Server 2022 Base (`Type=WINDOWS,
|
344
|
+
# Version=2022`)
|
345
|
+
#
|
346
|
+
# * Proton 8.0-5 (`Type=PROTON, Version=20241007`)
|
347
|
+
#
|
348
|
+
# * Proton 8.0-2c (`Type=PROTON, Version=20230704`)
|
349
|
+
# @return [Types::RuntimeEnvironment]
|
350
|
+
#
|
351
|
+
# @!attribute [rw] tags
|
352
|
+
# A list of labels to assign to the new application resource. Tags are
|
353
|
+
# developer-defined key-value pairs. Tagging Amazon Web Services
|
354
|
+
# resources is useful for resource management, access management and
|
355
|
+
# cost allocation. See [ Tagging Amazon Web Services Resources][1] in
|
356
|
+
# the *Amazon Web Services General Reference*. You can use TagResource
|
357
|
+
# to add tags, UntagResource to remove tags, and ListTagsForResource
|
358
|
+
# to view tags on existing resources. The maximum tag limit might be
|
359
|
+
# lower than stated. See the *Amazon Web Services General Reference*
|
360
|
+
# for actual tagging limits.
|
361
|
+
#
|
362
|
+
#
|
363
|
+
#
|
364
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
365
|
+
# @return [Hash<String,String>]
|
366
|
+
#
|
367
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/CreateApplicationInput AWS API Documentation
|
368
|
+
#
|
369
|
+
class CreateApplicationInput < Struct.new(
|
370
|
+
:application_log_output_uri,
|
371
|
+
:application_log_paths,
|
372
|
+
:application_source_uri,
|
373
|
+
:client_token,
|
374
|
+
:description,
|
375
|
+
:executable_path,
|
376
|
+
:runtime_environment,
|
377
|
+
:tags)
|
378
|
+
SENSITIVE = []
|
379
|
+
include Aws::Structure
|
380
|
+
end
|
381
|
+
|
382
|
+
# @!attribute [rw] application_log_output_uri
|
383
|
+
# An Amazon S3 URI to a bucket where you would like Amazon GameLift
|
384
|
+
# Streams to save application logs. Use the following format for the
|
385
|
+
# URI: `s3://[bucket name]/[prefix]`. Required if you specify one or
|
386
|
+
# more `LogPaths`.
|
387
|
+
# @return [String]
|
388
|
+
#
|
389
|
+
# @!attribute [rw] application_log_paths
|
390
|
+
# Locations of log files that your content generates during a stream
|
391
|
+
# session. Amazon GameLift Streams uploads log files to the Amazon S3
|
392
|
+
# bucket that you specify in `ApplicationLogOutputUri` at the end of a
|
393
|
+
# stream session. To retrieve stored log files, call GetStreamSession
|
394
|
+
# and get the `LogFileLocationUri`.
|
395
|
+
# @return [Array<String>]
|
396
|
+
#
|
397
|
+
# @!attribute [rw] application_source_uri
|
398
|
+
# The original Amazon S3 location of uploaded stream content for the
|
399
|
+
# application.
|
400
|
+
# @return [String]
|
401
|
+
#
|
402
|
+
# @!attribute [rw] arn
|
403
|
+
# An Amazon Resource Name (ARN) that's assigned to an application
|
404
|
+
# resource and uniquely identifies it across all Amazon Web Services
|
405
|
+
# Regions. Format is `arn:aws:gameliftstreams:[AWS Region]:[AWS
|
406
|
+
# account]:application/[resource ID]`.
|
407
|
+
# @return [String]
|
408
|
+
#
|
409
|
+
# @!attribute [rw] associated_stream_groups
|
410
|
+
# A newly created application is not associated to any stream groups.
|
411
|
+
# This value is empty.
|
412
|
+
# @return [Array<String>]
|
413
|
+
#
|
414
|
+
# @!attribute [rw] created_at
|
415
|
+
# A timestamp that indicates when this resource was created.
|
416
|
+
# Timestamps are expressed using in ISO8601 format, such as:
|
417
|
+
# `2022-12-27T22:29:40+00:00` (UTC).
|
418
|
+
# @return [Time]
|
419
|
+
#
|
420
|
+
# @!attribute [rw] description
|
421
|
+
# A human-readable label for the application. You can edit this value.
|
422
|
+
# @return [String]
|
423
|
+
#
|
424
|
+
# @!attribute [rw] executable_path
|
425
|
+
# The path and file name of the executable file that launches the
|
426
|
+
# content for streaming.
|
427
|
+
# @return [String]
|
428
|
+
#
|
429
|
+
# @!attribute [rw] id
|
430
|
+
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies
|
431
|
+
# the application resource. Format example:
|
432
|
+
# ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6`
|
433
|
+
# or ID-`9ZY8X7Wv6`.
|
434
|
+
#
|
435
|
+
#
|
436
|
+
#
|
437
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
438
|
+
# @return [String]
|
439
|
+
#
|
440
|
+
# @!attribute [rw] last_updated_at
|
441
|
+
# A timestamp that indicates when this resource was last updated.
|
442
|
+
# Timestamps are expressed using in ISO8601 format, such as:
|
443
|
+
# `2022-12-27T22:29:40+00:00` (UTC).
|
444
|
+
# @return [Time]
|
445
|
+
#
|
446
|
+
# @!attribute [rw] replication_statuses
|
447
|
+
# A set of replication statuses for each location.
|
448
|
+
# @return [Array<Types::ReplicationStatus>]
|
449
|
+
#
|
450
|
+
# @!attribute [rw] runtime_environment
|
451
|
+
# A set of configuration settings to run the application on a stream
|
452
|
+
# group. This configures the operating system, and can include
|
453
|
+
# compatibility layers and other drivers.
|
454
|
+
#
|
455
|
+
# A runtime environment can be one of the following:
|
456
|
+
#
|
457
|
+
# * For Linux applications
|
458
|
+
#
|
459
|
+
# * Ubuntu 22.04 LTS(`Type=UBUNTU, Version=22_04_LTS`)
|
460
|
+
#
|
461
|
+
# ^
|
462
|
+
# * For Windows applications
|
463
|
+
#
|
464
|
+
# * Microsoft Windows Server 2022 Base (`Type=WINDOWS,
|
465
|
+
# Version=2022`)
|
466
|
+
#
|
467
|
+
# * Proton 8.0-5 (`Type=PROTON, Version=20241007`)
|
468
|
+
#
|
469
|
+
# * Proton 8.0-2c (`Type=PROTON, Version=20230704`)
|
470
|
+
# @return [Types::RuntimeEnvironment]
|
471
|
+
#
|
472
|
+
# @!attribute [rw] status
|
473
|
+
# The current status of the application resource. Possible statuses
|
474
|
+
# include the following:
|
475
|
+
#
|
476
|
+
# * `INITIALIZED`: Amazon GameLift Streams has received the request
|
477
|
+
# and is initiating the work flow to create an application.
|
478
|
+
#
|
479
|
+
# * `PROCESSING`: The create application work flow is in process.
|
480
|
+
# Amazon GameLift Streams is copying the content and caching for
|
481
|
+
# future deployment in a stream group.
|
482
|
+
#
|
483
|
+
# * `READY`: The application is ready to deploy in a stream group.
|
484
|
+
#
|
485
|
+
# * `ERROR`: An error occurred when setting up the application. See
|
486
|
+
# `StatusReason` for more information.
|
487
|
+
#
|
488
|
+
# * `DELETING`: Amazon GameLift Streams is in the process of deleting
|
489
|
+
# the application.
|
490
|
+
# @return [String]
|
491
|
+
#
|
492
|
+
# @!attribute [rw] status_reason
|
493
|
+
# A short description of the status reason when the application is in
|
494
|
+
# `ERROR` status.
|
495
|
+
# @return [String]
|
496
|
+
#
|
497
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/CreateApplicationOutput AWS API Documentation
|
498
|
+
#
|
499
|
+
class CreateApplicationOutput < Struct.new(
|
500
|
+
:application_log_output_uri,
|
501
|
+
:application_log_paths,
|
502
|
+
:application_source_uri,
|
503
|
+
:arn,
|
504
|
+
:associated_stream_groups,
|
505
|
+
:created_at,
|
506
|
+
:description,
|
507
|
+
:executable_path,
|
508
|
+
:id,
|
509
|
+
:last_updated_at,
|
510
|
+
:replication_statuses,
|
511
|
+
:runtime_environment,
|
512
|
+
:status,
|
513
|
+
:status_reason)
|
514
|
+
SENSITIVE = []
|
515
|
+
include Aws::Structure
|
516
|
+
end
|
517
|
+
|
518
|
+
# @!attribute [rw] client_token
|
519
|
+
# A unique identifier that represents a client request. The request is
|
520
|
+
# idempotent, which ensures that an API request completes only once.
|
521
|
+
# When users send a request, Amazon GameLift Streams automatically
|
522
|
+
# populates this field.
|
523
|
+
#
|
524
|
+
# **A suitable default value is auto-generated.** You should normally
|
525
|
+
# not need to pass this option.
|
526
|
+
# @return [String]
|
527
|
+
#
|
528
|
+
# @!attribute [rw] default_application_identifier
|
529
|
+
# The unique identifier of the Amazon GameLift Streams application
|
530
|
+
# that you want to associate to a stream group as the default
|
531
|
+
# application. The application must be in `READY` status. By setting
|
532
|
+
# the default application identifier, you will optimize startup
|
533
|
+
# performance of this application in your stream group. Once set, this
|
534
|
+
# application cannot be disassociated from the stream group, unlike
|
535
|
+
# applications that are associated using AssociateApplications. If not
|
536
|
+
# set when creating a stream group, you will need to call
|
537
|
+
# AssociateApplications later, before you can start streaming.
|
538
|
+
# @return [String]
|
539
|
+
#
|
540
|
+
# @!attribute [rw] description
|
541
|
+
# A descriptive label for the stream group.
|
542
|
+
# @return [String]
|
543
|
+
#
|
544
|
+
# @!attribute [rw] location_configurations
|
545
|
+
# A set of one or more locations and the streaming capacity for each
|
546
|
+
# location.
|
547
|
+
# @return [Array<Types::LocationConfiguration>]
|
548
|
+
#
|
549
|
+
# @!attribute [rw] stream_class
|
550
|
+
# The target stream quality for sessions that are hosted in this
|
551
|
+
# stream group. Set a stream class that is appropriate to the type of
|
552
|
+
# content that you're streaming. Stream class determines the type of
|
553
|
+
# computing resources Amazon GameLift Streams uses and impacts the
|
554
|
+
# cost of streaming. The following options are available:
|
555
|
+
#
|
556
|
+
# A stream class can be one of the following:
|
557
|
+
#
|
558
|
+
# * <b> <code>gen5n_win2022</code> (NVIDIA, ultra)</b> Supports
|
559
|
+
# applications with extremely high 3D scene complexity. Runs
|
560
|
+
# applications on Microsoft Windows Server 2022 Base and supports
|
561
|
+
# DirectX 12. Compatible with most Unreal Engine 5.x builds, 32-bit
|
562
|
+
# applications, and anti-cheat technology. Uses NVIDIA A10G Tensor
|
563
|
+
# GPU.
|
564
|
+
#
|
565
|
+
# * Reference resolution: 1080p
|
566
|
+
#
|
567
|
+
# * Reference frame rate: 60 fps
|
568
|
+
#
|
569
|
+
# * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
|
570
|
+
#
|
571
|
+
# * Tenancy: Supports 1 concurrent stream session
|
572
|
+
# * <b> <code>gen5n_high</code> (NVIDIA, high)</b> Supports
|
573
|
+
# applications with moderate to high 3D scene complexity. Uses
|
574
|
+
# NVIDIA A10G Tensor GPU.
|
575
|
+
#
|
576
|
+
# * Reference resolution: 1080p
|
577
|
+
#
|
578
|
+
# * Reference frame rate: 60 fps
|
579
|
+
#
|
580
|
+
# * Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM
|
581
|
+
#
|
582
|
+
# * Tenancy: Supports up to 2 concurrent stream sessions
|
583
|
+
# * <b> <code>gen5n_ultra</code> (NVIDIA, ultra)</b> Supports
|
584
|
+
# applications with extremely high 3D scene complexity. Uses
|
585
|
+
# dedicated NVIDIA A10G Tensor GPU.
|
586
|
+
#
|
587
|
+
# * Reference resolution: 1080p
|
588
|
+
#
|
589
|
+
# * Reference frame rate: 60 fps
|
590
|
+
#
|
591
|
+
# * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
|
592
|
+
#
|
593
|
+
# * Tenancy: Supports 1 concurrent stream session
|
594
|
+
# * <b> <code>gen4n_win2022</code> (NVIDIA, ultra)</b> Supports
|
595
|
+
# applications with extremely high 3D scene complexity. Runs
|
596
|
+
# applications on Microsoft Windows Server 2022 Base and supports
|
597
|
+
# DirectX 12. Compatible with most Unreal Engine 5.2 and 5.3 builds,
|
598
|
+
# 32-bit applications, and anti-cheat technology. Uses NVIDIA T4
|
599
|
+
# Tensor GPU.
|
600
|
+
#
|
601
|
+
# * Reference resolution: 1080p
|
602
|
+
#
|
603
|
+
# * Reference frame rate: 60 fps
|
604
|
+
#
|
605
|
+
# * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
|
606
|
+
#
|
607
|
+
# * Tenancy: Supports 1 concurrent stream session
|
608
|
+
# * <b> <code>gen4n_high</code> (NVIDIA, high)</b> Supports
|
609
|
+
# applications with moderate to high 3D scene complexity. Uses
|
610
|
+
# NVIDIA T4 Tensor GPU.
|
611
|
+
#
|
612
|
+
# * Reference resolution: 1080p
|
613
|
+
#
|
614
|
+
# * Reference frame rate: 60 fps
|
615
|
+
#
|
616
|
+
# * Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM
|
617
|
+
#
|
618
|
+
# * Tenancy: Supports up to 2 concurrent stream sessions
|
619
|
+
# * <b> <code>gen4n_ultra</code> (NVIDIA, ultra)</b> Supports
|
620
|
+
# applications with high 3D scene complexity. Uses dedicated NVIDIA
|
621
|
+
# T4 Tensor GPU.
|
622
|
+
#
|
623
|
+
# * Reference resolution: 1080p
|
624
|
+
#
|
625
|
+
# * Reference frame rate: 60 fps
|
626
|
+
#
|
627
|
+
# * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
|
628
|
+
#
|
629
|
+
# * Tenancy: Supports 1 concurrent stream session
|
630
|
+
# @return [String]
|
631
|
+
#
|
632
|
+
# @!attribute [rw] tags
|
633
|
+
# A list of labels to assign to the new stream group resource. Tags
|
634
|
+
# are developer-defined key-value pairs. It is useful to tag Amazon
|
635
|
+
# Web Services resources for resource management, access management,
|
636
|
+
# and cost allocation. See [ Tagging Amazon Web Services Resources][1]
|
637
|
+
# in the *Amazon Web Services General Reference*. You can use
|
638
|
+
# TagResource, UntagResource, and ListTagsForResource to add, remove,
|
639
|
+
# and view tags on existing resources. The maximum tag limit might be
|
640
|
+
# lower than stated. See the <i>Amazon Web Services </i> for actual
|
641
|
+
# tagging limits.
|
642
|
+
#
|
643
|
+
#
|
644
|
+
#
|
645
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
646
|
+
# @return [Hash<String,String>]
|
647
|
+
#
|
648
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/CreateStreamGroupInput AWS API Documentation
|
649
|
+
#
|
650
|
+
class CreateStreamGroupInput < Struct.new(
|
651
|
+
:client_token,
|
652
|
+
:default_application_identifier,
|
653
|
+
:description,
|
654
|
+
:location_configurations,
|
655
|
+
:stream_class,
|
656
|
+
:tags)
|
657
|
+
SENSITIVE = []
|
658
|
+
include Aws::Structure
|
659
|
+
end
|
660
|
+
|
661
|
+
# @!attribute [rw] arn
|
662
|
+
# An Amazon Resource Name (ARN) that is assigned to the stream group
|
663
|
+
# resource and that uniquely identifies the group across all Amazon
|
664
|
+
# Web Services Regions. Format is `arn:aws:gameliftstreams:[AWS
|
665
|
+
# Region]:[AWS account]:streamgroup/[resource ID]`.
|
666
|
+
# @return [String]
|
667
|
+
#
|
668
|
+
# @!attribute [rw] associated_applications
|
669
|
+
# A set of applications that this stream group is associated to. You
|
670
|
+
# can stream any of these applications by using this stream group.
|
671
|
+
#
|
672
|
+
# This value is a set of [Amazon Resource Names (ARNs)][1] that
|
673
|
+
# uniquely identify application resources. Format example:
|
674
|
+
# `arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6`.
|
675
|
+
#
|
676
|
+
#
|
677
|
+
#
|
678
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
679
|
+
# @return [Array<String>]
|
680
|
+
#
|
681
|
+
# @!attribute [rw] created_at
|
682
|
+
# A timestamp that indicates when this resource was created.
|
683
|
+
# Timestamps are expressed using in ISO8601 format, such as:
|
684
|
+
# `2022-12-27T22:29:40+00:00` (UTC).
|
685
|
+
# @return [Time]
|
686
|
+
#
|
687
|
+
# @!attribute [rw] default_application
|
688
|
+
# The Amazon GameLift Streams application that is associated with this
|
689
|
+
# stream group.
|
690
|
+
# @return [Types::DefaultApplication]
|
691
|
+
#
|
692
|
+
# @!attribute [rw] description
|
693
|
+
# A descriptive label for the stream group.
|
694
|
+
# @return [String]
|
695
|
+
#
|
696
|
+
# @!attribute [rw] id
|
697
|
+
# A unique ID value that is assigned to the resource when it's
|
698
|
+
# created. Format example: `1AB2C3De4`.
|
699
|
+
# @return [String]
|
700
|
+
#
|
701
|
+
# @!attribute [rw] last_updated_at
|
702
|
+
# A timestamp that indicates when this resource was last updated.
|
703
|
+
# Timestamps are expressed using in ISO8601 format, such as:
|
704
|
+
# `2022-12-27T22:29:40+00:00` (UTC).
|
705
|
+
# @return [Time]
|
706
|
+
#
|
707
|
+
# @!attribute [rw] location_states
|
708
|
+
# This value is the set of locations, including their name, current
|
709
|
+
# status, and capacities.
|
710
|
+
#
|
711
|
+
# A location can be in one of the following states:
|
712
|
+
#
|
713
|
+
# * **ACTIVATING**: Amazon GameLift Streams is preparing the location.
|
714
|
+
# You cannot stream from, scale the capacity of, or remove this
|
715
|
+
# location yet.
|
716
|
+
#
|
717
|
+
# * **ACTIVE**: The location is provisioned with initial capacity. You
|
718
|
+
# can now stream from, scale the capacity of, or remove this
|
719
|
+
# location.
|
720
|
+
#
|
721
|
+
# * **ERROR**: Amazon GameLift Streams failed to set up this location.
|
722
|
+
# The StatusReason field describes the error. You can remove this
|
723
|
+
# location and try to add it again.
|
724
|
+
#
|
725
|
+
# * **REMOVING**: Amazon GameLift Streams is working to remove this
|
726
|
+
# location. It releases all provisioned capacity for this location
|
727
|
+
# in this stream group.
|
728
|
+
# @return [Array<Types::LocationState>]
|
729
|
+
#
|
730
|
+
# @!attribute [rw] status
|
731
|
+
# The current status of the stream group resource. Possible statuses
|
732
|
+
# include the following:
|
733
|
+
#
|
734
|
+
# * `ACTIVATING`: The stream group is deploying and isn't ready to
|
735
|
+
# host streams.
|
736
|
+
#
|
737
|
+
# * `ACTIVE`: The stream group is ready to host streams.
|
738
|
+
#
|
739
|
+
# * `ACTIVE_WITH_ERRORS`: One or more locations in the stream group
|
740
|
+
# are in an error state. Verify the details of individual locations
|
741
|
+
# and remove any locations which are in error.
|
742
|
+
#
|
743
|
+
# * `ERROR`: An error occurred when the stream group deployed. See
|
744
|
+
# `StatusReason` for more information.
|
745
|
+
#
|
746
|
+
# * `DELETING`: Amazon GameLift Streams is in the process of deleting
|
747
|
+
# the stream group.
|
748
|
+
#
|
749
|
+
# * `UPDATING_LOCATIONS`: One or more locations in the stream group
|
750
|
+
# are in the process of updating (either activating or deleting).
|
751
|
+
# @return [String]
|
752
|
+
#
|
753
|
+
# @!attribute [rw] status_reason
|
754
|
+
# A short description of the reason that the stream group is in
|
755
|
+
# `ERROR` status. The possible reasons can be one of the following:
|
756
|
+
#
|
757
|
+
# * `internalError`: The request can't process right now bcause of an
|
758
|
+
# issue with the server. Try again later. Reach out to the Amazon
|
759
|
+
# GameLift Streams team for more help.
|
760
|
+
#
|
761
|
+
# * `noAvailableInstances`: Amazon GameLift Streams does not currently
|
762
|
+
# have enough available On-Demand capacity to fulfill your request.
|
763
|
+
# Wait a few minutes and retry the request as capacity can shift
|
764
|
+
# frequently. You can also try to make the request using a different
|
765
|
+
# stream class or in another region.
|
766
|
+
# @return [String]
|
767
|
+
#
|
768
|
+
# @!attribute [rw] stream_class
|
769
|
+
# The target stream quality for the stream group.
|
770
|
+
#
|
771
|
+
# A stream class can be one of the following:
|
772
|
+
#
|
773
|
+
# * <b> <code>gen5n_win2022</code> (NVIDIA, ultra)</b> Supports
|
774
|
+
# applications with extremely high 3D scene complexity. Runs
|
775
|
+
# applications on Microsoft Windows Server 2022 Base and supports
|
776
|
+
# DirectX 12. Compatible with most Unreal Engine 5.x builds, 32-bit
|
777
|
+
# applications, and anti-cheat technology. Uses NVIDIA A10G Tensor
|
778
|
+
# GPU.
|
779
|
+
#
|
780
|
+
# * Reference resolution: 1080p
|
781
|
+
#
|
782
|
+
# * Reference frame rate: 60 fps
|
783
|
+
#
|
784
|
+
# * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
|
785
|
+
#
|
786
|
+
# * Tenancy: Supports 1 concurrent stream session
|
787
|
+
# * <b> <code>gen5n_high</code> (NVIDIA, high)</b> Supports
|
788
|
+
# applications with moderate to high 3D scene complexity. Uses
|
789
|
+
# NVIDIA A10G Tensor GPU.
|
790
|
+
#
|
791
|
+
# * Reference resolution: 1080p
|
792
|
+
#
|
793
|
+
# * Reference frame rate: 60 fps
|
794
|
+
#
|
795
|
+
# * Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM
|
796
|
+
#
|
797
|
+
# * Tenancy: Supports up to 2 concurrent stream sessions
|
798
|
+
# * <b> <code>gen5n_ultra</code> (NVIDIA, ultra)</b> Supports
|
799
|
+
# applications with extremely high 3D scene complexity. Uses
|
800
|
+
# dedicated NVIDIA A10G Tensor GPU.
|
801
|
+
#
|
802
|
+
# * Reference resolution: 1080p
|
803
|
+
#
|
804
|
+
# * Reference frame rate: 60 fps
|
805
|
+
#
|
806
|
+
# * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
|
807
|
+
#
|
808
|
+
# * Tenancy: Supports 1 concurrent stream session
|
809
|
+
# * <b> <code>gen4n_win2022</code> (NVIDIA, ultra)</b> Supports
|
810
|
+
# applications with extremely high 3D scene complexity. Runs
|
811
|
+
# applications on Microsoft Windows Server 2022 Base and supports
|
812
|
+
# DirectX 12. Compatible with most Unreal Engine 5.2 and 5.3 builds,
|
813
|
+
# 32-bit applications, and anti-cheat technology. Uses NVIDIA T4
|
814
|
+
# Tensor GPU.
|
815
|
+
#
|
816
|
+
# * Reference resolution: 1080p
|
817
|
+
#
|
818
|
+
# * Reference frame rate: 60 fps
|
819
|
+
#
|
820
|
+
# * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
|
821
|
+
#
|
822
|
+
# * Tenancy: Supports 1 concurrent stream session
|
823
|
+
# * <b> <code>gen4n_high</code> (NVIDIA, high)</b> Supports
|
824
|
+
# applications with moderate to high 3D scene complexity. Uses
|
825
|
+
# NVIDIA T4 Tensor GPU.
|
826
|
+
#
|
827
|
+
# * Reference resolution: 1080p
|
828
|
+
#
|
829
|
+
# * Reference frame rate: 60 fps
|
830
|
+
#
|
831
|
+
# * Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM
|
832
|
+
#
|
833
|
+
# * Tenancy: Supports up to 2 concurrent stream sessions
|
834
|
+
# * <b> <code>gen4n_ultra</code> (NVIDIA, ultra)</b> Supports
|
835
|
+
# applications with high 3D scene complexity. Uses dedicated NVIDIA
|
836
|
+
# T4 Tensor GPU.
|
837
|
+
#
|
838
|
+
# * Reference resolution: 1080p
|
839
|
+
#
|
840
|
+
# * Reference frame rate: 60 fps
|
841
|
+
#
|
842
|
+
# * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
|
843
|
+
#
|
844
|
+
# * Tenancy: Supports 1 concurrent stream session
|
845
|
+
# @return [String]
|
846
|
+
#
|
847
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/CreateStreamGroupOutput AWS API Documentation
|
848
|
+
#
|
849
|
+
class CreateStreamGroupOutput < Struct.new(
|
850
|
+
:arn,
|
851
|
+
:associated_applications,
|
852
|
+
:created_at,
|
853
|
+
:default_application,
|
854
|
+
:description,
|
855
|
+
:id,
|
856
|
+
:last_updated_at,
|
857
|
+
:location_states,
|
858
|
+
:status,
|
859
|
+
:status_reason,
|
860
|
+
:stream_class)
|
861
|
+
SENSITIVE = []
|
862
|
+
include Aws::Structure
|
863
|
+
end
|
864
|
+
|
865
|
+
# @!attribute [rw] client_token
|
866
|
+
# A unique identifier that represents a client request. The request is
|
867
|
+
# idempotent, which ensures that an API request completes only once.
|
868
|
+
# When users send a request, Amazon GameLift Streams automatically
|
869
|
+
# populates this field.
|
870
|
+
#
|
871
|
+
# **A suitable default value is auto-generated.** You should normally
|
872
|
+
# not need to pass this option.
|
873
|
+
# @return [String]
|
874
|
+
#
|
875
|
+
# @!attribute [rw] identifier
|
876
|
+
# [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
|
877
|
+
# stream group resource. Format example:
|
878
|
+
# ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4`
|
879
|
+
# or ID-`1AB2C3De4`.
|
880
|
+
#
|
881
|
+
# The stream group that you want to run this stream session with. The
|
882
|
+
# stream group must be in `ACTIVE` status and have idle stream
|
883
|
+
# capacity.
|
884
|
+
#
|
885
|
+
#
|
886
|
+
#
|
887
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
888
|
+
# @return [String]
|
889
|
+
#
|
890
|
+
# @!attribute [rw] signal_request
|
891
|
+
# A WebRTC ICE offer string to use when initializing a WebRTC
|
892
|
+
# connection. The offer is a very long JSON string. Provide the string
|
893
|
+
# as a text value in quotes. The offer must be newly generated, not
|
894
|
+
# the same offer provided to `StartStreamSession`.
|
895
|
+
# @return [String]
|
896
|
+
#
|
897
|
+
# @!attribute [rw] stream_session_identifier
|
898
|
+
# [Amazon Resource Name (ARN)][1] that uniquely identifies the stream
|
899
|
+
# session resource. Format example: `1AB2C3De4`. The stream session
|
900
|
+
# must be in `PENDING_CLIENT_RECONNECTION` or `ACTIVE` status.
|
901
|
+
#
|
902
|
+
#
|
903
|
+
#
|
904
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
905
|
+
# @return [String]
|
906
|
+
#
|
907
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/CreateStreamSessionConnectionInput AWS API Documentation
|
908
|
+
#
|
909
|
+
class CreateStreamSessionConnectionInput < Struct.new(
|
910
|
+
:client_token,
|
911
|
+
:identifier,
|
912
|
+
:signal_request,
|
913
|
+
:stream_session_identifier)
|
914
|
+
SENSITIVE = [:signal_request]
|
915
|
+
include Aws::Structure
|
916
|
+
end
|
917
|
+
|
918
|
+
# @!attribute [rw] signal_response
|
919
|
+
# The WebRTC answer string that the stream server generates in
|
920
|
+
# response to the `SignalRequest`.
|
921
|
+
# @return [String]
|
922
|
+
#
|
923
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/CreateStreamSessionConnectionOutput AWS API Documentation
|
924
|
+
#
|
925
|
+
class CreateStreamSessionConnectionOutput < Struct.new(
|
926
|
+
:signal_response)
|
927
|
+
SENSITIVE = [:signal_response]
|
928
|
+
include Aws::Structure
|
929
|
+
end
|
930
|
+
|
931
|
+
# Represents the Amazon GameLift Streams application that a stream group
|
932
|
+
# hosts.
|
933
|
+
#
|
934
|
+
# @!attribute [rw] arn
|
935
|
+
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies
|
936
|
+
# the stream group resource. Format example:
|
937
|
+
# ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4`
|
938
|
+
# or ID-`1AB2C3De4`.
|
939
|
+
#
|
940
|
+
#
|
941
|
+
#
|
942
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
943
|
+
# @return [String]
|
944
|
+
#
|
945
|
+
# @!attribute [rw] id
|
946
|
+
# The default application of the stream group.
|
947
|
+
#
|
948
|
+
# This value is an [Amazon Resource Name (ARN)][1] or ID that uniquely
|
949
|
+
# identifies the application resource. Format example:
|
950
|
+
# ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6`
|
951
|
+
# or ID-`9ZY8X7Wv6`.
|
952
|
+
#
|
953
|
+
#
|
954
|
+
#
|
955
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
956
|
+
# @return [String]
|
957
|
+
#
|
958
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/DefaultApplication AWS API Documentation
|
959
|
+
#
|
960
|
+
class DefaultApplication < Struct.new(
|
961
|
+
:arn,
|
962
|
+
:id)
|
963
|
+
SENSITIVE = []
|
964
|
+
include Aws::Structure
|
965
|
+
end
|
966
|
+
|
967
|
+
# @!attribute [rw] identifier
|
968
|
+
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies
|
969
|
+
# the application resource. Format example:
|
970
|
+
# ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6`
|
971
|
+
# or ID-`9ZY8X7Wv6`.
|
972
|
+
#
|
973
|
+
#
|
974
|
+
#
|
975
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
976
|
+
# @return [String]
|
977
|
+
#
|
978
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/DeleteApplicationInput AWS API Documentation
|
979
|
+
#
|
980
|
+
class DeleteApplicationInput < Struct.new(
|
981
|
+
:identifier)
|
982
|
+
SENSITIVE = []
|
983
|
+
include Aws::Structure
|
984
|
+
end
|
985
|
+
|
986
|
+
# @!attribute [rw] identifier
|
987
|
+
# The unique ID value of the stream group resource to delete. Format
|
988
|
+
# example: `1AB2C3De4`.
|
989
|
+
# @return [String]
|
990
|
+
#
|
991
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/DeleteStreamGroupInput AWS API Documentation
|
992
|
+
#
|
993
|
+
class DeleteStreamGroupInput < Struct.new(
|
994
|
+
:identifier)
|
995
|
+
SENSITIVE = []
|
996
|
+
include Aws::Structure
|
997
|
+
end
|
998
|
+
|
999
|
+
# @!attribute [rw] application_identifiers
|
1000
|
+
# A set of applications that you want to disassociate from the stream
|
1001
|
+
# group.
|
1002
|
+
#
|
1003
|
+
# This value is a set of either [Amazon Resource Names (ARN)][1] or
|
1004
|
+
# IDs that uniquely identify application resources. Format example:
|
1005
|
+
# ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6`
|
1006
|
+
# or ID-`9ZY8X7Wv6`.
|
1007
|
+
#
|
1008
|
+
#
|
1009
|
+
#
|
1010
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1011
|
+
# @return [Array<String>]
|
1012
|
+
#
|
1013
|
+
# @!attribute [rw] identifier
|
1014
|
+
# A stream group to disassociate these applications from.
|
1015
|
+
#
|
1016
|
+
# This value is an [Amazon Resource Name (ARN)][1] or ID that uniquely
|
1017
|
+
# identifies the stream group resource. Format example:
|
1018
|
+
# ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4`
|
1019
|
+
# or ID-`1AB2C3De4`.
|
1020
|
+
#
|
1021
|
+
#
|
1022
|
+
#
|
1023
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1024
|
+
# @return [String]
|
1025
|
+
#
|
1026
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/DisassociateApplicationsInput AWS API Documentation
|
1027
|
+
#
|
1028
|
+
class DisassociateApplicationsInput < Struct.new(
|
1029
|
+
:application_identifiers,
|
1030
|
+
:identifier)
|
1031
|
+
SENSITIVE = []
|
1032
|
+
include Aws::Structure
|
1033
|
+
end
|
1034
|
+
|
1035
|
+
# @!attribute [rw] application_arns
|
1036
|
+
# A set of applications that are disassociated from this stream group.
|
1037
|
+
#
|
1038
|
+
# This value is a set of either [Amazon Resource Names (ARN)][1] or
|
1039
|
+
# IDs that uniquely identify application resources. Format example:
|
1040
|
+
# ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6`
|
1041
|
+
# or ID-`9ZY8X7Wv6`.
|
1042
|
+
#
|
1043
|
+
#
|
1044
|
+
#
|
1045
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1046
|
+
# @return [Array<String>]
|
1047
|
+
#
|
1048
|
+
# @!attribute [rw] arn
|
1049
|
+
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies
|
1050
|
+
# the stream group resource. Format example:
|
1051
|
+
# ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4`
|
1052
|
+
# or ID-`1AB2C3De4`.
|
1053
|
+
#
|
1054
|
+
#
|
1055
|
+
#
|
1056
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1057
|
+
# @return [String]
|
1058
|
+
#
|
1059
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/DisassociateApplicationsOutput AWS API Documentation
|
1060
|
+
#
|
1061
|
+
class DisassociateApplicationsOutput < Struct.new(
|
1062
|
+
:application_arns,
|
1063
|
+
:arn)
|
1064
|
+
SENSITIVE = []
|
1065
|
+
include Aws::Structure
|
1066
|
+
end
|
1067
|
+
|
1068
|
+
# Provides details about the stream session's exported files.
|
1069
|
+
#
|
1070
|
+
# @!attribute [rw] output_uri
|
1071
|
+
# The S3 bucket URI where Amazon GameLift Streams uploaded the set of
|
1072
|
+
# compressed exported files for a stream session. Amazon GameLift
|
1073
|
+
# Streams generates a ZIP file name based on the stream session
|
1074
|
+
# metadata. Alternatively, you can provide a custom file name with a
|
1075
|
+
# `.zip` file extension.
|
1076
|
+
#
|
1077
|
+
# Example 1: If you provide an S3 URI called
|
1078
|
+
# `s3://MyBucket/MyGame_Session1.zip`, then Amazon GameLift Streams
|
1079
|
+
# will save the files at that location.
|
1080
|
+
#
|
1081
|
+
# Example 2: If you provide an S3 URI called
|
1082
|
+
# `s3://MyBucket/MyGameSessions_ExportedFiles/`, then Amazon GameLift
|
1083
|
+
# Streams will save the files at
|
1084
|
+
# `s3://MyBucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip`
|
1085
|
+
# or another similar name.
|
1086
|
+
# @return [String]
|
1087
|
+
#
|
1088
|
+
# @!attribute [rw] status
|
1089
|
+
# The result of the ExportStreamSessionFiles operation.
|
1090
|
+
# @return [String]
|
1091
|
+
#
|
1092
|
+
# @!attribute [rw] status_reason
|
1093
|
+
# A short description of the reason the export is in `FAILED` status.
|
1094
|
+
# @return [String]
|
1095
|
+
#
|
1096
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/ExportFilesMetadata AWS API Documentation
|
1097
|
+
#
|
1098
|
+
class ExportFilesMetadata < Struct.new(
|
1099
|
+
:output_uri,
|
1100
|
+
:status,
|
1101
|
+
:status_reason)
|
1102
|
+
SENSITIVE = []
|
1103
|
+
include Aws::Structure
|
1104
|
+
end
|
1105
|
+
|
1106
|
+
# @!attribute [rw] identifier
|
1107
|
+
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies
|
1108
|
+
# the stream group resource. Format example:
|
1109
|
+
# ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4`
|
1110
|
+
# or ID-`1AB2C3De4`.
|
1111
|
+
#
|
1112
|
+
#
|
1113
|
+
#
|
1114
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1115
|
+
# @return [String]
|
1116
|
+
#
|
1117
|
+
# @!attribute [rw] output_uri
|
1118
|
+
# The S3 bucket URI where Amazon GameLift Streams uploads the set of
|
1119
|
+
# compressed exported files for this stream session. Amazon GameLift
|
1120
|
+
# Streams generates a ZIP file name based on the stream session
|
1121
|
+
# metadata. Alternatively, you can provide a custom file name with a
|
1122
|
+
# `.zip` file extension.
|
1123
|
+
#
|
1124
|
+
# Example 1: If you provide an S3 URI called
|
1125
|
+
# `s3://MyBucket/MyGame_Session1.zip`, then Amazon GameLift Streams
|
1126
|
+
# will save the files at that location.
|
1127
|
+
#
|
1128
|
+
# Example 2: If you provide an S3 URI called
|
1129
|
+
# `s3://MyBucket/MyGameSessions_ExportedFiles/`, then Amazon GameLift
|
1130
|
+
# Streams will save the files at
|
1131
|
+
# `s3://MyBucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip`
|
1132
|
+
# or another similar name.
|
1133
|
+
# @return [String]
|
1134
|
+
#
|
1135
|
+
# @!attribute [rw] stream_session_identifier
|
1136
|
+
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies
|
1137
|
+
# the stream session resource. Format example: `1AB2C3De4`.
|
1138
|
+
#
|
1139
|
+
#
|
1140
|
+
#
|
1141
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1142
|
+
# @return [String]
|
1143
|
+
#
|
1144
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/ExportStreamSessionFilesInput AWS API Documentation
|
1145
|
+
#
|
1146
|
+
class ExportStreamSessionFilesInput < Struct.new(
|
1147
|
+
:identifier,
|
1148
|
+
:output_uri,
|
1149
|
+
:stream_session_identifier)
|
1150
|
+
SENSITIVE = []
|
1151
|
+
include Aws::Structure
|
1152
|
+
end
|
1153
|
+
|
1154
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/ExportStreamSessionFilesOutput AWS API Documentation
|
1155
|
+
#
|
1156
|
+
class ExportStreamSessionFilesOutput < Aws::EmptyStructure; end
|
1157
|
+
|
1158
|
+
# @!attribute [rw] identifier
|
1159
|
+
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies
|
1160
|
+
# the application resource. Format example:
|
1161
|
+
# ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6`
|
1162
|
+
# or ID-`9ZY8X7Wv6`.
|
1163
|
+
#
|
1164
|
+
#
|
1165
|
+
#
|
1166
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1167
|
+
# @return [String]
|
1168
|
+
#
|
1169
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/GetApplicationInput AWS API Documentation
|
1170
|
+
#
|
1171
|
+
class GetApplicationInput < Struct.new(
|
1172
|
+
:identifier)
|
1173
|
+
SENSITIVE = []
|
1174
|
+
include Aws::Structure
|
1175
|
+
end
|
1176
|
+
|
1177
|
+
# @!attribute [rw] application_log_output_uri
|
1178
|
+
# An Amazon S3 URI to a bucket where you would like Amazon GameLift
|
1179
|
+
# Streams to save application logs. Use the following format for the
|
1180
|
+
# URI: `s3://[bucket name]/[prefix]`. Required if you specify one or
|
1181
|
+
# more `LogPaths`.
|
1182
|
+
# @return [String]
|
1183
|
+
#
|
1184
|
+
# @!attribute [rw] application_log_paths
|
1185
|
+
# Locations of log files that your content generates during a stream
|
1186
|
+
# session. Amazon GameLift Streams uploads log files to the Amazon S3
|
1187
|
+
# bucket that you specify in `ApplicationLogOutputUri` at the end of a
|
1188
|
+
# stream session. To retrieve stored log files, call GetStreamSession
|
1189
|
+
# and get the `LogFileLocationUri`.
|
1190
|
+
# @return [Array<String>]
|
1191
|
+
#
|
1192
|
+
# @!attribute [rw] application_source_uri
|
1193
|
+
# The original Amazon S3 location of uploaded stream content for the
|
1194
|
+
# application.
|
1195
|
+
# @return [String]
|
1196
|
+
#
|
1197
|
+
# @!attribute [rw] arn
|
1198
|
+
# An Amazon Resource Name (ARN) that's assigned to an application
|
1199
|
+
# resource and uniquely identifies it across all Amazon Web Services
|
1200
|
+
# Regions. Format is `arn:aws:gameliftstreams:[AWS Region]:[AWS
|
1201
|
+
# account]:application/[resource ID]`.
|
1202
|
+
# @return [String]
|
1203
|
+
#
|
1204
|
+
# @!attribute [rw] associated_stream_groups
|
1205
|
+
# A set of stream groups that this application is associated with. You
|
1206
|
+
# can use any of these stream groups to stream your application.
|
1207
|
+
#
|
1208
|
+
# This value is a set of [Amazon Resource Names (ARNs)][1] that
|
1209
|
+
# uniquely identify stream group resources. Format example:
|
1210
|
+
# `arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4`.
|
1211
|
+
#
|
1212
|
+
#
|
1213
|
+
#
|
1214
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1215
|
+
# @return [Array<String>]
|
1216
|
+
#
|
1217
|
+
# @!attribute [rw] created_at
|
1218
|
+
# A timestamp that indicates when this resource was created.
|
1219
|
+
# Timestamps are expressed using in ISO8601 format, such as:
|
1220
|
+
# `2022-12-27T22:29:40+00:00` (UTC).
|
1221
|
+
# @return [Time]
|
1222
|
+
#
|
1223
|
+
# @!attribute [rw] description
|
1224
|
+
# A human-readable label for the application. You can edit this value.
|
1225
|
+
# @return [String]
|
1226
|
+
#
|
1227
|
+
# @!attribute [rw] executable_path
|
1228
|
+
# The path and file name of the executable file that launches the
|
1229
|
+
# content for streaming.
|
1230
|
+
# @return [String]
|
1231
|
+
#
|
1232
|
+
# @!attribute [rw] id
|
1233
|
+
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies
|
1234
|
+
# the application resource. Format example:
|
1235
|
+
# ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6`
|
1236
|
+
# or ID-`9ZY8X7Wv6`.
|
1237
|
+
#
|
1238
|
+
#
|
1239
|
+
#
|
1240
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1241
|
+
# @return [String]
|
1242
|
+
#
|
1243
|
+
# @!attribute [rw] last_updated_at
|
1244
|
+
# A timestamp that indicates when this resource was last updated.
|
1245
|
+
# Timestamps are expressed using in ISO8601 format, such as:
|
1246
|
+
# `2022-12-27T22:29:40+00:00` (UTC).
|
1247
|
+
# @return [Time]
|
1248
|
+
#
|
1249
|
+
# @!attribute [rw] replication_statuses
|
1250
|
+
# A set of replication statuses for each location.
|
1251
|
+
# @return [Array<Types::ReplicationStatus>]
|
1252
|
+
#
|
1253
|
+
# @!attribute [rw] runtime_environment
|
1254
|
+
# A set of configuration settings to run the application on a stream
|
1255
|
+
# group. This configures the operating system, and can include
|
1256
|
+
# compatibility layers and other drivers.
|
1257
|
+
#
|
1258
|
+
# A runtime environment can be one of the following:
|
1259
|
+
#
|
1260
|
+
# * For Linux applications
|
1261
|
+
#
|
1262
|
+
# * Ubuntu 22.04 LTS(`Type=UBUNTU, Version=22_04_LTS`)
|
1263
|
+
#
|
1264
|
+
# ^
|
1265
|
+
# * For Windows applications
|
1266
|
+
#
|
1267
|
+
# * Microsoft Windows Server 2022 Base (`Type=WINDOWS,
|
1268
|
+
# Version=2022`)
|
1269
|
+
#
|
1270
|
+
# * Proton 8.0-5 (`Type=PROTON, Version=20241007`)
|
1271
|
+
#
|
1272
|
+
# * Proton 8.0-2c (`Type=PROTON, Version=20230704`)
|
1273
|
+
# @return [Types::RuntimeEnvironment]
|
1274
|
+
#
|
1275
|
+
# @!attribute [rw] status
|
1276
|
+
# The current status of the application resource. Possible statuses
|
1277
|
+
# include the following:
|
1278
|
+
#
|
1279
|
+
# * `INITIALIZED`: Amazon GameLift Streams has received the request
|
1280
|
+
# and is initiating the work flow to create an application.
|
1281
|
+
#
|
1282
|
+
# * `PROCESSING`: The create application work flow is in process.
|
1283
|
+
# Amazon GameLift Streams is copying the content and caching for
|
1284
|
+
# future deployment in a stream group.
|
1285
|
+
#
|
1286
|
+
# * `READY`: The application is ready to deploy in a stream group.
|
1287
|
+
#
|
1288
|
+
# * `ERROR`: An error occurred when setting up the application. See
|
1289
|
+
# `StatusReason` for more information.
|
1290
|
+
#
|
1291
|
+
# * `DELETING`: Amazon GameLift Streams is in the process of deleting
|
1292
|
+
# the application.
|
1293
|
+
# @return [String]
|
1294
|
+
#
|
1295
|
+
# @!attribute [rw] status_reason
|
1296
|
+
# A short description of the status reason when the application is in
|
1297
|
+
# `ERROR` status.
|
1298
|
+
# @return [String]
|
1299
|
+
#
|
1300
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/GetApplicationOutput AWS API Documentation
|
1301
|
+
#
|
1302
|
+
class GetApplicationOutput < Struct.new(
|
1303
|
+
:application_log_output_uri,
|
1304
|
+
:application_log_paths,
|
1305
|
+
:application_source_uri,
|
1306
|
+
:arn,
|
1307
|
+
:associated_stream_groups,
|
1308
|
+
:created_at,
|
1309
|
+
:description,
|
1310
|
+
:executable_path,
|
1311
|
+
:id,
|
1312
|
+
:last_updated_at,
|
1313
|
+
:replication_statuses,
|
1314
|
+
:runtime_environment,
|
1315
|
+
:status,
|
1316
|
+
:status_reason)
|
1317
|
+
SENSITIVE = []
|
1318
|
+
include Aws::Structure
|
1319
|
+
end
|
1320
|
+
|
1321
|
+
# @!attribute [rw] identifier
|
1322
|
+
# The unique ID value of the stream group resource to retrieve. Format
|
1323
|
+
# example: `1AB2C3De4`.
|
1324
|
+
# @return [String]
|
1325
|
+
#
|
1326
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/GetStreamGroupInput AWS API Documentation
|
1327
|
+
#
|
1328
|
+
class GetStreamGroupInput < Struct.new(
|
1329
|
+
:identifier)
|
1330
|
+
SENSITIVE = []
|
1331
|
+
include Aws::Structure
|
1332
|
+
end
|
1333
|
+
|
1334
|
+
# @!attribute [rw] arn
|
1335
|
+
# An Amazon Resource Name (ARN) that is assigned to the stream group
|
1336
|
+
# resource and that uniquely identifies the group across all Amazon
|
1337
|
+
# Web Services Regions. Format is `arn:aws:gameliftstreams:[AWS
|
1338
|
+
# Region]:[AWS account]:streamgroup/[resource ID]`.
|
1339
|
+
# @return [String]
|
1340
|
+
#
|
1341
|
+
# @!attribute [rw] associated_applications
|
1342
|
+
# A set of applications that this stream group is associated to. You
|
1343
|
+
# can stream any of these applications by using this stream group.
|
1344
|
+
#
|
1345
|
+
# This value is a set of [Amazon Resource Names (ARNs)][1] that
|
1346
|
+
# uniquely identify application resources. Format example:
|
1347
|
+
# `arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6`.
|
1348
|
+
#
|
1349
|
+
#
|
1350
|
+
#
|
1351
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1352
|
+
# @return [Array<String>]
|
1353
|
+
#
|
1354
|
+
# @!attribute [rw] created_at
|
1355
|
+
# A timestamp that indicates when this resource was created.
|
1356
|
+
# Timestamps are expressed using in ISO8601 format, such as:
|
1357
|
+
# `2022-12-27T22:29:40+00:00` (UTC).
|
1358
|
+
# @return [Time]
|
1359
|
+
#
|
1360
|
+
# @!attribute [rw] default_application
|
1361
|
+
# The Amazon GameLift Streams application that is associated with this
|
1362
|
+
# stream group.
|
1363
|
+
# @return [Types::DefaultApplication]
|
1364
|
+
#
|
1365
|
+
# @!attribute [rw] description
|
1366
|
+
# A descriptive label for the stream group.
|
1367
|
+
# @return [String]
|
1368
|
+
#
|
1369
|
+
# @!attribute [rw] id
|
1370
|
+
# A unique ID value that is assigned to the resource when it's
|
1371
|
+
# created. Format example: `1AB2C3De4`.
|
1372
|
+
# @return [String]
|
1373
|
+
#
|
1374
|
+
# @!attribute [rw] last_updated_at
|
1375
|
+
# A timestamp that indicates when this resource was last updated.
|
1376
|
+
# Timestamps are expressed using in ISO8601 format, such as:
|
1377
|
+
# `2022-12-27T22:29:40+00:00` (UTC).
|
1378
|
+
# @return [Time]
|
1379
|
+
#
|
1380
|
+
# @!attribute [rw] location_states
|
1381
|
+
# This value is the set of locations, including their name, current
|
1382
|
+
# status, and capacities.
|
1383
|
+
#
|
1384
|
+
# A location can be in one of the following states:
|
1385
|
+
#
|
1386
|
+
# * **ACTIVATING**: Amazon GameLift Streams is preparing the location.
|
1387
|
+
# You cannot stream from, scale the capacity of, or remove this
|
1388
|
+
# location yet.
|
1389
|
+
#
|
1390
|
+
# * **ACTIVE**: The location is provisioned with initial capacity. You
|
1391
|
+
# can now stream from, scale the capacity of, or remove this
|
1392
|
+
# location.
|
1393
|
+
#
|
1394
|
+
# * **ERROR**: Amazon GameLift Streams failed to set up this location.
|
1395
|
+
# The StatusReason field describes the error. You can remove this
|
1396
|
+
# location and try to add it again.
|
1397
|
+
#
|
1398
|
+
# * **REMOVING**: Amazon GameLift Streams is working to remove this
|
1399
|
+
# location. It releases all provisioned capacity for this location
|
1400
|
+
# in this stream group.
|
1401
|
+
# @return [Array<Types::LocationState>]
|
1402
|
+
#
|
1403
|
+
# @!attribute [rw] status
|
1404
|
+
# The current status of the stream group resource. Possible statuses
|
1405
|
+
# include the following:
|
1406
|
+
#
|
1407
|
+
# * `ACTIVATING`: The stream group is deploying and isn't ready to
|
1408
|
+
# host streams.
|
1409
|
+
#
|
1410
|
+
# * `ACTIVE`: The stream group is ready to host streams.
|
1411
|
+
#
|
1412
|
+
# * `ACTIVE_WITH_ERRORS`: One or more locations in the stream group
|
1413
|
+
# are in an error state. Verify the details of individual locations
|
1414
|
+
# and remove any locations which are in error.
|
1415
|
+
#
|
1416
|
+
# * `ERROR`: An error occurred when the stream group deployed. See
|
1417
|
+
# `StatusReason` for more information.
|
1418
|
+
#
|
1419
|
+
# * `DELETING`: Amazon GameLift Streams is in the process of deleting
|
1420
|
+
# the stream group.
|
1421
|
+
#
|
1422
|
+
# * `UPDATING_LOCATIONS`: One or more locations in the stream group
|
1423
|
+
# are in the process of updating (either activating or deleting).
|
1424
|
+
# @return [String]
|
1425
|
+
#
|
1426
|
+
# @!attribute [rw] status_reason
|
1427
|
+
# A short description of the reason that the stream group is in
|
1428
|
+
# `ERROR` status. The possible reasons can be one of the following:
|
1429
|
+
#
|
1430
|
+
# * `internalError`: The request can't process right now bcause of an
|
1431
|
+
# issue with the server. Try again later. Reach out to the Amazon
|
1432
|
+
# GameLift Streams team for more help.
|
1433
|
+
#
|
1434
|
+
# * `noAvailableInstances`: Amazon GameLift Streams does not currently
|
1435
|
+
# have enough available On-Demand capacity to fulfill your request.
|
1436
|
+
# Wait a few minutes and retry the request as capacity can shift
|
1437
|
+
# frequently. You can also try to make the request using a different
|
1438
|
+
# stream class or in another region.
|
1439
|
+
# @return [String]
|
1440
|
+
#
|
1441
|
+
# @!attribute [rw] stream_class
|
1442
|
+
# The target stream quality for the stream group.
|
1443
|
+
#
|
1444
|
+
# A stream class can be one of the following:
|
1445
|
+
#
|
1446
|
+
# * <b> <code>gen5n_win2022</code> (NVIDIA, ultra)</b> Supports
|
1447
|
+
# applications with extremely high 3D scene complexity. Runs
|
1448
|
+
# applications on Microsoft Windows Server 2022 Base and supports
|
1449
|
+
# DirectX 12. Compatible with most Unreal Engine 5.x builds, 32-bit
|
1450
|
+
# applications, and anti-cheat technology. Uses NVIDIA A10G Tensor
|
1451
|
+
# GPU.
|
1452
|
+
#
|
1453
|
+
# * Reference resolution: 1080p
|
1454
|
+
#
|
1455
|
+
# * Reference frame rate: 60 fps
|
1456
|
+
#
|
1457
|
+
# * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
|
1458
|
+
#
|
1459
|
+
# * Tenancy: Supports 1 concurrent stream session
|
1460
|
+
# * <b> <code>gen5n_high</code> (NVIDIA, high)</b> Supports
|
1461
|
+
# applications with moderate to high 3D scene complexity. Uses
|
1462
|
+
# NVIDIA A10G Tensor GPU.
|
1463
|
+
#
|
1464
|
+
# * Reference resolution: 1080p
|
1465
|
+
#
|
1466
|
+
# * Reference frame rate: 60 fps
|
1467
|
+
#
|
1468
|
+
# * Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM
|
1469
|
+
#
|
1470
|
+
# * Tenancy: Supports up to 2 concurrent stream sessions
|
1471
|
+
# * <b> <code>gen5n_ultra</code> (NVIDIA, ultra)</b> Supports
|
1472
|
+
# applications with extremely high 3D scene complexity. Uses
|
1473
|
+
# dedicated NVIDIA A10G Tensor GPU.
|
1474
|
+
#
|
1475
|
+
# * Reference resolution: 1080p
|
1476
|
+
#
|
1477
|
+
# * Reference frame rate: 60 fps
|
1478
|
+
#
|
1479
|
+
# * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
|
1480
|
+
#
|
1481
|
+
# * Tenancy: Supports 1 concurrent stream session
|
1482
|
+
# * <b> <code>gen4n_win2022</code> (NVIDIA, ultra)</b> Supports
|
1483
|
+
# applications with extremely high 3D scene complexity. Runs
|
1484
|
+
# applications on Microsoft Windows Server 2022 Base and supports
|
1485
|
+
# DirectX 12. Compatible with most Unreal Engine 5.2 and 5.3 builds,
|
1486
|
+
# 32-bit applications, and anti-cheat technology. Uses NVIDIA T4
|
1487
|
+
# Tensor GPU.
|
1488
|
+
#
|
1489
|
+
# * Reference resolution: 1080p
|
1490
|
+
#
|
1491
|
+
# * Reference frame rate: 60 fps
|
1492
|
+
#
|
1493
|
+
# * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
|
1494
|
+
#
|
1495
|
+
# * Tenancy: Supports 1 concurrent stream session
|
1496
|
+
# * <b> <code>gen4n_high</code> (NVIDIA, high)</b> Supports
|
1497
|
+
# applications with moderate to high 3D scene complexity. Uses
|
1498
|
+
# NVIDIA T4 Tensor GPU.
|
1499
|
+
#
|
1500
|
+
# * Reference resolution: 1080p
|
1501
|
+
#
|
1502
|
+
# * Reference frame rate: 60 fps
|
1503
|
+
#
|
1504
|
+
# * Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM
|
1505
|
+
#
|
1506
|
+
# * Tenancy: Supports up to 2 concurrent stream sessions
|
1507
|
+
# * <b> <code>gen4n_ultra</code> (NVIDIA, ultra)</b> Supports
|
1508
|
+
# applications with high 3D scene complexity. Uses dedicated NVIDIA
|
1509
|
+
# T4 Tensor GPU.
|
1510
|
+
#
|
1511
|
+
# * Reference resolution: 1080p
|
1512
|
+
#
|
1513
|
+
# * Reference frame rate: 60 fps
|
1514
|
+
#
|
1515
|
+
# * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
|
1516
|
+
#
|
1517
|
+
# * Tenancy: Supports 1 concurrent stream session
|
1518
|
+
# @return [String]
|
1519
|
+
#
|
1520
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/GetStreamGroupOutput AWS API Documentation
|
1521
|
+
#
|
1522
|
+
class GetStreamGroupOutput < Struct.new(
|
1523
|
+
:arn,
|
1524
|
+
:associated_applications,
|
1525
|
+
:created_at,
|
1526
|
+
:default_application,
|
1527
|
+
:description,
|
1528
|
+
:id,
|
1529
|
+
:last_updated_at,
|
1530
|
+
:location_states,
|
1531
|
+
:status,
|
1532
|
+
:status_reason,
|
1533
|
+
:stream_class)
|
1534
|
+
SENSITIVE = []
|
1535
|
+
include Aws::Structure
|
1536
|
+
end
|
1537
|
+
|
1538
|
+
# @!attribute [rw] identifier
|
1539
|
+
# The stream group that runs this stream session.
|
1540
|
+
#
|
1541
|
+
# This value is an [Amazon Resource Name (ARN)][1] or ID that uniquely
|
1542
|
+
# identifies the stream group resource. Format example:
|
1543
|
+
# ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4`
|
1544
|
+
# or ID-`1AB2C3De4`.
|
1545
|
+
#
|
1546
|
+
#
|
1547
|
+
#
|
1548
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1549
|
+
# @return [String]
|
1550
|
+
#
|
1551
|
+
# @!attribute [rw] stream_session_identifier
|
1552
|
+
# An [Amazon Resource Name (ARN)][1] that uniquely identifies the
|
1553
|
+
# stream session resource. Format example: `1AB2C3De4`.
|
1554
|
+
#
|
1555
|
+
#
|
1556
|
+
#
|
1557
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1558
|
+
# @return [String]
|
1559
|
+
#
|
1560
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/GetStreamSessionInput AWS API Documentation
|
1561
|
+
#
|
1562
|
+
class GetStreamSessionInput < Struct.new(
|
1563
|
+
:identifier,
|
1564
|
+
:stream_session_identifier)
|
1565
|
+
SENSITIVE = []
|
1566
|
+
include Aws::Structure
|
1567
|
+
end
|
1568
|
+
|
1569
|
+
# @!attribute [rw] additional_environment_variables
|
1570
|
+
# A set of options that you can use to control the stream session
|
1571
|
+
# runtime environment, expressed as a set of key-value pairs. You can
|
1572
|
+
# use this to configure the application or stream session details. You
|
1573
|
+
# can also provide custom environment variables that Amazon GameLift
|
1574
|
+
# Streams passes to your game client.
|
1575
|
+
#
|
1576
|
+
# <note markdown="1"> If you want to debug your application with environment variables, we
|
1577
|
+
# recommend that you do so in a local environment outside of Amazon
|
1578
|
+
# GameLift Streams. For more information, refer to the Compatibility
|
1579
|
+
# Guidance in the troubleshooting section of the Developer Guide.
|
1580
|
+
#
|
1581
|
+
# </note>
|
1582
|
+
#
|
1583
|
+
# `AdditionalEnvironmentVariables` and `AdditionalLaunchArgs` have
|
1584
|
+
# similar purposes. `AdditionalEnvironmentVariables` passes data using
|
1585
|
+
# environment variables; while `AdditionalLaunchArgs` passes data
|
1586
|
+
# using command-line arguments.
|
1587
|
+
# @return [Hash<String,String>]
|
1588
|
+
#
|
1589
|
+
# @!attribute [rw] additional_launch_args
|
1590
|
+
# A list of CLI arguments that are sent to the streaming server when a
|
1591
|
+
# stream session launches. You can use this to configure the
|
1592
|
+
# application or stream session details. You can also provide custom
|
1593
|
+
# arguments that Amazon GameLift Streams passes to your game client.
|
1594
|
+
#
|
1595
|
+
# `AdditionalEnvironmentVariables` and `AdditionalLaunchArgs` have
|
1596
|
+
# similar purposes. `AdditionalEnvironmentVariables` passes data using
|
1597
|
+
# environment variables; while `AdditionalLaunchArgs` passes data
|
1598
|
+
# using command-line arguments.
|
1599
|
+
# @return [Array<String>]
|
1600
|
+
#
|
1601
|
+
# @!attribute [rw] application_arn
|
1602
|
+
# The application streaming in this session.
|
1603
|
+
#
|
1604
|
+
# This value is an [Amazon Resource Name (ARN)][1] that uniquely
|
1605
|
+
# identifies the application resource. Format example:
|
1606
|
+
# `arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6`.
|
1607
|
+
#
|
1608
|
+
#
|
1609
|
+
#
|
1610
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
1611
|
+
# @return [String]
|
1612
|
+
#
|
1613
|
+
# @!attribute [rw] arn
|
1614
|
+
# The Amazon Resource Name (ARN) assigned to the stream session
|
1615
|
+
# resource. When combined with the stream group ARN, this value
|
1616
|
+
# uniquely identifies it across all Amazon Web Services Regions.
|
1617
|
+
# Format is `arn:aws:gameliftstreams:[AWS Region]:[AWS
|
1618
|
+
# account]:streamsession/[resource ID]`.
|
1619
|
+
# @return [String]
|
1620
|
+
#
|
1621
|
+
# @!attribute [rw] connection_timeout_seconds
|
1622
|
+
# The maximum length of time (in seconds) that Amazon GameLift Streams
|
1623
|
+
# keeps the stream session open. At this point, Amazon GameLift
|
1624
|
+
# Streams ends the stream session regardless of any existing client
|
1625
|
+
# connections.
|
1626
|
+
# @return [Integer]
|
1627
|
+
#
|
1628
|
+
# @!attribute [rw] created_at
|
1629
|
+
# A timestamp that indicates when this resource was created.
|
1630
|
+
# Timestamps are expressed using in ISO8601 format, such as:
|
1631
|
+
# `2022-12-27T22:29:40+00:00` (UTC).
|
1632
|
+
# @return [Time]
|
1633
|
+
#
|
1634
|
+
# @!attribute [rw] description
|
1635
|
+
# A human-readable label for the stream session. You can update this
|
1636
|
+
# value at any time.
|
1637
|
+
# @return [String]
|
1638
|
+
#
|
1639
|
+
# @!attribute [rw] export_files_metadata
|
1640
|
+
# Provides details about the stream session's exported files.
|
1641
|
+
# @return [Types::ExportFilesMetadata]
|
1642
|
+
#
|
1643
|
+
# @!attribute [rw] last_updated_at
|
1644
|
+
# A timestamp that indicates when this resource was last updated.
|
1645
|
+
# Timestamps are expressed using in ISO8601 format, such as:
|
1646
|
+
# `2022-12-27T22:29:40+00:00` (UTC).
|
1647
|
+
# @return [Time]
|
1648
|
+
#
|
1649
|
+
# @!attribute [rw] location
|
1650
|
+
# The location where Amazon GameLift Streams is hosting the stream
|
1651
|
+
# session.
|
1652
|
+
#
|
1653
|
+
# A location's name. For example, `us-east-1`. For a complete list of
|
1654
|
+
# locations that Amazon GameLift Streams supports, see the Regions and
|
1655
|
+
# quotas section in the Amazon GameLift Streams Developer Guide .
|
1656
|
+
# @return [String]
|
1657
|
+
#
|
1658
|
+
# @!attribute [rw] log_file_location_uri
|
1659
|
+
# Access location for log files that your content generates during a
|
1660
|
+
# stream session. These log files are uploaded to cloud storage
|
1661
|
+
# location at the end of a stream session. The Amazon GameLift Streams
|
1662
|
+
# application resource defines which log files to upload.
|
1663
|
+
# @return [String]
|
1664
|
+
#
|
1665
|
+
# @!attribute [rw] protocol
|
1666
|
+
# The data transfer protocol in use with the stream session.
|
1667
|
+
# @return [String]
|
1668
|
+
#
|
1669
|
+
# @!attribute [rw] session_length_seconds
|
1670
|
+
# The length of time that Amazon GameLift Streams keeps the game
|
1671
|
+
# session open.
|
1672
|
+
# @return [Integer]
|
1673
|
+
#
|
1674
|
+
# @!attribute [rw] signal_request
|
1675
|
+
# The WebRTC ICE offer string that a client generates to initiate a
|
1676
|
+
# connection to the stream session.
|
1677
|
+
# @return [String]
|
1678
|
+
#
|
1679
|
+
# @!attribute [rw] signal_response
|
1680
|
+
# The WebRTC answer string that the stream server generates in
|
1681
|
+
# response to the `SignalRequest`.
|
1682
|
+
# @return [String]
|
1683
|
+
#
|
1684
|
+
# @!attribute [rw] status
|
1685
|
+
# The current status of the stream session. A stream session can host
|
1686
|
+
# clients when in `ACTIVE` status.
|
1687
|
+
# @return [String]
|
1688
|
+
#
|
1689
|
+
# @!attribute [rw] status_reason
|
1690
|
+
# A short description of the reason the stream session is in `ERROR`
|
1691
|
+
# status.
|
1692
|
+
# @return [String]
|
1693
|
+
#
|
1694
|
+
# @!attribute [rw] stream_group_id
|
1695
|
+
# The unique identifier for the Amazon GameLift Streams stream group
|
1696
|
+
# that is hosting the stream session.
|
1697
|
+
# @return [String]
|
1698
|
+
#
|
1699
|
+
# @!attribute [rw] user_id
|
1700
|
+
# An opaque, unique identifier for an end-user, defined by the
|
1701
|
+
# developer.
|
1702
|
+
# @return [String]
|
1703
|
+
#
|
1704
|
+
# @!attribute [rw] web_sdk_protocol_url
|
1705
|
+
# The URL of an S3 bucket that stores Amazon GameLift Streams WebSDK
|
1706
|
+
# files. The URL is used to establish connection with the client.
|
1707
|
+
# @return [String]
|
1708
|
+
#
|
1709
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/GetStreamSessionOutput AWS API Documentation
|
1710
|
+
#
|
1711
|
+
class GetStreamSessionOutput < Struct.new(
|
1712
|
+
:additional_environment_variables,
|
1713
|
+
:additional_launch_args,
|
1714
|
+
:application_arn,
|
1715
|
+
:arn,
|
1716
|
+
:connection_timeout_seconds,
|
1717
|
+
:created_at,
|
1718
|
+
:description,
|
1719
|
+
:export_files_metadata,
|
1720
|
+
:last_updated_at,
|
1721
|
+
:location,
|
1722
|
+
:log_file_location_uri,
|
1723
|
+
:protocol,
|
1724
|
+
:session_length_seconds,
|
1725
|
+
:signal_request,
|
1726
|
+
:signal_response,
|
1727
|
+
:status,
|
1728
|
+
:status_reason,
|
1729
|
+
:stream_group_id,
|
1730
|
+
:user_id,
|
1731
|
+
:web_sdk_protocol_url)
|
1732
|
+
SENSITIVE = [:signal_request, :signal_response]
|
1733
|
+
include Aws::Structure
|
1734
|
+
end
|
1735
|
+
|
1736
|
+
# The service encountered an internal error and is unable to complete
|
1737
|
+
# the request.
|
1738
|
+
#
|
1739
|
+
# @!attribute [rw] message
|
1740
|
+
# Description of the error.
|
1741
|
+
# @return [String]
|
1742
|
+
#
|
1743
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/InternalServerException AWS API Documentation
|
1744
|
+
#
|
1745
|
+
class InternalServerException < Struct.new(
|
1746
|
+
:message)
|
1747
|
+
SENSITIVE = []
|
1748
|
+
include Aws::Structure
|
1749
|
+
end
|
1750
|
+
|
1751
|
+
# @!attribute [rw] max_results
|
1752
|
+
# The number of results to return. Use this parameter with `NextToken`
|
1753
|
+
# to return results in sequential pages. Default value is `25`.
|
1754
|
+
# @return [Integer]
|
1755
|
+
#
|
1756
|
+
# @!attribute [rw] next_token
|
1757
|
+
# The token that marks the start of the next set of results. Use this
|
1758
|
+
# token when you retrieve results as sequential pages. To get the
|
1759
|
+
# first page of results, omit a token value. To get the remaining
|
1760
|
+
# pages, provide the token returned with the previous result set.
|
1761
|
+
# @return [String]
|
1762
|
+
#
|
1763
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/ListApplicationsInput AWS API Documentation
|
1764
|
+
#
|
1765
|
+
class ListApplicationsInput < Struct.new(
|
1766
|
+
:max_results,
|
1767
|
+
:next_token)
|
1768
|
+
SENSITIVE = []
|
1769
|
+
include Aws::Structure
|
1770
|
+
end
|
1771
|
+
|
1772
|
+
# @!attribute [rw] items
|
1773
|
+
# A collection of Amazon GameLift Streams applications that are
|
1774
|
+
# associated with the Amazon Web Services account in use. Each item
|
1775
|
+
# includes application metadata and status.
|
1776
|
+
# @return [Array<Types::ApplicationSummary>]
|
1777
|
+
#
|
1778
|
+
# @!attribute [rw] next_token
|
1779
|
+
# A token that marks the start of the next sequential page of results.
|
1780
|
+
# If an operation doesn't return a token, you've reached the end of
|
1781
|
+
# the list.
|
1782
|
+
# @return [String]
|
1783
|
+
#
|
1784
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/ListApplicationsOutput AWS API Documentation
|
1785
|
+
#
|
1786
|
+
class ListApplicationsOutput < Struct.new(
|
1787
|
+
:items,
|
1788
|
+
:next_token)
|
1789
|
+
SENSITIVE = []
|
1790
|
+
include Aws::Structure
|
1791
|
+
end
|
1792
|
+
|
1793
|
+
# @!attribute [rw] max_results
|
1794
|
+
# The number of results to return. Use this parameter with `NextToken`
|
1795
|
+
# to return results in sequential pages. Default value is `25`.
|
1796
|
+
# @return [Integer]
|
1797
|
+
#
|
1798
|
+
# @!attribute [rw] next_token
|
1799
|
+
# A token that marks the start of the next set of results. Use this
|
1800
|
+
# token when you retrieve results as sequential pages. To get the
|
1801
|
+
# first page of results, omit a token value. To get the remaining
|
1802
|
+
# pages, provide the token returned with the previous result set.
|
1803
|
+
# @return [String]
|
1804
|
+
#
|
1805
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/ListStreamGroupsInput AWS API Documentation
|
1806
|
+
#
|
1807
|
+
class ListStreamGroupsInput < Struct.new(
|
1808
|
+
:max_results,
|
1809
|
+
:next_token)
|
1810
|
+
SENSITIVE = []
|
1811
|
+
include Aws::Structure
|
1812
|
+
end
|
1813
|
+
|
1814
|
+
# @!attribute [rw] items
|
1815
|
+
# A collection of Amazon GameLift Streams stream groups that are
|
1816
|
+
# associated with the Amazon Web Services account in use. Each item
|
1817
|
+
# includes stream group metadata and status, but doesn't include
|
1818
|
+
# capacity information.
|
1819
|
+
# @return [Array<Types::StreamGroupSummary>]
|
1820
|
+
#
|
1821
|
+
# @!attribute [rw] next_token
|
1822
|
+
# A token that marks the start of the next sequential page of results.
|
1823
|
+
# If an operation doesn't return a token, you've reached the end of
|
1824
|
+
# the list.
|
1825
|
+
# @return [String]
|
1826
|
+
#
|
1827
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/ListStreamGroupsOutput AWS API Documentation
|
1828
|
+
#
|
1829
|
+
class ListStreamGroupsOutput < Struct.new(
|
1830
|
+
:items,
|
1831
|
+
:next_token)
|
1832
|
+
SENSITIVE = []
|
1833
|
+
include Aws::Structure
|
1834
|
+
end
|
1835
|
+
|
1836
|
+
# @!attribute [rw] export_files_status
|
1837
|
+
# Filter by the exported files status. You can specify one status in
|
1838
|
+
# each request to retrieve only sessions that currently have that
|
1839
|
+
# exported files status.
|
1840
|
+
# @return [String]
|
1841
|
+
#
|
1842
|
+
# @!attribute [rw] max_results
|
1843
|
+
# The number of results to return. Use this parameter with `NextToken`
|
1844
|
+
# to return results in sequential pages. Default value is `25`.
|
1845
|
+
# @return [Integer]
|
1846
|
+
#
|
1847
|
+
# @!attribute [rw] next_token
|
1848
|
+
# The token that marks the start of the next set of results. Use this
|
1849
|
+
# token when you retrieve results as sequential pages. To get the
|
1850
|
+
# first page of results, omit a token value. To get the remaining
|
1851
|
+
# pages, provide the token returned with the previous result set.
|
1852
|
+
# @return [String]
|
1853
|
+
#
|
1854
|
+
# @!attribute [rw] status
|
1855
|
+
# Filter by the stream session status. You can specify one status in
|
1856
|
+
# each request to retrieve only sessions that are currently in that
|
1857
|
+
# status.
|
1858
|
+
# @return [String]
|
1859
|
+
#
|
1860
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/ListStreamSessionsByAccountInput AWS API Documentation
|
1861
|
+
#
|
1862
|
+
class ListStreamSessionsByAccountInput < Struct.new(
|
1863
|
+
:export_files_status,
|
1864
|
+
:max_results,
|
1865
|
+
:next_token,
|
1866
|
+
:status)
|
1867
|
+
SENSITIVE = []
|
1868
|
+
include Aws::Structure
|
1869
|
+
end
|
1870
|
+
|
1871
|
+
# @!attribute [rw] items
|
1872
|
+
# A collection of Amazon GameLift Streams stream sessions that are
|
1873
|
+
# associated with a stream group and returned in response to a list
|
1874
|
+
# request. Each item includes stream session metadata and status.
|
1875
|
+
# @return [Array<Types::StreamSessionSummary>]
|
1876
|
+
#
|
1877
|
+
# @!attribute [rw] next_token
|
1878
|
+
# A token that marks the start of the next sequential page of results.
|
1879
|
+
# If an operation doesn't return a token, you've reached the end of
|
1880
|
+
# the list.
|
1881
|
+
# @return [String]
|
1882
|
+
#
|
1883
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/ListStreamSessionsByAccountOutput AWS API Documentation
|
1884
|
+
#
|
1885
|
+
class ListStreamSessionsByAccountOutput < Struct.new(
|
1886
|
+
:items,
|
1887
|
+
:next_token)
|
1888
|
+
SENSITIVE = []
|
1889
|
+
include Aws::Structure
|
1890
|
+
end
|
1891
|
+
|
1892
|
+
# @!attribute [rw] export_files_status
|
1893
|
+
# Filter by the exported files status. You can specify one status in
|
1894
|
+
# each request to retrieve only sessions that currently have that
|
1895
|
+
# exported files status.
|
1896
|
+
#
|
1897
|
+
# Exported files can be in one of the following states:
|
1898
|
+
#
|
1899
|
+
# * **SUCCEEDED**: The exported files are successfully stored in S3
|
1900
|
+
# bucket.
|
1901
|
+
#
|
1902
|
+
# * **FAILED**: The session ended but Amazon GameLift Streams
|
1903
|
+
# couldn't collect and upload the to S3.
|
1904
|
+
#
|
1905
|
+
# * **PENDING**: Either the stream session is still in progress, or
|
1906
|
+
# uploading the exported files to the S3 bucket is in progress.
|
1907
|
+
# @return [String]
|
1908
|
+
#
|
1909
|
+
# @!attribute [rw] identifier
|
1910
|
+
# The unique identifier of a Amazon GameLift Streams stream group to
|
1911
|
+
# retrieve the stream session for. You can use either the stream group
|
1912
|
+
# ID or the Amazon Resource Name (ARN).
|
1913
|
+
# @return [String]
|
1914
|
+
#
|
1915
|
+
# @!attribute [rw] max_results
|
1916
|
+
# The number of results to return. Use this parameter with `NextToken`
|
1917
|
+
# to return results in sequential pages. Default value is `25`.
|
1918
|
+
# @return [Integer]
|
1919
|
+
#
|
1920
|
+
# @!attribute [rw] next_token
|
1921
|
+
# The token that marks the start of the next set of results. Use this
|
1922
|
+
# token when you retrieve results as sequential pages. To get the
|
1923
|
+
# first page of results, omit a token value. To get the remaining
|
1924
|
+
# pages, provide the token returned with the previous result set.
|
1925
|
+
# @return [String]
|
1926
|
+
#
|
1927
|
+
# @!attribute [rw] status
|
1928
|
+
# Filter by the stream session status. You can specify one status in
|
1929
|
+
# each request to retrieve only sessions that are currently in that
|
1930
|
+
# status.
|
1931
|
+
# @return [String]
|
1932
|
+
#
|
1933
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/ListStreamSessionsInput AWS API Documentation
|
1934
|
+
#
|
1935
|
+
class ListStreamSessionsInput < Struct.new(
|
1936
|
+
:export_files_status,
|
1937
|
+
:identifier,
|
1938
|
+
:max_results,
|
1939
|
+
:next_token,
|
1940
|
+
:status)
|
1941
|
+
SENSITIVE = []
|
1942
|
+
include Aws::Structure
|
1943
|
+
end
|
1944
|
+
|
1945
|
+
# @!attribute [rw] items
|
1946
|
+
# A collection of Amazon GameLift Streams stream sessions that are
|
1947
|
+
# associated with a stream group and returned in response to a list
|
1948
|
+
# request. Each item includes stream session metadata and status.
|
1949
|
+
# @return [Array<Types::StreamSessionSummary>]
|
1950
|
+
#
|
1951
|
+
# @!attribute [rw] next_token
|
1952
|
+
# A token that marks the start of the next sequential page of results.
|
1953
|
+
# If an operation doesn't return a token, you've reached the end of
|
1954
|
+
# the list.
|
1955
|
+
# @return [String]
|
1956
|
+
#
|
1957
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/ListStreamSessionsOutput AWS API Documentation
|
1958
|
+
#
|
1959
|
+
class ListStreamSessionsOutput < Struct.new(
|
1960
|
+
:items,
|
1961
|
+
:next_token)
|
1962
|
+
SENSITIVE = []
|
1963
|
+
include Aws::Structure
|
1964
|
+
end
|
1965
|
+
|
1966
|
+
# @!attribute [rw] resource_arn
|
1967
|
+
# The ([Amazon Resource Name (ARN)][1] that you want to retrieve tags
|
1968
|
+
# for. To get a Amazon GameLift Streams resource ARN, call a List or
|
1969
|
+
# Get operation for the resource.
|
1970
|
+
#
|
1971
|
+
#
|
1972
|
+
#
|
1973
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
|
1974
|
+
# @return [String]
|
1975
|
+
#
|
1976
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/ListTagsForResourceRequest AWS API Documentation
|
1977
|
+
#
|
1978
|
+
class ListTagsForResourceRequest < Struct.new(
|
1979
|
+
:resource_arn)
|
1980
|
+
SENSITIVE = []
|
1981
|
+
include Aws::Structure
|
1982
|
+
end
|
1983
|
+
|
1984
|
+
# @!attribute [rw] tags
|
1985
|
+
# A collection of tags that have been assigned to the specified
|
1986
|
+
# resource.
|
1987
|
+
# @return [Hash<String,String>]
|
1988
|
+
#
|
1989
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/ListTagsForResourceResponse AWS API Documentation
|
1990
|
+
#
|
1991
|
+
class ListTagsForResourceResponse < Struct.new(
|
1992
|
+
:tags)
|
1993
|
+
SENSITIVE = []
|
1994
|
+
include Aws::Structure
|
1995
|
+
end
|
1996
|
+
|
1997
|
+
# Configuration settings that define a stream group's stream capacity
|
1998
|
+
# for a location. When configuring a location for the first time, you
|
1999
|
+
# must specify a numeric value for at least one of the two capacity
|
2000
|
+
# types. To update the capacity for an existing stream group, call
|
2001
|
+
# UpdateStreamGroup. To add a new location and specify its capacity,
|
2002
|
+
# call AddStreamGroupLocations.
|
2003
|
+
#
|
2004
|
+
# @!attribute [rw] always_on_capacity
|
2005
|
+
# The streaming capacity that is allocated and ready to handle stream
|
2006
|
+
# requests without delay. You pay for this capacity whether it's in
|
2007
|
+
# use or not. Best for quickest time from streaming request to
|
2008
|
+
# streaming session.
|
2009
|
+
# @return [Integer]
|
2010
|
+
#
|
2011
|
+
# @!attribute [rw] location_name
|
2012
|
+
# A location's name. For example, `us-east-1`. For a complete list of
|
2013
|
+
# locations that Amazon GameLift Streams supports, see the Regions and
|
2014
|
+
# quotas section in the Amazon GameLift Streams Developer Guide .
|
2015
|
+
# @return [String]
|
2016
|
+
#
|
2017
|
+
# @!attribute [rw] on_demand_capacity
|
2018
|
+
# The streaming capacity that Amazon GameLift Streams can allocate in
|
2019
|
+
# response to stream requests, and then de-allocate when the session
|
2020
|
+
# has terminated. This offers a cost control measure at the expense of
|
2021
|
+
# a greater startup time (typically under 5 minutes).
|
2022
|
+
# @return [Integer]
|
2023
|
+
#
|
2024
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/LocationConfiguration AWS API Documentation
|
2025
|
+
#
|
2026
|
+
class LocationConfiguration < Struct.new(
|
2027
|
+
:always_on_capacity,
|
2028
|
+
:location_name,
|
2029
|
+
:on_demand_capacity)
|
2030
|
+
SENSITIVE = []
|
2031
|
+
include Aws::Structure
|
2032
|
+
end
|
2033
|
+
|
2034
|
+
# Represents a location and its corresponding stream capacity and
|
2035
|
+
# status.
|
2036
|
+
#
|
2037
|
+
# @!attribute [rw] allocated_capacity
|
2038
|
+
# This value is the number of compute resources that a stream group
|
2039
|
+
# has provisioned and is ready to stream. It includes resources that
|
2040
|
+
# are currently streaming and resources that are idle and ready to
|
2041
|
+
# respond to stream requests.
|
2042
|
+
# @return [Integer]
|
2043
|
+
#
|
2044
|
+
# @!attribute [rw] always_on_capacity
|
2045
|
+
# The streaming capacity that is allocated and ready to handle stream
|
2046
|
+
# requests without delay. You pay for this capacity whether it's in
|
2047
|
+
# use or not. Best for quickest time from streaming request to
|
2048
|
+
# streaming session.
|
2049
|
+
# @return [Integer]
|
2050
|
+
#
|
2051
|
+
# @!attribute [rw] idle_capacity
|
2052
|
+
# This value is the amount of allocated capacity that is not currently
|
2053
|
+
# streaming. It represents the stream group's availability to respond
|
2054
|
+
# to new stream requests, but not including on-demand capacity.
|
2055
|
+
# @return [Integer]
|
2056
|
+
#
|
2057
|
+
# @!attribute [rw] location_name
|
2058
|
+
# A location's name. For example, `us-east-1`. For a complete list of
|
2059
|
+
# locations that Amazon GameLift Streams supports, see the Regions and
|
2060
|
+
# quotas section in the Amazon GameLift Streams Developer Guide .
|
2061
|
+
# @return [String]
|
2062
|
+
#
|
2063
|
+
# @!attribute [rw] on_demand_capacity
|
2064
|
+
# The streaming capacity that Amazon GameLift Streams can allocate in
|
2065
|
+
# response to stream requests, and then de-allocate when the session
|
2066
|
+
# has terminated. This offers a cost control measure at the expense of
|
2067
|
+
# a greater startup time (typically under 5 minutes).
|
2068
|
+
# @return [Integer]
|
2069
|
+
#
|
2070
|
+
# @!attribute [rw] requested_capacity
|
2071
|
+
# This value is the total number of compute resources that you request
|
2072
|
+
# for a stream group. This includes resources that Amazon GameLift
|
2073
|
+
# Streams has either already provisioned or is working to provision.
|
2074
|
+
# You request capacity for each location in a stream group.
|
2075
|
+
# @return [Integer]
|
2076
|
+
#
|
2077
|
+
# @!attribute [rw] status
|
2078
|
+
# This value is set of locations, including their name, current
|
2079
|
+
# status, and capacities.
|
2080
|
+
#
|
2081
|
+
# A location can be in one of the following states:
|
2082
|
+
#
|
2083
|
+
# * **ACTIVATING**: Amazon GameLift Streams is preparing the location.
|
2084
|
+
# You cannot stream from, scale the capacity of, or remove this
|
2085
|
+
# location yet.
|
2086
|
+
#
|
2087
|
+
# * **ACTIVE**: The location is provisioned with initial capacity. You
|
2088
|
+
# can now stream from, scale the capacity of, or remove this
|
2089
|
+
# location.
|
2090
|
+
#
|
2091
|
+
# * **ERROR**: Amazon GameLift Streams failed to set up this location.
|
2092
|
+
# The StatusReason field describes the error. You can remove this
|
2093
|
+
# location and try to add it again.
|
2094
|
+
#
|
2095
|
+
# * **REMOVING**: Amazon GameLift Streams is working to remove this
|
2096
|
+
# location. It releases all provisioned capacity for this location
|
2097
|
+
# in this stream group.
|
2098
|
+
# @return [String]
|
2099
|
+
#
|
2100
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/LocationState AWS API Documentation
|
2101
|
+
#
|
2102
|
+
class LocationState < Struct.new(
|
2103
|
+
:allocated_capacity,
|
2104
|
+
:always_on_capacity,
|
2105
|
+
:idle_capacity,
|
2106
|
+
:location_name,
|
2107
|
+
:on_demand_capacity,
|
2108
|
+
:requested_capacity,
|
2109
|
+
:status)
|
2110
|
+
SENSITIVE = []
|
2111
|
+
include Aws::Structure
|
2112
|
+
end
|
2113
|
+
|
2114
|
+
# @!attribute [rw] identifier
|
2115
|
+
# A stream group to remove the specified locations from.
|
2116
|
+
#
|
2117
|
+
# This value is a Amazon Resource Name (ARN) that uniquely identifies
|
2118
|
+
# the stream group resource. Format example: `1AB2C3De4`. </p>
|
2119
|
+
# @return [String]
|
2120
|
+
#
|
2121
|
+
# @!attribute [rw] locations
|
2122
|
+
# A set of locations to remove this stream group.
|
2123
|
+
#
|
2124
|
+
# A set of location names. For example, `us-east-1`. For a complete
|
2125
|
+
# list of locations that Amazon GameLift Streams supports, see the
|
2126
|
+
# Regions and quotas section in the Amazon GameLift Streams Developer
|
2127
|
+
# Guide . </p>
|
2128
|
+
# @return [Array<String>]
|
2129
|
+
#
|
2130
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/RemoveStreamGroupLocationsInput AWS API Documentation
|
2131
|
+
#
|
2132
|
+
class RemoveStreamGroupLocationsInput < Struct.new(
|
2133
|
+
:identifier,
|
2134
|
+
:locations)
|
2135
|
+
SENSITIVE = []
|
2136
|
+
include Aws::Structure
|
2137
|
+
end
|
2138
|
+
|
2139
|
+
# Represents the status of the replication of an application to a
|
2140
|
+
# location. An application cannot be streamed from a location until it
|
2141
|
+
# has finished replicating there.
|
2142
|
+
#
|
2143
|
+
# @!attribute [rw] location
|
2144
|
+
# A location's name. For example, `us-east-1`. For a complete list of
|
2145
|
+
# locations that Amazon GameLift Streams supports, see the Regions and
|
2146
|
+
# quotas section in the Amazon GameLift Streams Developer Guide .
|
2147
|
+
# @return [String]
|
2148
|
+
#
|
2149
|
+
# @!attribute [rw] status
|
2150
|
+
# The current status of the replication process.
|
2151
|
+
# @return [String]
|
2152
|
+
#
|
2153
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/ReplicationStatus AWS API Documentation
|
2154
|
+
#
|
2155
|
+
class ReplicationStatus < Struct.new(
|
2156
|
+
:location,
|
2157
|
+
:status)
|
2158
|
+
SENSITIVE = []
|
2159
|
+
include Aws::Structure
|
2160
|
+
end
|
2161
|
+
|
2162
|
+
# The resource specified in the request was not found. Correct the
|
2163
|
+
# request before you try again.
|
2164
|
+
#
|
2165
|
+
# @!attribute [rw] message
|
2166
|
+
# Description of the error.
|
2167
|
+
# @return [String]
|
2168
|
+
#
|
2169
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/ResourceNotFoundException AWS API Documentation
|
2170
|
+
#
|
2171
|
+
class ResourceNotFoundException < Struct.new(
|
2172
|
+
:message)
|
2173
|
+
SENSITIVE = []
|
2174
|
+
include Aws::Structure
|
2175
|
+
end
|
2176
|
+
|
2177
|
+
# Configuration settings that identify the operating system for an
|
2178
|
+
# application resource. This can also include a compatibility layer and
|
2179
|
+
# other drivers.
|
2180
|
+
#
|
2181
|
+
# A runtime environment can be one of the following:
|
2182
|
+
#
|
2183
|
+
# * For Linux applications
|
2184
|
+
#
|
2185
|
+
# * Ubuntu 22.04 LTS(`Type=UBUNTU, Version=22_04_LTS`)
|
2186
|
+
#
|
2187
|
+
# ^
|
2188
|
+
# * For Windows applications
|
2189
|
+
#
|
2190
|
+
# * Microsoft Windows Server 2022 Base (`Type=WINDOWS, Version=2022`)
|
2191
|
+
#
|
2192
|
+
# * Proton 8.0-5 (`Type=PROTON, Version=20241007`)
|
2193
|
+
#
|
2194
|
+
# * Proton 8.0-2c (`Type=PROTON, Version=20230704`)
|
2195
|
+
#
|
2196
|
+
# @!attribute [rw] type
|
2197
|
+
# The operating system and other drivers. For Proton, this also
|
2198
|
+
# includes the Proton compatibility layer.
|
2199
|
+
# @return [String]
|
2200
|
+
#
|
2201
|
+
# @!attribute [rw] version
|
2202
|
+
# Versioned container environment for the application operating
|
2203
|
+
# system.
|
2204
|
+
# @return [String]
|
2205
|
+
#
|
2206
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/RuntimeEnvironment AWS API Documentation
|
2207
|
+
#
|
2208
|
+
class RuntimeEnvironment < Struct.new(
|
2209
|
+
:type,
|
2210
|
+
:version)
|
2211
|
+
SENSITIVE = []
|
2212
|
+
include Aws::Structure
|
2213
|
+
end
|
2214
|
+
|
2215
|
+
# The request would cause the resource to exceed an allowed service
|
2216
|
+
# quota. Resolve the issue before you try again.
|
2217
|
+
#
|
2218
|
+
# @!attribute [rw] message
|
2219
|
+
# Description of the error.
|
2220
|
+
# @return [String]
|
2221
|
+
#
|
2222
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/ServiceQuotaExceededException AWS API Documentation
|
2223
|
+
#
|
2224
|
+
class ServiceQuotaExceededException < Struct.new(
|
2225
|
+
:message)
|
2226
|
+
SENSITIVE = []
|
2227
|
+
include Aws::Structure
|
2228
|
+
end
|
2229
|
+
|
2230
|
+
# @!attribute [rw] additional_environment_variables
|
2231
|
+
# A set of options that you can use to control the stream session
|
2232
|
+
# runtime environment, expressed as a set of key-value pairs. You can
|
2233
|
+
# use this to configure the application or stream session details. You
|
2234
|
+
# can also provide custom environment variables that Amazon GameLift
|
2235
|
+
# Streams passes to your game client.
|
2236
|
+
#
|
2237
|
+
# <note markdown="1"> If you want to debug your application with environment variables, we
|
2238
|
+
# recommend that you do so in a local environment outside of Amazon
|
2239
|
+
# GameLift Streams. For more information, refer to the Compatibility
|
2240
|
+
# Guidance in the troubleshooting section of the Developer Guide.
|
2241
|
+
#
|
2242
|
+
# </note>
|
2243
|
+
#
|
2244
|
+
# `AdditionalEnvironmentVariables` and `AdditionalLaunchArgs` have
|
2245
|
+
# similar purposes. `AdditionalEnvironmentVariables` passes data using
|
2246
|
+
# environment variables; while `AdditionalLaunchArgs` passes data
|
2247
|
+
# using command-line arguments.
|
2248
|
+
# @return [Hash<String,String>]
|
2249
|
+
#
|
2250
|
+
# @!attribute [rw] additional_launch_args
|
2251
|
+
# A list of CLI arguments that are sent to the streaming server when a
|
2252
|
+
# stream session launches. You can use this to configure the
|
2253
|
+
# application or stream session details. You can also provide custom
|
2254
|
+
# arguments that Amazon GameLift Streams passes to your game client.
|
2255
|
+
#
|
2256
|
+
# `AdditionalEnvironmentVariables` and `AdditionalLaunchArgs` have
|
2257
|
+
# similar purposes. `AdditionalEnvironmentVariables` passes data using
|
2258
|
+
# environment variables; while `AdditionalLaunchArgs` passes data
|
2259
|
+
# using command-line arguments.
|
2260
|
+
# @return [Array<String>]
|
2261
|
+
#
|
2262
|
+
# @!attribute [rw] application_identifier
|
2263
|
+
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies
|
2264
|
+
# the application resource. Format example:
|
2265
|
+
# ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6`
|
2266
|
+
# or ID-`9ZY8X7Wv6`.
|
2267
|
+
#
|
2268
|
+
#
|
2269
|
+
#
|
2270
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
2271
|
+
# @return [String]
|
2272
|
+
#
|
2273
|
+
# @!attribute [rw] client_token
|
2274
|
+
# A unique identifier that represents a client request. The request is
|
2275
|
+
# idempotent, which ensures that an API request completes only once.
|
2276
|
+
# When users send a request, Amazon GameLift Streams automatically
|
2277
|
+
# populates this field.
|
2278
|
+
#
|
2279
|
+
# **A suitable default value is auto-generated.** You should normally
|
2280
|
+
# not need to pass this option.
|
2281
|
+
# @return [String]
|
2282
|
+
#
|
2283
|
+
# @!attribute [rw] connection_timeout_seconds
|
2284
|
+
# Length of time (in seconds) that Amazon GameLift Streams should wait
|
2285
|
+
# for a client to connect to the stream session. This time span starts
|
2286
|
+
# when the stream session reaches `ACTIVE` status. If no client
|
2287
|
+
# connects before the timeout, Amazon GameLift Streams stops the
|
2288
|
+
# stream session with status of `TERMINATED`. Default value is 120.
|
2289
|
+
# @return [Integer]
|
2290
|
+
#
|
2291
|
+
# @!attribute [rw] description
|
2292
|
+
# A human-readable label for the stream session. You can update this
|
2293
|
+
# value later.
|
2294
|
+
# @return [String]
|
2295
|
+
#
|
2296
|
+
# @!attribute [rw] identifier
|
2297
|
+
# The stream group to run this stream session with.
|
2298
|
+
#
|
2299
|
+
# This value is an [Amazon Resource Name (ARN)][1] or ID that uniquely
|
2300
|
+
# identifies the stream group resource. Format example:
|
2301
|
+
# ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4`
|
2302
|
+
# or ID-`1AB2C3De4`.
|
2303
|
+
#
|
2304
|
+
#
|
2305
|
+
#
|
2306
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
2307
|
+
# @return [String]
|
2308
|
+
#
|
2309
|
+
# @!attribute [rw] locations
|
2310
|
+
# A list of locations, in order of priority, where you want Amazon
|
2311
|
+
# GameLift Streams to start a stream from. Amazon GameLift Streams
|
2312
|
+
# selects the location with the next available capacity to start a
|
2313
|
+
# single stream session in. If this value is empty, Amazon GameLift
|
2314
|
+
# Streams attempts to start a stream session in the primary location.
|
2315
|
+
#
|
2316
|
+
# This value is A set of location names. For example, `us-east-1`. For
|
2317
|
+
# a complete list of locations that Amazon GameLift Streams supports,
|
2318
|
+
# see the Regions and quotas section in the Amazon GameLift Streams
|
2319
|
+
# Developer Guide . </p>
|
2320
|
+
# @return [Array<String>]
|
2321
|
+
#
|
2322
|
+
# @!attribute [rw] protocol
|
2323
|
+
# The data transport protocol to use for the stream session.
|
2324
|
+
# @return [String]
|
2325
|
+
#
|
2326
|
+
# @!attribute [rw] session_length_seconds
|
2327
|
+
# The maximum length of time (in seconds) that Amazon GameLift Streams
|
2328
|
+
# keeps the stream session open. At this point, Amazon GameLift
|
2329
|
+
# Streams ends the stream session regardless of any existing client
|
2330
|
+
# connections. Default value is 43200.
|
2331
|
+
# @return [Integer]
|
2332
|
+
#
|
2333
|
+
# @!attribute [rw] signal_request
|
2334
|
+
# A WebRTC ICE offer string to use when initializing a WebRTC
|
2335
|
+
# connection. The offer is a very long JSON string. Provide the string
|
2336
|
+
# as a text value in quotes.
|
2337
|
+
# @return [String]
|
2338
|
+
#
|
2339
|
+
# @!attribute [rw] user_id
|
2340
|
+
# An opaque, unique identifier for an end-user, defined by the
|
2341
|
+
# developer.
|
2342
|
+
# @return [String]
|
2343
|
+
#
|
2344
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/StartStreamSessionInput AWS API Documentation
|
2345
|
+
#
|
2346
|
+
class StartStreamSessionInput < Struct.new(
|
2347
|
+
:additional_environment_variables,
|
2348
|
+
:additional_launch_args,
|
2349
|
+
:application_identifier,
|
2350
|
+
:client_token,
|
2351
|
+
:connection_timeout_seconds,
|
2352
|
+
:description,
|
2353
|
+
:identifier,
|
2354
|
+
:locations,
|
2355
|
+
:protocol,
|
2356
|
+
:session_length_seconds,
|
2357
|
+
:signal_request,
|
2358
|
+
:user_id)
|
2359
|
+
SENSITIVE = [:signal_request]
|
2360
|
+
include Aws::Structure
|
2361
|
+
end
|
2362
|
+
|
2363
|
+
# @!attribute [rw] additional_environment_variables
|
2364
|
+
# A set of options that you can use to control the stream session
|
2365
|
+
# runtime environment, expressed as a set of key-value pairs. You can
|
2366
|
+
# use this to configure the application or stream session details. You
|
2367
|
+
# can also provide custom environment variables that Amazon GameLift
|
2368
|
+
# Streams passes to your game client.
|
2369
|
+
#
|
2370
|
+
# <note markdown="1"> If you want to debug your application with environment variables, we
|
2371
|
+
# recommend that you do so in a local environment outside of Amazon
|
2372
|
+
# GameLift Streams. For more information, refer to the Compatibility
|
2373
|
+
# Guidance in the troubleshooting section of the Developer Guide.
|
2374
|
+
#
|
2375
|
+
# </note>
|
2376
|
+
#
|
2377
|
+
# `AdditionalEnvironmentVariables` and `AdditionalLaunchArgs` have
|
2378
|
+
# similar purposes. `AdditionalEnvironmentVariables` passes data using
|
2379
|
+
# environment variables; while `AdditionalLaunchArgs` passes data
|
2380
|
+
# using command-line arguments.
|
2381
|
+
# @return [Hash<String,String>]
|
2382
|
+
#
|
2383
|
+
# @!attribute [rw] additional_launch_args
|
2384
|
+
# A list of CLI arguments that are sent to the streaming server when a
|
2385
|
+
# stream session launches. You can use this to configure the
|
2386
|
+
# application or stream session details. You can also provide custom
|
2387
|
+
# arguments that Amazon GameLift Streams passes to your game client.
|
2388
|
+
#
|
2389
|
+
# `AdditionalEnvironmentVariables` and `AdditionalLaunchArgs` have
|
2390
|
+
# similar purposes. `AdditionalEnvironmentVariables` passes data using
|
2391
|
+
# environment variables; while `AdditionalLaunchArgs` passes data
|
2392
|
+
# using command-line arguments.
|
2393
|
+
# @return [Array<String>]
|
2394
|
+
#
|
2395
|
+
# @!attribute [rw] application_arn
|
2396
|
+
# An [Amazon Resource Name (ARN)][1] that uniquely identifies the
|
2397
|
+
# application resource. Format example:
|
2398
|
+
# `arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6`.
|
2399
|
+
#
|
2400
|
+
#
|
2401
|
+
#
|
2402
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
2403
|
+
# @return [String]
|
2404
|
+
#
|
2405
|
+
# @!attribute [rw] arn
|
2406
|
+
# The Amazon Resource Name (ARN) assigned to the stream session
|
2407
|
+
# resource. When combined with the stream group ARN, this value
|
2408
|
+
# uniquely identifies it across all Amazon Web Services Regions.
|
2409
|
+
# Format is `arn:aws:gameliftstreams:[AWS Region]:[AWS
|
2410
|
+
# account]:streamsession/[resource ID]`.
|
2411
|
+
# @return [String]
|
2412
|
+
#
|
2413
|
+
# @!attribute [rw] connection_timeout_seconds
|
2414
|
+
# The maximum length of time (in seconds) that Amazon GameLift Streams
|
2415
|
+
# keeps the stream session open. At this point, Amazon GameLift
|
2416
|
+
# Streams ends the stream session regardless of any existing client
|
2417
|
+
# connections.
|
2418
|
+
# @return [Integer]
|
2419
|
+
#
|
2420
|
+
# @!attribute [rw] created_at
|
2421
|
+
# A timestamp that indicates when this resource was created.
|
2422
|
+
# Timestamps are expressed using in ISO8601 format, such as:
|
2423
|
+
# `2022-12-27T22:29:40+00:00` (UTC).
|
2424
|
+
# @return [Time]
|
2425
|
+
#
|
2426
|
+
# @!attribute [rw] description
|
2427
|
+
# A human-readable label for the stream session. You can update this
|
2428
|
+
# value at any time.
|
2429
|
+
# @return [String]
|
2430
|
+
#
|
2431
|
+
# @!attribute [rw] export_files_metadata
|
2432
|
+
# Provides details about the stream session's exported files.
|
2433
|
+
# @return [Types::ExportFilesMetadata]
|
2434
|
+
#
|
2435
|
+
# @!attribute [rw] last_updated_at
|
2436
|
+
# A timestamp that indicates when this resource was last updated.
|
2437
|
+
# Timestamps are expressed using in ISO8601 format, such as:
|
2438
|
+
# `2022-12-27T22:29:40+00:00` (UTC).
|
2439
|
+
# @return [Time]
|
2440
|
+
#
|
2441
|
+
# @!attribute [rw] location
|
2442
|
+
# The location where Amazon GameLift Streams is streaming your
|
2443
|
+
# application from.
|
2444
|
+
#
|
2445
|
+
# A location's name. For example, `us-east-1`. For a complete list of
|
2446
|
+
# locations that Amazon GameLift Streams supports, see the Regions and
|
2447
|
+
# quotas section in the Amazon GameLift Streams Developer Guide .
|
2448
|
+
# @return [String]
|
2449
|
+
#
|
2450
|
+
# @!attribute [rw] log_file_location_uri
|
2451
|
+
# Access location for log files that your content generates during a
|
2452
|
+
# stream session. These log files are uploaded to cloud storage
|
2453
|
+
# location at the end of a stream session. The Amazon GameLift Streams
|
2454
|
+
# application resource defines which log files to upload.
|
2455
|
+
# @return [String]
|
2456
|
+
#
|
2457
|
+
# @!attribute [rw] protocol
|
2458
|
+
# The data transfer protocol in use with the stream session.
|
2459
|
+
# @return [String]
|
2460
|
+
#
|
2461
|
+
# @!attribute [rw] session_length_seconds
|
2462
|
+
# The length of time that Amazon GameLift Streams keeps the game
|
2463
|
+
# session open.
|
2464
|
+
# @return [Integer]
|
2465
|
+
#
|
2466
|
+
# @!attribute [rw] signal_request
|
2467
|
+
# The WebRTC ICE offer string that a client generates to initiate a
|
2468
|
+
# connection to the stream session.
|
2469
|
+
# @return [String]
|
2470
|
+
#
|
2471
|
+
# @!attribute [rw] signal_response
|
2472
|
+
# The WebRTC answer string that the stream server generates in
|
2473
|
+
# response to the `SignalRequest`.
|
2474
|
+
# @return [String]
|
2475
|
+
#
|
2476
|
+
# @!attribute [rw] status
|
2477
|
+
# The current status of the stream session. A stream session can host
|
2478
|
+
# clients when in `ACTIVE` status.
|
2479
|
+
# @return [String]
|
2480
|
+
#
|
2481
|
+
# @!attribute [rw] status_reason
|
2482
|
+
# A short description of the reason the stream session is in `ERROR`
|
2483
|
+
# status.
|
2484
|
+
# @return [String]
|
2485
|
+
#
|
2486
|
+
# @!attribute [rw] stream_group_id
|
2487
|
+
# The unique identifier for the Amazon GameLift Streams stream group
|
2488
|
+
# that is hosting the stream session.
|
2489
|
+
# @return [String]
|
2490
|
+
#
|
2491
|
+
# @!attribute [rw] user_id
|
2492
|
+
# An opaque, unique identifier for an end-user, defined by the
|
2493
|
+
# developer.
|
2494
|
+
# @return [String]
|
2495
|
+
#
|
2496
|
+
# @!attribute [rw] web_sdk_protocol_url
|
2497
|
+
# The URL of an S3 bucket that stores Amazon GameLift Streams WebSDK
|
2498
|
+
# files. The URL is used to establish connection with the client.
|
2499
|
+
# @return [String]
|
2500
|
+
#
|
2501
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/StartStreamSessionOutput AWS API Documentation
|
2502
|
+
#
|
2503
|
+
class StartStreamSessionOutput < Struct.new(
|
2504
|
+
:additional_environment_variables,
|
2505
|
+
:additional_launch_args,
|
2506
|
+
:application_arn,
|
2507
|
+
:arn,
|
2508
|
+
:connection_timeout_seconds,
|
2509
|
+
:created_at,
|
2510
|
+
:description,
|
2511
|
+
:export_files_metadata,
|
2512
|
+
:last_updated_at,
|
2513
|
+
:location,
|
2514
|
+
:log_file_location_uri,
|
2515
|
+
:protocol,
|
2516
|
+
:session_length_seconds,
|
2517
|
+
:signal_request,
|
2518
|
+
:signal_response,
|
2519
|
+
:status,
|
2520
|
+
:status_reason,
|
2521
|
+
:stream_group_id,
|
2522
|
+
:user_id,
|
2523
|
+
:web_sdk_protocol_url)
|
2524
|
+
SENSITIVE = [:signal_request, :signal_response]
|
2525
|
+
include Aws::Structure
|
2526
|
+
end
|
2527
|
+
|
2528
|
+
# Describes a Amazon GameLift Streams stream group resource for hosting
|
2529
|
+
# content streams. To retrieve additional stream group details, call
|
2530
|
+
# GetStreamGroup.
|
2531
|
+
#
|
2532
|
+
# @!attribute [rw] arn
|
2533
|
+
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies
|
2534
|
+
# the stream group resource. Format example:
|
2535
|
+
# ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4`
|
2536
|
+
# or ID-`1AB2C3De4`.
|
2537
|
+
#
|
2538
|
+
#
|
2539
|
+
#
|
2540
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
2541
|
+
# @return [String]
|
2542
|
+
#
|
2543
|
+
# @!attribute [rw] created_at
|
2544
|
+
# A timestamp that indicates when this resource was created.
|
2545
|
+
# Timestamps are expressed using in ISO8601 format, such as:
|
2546
|
+
# `2022-12-27T22:29:40+00:00` (UTC).
|
2547
|
+
# @return [Time]
|
2548
|
+
#
|
2549
|
+
# @!attribute [rw] default_application
|
2550
|
+
# Object that identifies the Amazon GameLift Streams application to
|
2551
|
+
# stream with this stream group.
|
2552
|
+
# @return [Types::DefaultApplication]
|
2553
|
+
#
|
2554
|
+
# @!attribute [rw] description
|
2555
|
+
# A descriptive label for the stream group.
|
2556
|
+
# @return [String]
|
2557
|
+
#
|
2558
|
+
# @!attribute [rw] id
|
2559
|
+
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies
|
2560
|
+
# the stream group resource. Format example:
|
2561
|
+
# ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4`
|
2562
|
+
# or ID-`1AB2C3De4`.
|
2563
|
+
#
|
2564
|
+
#
|
2565
|
+
#
|
2566
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
2567
|
+
# @return [String]
|
2568
|
+
#
|
2569
|
+
# @!attribute [rw] last_updated_at
|
2570
|
+
# A timestamp that indicates when this resource was last updated.
|
2571
|
+
# Timestamps are expressed using in ISO8601 format, such as:
|
2572
|
+
# `2022-12-27T22:29:40+00:00` (UTC).
|
2573
|
+
# @return [Time]
|
2574
|
+
#
|
2575
|
+
# @!attribute [rw] status
|
2576
|
+
# The current status of the stream group resource. Possible statuses
|
2577
|
+
# include the following:
|
2578
|
+
#
|
2579
|
+
# * `ACTIVATING`: The stream group is deploying and isn't ready to
|
2580
|
+
# host streams.
|
2581
|
+
#
|
2582
|
+
# * `ACTIVE`: The stream group is ready to host streams.
|
2583
|
+
#
|
2584
|
+
# * `ACTIVE_WITH_ERRORS`: One or more locations in the stream group
|
2585
|
+
# are in an error state. Verify the details of individual locations
|
2586
|
+
# and remove any locations which are in error.
|
2587
|
+
#
|
2588
|
+
# * `ERROR`: An error occurred when the stream group deployed. See
|
2589
|
+
# `StatusReason` for more information.
|
2590
|
+
#
|
2591
|
+
# * `DELETING`: Amazon GameLift Streams is in the process of deleting
|
2592
|
+
# the stream group.
|
2593
|
+
#
|
2594
|
+
# * `UPDATING_LOCATIONS`: One or more locations in the stream group
|
2595
|
+
# are in the process of updating (either activating or deleting).
|
2596
|
+
# @return [String]
|
2597
|
+
#
|
2598
|
+
# @!attribute [rw] stream_class
|
2599
|
+
# The target stream quality for the stream group.
|
2600
|
+
#
|
2601
|
+
# A stream class can be one of the following:
|
2602
|
+
#
|
2603
|
+
# * <b> <code>gen5n_win2022</code> (NVIDIA, ultra)</b> Supports
|
2604
|
+
# applications with extremely high 3D scene complexity. Runs
|
2605
|
+
# applications on Microsoft Windows Server 2022 Base and supports
|
2606
|
+
# DirectX 12. Compatible with most Unreal Engine 5.x builds, 32-bit
|
2607
|
+
# applications, and anti-cheat technology. Uses NVIDIA A10G Tensor
|
2608
|
+
# GPU.
|
2609
|
+
#
|
2610
|
+
# * Reference resolution: 1080p
|
2611
|
+
#
|
2612
|
+
# * Reference frame rate: 60 fps
|
2613
|
+
#
|
2614
|
+
# * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
|
2615
|
+
#
|
2616
|
+
# * Tenancy: Supports 1 concurrent stream session
|
2617
|
+
# * <b> <code>gen5n_high</code> (NVIDIA, high)</b> Supports
|
2618
|
+
# applications with moderate to high 3D scene complexity. Uses
|
2619
|
+
# NVIDIA A10G Tensor GPU.
|
2620
|
+
#
|
2621
|
+
# * Reference resolution: 1080p
|
2622
|
+
#
|
2623
|
+
# * Reference frame rate: 60 fps
|
2624
|
+
#
|
2625
|
+
# * Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM
|
2626
|
+
#
|
2627
|
+
# * Tenancy: Supports up to 2 concurrent stream sessions
|
2628
|
+
# * <b> <code>gen5n_ultra</code> (NVIDIA, ultra)</b> Supports
|
2629
|
+
# applications with extremely high 3D scene complexity. Uses
|
2630
|
+
# dedicated NVIDIA A10G Tensor GPU.
|
2631
|
+
#
|
2632
|
+
# * Reference resolution: 1080p
|
2633
|
+
#
|
2634
|
+
# * Reference frame rate: 60 fps
|
2635
|
+
#
|
2636
|
+
# * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
|
2637
|
+
#
|
2638
|
+
# * Tenancy: Supports 1 concurrent stream session
|
2639
|
+
# * <b> <code>gen4n_win2022</code> (NVIDIA, ultra)</b> Supports
|
2640
|
+
# applications with extremely high 3D scene complexity. Runs
|
2641
|
+
# applications on Microsoft Windows Server 2022 Base and supports
|
2642
|
+
# DirectX 12. Compatible with most Unreal Engine 5.2 and 5.3 builds,
|
2643
|
+
# 32-bit applications, and anti-cheat technology. Uses NVIDIA T4
|
2644
|
+
# Tensor GPU.
|
2645
|
+
#
|
2646
|
+
# * Reference resolution: 1080p
|
2647
|
+
#
|
2648
|
+
# * Reference frame rate: 60 fps
|
2649
|
+
#
|
2650
|
+
# * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
|
2651
|
+
#
|
2652
|
+
# * Tenancy: Supports 1 concurrent stream session
|
2653
|
+
# * <b> <code>gen4n_high</code> (NVIDIA, high)</b> Supports
|
2654
|
+
# applications with moderate to high 3D scene complexity. Uses
|
2655
|
+
# NVIDIA T4 Tensor GPU.
|
2656
|
+
#
|
2657
|
+
# * Reference resolution: 1080p
|
2658
|
+
#
|
2659
|
+
# * Reference frame rate: 60 fps
|
2660
|
+
#
|
2661
|
+
# * Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM
|
2662
|
+
#
|
2663
|
+
# * Tenancy: Supports up to 2 concurrent stream sessions
|
2664
|
+
# * <b> <code>gen4n_ultra</code> (NVIDIA, ultra)</b> Supports
|
2665
|
+
# applications with high 3D scene complexity. Uses dedicated NVIDIA
|
2666
|
+
# T4 Tensor GPU.
|
2667
|
+
#
|
2668
|
+
# * Reference resolution: 1080p
|
2669
|
+
#
|
2670
|
+
# * Reference frame rate: 60 fps
|
2671
|
+
#
|
2672
|
+
# * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
|
2673
|
+
#
|
2674
|
+
# * Tenancy: Supports 1 concurrent stream session
|
2675
|
+
# @return [String]
|
2676
|
+
#
|
2677
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/StreamGroupSummary AWS API Documentation
|
2678
|
+
#
|
2679
|
+
class StreamGroupSummary < Struct.new(
|
2680
|
+
:arn,
|
2681
|
+
:created_at,
|
2682
|
+
:default_application,
|
2683
|
+
:description,
|
2684
|
+
:id,
|
2685
|
+
:last_updated_at,
|
2686
|
+
:status,
|
2687
|
+
:stream_class)
|
2688
|
+
SENSITIVE = []
|
2689
|
+
include Aws::Structure
|
2690
|
+
end
|
2691
|
+
|
2692
|
+
# Describes a Amazon GameLift Streams stream session. To retrieve
|
2693
|
+
# additional details for the stream session, call GetStreamSession.
|
2694
|
+
#
|
2695
|
+
# @!attribute [rw] application_arn
|
2696
|
+
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies
|
2697
|
+
# the application resource. Format example:
|
2698
|
+
# ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6`
|
2699
|
+
# or ID-`9ZY8X7Wv6`.
|
2700
|
+
#
|
2701
|
+
#
|
2702
|
+
#
|
2703
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
2704
|
+
# @return [String]
|
2705
|
+
#
|
2706
|
+
# @!attribute [rw] arn
|
2707
|
+
# An [Amazon Resource Name (ARN)][1] that uniquely identifies the
|
2708
|
+
# stream session resource. Format example: `1AB2C3De4`. .
|
2709
|
+
#
|
2710
|
+
#
|
2711
|
+
#
|
2712
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
2713
|
+
# @return [String]
|
2714
|
+
#
|
2715
|
+
# @!attribute [rw] created_at
|
2716
|
+
# A timestamp that indicates when this resource was created.
|
2717
|
+
# Timestamps are expressed using in ISO8601 format, such as:
|
2718
|
+
# `2022-12-27T22:29:40+00:00` (UTC).
|
2719
|
+
# @return [Time]
|
2720
|
+
#
|
2721
|
+
# @!attribute [rw] export_files_metadata
|
2722
|
+
# Provides details about the stream session's exported files.
|
2723
|
+
# @return [Types::ExportFilesMetadata]
|
2724
|
+
#
|
2725
|
+
# @!attribute [rw] last_updated_at
|
2726
|
+
# A timestamp that indicates when this resource was last updated.
|
2727
|
+
# Timestamps are expressed using in ISO8601 format, such as:
|
2728
|
+
# `2022-12-27T22:29:40+00:00` (UTC).
|
2729
|
+
# @return [Time]
|
2730
|
+
#
|
2731
|
+
# @!attribute [rw] location
|
2732
|
+
# The location where Amazon GameLift Streams is hosting the stream
|
2733
|
+
# session.
|
2734
|
+
#
|
2735
|
+
# A location's name. For example, `us-east-1`. For a complete list of
|
2736
|
+
# locations that Amazon GameLift Streams supports, see the Regions and
|
2737
|
+
# quotas section in the Amazon GameLift Streams Developer Guide .
|
2738
|
+
# @return [String]
|
2739
|
+
#
|
2740
|
+
# @!attribute [rw] protocol
|
2741
|
+
# The data transfer protocol in use with the stream session.
|
2742
|
+
# @return [String]
|
2743
|
+
#
|
2744
|
+
# @!attribute [rw] status
|
2745
|
+
# The current status of the stream session resource. Possible statuses
|
2746
|
+
# include the following:
|
2747
|
+
#
|
2748
|
+
# * `ACTIVATING`: The stream session is starting and preparing to
|
2749
|
+
# stream.
|
2750
|
+
#
|
2751
|
+
# * `ACTIVE`: The stream session is ready to accept client
|
2752
|
+
# connections.
|
2753
|
+
#
|
2754
|
+
# * `CONNECTED`: The stream session has a connected client.
|
2755
|
+
#
|
2756
|
+
# * `PENDING_CLIENT_RECONNECTION`: A client has recently disconnected,
|
2757
|
+
# and the stream session is waiting for the client to reconnect.
|
2758
|
+
# After a short time, if the client doesn't reconnect, the stream
|
2759
|
+
# session status transitions to `TERMINATED`.
|
2760
|
+
#
|
2761
|
+
# * `TERMINATING`: The stream session is ending.
|
2762
|
+
#
|
2763
|
+
# * `TERMINATED`: The stream session has ended.
|
2764
|
+
#
|
2765
|
+
# * `ERROR`: The stream session failed to activate.
|
2766
|
+
# @return [String]
|
2767
|
+
#
|
2768
|
+
# @!attribute [rw] user_id
|
2769
|
+
# An opaque, unique identifier for an end-user, defined by the
|
2770
|
+
# developer.
|
2771
|
+
# @return [String]
|
2772
|
+
#
|
2773
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/StreamSessionSummary AWS API Documentation
|
2774
|
+
#
|
2775
|
+
class StreamSessionSummary < Struct.new(
|
2776
|
+
:application_arn,
|
2777
|
+
:arn,
|
2778
|
+
:created_at,
|
2779
|
+
:export_files_metadata,
|
2780
|
+
:last_updated_at,
|
2781
|
+
:location,
|
2782
|
+
:protocol,
|
2783
|
+
:status,
|
2784
|
+
:user_id)
|
2785
|
+
SENSITIVE = []
|
2786
|
+
include Aws::Structure
|
2787
|
+
end
|
2788
|
+
|
2789
|
+
# @!attribute [rw] resource_arn
|
2790
|
+
# The [Amazon Resource Name (ARN)][1] of the Amazon GameLift Streams
|
2791
|
+
# resource that you want to apply tags to.
|
2792
|
+
#
|
2793
|
+
#
|
2794
|
+
#
|
2795
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
|
2796
|
+
# @return [String]
|
2797
|
+
#
|
2798
|
+
# @!attribute [rw] tags
|
2799
|
+
# A list of tags, in the form of key-value pairs, to assign to the
|
2800
|
+
# specified Amazon GameLift Streams resource.
|
2801
|
+
# @return [Hash<String,String>]
|
2802
|
+
#
|
2803
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/TagResourceRequest AWS API Documentation
|
2804
|
+
#
|
2805
|
+
class TagResourceRequest < Struct.new(
|
2806
|
+
:resource_arn,
|
2807
|
+
:tags)
|
2808
|
+
SENSITIVE = []
|
2809
|
+
include Aws::Structure
|
2810
|
+
end
|
2811
|
+
|
2812
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/TagResourceResponse AWS API Documentation
|
2813
|
+
#
|
2814
|
+
class TagResourceResponse < Aws::EmptyStructure; end
|
2815
|
+
|
2816
|
+
# @!attribute [rw] identifier
|
2817
|
+
# [Amazon Resource Name (ARN)][1] or ID that uniquely identifies the
|
2818
|
+
# stream group resource. Format example:
|
2819
|
+
# ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4`
|
2820
|
+
# or ID-`1AB2C3De4`.
|
2821
|
+
#
|
2822
|
+
# The stream group that runs this stream session.
|
2823
|
+
#
|
2824
|
+
#
|
2825
|
+
#
|
2826
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
2827
|
+
# @return [String]
|
2828
|
+
#
|
2829
|
+
# @!attribute [rw] stream_session_identifier
|
2830
|
+
# [Amazon Resource Name (ARN)][1] that uniquely identifies the stream
|
2831
|
+
# session resource. Format example: `1AB2C3De4`.
|
2832
|
+
#
|
2833
|
+
#
|
2834
|
+
#
|
2835
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
2836
|
+
# @return [String]
|
2837
|
+
#
|
2838
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/TerminateStreamSessionInput AWS API Documentation
|
2839
|
+
#
|
2840
|
+
class TerminateStreamSessionInput < Struct.new(
|
2841
|
+
:identifier,
|
2842
|
+
:stream_session_identifier)
|
2843
|
+
SENSITIVE = []
|
2844
|
+
include Aws::Structure
|
2845
|
+
end
|
2846
|
+
|
2847
|
+
# The request was denied due to request throttling. Retry the request
|
2848
|
+
# after the suggested wait time.
|
2849
|
+
#
|
2850
|
+
# @!attribute [rw] message
|
2851
|
+
# Description of the error.
|
2852
|
+
# @return [String]
|
2853
|
+
#
|
2854
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/ThrottlingException AWS API Documentation
|
2855
|
+
#
|
2856
|
+
class ThrottlingException < Struct.new(
|
2857
|
+
:message)
|
2858
|
+
SENSITIVE = []
|
2859
|
+
include Aws::Structure
|
2860
|
+
end
|
2861
|
+
|
2862
|
+
# @!attribute [rw] resource_arn
|
2863
|
+
# The [Amazon Resource Name (ARN)][1] of the Amazon GameLift Streams
|
2864
|
+
# resource that you want to remove tags from.
|
2865
|
+
#
|
2866
|
+
#
|
2867
|
+
#
|
2868
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
|
2869
|
+
# @return [String]
|
2870
|
+
#
|
2871
|
+
# @!attribute [rw] tag_keys
|
2872
|
+
# A list of tag keys to remove from the specified Amazon GameLift
|
2873
|
+
# Streams resource.
|
2874
|
+
# @return [Array<String>]
|
2875
|
+
#
|
2876
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/UntagResourceRequest AWS API Documentation
|
2877
|
+
#
|
2878
|
+
class UntagResourceRequest < Struct.new(
|
2879
|
+
:resource_arn,
|
2880
|
+
:tag_keys)
|
2881
|
+
SENSITIVE = []
|
2882
|
+
include Aws::Structure
|
2883
|
+
end
|
2884
|
+
|
2885
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/UntagResourceResponse AWS API Documentation
|
2886
|
+
#
|
2887
|
+
class UntagResourceResponse < Aws::EmptyStructure; end
|
2888
|
+
|
2889
|
+
# @!attribute [rw] application_log_output_uri
|
2890
|
+
# An Amazon S3 URI to a bucket where you would like Amazon GameLift
|
2891
|
+
# Streams to save application logs. Use the following format for the
|
2892
|
+
# URI: `s3://[bucket name]/[prefix]`. Required if you specify one or
|
2893
|
+
# more `LogPaths`.
|
2894
|
+
#
|
2895
|
+
# <note markdown="1"> The log bucket must have permissions that give Amazon GameLift
|
2896
|
+
# Streams access to write the log files. For more information, see
|
2897
|
+
# **Getting Started** in the Amazon GameLift Streams Developer Guide.
|
2898
|
+
#
|
2899
|
+
# </note>
|
2900
|
+
# @return [String]
|
2901
|
+
#
|
2902
|
+
# @!attribute [rw] application_log_paths
|
2903
|
+
# Locations of log files that your content generates during a stream
|
2904
|
+
# session. Enter path values that are relative to the
|
2905
|
+
# `ApplicationSourceUri` location. You can specify up to 10 log
|
2906
|
+
# locations. Amazon GameLift Streams uploads designated log files to
|
2907
|
+
# the Amazon S3 bucket that you specify in `ApplicationLogOutputUri`
|
2908
|
+
# at the end of a stream session. To retrieve stored log files, call
|
2909
|
+
# GetStreamSession and get the `LogFileLocationUri`.
|
2910
|
+
# @return [Array<String>]
|
2911
|
+
#
|
2912
|
+
# @!attribute [rw] description
|
2913
|
+
# A human-readable label for the application.
|
2914
|
+
# @return [String]
|
2915
|
+
#
|
2916
|
+
# @!attribute [rw] identifier
|
2917
|
+
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies
|
2918
|
+
# the application resource. Format example:
|
2919
|
+
# ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6`
|
2920
|
+
# or ID-`9ZY8X7Wv6`.
|
2921
|
+
#
|
2922
|
+
#
|
2923
|
+
#
|
2924
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
2925
|
+
# @return [String]
|
2926
|
+
#
|
2927
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/UpdateApplicationInput AWS API Documentation
|
2928
|
+
#
|
2929
|
+
class UpdateApplicationInput < Struct.new(
|
2930
|
+
:application_log_output_uri,
|
2931
|
+
:application_log_paths,
|
2932
|
+
:description,
|
2933
|
+
:identifier)
|
2934
|
+
SENSITIVE = []
|
2935
|
+
include Aws::Structure
|
2936
|
+
end
|
2937
|
+
|
2938
|
+
# @!attribute [rw] application_log_output_uri
|
2939
|
+
# An Amazon S3 URI to a bucket where you would like Amazon GameLift
|
2940
|
+
# Streams to save application logs. Use the following format for the
|
2941
|
+
# URI: `s3://[bucket name]/[prefix]`. Required if you specify one or
|
2942
|
+
# more `LogPaths`.
|
2943
|
+
# @return [String]
|
2944
|
+
#
|
2945
|
+
# @!attribute [rw] application_log_paths
|
2946
|
+
# Locations of log files that your content generates during a stream
|
2947
|
+
# session. Amazon GameLift Streams uploads log files to the Amazon S3
|
2948
|
+
# bucket that you specify in `ApplicationLogOutputUri` at the end of a
|
2949
|
+
# stream session. To retrieve stored log files, call GetStreamSession
|
2950
|
+
# and get the `LogFileLocationUri`.
|
2951
|
+
# @return [Array<String>]
|
2952
|
+
#
|
2953
|
+
# @!attribute [rw] application_source_uri
|
2954
|
+
# The original Amazon S3 location of uploaded stream content for the
|
2955
|
+
# application.
|
2956
|
+
# @return [String]
|
2957
|
+
#
|
2958
|
+
# @!attribute [rw] arn
|
2959
|
+
# An Amazon Resource Name (ARN) that's assigned to an application
|
2960
|
+
# resource and uniquely identifies it across all Amazon Web Services
|
2961
|
+
# Regions. Format is `arn:aws:gameliftstreams:[AWS Region]:[AWS
|
2962
|
+
# account]:application/[resource ID]`.
|
2963
|
+
# @return [String]
|
2964
|
+
#
|
2965
|
+
# @!attribute [rw] associated_stream_groups
|
2966
|
+
# A set of stream groups that this application is associated with. You
|
2967
|
+
# can use any of these stream groups to stream your application.
|
2968
|
+
#
|
2969
|
+
# This value is a set of [Amazon Resource Names (ARNs)][1] that
|
2970
|
+
# uniquely identify stream group resources. Format example:
|
2971
|
+
# `arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4`.
|
2972
|
+
#
|
2973
|
+
#
|
2974
|
+
#
|
2975
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
2976
|
+
# @return [Array<String>]
|
2977
|
+
#
|
2978
|
+
# @!attribute [rw] created_at
|
2979
|
+
# A timestamp that indicates when this resource was created.
|
2980
|
+
# Timestamps are expressed using in ISO8601 format, such as:
|
2981
|
+
# `2022-12-27T22:29:40+00:00` (UTC).
|
2982
|
+
# @return [Time]
|
2983
|
+
#
|
2984
|
+
# @!attribute [rw] description
|
2985
|
+
# A human-readable label for the application. You can edit this value.
|
2986
|
+
# @return [String]
|
2987
|
+
#
|
2988
|
+
# @!attribute [rw] executable_path
|
2989
|
+
# The path and file name of the executable file that launches the
|
2990
|
+
# content for streaming.
|
2991
|
+
# @return [String]
|
2992
|
+
#
|
2993
|
+
# @!attribute [rw] id
|
2994
|
+
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies
|
2995
|
+
# the application resource. Format example:
|
2996
|
+
# ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6`
|
2997
|
+
# or ID-`9ZY8X7Wv6`.
|
2998
|
+
#
|
2999
|
+
#
|
3000
|
+
#
|
3001
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
3002
|
+
# @return [String]
|
3003
|
+
#
|
3004
|
+
# @!attribute [rw] last_updated_at
|
3005
|
+
# A timestamp that indicates when this resource was last updated.
|
3006
|
+
# Timestamps are expressed using in ISO8601 format, such as:
|
3007
|
+
# `2022-12-27T22:29:40+00:00` (UTC).
|
3008
|
+
# @return [Time]
|
3009
|
+
#
|
3010
|
+
# @!attribute [rw] replication_statuses
|
3011
|
+
# A set of replication statuses for each location.
|
3012
|
+
# @return [Array<Types::ReplicationStatus>]
|
3013
|
+
#
|
3014
|
+
# @!attribute [rw] runtime_environment
|
3015
|
+
# A set of configuration settings to run the application on a stream
|
3016
|
+
# group. This configures the operating system, and can include
|
3017
|
+
# compatibility layers and other drivers.
|
3018
|
+
#
|
3019
|
+
# A runtime environment can be one of the following:
|
3020
|
+
#
|
3021
|
+
# * For Linux applications
|
3022
|
+
#
|
3023
|
+
# * Ubuntu 22.04 LTS(`Type=UBUNTU, Version=22_04_LTS`)
|
3024
|
+
#
|
3025
|
+
# ^
|
3026
|
+
# * For Windows applications
|
3027
|
+
#
|
3028
|
+
# * Microsoft Windows Server 2022 Base (`Type=WINDOWS,
|
3029
|
+
# Version=2022`)
|
3030
|
+
#
|
3031
|
+
# * Proton 8.0-5 (`Type=PROTON, Version=20241007`)
|
3032
|
+
#
|
3033
|
+
# * Proton 8.0-2c (`Type=PROTON, Version=20230704`)
|
3034
|
+
# @return [Types::RuntimeEnvironment]
|
3035
|
+
#
|
3036
|
+
# @!attribute [rw] status
|
3037
|
+
# The current status of the application resource. Possible statuses
|
3038
|
+
# include the following:
|
3039
|
+
#
|
3040
|
+
# * `INITIALIZED`: Amazon GameLift Streams has received the request
|
3041
|
+
# and is initiating the work flow to create an application.
|
3042
|
+
#
|
3043
|
+
# * `PROCESSING`: The create application work flow is in process.
|
3044
|
+
# Amazon GameLift Streams is copying the content and caching for
|
3045
|
+
# future deployment in a stream group.
|
3046
|
+
#
|
3047
|
+
# * `READY`: The application is ready to deploy in a stream group.
|
3048
|
+
#
|
3049
|
+
# * `ERROR`: An error occurred when setting up the application. See
|
3050
|
+
# `StatusReason` for more information.
|
3051
|
+
#
|
3052
|
+
# * `DELETING`: Amazon GameLift Streams is in the process of deleting
|
3053
|
+
# the application.
|
3054
|
+
# @return [String]
|
3055
|
+
#
|
3056
|
+
# @!attribute [rw] status_reason
|
3057
|
+
# A short description of the status reason when the application is in
|
3058
|
+
# `ERROR` status.
|
3059
|
+
# @return [String]
|
3060
|
+
#
|
3061
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/UpdateApplicationOutput AWS API Documentation
|
3062
|
+
#
|
3063
|
+
class UpdateApplicationOutput < Struct.new(
|
3064
|
+
:application_log_output_uri,
|
3065
|
+
:application_log_paths,
|
3066
|
+
:application_source_uri,
|
3067
|
+
:arn,
|
3068
|
+
:associated_stream_groups,
|
3069
|
+
:created_at,
|
3070
|
+
:description,
|
3071
|
+
:executable_path,
|
3072
|
+
:id,
|
3073
|
+
:last_updated_at,
|
3074
|
+
:replication_statuses,
|
3075
|
+
:runtime_environment,
|
3076
|
+
:status,
|
3077
|
+
:status_reason)
|
3078
|
+
SENSITIVE = []
|
3079
|
+
include Aws::Structure
|
3080
|
+
end
|
3081
|
+
|
3082
|
+
# @!attribute [rw] description
|
3083
|
+
# A descriptive label for the stream group.
|
3084
|
+
# @return [String]
|
3085
|
+
#
|
3086
|
+
# @!attribute [rw] identifier
|
3087
|
+
# An [Amazon Resource Name (ARN)][1] or ID that uniquely identifies
|
3088
|
+
# the stream group resource. Format example:
|
3089
|
+
# ARN-`arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/1AB2C3De4`
|
3090
|
+
# or ID-`1AB2C3De4`.
|
3091
|
+
#
|
3092
|
+
#
|
3093
|
+
#
|
3094
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
3095
|
+
# @return [String]
|
3096
|
+
#
|
3097
|
+
# @!attribute [rw] location_configurations
|
3098
|
+
# A set of one or more locations and the streaming capacity for each
|
3099
|
+
# location.
|
3100
|
+
# @return [Array<Types::LocationConfiguration>]
|
3101
|
+
#
|
3102
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/UpdateStreamGroupInput AWS API Documentation
|
3103
|
+
#
|
3104
|
+
class UpdateStreamGroupInput < Struct.new(
|
3105
|
+
:description,
|
3106
|
+
:identifier,
|
3107
|
+
:location_configurations)
|
3108
|
+
SENSITIVE = []
|
3109
|
+
include Aws::Structure
|
3110
|
+
end
|
3111
|
+
|
3112
|
+
# @!attribute [rw] arn
|
3113
|
+
# An Amazon Resource Name (ARN) that is assigned to the stream group
|
3114
|
+
# resource and that uniquely identifies the group across all Amazon
|
3115
|
+
# Web Services Regions. Format is `arn:aws:gameliftstreams:[AWS
|
3116
|
+
# Region]:[AWS account]:streamgroup/[resource ID]`.
|
3117
|
+
# @return [String]
|
3118
|
+
#
|
3119
|
+
# @!attribute [rw] associated_applications
|
3120
|
+
# A set of applications that this stream group is associated with. You
|
3121
|
+
# can stream any of these applications with the stream group.
|
3122
|
+
#
|
3123
|
+
# This value is a set of [Amazon Resource Names (ARNs)][1] that
|
3124
|
+
# uniquely identify application resources. Format example:
|
3125
|
+
# `arn:aws:gameliftstreams:us-west-2:123456789012:application/9ZY8X7Wv6`.
|
3126
|
+
#
|
3127
|
+
#
|
3128
|
+
#
|
3129
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html
|
3130
|
+
# @return [Array<String>]
|
3131
|
+
#
|
3132
|
+
# @!attribute [rw] created_at
|
3133
|
+
# A timestamp that indicates when this resource was created.
|
3134
|
+
# Timestamps are expressed using in ISO8601 format, such as:
|
3135
|
+
# `2022-12-27T22:29:40+00:00` (UTC).
|
3136
|
+
# @return [Time]
|
3137
|
+
#
|
3138
|
+
# @!attribute [rw] default_application
|
3139
|
+
# The Amazon GameLift Streams application that is associated with this
|
3140
|
+
# stream group.
|
3141
|
+
# @return [Types::DefaultApplication]
|
3142
|
+
#
|
3143
|
+
# @!attribute [rw] description
|
3144
|
+
# A descriptive label for the stream group.
|
3145
|
+
# @return [String]
|
3146
|
+
#
|
3147
|
+
# @!attribute [rw] id
|
3148
|
+
# A unique ID value that is assigned to the resource when it's
|
3149
|
+
# created. Format example: `1AB2C3De4`.
|
3150
|
+
# @return [String]
|
3151
|
+
#
|
3152
|
+
# @!attribute [rw] last_updated_at
|
3153
|
+
# A timestamp that indicates when this resource was last updated.
|
3154
|
+
# Timestamps are expressed using in ISO8601 format, such as:
|
3155
|
+
# `2022-12-27T22:29:40+00:00` (UTC).
|
3156
|
+
# @return [Time]
|
3157
|
+
#
|
3158
|
+
# @!attribute [rw] location_states
|
3159
|
+
# This value is set of locations, including their name, current
|
3160
|
+
# status, and capacities.
|
3161
|
+
#
|
3162
|
+
# A location can be in one of the following states:
|
3163
|
+
#
|
3164
|
+
# * **ACTIVATING**: Amazon GameLift Streams is preparing the location.
|
3165
|
+
# You cannot stream from, scale the capacity of, or remove this
|
3166
|
+
# location yet.
|
3167
|
+
#
|
3168
|
+
# * **ACTIVE**: The location is provisioned with initial capacity. You
|
3169
|
+
# can now stream from, scale the capacity of, or remove this
|
3170
|
+
# location.
|
3171
|
+
#
|
3172
|
+
# * **ERROR**: Amazon GameLift Streams failed to set up this location.
|
3173
|
+
# The StatusReason field describes the error. You can remove this
|
3174
|
+
# location and try to add it again.
|
3175
|
+
#
|
3176
|
+
# * **REMOVING**: Amazon GameLift Streams is working to remove this
|
3177
|
+
# location. It releases all provisioned capacity for this location
|
3178
|
+
# in this stream group.
|
3179
|
+
# @return [Array<Types::LocationState>]
|
3180
|
+
#
|
3181
|
+
# @!attribute [rw] status
|
3182
|
+
# The current status of the stream group resource. Possible statuses
|
3183
|
+
# include the following:
|
3184
|
+
#
|
3185
|
+
# * `ACTIVATING`: The stream group is deploying and isn't ready to
|
3186
|
+
# host streams.
|
3187
|
+
#
|
3188
|
+
# * `ACTIVE`: The stream group is ready to host streams.
|
3189
|
+
#
|
3190
|
+
# * `ACTIVE_WITH_ERRORS`: One or more locations in the stream group
|
3191
|
+
# are in an error state. Verify the details of individual locations
|
3192
|
+
# and remove any locations which are in error.
|
3193
|
+
#
|
3194
|
+
# * `ERROR`: An error occurred when the stream group deployed. See
|
3195
|
+
# `StatusReason` for more information.
|
3196
|
+
#
|
3197
|
+
# * `DELETING`: Amazon GameLift Streams is in the process of deleting
|
3198
|
+
# the stream group.
|
3199
|
+
#
|
3200
|
+
# * `UPDATING_LOCATIONS`: One or more locations in the stream group
|
3201
|
+
# are in the process of updating (either activating or deleting).
|
3202
|
+
# @return [String]
|
3203
|
+
#
|
3204
|
+
# @!attribute [rw] status_reason
|
3205
|
+
# A short description of the reason that the stream group is in
|
3206
|
+
# `ERROR` status. The possible reasons can be one of the following:
|
3207
|
+
#
|
3208
|
+
# * `internalError`: The request can't process right now bcause of an
|
3209
|
+
# issue with the server. Try again later. Reach out to the Amazon
|
3210
|
+
# GameLift Streams team for more help.
|
3211
|
+
#
|
3212
|
+
# * `noAvailableInstances`: Amazon GameLift Streams does not currently
|
3213
|
+
# have enough available On-Demand capacity to fulfill your request.
|
3214
|
+
# Wait a few minutes and retry the request as capacity can shift
|
3215
|
+
# frequently. You can also try to make the request using a different
|
3216
|
+
# stream class or in another region.
|
3217
|
+
# @return [String]
|
3218
|
+
#
|
3219
|
+
# @!attribute [rw] stream_class
|
3220
|
+
# The target stream quality for the stream group.
|
3221
|
+
#
|
3222
|
+
# A stream class can be one of the following:
|
3223
|
+
#
|
3224
|
+
# * <b> <code>gen5n_win2022</code> (NVIDIA, ultra)</b> Supports
|
3225
|
+
# applications with extremely high 3D scene complexity. Runs
|
3226
|
+
# applications on Microsoft Windows Server 2022 Base and supports
|
3227
|
+
# DirectX 12. Compatible with most Unreal Engine 5.x builds, 32-bit
|
3228
|
+
# applications, and anti-cheat technology. Uses NVIDIA A10G Tensor
|
3229
|
+
# GPU.
|
3230
|
+
#
|
3231
|
+
# * Reference resolution: 1080p
|
3232
|
+
#
|
3233
|
+
# * Reference frame rate: 60 fps
|
3234
|
+
#
|
3235
|
+
# * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
|
3236
|
+
#
|
3237
|
+
# * Tenancy: Supports 1 concurrent stream session
|
3238
|
+
# * <b> <code>gen5n_high</code> (NVIDIA, high)</b> Supports
|
3239
|
+
# applications with moderate to high 3D scene complexity. Uses
|
3240
|
+
# NVIDIA A10G Tensor GPU.
|
3241
|
+
#
|
3242
|
+
# * Reference resolution: 1080p
|
3243
|
+
#
|
3244
|
+
# * Reference frame rate: 60 fps
|
3245
|
+
#
|
3246
|
+
# * Workload specifications: 4 vCPUs, 16 GB RAM, 12 GB VRAM
|
3247
|
+
#
|
3248
|
+
# * Tenancy: Supports up to 2 concurrent stream sessions
|
3249
|
+
# * <b> <code>gen5n_ultra</code> (NVIDIA, ultra)</b> Supports
|
3250
|
+
# applications with extremely high 3D scene complexity. Uses
|
3251
|
+
# dedicated NVIDIA A10G Tensor GPU.
|
3252
|
+
#
|
3253
|
+
# * Reference resolution: 1080p
|
3254
|
+
#
|
3255
|
+
# * Reference frame rate: 60 fps
|
3256
|
+
#
|
3257
|
+
# * Workload specifications: 8 vCPUs, 32 GB RAM, 24 GB VRAM
|
3258
|
+
#
|
3259
|
+
# * Tenancy: Supports 1 concurrent stream session
|
3260
|
+
# * <b> <code>gen4n_win2022</code> (NVIDIA, ultra)</b> Supports
|
3261
|
+
# applications with extremely high 3D scene complexity. Runs
|
3262
|
+
# applications on Microsoft Windows Server 2022 Base and supports
|
3263
|
+
# DirectX 12. Compatible with most Unreal Engine 5.2 and 5.3 builds,
|
3264
|
+
# 32-bit applications, and anti-cheat technology. Uses NVIDIA T4
|
3265
|
+
# Tensor GPU.
|
3266
|
+
#
|
3267
|
+
# * Reference resolution: 1080p
|
3268
|
+
#
|
3269
|
+
# * Reference frame rate: 60 fps
|
3270
|
+
#
|
3271
|
+
# * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
|
3272
|
+
#
|
3273
|
+
# * Tenancy: Supports 1 concurrent stream session
|
3274
|
+
# * <b> <code>gen4n_high</code> (NVIDIA, high)</b> Supports
|
3275
|
+
# applications with moderate to high 3D scene complexity. Uses
|
3276
|
+
# NVIDIA T4 Tensor GPU.
|
3277
|
+
#
|
3278
|
+
# * Reference resolution: 1080p
|
3279
|
+
#
|
3280
|
+
# * Reference frame rate: 60 fps
|
3281
|
+
#
|
3282
|
+
# * Workload specifications: 4 vCPUs, 16 GB RAM, 8 GB VRAM
|
3283
|
+
#
|
3284
|
+
# * Tenancy: Supports up to 2 concurrent stream sessions
|
3285
|
+
# * <b> <code>gen4n_ultra</code> (NVIDIA, ultra)</b> Supports
|
3286
|
+
# applications with high 3D scene complexity. Uses dedicated NVIDIA
|
3287
|
+
# T4 Tensor GPU.
|
3288
|
+
#
|
3289
|
+
# * Reference resolution: 1080p
|
3290
|
+
#
|
3291
|
+
# * Reference frame rate: 60 fps
|
3292
|
+
#
|
3293
|
+
# * Workload specifications: 8 vCPUs, 32 GB RAM, 16 GB VRAM
|
3294
|
+
#
|
3295
|
+
# * Tenancy: Supports 1 concurrent stream session
|
3296
|
+
# @return [String]
|
3297
|
+
#
|
3298
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/UpdateStreamGroupOutput AWS API Documentation
|
3299
|
+
#
|
3300
|
+
class UpdateStreamGroupOutput < Struct.new(
|
3301
|
+
:arn,
|
3302
|
+
:associated_applications,
|
3303
|
+
:created_at,
|
3304
|
+
:default_application,
|
3305
|
+
:description,
|
3306
|
+
:id,
|
3307
|
+
:last_updated_at,
|
3308
|
+
:location_states,
|
3309
|
+
:status,
|
3310
|
+
:status_reason,
|
3311
|
+
:stream_class)
|
3312
|
+
SENSITIVE = []
|
3313
|
+
include Aws::Structure
|
3314
|
+
end
|
3315
|
+
|
3316
|
+
# One or more parameter values in the request fail to satisfy the
|
3317
|
+
# specified constraints. Correct the invalid parameter values before
|
3318
|
+
# retrying the request.
|
3319
|
+
#
|
3320
|
+
# @!attribute [rw] message
|
3321
|
+
# Description of the error.
|
3322
|
+
# @return [String]
|
3323
|
+
#
|
3324
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gameliftstreams-2018-05-10/ValidationException AWS API Documentation
|
3325
|
+
#
|
3326
|
+
class ValidationException < Struct.new(
|
3327
|
+
:message)
|
3328
|
+
SENSITIVE = []
|
3329
|
+
include Aws::Structure
|
3330
|
+
end
|
3331
|
+
|
3332
|
+
end
|
3333
|
+
end
|
3334
|
+
|