@aws-sdk/client-gameliftstreams 3.774.0 → 3.775.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -5
- package/dist-cjs/GameLiftStreamsClient.js +2 -1
- package/dist-cjs/auth/httpAuthSchemeProvider.js +1 -3
- package/dist-cjs/endpoint/EndpointParameters.js +2 -3
- package/dist-cjs/runtimeExtensions.js +2 -14
- package/dist-es/GameLiftStreamsClient.js +2 -1
- package/dist-es/auth/httpAuthSchemeProvider.js +1 -3
- package/dist-es/endpoint/EndpointParameters.js +2 -3
- package/dist-es/runtimeExtensions.js +2 -14
- package/dist-types/GameLiftStreams.d.ts +4 -5
- package/dist-types/GameLiftStreamsClient.d.ts +4 -5
- package/dist-types/commands/AddStreamGroupLocationsCommand.d.ts +10 -14
- package/dist-types/commands/AssociateApplicationsCommand.d.ts +7 -9
- package/dist-types/commands/CreateApplicationCommand.d.ts +16 -22
- package/dist-types/commands/CreateStreamGroupCommand.d.ts +20 -18
- package/dist-types/commands/CreateStreamSessionConnectionCommand.d.ts +17 -26
- package/dist-types/commands/DeleteApplicationCommand.d.ts +18 -24
- package/dist-types/commands/DeleteStreamGroupCommand.d.ts +8 -9
- package/dist-types/commands/DisassociateApplicationsCommand.d.ts +10 -12
- package/dist-types/commands/ExportStreamSessionFilesCommand.d.ts +16 -16
- package/dist-types/commands/GetApplicationCommand.d.ts +6 -9
- package/dist-types/commands/GetStreamGroupCommand.d.ts +6 -9
- package/dist-types/commands/GetStreamSessionCommand.d.ts +6 -9
- package/dist-types/commands/ListApplicationsCommand.d.ts +6 -9
- package/dist-types/commands/ListStreamGroupsCommand.d.ts +6 -9
- package/dist-types/commands/ListStreamSessionsByAccountCommand.d.ts +7 -8
- package/dist-types/commands/ListStreamSessionsCommand.d.ts +6 -8
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -12
- package/dist-types/commands/RemoveStreamGroupLocationsCommand.d.ts +9 -12
- package/dist-types/commands/StartStreamSessionCommand.d.ts +11 -9
- package/dist-types/commands/TagResourceCommand.d.ts +9 -12
- package/dist-types/commands/TerminateStreamSessionCommand.d.ts +7 -10
- package/dist-types/commands/UntagResourceCommand.d.ts +6 -8
- package/dist-types/commands/UpdateApplicationCommand.d.ts +4 -6
- package/dist-types/commands/UpdateStreamGroupCommand.d.ts +11 -16
- package/dist-types/index.d.ts +4 -5
- package/dist-types/models/models_0.d.ts +289 -428
- package/package.json +34 -34
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { GameLiftStreamsServiceException as __BaseException } from "./GameLiftStreamsServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* <p>You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the
|
|
5
|
-
* permissions before you try again.</p>
|
|
4
|
+
* <p>You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.</p>
|
|
6
5
|
* @public
|
|
7
6
|
*/
|
|
8
7
|
export declare class AccessDeniedException extends __BaseException {
|
|
@@ -19,15 +18,15 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
19
18
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
20
19
|
}
|
|
21
20
|
/**
|
|
22
|
-
* <p>Configuration settings that define a stream group's stream capacity for a location. When configuring a location for the first time, you
|
|
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>
|
|
23
24
|
* @public
|
|
24
25
|
*/
|
|
25
26
|
export interface LocationConfiguration {
|
|
26
27
|
/**
|
|
27
28
|
* <p>
|
|
28
|
-
* A location's name. For example, <code>us-east-1</code>. For a complete list of locations that Amazon GameLift Streams supports,
|
|
29
|
-
* the Regions and quotas section in the Amazon GameLift Streams Developer Guide
|
|
30
|
-
* .
|
|
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>.
|
|
31
30
|
* </p>
|
|
32
31
|
* @public
|
|
33
32
|
*/
|
|
@@ -52,11 +51,9 @@ export interface LocationConfiguration {
|
|
|
52
51
|
*/
|
|
53
52
|
export interface AddStreamGroupLocationsInput {
|
|
54
53
|
/**
|
|
55
|
-
* <p>
|
|
56
|
-
* A stream group to add the specified locations to.
|
|
57
|
-
* </p>
|
|
54
|
+
* <p> A stream group to add the specified locations to. </p>
|
|
58
55
|
* <p>This value is a
|
|
59
|
-
* Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Format example: <code>1AB2C3De4</code>.
|
|
56
|
+
* Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Format example: <code>sg-1AB2C3De4</code>.
|
|
60
57
|
* </p>
|
|
61
58
|
* @public
|
|
62
59
|
*/
|
|
@@ -90,9 +87,7 @@ export type StreamGroupLocationStatus = (typeof StreamGroupLocationStatus)[keyof
|
|
|
90
87
|
export interface LocationState {
|
|
91
88
|
/**
|
|
92
89
|
* <p>
|
|
93
|
-
* A location's name. For example, <code>us-east-1</code>. For a complete list of locations that Amazon GameLift Streams supports,
|
|
94
|
-
* the Regions and quotas section in the Amazon GameLift Streams Developer Guide
|
|
95
|
-
* .
|
|
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>.
|
|
96
91
|
* </p>
|
|
97
92
|
* @public
|
|
98
93
|
*/
|
|
@@ -165,7 +160,7 @@ export interface LocationState {
|
|
|
165
160
|
export interface AddStreamGroupLocationsOutput {
|
|
166
161
|
/**
|
|
167
162
|
* <p>This value is the
|
|
168
|
-
* Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Format example: <code>1AB2C3De4</code>.
|
|
163
|
+
* Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Format example: <code>sg-1AB2C3De4</code>.
|
|
169
164
|
* </p>
|
|
170
165
|
* @public
|
|
171
166
|
*/
|
|
@@ -239,8 +234,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
239
234
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
240
235
|
}
|
|
241
236
|
/**
|
|
242
|
-
* <p>The request would cause the resource to exceed an allowed service quota. Resolve the
|
|
243
|
-
* issue before you try again.</p>
|
|
237
|
+
* <p>The request would cause the resource to exceed an allowed service quota. Resolve the issue before you try again.</p>
|
|
244
238
|
* @public
|
|
245
239
|
*/
|
|
246
240
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
@@ -257,8 +251,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
257
251
|
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
258
252
|
}
|
|
259
253
|
/**
|
|
260
|
-
* <p>The request was denied due to request throttling. Retry the request after the
|
|
261
|
-
* suggested wait time.</p>
|
|
254
|
+
* <p>The request was denied due to request throttling. Retry the request after the suggested wait time.</p>
|
|
262
255
|
* @public
|
|
263
256
|
*/
|
|
264
257
|
export declare class ThrottlingException extends __BaseException {
|
|
@@ -278,8 +271,8 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
278
271
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
279
272
|
}
|
|
280
273
|
/**
|
|
281
|
-
* <p>One or more parameter values in the request fail to satisfy the specified constraints.
|
|
282
|
-
*
|
|
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>
|
|
283
276
|
* @public
|
|
284
277
|
*/
|
|
285
278
|
export declare class ValidationException extends __BaseException {
|
|
@@ -323,7 +316,8 @@ export declare const ApplicationStatusReason: {
|
|
|
323
316
|
*/
|
|
324
317
|
export type ApplicationStatusReason = (typeof ApplicationStatusReason)[keyof typeof ApplicationStatusReason];
|
|
325
318
|
/**
|
|
326
|
-
* <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the
|
|
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>
|
|
327
321
|
* @public
|
|
328
322
|
*/
|
|
329
323
|
export declare class ConflictException extends __BaseException {
|
|
@@ -353,8 +347,8 @@ export declare const RuntimeEnvironmentType: {
|
|
|
353
347
|
*/
|
|
354
348
|
export type RuntimeEnvironmentType = (typeof RuntimeEnvironmentType)[keyof typeof RuntimeEnvironmentType];
|
|
355
349
|
/**
|
|
356
|
-
* <p>Configuration settings that identify the operating system for an application
|
|
357
|
-
*
|
|
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>
|
|
358
352
|
* <p>A runtime environment can be one of the following:</p>
|
|
359
353
|
* <ul>
|
|
360
354
|
* <li>
|
|
@@ -364,7 +358,7 @@ export type RuntimeEnvironmentType = (typeof RuntimeEnvironmentType)[keyof typeo
|
|
|
364
358
|
* <ul>
|
|
365
359
|
* <li>
|
|
366
360
|
* <p>
|
|
367
|
-
* Ubuntu 22.04 LTS(<code>Type=UBUNTU, Version=22_04_LTS</code>)
|
|
361
|
+
* Ubuntu 22.04 LTS (<code>Type=UBUNTU, Version=22_04_LTS</code>)
|
|
368
362
|
* </p>
|
|
369
363
|
* </li>
|
|
370
364
|
* </ul>
|
|
@@ -410,7 +404,8 @@ export interface CreateApplicationInput {
|
|
|
410
404
|
*/
|
|
411
405
|
Description: string | undefined;
|
|
412
406
|
/**
|
|
413
|
-
* <p>
|
|
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>
|
|
414
409
|
* <p>A runtime environment can be one of the following:</p>
|
|
415
410
|
* <ul>
|
|
416
411
|
* <li>
|
|
@@ -420,7 +415,7 @@ export interface CreateApplicationInput {
|
|
|
420
415
|
* <ul>
|
|
421
416
|
* <li>
|
|
422
417
|
* <p>
|
|
423
|
-
* Ubuntu 22.04 LTS(<code>Type=UBUNTU, Version=22_04_LTS</code>)
|
|
418
|
+
* Ubuntu 22.04 LTS (<code>Type=UBUNTU, Version=22_04_LTS</code>)
|
|
424
419
|
* </p>
|
|
425
420
|
* </li>
|
|
426
421
|
* </ul>
|
|
@@ -446,22 +441,18 @@ export interface CreateApplicationInput {
|
|
|
446
441
|
*/
|
|
447
442
|
RuntimeEnvironment: RuntimeEnvironment | undefined;
|
|
448
443
|
/**
|
|
449
|
-
* <p>The path and file name of the executable file that launches the content for streaming.
|
|
450
|
-
*
|
|
451
|
-
* <code>ApplicationSourceUri</code>.</p>
|
|
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>
|
|
452
446
|
* @public
|
|
453
447
|
*/
|
|
454
448
|
ExecutablePath: string | undefined;
|
|
455
449
|
/**
|
|
456
|
-
* <p>The location of the content that you want to stream. Enter
|
|
457
|
-
*
|
|
458
|
-
*
|
|
459
|
-
*
|
|
460
|
-
* copies everything under the specified location.</p>
|
|
461
|
-
* <p>This value is immutable. To designate a different content location, create a new
|
|
462
|
-
* application.</p>
|
|
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>
|
|
463
454
|
* <note>
|
|
464
|
-
* <p>The S3 bucket and the Amazon GameLift Streams application must be in the same Amazon Web Services Region.</p>
|
|
455
|
+
* <p>The Amazon S3 bucket and the Amazon GameLift Streams application must be in the same Amazon Web Services Region.</p>
|
|
465
456
|
* </note>
|
|
466
457
|
* @public
|
|
467
458
|
*/
|
|
@@ -469,16 +460,15 @@ export interface CreateApplicationInput {
|
|
|
469
460
|
/**
|
|
470
461
|
* <p>Locations of log files that your content generates during a stream session. Enter path
|
|
471
462
|
* values that are relative to the <code>ApplicationSourceUri</code> location.
|
|
472
|
-
* You can specify up to 10 log
|
|
463
|
+
* You can specify up to 10 log paths.
|
|
473
464
|
* Amazon GameLift Streams uploads designated log files to the Amazon S3 bucket that you specify in <code>ApplicationLogOutputUri</code>
|
|
474
|
-
* at the end of a stream session. To retrieve stored log files, call <a>GetStreamSession</a>
|
|
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>
|
|
475
466
|
* and get the <code>LogFileLocationUri</code>.</p>
|
|
476
467
|
* @public
|
|
477
468
|
*/
|
|
478
469
|
ApplicationLogPaths?: string[] | undefined;
|
|
479
470
|
/**
|
|
480
|
-
* <p>An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs.
|
|
481
|
-
* Required if you specify one or more <code>LogPaths</code>.</p>
|
|
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>
|
|
482
472
|
* <note>
|
|
483
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>
|
|
484
474
|
* </note>
|
|
@@ -486,13 +476,9 @@ export interface CreateApplicationInput {
|
|
|
486
476
|
*/
|
|
487
477
|
ApplicationLogOutputUri?: string | undefined;
|
|
488
478
|
/**
|
|
489
|
-
* <p>A list of labels to assign to the new application resource. Tags are developer-defined
|
|
490
|
-
*
|
|
491
|
-
*
|
|
492
|
-
* <i>Amazon Web Services General Reference</i>. You can use <a>TagResource</a> to add tags, <a>UntagResource</a> to remove tags,
|
|
493
|
-
* and <a>ListTagsForResource</a> to view tags on existing resources. The
|
|
494
|
-
* maximum tag limit might be lower than stated. See the <i>Amazon Web Services General
|
|
495
|
-
* Reference</i> for actual tagging limits.</p>
|
|
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>
|
|
496
482
|
* @public
|
|
497
483
|
*/
|
|
498
484
|
Tags?: Record<string, string> | undefined;
|
|
@@ -517,15 +503,14 @@ export declare const ReplicationStatusType: {
|
|
|
517
503
|
*/
|
|
518
504
|
export type ReplicationStatusType = (typeof ReplicationStatusType)[keyof typeof ReplicationStatusType];
|
|
519
505
|
/**
|
|
520
|
-
* <p>Represents the status of the replication of an application to a location. An application cannot be streamed from a location until it has
|
|
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>
|
|
521
508
|
* @public
|
|
522
509
|
*/
|
|
523
510
|
export interface ReplicationStatus {
|
|
524
511
|
/**
|
|
525
512
|
* <p>
|
|
526
|
-
* A location's name. For example, <code>us-east-1</code>. For a complete list of locations that Amazon GameLift Streams supports,
|
|
527
|
-
* the Regions and quotas section in the Amazon GameLift Streams Developer Guide
|
|
528
|
-
* .
|
|
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>.
|
|
529
514
|
* </p>
|
|
530
515
|
* @public
|
|
531
516
|
*/
|
|
@@ -541,9 +526,8 @@ export interface ReplicationStatus {
|
|
|
541
526
|
*/
|
|
542
527
|
export interface CreateApplicationOutput {
|
|
543
528
|
/**
|
|
544
|
-
* <p>An Amazon Resource Name (ARN) that's assigned to an application resource and uniquely identifies it across
|
|
545
|
-
*
|
|
546
|
-
* account]:application/[resource ID]</code>.</p>
|
|
529
|
+
* <p>An Amazon Resource Name (ARN) that's assigned to an application resource and uniquely identifies it across all Amazon Web Services Regions. Format is
|
|
530
|
+
* <code>arn:aws:gameliftstreams:[AWS Region]:[AWS account]:application/[resource ID]</code>.</p>
|
|
547
531
|
* @public
|
|
548
532
|
*/
|
|
549
533
|
Arn: string | undefined;
|
|
@@ -553,9 +537,8 @@ export interface CreateApplicationOutput {
|
|
|
553
537
|
*/
|
|
554
538
|
Description?: string | undefined;
|
|
555
539
|
/**
|
|
556
|
-
* <p>
|
|
557
|
-
*
|
|
558
|
-
* </p>
|
|
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>
|
|
559
542
|
* <p>A runtime environment can be one of the following:</p>
|
|
560
543
|
* <ul>
|
|
561
544
|
* <li>
|
|
@@ -565,7 +548,7 @@ export interface CreateApplicationOutput {
|
|
|
565
548
|
* <ul>
|
|
566
549
|
* <li>
|
|
567
550
|
* <p>
|
|
568
|
-
* Ubuntu 22.04 LTS(<code>Type=UBUNTU, Version=22_04_LTS</code>)
|
|
551
|
+
* Ubuntu 22.04 LTS (<code>Type=UBUNTU, Version=22_04_LTS</code>)
|
|
569
552
|
* </p>
|
|
570
553
|
* </li>
|
|
571
554
|
* </ul>
|
|
@@ -591,22 +574,20 @@ export interface CreateApplicationOutput {
|
|
|
591
574
|
*/
|
|
592
575
|
RuntimeEnvironment?: RuntimeEnvironment | undefined;
|
|
593
576
|
/**
|
|
594
|
-
* <p>The path and file name of the executable file that launches the content for
|
|
595
|
-
* streaming.</p>
|
|
577
|
+
* <p>The path and file name of the executable file that launches the content for streaming.</p>
|
|
596
578
|
* @public
|
|
597
579
|
*/
|
|
598
580
|
ExecutablePath?: string | undefined;
|
|
599
581
|
/**
|
|
600
582
|
* <p>Locations of log files that your content generates during a stream session.
|
|
601
583
|
* Amazon GameLift Streams uploads log files to the Amazon S3 bucket that you specify in <code>ApplicationLogOutputUri</code>
|
|
602
|
-
* at the end of a stream session. To retrieve stored log files, call <a>GetStreamSession</a>
|
|
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>
|
|
603
585
|
* and get the <code>LogFileLocationUri</code>.</p>
|
|
604
586
|
* @public
|
|
605
587
|
*/
|
|
606
588
|
ApplicationLogPaths?: string[] | undefined;
|
|
607
589
|
/**
|
|
608
|
-
* <p>An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs.
|
|
609
|
-
* Required if you specify one or more <code>LogPaths</code>.</p>
|
|
590
|
+
* <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>
|
|
610
591
|
* @public
|
|
611
592
|
*/
|
|
612
593
|
ApplicationLogOutputUri?: string | undefined;
|
|
@@ -617,25 +598,22 @@ export interface CreateApplicationOutput {
|
|
|
617
598
|
ApplicationSourceUri?: string | undefined;
|
|
618
599
|
/**
|
|
619
600
|
* <p>An
|
|
620
|
-
* <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/9ZY8X7Wv6</code> or ID-<code>9ZY8X7Wv6</code>.
|
|
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>.
|
|
621
602
|
* </p>
|
|
622
603
|
* @public
|
|
623
604
|
*/
|
|
624
605
|
Id?: string | undefined;
|
|
625
606
|
/**
|
|
626
|
-
* <p>The current status of the application resource. Possible statuses include the
|
|
627
|
-
* following:</p>
|
|
607
|
+
* <p>The current status of the application resource. Possible statuses include the following:</p>
|
|
628
608
|
* <ul>
|
|
629
609
|
* <li>
|
|
630
610
|
* <p>
|
|
631
|
-
* <code>INITIALIZED</code>: Amazon GameLift Streams has received the request and is initiating the
|
|
632
|
-
* work flow to create an application. </p>
|
|
611
|
+
* <code>INITIALIZED</code>: Amazon GameLift Streams has received the request and is initiating the work flow to create an application. </p>
|
|
633
612
|
* </li>
|
|
634
613
|
* <li>
|
|
635
614
|
* <p>
|
|
636
|
-
* <code>PROCESSING</code>: The create application work flow is in process. Amazon GameLift Streams
|
|
637
|
-
*
|
|
638
|
-
* group.</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>
|
|
639
617
|
* </li>
|
|
640
618
|
* <li>
|
|
641
619
|
* <p>
|
|
@@ -643,21 +621,18 @@ export interface CreateApplicationOutput {
|
|
|
643
621
|
* </li>
|
|
644
622
|
* <li>
|
|
645
623
|
* <p>
|
|
646
|
-
* <code>ERROR</code>: An error occurred when setting up the application. See
|
|
647
|
-
* <code>StatusReason</code> for more information.</p>
|
|
624
|
+
* <code>ERROR</code>: An error occurred when setting up the application. See <code>StatusReason</code> for more information.</p>
|
|
648
625
|
* </li>
|
|
649
626
|
* <li>
|
|
650
627
|
* <p>
|
|
651
|
-
* <code>DELETING</code>: Amazon GameLift Streams is in the process of deleting the
|
|
652
|
-
* application.</p>
|
|
628
|
+
* <code>DELETING</code>: Amazon GameLift Streams is in the process of deleting the application.</p>
|
|
653
629
|
* </li>
|
|
654
630
|
* </ul>
|
|
655
631
|
* @public
|
|
656
632
|
*/
|
|
657
633
|
Status?: ApplicationStatus | undefined;
|
|
658
634
|
/**
|
|
659
|
-
* <p>A short description of the status reason when the application is in <code>ERROR</code>
|
|
660
|
-
* status.</p>
|
|
635
|
+
* <p>A short description of the status reason when the application is in <code>ERROR</code> status.</p>
|
|
661
636
|
* @public
|
|
662
637
|
*/
|
|
663
638
|
StatusReason?: ApplicationStatusReason | undefined;
|
|
@@ -688,7 +663,7 @@ export interface CreateApplicationOutput {
|
|
|
688
663
|
export interface DeleteApplicationInput {
|
|
689
664
|
/**
|
|
690
665
|
* <p>An
|
|
691
|
-
* <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/9ZY8X7Wv6</code> or ID-<code>9ZY8X7Wv6</code>.
|
|
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>.
|
|
692
667
|
* </p>
|
|
693
668
|
* @public
|
|
694
669
|
*/
|
|
@@ -700,7 +675,7 @@ export interface DeleteApplicationInput {
|
|
|
700
675
|
export interface GetApplicationInput {
|
|
701
676
|
/**
|
|
702
677
|
* <p>An
|
|
703
|
-
* <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/9ZY8X7Wv6</code> or ID-<code>9ZY8X7Wv6</code>.
|
|
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>.
|
|
704
679
|
* </p>
|
|
705
680
|
* @public
|
|
706
681
|
*/
|
|
@@ -711,9 +686,8 @@ export interface GetApplicationInput {
|
|
|
711
686
|
*/
|
|
712
687
|
export interface GetApplicationOutput {
|
|
713
688
|
/**
|
|
714
|
-
* <p>An Amazon Resource Name (ARN) that's assigned to an application resource and uniquely identifies it across
|
|
715
|
-
*
|
|
716
|
-
* account]:application/[resource ID]</code>.</p>
|
|
689
|
+
* <p>An Amazon Resource Name (ARN) that's assigned to an application resource and uniquely identifies it across all Amazon Web Services Regions. Format is
|
|
690
|
+
* <code>arn:aws:gameliftstreams:[AWS Region]:[AWS account]:application/[resource ID]</code>.</p>
|
|
717
691
|
* @public
|
|
718
692
|
*/
|
|
719
693
|
Arn: string | undefined;
|
|
@@ -723,9 +697,8 @@ export interface GetApplicationOutput {
|
|
|
723
697
|
*/
|
|
724
698
|
Description?: string | undefined;
|
|
725
699
|
/**
|
|
726
|
-
* <p>
|
|
727
|
-
*
|
|
728
|
-
* </p>
|
|
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>
|
|
729
702
|
* <p>A runtime environment can be one of the following:</p>
|
|
730
703
|
* <ul>
|
|
731
704
|
* <li>
|
|
@@ -735,7 +708,7 @@ export interface GetApplicationOutput {
|
|
|
735
708
|
* <ul>
|
|
736
709
|
* <li>
|
|
737
710
|
* <p>
|
|
738
|
-
* Ubuntu 22.04 LTS(<code>Type=UBUNTU, Version=22_04_LTS</code>)
|
|
711
|
+
* Ubuntu 22.04 LTS (<code>Type=UBUNTU, Version=22_04_LTS</code>)
|
|
739
712
|
* </p>
|
|
740
713
|
* </li>
|
|
741
714
|
* </ul>
|
|
@@ -761,22 +734,20 @@ export interface GetApplicationOutput {
|
|
|
761
734
|
*/
|
|
762
735
|
RuntimeEnvironment?: RuntimeEnvironment | undefined;
|
|
763
736
|
/**
|
|
764
|
-
* <p>The path and file name of the executable file that launches the content for
|
|
765
|
-
* streaming.</p>
|
|
737
|
+
* <p>The path and file name of the executable file that launches the content for streaming.</p>
|
|
766
738
|
* @public
|
|
767
739
|
*/
|
|
768
740
|
ExecutablePath?: string | undefined;
|
|
769
741
|
/**
|
|
770
742
|
* <p>Locations of log files that your content generates during a stream session.
|
|
771
743
|
* Amazon GameLift Streams uploads log files to the Amazon S3 bucket that you specify in <code>ApplicationLogOutputUri</code>
|
|
772
|
-
* at the end of a stream session. To retrieve stored log files, call <a>GetStreamSession</a>
|
|
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>
|
|
773
745
|
* and get the <code>LogFileLocationUri</code>.</p>
|
|
774
746
|
* @public
|
|
775
747
|
*/
|
|
776
748
|
ApplicationLogPaths?: string[] | undefined;
|
|
777
749
|
/**
|
|
778
|
-
* <p>An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs.
|
|
779
|
-
* Required if you specify one or more <code>LogPaths</code>.</p>
|
|
750
|
+
* <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>
|
|
780
751
|
* @public
|
|
781
752
|
*/
|
|
782
753
|
ApplicationLogOutputUri?: string | undefined;
|
|
@@ -787,25 +758,22 @@ export interface GetApplicationOutput {
|
|
|
787
758
|
ApplicationSourceUri?: string | undefined;
|
|
788
759
|
/**
|
|
789
760
|
* <p>An
|
|
790
|
-
* <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/9ZY8X7Wv6</code> or ID-<code>9ZY8X7Wv6</code>.
|
|
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>.
|
|
791
762
|
* </p>
|
|
792
763
|
* @public
|
|
793
764
|
*/
|
|
794
765
|
Id?: string | undefined;
|
|
795
766
|
/**
|
|
796
|
-
* <p>The current status of the application resource. Possible statuses include the
|
|
797
|
-
* following:</p>
|
|
767
|
+
* <p>The current status of the application resource. Possible statuses include the following:</p>
|
|
798
768
|
* <ul>
|
|
799
769
|
* <li>
|
|
800
770
|
* <p>
|
|
801
|
-
* <code>INITIALIZED</code>: Amazon GameLift Streams has received the request and is initiating the
|
|
802
|
-
* work flow to create an application. </p>
|
|
771
|
+
* <code>INITIALIZED</code>: Amazon GameLift Streams has received the request and is initiating the work flow to create an application. </p>
|
|
803
772
|
* </li>
|
|
804
773
|
* <li>
|
|
805
774
|
* <p>
|
|
806
|
-
* <code>PROCESSING</code>: The create application work flow is in process. Amazon GameLift Streams
|
|
807
|
-
*
|
|
808
|
-
* group.</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>
|
|
809
777
|
* </li>
|
|
810
778
|
* <li>
|
|
811
779
|
* <p>
|
|
@@ -813,21 +781,18 @@ export interface GetApplicationOutput {
|
|
|
813
781
|
* </li>
|
|
814
782
|
* <li>
|
|
815
783
|
* <p>
|
|
816
|
-
* <code>ERROR</code>: An error occurred when setting up the application. See
|
|
817
|
-
* <code>StatusReason</code> for more information.</p>
|
|
784
|
+
* <code>ERROR</code>: An error occurred when setting up the application. See <code>StatusReason</code> for more information.</p>
|
|
818
785
|
* </li>
|
|
819
786
|
* <li>
|
|
820
787
|
* <p>
|
|
821
|
-
* <code>DELETING</code>: Amazon GameLift Streams is in the process of deleting the
|
|
822
|
-
* application.</p>
|
|
788
|
+
* <code>DELETING</code>: Amazon GameLift Streams is in the process of deleting the application.</p>
|
|
823
789
|
* </li>
|
|
824
790
|
* </ul>
|
|
825
791
|
* @public
|
|
826
792
|
*/
|
|
827
793
|
Status?: ApplicationStatus | undefined;
|
|
828
794
|
/**
|
|
829
|
-
* <p>A short description of the status reason when the application is in <code>ERROR</code>
|
|
830
|
-
* status.</p>
|
|
795
|
+
* <p>A short description of the status reason when the application is in <code>ERROR</code> status.</p>
|
|
831
796
|
* @public
|
|
832
797
|
*/
|
|
833
798
|
StatusReason?: ApplicationStatusReason | undefined;
|
|
@@ -847,11 +812,9 @@ export interface GetApplicationOutput {
|
|
|
847
812
|
*/
|
|
848
813
|
LastUpdatedAt?: Date | undefined;
|
|
849
814
|
/**
|
|
850
|
-
* <p>
|
|
851
|
-
* A set of stream groups that this application is associated with. You can use any of these stream groups to stream your application.
|
|
852
|
-
* </p>
|
|
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>
|
|
853
816
|
* <p>This value is a
|
|
854
|
-
* 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/1AB2C3De4</code>.
|
|
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>.
|
|
855
818
|
* </p>
|
|
856
819
|
* @public
|
|
857
820
|
*/
|
|
@@ -872,28 +835,27 @@ export interface ListApplicationsInput {
|
|
|
872
835
|
*/
|
|
873
836
|
NextToken?: string | undefined;
|
|
874
837
|
/**
|
|
875
|
-
* <p>The number of results to return. Use this parameter with <code>NextToken</code> to
|
|
876
|
-
*
|
|
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>
|
|
877
840
|
* @public
|
|
878
841
|
*/
|
|
879
842
|
MaxResults?: number | undefined;
|
|
880
843
|
}
|
|
881
844
|
/**
|
|
882
|
-
* <p>Describes an application resource that represents a collection of content for
|
|
883
|
-
*
|
|
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>
|
|
884
847
|
* @public
|
|
885
848
|
*/
|
|
886
849
|
export interface ApplicationSummary {
|
|
887
850
|
/**
|
|
888
|
-
* <p>An Amazon Resource Name (ARN) that's assigned to an application resource and uniquely identifies the
|
|
889
|
-
*
|
|
890
|
-
* account]:application/[resource ID]</code>.</p>
|
|
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>
|
|
891
853
|
* @public
|
|
892
854
|
*/
|
|
893
855
|
Arn: string | undefined;
|
|
894
856
|
/**
|
|
895
857
|
* <p>An
|
|
896
|
-
* <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/9ZY8X7Wv6</code> or ID-<code>9ZY8X7Wv6</code>.
|
|
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>.
|
|
897
859
|
* </p>
|
|
898
860
|
* @public
|
|
899
861
|
*/
|
|
@@ -904,19 +866,16 @@ export interface ApplicationSummary {
|
|
|
904
866
|
*/
|
|
905
867
|
Description?: string | undefined;
|
|
906
868
|
/**
|
|
907
|
-
* <p>The current status of the application resource. Possible statuses include the
|
|
908
|
-
* following:</p>
|
|
869
|
+
* <p>The current status of the application resource. Possible statuses include the following:</p>
|
|
909
870
|
* <ul>
|
|
910
871
|
* <li>
|
|
911
872
|
* <p>
|
|
912
|
-
* <code>INITIALIZED</code>: Amazon GameLift Streams has received the request and is initiating the
|
|
913
|
-
* work flow to create an application. </p>
|
|
873
|
+
* <code>INITIALIZED</code>: Amazon GameLift Streams has received the request and is initiating the work flow to create an application. </p>
|
|
914
874
|
* </li>
|
|
915
875
|
* <li>
|
|
916
876
|
* <p>
|
|
917
|
-
* <code>PROCESSING</code>: The create application work flow is in process. Amazon GameLift Streams
|
|
918
|
-
*
|
|
919
|
-
* group.</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>
|
|
920
879
|
* </li>
|
|
921
880
|
* <li>
|
|
922
881
|
* <p>
|
|
@@ -924,13 +883,11 @@ export interface ApplicationSummary {
|
|
|
924
883
|
* </li>
|
|
925
884
|
* <li>
|
|
926
885
|
* <p>
|
|
927
|
-
* <code>ERROR</code>: An error occurred when setting up the application. See
|
|
928
|
-
* <code>StatusReason</code> for more information.</p>
|
|
886
|
+
* <code>ERROR</code>: An error occurred when setting up the application. See <code>StatusReason</code> for more information.</p>
|
|
929
887
|
* </li>
|
|
930
888
|
* <li>
|
|
931
889
|
* <p>
|
|
932
|
-
* <code>DELETING</code>: Amazon GameLift Streams is in the process of deleting the
|
|
933
|
-
* application.</p>
|
|
890
|
+
* <code>DELETING</code>: Amazon GameLift Streams is in the process of deleting the application.</p>
|
|
934
891
|
* </li>
|
|
935
892
|
* </ul>
|
|
936
893
|
* @public
|
|
@@ -947,9 +904,8 @@ export interface ApplicationSummary {
|
|
|
947
904
|
*/
|
|
948
905
|
LastUpdatedAt?: Date | undefined;
|
|
949
906
|
/**
|
|
950
|
-
* <p>
|
|
951
|
-
*
|
|
952
|
-
* </p>
|
|
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>
|
|
953
909
|
* <p>A runtime environment can be one of the following:</p>
|
|
954
910
|
* <ul>
|
|
955
911
|
* <li>
|
|
@@ -959,7 +915,7 @@ export interface ApplicationSummary {
|
|
|
959
915
|
* <ul>
|
|
960
916
|
* <li>
|
|
961
917
|
* <p>
|
|
962
|
-
* Ubuntu 22.04 LTS(<code>Type=UBUNTU, Version=22_04_LTS</code>)
|
|
918
|
+
* Ubuntu 22.04 LTS (<code>Type=UBUNTU, Version=22_04_LTS</code>)
|
|
963
919
|
* </p>
|
|
964
920
|
* </li>
|
|
965
921
|
* </ul>
|
|
@@ -990,8 +946,8 @@ export interface ApplicationSummary {
|
|
|
990
946
|
*/
|
|
991
947
|
export interface ListApplicationsOutput {
|
|
992
948
|
/**
|
|
993
|
-
* <p>A collection of Amazon GameLift Streams applications that are associated with the Amazon Web Services account in
|
|
994
|
-
*
|
|
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>
|
|
995
951
|
* @public
|
|
996
952
|
*/
|
|
997
953
|
Items?: ApplicationSummary[] | undefined;
|
|
@@ -1010,7 +966,7 @@ export interface ListApplicationsOutput {
|
|
|
1010
966
|
export interface UpdateApplicationInput {
|
|
1011
967
|
/**
|
|
1012
968
|
* <p>An
|
|
1013
|
-
* <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/9ZY8X7Wv6</code> or ID-<code>9ZY8X7Wv6</code>.
|
|
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>.
|
|
1014
970
|
* </p>
|
|
1015
971
|
* @public
|
|
1016
972
|
*/
|
|
@@ -1023,16 +979,15 @@ export interface UpdateApplicationInput {
|
|
|
1023
979
|
/**
|
|
1024
980
|
* <p>Locations of log files that your content generates during a stream session. Enter path
|
|
1025
981
|
* values that are relative to the <code>ApplicationSourceUri</code> location.
|
|
1026
|
-
* You can specify up to 10 log
|
|
982
|
+
* You can specify up to 10 log paths.
|
|
1027
983
|
* Amazon GameLift Streams uploads designated log files to the Amazon S3 bucket that you specify in <code>ApplicationLogOutputUri</code>
|
|
1028
|
-
* at the end of a stream session. To retrieve stored log files, call <a>GetStreamSession</a>
|
|
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>
|
|
1029
985
|
* and get the <code>LogFileLocationUri</code>.</p>
|
|
1030
986
|
* @public
|
|
1031
987
|
*/
|
|
1032
988
|
ApplicationLogPaths?: string[] | undefined;
|
|
1033
989
|
/**
|
|
1034
|
-
* <p>An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs.
|
|
1035
|
-
* Required if you specify one or more <code>LogPaths</code>.</p>
|
|
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>
|
|
1036
991
|
* <note>
|
|
1037
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>
|
|
1038
993
|
* </note>
|
|
@@ -1045,9 +1000,8 @@ export interface UpdateApplicationInput {
|
|
|
1045
1000
|
*/
|
|
1046
1001
|
export interface UpdateApplicationOutput {
|
|
1047
1002
|
/**
|
|
1048
|
-
* <p>An Amazon Resource Name (ARN) that's assigned to an application resource and uniquely identifies it across
|
|
1049
|
-
*
|
|
1050
|
-
* account]:application/[resource ID]</code>.</p>
|
|
1003
|
+
* <p>An Amazon Resource Name (ARN) that's assigned to an application resource and uniquely identifies it across all Amazon Web Services Regions. Format is
|
|
1004
|
+
* <code>arn:aws:gameliftstreams:[AWS Region]:[AWS account]:application/[resource ID]</code>.</p>
|
|
1051
1005
|
* @public
|
|
1052
1006
|
*/
|
|
1053
1007
|
Arn: string | undefined;
|
|
@@ -1057,9 +1011,8 @@ export interface UpdateApplicationOutput {
|
|
|
1057
1011
|
*/
|
|
1058
1012
|
Description?: string | undefined;
|
|
1059
1013
|
/**
|
|
1060
|
-
* <p>
|
|
1061
|
-
*
|
|
1062
|
-
* </p>
|
|
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>
|
|
1063
1016
|
* <p>A runtime environment can be one of the following:</p>
|
|
1064
1017
|
* <ul>
|
|
1065
1018
|
* <li>
|
|
@@ -1069,7 +1022,7 @@ export interface UpdateApplicationOutput {
|
|
|
1069
1022
|
* <ul>
|
|
1070
1023
|
* <li>
|
|
1071
1024
|
* <p>
|
|
1072
|
-
* Ubuntu 22.04 LTS(<code>Type=UBUNTU, Version=22_04_LTS</code>)
|
|
1025
|
+
* Ubuntu 22.04 LTS (<code>Type=UBUNTU, Version=22_04_LTS</code>)
|
|
1073
1026
|
* </p>
|
|
1074
1027
|
* </li>
|
|
1075
1028
|
* </ul>
|
|
@@ -1095,22 +1048,20 @@ export interface UpdateApplicationOutput {
|
|
|
1095
1048
|
*/
|
|
1096
1049
|
RuntimeEnvironment?: RuntimeEnvironment | undefined;
|
|
1097
1050
|
/**
|
|
1098
|
-
* <p>The path and file name of the executable file that launches the content for
|
|
1099
|
-
* streaming.</p>
|
|
1051
|
+
* <p>The path and file name of the executable file that launches the content for streaming.</p>
|
|
1100
1052
|
* @public
|
|
1101
1053
|
*/
|
|
1102
1054
|
ExecutablePath?: string | undefined;
|
|
1103
1055
|
/**
|
|
1104
1056
|
* <p>Locations of log files that your content generates during a stream session.
|
|
1105
1057
|
* Amazon GameLift Streams uploads log files to the Amazon S3 bucket that you specify in <code>ApplicationLogOutputUri</code>
|
|
1106
|
-
* at the end of a stream session. To retrieve stored log files, call <a>GetStreamSession</a>
|
|
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>
|
|
1107
1059
|
* and get the <code>LogFileLocationUri</code>.</p>
|
|
1108
1060
|
* @public
|
|
1109
1061
|
*/
|
|
1110
1062
|
ApplicationLogPaths?: string[] | undefined;
|
|
1111
1063
|
/**
|
|
1112
|
-
* <p>An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs.
|
|
1113
|
-
* Required if you specify one or more <code>LogPaths</code>.</p>
|
|
1064
|
+
* <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>
|
|
1114
1065
|
* @public
|
|
1115
1066
|
*/
|
|
1116
1067
|
ApplicationLogOutputUri?: string | undefined;
|
|
@@ -1121,25 +1072,22 @@ export interface UpdateApplicationOutput {
|
|
|
1121
1072
|
ApplicationSourceUri?: string | undefined;
|
|
1122
1073
|
/**
|
|
1123
1074
|
* <p>An
|
|
1124
|
-
* <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/9ZY8X7Wv6</code> or ID-<code>9ZY8X7Wv6</code>.
|
|
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>.
|
|
1125
1076
|
* </p>
|
|
1126
1077
|
* @public
|
|
1127
1078
|
*/
|
|
1128
1079
|
Id?: string | undefined;
|
|
1129
1080
|
/**
|
|
1130
|
-
* <p>The current status of the application resource. Possible statuses include the
|
|
1131
|
-
* following:</p>
|
|
1081
|
+
* <p>The current status of the application resource. Possible statuses include the following:</p>
|
|
1132
1082
|
* <ul>
|
|
1133
1083
|
* <li>
|
|
1134
1084
|
* <p>
|
|
1135
|
-
* <code>INITIALIZED</code>: Amazon GameLift Streams has received the request and is initiating the
|
|
1136
|
-
* work flow to create an application. </p>
|
|
1085
|
+
* <code>INITIALIZED</code>: Amazon GameLift Streams has received the request and is initiating the work flow to create an application. </p>
|
|
1137
1086
|
* </li>
|
|
1138
1087
|
* <li>
|
|
1139
1088
|
* <p>
|
|
1140
|
-
* <code>PROCESSING</code>: The create application work flow is in process. Amazon GameLift Streams
|
|
1141
|
-
*
|
|
1142
|
-
* group.</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>
|
|
1143
1091
|
* </li>
|
|
1144
1092
|
* <li>
|
|
1145
1093
|
* <p>
|
|
@@ -1147,21 +1095,18 @@ export interface UpdateApplicationOutput {
|
|
|
1147
1095
|
* </li>
|
|
1148
1096
|
* <li>
|
|
1149
1097
|
* <p>
|
|
1150
|
-
* <code>ERROR</code>: An error occurred when setting up the application. See
|
|
1151
|
-
* <code>StatusReason</code> for more information.</p>
|
|
1098
|
+
* <code>ERROR</code>: An error occurred when setting up the application. See <code>StatusReason</code> for more information.</p>
|
|
1152
1099
|
* </li>
|
|
1153
1100
|
* <li>
|
|
1154
1101
|
* <p>
|
|
1155
|
-
* <code>DELETING</code>: Amazon GameLift Streams is in the process of deleting the
|
|
1156
|
-
* application.</p>
|
|
1102
|
+
* <code>DELETING</code>: Amazon GameLift Streams is in the process of deleting the application.</p>
|
|
1157
1103
|
* </li>
|
|
1158
1104
|
* </ul>
|
|
1159
1105
|
* @public
|
|
1160
1106
|
*/
|
|
1161
1107
|
Status?: ApplicationStatus | undefined;
|
|
1162
1108
|
/**
|
|
1163
|
-
* <p>A short description of the status reason when the application is in <code>ERROR</code>
|
|
1164
|
-
* status.</p>
|
|
1109
|
+
* <p>A short description of the status reason when the application is in <code>ERROR</code> status.</p>
|
|
1165
1110
|
* @public
|
|
1166
1111
|
*/
|
|
1167
1112
|
StatusReason?: ApplicationStatusReason | undefined;
|
|
@@ -1181,11 +1126,9 @@ export interface UpdateApplicationOutput {
|
|
|
1181
1126
|
*/
|
|
1182
1127
|
LastUpdatedAt?: Date | undefined;
|
|
1183
1128
|
/**
|
|
1184
|
-
* <p>
|
|
1185
|
-
* A set of stream groups that this application is associated with. You can use any of these stream groups to stream your application.
|
|
1186
|
-
* </p>
|
|
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>
|
|
1187
1130
|
* <p>This value is a
|
|
1188
|
-
* 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/1AB2C3De4</code>.
|
|
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>.
|
|
1189
1132
|
* </p>
|
|
1190
1133
|
* @public
|
|
1191
1134
|
*/
|
|
@@ -1198,7 +1141,7 @@ export interface AssociateApplicationsInput {
|
|
|
1198
1141
|
/**
|
|
1199
1142
|
* <p>A stream group to associate to the applications.</p>
|
|
1200
1143
|
* <p>This value is a
|
|
1201
|
-
* <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/1AB2C3De4</code> or ID-<code>1AB2C3De4</code>.
|
|
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>.
|
|
1202
1145
|
* </p>
|
|
1203
1146
|
* @public
|
|
1204
1147
|
*/
|
|
@@ -1206,7 +1149,7 @@ export interface AssociateApplicationsInput {
|
|
|
1206
1149
|
/**
|
|
1207
1150
|
* <p>A set of applications to associate with the stream group.</p>
|
|
1208
1151
|
* <p>This value is a
|
|
1209
|
-
* 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/9ZY8X7Wv6</code> or ID-<code>9ZY8X7Wv6</code>.
|
|
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>.
|
|
1210
1153
|
* </p>
|
|
1211
1154
|
* @public
|
|
1212
1155
|
*/
|
|
@@ -1219,7 +1162,7 @@ export interface AssociateApplicationsOutput {
|
|
|
1219
1162
|
/**
|
|
1220
1163
|
* <p>A stream group that is associated to the applications.</p>
|
|
1221
1164
|
* <p>This value is a
|
|
1222
|
-
* <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/1AB2C3De4</code> or ID-<code>1AB2C3De4</code>.
|
|
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>.
|
|
1223
1166
|
* </p>
|
|
1224
1167
|
* @public
|
|
1225
1168
|
*/
|
|
@@ -1227,7 +1170,7 @@ export interface AssociateApplicationsOutput {
|
|
|
1227
1170
|
/**
|
|
1228
1171
|
* <p>A set of applications that are associated to the stream group.</p>
|
|
1229
1172
|
* <p>This value is a
|
|
1230
|
-
* 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/9ZY8X7Wv6</code> or ID-<code>9ZY8X7Wv6</code>.
|
|
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>.
|
|
1231
1174
|
* </p>
|
|
1232
1175
|
* @public
|
|
1233
1176
|
*/
|
|
@@ -1259,16 +1202,15 @@ export interface CreateStreamGroupInput {
|
|
|
1259
1202
|
*/
|
|
1260
1203
|
Description: string | undefined;
|
|
1261
1204
|
/**
|
|
1262
|
-
* <p>The target stream quality for sessions that are hosted in this stream group. Set a
|
|
1263
|
-
*
|
|
1264
|
-
*
|
|
1265
|
-
* streaming. The following options are available: </p>
|
|
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>
|
|
1266
1208
|
* <p>A stream class can be one of the following:</p>
|
|
1267
1209
|
* <ul>
|
|
1268
1210
|
* <li>
|
|
1269
1211
|
* <p>
|
|
1270
1212
|
* <b>
|
|
1271
|
-
* <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
|
|
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>
|
|
1272
1214
|
* <ul>
|
|
1273
1215
|
* <li>
|
|
1274
1216
|
* <p>Reference resolution: 1080p</p>
|
|
@@ -1327,7 +1269,7 @@ export interface CreateStreamGroupInput {
|
|
|
1327
1269
|
* <li>
|
|
1328
1270
|
* <p>
|
|
1329
1271
|
* <b>
|
|
1330
|
-
* <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
|
|
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>
|
|
1331
1273
|
* <ul>
|
|
1332
1274
|
* <li>
|
|
1333
1275
|
* <p>Reference resolution: 1080p</p>
|
|
@@ -1404,12 +1346,9 @@ export interface CreateStreamGroupInput {
|
|
|
1404
1346
|
*/
|
|
1405
1347
|
LocationConfigurations?: LocationConfiguration[] | undefined;
|
|
1406
1348
|
/**
|
|
1407
|
-
* <p>A list of labels to assign to the new stream group resource. Tags are
|
|
1408
|
-
*
|
|
1409
|
-
*
|
|
1410
|
-
* <i>Amazon Web Services General Reference</i>. You can use <a>TagResource</a>, <a>UntagResource</a>, and <a>ListTagsForResource</a> to add, remove, and view tags on existing resources.
|
|
1411
|
-
* The maximum tag limit might be lower than stated. See the <i>Amazon Web Services </i>
|
|
1412
|
-
* for actual tagging limits.</p>
|
|
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>
|
|
1413
1352
|
* @public
|
|
1414
1353
|
*/
|
|
1415
1354
|
Tags?: Record<string, string> | undefined;
|
|
@@ -1422,21 +1361,18 @@ export interface CreateStreamGroupInput {
|
|
|
1422
1361
|
ClientToken?: string | undefined;
|
|
1423
1362
|
}
|
|
1424
1363
|
/**
|
|
1425
|
-
* <p>Represents the Amazon GameLift Streams application that a stream group hosts.</p>
|
|
1364
|
+
* <p>Represents the default Amazon GameLift Streams application that a stream group hosts.</p>
|
|
1426
1365
|
* @public
|
|
1427
1366
|
*/
|
|
1428
1367
|
export interface DefaultApplication {
|
|
1429
1368
|
/**
|
|
1430
|
-
* <p>
|
|
1431
|
-
* <p>This value is an
|
|
1432
|
-
* <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/9ZY8X7Wv6</code> or ID-<code>9ZY8X7Wv6</code>.
|
|
1433
|
-
* </p>
|
|
1369
|
+
* <p>An ID that uniquely identifies the application resource. For example: <code>a-9ZY8X7Wv6</code>.</p>
|
|
1434
1370
|
* @public
|
|
1435
1371
|
*/
|
|
1436
1372
|
Id?: string | undefined;
|
|
1437
1373
|
/**
|
|
1438
1374
|
* <p>An
|
|
1439
|
-
* <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Name (ARN)</a>
|
|
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>.
|
|
1440
1376
|
* </p>
|
|
1441
1377
|
* @public
|
|
1442
1378
|
*/
|
|
@@ -1475,9 +1411,8 @@ export type StreamGroupStatusReason = (typeof StreamGroupStatusReason)[keyof typ
|
|
|
1475
1411
|
*/
|
|
1476
1412
|
export interface CreateStreamGroupOutput {
|
|
1477
1413
|
/**
|
|
1478
|
-
* <p>An Amazon Resource Name (ARN) that is assigned to the stream group resource and that uniquely identifies
|
|
1479
|
-
*
|
|
1480
|
-
* account]:streamgroup/[resource ID]</code>.</p>
|
|
1414
|
+
* <p>An Amazon Resource Name (ARN) that is assigned to the stream group resource and that uniquely identifies the group across all Amazon Web Services Regions. Format is
|
|
1415
|
+
* <code>arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamgroup/[resource ID]</code>.</p>
|
|
1481
1416
|
* @public
|
|
1482
1417
|
*/
|
|
1483
1418
|
Arn: string | undefined;
|
|
@@ -1487,7 +1422,7 @@ export interface CreateStreamGroupOutput {
|
|
|
1487
1422
|
*/
|
|
1488
1423
|
Description?: string | undefined;
|
|
1489
1424
|
/**
|
|
1490
|
-
* <p>The Amazon GameLift Streams application that is associated with this stream group.</p>
|
|
1425
|
+
* <p>The default Amazon GameLift Streams application that is associated with this stream group.</p>
|
|
1491
1426
|
* @public
|
|
1492
1427
|
*/
|
|
1493
1428
|
DefaultApplication?: DefaultApplication | undefined;
|
|
@@ -1530,7 +1465,7 @@ export interface CreateStreamGroupOutput {
|
|
|
1530
1465
|
* <li>
|
|
1531
1466
|
* <p>
|
|
1532
1467
|
* <b>
|
|
1533
|
-
* <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
|
|
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>
|
|
1534
1469
|
* <ul>
|
|
1535
1470
|
* <li>
|
|
1536
1471
|
* <p>Reference resolution: 1080p</p>
|
|
@@ -1589,7 +1524,7 @@ export interface CreateStreamGroupOutput {
|
|
|
1589
1524
|
* <li>
|
|
1590
1525
|
* <p>
|
|
1591
1526
|
* <b>
|
|
1592
|
-
* <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
|
|
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>
|
|
1593
1528
|
* <ul>
|
|
1594
1529
|
* <li>
|
|
1595
1530
|
* <p>Reference resolution: 1080p</p>
|
|
@@ -1650,8 +1585,7 @@ export interface CreateStreamGroupOutput {
|
|
|
1650
1585
|
*/
|
|
1651
1586
|
StreamClass?: StreamClass | undefined;
|
|
1652
1587
|
/**
|
|
1653
|
-
* <p>A unique ID value that is assigned to the resource when it's created. Format example:
|
|
1654
|
-
* <code>1AB2C3De4</code>.</p>
|
|
1588
|
+
* <p>A unique ID value that is assigned to the resource when it's created. Format example: <code>sg-1AB2C3De4</code>.</p>
|
|
1655
1589
|
* @public
|
|
1656
1590
|
*/
|
|
1657
1591
|
Id?: string | undefined;
|
|
@@ -1697,19 +1631,19 @@ export interface CreateStreamGroupOutput {
|
|
|
1697
1631
|
*/
|
|
1698
1632
|
Status?: StreamGroupStatus | undefined;
|
|
1699
1633
|
/**
|
|
1700
|
-
* <p>
|
|
1701
|
-
*
|
|
1702
|
-
* </p>
|
|
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>
|
|
1703
1636
|
* <ul>
|
|
1704
1637
|
* <li>
|
|
1705
1638
|
* <p>
|
|
1706
|
-
* <code>internalError</code>: The request can't process right now bcause of an issue with the server. Try again later. Reach out to
|
|
1707
|
-
*
|
|
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>
|
|
1708
1641
|
* </li>
|
|
1709
1642
|
* <li>
|
|
1710
1643
|
* <p>
|
|
1711
|
-
* <code>noAvailableInstances</code>: Amazon GameLift Streams does not currently have enough available On-Demand capacity to fulfill your request.
|
|
1712
|
-
*
|
|
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>
|
|
1713
1647
|
* </li>
|
|
1714
1648
|
* </ul>
|
|
1715
1649
|
* @public
|
|
@@ -1726,11 +1660,9 @@ export interface CreateStreamGroupOutput {
|
|
|
1726
1660
|
*/
|
|
1727
1661
|
CreatedAt?: Date | undefined;
|
|
1728
1662
|
/**
|
|
1729
|
-
* <p>
|
|
1730
|
-
* A set of applications that this stream group is associated to. You can stream any of these applications by using this stream group.
|
|
1731
|
-
* </p>
|
|
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>
|
|
1732
1664
|
* <p>This value is a
|
|
1733
|
-
* 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/9ZY8X7Wv6</code>.
|
|
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>.
|
|
1734
1666
|
* </p>
|
|
1735
1667
|
* @public
|
|
1736
1668
|
*/
|
|
@@ -1749,26 +1681,23 @@ export interface CreateStreamSessionConnectionInput {
|
|
|
1749
1681
|
ClientToken?: string | undefined;
|
|
1750
1682
|
/**
|
|
1751
1683
|
* <p>
|
|
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/1AB2C3De4</code> or ID-<code>1AB2C3De4</code>.
|
|
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>.
|
|
1753
1685
|
* </p>
|
|
1754
|
-
* <p>
|
|
1755
|
-
*
|
|
1756
|
-
* </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>
|
|
1757
1688
|
* @public
|
|
1758
1689
|
*/
|
|
1759
1690
|
Identifier: string | undefined;
|
|
1760
1691
|
/**
|
|
1761
1692
|
* <p>
|
|
1762
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>.
|
|
1763
|
-
* The stream session must be in
|
|
1764
|
-
* <code>PENDING_CLIENT_RECONNECTION</code> or <code>ACTIVE</code> status. </p>
|
|
1694
|
+
* The stream session must be in <code>PENDING_CLIENT_RECONNECTION</code> or <code>ACTIVE</code> status. </p>
|
|
1765
1695
|
* @public
|
|
1766
1696
|
*/
|
|
1767
1697
|
StreamSessionIdentifier: string | undefined;
|
|
1768
1698
|
/**
|
|
1769
|
-
* <p>A WebRTC ICE offer string to use when initializing a WebRTC connection. The offer is a
|
|
1770
|
-
*
|
|
1771
|
-
* newly generated, not the same offer provided to <code>StartStreamSession</code>. </p>
|
|
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>
|
|
1772
1701
|
* @public
|
|
1773
1702
|
*/
|
|
1774
1703
|
SignalRequest: string | undefined;
|
|
@@ -1778,8 +1707,7 @@ export interface CreateStreamSessionConnectionInput {
|
|
|
1778
1707
|
*/
|
|
1779
1708
|
export interface CreateStreamSessionConnectionOutput {
|
|
1780
1709
|
/**
|
|
1781
|
-
* <p>The WebRTC answer string that the stream server generates in response to the
|
|
1782
|
-
* <code>SignalRequest</code>. </p>
|
|
1710
|
+
* <p>The WebRTC answer string that the stream server generates in response to the <code>SignalRequest</code>. </p>
|
|
1783
1711
|
* @public
|
|
1784
1712
|
*/
|
|
1785
1713
|
SignalResponse?: string | undefined;
|
|
@@ -1789,8 +1717,7 @@ export interface CreateStreamSessionConnectionOutput {
|
|
|
1789
1717
|
*/
|
|
1790
1718
|
export interface DeleteStreamGroupInput {
|
|
1791
1719
|
/**
|
|
1792
|
-
* <p>The unique ID value of the stream group resource to delete. Format example:
|
|
1793
|
-
* <code>1AB2C3De4</code>.</p>
|
|
1720
|
+
* <p>The unique ID value of the stream group resource to delete. Format example: <code>sg-1AB2C3De4</code>.</p>
|
|
1794
1721
|
* @public
|
|
1795
1722
|
*/
|
|
1796
1723
|
Identifier: string | undefined;
|
|
@@ -1802,7 +1729,7 @@ export interface DisassociateApplicationsInput {
|
|
|
1802
1729
|
/**
|
|
1803
1730
|
* <p>A stream group to disassociate these applications from.</p>
|
|
1804
1731
|
* <p>This value is an
|
|
1805
|
-
* <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/1AB2C3De4</code> or ID-<code>1AB2C3De4</code>.
|
|
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>.
|
|
1806
1733
|
* </p>
|
|
1807
1734
|
* @public
|
|
1808
1735
|
*/
|
|
@@ -1810,7 +1737,7 @@ export interface DisassociateApplicationsInput {
|
|
|
1810
1737
|
/**
|
|
1811
1738
|
* <p>A set of applications that you want to disassociate from the stream group.</p>
|
|
1812
1739
|
* <p>This value is a
|
|
1813
|
-
* 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/9ZY8X7Wv6</code> or ID-<code>9ZY8X7Wv6</code>.
|
|
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>.
|
|
1814
1741
|
* </p>
|
|
1815
1742
|
* @public
|
|
1816
1743
|
*/
|
|
@@ -1822,7 +1749,7 @@ export interface DisassociateApplicationsInput {
|
|
|
1822
1749
|
export interface DisassociateApplicationsOutput {
|
|
1823
1750
|
/**
|
|
1824
1751
|
* <p>An
|
|
1825
|
-
* <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/1AB2C3De4</code> or ID-<code>1AB2C3De4</code>.
|
|
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>.
|
|
1826
1753
|
* </p>
|
|
1827
1754
|
* @public
|
|
1828
1755
|
*/
|
|
@@ -1830,7 +1757,7 @@ export interface DisassociateApplicationsOutput {
|
|
|
1830
1757
|
/**
|
|
1831
1758
|
* <p>A set of applications that are disassociated from this stream group.</p>
|
|
1832
1759
|
* <p>This value is a
|
|
1833
|
-
* 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/9ZY8X7Wv6</code> or ID-<code>9ZY8X7Wv6</code>.
|
|
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>.
|
|
1834
1761
|
* </p>
|
|
1835
1762
|
* @public
|
|
1836
1763
|
*/
|
|
@@ -1857,7 +1784,8 @@ export type ExportFilesStatus = (typeof ExportFilesStatus)[keyof typeof ExportFi
|
|
|
1857
1784
|
*/
|
|
1858
1785
|
export interface ExportFilesMetadata {
|
|
1859
1786
|
/**
|
|
1860
|
-
* <p>The result of the <a>ExportStreamSessionFiles</a>
|
|
1787
|
+
* <p>The result of the <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_ExportStreamSessionFiles.html">ExportStreamSessionFiles</a>
|
|
1788
|
+
* operation.</p>
|
|
1861
1789
|
* @public
|
|
1862
1790
|
*/
|
|
1863
1791
|
Status?: ExportFilesStatus | undefined;
|
|
@@ -1868,10 +1796,9 @@ export interface ExportFilesMetadata {
|
|
|
1868
1796
|
StatusReason?: string | undefined;
|
|
1869
1797
|
/**
|
|
1870
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
|
|
1871
|
-
* based on the stream session metadata. Alternatively, you can provide a custom file name with
|
|
1872
|
-
* <p>
|
|
1873
|
-
*
|
|
1874
|
-
* </p>
|
|
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>
|
|
1875
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
|
|
1876
1803
|
* at <code>s3://MyBucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip</code> or another similar name. </p>
|
|
1877
1804
|
* @public
|
|
@@ -1884,7 +1811,7 @@ export interface ExportFilesMetadata {
|
|
|
1884
1811
|
export interface ExportStreamSessionFilesInput {
|
|
1885
1812
|
/**
|
|
1886
1813
|
* <p>An
|
|
1887
|
-
* <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/1AB2C3De4</code> or ID-<code>1AB2C3De4</code>.
|
|
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>.
|
|
1888
1815
|
* </p>
|
|
1889
1816
|
* @public
|
|
1890
1817
|
*/
|
|
@@ -1898,10 +1825,9 @@ export interface ExportStreamSessionFilesInput {
|
|
|
1898
1825
|
StreamSessionIdentifier: string | undefined;
|
|
1899
1826
|
/**
|
|
1900
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
|
|
1901
|
-
* based on the stream session metadata. Alternatively, you can provide a custom file name with
|
|
1902
|
-
* <p>
|
|
1903
|
-
*
|
|
1904
|
-
* </p>
|
|
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>
|
|
1905
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
|
|
1906
1832
|
* at <code>s3://MyBucket/MyGameSessions_ExportedFiles/YYYYMMDD-HHMMSS-appId-sg-Id-sessionId.zip</code> or another similar name. </p>
|
|
1907
1833
|
* @public
|
|
@@ -1920,7 +1846,7 @@ export interface GetStreamSessionInput {
|
|
|
1920
1846
|
/**
|
|
1921
1847
|
* <p>The stream group that runs this stream session.</p>
|
|
1922
1848
|
* <p>This value is an
|
|
1923
|
-
* <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/1AB2C3De4</code> or ID-<code>1AB2C3De4</code>.
|
|
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>.
|
|
1924
1850
|
* </p>
|
|
1925
1851
|
* @public
|
|
1926
1852
|
*/
|
|
@@ -1981,22 +1907,18 @@ export type StreamSessionStatusReason = (typeof StreamSessionStatusReason)[keyof
|
|
|
1981
1907
|
*/
|
|
1982
1908
|
export interface GetStreamSessionOutput {
|
|
1983
1909
|
/**
|
|
1984
|
-
* <p>The Amazon Resource Name (ARN) assigned to the stream session resource. When combined with the stream group
|
|
1985
|
-
*
|
|
1986
|
-
* <code>arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamsession/[resource
|
|
1987
|
-
* ID]</code>.</p>
|
|
1910
|
+
* <p>The Amazon Resource Name (ARN) assigned to the stream session resource. When combined with the stream group ARN, this value uniquely identifies it across all
|
|
1911
|
+
* Amazon Web Services Regions. Format is <code>arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamsession/[resource ID]</code>.</p>
|
|
1988
1912
|
* @public
|
|
1989
1913
|
*/
|
|
1990
1914
|
Arn?: string | undefined;
|
|
1991
1915
|
/**
|
|
1992
|
-
* <p>A human-readable label for the stream session. You can update this value at any
|
|
1993
|
-
* time.</p>
|
|
1916
|
+
* <p>A human-readable label for the stream session. You can update this value at any time.</p>
|
|
1994
1917
|
* @public
|
|
1995
1918
|
*/
|
|
1996
1919
|
Description?: string | undefined;
|
|
1997
1920
|
/**
|
|
1998
|
-
* <p>The unique identifier for the Amazon GameLift Streams stream group that is hosting the stream
|
|
1999
|
-
* session.</p>
|
|
1921
|
+
* <p>The unique identifier for the Amazon GameLift Streams stream group that is hosting the stream session.</p>
|
|
2000
1922
|
* @public
|
|
2001
1923
|
*/
|
|
2002
1924
|
StreamGroupId?: string | undefined;
|
|
@@ -2008,14 +1930,12 @@ export interface GetStreamSessionOutput {
|
|
|
2008
1930
|
*/
|
|
2009
1931
|
UserId?: string | undefined;
|
|
2010
1932
|
/**
|
|
2011
|
-
* <p>The current status of the stream session. A stream session can host clients when in
|
|
2012
|
-
* <code>ACTIVE</code> status.</p>
|
|
1933
|
+
* <p>The current status of the stream session. A stream session can host clients when in <code>ACTIVE</code> status.</p>
|
|
2013
1934
|
* @public
|
|
2014
1935
|
*/
|
|
2015
1936
|
Status?: StreamSessionStatus | undefined;
|
|
2016
1937
|
/**
|
|
2017
|
-
* <p>A short description of the reason the stream session is in <code>ERROR</code>
|
|
2018
|
-
* status.</p>
|
|
1938
|
+
* <p>A short description of the reason the stream session is in <code>ERROR</code> status.</p>
|
|
2019
1939
|
* @public
|
|
2020
1940
|
*/
|
|
2021
1941
|
StatusReason?: StreamSessionStatusReason | undefined;
|
|
@@ -2027,29 +1947,24 @@ export interface GetStreamSessionOutput {
|
|
|
2027
1947
|
/**
|
|
2028
1948
|
* <p>The location where Amazon GameLift Streams is hosting the stream session.</p>
|
|
2029
1949
|
* <p>
|
|
2030
|
-
* A location's name. For example, <code>us-east-1</code>. For a complete list of locations that Amazon GameLift Streams supports,
|
|
2031
|
-
* the Regions and quotas section in the Amazon GameLift Streams Developer Guide
|
|
2032
|
-
* .
|
|
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>.
|
|
2033
1951
|
* </p>
|
|
2034
1952
|
* @public
|
|
2035
1953
|
*/
|
|
2036
1954
|
Location?: string | undefined;
|
|
2037
1955
|
/**
|
|
2038
|
-
* <p>The WebRTC ICE offer string that a client generates to initiate a connection to the
|
|
2039
|
-
* stream session.</p>
|
|
1956
|
+
* <p>The WebRTC ICE offer string that a client generates to initiate a connection to the stream session.</p>
|
|
2040
1957
|
* @public
|
|
2041
1958
|
*/
|
|
2042
1959
|
SignalRequest?: string | undefined;
|
|
2043
1960
|
/**
|
|
2044
|
-
* <p>The WebRTC answer string that the stream server generates in response to the
|
|
2045
|
-
* <code>SignalRequest</code>.</p>
|
|
1961
|
+
* <p>The WebRTC answer string that the stream server generates in response to the <code>SignalRequest</code>.</p>
|
|
2046
1962
|
* @public
|
|
2047
1963
|
*/
|
|
2048
1964
|
SignalResponse?: string | undefined;
|
|
2049
1965
|
/**
|
|
2050
|
-
* <p>The maximum length of time (in seconds) that Amazon GameLift Streams keeps the stream session open. At
|
|
2051
|
-
*
|
|
2052
|
-
* connections.</p>
|
|
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>
|
|
2053
1968
|
* @public
|
|
2054
1969
|
*/
|
|
2055
1970
|
ConnectionTimeoutSeconds?: number | undefined;
|
|
@@ -2082,15 +1997,13 @@ export interface GetStreamSessionOutput {
|
|
|
2082
1997
|
*/
|
|
2083
1998
|
AdditionalEnvironmentVariables?: Record<string, string> | undefined;
|
|
2084
1999
|
/**
|
|
2085
|
-
* <p>Access location for log files that your content generates during a stream session.
|
|
2086
|
-
*
|
|
2087
|
-
* The Amazon GameLift Streams application resource defines which log files to upload.</p>
|
|
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>
|
|
2088
2002
|
* @public
|
|
2089
2003
|
*/
|
|
2090
2004
|
LogFileLocationUri?: string | undefined;
|
|
2091
2005
|
/**
|
|
2092
|
-
* <p>The URL of an S3 bucket that stores Amazon GameLift Streams WebSDK files. The URL is used to establish
|
|
2093
|
-
* connection with the client.</p>
|
|
2006
|
+
* <p>The URL of an S3 bucket that stores Amazon GameLift Streams WebSDK files. The URL is used to establish connection with the client.</p>
|
|
2094
2007
|
* @public
|
|
2095
2008
|
*/
|
|
2096
2009
|
WebSdkProtocolUrl?: string | undefined;
|
|
@@ -2107,7 +2020,7 @@ export interface GetStreamSessionOutput {
|
|
|
2107
2020
|
/**
|
|
2108
2021
|
* <p>The application streaming in this session.</p>
|
|
2109
2022
|
* <p>This value is an
|
|
2110
|
-
* <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/9ZY8X7Wv6</code>.
|
|
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>.
|
|
2111
2024
|
* </p>
|
|
2112
2025
|
* @public
|
|
2113
2026
|
*/
|
|
@@ -2125,14 +2038,14 @@ export interface GetStreamSessionOutput {
|
|
|
2125
2038
|
*/
|
|
2126
2039
|
export interface ListStreamSessionsInput {
|
|
2127
2040
|
/**
|
|
2128
|
-
* <p>Filter by the stream session status. You can specify one status in each request
|
|
2129
|
-
*
|
|
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>
|
|
2130
2043
|
* @public
|
|
2131
2044
|
*/
|
|
2132
2045
|
Status?: StreamSessionStatus | undefined;
|
|
2133
2046
|
/**
|
|
2134
|
-
* <p>Filter by the exported files status. You can specify one status in each request
|
|
2135
|
-
*
|
|
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>
|
|
2136
2049
|
* <p>
|
|
2137
2050
|
* Exported files can be in one of the following states:
|
|
2138
2051
|
* </p>
|
|
@@ -2175,15 +2088,14 @@ export interface ListStreamSessionsInput {
|
|
|
2175
2088
|
*/
|
|
2176
2089
|
MaxResults?: number | undefined;
|
|
2177
2090
|
/**
|
|
2178
|
-
* <p>The unique identifier of a Amazon GameLift Streams stream group to retrieve the stream session for.
|
|
2179
|
-
*
|
|
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>
|
|
2180
2093
|
* @public
|
|
2181
2094
|
*/
|
|
2182
2095
|
Identifier: string | undefined;
|
|
2183
2096
|
}
|
|
2184
2097
|
/**
|
|
2185
|
-
* <p>Describes a Amazon GameLift Streams stream session. To retrieve additional details for the stream
|
|
2186
|
-
* session, call <a>GetStreamSession</a>.</p>
|
|
2098
|
+
* <p>Describes a Amazon GameLift Streams stream session. To retrieve additional details for the stream session, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamSession.html">GetStreamSession</a>.</p>
|
|
2187
2099
|
* @public
|
|
2188
2100
|
*/
|
|
2189
2101
|
export interface StreamSessionSummary {
|
|
@@ -2202,18 +2114,15 @@ export interface StreamSessionSummary {
|
|
|
2202
2114
|
*/
|
|
2203
2115
|
UserId?: string | undefined;
|
|
2204
2116
|
/**
|
|
2205
|
-
* <p>The current status of the stream session resource. Possible statuses include the
|
|
2206
|
-
* following: </p>
|
|
2117
|
+
* <p>The current status of the stream session resource. Possible statuses include the following: </p>
|
|
2207
2118
|
* <ul>
|
|
2208
2119
|
* <li>
|
|
2209
2120
|
* <p>
|
|
2210
|
-
* <code>ACTIVATING</code>: The stream session is starting and preparing to
|
|
2211
|
-
* stream.</p>
|
|
2121
|
+
* <code>ACTIVATING</code>: The stream session is starting and preparing to stream.</p>
|
|
2212
2122
|
* </li>
|
|
2213
2123
|
* <li>
|
|
2214
2124
|
* <p>
|
|
2215
|
-
* <code>ACTIVE</code>: The stream session is ready to accept client
|
|
2216
|
-
* connections.</p>
|
|
2125
|
+
* <code>ACTIVE</code>: The stream session is ready to accept client connections.</p>
|
|
2217
2126
|
* </li>
|
|
2218
2127
|
* <li>
|
|
2219
2128
|
* <p>
|
|
@@ -2221,9 +2130,8 @@ export interface StreamSessionSummary {
|
|
|
2221
2130
|
* </li>
|
|
2222
2131
|
* <li>
|
|
2223
2132
|
* <p>
|
|
2224
|
-
* <code>PENDING_CLIENT_RECONNECTION</code>: A client has recently disconnected,
|
|
2225
|
-
*
|
|
2226
|
-
* time, if the client doesn't reconnect, the stream session status transitions to
|
|
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
|
|
2227
2135
|
* <code>TERMINATED</code>.</p>
|
|
2228
2136
|
* </li>
|
|
2229
2137
|
* <li>
|
|
@@ -2259,7 +2167,7 @@ export interface StreamSessionSummary {
|
|
|
2259
2167
|
CreatedAt?: Date | undefined;
|
|
2260
2168
|
/**
|
|
2261
2169
|
* <p>An
|
|
2262
|
-
* <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/9ZY8X7Wv6</code> or ID-<code>9ZY8X7Wv6</code>.
|
|
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>.
|
|
2263
2171
|
* </p>
|
|
2264
2172
|
* @public
|
|
2265
2173
|
*/
|
|
@@ -2274,9 +2182,7 @@ export interface StreamSessionSummary {
|
|
|
2274
2182
|
/**
|
|
2275
2183
|
* <p>The location where Amazon GameLift Streams is hosting the stream session.</p>
|
|
2276
2184
|
* <p>
|
|
2277
|
-
* A location's name. For example, <code>us-east-1</code>. For a complete list of locations that Amazon GameLift Streams supports,
|
|
2278
|
-
* the Regions and quotas section in the Amazon GameLift Streams Developer Guide
|
|
2279
|
-
* .
|
|
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>.
|
|
2280
2186
|
* </p>
|
|
2281
2187
|
* @public
|
|
2282
2188
|
*/
|
|
@@ -2287,9 +2193,8 @@ export interface StreamSessionSummary {
|
|
|
2287
2193
|
*/
|
|
2288
2194
|
export interface ListStreamSessionsOutput {
|
|
2289
2195
|
/**
|
|
2290
|
-
* <p>A collection of Amazon GameLift Streams stream sessions that are associated with a stream group and
|
|
2291
|
-
*
|
|
2292
|
-
* status.</p>
|
|
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>
|
|
2293
2198
|
* @public
|
|
2294
2199
|
*/
|
|
2295
2200
|
Items?: StreamSessionSummary[] | undefined;
|
|
@@ -2307,14 +2212,14 @@ export interface ListStreamSessionsOutput {
|
|
|
2307
2212
|
*/
|
|
2308
2213
|
export interface ListStreamSessionsByAccountInput {
|
|
2309
2214
|
/**
|
|
2310
|
-
* <p>Filter by the stream session status. You can specify one status in each request
|
|
2311
|
-
*
|
|
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>
|
|
2312
2217
|
* @public
|
|
2313
2218
|
*/
|
|
2314
2219
|
Status?: StreamSessionStatus | undefined;
|
|
2315
2220
|
/**
|
|
2316
|
-
* <p>Filter by the exported files status. You can specify one status in each request
|
|
2317
|
-
*
|
|
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>
|
|
2318
2223
|
* @public
|
|
2319
2224
|
*/
|
|
2320
2225
|
ExportFilesStatus?: ExportFilesStatus | undefined;
|
|
@@ -2342,9 +2247,8 @@ export interface ListStreamSessionsByAccountInput {
|
|
|
2342
2247
|
*/
|
|
2343
2248
|
export interface ListStreamSessionsByAccountOutput {
|
|
2344
2249
|
/**
|
|
2345
|
-
* <p>A collection of Amazon GameLift Streams stream sessions that are associated with a stream group and
|
|
2346
|
-
*
|
|
2347
|
-
* status.</p>
|
|
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>
|
|
2348
2252
|
* @public
|
|
2349
2253
|
*/
|
|
2350
2254
|
Items?: StreamSessionSummary[] | undefined;
|
|
@@ -2362,8 +2266,8 @@ export interface ListStreamSessionsByAccountOutput {
|
|
|
2362
2266
|
*/
|
|
2363
2267
|
export interface ListTagsForResourceRequest {
|
|
2364
2268
|
/**
|
|
2365
|
-
* <p>The (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">Amazon Resource Name (ARN)</a> that you want to retrieve tags for. To get a
|
|
2366
|
-
* List or Get operation for the resource.</p>
|
|
2269
|
+
* <p>The (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">Amazon Resource Name (ARN)</a> that you want to retrieve tags for. To get a
|
|
2270
|
+
* Amazon GameLift Streams resource ARN, call a List or Get operation for the resource.</p>
|
|
2367
2271
|
* @public
|
|
2368
2272
|
*/
|
|
2369
2273
|
ResourceArn: string | undefined;
|
|
@@ -2383,27 +2287,17 @@ export interface ListTagsForResourceResponse {
|
|
|
2383
2287
|
*/
|
|
2384
2288
|
export interface RemoveStreamGroupLocationsInput {
|
|
2385
2289
|
/**
|
|
2386
|
-
* <p>
|
|
2387
|
-
*
|
|
2388
|
-
*
|
|
2389
|
-
*
|
|
2390
|
-
* This value is a
|
|
2391
|
-
* Amazon Resource Name (ARN) that uniquely identifies the stream group resource. Format example: <code>1AB2C3De4</code>.
|
|
2392
|
-
*
|
|
2393
|
-
* </p>
|
|
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>
|
|
2394
2294
|
* @public
|
|
2395
2295
|
*/
|
|
2396
2296
|
Identifier: string | undefined;
|
|
2397
2297
|
/**
|
|
2398
|
-
* <p>
|
|
2399
|
-
*
|
|
2400
|
-
*
|
|
2401
|
-
* <p>
|
|
2402
|
-
* A set of location names. For example, <code>us-east-1</code>. For a complete list of locations that Amazon GameLift Streams supports, see
|
|
2403
|
-
* the Regions and quotas section in the Amazon GameLift Streams Developer Guide
|
|
2404
|
-
* .
|
|
2405
|
-
*
|
|
2406
|
-
* </p>
|
|
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>
|
|
2407
2301
|
* @public
|
|
2408
2302
|
*/
|
|
2409
2303
|
Locations: string[] | undefined;
|
|
@@ -2427,7 +2321,7 @@ export interface StartStreamSessionInput {
|
|
|
2427
2321
|
/**
|
|
2428
2322
|
* <p>The stream group to run this stream session with.</p>
|
|
2429
2323
|
* <p>This value is an
|
|
2430
|
-
* <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/1AB2C3De4</code> or ID-<code>1AB2C3De4</code>.
|
|
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>.
|
|
2431
2325
|
* </p>
|
|
2432
2326
|
* @public
|
|
2433
2327
|
*/
|
|
@@ -2438,14 +2332,14 @@ export interface StartStreamSessionInput {
|
|
|
2438
2332
|
*/
|
|
2439
2333
|
Protocol: Protocol | undefined;
|
|
2440
2334
|
/**
|
|
2441
|
-
* <p>A WebRTC ICE offer string to use when initializing a WebRTC connection. The offer is a
|
|
2442
|
-
*
|
|
2335
|
+
* <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
|
|
2336
|
+
* text value in quotes.</p>
|
|
2443
2337
|
* @public
|
|
2444
2338
|
*/
|
|
2445
2339
|
SignalRequest: string | undefined;
|
|
2446
2340
|
/**
|
|
2447
2341
|
* <p>An
|
|
2448
|
-
* <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/9ZY8X7Wv6</code> or ID-<code>9ZY8X7Wv6</code>.
|
|
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>.
|
|
2449
2343
|
* </p>
|
|
2450
2344
|
* @public
|
|
2451
2345
|
*/
|
|
@@ -2458,31 +2352,24 @@ export interface StartStreamSessionInput {
|
|
|
2458
2352
|
*/
|
|
2459
2353
|
UserId?: string | undefined;
|
|
2460
2354
|
/**
|
|
2461
|
-
* <p> A list of locations, in order of priority, where you want Amazon GameLift Streams to start a stream
|
|
2462
|
-
*
|
|
2463
|
-
*
|
|
2464
|
-
*
|
|
2465
|
-
*
|
|
2466
|
-
* 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, see
|
|
2467
|
-
* the Regions and quotas section in the Amazon GameLift Streams Developer Guide
|
|
2468
|
-
* .
|
|
2469
|
-
*
|
|
2470
|
-
* </p>
|
|
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>
|
|
2471
2360
|
* @public
|
|
2472
2361
|
*/
|
|
2473
2362
|
Locations?: string[] | undefined;
|
|
2474
2363
|
/**
|
|
2475
|
-
* <p>Length of time (in seconds) that Amazon GameLift Streams should wait for a client to connect to the
|
|
2476
|
-
* stream session.
|
|
2477
|
-
*
|
|
2478
|
-
* the stream session with status of <code>TERMINATED</code>. Default value is 120.</p>
|
|
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>
|
|
2479
2367
|
* @public
|
|
2480
2368
|
*/
|
|
2481
2369
|
ConnectionTimeoutSeconds?: number | undefined;
|
|
2482
2370
|
/**
|
|
2483
|
-
* <p>The maximum length of time (in seconds) that Amazon GameLift Streams keeps the stream session open. At
|
|
2484
|
-
*
|
|
2485
|
-
* connections. Default value is 43200.</p>
|
|
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>
|
|
2486
2373
|
* @public
|
|
2487
2374
|
*/
|
|
2488
2375
|
SessionLengthSeconds?: number | undefined;
|
|
@@ -2515,22 +2402,18 @@ export interface StartStreamSessionInput {
|
|
|
2515
2402
|
*/
|
|
2516
2403
|
export interface StartStreamSessionOutput {
|
|
2517
2404
|
/**
|
|
2518
|
-
* <p>The Amazon Resource Name (ARN) assigned to the stream session resource. When combined with the stream group
|
|
2519
|
-
*
|
|
2520
|
-
* <code>arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamsession/[resource
|
|
2521
|
-
* ID]</code>.</p>
|
|
2405
|
+
* <p>The Amazon Resource Name (ARN) assigned to the stream session resource. When combined with the stream group ARN, this value uniquely identifies it across all
|
|
2406
|
+
* Amazon Web Services Regions. Format is <code>arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamsession/[resource ID]</code>.</p>
|
|
2522
2407
|
* @public
|
|
2523
2408
|
*/
|
|
2524
2409
|
Arn?: string | undefined;
|
|
2525
2410
|
/**
|
|
2526
|
-
* <p>A human-readable label for the stream session. You can update this value at any
|
|
2527
|
-
* time.</p>
|
|
2411
|
+
* <p>A human-readable label for the stream session. You can update this value at any time.</p>
|
|
2528
2412
|
* @public
|
|
2529
2413
|
*/
|
|
2530
2414
|
Description?: string | undefined;
|
|
2531
2415
|
/**
|
|
2532
|
-
* <p>The unique identifier for the Amazon GameLift Streams stream group that is hosting the stream
|
|
2533
|
-
* session.</p>
|
|
2416
|
+
* <p>The unique identifier for the Amazon GameLift Streams stream group that is hosting the stream session.</p>
|
|
2534
2417
|
* @public
|
|
2535
2418
|
*/
|
|
2536
2419
|
StreamGroupId?: string | undefined;
|
|
@@ -2542,14 +2425,12 @@ export interface StartStreamSessionOutput {
|
|
|
2542
2425
|
*/
|
|
2543
2426
|
UserId?: string | undefined;
|
|
2544
2427
|
/**
|
|
2545
|
-
* <p>The current status of the stream session. A stream session can host clients when in
|
|
2546
|
-
* <code>ACTIVE</code> status.</p>
|
|
2428
|
+
* <p>The current status of the stream session. A stream session can host clients when in <code>ACTIVE</code> status.</p>
|
|
2547
2429
|
* @public
|
|
2548
2430
|
*/
|
|
2549
2431
|
Status?: StreamSessionStatus | undefined;
|
|
2550
2432
|
/**
|
|
2551
|
-
* <p>A short description of the reason the stream session is in <code>ERROR</code>
|
|
2552
|
-
* status.</p>
|
|
2433
|
+
* <p>A short description of the reason the stream session is in <code>ERROR</code> status.</p>
|
|
2553
2434
|
* @public
|
|
2554
2435
|
*/
|
|
2555
2436
|
StatusReason?: StreamSessionStatusReason | undefined;
|
|
@@ -2559,33 +2440,26 @@ export interface StartStreamSessionOutput {
|
|
|
2559
2440
|
*/
|
|
2560
2441
|
Protocol?: Protocol | undefined;
|
|
2561
2442
|
/**
|
|
2562
|
-
* <p>
|
|
2563
|
-
* The location where Amazon GameLift Streams is streaming your application from.
|
|
2564
|
-
* </p>
|
|
2443
|
+
* <p> The location where Amazon GameLift Streams is streaming your application from. </p>
|
|
2565
2444
|
* <p>
|
|
2566
|
-
* A location's name. For example, <code>us-east-1</code>. For a complete list of locations that Amazon GameLift Streams supports,
|
|
2567
|
-
* the Regions and quotas section in the Amazon GameLift Streams Developer Guide
|
|
2568
|
-
* .
|
|
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>.
|
|
2569
2446
|
* </p>
|
|
2570
2447
|
* @public
|
|
2571
2448
|
*/
|
|
2572
2449
|
Location?: string | undefined;
|
|
2573
2450
|
/**
|
|
2574
|
-
* <p>The WebRTC ICE offer string that a client generates to initiate a connection to the
|
|
2575
|
-
* stream session.</p>
|
|
2451
|
+
* <p>The WebRTC ICE offer string that a client generates to initiate a connection to the stream session.</p>
|
|
2576
2452
|
* @public
|
|
2577
2453
|
*/
|
|
2578
2454
|
SignalRequest?: string | undefined;
|
|
2579
2455
|
/**
|
|
2580
|
-
* <p>The WebRTC answer string that the stream server generates in response to the
|
|
2581
|
-
* <code>SignalRequest</code>.</p>
|
|
2456
|
+
* <p>The WebRTC answer string that the stream server generates in response to the <code>SignalRequest</code>.</p>
|
|
2582
2457
|
* @public
|
|
2583
2458
|
*/
|
|
2584
2459
|
SignalResponse?: string | undefined;
|
|
2585
2460
|
/**
|
|
2586
|
-
* <p>The maximum length of time (in seconds) that Amazon GameLift Streams keeps the stream session open. At
|
|
2587
|
-
*
|
|
2588
|
-
* connections.</p>
|
|
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>
|
|
2589
2463
|
* @public
|
|
2590
2464
|
*/
|
|
2591
2465
|
ConnectionTimeoutSeconds?: number | undefined;
|
|
@@ -2618,15 +2492,13 @@ export interface StartStreamSessionOutput {
|
|
|
2618
2492
|
*/
|
|
2619
2493
|
AdditionalEnvironmentVariables?: Record<string, string> | undefined;
|
|
2620
2494
|
/**
|
|
2621
|
-
* <p>Access location for log files that your content generates during a stream session.
|
|
2622
|
-
*
|
|
2623
|
-
* The Amazon GameLift Streams application resource defines which log files to upload.</p>
|
|
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>
|
|
2624
2497
|
* @public
|
|
2625
2498
|
*/
|
|
2626
2499
|
LogFileLocationUri?: string | undefined;
|
|
2627
2500
|
/**
|
|
2628
|
-
* <p>The URL of an S3 bucket that stores Amazon GameLift Streams WebSDK files. The URL is used to establish
|
|
2629
|
-
* connection with the client.</p>
|
|
2501
|
+
* <p>The URL of an S3 bucket that stores Amazon GameLift Streams WebSDK files. The URL is used to establish connection with the client.</p>
|
|
2630
2502
|
* @public
|
|
2631
2503
|
*/
|
|
2632
2504
|
WebSdkProtocolUrl?: string | undefined;
|
|
@@ -2642,7 +2514,7 @@ export interface StartStreamSessionOutput {
|
|
|
2642
2514
|
CreatedAt?: Date | undefined;
|
|
2643
2515
|
/**
|
|
2644
2516
|
* <p>An
|
|
2645
|
-
* <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/9ZY8X7Wv6</code>.
|
|
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>.
|
|
2646
2518
|
* </p>
|
|
2647
2519
|
* @public
|
|
2648
2520
|
*/
|
|
@@ -2660,8 +2532,7 @@ export interface StartStreamSessionOutput {
|
|
|
2660
2532
|
*/
|
|
2661
2533
|
export interface GetStreamGroupInput {
|
|
2662
2534
|
/**
|
|
2663
|
-
* <p>The unique ID value of the stream group resource to retrieve. Format example:
|
|
2664
|
-
* <code>1AB2C3De4</code>.</p>
|
|
2535
|
+
* <p>The unique ID value of the stream group resource to retrieve. Format example: <code>sg-1AB2C3De4</code>.</p>
|
|
2665
2536
|
* @public
|
|
2666
2537
|
*/
|
|
2667
2538
|
Identifier: string | undefined;
|
|
@@ -2671,9 +2542,8 @@ export interface GetStreamGroupInput {
|
|
|
2671
2542
|
*/
|
|
2672
2543
|
export interface GetStreamGroupOutput {
|
|
2673
2544
|
/**
|
|
2674
|
-
* <p>An Amazon Resource Name (ARN) that is assigned to the stream group resource and that uniquely identifies
|
|
2675
|
-
*
|
|
2676
|
-
* account]:streamgroup/[resource ID]</code>.</p>
|
|
2545
|
+
* <p>An Amazon Resource Name (ARN) that is assigned to the stream group resource and that uniquely identifies the group across all Amazon Web Services Regions. Format is
|
|
2546
|
+
* <code>arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamgroup/[resource ID]</code>.</p>
|
|
2677
2547
|
* @public
|
|
2678
2548
|
*/
|
|
2679
2549
|
Arn: string | undefined;
|
|
@@ -2683,7 +2553,7 @@ export interface GetStreamGroupOutput {
|
|
|
2683
2553
|
*/
|
|
2684
2554
|
Description?: string | undefined;
|
|
2685
2555
|
/**
|
|
2686
|
-
* <p>The Amazon GameLift Streams application that is associated with this stream group.</p>
|
|
2556
|
+
* <p>The default Amazon GameLift Streams application that is associated with this stream group.</p>
|
|
2687
2557
|
* @public
|
|
2688
2558
|
*/
|
|
2689
2559
|
DefaultApplication?: DefaultApplication | undefined;
|
|
@@ -2726,7 +2596,7 @@ export interface GetStreamGroupOutput {
|
|
|
2726
2596
|
* <li>
|
|
2727
2597
|
* <p>
|
|
2728
2598
|
* <b>
|
|
2729
|
-
* <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
|
|
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>
|
|
2730
2600
|
* <ul>
|
|
2731
2601
|
* <li>
|
|
2732
2602
|
* <p>Reference resolution: 1080p</p>
|
|
@@ -2785,7 +2655,7 @@ export interface GetStreamGroupOutput {
|
|
|
2785
2655
|
* <li>
|
|
2786
2656
|
* <p>
|
|
2787
2657
|
* <b>
|
|
2788
|
-
* <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
|
|
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>
|
|
2789
2659
|
* <ul>
|
|
2790
2660
|
* <li>
|
|
2791
2661
|
* <p>Reference resolution: 1080p</p>
|
|
@@ -2846,8 +2716,7 @@ export interface GetStreamGroupOutput {
|
|
|
2846
2716
|
*/
|
|
2847
2717
|
StreamClass?: StreamClass | undefined;
|
|
2848
2718
|
/**
|
|
2849
|
-
* <p>A unique ID value that is assigned to the resource when it's created. Format example:
|
|
2850
|
-
* <code>1AB2C3De4</code>.</p>
|
|
2719
|
+
* <p>A unique ID value that is assigned to the resource when it's created. Format example: <code>sg-1AB2C3De4</code>.</p>
|
|
2851
2720
|
* @public
|
|
2852
2721
|
*/
|
|
2853
2722
|
Id?: string | undefined;
|
|
@@ -2893,19 +2762,19 @@ export interface GetStreamGroupOutput {
|
|
|
2893
2762
|
*/
|
|
2894
2763
|
Status?: StreamGroupStatus | undefined;
|
|
2895
2764
|
/**
|
|
2896
|
-
* <p>
|
|
2897
|
-
*
|
|
2898
|
-
* </p>
|
|
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>
|
|
2899
2767
|
* <ul>
|
|
2900
2768
|
* <li>
|
|
2901
2769
|
* <p>
|
|
2902
|
-
* <code>internalError</code>: The request can't process right now bcause of an issue with the server. Try again later. Reach out to
|
|
2903
|
-
*
|
|
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>
|
|
2904
2772
|
* </li>
|
|
2905
2773
|
* <li>
|
|
2906
2774
|
* <p>
|
|
2907
|
-
* <code>noAvailableInstances</code>: Amazon GameLift Streams does not currently have enough available On-Demand capacity to fulfill your request.
|
|
2908
|
-
*
|
|
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>
|
|
2909
2778
|
* </li>
|
|
2910
2779
|
* </ul>
|
|
2911
2780
|
* @public
|
|
@@ -2922,11 +2791,9 @@ export interface GetStreamGroupOutput {
|
|
|
2922
2791
|
*/
|
|
2923
2792
|
CreatedAt?: Date | undefined;
|
|
2924
2793
|
/**
|
|
2925
|
-
* <p>
|
|
2926
|
-
* A set of applications that this stream group is associated to. You can stream any of these applications by using this stream group.
|
|
2927
|
-
* </p>
|
|
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>
|
|
2928
2795
|
* <p>This value is a
|
|
2929
|
-
* 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/9ZY8X7Wv6</code>.
|
|
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>.
|
|
2930
2797
|
* </p>
|
|
2931
2798
|
* @public
|
|
2932
2799
|
*/
|
|
@@ -2947,28 +2814,27 @@ export interface ListStreamGroupsInput {
|
|
|
2947
2814
|
*/
|
|
2948
2815
|
NextToken?: string | undefined;
|
|
2949
2816
|
/**
|
|
2950
|
-
* <p>The number of results to return. Use this parameter with <code>NextToken</code> to
|
|
2951
|
-
*
|
|
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>
|
|
2952
2819
|
* @public
|
|
2953
2820
|
*/
|
|
2954
2821
|
MaxResults?: number | undefined;
|
|
2955
2822
|
}
|
|
2956
2823
|
/**
|
|
2957
|
-
* <p>Describes a Amazon GameLift Streams stream group resource for hosting content streams. To retrieve
|
|
2958
|
-
* additional stream group details, call <a>GetStreamGroup</a>.</p>
|
|
2824
|
+
* <p>Describes a Amazon GameLift Streams stream group resource for hosting content streams. To retrieve additional stream group details, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamGroup.html">GetStreamGroup</a>.</p>
|
|
2959
2825
|
* @public
|
|
2960
2826
|
*/
|
|
2961
2827
|
export interface StreamGroupSummary {
|
|
2962
2828
|
/**
|
|
2963
2829
|
* <p>An
|
|
2964
|
-
* <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/1AB2C3De4</code> or ID-<code>1AB2C3De4</code>.
|
|
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>.
|
|
2965
2831
|
* </p>
|
|
2966
2832
|
* @public
|
|
2967
2833
|
*/
|
|
2968
2834
|
Arn: string | undefined;
|
|
2969
2835
|
/**
|
|
2970
2836
|
* <p>An
|
|
2971
|
-
* <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/1AB2C3De4</code> or ID-<code>1AB2C3De4</code>.
|
|
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>.
|
|
2972
2838
|
* </p>
|
|
2973
2839
|
* @public
|
|
2974
2840
|
*/
|
|
@@ -2979,8 +2845,7 @@ export interface StreamGroupSummary {
|
|
|
2979
2845
|
*/
|
|
2980
2846
|
Description?: string | undefined;
|
|
2981
2847
|
/**
|
|
2982
|
-
* <p>Object that identifies the Amazon GameLift Streams application to stream with this stream
|
|
2983
|
-
* group.</p>
|
|
2848
|
+
* <p>Object that identifies the Amazon GameLift Streams application to stream with this stream group.</p>
|
|
2984
2849
|
* @public
|
|
2985
2850
|
*/
|
|
2986
2851
|
DefaultApplication?: DefaultApplication | undefined;
|
|
@@ -2991,7 +2856,7 @@ export interface StreamGroupSummary {
|
|
|
2991
2856
|
* <li>
|
|
2992
2857
|
* <p>
|
|
2993
2858
|
* <b>
|
|
2994
|
-
* <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
|
|
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>
|
|
2995
2860
|
* <ul>
|
|
2996
2861
|
* <li>
|
|
2997
2862
|
* <p>Reference resolution: 1080p</p>
|
|
@@ -3050,7 +2915,7 @@ export interface StreamGroupSummary {
|
|
|
3050
2915
|
* <li>
|
|
3051
2916
|
* <p>
|
|
3052
2917
|
* <b>
|
|
3053
|
-
* <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
|
|
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>
|
|
3054
2919
|
* <ul>
|
|
3055
2920
|
* <li>
|
|
3056
2921
|
* <p>Reference resolution: 1080p</p>
|
|
@@ -3167,9 +3032,8 @@ export interface StreamGroupSummary {
|
|
|
3167
3032
|
*/
|
|
3168
3033
|
export interface ListStreamGroupsOutput {
|
|
3169
3034
|
/**
|
|
3170
|
-
* <p>A collection of Amazon GameLift Streams stream groups that are associated with the Amazon Web Services account in
|
|
3171
|
-
*
|
|
3172
|
-
* information.</p>
|
|
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>
|
|
3173
3037
|
* @public
|
|
3174
3038
|
*/
|
|
3175
3039
|
Items?: StreamGroupSummary[] | undefined;
|
|
@@ -3188,7 +3052,7 @@ export interface ListStreamGroupsOutput {
|
|
|
3188
3052
|
export interface UpdateStreamGroupInput {
|
|
3189
3053
|
/**
|
|
3190
3054
|
* <p>An
|
|
3191
|
-
* <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/1AB2C3De4</code> or ID-<code>1AB2C3De4</code>.
|
|
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>.
|
|
3192
3056
|
* </p>
|
|
3193
3057
|
* @public
|
|
3194
3058
|
*/
|
|
@@ -3211,9 +3075,8 @@ export interface UpdateStreamGroupInput {
|
|
|
3211
3075
|
*/
|
|
3212
3076
|
export interface UpdateStreamGroupOutput {
|
|
3213
3077
|
/**
|
|
3214
|
-
* <p>An Amazon Resource Name (ARN) that is assigned to the stream group resource and that uniquely identifies
|
|
3215
|
-
*
|
|
3216
|
-
* account]:streamgroup/[resource ID]</code>.</p>
|
|
3078
|
+
* <p>An Amazon Resource Name (ARN) that is assigned to the stream group resource and that uniquely identifies the group across all Amazon Web Services Regions. Format is
|
|
3079
|
+
* <code>arn:aws:gameliftstreams:[AWS Region]:[AWS account]:streamgroup/[resource ID]</code>.</p>
|
|
3217
3080
|
* @public
|
|
3218
3081
|
*/
|
|
3219
3082
|
Arn: string | undefined;
|
|
@@ -3223,7 +3086,7 @@ export interface UpdateStreamGroupOutput {
|
|
|
3223
3086
|
*/
|
|
3224
3087
|
Description?: string | undefined;
|
|
3225
3088
|
/**
|
|
3226
|
-
* <p>The Amazon GameLift Streams application that is associated with this stream group.</p>
|
|
3089
|
+
* <p>The default Amazon GameLift Streams application that is associated with this stream group.</p>
|
|
3227
3090
|
* @public
|
|
3228
3091
|
*/
|
|
3229
3092
|
DefaultApplication?: DefaultApplication | undefined;
|
|
@@ -3266,7 +3129,7 @@ export interface UpdateStreamGroupOutput {
|
|
|
3266
3129
|
* <li>
|
|
3267
3130
|
* <p>
|
|
3268
3131
|
* <b>
|
|
3269
|
-
* <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
|
|
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>
|
|
3270
3133
|
* <ul>
|
|
3271
3134
|
* <li>
|
|
3272
3135
|
* <p>Reference resolution: 1080p</p>
|
|
@@ -3325,7 +3188,7 @@ export interface UpdateStreamGroupOutput {
|
|
|
3325
3188
|
* <li>
|
|
3326
3189
|
* <p>
|
|
3327
3190
|
* <b>
|
|
3328
|
-
* <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
|
|
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>
|
|
3329
3192
|
* <ul>
|
|
3330
3193
|
* <li>
|
|
3331
3194
|
* <p>Reference resolution: 1080p</p>
|
|
@@ -3386,8 +3249,7 @@ export interface UpdateStreamGroupOutput {
|
|
|
3386
3249
|
*/
|
|
3387
3250
|
StreamClass?: StreamClass | undefined;
|
|
3388
3251
|
/**
|
|
3389
|
-
* <p>A unique ID value that is assigned to the resource when it's created. Format example:
|
|
3390
|
-
* <code>1AB2C3De4</code>.</p>
|
|
3252
|
+
* <p>A unique ID value that is assigned to the resource when it's created. Format example: <code>sg-1AB2C3De4</code>.</p>
|
|
3391
3253
|
* @public
|
|
3392
3254
|
*/
|
|
3393
3255
|
Id?: string | undefined;
|
|
@@ -3433,19 +3295,19 @@ export interface UpdateStreamGroupOutput {
|
|
|
3433
3295
|
*/
|
|
3434
3296
|
Status?: StreamGroupStatus | undefined;
|
|
3435
3297
|
/**
|
|
3436
|
-
* <p>
|
|
3437
|
-
*
|
|
3438
|
-
* </p>
|
|
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>
|
|
3439
3300
|
* <ul>
|
|
3440
3301
|
* <li>
|
|
3441
3302
|
* <p>
|
|
3442
|
-
* <code>internalError</code>: The request can't process right now bcause of an issue with the server. Try again later. Reach out to
|
|
3443
|
-
*
|
|
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>
|
|
3444
3305
|
* </li>
|
|
3445
3306
|
* <li>
|
|
3446
3307
|
* <p>
|
|
3447
|
-
* <code>noAvailableInstances</code>: Amazon GameLift Streams does not currently have enough available On-Demand capacity to fulfill your request.
|
|
3448
|
-
*
|
|
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>
|
|
3449
3311
|
* </li>
|
|
3450
3312
|
* </ul>
|
|
3451
3313
|
* @public
|
|
@@ -3462,11 +3324,9 @@ export interface UpdateStreamGroupOutput {
|
|
|
3462
3324
|
*/
|
|
3463
3325
|
CreatedAt?: Date | undefined;
|
|
3464
3326
|
/**
|
|
3465
|
-
* <p>
|
|
3466
|
-
* A set of applications that this stream group is associated with. You can stream any of these applications with the stream group.
|
|
3467
|
-
* </p>
|
|
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>
|
|
3468
3328
|
* <p>This value is a
|
|
3469
|
-
* 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/9ZY8X7Wv6</code>.
|
|
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>.
|
|
3470
3330
|
* </p>
|
|
3471
3331
|
* @public
|
|
3472
3332
|
*/
|
|
@@ -3477,13 +3337,13 @@ export interface UpdateStreamGroupOutput {
|
|
|
3477
3337
|
*/
|
|
3478
3338
|
export interface TagResourceRequest {
|
|
3479
3339
|
/**
|
|
3480
|
-
* <p>The <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">Amazon Resource Name (ARN)</a> of the Amazon GameLift Streams resource that you want to apply
|
|
3340
|
+
* <p>The <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">Amazon Resource Name (ARN)</a> of the Amazon GameLift Streams resource that you want to apply
|
|
3341
|
+
* tags to.</p>
|
|
3481
3342
|
* @public
|
|
3482
3343
|
*/
|
|
3483
3344
|
ResourceArn: string | undefined;
|
|
3484
3345
|
/**
|
|
3485
|
-
* <p>A list of tags, in the form of key-value pairs, to assign to the specified Amazon GameLift Streams
|
|
3486
|
-
* resource.</p>
|
|
3346
|
+
* <p>A list of tags, in the form of key-value pairs, to assign to the specified Amazon GameLift Streams resource.</p>
|
|
3487
3347
|
* @public
|
|
3488
3348
|
*/
|
|
3489
3349
|
Tags: Record<string, string> | undefined;
|
|
@@ -3499,7 +3359,7 @@ export interface TagResourceResponse {
|
|
|
3499
3359
|
export interface TerminateStreamSessionInput {
|
|
3500
3360
|
/**
|
|
3501
3361
|
* <p>
|
|
3502
|
-
* <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/1AB2C3De4</code> or ID-<code>1AB2C3De4</code>.
|
|
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>.
|
|
3503
3363
|
* </p>
|
|
3504
3364
|
* <p>The stream group that runs this stream session.</p>
|
|
3505
3365
|
* @public
|
|
@@ -3518,7 +3378,8 @@ export interface TerminateStreamSessionInput {
|
|
|
3518
3378
|
*/
|
|
3519
3379
|
export interface UntagResourceRequest {
|
|
3520
3380
|
/**
|
|
3521
|
-
* <p>The <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">Amazon Resource Name (ARN)</a> of the Amazon GameLift Streams resource that you want to remove
|
|
3381
|
+
* <p>The <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">Amazon Resource Name (ARN)</a> of the Amazon GameLift Streams resource that you want to remove
|
|
3382
|
+
* tags from.</p>
|
|
3522
3383
|
* @public
|
|
3523
3384
|
*/
|
|
3524
3385
|
ResourceArn: string | undefined;
|