@aws-sdk/client-gameliftstreams 3.918.0 → 3.919.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/dist-cjs/index.js +5 -0
- package/dist-es/models/models_0.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +4 -0
- package/dist-types/commands/AddStreamGroupLocationsCommand.d.ts +1 -1
- package/dist-types/commands/CreateStreamGroupCommand.d.ts +3 -2
- package/dist-types/commands/DisassociateApplicationsCommand.d.ts +1 -1
- package/dist-types/commands/GetStreamGroupCommand.d.ts +2 -1
- package/dist-types/commands/ListStreamGroupsCommand.d.ts +2 -1
- package/dist-types/commands/RemoveStreamGroupLocationsCommand.d.ts +1 -1
- package/dist-types/commands/StartStreamSessionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateStreamGroupCommand.d.ts +3 -2
- package/dist-types/models/models_0.d.ts +25 -4
- package/dist-types/ts3.4/models/models_0.d.ts +5 -0
- package/package.json +3 -3
package/dist-cjs/index.js
CHANGED
|
@@ -259,6 +259,7 @@ const StreamGroupStatus = {
|
|
|
259
259
|
ACTIVE_WITH_ERRORS: "ACTIVE_WITH_ERRORS",
|
|
260
260
|
DELETING: "DELETING",
|
|
261
261
|
ERROR: "ERROR",
|
|
262
|
+
EXPIRED: "EXPIRED",
|
|
262
263
|
UPDATING_LOCATIONS: "UPDATING_LOCATIONS",
|
|
263
264
|
};
|
|
264
265
|
const StreamGroupStatusReason = {
|
|
@@ -712,6 +713,7 @@ const de_CreateStreamGroupCommand = async (output, context) => {
|
|
|
712
713
|
CreatedAt: (_) => smithyClient.expectNonNull(smithyClient.parseEpochTimestamp(smithyClient.expectNumber(_))),
|
|
713
714
|
DefaultApplication: smithyClient._json,
|
|
714
715
|
Description: smithyClient.expectString,
|
|
716
|
+
ExpiresAt: (_) => smithyClient.expectNonNull(smithyClient.parseEpochTimestamp(smithyClient.expectNumber(_))),
|
|
715
717
|
Id: smithyClient.expectString,
|
|
716
718
|
LastUpdatedAt: (_) => smithyClient.expectNonNull(smithyClient.parseEpochTimestamp(smithyClient.expectNumber(_))),
|
|
717
719
|
LocationStates: smithyClient._json,
|
|
@@ -822,6 +824,7 @@ const de_GetStreamGroupCommand = async (output, context) => {
|
|
|
822
824
|
CreatedAt: (_) => smithyClient.expectNonNull(smithyClient.parseEpochTimestamp(smithyClient.expectNumber(_))),
|
|
823
825
|
DefaultApplication: smithyClient._json,
|
|
824
826
|
Description: smithyClient.expectString,
|
|
827
|
+
ExpiresAt: (_) => smithyClient.expectNonNull(smithyClient.parseEpochTimestamp(smithyClient.expectNumber(_))),
|
|
825
828
|
Id: smithyClient.expectString,
|
|
826
829
|
LastUpdatedAt: (_) => smithyClient.expectNonNull(smithyClient.parseEpochTimestamp(smithyClient.expectNumber(_))),
|
|
827
830
|
LocationStates: smithyClient._json,
|
|
@@ -1053,6 +1056,7 @@ const de_UpdateStreamGroupCommand = async (output, context) => {
|
|
|
1053
1056
|
CreatedAt: (_) => smithyClient.expectNonNull(smithyClient.parseEpochTimestamp(smithyClient.expectNumber(_))),
|
|
1054
1057
|
DefaultApplication: smithyClient._json,
|
|
1055
1058
|
Description: smithyClient.expectString,
|
|
1059
|
+
ExpiresAt: (_) => smithyClient.expectNonNull(smithyClient.parseEpochTimestamp(smithyClient.expectNumber(_))),
|
|
1056
1060
|
Id: smithyClient.expectString,
|
|
1057
1061
|
LastUpdatedAt: (_) => smithyClient.expectNonNull(smithyClient.parseEpochTimestamp(smithyClient.expectNumber(_))),
|
|
1058
1062
|
LocationStates: smithyClient._json,
|
|
@@ -1217,6 +1221,7 @@ const de_StreamGroupSummary = (output, context) => {
|
|
|
1217
1221
|
CreatedAt: (_) => smithyClient.expectNonNull(smithyClient.parseEpochTimestamp(smithyClient.expectNumber(_))),
|
|
1218
1222
|
DefaultApplication: smithyClient._json,
|
|
1219
1223
|
Description: smithyClient.expectString,
|
|
1224
|
+
ExpiresAt: (_) => smithyClient.expectNonNull(smithyClient.parseEpochTimestamp(smithyClient.expectNumber(_))),
|
|
1220
1225
|
Id: smithyClient.expectString,
|
|
1221
1226
|
LastUpdatedAt: (_) => smithyClient.expectNonNull(smithyClient.parseEpochTimestamp(smithyClient.expectNumber(_))),
|
|
1222
1227
|
Status: smithyClient.expectString,
|
|
@@ -398,6 +398,7 @@ export const de_CreateStreamGroupCommand = async (output, context) => {
|
|
|
398
398
|
CreatedAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
399
399
|
DefaultApplication: _json,
|
|
400
400
|
Description: __expectString,
|
|
401
|
+
ExpiresAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
401
402
|
Id: __expectString,
|
|
402
403
|
LastUpdatedAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
403
404
|
LocationStates: _json,
|
|
@@ -508,6 +509,7 @@ export const de_GetStreamGroupCommand = async (output, context) => {
|
|
|
508
509
|
CreatedAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
509
510
|
DefaultApplication: _json,
|
|
510
511
|
Description: __expectString,
|
|
512
|
+
ExpiresAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
511
513
|
Id: __expectString,
|
|
512
514
|
LastUpdatedAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
513
515
|
LocationStates: _json,
|
|
@@ -739,6 +741,7 @@ export const de_UpdateStreamGroupCommand = async (output, context) => {
|
|
|
739
741
|
CreatedAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
740
742
|
DefaultApplication: _json,
|
|
741
743
|
Description: __expectString,
|
|
744
|
+
ExpiresAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
742
745
|
Id: __expectString,
|
|
743
746
|
LastUpdatedAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
744
747
|
LocationStates: _json,
|
|
@@ -903,6 +906,7 @@ const de_StreamGroupSummary = (output, context) => {
|
|
|
903
906
|
CreatedAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
904
907
|
DefaultApplication: _json,
|
|
905
908
|
Description: __expectString,
|
|
909
|
+
ExpiresAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
906
910
|
Id: __expectString,
|
|
907
911
|
LastUpdatedAt: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
908
912
|
Status: __expectString,
|
|
@@ -27,7 +27,7 @@ declare const AddStreamGroupLocationsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p> Add locations that can host stream sessions. You configure locations and their corresponding capacity for each stream group. Creating a stream group in a location that's nearest to your end users can help minimize latency and improve quality. </p> <p> This operation provisions stream capacity at the specified locations. By default, all locations have 1 or 2 capacity, depending on the stream class option: 2 for 'High' and 1 for 'Ultra' and 'Win2022'. This operation also copies the content files of all associated applications to an internal S3 bucket at each location. This allows Amazon GameLift Streams to host performant stream sessions. </p>
|
|
30
|
+
* <p> Add locations that can host stream sessions. To add a location, the stream group must be in <code>ACTIVE</code> status. You configure locations and their corresponding capacity for each stream group. Creating a stream group in a location that's nearest to your end users can help minimize latency and improve quality. </p> <p> This operation provisions stream capacity at the specified locations. By default, all locations have 1 or 2 capacity, depending on the stream class option: 2 for 'High' and 1 for 'Ultra' and 'Win2022'. This operation also copies the content files of all associated applications to an internal S3 bucket at each location. This allows Amazon GameLift Streams to host performant stream sessions. </p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const CreateStreamGroupCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
30
|
+
* <p> Stream groups manage how Amazon GameLift Streams allocates resources and handles concurrent streams, allowing you to effectively manage capacity and costs. Within a stream group, you specify an application to stream, streaming locations and their capacity, and the stream class you want to use when streaming applications to your end-users. A stream class defines the hardware configuration of the compute resources that Amazon GameLift Streams will use when streaming, such as the CPU, GPU, and memory. </p> <p> Stream capacity represents the number of concurrent streams that can be active at a time. You set stream capacity per location, per stream group. There are two types of capacity, always-on and on-demand: </p> <ul> <li> <p> <b>Always-on</b>: The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session. Default is 1 (2 for high stream classes) when creating a stream group or adding a location. </p> </li> <li> <p> <b>On-demand</b>: The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). Default is 0 when creating a stream group or adding a location. </p> </li> </ul> <p>Values for capacity must be whole number multiples of the tenancy value of the stream group's stream class.</p> <p> To adjust the capacity of any <code>ACTIVE</code> stream group, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_UpdateStreamGroup.html">UpdateStreamGroup</a>. </p> <p> If the <code>CreateStreamGroup</code> request is successful, Amazon GameLift Streams assigns a unique ID to the stream group resource and sets the status to <code>ACTIVATING</code>. It can take a few minutes for Amazon GameLift Streams to finish creating the stream group while it searches for unallocated compute resources and provisions them. When complete, the stream group status will be <code>ACTIVE</code> and you can start stream sessions by using <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_StartStreamSession.html">StartStreamSession</a>. To check the stream group's status, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamGroup.html">GetStreamGroup</a>. </p> <p>Stream groups should be recreated every 3-4 weeks to pick up important service updates and fixes. Stream groups that are older than 180 days can no longer be updated with new application associations. Stream groups expire when they are 365 days old, at which point they can no longer stream sessions. The exact expiration date is indicated by the date value in the <code>ExpiresAt</code> field.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -74,10 +74,11 @@ declare const CreateStreamGroupCommand_base: {
|
|
|
74
74
|
* // ],
|
|
75
75
|
* // StreamClass: "gen4n_high" || "gen4n_ultra" || "gen4n_win2022" || "gen5n_high" || "gen5n_ultra" || "gen5n_win2022",
|
|
76
76
|
* // Id: "STRING_VALUE",
|
|
77
|
-
* // Status: "ACTIVATING" || "UPDATING_LOCATIONS" || "ACTIVE" || "ACTIVE_WITH_ERRORS" || "ERROR" || "DELETING",
|
|
77
|
+
* // Status: "ACTIVATING" || "UPDATING_LOCATIONS" || "ACTIVE" || "ACTIVE_WITH_ERRORS" || "ERROR" || "DELETING" || "EXPIRED",
|
|
78
78
|
* // StatusReason: "internalError" || "noAvailableInstances",
|
|
79
79
|
* // LastUpdatedAt: new Date("TIMESTAMP"),
|
|
80
80
|
* // CreatedAt: new Date("TIMESTAMP"),
|
|
81
|
+
* // ExpiresAt: new Date("TIMESTAMP"),
|
|
81
82
|
* // AssociatedApplications: [ // ArnList
|
|
82
83
|
* // "STRING_VALUE",
|
|
83
84
|
* // ],
|
|
@@ -27,7 +27,7 @@ declare const DisassociateApplicationsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p> When you disassociate, or unlink, an application from a stream group, you can no longer stream this application by using that stream group's allocated compute resources. Any streams in process will continue until they terminate, which helps avoid interrupting an end-user's stream. Amazon GameLift Streams will not initiate new streams in the stream group using the disassociated application. The disassociate action does not affect the stream capacity of a stream group. </p> <p> If you disassociate the default application, Amazon GameLift Streams will automatically choose a new default application from the remaining associated applications. To change which application is the default application, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_UpdateStreamGroup.html">UpdateStreamGroup</a> and specify a new <code>DefaultApplicationIdentifier</code>. </p>
|
|
30
|
+
* <p> When you disassociate, or unlink, an application from a stream group, you can no longer stream this application by using that stream group's allocated compute resources. Any streams in process will continue until they terminate, which helps avoid interrupting an end-user's stream. Amazon GameLift Streams will not initiate new streams in the stream group using the disassociated application. The disassociate action does not affect the stream capacity of a stream group. To disassociate an application, the stream group must be in <code>ACTIVE</code> status. </p> <p> If you disassociate the default application, Amazon GameLift Streams will automatically choose a new default application from the remaining associated applications. To change which application is the default application, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_UpdateStreamGroup.html">UpdateStreamGroup</a> and specify a new <code>DefaultApplicationIdentifier</code>. </p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -61,10 +61,11 @@ declare const GetStreamGroupCommand_base: {
|
|
|
61
61
|
* // ],
|
|
62
62
|
* // StreamClass: "gen4n_high" || "gen4n_ultra" || "gen4n_win2022" || "gen5n_high" || "gen5n_ultra" || "gen5n_win2022",
|
|
63
63
|
* // Id: "STRING_VALUE",
|
|
64
|
-
* // Status: "ACTIVATING" || "UPDATING_LOCATIONS" || "ACTIVE" || "ACTIVE_WITH_ERRORS" || "ERROR" || "DELETING",
|
|
64
|
+
* // Status: "ACTIVATING" || "UPDATING_LOCATIONS" || "ACTIVE" || "ACTIVE_WITH_ERRORS" || "ERROR" || "DELETING" || "EXPIRED",
|
|
65
65
|
* // StatusReason: "internalError" || "noAvailableInstances",
|
|
66
66
|
* // LastUpdatedAt: new Date("TIMESTAMP"),
|
|
67
67
|
* // CreatedAt: new Date("TIMESTAMP"),
|
|
68
|
+
* // ExpiresAt: new Date("TIMESTAMP"),
|
|
68
69
|
* // AssociatedApplications: [ // ArnList
|
|
69
70
|
* // "STRING_VALUE",
|
|
70
71
|
* // ],
|
|
@@ -53,9 +53,10 @@ declare const ListStreamGroupsCommand_base: {
|
|
|
53
53
|
* // Arn: "STRING_VALUE",
|
|
54
54
|
* // },
|
|
55
55
|
* // StreamClass: "gen4n_high" || "gen4n_ultra" || "gen4n_win2022" || "gen5n_high" || "gen5n_ultra" || "gen5n_win2022",
|
|
56
|
-
* // Status: "ACTIVATING" || "UPDATING_LOCATIONS" || "ACTIVE" || "ACTIVE_WITH_ERRORS" || "ERROR" || "DELETING",
|
|
56
|
+
* // Status: "ACTIVATING" || "UPDATING_LOCATIONS" || "ACTIVE" || "ACTIVE_WITH_ERRORS" || "ERROR" || "DELETING" || "EXPIRED",
|
|
57
57
|
* // CreatedAt: new Date("TIMESTAMP"),
|
|
58
58
|
* // LastUpdatedAt: new Date("TIMESTAMP"),
|
|
59
|
+
* // ExpiresAt: new Date("TIMESTAMP"),
|
|
59
60
|
* // },
|
|
60
61
|
* // ],
|
|
61
62
|
* // NextToken: "STRING_VALUE",
|
|
@@ -27,7 +27,7 @@ declare const RemoveStreamGroupLocationsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p> Removes a set of remote locations from this stream group. Amazon GameLift Streams
|
|
30
|
+
* <p> Removes a set of remote locations from this stream group. To remove a location, the stream group must be in <code>ACTIVE</code> status. When you remove a location, Amazon GameLift Streams releases allocated compute resources in that location. Stream sessions can no longer start from removed locations in a stream group. Amazon GameLift Streams also deletes the content files of all associated applications that were in Amazon GameLift Streams's internal Amazon S3 bucket at this location. </p> <p> You cannot remove the Amazon Web Services Region location where you initially created this stream group, known as the primary location. However, you can set the stream capacity to zero to avoid incurring costs for allocated compute resources in that location. </p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const StartStreamSessionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p> This action initiates a new stream session and outputs connection information that clients can use to access the stream. A stream session refers to an instance of a stream that Amazon GameLift Streams transmits from the server to the end-user. A stream session runs on a compute resource that a stream group has allocated. The start stream session process works as follows: </p> <ol> <li> <p>Prerequisites:</p> <ul> <li> <p>You must have a stream group in <code>ACTIVE</code>
|
|
30
|
+
* <p> This action initiates a new stream session and outputs connection information that clients can use to access the stream. A stream session refers to an instance of a stream that Amazon GameLift Streams transmits from the server to the end-user. A stream session runs on a compute resource that a stream group has allocated. The start stream session process works as follows: </p> <ol> <li> <p>Prerequisites:</p> <ul> <li> <p>You must have a stream group in <code>ACTIVE</code> status</p> </li> <li> <p>You must have idle or on-demand capacity in a stream group in the location you want to stream from</p> </li> <li> <p>You must have at least one application associated to the stream group (use <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_AssociateApplications.html">AssociateApplications</a> if needed)</p> </li> </ul> </li> <li> <p>Start stream request:</p> <ul> <li> <p>Your backend server calls <b>StartStreamSession</b> to initiate connection</p> </li> <li> <p>Amazon GameLift Streams creates the stream session resource, assigns an Amazon Resource Name (ARN) value, and begins searching for available stream capacity to run the stream</p> </li> <li> <p>Session transitions to <code>ACTIVATING</code> status</p> </li> </ul> </li> <li> <p>Placement completion:</p> <ul> <li> <p>If Amazon GameLift Streams is successful in finding capacity for the stream, the stream session status changes to <code>ACTIVE</code> status and <b>StartStreamSession</b> returns stream connection information</p> </li> <li> <p>If Amazon GameLift Streams was not successful in finding capacity within the placement timeout period (defined according to the capacity type and platform type), the stream session status changes to <code>ERROR</code> status and <b>StartStreamSession</b> returns a <code>StatusReason</code> of <code>placementTimeout</code> </p> </li> </ul> </li> <li> <p>Connection completion:</p> <ul> <li> <p>Provide the new connection information to the requesting client</p> </li> <li> <p>Client must establish connection within <code>ConnectionTimeoutSeconds</code> (specified in <b>StartStreamSession</b> parameters)</p> </li> <li> <p>Session terminates automatically if client fails to connect in time</p> </li> </ul> </li> </ol> <p>For more information about the stream session lifecycle, see <a href="https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/stream-sessions.html">Stream sessions</a> in the <i>Amazon GameLift Streams Developer Guide</i>.</p> <p>Timeouts to be aware of that affect a stream session:</p> <ul> <li> <p> <b>Placement timeout</b>: The amount of time that Amazon GameLift Streams has to find capacity for a stream request. Placement timeout varies based on the capacity type used to fulfill your stream request:</p> <ul> <li> <p> <b>Always-on capacity</b>: 75 seconds</p> </li> <li> <p> <b>On-demand capacity</b>:</p> <ul> <li> <p>Linux/Proton runtimes: 90 seconds</p> </li> <li> <p>Windows runtime: 10 minutes</p> </li> </ul> </li> </ul> </li> <li> <p> <b>Connection timeout</b>: The amount of time that Amazon GameLift Streams waits for a client to connect to a stream session in <code>ACTIVE</code> status, or reconnect to a stream session in <code>PENDING_CLIENT_RECONNECTION</code> status, the latter of which occurs when a client disconnects or loses connection from a stream session. If no client connects before the timeout, Amazon GameLift Streams terminates the stream session. This value is specified by <code>ConnectionTimeoutSeconds</code> in the <code>StartStreamSession</code> parameters.</p> </li> <li> <p> <b>Idle timeout</b>: A stream session will be terminated if no user input has been received for 60 minutes.</p> </li> <li> <p> <b>Maximum session length</b>: A stream session will be terminated after this amount of time has elapsed since it started, regardless of any existing client connections. This value is specified by <code>SessionLengthSeconds</code> in the <code>StartStreamSession</code> parameters.</p> </li> </ul> <p>To start a new stream session, specify a stream group ID and application ID, along with the transport protocol and signal request to use with the stream session.</p> <p>For stream groups that have multiple locations, provide a set of locations ordered by priority using a <code>Locations</code> parameter. Amazon GameLift Streams will start a single stream session in the next available location. An application must be finished replicating to a remote location before the remote location can host a stream.</p> <p>To reconnect to a stream session after a client disconnects or loses connection, use <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_CreateStreamSessionConnection.html">CreateStreamSessionConnection</a>.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ declare const UpdateStreamGroupCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p> Updates the configuration settings for an Amazon GameLift Streams stream group resource. You can change the description, the set of locations, and the requested capacity of a stream group per location. If you want to change the stream class, create a new stream group. </p> <p> Stream capacity represents the number of concurrent streams that can be active at a time. You set stream capacity per location, per stream group. There are two types of capacity, always-on and on-demand: </p> <ul> <li> <p> <b>Always-on</b>: The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session. Default is 1 (2 for high stream classes) when creating a stream group or adding a location. </p> </li> <li> <p> <b>On-demand</b>: The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). Default is 0 when creating a stream group or adding a location. </p> </li> </ul> <p>Values for capacity must be whole number multiples of the tenancy value of the stream group's stream class.</p> <p>To update a stream group, specify the stream group's Amazon Resource Name (ARN) and provide the new values. If the request is successful, Amazon GameLift Streams returns the complete updated metadata for the stream group.</p>
|
|
30
|
+
* <p> Updates the configuration settings for an Amazon GameLift Streams stream group resource. To update a stream group, it must be in <code>ACTIVE</code> status. You can change the description, the set of locations, and the requested capacity of a stream group per location. If you want to change the stream class, create a new stream group. </p> <p> Stream capacity represents the number of concurrent streams that can be active at a time. You set stream capacity per location, per stream group. There are two types of capacity, always-on and on-demand: </p> <ul> <li> <p> <b>Always-on</b>: The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session. Default is 1 (2 for high stream classes) when creating a stream group or adding a location. </p> </li> <li> <p> <b>On-demand</b>: The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes). Default is 0 when creating a stream group or adding a location. </p> </li> </ul> <p>Values for capacity must be whole number multiples of the tenancy value of the stream group's stream class.</p> <p>To update a stream group, specify the stream group's Amazon Resource Name (ARN) and provide the new values. If the request is successful, Amazon GameLift Streams returns the complete updated metadata for the stream group. Expired stream groups cannot be updated.</p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
33
|
* ```javascript
|
|
@@ -70,10 +70,11 @@ declare const UpdateStreamGroupCommand_base: {
|
|
|
70
70
|
* // ],
|
|
71
71
|
* // StreamClass: "gen4n_high" || "gen4n_ultra" || "gen4n_win2022" || "gen5n_high" || "gen5n_ultra" || "gen5n_win2022",
|
|
72
72
|
* // Id: "STRING_VALUE",
|
|
73
|
-
* // Status: "ACTIVATING" || "UPDATING_LOCATIONS" || "ACTIVE" || "ACTIVE_WITH_ERRORS" || "ERROR" || "DELETING",
|
|
73
|
+
* // Status: "ACTIVATING" || "UPDATING_LOCATIONS" || "ACTIVE" || "ACTIVE_WITH_ERRORS" || "ERROR" || "DELETING" || "EXPIRED",
|
|
74
74
|
* // StatusReason: "internalError" || "noAvailableInstances",
|
|
75
75
|
* // LastUpdatedAt: new Date("TIMESTAMP"),
|
|
76
76
|
* // CreatedAt: new Date("TIMESTAMP"),
|
|
77
|
+
* // ExpiresAt: new Date("TIMESTAMP"),
|
|
77
78
|
* // AssociatedApplications: [ // ArnList
|
|
78
79
|
* // "STRING_VALUE",
|
|
79
80
|
* // ],
|
|
@@ -806,6 +806,7 @@ export declare const StreamGroupStatus: {
|
|
|
806
806
|
readonly ACTIVE_WITH_ERRORS: "ACTIVE_WITH_ERRORS";
|
|
807
807
|
readonly DELETING: "DELETING";
|
|
808
808
|
readonly ERROR: "ERROR";
|
|
809
|
+
readonly EXPIRED: "EXPIRED";
|
|
809
810
|
readonly UPDATING_LOCATIONS: "UPDATING_LOCATIONS";
|
|
810
811
|
};
|
|
811
812
|
/**
|
|
@@ -859,7 +860,7 @@ export interface CreateStreamGroupOutput {
|
|
|
859
860
|
*/
|
|
860
861
|
Id?: string | undefined;
|
|
861
862
|
/**
|
|
862
|
-
* <p>The current status of the stream group resource. Possible statuses include the following:</p> <ul> <li> <p> <code>ACTIVATING</code>: The stream group is deploying and isn't ready to host streams. </p> </li> <li> <p> <code>ACTIVE</code>: The stream group is ready to host streams. </p> </li> <li> <p> <code>ACTIVE_WITH_ERRORS</code>: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error. </p> </li> <li> <p> <code>ERROR</code>: An error occurred when the stream group deployed. See <code>StatusReason</code> (returned by <code>CreateStreamGroup</code>, <code>GetStreamGroup</code>, and <code>UpdateStreamGroup</code>) for more information. </p> </li> <li> <p> <code>
|
|
863
|
+
* <p>The current status of the stream group resource. Possible statuses include the following:</p> <ul> <li> <p> <code>ACTIVATING</code>: The stream group is deploying and isn't ready to host streams. </p> </li> <li> <p> <code>ACTIVE</code>: The stream group is ready to host streams. </p> </li> <li> <p> <code>ACTIVE_WITH_ERRORS</code>: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error. </p> </li> <li> <p> <code>DELETING</code>: Amazon GameLift Streams is in the process of deleting the stream group. </p> </li> <li> <p> <code>ERROR</code>: An error occurred when the stream group deployed. See <code>StatusReason</code> (returned by <code>CreateStreamGroup</code>, <code>GetStreamGroup</code>, and <code>UpdateStreamGroup</code>) for more information. </p> </li> <li> <p> <code>EXPIRED</code>: The stream group is expired and can no longer host streams. This typically occurs when a stream group is 365 days old, as indicated by the value of <code>ExpiresAt</code>. Create a new stream group to resume streaming capabilities. </p> </li> <li> <p> <code>UPDATING_LOCATIONS</code>: One or more locations in the stream group are in the process of updating (either activating or deleting). </p> </li> </ul>
|
|
863
864
|
* @public
|
|
864
865
|
*/
|
|
865
866
|
Status?: StreamGroupStatus | undefined;
|
|
@@ -878,6 +879,11 @@ export interface CreateStreamGroupOutput {
|
|
|
878
879
|
* @public
|
|
879
880
|
*/
|
|
880
881
|
CreatedAt?: Date | undefined;
|
|
882
|
+
/**
|
|
883
|
+
* <p>The time at which this stream group expires. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC). After this time, you will no longer be able to update this stream group or use it to start stream sessions. Only Get and Delete operations will work on an expired stream group.</p>
|
|
884
|
+
* @public
|
|
885
|
+
*/
|
|
886
|
+
ExpiresAt?: Date | undefined;
|
|
881
887
|
/**
|
|
882
888
|
* <p> A set of applications that this stream group is associated to. You can stream any of these applications by using this stream group. </p> <p>This value is a set of <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Names (ARNs)</a> that uniquely identify application resources. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6</code>. </p>
|
|
883
889
|
* @public
|
|
@@ -1573,7 +1579,7 @@ export interface GetStreamGroupOutput {
|
|
|
1573
1579
|
*/
|
|
1574
1580
|
Id?: string | undefined;
|
|
1575
1581
|
/**
|
|
1576
|
-
* <p>The current status of the stream group resource. Possible statuses include the following:</p> <ul> <li> <p> <code>ACTIVATING</code>: The stream group is deploying and isn't ready to host streams. </p> </li> <li> <p> <code>ACTIVE</code>: The stream group is ready to host streams. </p> </li> <li> <p> <code>ACTIVE_WITH_ERRORS</code>: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error. </p> </li> <li> <p> <code>ERROR</code>: An error occurred when the stream group deployed. See <code>StatusReason</code> (returned by <code>CreateStreamGroup</code>, <code>GetStreamGroup</code>, and <code>UpdateStreamGroup</code>) for more information. </p> </li> <li> <p> <code>
|
|
1582
|
+
* <p>The current status of the stream group resource. Possible statuses include the following:</p> <ul> <li> <p> <code>ACTIVATING</code>: The stream group is deploying and isn't ready to host streams. </p> </li> <li> <p> <code>ACTIVE</code>: The stream group is ready to host streams. </p> </li> <li> <p> <code>ACTIVE_WITH_ERRORS</code>: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error. </p> </li> <li> <p> <code>DELETING</code>: Amazon GameLift Streams is in the process of deleting the stream group. </p> </li> <li> <p> <code>ERROR</code>: An error occurred when the stream group deployed. See <code>StatusReason</code> (returned by <code>CreateStreamGroup</code>, <code>GetStreamGroup</code>, and <code>UpdateStreamGroup</code>) for more information. </p> </li> <li> <p> <code>EXPIRED</code>: The stream group is expired and can no longer host streams. This typically occurs when a stream group is 365 days old, as indicated by the value of <code>ExpiresAt</code>. Create a new stream group to resume streaming capabilities. </p> </li> <li> <p> <code>UPDATING_LOCATIONS</code>: One or more locations in the stream group are in the process of updating (either activating or deleting). </p> </li> </ul>
|
|
1577
1583
|
* @public
|
|
1578
1584
|
*/
|
|
1579
1585
|
Status?: StreamGroupStatus | undefined;
|
|
@@ -1592,6 +1598,11 @@ export interface GetStreamGroupOutput {
|
|
|
1592
1598
|
* @public
|
|
1593
1599
|
*/
|
|
1594
1600
|
CreatedAt?: Date | undefined;
|
|
1601
|
+
/**
|
|
1602
|
+
* <p>The time at which this stream group expires. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC). After this time, you will no longer be able to update this stream group or use it to start stream sessions. Only Get and Delete operations will work on an expired stream group.</p>
|
|
1603
|
+
* @public
|
|
1604
|
+
*/
|
|
1605
|
+
ExpiresAt?: Date | undefined;
|
|
1595
1606
|
/**
|
|
1596
1607
|
* <p> A set of applications that this stream group is associated to. You can stream any of these applications by using this stream group. </p> <p>This value is a set of <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Names (ARNs)</a> that uniquely identify application resources. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6</code>. </p>
|
|
1597
1608
|
* @public
|
|
@@ -1644,7 +1655,7 @@ export interface StreamGroupSummary {
|
|
|
1644
1655
|
*/
|
|
1645
1656
|
StreamClass?: StreamClass | undefined;
|
|
1646
1657
|
/**
|
|
1647
|
-
* <p>The current status of the stream group resource. Possible statuses include the following:</p> <ul> <li> <p> <code>ACTIVATING</code>: The stream group is deploying and isn't ready to host streams. </p> </li> <li> <p> <code>ACTIVE</code>: The stream group is ready to host streams. </p> </li> <li> <p> <code>ACTIVE_WITH_ERRORS</code>: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error. </p> </li> <li> <p> <code>ERROR</code>: An error occurred when the stream group deployed. See <code>StatusReason</code> (returned by <code>CreateStreamGroup</code>, <code>GetStreamGroup</code>, and <code>UpdateStreamGroup</code>) for more information. </p> </li> <li> <p> <code>
|
|
1658
|
+
* <p>The current status of the stream group resource. Possible statuses include the following:</p> <ul> <li> <p> <code>ACTIVATING</code>: The stream group is deploying and isn't ready to host streams. </p> </li> <li> <p> <code>ACTIVE</code>: The stream group is ready to host streams. </p> </li> <li> <p> <code>ACTIVE_WITH_ERRORS</code>: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error. </p> </li> <li> <p> <code>DELETING</code>: Amazon GameLift Streams is in the process of deleting the stream group. </p> </li> <li> <p> <code>ERROR</code>: An error occurred when the stream group deployed. See <code>StatusReason</code> (returned by <code>CreateStreamGroup</code>, <code>GetStreamGroup</code>, and <code>UpdateStreamGroup</code>) for more information. </p> </li> <li> <p> <code>EXPIRED</code>: The stream group is expired and can no longer host streams. This typically occurs when a stream group is 365 days old, as indicated by the value of <code>ExpiresAt</code>. Create a new stream group to resume streaming capabilities. </p> </li> <li> <p> <code>UPDATING_LOCATIONS</code>: One or more locations in the stream group are in the process of updating (either activating or deleting). </p> </li> </ul>
|
|
1648
1659
|
* @public
|
|
1649
1660
|
*/
|
|
1650
1661
|
Status?: StreamGroupStatus | undefined;
|
|
@@ -1658,6 +1669,11 @@ export interface StreamGroupSummary {
|
|
|
1658
1669
|
* @public
|
|
1659
1670
|
*/
|
|
1660
1671
|
LastUpdatedAt?: Date | undefined;
|
|
1672
|
+
/**
|
|
1673
|
+
* <p>The time at which this stream group expires. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC). After this time, you will no longer be able to update this stream group or use it to start stream sessions. Only Get and Delete operations will work on an expired stream group.</p>
|
|
1674
|
+
* @public
|
|
1675
|
+
*/
|
|
1676
|
+
ExpiresAt?: Date | undefined;
|
|
1661
1677
|
}
|
|
1662
1678
|
/**
|
|
1663
1679
|
* @public
|
|
@@ -1734,7 +1750,7 @@ export interface UpdateStreamGroupOutput {
|
|
|
1734
1750
|
*/
|
|
1735
1751
|
Id?: string | undefined;
|
|
1736
1752
|
/**
|
|
1737
|
-
* <p>The current status of the stream group resource. Possible statuses include the following:</p> <ul> <li> <p> <code>ACTIVATING</code>: The stream group is deploying and isn't ready to host streams. </p> </li> <li> <p> <code>ACTIVE</code>: The stream group is ready to host streams. </p> </li> <li> <p> <code>ACTIVE_WITH_ERRORS</code>: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error. </p> </li> <li> <p> <code>ERROR</code>: An error occurred when the stream group deployed. See <code>StatusReason</code> (returned by <code>CreateStreamGroup</code>, <code>GetStreamGroup</code>, and <code>UpdateStreamGroup</code>) for more information. </p> </li> <li> <p> <code>
|
|
1753
|
+
* <p>The current status of the stream group resource. Possible statuses include the following:</p> <ul> <li> <p> <code>ACTIVATING</code>: The stream group is deploying and isn't ready to host streams. </p> </li> <li> <p> <code>ACTIVE</code>: The stream group is ready to host streams. </p> </li> <li> <p> <code>ACTIVE_WITH_ERRORS</code>: One or more locations in the stream group are in an error state. Verify the details of individual locations and remove any locations which are in error. </p> </li> <li> <p> <code>DELETING</code>: Amazon GameLift Streams is in the process of deleting the stream group. </p> </li> <li> <p> <code>ERROR</code>: An error occurred when the stream group deployed. See <code>StatusReason</code> (returned by <code>CreateStreamGroup</code>, <code>GetStreamGroup</code>, and <code>UpdateStreamGroup</code>) for more information. </p> </li> <li> <p> <code>EXPIRED</code>: The stream group is expired and can no longer host streams. This typically occurs when a stream group is 365 days old, as indicated by the value of <code>ExpiresAt</code>. Create a new stream group to resume streaming capabilities. </p> </li> <li> <p> <code>UPDATING_LOCATIONS</code>: One or more locations in the stream group are in the process of updating (either activating or deleting). </p> </li> </ul>
|
|
1738
1754
|
* @public
|
|
1739
1755
|
*/
|
|
1740
1756
|
Status?: StreamGroupStatus | undefined;
|
|
@@ -1753,6 +1769,11 @@ export interface UpdateStreamGroupOutput {
|
|
|
1753
1769
|
* @public
|
|
1754
1770
|
*/
|
|
1755
1771
|
CreatedAt?: Date | undefined;
|
|
1772
|
+
/**
|
|
1773
|
+
* <p>The time at which this stream group expires. Timestamps are expressed using in ISO8601 format, such as: <code>2022-12-27T22:29:40+00:00</code> (UTC). After this time, you will no longer be able to update this stream group or use it to start stream sessions. Only Get and Delete operations will work on an expired stream group.</p>
|
|
1774
|
+
* @public
|
|
1775
|
+
*/
|
|
1776
|
+
ExpiresAt?: Date | undefined;
|
|
1756
1777
|
/**
|
|
1757
1778
|
* <p> A set of applications that this stream group is associated with. You can stream any of these applications with the stream group. </p> <p>This value is a set of <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon Resource Names (ARNs)</a> that uniquely identify application resources. Example ARN: <code>arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6</code>. </p>
|
|
1758
1779
|
* @public
|
|
@@ -246,6 +246,7 @@ export declare const StreamGroupStatus: {
|
|
|
246
246
|
readonly ACTIVE_WITH_ERRORS: "ACTIVE_WITH_ERRORS";
|
|
247
247
|
readonly DELETING: "DELETING";
|
|
248
248
|
readonly ERROR: "ERROR";
|
|
249
|
+
readonly EXPIRED: "EXPIRED";
|
|
249
250
|
readonly UPDATING_LOCATIONS: "UPDATING_LOCATIONS";
|
|
250
251
|
};
|
|
251
252
|
export type StreamGroupStatus =
|
|
@@ -267,6 +268,7 @@ export interface CreateStreamGroupOutput {
|
|
|
267
268
|
StatusReason?: StreamGroupStatusReason | undefined;
|
|
268
269
|
LastUpdatedAt?: Date | undefined;
|
|
269
270
|
CreatedAt?: Date | undefined;
|
|
271
|
+
ExpiresAt?: Date | undefined;
|
|
270
272
|
AssociatedApplications?: string[] | undefined;
|
|
271
273
|
}
|
|
272
274
|
export interface CreateStreamSessionConnectionInput {
|
|
@@ -455,6 +457,7 @@ export interface GetStreamGroupOutput {
|
|
|
455
457
|
StatusReason?: StreamGroupStatusReason | undefined;
|
|
456
458
|
LastUpdatedAt?: Date | undefined;
|
|
457
459
|
CreatedAt?: Date | undefined;
|
|
460
|
+
ExpiresAt?: Date | undefined;
|
|
458
461
|
AssociatedApplications?: string[] | undefined;
|
|
459
462
|
}
|
|
460
463
|
export interface ListStreamGroupsInput {
|
|
@@ -470,6 +473,7 @@ export interface StreamGroupSummary {
|
|
|
470
473
|
Status?: StreamGroupStatus | undefined;
|
|
471
474
|
CreatedAt?: Date | undefined;
|
|
472
475
|
LastUpdatedAt?: Date | undefined;
|
|
476
|
+
ExpiresAt?: Date | undefined;
|
|
473
477
|
}
|
|
474
478
|
export interface ListStreamGroupsOutput {
|
|
475
479
|
Items?: StreamGroupSummary[] | undefined;
|
|
@@ -492,6 +496,7 @@ export interface UpdateStreamGroupOutput {
|
|
|
492
496
|
StatusReason?: StreamGroupStatusReason | undefined;
|
|
493
497
|
LastUpdatedAt?: Date | undefined;
|
|
494
498
|
CreatedAt?: Date | undefined;
|
|
499
|
+
ExpiresAt?: Date | undefined;
|
|
495
500
|
AssociatedApplications?: string[] | undefined;
|
|
496
501
|
}
|
|
497
502
|
export interface TagResourceRequest {
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-gameliftstreams",
|
|
3
3
|
"description": "AWS SDK for JavaScript Gameliftstreams Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.919.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-gameliftstreams",
|
|
@@ -21,10 +21,10 @@
|
|
|
21
21
|
"@aws-crypto/sha256-browser": "5.2.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "5.2.0",
|
|
23
23
|
"@aws-sdk/core": "3.916.0",
|
|
24
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
24
|
+
"@aws-sdk/credential-provider-node": "3.919.0",
|
|
25
25
|
"@aws-sdk/middleware-host-header": "3.914.0",
|
|
26
26
|
"@aws-sdk/middleware-logger": "3.914.0",
|
|
27
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
27
|
+
"@aws-sdk/middleware-recursion-detection": "3.919.0",
|
|
28
28
|
"@aws-sdk/middleware-user-agent": "3.916.0",
|
|
29
29
|
"@aws-sdk/region-config-resolver": "3.914.0",
|
|
30
30
|
"@aws-sdk/types": "3.914.0",
|