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