@aws-sdk/client-gameliftstreams 3.825.0 → 3.827.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -7
- package/dist-types/GameLiftStreams.d.ts +1 -6
- package/dist-types/GameLiftStreamsClient.d.ts +1 -6
- package/dist-types/commands/AddStreamGroupLocationsCommand.d.ts +2 -7
- package/dist-types/commands/AssociateApplicationsCommand.d.ts +2 -4
- package/dist-types/commands/CreateApplicationCommand.d.ts +3 -15
- package/dist-types/commands/CreateStreamGroupCommand.d.ts +3 -33
- package/dist-types/commands/CreateStreamSessionConnectionCommand.d.ts +3 -16
- package/dist-types/commands/DeleteApplicationCommand.d.ts +3 -26
- package/dist-types/commands/DeleteStreamGroupCommand.d.ts +3 -8
- package/dist-types/commands/DisassociateApplicationsCommand.d.ts +2 -8
- package/dist-types/commands/ExportStreamSessionFilesCommand.d.ts +2 -32
- package/dist-types/commands/GetApplicationCommand.d.ts +2 -4
- package/dist-types/commands/GetStreamGroupCommand.d.ts +2 -4
- package/dist-types/commands/GetStreamSessionCommand.d.ts +2 -4
- package/dist-types/commands/ListApplicationsCommand.d.ts +2 -4
- package/dist-types/commands/ListStreamGroupsCommand.d.ts +2 -4
- package/dist-types/commands/ListStreamSessionsByAccountCommand.d.ts +2 -7
- package/dist-types/commands/ListStreamSessionsCommand.d.ts +2 -6
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -13
- package/dist-types/commands/RemoveStreamGroupLocationsCommand.d.ts +2 -7
- package/dist-types/commands/StartStreamSessionCommand.d.ts +3 -28
- package/dist-types/commands/TagResourceCommand.d.ts +2 -22
- package/dist-types/commands/TerminateStreamSessionCommand.d.ts +2 -5
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -4
- package/dist-types/commands/UpdateApplicationCommand.d.ts +2 -6
- package/dist-types/commands/UpdateStreamGroupCommand.d.ts +3 -27
- package/dist-types/index.d.ts +1 -6
- package/dist-types/models/models_0.d.ts +179 -1770
- package/package.json +11 -11
package/README.md
CHANGED
|
@@ -6,13 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
AWS SDK for JavaScript GameLiftStreams Client for Node.js, Browser and React Native.
|
|
8
8
|
|
|
9
|
-
<fullname>Amazon GameLift Streams</fullname>
|
|
10
|
-
|
|
11
|
-
<p>Amazon GameLift Streams provides a global cloud solution for content streaming experiences. Use Amazon GameLift Streams tools to upload and configure content for
|
|
12
|
-
streaming, deploy and scale computing resources to host streams, and manage stream session placement to meet customer demand.</p>
|
|
13
|
-
<p>This Reference Guide describes the Amazon GameLift Streams service API. You can use the API through the Amazon Web Services SDK, the Command Line Interface (AWS CLI), or by making
|
|
14
|
-
direct REST calls through HTTPS.</p>
|
|
15
|
-
<p>See the <i>Amazon GameLift Streams Developer Guide</i> for more information on how Amazon GameLift Streams works and how to work with it.</p>
|
|
9
|
+
<fullname>Amazon GameLift Streams</fullname> <p>Amazon GameLift Streams provides a global cloud solution for content streaming experiences. Use Amazon GameLift Streams tools to upload and configure content for streaming, deploy and scale computing resources to host streams, and manage stream session placement to meet customer demand.</p> <p>This Reference Guide describes the Amazon GameLift Streams service API. You can use the API through the Amazon Web Services SDK, the Command Line Interface (CLI), or by making direct REST calls through HTTPS.</p> <p>See the <i>Amazon GameLift Streams Developer Guide</i> for more information on how Amazon GameLift Streams works and how to work with it.</p>
|
|
16
10
|
|
|
17
11
|
## Installing
|
|
18
12
|
|
|
@@ -174,12 +174,7 @@ export interface GameLiftStreams {
|
|
|
174
174
|
updateStreamGroup(args: UpdateStreamGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStreamGroupCommandOutput) => void): void;
|
|
175
175
|
}
|
|
176
176
|
/**
|
|
177
|
-
* <fullname>Amazon GameLift Streams</fullname>
|
|
178
|
-
* <p>Amazon GameLift Streams provides a global cloud solution for content streaming experiences. Use Amazon GameLift Streams tools to upload and configure content for
|
|
179
|
-
* streaming, deploy and scale computing resources to host streams, and manage stream session placement to meet customer demand.</p>
|
|
180
|
-
* <p>This Reference Guide describes the Amazon GameLift Streams service API. You can use the API through the Amazon Web Services SDK, the Command Line Interface (AWS CLI), or by making
|
|
181
|
-
* direct REST calls through HTTPS.</p>
|
|
182
|
-
* <p>See the <i>Amazon GameLift Streams Developer Guide</i> for more information on how Amazon GameLift Streams works and how to work with it.</p>
|
|
177
|
+
* <fullname>Amazon GameLift Streams</fullname> <p>Amazon GameLift Streams provides a global cloud solution for content streaming experiences. Use Amazon GameLift Streams tools to upload and configure content for streaming, deploy and scale computing resources to host streams, and manage stream session placement to meet customer demand.</p> <p>This Reference Guide describes the Amazon GameLift Streams service API. You can use the API through the Amazon Web Services SDK, the Command Line Interface (CLI), or by making direct REST calls through HTTPS.</p> <p>See the <i>Amazon GameLift Streams Developer Guide</i> for more information on how Amazon GameLift Streams works and how to work with it.</p>
|
|
183
178
|
* @public
|
|
184
179
|
*/
|
|
185
180
|
export declare class GameLiftStreams extends GameLiftStreamsClient implements GameLiftStreams {
|
|
@@ -193,12 +193,7 @@ export type GameLiftStreamsClientResolvedConfigType = __SmithyResolvedConfigurat
|
|
|
193
193
|
export interface GameLiftStreamsClientResolvedConfig extends GameLiftStreamsClientResolvedConfigType {
|
|
194
194
|
}
|
|
195
195
|
/**
|
|
196
|
-
* <fullname>Amazon GameLift Streams</fullname>
|
|
197
|
-
* <p>Amazon GameLift Streams provides a global cloud solution for content streaming experiences. Use Amazon GameLift Streams tools to upload and configure content for
|
|
198
|
-
* streaming, deploy and scale computing resources to host streams, and manage stream session placement to meet customer demand.</p>
|
|
199
|
-
* <p>This Reference Guide describes the Amazon GameLift Streams service API. You can use the API through the Amazon Web Services SDK, the Command Line Interface (AWS CLI), or by making
|
|
200
|
-
* direct REST calls through HTTPS.</p>
|
|
201
|
-
* <p>See the <i>Amazon GameLift Streams Developer Guide</i> for more information on how Amazon GameLift Streams works and how to work with it.</p>
|
|
196
|
+
* <fullname>Amazon GameLift Streams</fullname> <p>Amazon GameLift Streams provides a global cloud solution for content streaming experiences. Use Amazon GameLift Streams tools to upload and configure content for streaming, deploy and scale computing resources to host streams, and manage stream session placement to meet customer demand.</p> <p>This Reference Guide describes the Amazon GameLift Streams service API. You can use the API through the Amazon Web Services SDK, the Command Line Interface (CLI), or by making direct REST calls through HTTPS.</p> <p>See the <i>Amazon GameLift Streams Developer Guide</i> for more information on how Amazon GameLift Streams works and how to work with it.</p>
|
|
202
197
|
* @public
|
|
203
198
|
*/
|
|
204
199
|
export declare class GameLiftStreamsClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, GameLiftStreamsClientResolvedConfig> {
|
|
@@ -27,11 +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
|
|
31
|
-
* stream group in a location that's nearest to your end users can help minimize latency and improve quality. </p>
|
|
32
|
-
* <p> This operation provisions stream capacity at the specified locations. By default, all locations have 1 or 2 capacity, depending on the
|
|
33
|
-
* stream class option: 2 for 'High' and 1 for 'Ultra' and 'Win2022'. This operation also copies the content files of all associated
|
|
34
|
-
* 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. 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>
|
|
35
31
|
* @example
|
|
36
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
33
|
* ```javascript
|
|
@@ -89,8 +85,7 @@ declare const AddStreamGroupLocationsCommand_base: {
|
|
|
89
85
|
* <p>The request was denied due to request throttling. Retry the request after the suggested wait time.</p>
|
|
90
86
|
*
|
|
91
87
|
* @throws {@link ValidationException} (client fault)
|
|
92
|
-
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before
|
|
93
|
-
* retrying the request.</p>
|
|
88
|
+
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.</p>
|
|
94
89
|
*
|
|
95
90
|
* @throws {@link GameLiftStreamsServiceException}
|
|
96
91
|
* <p>Base exception class for all service exceptions from GameLiftStreams service.</p>
|
|
@@ -27,8 +27,7 @@ declare const AssociateApplicationsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>When you associate, or link, an application with a stream group, then Amazon GameLift Streams can launch the application using the stream group's
|
|
31
|
-
* allocated compute resources. The stream group must be in <code>ACTIVE</code> status. You can reverse this action by using <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_DisassociateApplications.html">DisassociateApplications</a>.</p>
|
|
30
|
+
* <p>When you associate, or link, an application with a stream group, then Amazon GameLift Streams can launch the application using the stream group's allocated compute resources. The stream group must be in <code>ACTIVE</code> status. You can reverse this action by using <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_DisassociateApplications.html">DisassociateApplications</a>.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -74,8 +73,7 @@ declare const AssociateApplicationsCommand_base: {
|
|
|
74
73
|
* <p>The request was denied due to request throttling. Retry the request after the suggested wait time.</p>
|
|
75
74
|
*
|
|
76
75
|
* @throws {@link ValidationException} (client fault)
|
|
77
|
-
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before
|
|
78
|
-
* retrying the request.</p>
|
|
76
|
+
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.</p>
|
|
79
77
|
*
|
|
80
78
|
* @throws {@link GameLiftStreamsServiceException}
|
|
81
79
|
* <p>Base exception class for all service exceptions from GameLiftStreams service.</p>
|
|
@@ -27,17 +27,7 @@ declare const CreateApplicationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Creates an application resource in Amazon GameLift Streams, which specifies the application content you want to stream, such as a game build or other
|
|
31
|
-
* software, and configures the settings to run it.</p>
|
|
32
|
-
* <p> Before you create an application, upload your application content files to an Amazon Simple Storage Service (Amazon S3) bucket. For more information, see
|
|
33
|
-
* <b>Getting Started</b> in the Amazon GameLift Streams Developer Guide. </p>
|
|
34
|
-
* <important>
|
|
35
|
-
* <p> Make sure that your files in the Amazon S3 bucket are the correct version you want to use. As soon as you create a Amazon GameLift Streams application,
|
|
36
|
-
* you cannot change the files at a later time. </p>
|
|
37
|
-
* </important>
|
|
38
|
-
* <p> If the request is successful, Amazon GameLift Streams begins to create an application and sets the status to <code>INITIALIZED</code>. When an
|
|
39
|
-
* application reaches <code>READY</code> status, you can use the application to set up stream groups and start streams. To track application
|
|
40
|
-
* status, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetApplication.html">GetApplication</a>. </p>
|
|
30
|
+
* <p>Creates an application resource in Amazon GameLift Streams, which specifies the application content you want to stream, such as a game build or other software, and configures the settings to run it.</p> <p> Before you create an application, upload your application content files to an Amazon Simple Storage Service (Amazon S3) bucket. For more information, see <b>Getting Started</b> in the Amazon GameLift Streams Developer Guide. </p> <important> <p> Make sure that your files in the Amazon S3 bucket are the correct version you want to use. If you change the files at a later time, you will need to create a new Amazon GameLift Streams application. </p> </important> <p> If the request is successful, Amazon GameLift Streams begins to create an application and sets the status to <code>INITIALIZED</code>. When an application reaches <code>READY</code> status, you can use the application to set up stream groups and start streams. To track application status, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetApplication.html">GetApplication</a>. </p>
|
|
41
31
|
* @example
|
|
42
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
43
33
|
* ```javascript
|
|
@@ -104,8 +94,7 @@ declare const CreateApplicationCommand_base: {
|
|
|
104
94
|
* <p>You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.</p>
|
|
105
95
|
*
|
|
106
96
|
* @throws {@link ConflictException} (client fault)
|
|
107
|
-
* <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the
|
|
108
|
-
* conflict before retrying this request.</p>
|
|
97
|
+
* <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.</p>
|
|
109
98
|
*
|
|
110
99
|
* @throws {@link InternalServerException} (server fault)
|
|
111
100
|
* <p>The service encountered an internal error and is unable to complete the request.</p>
|
|
@@ -117,8 +106,7 @@ declare const CreateApplicationCommand_base: {
|
|
|
117
106
|
* <p>The request was denied due to request throttling. Retry the request after the suggested wait time.</p>
|
|
118
107
|
*
|
|
119
108
|
* @throws {@link ValidationException} (client fault)
|
|
120
|
-
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before
|
|
121
|
-
* retrying the request.</p>
|
|
109
|
+
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.</p>
|
|
122
110
|
*
|
|
123
111
|
* @throws {@link GameLiftStreamsServiceException}
|
|
124
112
|
* <p>Base exception class for all service exceptions from GameLiftStreams service.</p>
|
|
@@ -27,35 +27,7 @@ declare const CreateStreamGroupCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p> Manage how Amazon GameLift Streams streams your applications by using a stream group. A stream group is a collection of resources that Amazon GameLift Streams uses to
|
|
31
|
-
* stream your application to end-users. When you create a stream group, you specify an application to stream by default and the type of
|
|
32
|
-
* hardware to use, such as the graphical processing unit (GPU). You can also link additional applications, which allows you to stream those
|
|
33
|
-
* applications using this stream group. Depending on your expected users, you also scale the number of concurrent streams you want to
|
|
34
|
-
* support at one time, and in what locations. </p>
|
|
35
|
-
* <p>
|
|
36
|
-
* 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:
|
|
37
|
-
* </p>
|
|
38
|
-
* <ul>
|
|
39
|
-
* <li>
|
|
40
|
-
* <p>
|
|
41
|
-
* <b>Always-on</b>:
|
|
42
|
-
* 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.
|
|
43
|
-
*
|
|
44
|
-
* </p>
|
|
45
|
-
* </li>
|
|
46
|
-
* <li>
|
|
47
|
-
* <p>
|
|
48
|
-
* <b>On-demand</b>:
|
|
49
|
-
* 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).
|
|
50
|
-
*
|
|
51
|
-
* </p>
|
|
52
|
-
* </li>
|
|
53
|
-
* </ul>
|
|
54
|
-
* <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>
|
|
55
|
-
* <p> If the request is successful, Amazon GameLift Streams begins creating the stream group. Amazon GameLift Streams assigns a unique ID to the stream group resource and
|
|
56
|
-
* sets the status to <code>ACTIVATING</code>. When the stream group reaches <code>ACTIVE</code> status, you can start stream sessions by
|
|
57
|
-
* using <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_StartStreamSession.html">StartStreamSession</a>. To check the stream
|
|
58
|
-
* group's status, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamGroup.html">GetStreamGroup</a>. </p>
|
|
30
|
+
* <p> Manage how Amazon GameLift Streams streams your applications by using a stream group. A stream group is a collection of resources that Amazon GameLift Streams uses to stream your application to end-users. When you create a stream group, you specify an application to stream by default and the type of hardware to use, such as the graphical processing unit (GPU). You can also link additional applications, which allows you to stream those applications using this stream group. Depending on your expected users, you also scale the number of concurrent streams you want to support at one time, and in what locations. </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. </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). </p> </li> </ul> <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 request is successful, Amazon GameLift Streams begins creating the stream group. Amazon GameLift Streams assigns a unique ID to the stream group resource and sets the status to <code>ACTIVATING</code>. When the stream group reaches <code>ACTIVE</code> status, 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>
|
|
59
31
|
* @example
|
|
60
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
61
33
|
* ```javascript
|
|
@@ -121,8 +93,7 @@ declare const CreateStreamGroupCommand_base: {
|
|
|
121
93
|
* <p>You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.</p>
|
|
122
94
|
*
|
|
123
95
|
* @throws {@link ConflictException} (client fault)
|
|
124
|
-
* <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the
|
|
125
|
-
* conflict before retrying this request.</p>
|
|
96
|
+
* <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.</p>
|
|
126
97
|
*
|
|
127
98
|
* @throws {@link InternalServerException} (server fault)
|
|
128
99
|
* <p>The service encountered an internal error and is unable to complete the request.</p>
|
|
@@ -137,8 +108,7 @@ declare const CreateStreamGroupCommand_base: {
|
|
|
137
108
|
* <p>The request was denied due to request throttling. Retry the request after the suggested wait time.</p>
|
|
138
109
|
*
|
|
139
110
|
* @throws {@link ValidationException} (client fault)
|
|
140
|
-
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before
|
|
141
|
-
* retrying the request.</p>
|
|
111
|
+
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.</p>
|
|
142
112
|
*
|
|
143
113
|
* @throws {@link GameLiftStreamsServiceException}
|
|
144
114
|
* <p>Base exception class for all service exceptions from GameLiftStreams service.</p>
|
|
@@ -27,18 +27,7 @@ declare const CreateStreamSessionConnectionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Allows clients to reconnect to a recently disconnected stream session without losing any data from the last session.</p>
|
|
31
|
-
* <p>A client can reconnect to a stream session that's in <code>PENDING_CLIENT_RECONNECTION</code> or <code>ACTIVE</code> status. In the
|
|
32
|
-
* stream session life cycle, when the client disconnects from the stream session, the stream session transitions from <code>CONNECTED</code>
|
|
33
|
-
* to <code>PENDING_CLIENT_RECONNECTION</code> status. When a client requests to reconnect by calling
|
|
34
|
-
* <code>CreateStreamSessionConnection</code>, the stream session transitions to <code>RECONNECTING</code> status. When the reconnection
|
|
35
|
-
* is successful, the stream session transitions to <code>ACTIVE</code> status. After a stream session is disconnected for longer than
|
|
36
|
-
* <code>ConnectionTimeoutSeconds</code>, the stream session transitions to the <code>TERMINATED</code> status.</p>
|
|
37
|
-
* <p>To connect to an existing stream session, specify the stream group ID and stream session ID that you want to reconnect to, as well as
|
|
38
|
-
* the signal request settings to use with the stream.</p>
|
|
39
|
-
* <p>
|
|
40
|
-
* <code>ConnectionTimeoutSeconds</code> defines the amount of time after the stream session disconnects that a reconnection is allowed. If
|
|
41
|
-
* a client is disconnected from the stream for longer than <code>ConnectionTimeoutSeconds</code>, the stream session ends.</p>
|
|
30
|
+
* <p>Allows clients to reconnect to a recently disconnected stream session without losing any data from the last session.</p> <p>A client can reconnect to a stream session that's in <code>PENDING_CLIENT_RECONNECTION</code> or <code>ACTIVE</code> status. In the stream session life cycle, when the client disconnects from the stream session, the stream session transitions from <code>CONNECTED</code> to <code>PENDING_CLIENT_RECONNECTION</code> status. When a client requests to reconnect by calling <code>CreateStreamSessionConnection</code>, the stream session transitions to <code>RECONNECTING</code> status. When the reconnection is successful, the stream session transitions to <code>ACTIVE</code> status. After a stream session is disconnected for longer than <code>ConnectionTimeoutSeconds</code>, the stream session transitions to the <code>TERMINATED</code> status.</p> <p>To connect to an existing stream session, specify the stream group ID and stream session ID that you want to reconnect to, as well as the signal request settings to use with the stream.</p> <p> <code>ConnectionTimeoutSeconds</code> defines the amount of time after the stream session disconnects that a reconnection is allowed. If a client is disconnected from the stream for longer than <code>ConnectionTimeoutSeconds</code>, the stream session ends.</p>
|
|
42
31
|
* @example
|
|
43
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
44
33
|
* ```javascript
|
|
@@ -69,8 +58,7 @@ declare const CreateStreamSessionConnectionCommand_base: {
|
|
|
69
58
|
* <p>You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.</p>
|
|
70
59
|
*
|
|
71
60
|
* @throws {@link ConflictException} (client fault)
|
|
72
|
-
* <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the
|
|
73
|
-
* conflict before retrying this request.</p>
|
|
61
|
+
* <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.</p>
|
|
74
62
|
*
|
|
75
63
|
* @throws {@link InternalServerException} (server fault)
|
|
76
64
|
* <p>The service encountered an internal error and is unable to complete the request.</p>
|
|
@@ -82,8 +70,7 @@ declare const CreateStreamSessionConnectionCommand_base: {
|
|
|
82
70
|
* <p>The request was denied due to request throttling. Retry the request after the suggested wait time.</p>
|
|
83
71
|
*
|
|
84
72
|
* @throws {@link ValidationException} (client fault)
|
|
85
|
-
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before
|
|
86
|
-
* retrying the request.</p>
|
|
73
|
+
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.</p>
|
|
87
74
|
*
|
|
88
75
|
* @throws {@link GameLiftStreamsServiceException}
|
|
89
76
|
* <p>Base exception class for all service exceptions from GameLiftStreams service.</p>
|
|
@@ -27,28 +27,7 @@ declare const DeleteApplicationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Permanently deletes an Amazon GameLift Streams application resource. This also deletes the application content files stored with Amazon GameLift Streams. However,
|
|
31
|
-
* this does not delete the original files that you uploaded to your Amazon S3 bucket; you can delete these any time after Amazon GameLift Streams creates an
|
|
32
|
-
* application, which is the only time Amazon GameLift Streams accesses your Amazon S3 bucket.</p>
|
|
33
|
-
* <p> You can only delete an application that meets the following conditions: </p>
|
|
34
|
-
* <ul>
|
|
35
|
-
* <li>
|
|
36
|
-
* <p>The application is in <code>READY</code> or <code>ERROR</code> status. You cannot delete an application that's in
|
|
37
|
-
* <code>PROCESSING</code> or <code>INITIALIZED</code> status.</p>
|
|
38
|
-
* </li>
|
|
39
|
-
* <li>
|
|
40
|
-
* <p>The application is not the default application of any stream groups. You must first delete the stream group by using <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_DeleteStreamGroup.html">DeleteStreamGroup</a>.</p>
|
|
41
|
-
* </li>
|
|
42
|
-
* <li>
|
|
43
|
-
* <p>The application is not linked to any stream groups. You must first unlink the stream group by using <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_DisassociateApplications.html">DisassociateApplications</a>.</p>
|
|
44
|
-
* </li>
|
|
45
|
-
* <li>
|
|
46
|
-
* <p> An application is not streaming in any ongoing stream session. You must wait until the client ends the stream session or call
|
|
47
|
-
* <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_TerminateStreamSession.html">TerminateStreamSession</a> to end the
|
|
48
|
-
* stream. </p>
|
|
49
|
-
* </li>
|
|
50
|
-
* </ul>
|
|
51
|
-
* <p>If any active stream groups exist for this application, this request returns a <code>ValidationException</code>. </p>
|
|
30
|
+
* <p>Permanently deletes an Amazon GameLift Streams application resource. This also deletes the application content files stored with Amazon GameLift Streams. However, this does not delete the original files that you uploaded to your Amazon S3 bucket; you can delete these any time after Amazon GameLift Streams creates an application, which is the only time Amazon GameLift Streams accesses your Amazon S3 bucket.</p> <p> You can only delete an application that meets the following conditions: </p> <ul> <li> <p>The application is in <code>READY</code> or <code>ERROR</code> status. You cannot delete an application that's in <code>PROCESSING</code> or <code>INITIALIZED</code> status.</p> </li> <li> <p>The application is not the default application of any stream groups. You must first delete the stream group by using <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_DeleteStreamGroup.html">DeleteStreamGroup</a>.</p> </li> <li> <p>The application is not linked to any stream groups. You must first unlink the stream group by using <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_DisassociateApplications.html">DisassociateApplications</a>.</p> </li> <li> <p> An application is not streaming in any ongoing stream session. You must wait until the client ends the stream session or call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_TerminateStreamSession.html">TerminateStreamSession</a> to end the stream. </p> </li> </ul> <p>If any active stream groups exist for this application, this request returns a <code>ValidationException</code>. </p>
|
|
52
31
|
* @example
|
|
53
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
54
33
|
* ```javascript
|
|
@@ -74,8 +53,7 @@ declare const DeleteApplicationCommand_base: {
|
|
|
74
53
|
* <p>You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.</p>
|
|
75
54
|
*
|
|
76
55
|
* @throws {@link ConflictException} (client fault)
|
|
77
|
-
* <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the
|
|
78
|
-
* conflict before retrying this request.</p>
|
|
56
|
+
* <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.</p>
|
|
79
57
|
*
|
|
80
58
|
* @throws {@link InternalServerException} (server fault)
|
|
81
59
|
* <p>The service encountered an internal error and is unable to complete the request.</p>
|
|
@@ -87,8 +65,7 @@ declare const DeleteApplicationCommand_base: {
|
|
|
87
65
|
* <p>The request was denied due to request throttling. Retry the request after the suggested wait time.</p>
|
|
88
66
|
*
|
|
89
67
|
* @throws {@link ValidationException} (client fault)
|
|
90
|
-
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before
|
|
91
|
-
* retrying the request.</p>
|
|
68
|
+
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.</p>
|
|
92
69
|
*
|
|
93
70
|
* @throws {@link GameLiftStreamsServiceException}
|
|
94
71
|
* <p>Base exception class for all service exceptions from GameLiftStreams service.</p>
|
|
@@ -27,10 +27,7 @@ declare const DeleteStreamGroupCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Permanently deletes all compute resources and information related to a stream group. To delete a stream group, specify the unique stream
|
|
31
|
-
* group identifier. During the deletion process, the stream group's status is <code>DELETING</code>. This operation stops streams in
|
|
32
|
-
* progress and prevents new streams from starting. As a best practice, before deleting the stream group, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_ListStreamSessions.html">ListStreamSessions</a> to check for streams in progress and take action to stop
|
|
33
|
-
* them. When you delete a stream group, any application associations referring to that stream group are automatically removed.</p>
|
|
30
|
+
* <p>Permanently deletes all compute resources and information related to a stream group. To delete a stream group, specify the unique stream group identifier. During the deletion process, the stream group's status is <code>DELETING</code>. This operation stops streams in progress and prevents new streams from starting. As a best practice, before deleting the stream group, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_ListStreamSessions.html">ListStreamSessions</a> to check for streams in progress and take action to stop them. When you delete a stream group, any application associations referring to that stream group are automatically removed.</p>
|
|
34
31
|
* @example
|
|
35
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
33
|
* ```javascript
|
|
@@ -56,8 +53,7 @@ declare const DeleteStreamGroupCommand_base: {
|
|
|
56
53
|
* <p>You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.</p>
|
|
57
54
|
*
|
|
58
55
|
* @throws {@link ConflictException} (client fault)
|
|
59
|
-
* <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the
|
|
60
|
-
* conflict before retrying this request.</p>
|
|
56
|
+
* <p>The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.</p>
|
|
61
57
|
*
|
|
62
58
|
* @throws {@link InternalServerException} (server fault)
|
|
63
59
|
* <p>The service encountered an internal error and is unable to complete the request.</p>
|
|
@@ -69,8 +65,7 @@ declare const DeleteStreamGroupCommand_base: {
|
|
|
69
65
|
* <p>The request was denied due to request throttling. Retry the request after the suggested wait time.</p>
|
|
70
66
|
*
|
|
71
67
|
* @throws {@link ValidationException} (client fault)
|
|
72
|
-
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before
|
|
73
|
-
* retrying the request.</p>
|
|
68
|
+
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.</p>
|
|
74
69
|
*
|
|
75
70
|
* @throws {@link GameLiftStreamsServiceException}
|
|
76
71
|
* <p>Base exception class for all service exceptions from GameLiftStreams service.</p>
|
|
@@ -27,12 +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
|
|
31
|
-
* group's allocated compute resources. Any streams in process will continue until they terminate, which helps avoid interrupting an
|
|
32
|
-
* end-user's stream. Amazon GameLift Streams will not initiate new streams using this stream group. The disassociate action does not affect the stream
|
|
33
|
-
* capacity of a stream group. </p>
|
|
34
|
-
* <p> You can only disassociate an application if it's not a default application of the stream group. Check
|
|
35
|
-
* <code>DefaultApplicationIdentifier</code> by calling <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamGroup.html">GetStreamGroup</a>. </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 using this stream group. The disassociate action does not affect the stream capacity of a stream group. </p> <p> You can only disassociate an application if it's not a default application of the stream group. Check <code>DefaultApplicationIdentifier</code> by calling <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamGroup.html">GetStreamGroup</a>. </p>
|
|
36
31
|
* @example
|
|
37
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
33
|
* ```javascript
|
|
@@ -75,8 +70,7 @@ declare const DisassociateApplicationsCommand_base: {
|
|
|
75
70
|
* <p>The request was denied due to request throttling. Retry the request after the suggested wait time.</p>
|
|
76
71
|
*
|
|
77
72
|
* @throws {@link ValidationException} (client fault)
|
|
78
|
-
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before
|
|
79
|
-
* retrying the request.</p>
|
|
73
|
+
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.</p>
|
|
80
74
|
*
|
|
81
75
|
* @throws {@link GameLiftStreamsServiceException}
|
|
82
76
|
* <p>Base exception class for all service exceptions from GameLiftStreams service.</p>
|
|
@@ -27,36 +27,7 @@ declare const ExportStreamSessionFilesCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p> Export the files that your application modifies or generates in a stream session, which can help you debug or verify your application.
|
|
31
|
-
* When your application runs, it generates output files such as logs, diagnostic information, crash dumps, save files, user data,
|
|
32
|
-
* screenshots, and so on. The files can be defined by the engine or frameworks that your application uses, or information that you've
|
|
33
|
-
* programmed your application to output. </p>
|
|
34
|
-
* <p> You can only call this action on a stream session that is in progress, specifically in one of the following statuses
|
|
35
|
-
* <code>ACTIVE</code>, <code>CONNECTED</code>, <code>PENDING_CLIENT_RECONNECTION</code>, and <code>RECONNECTING</code>. You must provide
|
|
36
|
-
* an Amazon Simple Storage Service (Amazon S3) bucket to store the files in. When the session ends, Amazon GameLift Streams produces a compressed folder
|
|
37
|
-
* that contains all of the files and directories that were modified or created by the application during the stream session. AWS uses your
|
|
38
|
-
* security credentials to authenticate and authorize access to your Amazon S3 bucket. </p>
|
|
39
|
-
* <p>Amazon GameLift Streams collects the following generated and modified files. Find them in the corresponding folders in the <code>.zip</code>
|
|
40
|
-
* archive.</p>
|
|
41
|
-
* <ul>
|
|
42
|
-
* <li>
|
|
43
|
-
* <p>
|
|
44
|
-
* <code>application/</code>: The folder where your application or game is stored. </p>
|
|
45
|
-
* </li>
|
|
46
|
-
* </ul>
|
|
47
|
-
* <ul>
|
|
48
|
-
* <li>
|
|
49
|
-
* <p>
|
|
50
|
-
* <code>profile/</code>: The user profile folder.</p>
|
|
51
|
-
* </li>
|
|
52
|
-
* <li>
|
|
53
|
-
* <p>
|
|
54
|
-
* <code>temp/</code>: The system temp folder.</p>
|
|
55
|
-
* </li>
|
|
56
|
-
* </ul>
|
|
57
|
-
* <p/>
|
|
58
|
-
* <p>To verify the status of the exported files, use GetStreamSession. </p>
|
|
59
|
-
* <p>To delete the files, delete the object in the S3 bucket. </p>
|
|
30
|
+
* <p> Export the files that your application modifies or generates in a stream session, which can help you debug or verify your application. When your application runs, it generates output files such as logs, diagnostic information, crash dumps, save files, user data, screenshots, and so on. The files can be defined by the engine or frameworks that your application uses, or information that you've programmed your application to output. </p> <p> You can only call this action on a stream session that is in progress, specifically in one of the following statuses <code>ACTIVE</code>, <code>CONNECTED</code>, <code>PENDING_CLIENT_RECONNECTION</code>, and <code>RECONNECTING</code>. You must provide an Amazon Simple Storage Service (Amazon S3) bucket to store the files in. When the session ends, Amazon GameLift Streams produces a compressed folder that contains all of the files and directories that were modified or created by the application during the stream session. AWS uses your security credentials to authenticate and authorize access to your Amazon S3 bucket. </p> <p>Amazon GameLift Streams collects the following generated and modified files. Find them in the corresponding folders in the <code>.zip</code> archive.</p> <ul> <li> <p> <code>application/</code>: The folder where your application or game is stored. </p> </li> </ul> <ul> <li> <p> <code>profile/</code>: The user profile folder.</p> </li> <li> <p> <code>temp/</code>: The system temp folder.</p> </li> </ul> <p/> <p>To verify the status of the exported files, use GetStreamSession. </p> <p>To delete the files, delete the object in the S3 bucket. </p>
|
|
60
31
|
* @example
|
|
61
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
62
33
|
* ```javascript
|
|
@@ -93,8 +64,7 @@ declare const ExportStreamSessionFilesCommand_base: {
|
|
|
93
64
|
* <p>The request was denied due to request throttling. Retry the request after the suggested wait time.</p>
|
|
94
65
|
*
|
|
95
66
|
* @throws {@link ValidationException} (client fault)
|
|
96
|
-
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before
|
|
97
|
-
* retrying the request.</p>
|
|
67
|
+
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.</p>
|
|
98
68
|
*
|
|
99
69
|
* @throws {@link GameLiftStreamsServiceException}
|
|
100
70
|
* <p>Base exception class for all service exceptions from GameLiftStreams service.</p>
|
|
@@ -27,8 +27,7 @@ declare const GetApplicationCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves properties for an Amazon GameLift Streams application resource. Specify the ID of the application that you want to retrieve. If the
|
|
31
|
-
* operation is successful, it returns properties for the requested application.</p>
|
|
30
|
+
* <p>Retrieves properties for an Amazon GameLift Streams application resource. Specify the ID of the application that you want to retrieve. If the operation is successful, it returns properties for the requested application.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -90,8 +89,7 @@ declare const GetApplicationCommand_base: {
|
|
|
90
89
|
* <p>The request was denied due to request throttling. Retry the request after the suggested wait time.</p>
|
|
91
90
|
*
|
|
92
91
|
* @throws {@link ValidationException} (client fault)
|
|
93
|
-
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before
|
|
94
|
-
* retrying the request.</p>
|
|
92
|
+
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.</p>
|
|
95
93
|
*
|
|
96
94
|
* @throws {@link GameLiftStreamsServiceException}
|
|
97
95
|
* <p>Base exception class for all service exceptions from GameLiftStreams service.</p>
|
|
@@ -27,8 +27,7 @@ declare const GetStreamGroupCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves properties for a Amazon GameLift Streams stream group resource. Specify the ID of the stream group that you want to retrieve. If the operation
|
|
31
|
-
* is successful, it returns properties for the requested stream group.</p>
|
|
30
|
+
* <p>Retrieves properties for a Amazon GameLift Streams stream group resource. Specify the ID of the stream group that you want to retrieve. If the operation is successful, it returns properties for the requested stream group.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -90,8 +89,7 @@ declare const GetStreamGroupCommand_base: {
|
|
|
90
89
|
* <p>The request was denied due to request throttling. Retry the request after the suggested wait time.</p>
|
|
91
90
|
*
|
|
92
91
|
* @throws {@link ValidationException} (client fault)
|
|
93
|
-
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before
|
|
94
|
-
* retrying the request.</p>
|
|
92
|
+
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.</p>
|
|
95
93
|
*
|
|
96
94
|
* @throws {@link GameLiftStreamsServiceException}
|
|
97
95
|
* <p>Base exception class for all service exceptions from GameLiftStreams service.</p>
|
|
@@ -27,8 +27,7 @@ declare const GetStreamSessionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves properties for a Amazon GameLift Streams stream session resource. Specify the Amazon Resource Name (ARN) of the stream session that you want to retrieve and its
|
|
31
|
-
* stream group ARN. If the operation is successful, it returns properties for the requested resource.</p>
|
|
30
|
+
* <p>Retrieves properties for a Amazon GameLift Streams stream session resource. Specify the Amazon Resource Name (ARN) of the stream session that you want to retrieve and its stream group ARN. If the operation is successful, it returns properties for the requested resource.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -93,8 +92,7 @@ declare const GetStreamSessionCommand_base: {
|
|
|
93
92
|
* <p>The request was denied due to request throttling. Retry the request after the suggested wait time.</p>
|
|
94
93
|
*
|
|
95
94
|
* @throws {@link ValidationException} (client fault)
|
|
96
|
-
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before
|
|
97
|
-
* retrying the request.</p>
|
|
95
|
+
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.</p>
|
|
98
96
|
*
|
|
99
97
|
* @throws {@link GameLiftStreamsServiceException}
|
|
100
98
|
* <p>Base exception class for all service exceptions from GameLiftStreams service.</p>
|
|
@@ -27,8 +27,7 @@ declare const ListApplicationsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves a list of all Amazon GameLift Streams applications that are associated with the Amazon Web Services account in use. This operation returns applications in
|
|
31
|
-
* all statuses, in no particular order. You can paginate the results as needed.</p>
|
|
30
|
+
* <p>Retrieves a list of all Amazon GameLift Streams applications that are associated with the Amazon Web Services account in use. This operation returns applications in all statuses, in no particular order. You can paginate the results as needed.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -77,8 +76,7 @@ declare const ListApplicationsCommand_base: {
|
|
|
77
76
|
* <p>The request was denied due to request throttling. Retry the request after the suggested wait time.</p>
|
|
78
77
|
*
|
|
79
78
|
* @throws {@link ValidationException} (client fault)
|
|
80
|
-
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before
|
|
81
|
-
* retrying the request.</p>
|
|
79
|
+
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.</p>
|
|
82
80
|
*
|
|
83
81
|
* @throws {@link GameLiftStreamsServiceException}
|
|
84
82
|
* <p>Base exception class for all service exceptions from GameLiftStreams service.</p>
|
|
@@ -27,8 +27,7 @@ declare const ListStreamGroupsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves a list of all Amazon GameLift Streams stream groups that are associated with the Amazon Web Services account in use. This operation returns stream groups in
|
|
31
|
-
* all statuses, in no particular order. You can paginate the results as needed.</p>
|
|
30
|
+
* <p>Retrieves a list of all Amazon GameLift Streams stream groups that are associated with the Amazon Web Services account in use. This operation returns stream groups in all statuses, in no particular order. You can paginate the results as needed.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -78,8 +77,7 @@ declare const ListStreamGroupsCommand_base: {
|
|
|
78
77
|
* <p>The request was denied due to request throttling. Retry the request after the suggested wait time.</p>
|
|
79
78
|
*
|
|
80
79
|
* @throws {@link ValidationException} (client fault)
|
|
81
|
-
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before
|
|
82
|
-
* retrying the request.</p>
|
|
80
|
+
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.</p>
|
|
83
81
|
*
|
|
84
82
|
* @throws {@link GameLiftStreamsServiceException}
|
|
85
83
|
* <p>Base exception class for all service exceptions from GameLiftStreams service.</p>
|
|
@@ -27,11 +27,7 @@ declare const ListStreamSessionsByAccountCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves a list of Amazon GameLift Streams stream sessions that this user account has access to.</p>
|
|
31
|
-
* <p>In the returned list of stream sessions, the <code>ExportFilesMetadata</code> property only shows the <code>Status</code> value. To get
|
|
32
|
-
* the <code>OutpurUri</code> and <code>StatusReason</code> values, use <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamSession.html">GetStreamSession</a>.</p>
|
|
33
|
-
* <p>We don't recommend using this operation to regularly check stream session statuses because it's costly. Instead, to check status updates
|
|
34
|
-
* for a specific stream session, use <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamSession.html">GetStreamSession</a>.</p>
|
|
30
|
+
* <p>Retrieves a list of Amazon GameLift Streams stream sessions that this user account has access to.</p> <p>In the returned list of stream sessions, the <code>ExportFilesMetadata</code> property only shows the <code>Status</code> value. To get the <code>OutpurUri</code> and <code>StatusReason</code> values, use <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamSession.html">GetStreamSession</a>.</p> <p>We don't recommend using this operation to regularly check stream session statuses because it's costly. Instead, to check status updates for a specific stream session, use <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamSession.html">GetStreamSession</a>.</p>
|
|
35
31
|
* @example
|
|
36
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
33
|
* ```javascript
|
|
@@ -85,8 +81,7 @@ declare const ListStreamSessionsByAccountCommand_base: {
|
|
|
85
81
|
* <p>The request was denied due to request throttling. Retry the request after the suggested wait time.</p>
|
|
86
82
|
*
|
|
87
83
|
* @throws {@link ValidationException} (client fault)
|
|
88
|
-
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before
|
|
89
|
-
* retrying the request.</p>
|
|
84
|
+
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.</p>
|
|
90
85
|
*
|
|
91
86
|
* @throws {@link GameLiftStreamsServiceException}
|
|
92
87
|
* <p>Base exception class for all service exceptions from GameLiftStreams service.</p>
|
|
@@ -27,10 +27,7 @@ declare const ListStreamSessionsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves a list of Amazon GameLift Streams stream sessions that a stream group is hosting.</p>
|
|
31
|
-
* <p>To retrieve stream sessions, specify the stream group, and optionally filter by stream session status. You can paginate the results as
|
|
32
|
-
* needed.</p>
|
|
33
|
-
* <p>This operation returns the requested stream sessions in no particular order.</p>
|
|
30
|
+
* <p>Retrieves a list of Amazon GameLift Streams stream sessions that a stream group is hosting.</p> <p>To retrieve stream sessions, specify the stream group, and optionally filter by stream session status. You can paginate the results as needed.</p> <p>This operation returns the requested stream sessions in no particular order.</p>
|
|
34
31
|
* @example
|
|
35
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
33
|
* ```javascript
|
|
@@ -88,8 +85,7 @@ declare const ListStreamSessionsCommand_base: {
|
|
|
88
85
|
* <p>The request was denied due to request throttling. Retry the request after the suggested wait time.</p>
|
|
89
86
|
*
|
|
90
87
|
* @throws {@link ValidationException} (client fault)
|
|
91
|
-
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before
|
|
92
|
-
* retrying the request.</p>
|
|
88
|
+
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.</p>
|
|
93
89
|
*
|
|
94
90
|
* @throws {@link GameLiftStreamsServiceException}
|
|
95
91
|
* <p>Base exception class for all service exceptions from GameLiftStreams service.</p>
|
|
@@ -27,17 +27,7 @@ declare const ListTagsForResourceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Retrieves all tags assigned to a Amazon GameLift Streams resource. To list tags for a resource, specify the ARN value for the resource.</p>
|
|
31
|
-
* <p>
|
|
32
|
-
* <b>Learn more</b>
|
|
33
|
-
* </p>
|
|
34
|
-
* <p>
|
|
35
|
-
* <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
|
|
36
|
-
* Reference</i>
|
|
37
|
-
* </p>
|
|
38
|
-
* <p>
|
|
39
|
-
* <a href="http://aws.amazon.com/answers/account-management/aws-tagging-strategies/"> Amazon Web Services Tagging Strategies</a>
|
|
40
|
-
* </p>
|
|
30
|
+
* <p>Retrieves all tags assigned to a Amazon GameLift Streams resource. To list tags for a resource, specify the ARN value for the resource.</p> <p> <b>Learn more</b> </p> <p> <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> </p> <p> <a href="http://aws.amazon.com/answers/account-management/aws-tagging-strategies/"> Amazon Web Services Tagging Strategies</a> </p>
|
|
41
31
|
* @example
|
|
42
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
43
33
|
* ```javascript
|
|
@@ -73,8 +63,7 @@ declare const ListTagsForResourceCommand_base: {
|
|
|
73
63
|
* <p>The request was denied due to request throttling. Retry the request after the suggested wait time.</p>
|
|
74
64
|
*
|
|
75
65
|
* @throws {@link ValidationException} (client fault)
|
|
76
|
-
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before
|
|
77
|
-
* retrying the request.</p>
|
|
66
|
+
* <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.</p>
|
|
78
67
|
*
|
|
79
68
|
* @throws {@link GameLiftStreamsServiceException}
|
|
80
69
|
* <p>Base exception class for all service exceptions from GameLiftStreams service.</p>
|