@aws-sdk/client-gamelift 3.554.0 → 3.562.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +32 -0
- package/dist-cjs/index.js +453 -72
- package/dist-es/GameLift.js +8 -0
- package/dist-es/commands/CreateContainerGroupDefinitionCommand.js +25 -0
- package/dist-es/commands/CreateFleetCommand.js +2 -2
- package/dist-es/commands/DeleteContainerGroupDefinitionCommand.js +24 -0
- package/dist-es/commands/DescribeContainerGroupDefinitionCommand.js +25 -0
- package/dist-es/commands/DescribeFleetAttributesCommand.js +2 -1
- package/dist-es/commands/ListContainerGroupDefinitionsCommand.js +25 -0
- package/dist-es/commands/SearchGameSessionsCommand.js +1 -1
- package/dist-es/commands/StartGameSessionPlacementCommand.js +1 -1
- package/dist-es/commands/StartMatchBackfillCommand.js +1 -1
- package/dist-es/commands/StartMatchmakingCommand.js +1 -1
- package/dist-es/commands/StopGameSessionPlacementCommand.js +1 -1
- package/dist-es/commands/index.js +4 -0
- package/dist-es/models/models_0.js +124 -45
- package/dist-es/models/models_1.js +42 -1
- package/dist-es/pagination/ListContainerGroupDefinitionsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_json1_1.js +129 -1
- package/dist-types/GameLift.d.ts +29 -0
- package/dist-types/GameLiftClient.d.ts +6 -2
- package/dist-types/commands/CreateContainerGroupDefinitionCommand.d.ts +262 -0
- package/dist-types/commands/CreateFleetCommand.d.ts +169 -29
- package/dist-types/commands/CreateFleetLocationsCommand.d.ts +14 -6
- package/dist-types/commands/DeleteContainerGroupDefinitionCommand.d.ts +94 -0
- package/dist-types/commands/DeleteFleetCommand.d.ts +5 -6
- package/dist-types/commands/DeregisterComputeCommand.d.ts +10 -2
- package/dist-types/commands/DescribeComputeCommand.d.ts +35 -6
- package/dist-types/commands/DescribeContainerGroupDefinitionCommand.d.ts +152 -0
- package/dist-types/commands/DescribeFleetAttributesCommand.d.ts +25 -7
- package/dist-types/commands/DescribeFleetCapacityCommand.d.ts +17 -7
- package/dist-types/commands/DescribeFleetEventsCommand.d.ts +1 -0
- package/dist-types/commands/DescribeFleetLocationCapacityCommand.d.ts +11 -3
- package/dist-types/commands/DescribeFleetPortSettingsCommand.d.ts +10 -9
- package/dist-types/commands/DescribeRuntimeConfigurationCommand.d.ts +7 -4
- package/dist-types/commands/GetComputeAccessCommand.d.ts +39 -14
- package/dist-types/commands/GetComputeAuthTokenCommand.d.ts +20 -6
- package/dist-types/commands/ListComputeCommand.d.ts +38 -8
- package/dist-types/commands/ListContainerGroupDefinitionsCommand.d.ts +156 -0
- package/dist-types/commands/ListFleetsCommand.d.ts +20 -19
- package/dist-types/commands/RegisterComputeCommand.d.ts +31 -8
- package/dist-types/commands/RequestUploadCredentialsCommand.d.ts +1 -1
- package/dist-types/commands/ResolveAliasCommand.d.ts +5 -1
- package/dist-types/commands/ResumeGameServerGroupCommand.d.ts +2 -1
- package/dist-types/commands/SearchGameSessionsCommand.d.ts +2 -2
- package/dist-types/commands/StartFleetActionsCommand.d.ts +1 -1
- package/dist-types/commands/StartGameSessionPlacementCommand.d.ts +1 -1
- package/dist-types/commands/StartMatchBackfillCommand.d.ts +1 -1
- package/dist-types/commands/StartMatchmakingCommand.d.ts +1 -1
- package/dist-types/commands/StopFleetActionsCommand.d.ts +3 -2
- package/dist-types/commands/StopGameSessionPlacementCommand.d.ts +1 -1
- package/dist-types/commands/StopMatchmakingCommand.d.ts +1 -1
- package/dist-types/commands/SuspendGameServerGroupCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAliasCommand.d.ts +4 -5
- package/dist-types/commands/UpdateBuildCommand.d.ts +1 -1
- package/dist-types/commands/UpdateFleetAttributesCommand.d.ts +3 -4
- package/dist-types/commands/UpdateFleetCapacityCommand.d.ts +27 -30
- package/dist-types/commands/UpdateFleetPortSettingsCommand.d.ts +4 -2
- package/dist-types/commands/UpdateRuntimeConfigurationCommand.d.ts +16 -9
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/models/models_0.d.ts +5561 -4910
- package/dist-types/models/models_1.d.ts +685 -7
- package/dist-types/pagination/ListContainerGroupDefinitionsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +36 -0
- package/dist-types/ts3.4/GameLift.d.ts +69 -0
- package/dist-types/ts3.4/GameLiftClient.d.ts +24 -0
- package/dist-types/ts3.4/commands/CreateContainerGroupDefinitionCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DeleteContainerGroupDefinitionCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/DescribeContainerGroupDefinitionCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListContainerGroupDefinitionsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ResumeGameServerGroupCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/SearchGameSessionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartFleetActionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartGameSessionPlacementCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartMatchBackfillCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartMatchmakingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopFleetActionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopGameSessionPlacementCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopMatchmakingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SuspendGameServerGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAliasCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateBuildCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateFleetAttributesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/models/models_0.d.ts +232 -150
- package/dist-types/ts3.4/models/models_1.d.ts +158 -0
- package/dist-types/ts3.4/pagination/ListContainerGroupDefinitionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +48 -0
- package/package.json +4 -4
|
@@ -1,4 +1,650 @@
|
|
|
1
|
-
import { BackfillMode, BalancingStrategy, FilterConfiguration, FlexMatchMode, GameProperty, GameServer, GameServerGroup, GameServerProtectionPolicy, GameServerUtilizationStatus, GameSession, GameSessionQueue, GameSessionQueueDestination, InstanceDefinition, IpPermission, MatchmakingConfiguration, PlayerLatencyPolicy, PlayerSessionCreationPolicy, PriorityConfiguration, ProtectionPolicy, RuntimeConfiguration, S3Location, Script } from "./models_0";
|
|
1
|
+
import { Alias, AnywhereConfiguration, BackfillMode, BalancingStrategy, Build, DesiredPlayerSession, FilterConfiguration, FleetAction, FlexMatchMode, GameProperty, GameServer, GameServerGroup, GameServerGroupAction, GameServerProtectionPolicy, GameServerUtilizationStatus, GameSession, GameSessionPlacement, GameSessionQueue, GameSessionQueueDestination, InstanceDefinition, IpPermission, MatchmakingConfiguration, MatchmakingTicket, Player, PlayerLatency, PlayerLatencyPolicy, PlayerSessionCreationPolicy, PriorityConfiguration, ProtectionPolicy, ResourceCreationLimitPolicy, RoutingStrategy, RuntimeConfiguration, S3Location, Script, Tag } from "./models_0";
|
|
2
|
+
/**
|
|
3
|
+
* @public
|
|
4
|
+
*/
|
|
5
|
+
export interface ResumeGameServerGroupOutput {
|
|
6
|
+
/**
|
|
7
|
+
* <p>An object that describes the game server group resource, with the
|
|
8
|
+
* <code>SuspendedActions</code> property updated to reflect the resumed
|
|
9
|
+
* activity.</p>
|
|
10
|
+
* @public
|
|
11
|
+
*/
|
|
12
|
+
GameServerGroup?: GameServerGroup;
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* @public
|
|
16
|
+
*/
|
|
17
|
+
export interface SearchGameSessionsInput {
|
|
18
|
+
/**
|
|
19
|
+
* <p>A unique identifier for the fleet to search for active game sessions. You can use either the fleet ID or ARN
|
|
20
|
+
* value. Each request must reference either a fleet ID or alias ID, but not both.</p>
|
|
21
|
+
* @public
|
|
22
|
+
*/
|
|
23
|
+
FleetId?: string;
|
|
24
|
+
/**
|
|
25
|
+
* <p>A unique identifier for the alias associated with the fleet to search for active game sessions. You can use either
|
|
26
|
+
* the alias ID or ARN value. Each request must reference either a fleet ID or alias ID,
|
|
27
|
+
* but not both.</p>
|
|
28
|
+
* @public
|
|
29
|
+
*/
|
|
30
|
+
AliasId?: string;
|
|
31
|
+
/**
|
|
32
|
+
* <p>A fleet location to search for game sessions. You can specify a fleet's home Region or
|
|
33
|
+
* a remote location. Use the Amazon Web Services Region code format, such as <code>us-west-2</code>.
|
|
34
|
+
* </p>
|
|
35
|
+
* @public
|
|
36
|
+
*/
|
|
37
|
+
Location?: string;
|
|
38
|
+
/**
|
|
39
|
+
* <p>String containing the search criteria for the session search. If no filter expression
|
|
40
|
+
* is included, the request returns results for all game sessions in the fleet that are in
|
|
41
|
+
* <code>ACTIVE</code> status.</p>
|
|
42
|
+
* <p>A filter expression can contain one or multiple conditions. Each condition consists of
|
|
43
|
+
* the following:</p>
|
|
44
|
+
* <ul>
|
|
45
|
+
* <li>
|
|
46
|
+
* <p>
|
|
47
|
+
* <b>Operand</b> -- Name of a game session attribute.
|
|
48
|
+
* Valid values are <code>gameSessionName</code>, <code>gameSessionId</code>,
|
|
49
|
+
* <code>gameSessionProperties</code>, <code>maximumSessions</code>,
|
|
50
|
+
* <code>creationTimeMillis</code>, <code>playerSessionCount</code>,
|
|
51
|
+
* <code>hasAvailablePlayerSessions</code>.</p>
|
|
52
|
+
* </li>
|
|
53
|
+
* <li>
|
|
54
|
+
* <p>
|
|
55
|
+
* <b>Comparator</b> -- Valid comparators are:
|
|
56
|
+
* <code>=</code>, <code><></code>, <code><</code>, <code>></code>,
|
|
57
|
+
* <code><=</code>, <code>>=</code>. </p>
|
|
58
|
+
* </li>
|
|
59
|
+
* <li>
|
|
60
|
+
* <p>
|
|
61
|
+
* <b>Value</b> -- Value to be searched for. Values may
|
|
62
|
+
* be numbers, boolean values (true/false) or strings depending on the operand.
|
|
63
|
+
* String values are case sensitive and must be enclosed in single quotes. Special
|
|
64
|
+
* characters must be escaped. Boolean and string values can only be used with the
|
|
65
|
+
* comparators <code>=</code> and <code><></code>. For example, the following
|
|
66
|
+
* filter expression searches on <code>gameSessionName</code>:
|
|
67
|
+
* "<code>FilterExpression": "gameSessionName = 'Matt\\'s Awesome Game
|
|
68
|
+
* 1'"</code>. </p>
|
|
69
|
+
* </li>
|
|
70
|
+
* </ul>
|
|
71
|
+
* <p>To chain multiple conditions in a single expression, use the logical keywords
|
|
72
|
+
* <code>AND</code>, <code>OR</code>, and <code>NOT</code> and parentheses as needed.
|
|
73
|
+
* For example: <code>x AND y AND NOT z</code>, <code>NOT (x OR y)</code>.</p>
|
|
74
|
+
* <p>Session search evaluates conditions from left to right using the following precedence
|
|
75
|
+
* rules:</p>
|
|
76
|
+
* <ol>
|
|
77
|
+
* <li>
|
|
78
|
+
* <p>
|
|
79
|
+
* <code>=</code>, <code><></code>, <code><</code>, <code>></code>,
|
|
80
|
+
* <code><=</code>, <code>>=</code>
|
|
81
|
+
* </p>
|
|
82
|
+
* </li>
|
|
83
|
+
* <li>
|
|
84
|
+
* <p>Parentheses</p>
|
|
85
|
+
* </li>
|
|
86
|
+
* <li>
|
|
87
|
+
* <p>NOT</p>
|
|
88
|
+
* </li>
|
|
89
|
+
* <li>
|
|
90
|
+
* <p>AND</p>
|
|
91
|
+
* </li>
|
|
92
|
+
* <li>
|
|
93
|
+
* <p>OR</p>
|
|
94
|
+
* </li>
|
|
95
|
+
* </ol>
|
|
96
|
+
* <p>For example, this filter expression retrieves game sessions hosting at least ten
|
|
97
|
+
* players that have an open player slot: <code>"maximumSessions>=10 AND
|
|
98
|
+
* hasAvailablePlayerSessions=true"</code>. </p>
|
|
99
|
+
* @public
|
|
100
|
+
*/
|
|
101
|
+
FilterExpression?: string;
|
|
102
|
+
/**
|
|
103
|
+
* <p>Instructions on how to sort the search results. If no sort expression is included, the
|
|
104
|
+
* request returns results in random order. A sort expression consists of the following
|
|
105
|
+
* elements:</p>
|
|
106
|
+
* <ul>
|
|
107
|
+
* <li>
|
|
108
|
+
* <p>
|
|
109
|
+
* <b>Operand</b> -- Name of a game session attribute.
|
|
110
|
+
* Valid values are <code>gameSessionName</code>, <code>gameSessionId</code>,
|
|
111
|
+
* <code>gameSessionProperties</code>, <code>maximumSessions</code>,
|
|
112
|
+
* <code>creationTimeMillis</code>, <code>playerSessionCount</code>,
|
|
113
|
+
* <code>hasAvailablePlayerSessions</code>.</p>
|
|
114
|
+
* </li>
|
|
115
|
+
* <li>
|
|
116
|
+
* <p>
|
|
117
|
+
* <b>Order</b> -- Valid sort orders are <code>ASC</code>
|
|
118
|
+
* (ascending) and <code>DESC</code> (descending).</p>
|
|
119
|
+
* </li>
|
|
120
|
+
* </ul>
|
|
121
|
+
* <p>For example, this sort expression returns the oldest active sessions first:
|
|
122
|
+
* <code>"SortExpression": "creationTimeMillis ASC"</code>. Results with a null value
|
|
123
|
+
* for the sort operand are returned at the end of the list.</p>
|
|
124
|
+
* @public
|
|
125
|
+
*/
|
|
126
|
+
SortExpression?: string;
|
|
127
|
+
/**
|
|
128
|
+
* <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. The maximum number of results returned is 20, even if this value is not set or
|
|
129
|
+
* is set higher than 20. </p>
|
|
130
|
+
* @public
|
|
131
|
+
*/
|
|
132
|
+
Limit?: number;
|
|
133
|
+
/**
|
|
134
|
+
* <p>A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.</p>
|
|
135
|
+
* @public
|
|
136
|
+
*/
|
|
137
|
+
NextToken?: string;
|
|
138
|
+
}
|
|
139
|
+
/**
|
|
140
|
+
* @public
|
|
141
|
+
*/
|
|
142
|
+
export interface SearchGameSessionsOutput {
|
|
143
|
+
/**
|
|
144
|
+
* <p>A collection of objects containing game session properties for each session that
|
|
145
|
+
* matches the request.</p>
|
|
146
|
+
* @public
|
|
147
|
+
*/
|
|
148
|
+
GameSessions?: GameSession[];
|
|
149
|
+
/**
|
|
150
|
+
* <p>A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.</p>
|
|
151
|
+
* @public
|
|
152
|
+
*/
|
|
153
|
+
NextToken?: string;
|
|
154
|
+
}
|
|
155
|
+
/**
|
|
156
|
+
* @public
|
|
157
|
+
*/
|
|
158
|
+
export interface StartFleetActionsInput {
|
|
159
|
+
/**
|
|
160
|
+
* <p>A unique identifier for the fleet to restart actions on. You can use either the fleet ID or ARN value.</p>
|
|
161
|
+
* @public
|
|
162
|
+
*/
|
|
163
|
+
FleetId: string | undefined;
|
|
164
|
+
/**
|
|
165
|
+
* <p>List of actions to restart on the fleet.</p>
|
|
166
|
+
* @public
|
|
167
|
+
*/
|
|
168
|
+
Actions: FleetAction[] | undefined;
|
|
169
|
+
/**
|
|
170
|
+
* <p>The fleet location to restart fleet actions for. Specify a location in the form of an
|
|
171
|
+
* Amazon Web Services Region code, such as <code>us-west-2</code>.</p>
|
|
172
|
+
* @public
|
|
173
|
+
*/
|
|
174
|
+
Location?: string;
|
|
175
|
+
}
|
|
176
|
+
/**
|
|
177
|
+
* @public
|
|
178
|
+
*/
|
|
179
|
+
export interface StartFleetActionsOutput {
|
|
180
|
+
/**
|
|
181
|
+
* <p>A unique identifier for the fleet to restart actions on.</p>
|
|
182
|
+
* @public
|
|
183
|
+
*/
|
|
184
|
+
FleetId?: string;
|
|
185
|
+
/**
|
|
186
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
187
|
+
* @public
|
|
188
|
+
*/
|
|
189
|
+
FleetArn?: string;
|
|
190
|
+
}
|
|
191
|
+
/**
|
|
192
|
+
* @public
|
|
193
|
+
*/
|
|
194
|
+
export interface StartGameSessionPlacementInput {
|
|
195
|
+
/**
|
|
196
|
+
* <p>A unique identifier to assign to the new game session placement. This value is
|
|
197
|
+
* developer-defined. The value must be unique across all Regions and cannot be
|
|
198
|
+
* reused.</p>
|
|
199
|
+
* @public
|
|
200
|
+
*/
|
|
201
|
+
PlacementId: string | undefined;
|
|
202
|
+
/**
|
|
203
|
+
* <p>Name of the queue to use to place the new game session. You can use either the queue
|
|
204
|
+
* name or ARN value. </p>
|
|
205
|
+
* @public
|
|
206
|
+
*/
|
|
207
|
+
GameSessionQueueName: string | undefined;
|
|
208
|
+
/**
|
|
209
|
+
* <p>A set of key-value pairs that can store custom data in a game session.
|
|
210
|
+
* For example: <code>\{"Key": "difficulty", "Value": "novice"\}</code>.</p>
|
|
211
|
+
* @public
|
|
212
|
+
*/
|
|
213
|
+
GameProperties?: GameProperty[];
|
|
214
|
+
/**
|
|
215
|
+
* <p>The maximum number of players that can be connected simultaneously to the game session.</p>
|
|
216
|
+
* @public
|
|
217
|
+
*/
|
|
218
|
+
MaximumPlayerSessionCount: number | undefined;
|
|
219
|
+
/**
|
|
220
|
+
* <p>A descriptive label that is associated with a game session. Session names do not need to be unique.</p>
|
|
221
|
+
* @public
|
|
222
|
+
*/
|
|
223
|
+
GameSessionName?: string;
|
|
224
|
+
/**
|
|
225
|
+
* <p>A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions. This information is used to try to place the new game session where it
|
|
226
|
+
* can offer the best possible gameplay experience for the players. </p>
|
|
227
|
+
* @public
|
|
228
|
+
*/
|
|
229
|
+
PlayerLatencies?: PlayerLatency[];
|
|
230
|
+
/**
|
|
231
|
+
* <p>Set of information on each player to create a player session for.</p>
|
|
232
|
+
* @public
|
|
233
|
+
*/
|
|
234
|
+
DesiredPlayerSessions?: DesiredPlayerSession[];
|
|
235
|
+
/**
|
|
236
|
+
* <p>A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the
|
|
237
|
+
* <code>GameSession</code> object with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>).</p>
|
|
238
|
+
* @public
|
|
239
|
+
*/
|
|
240
|
+
GameSessionData?: string;
|
|
241
|
+
}
|
|
242
|
+
/**
|
|
243
|
+
* @public
|
|
244
|
+
*/
|
|
245
|
+
export interface StartGameSessionPlacementOutput {
|
|
246
|
+
/**
|
|
247
|
+
* <p>Object that describes the newly created game session placement. This object includes
|
|
248
|
+
* all the information provided in the request, as well as start/end time stamps and
|
|
249
|
+
* placement status. </p>
|
|
250
|
+
* @public
|
|
251
|
+
*/
|
|
252
|
+
GameSessionPlacement?: GameSessionPlacement;
|
|
253
|
+
}
|
|
254
|
+
/**
|
|
255
|
+
* @public
|
|
256
|
+
*/
|
|
257
|
+
export interface StartMatchBackfillInput {
|
|
258
|
+
/**
|
|
259
|
+
* <p>A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a
|
|
260
|
+
* UUID. Use this identifier to track the match backfill ticket status and retrieve match
|
|
261
|
+
* results.</p>
|
|
262
|
+
* @public
|
|
263
|
+
*/
|
|
264
|
+
TicketId?: string;
|
|
265
|
+
/**
|
|
266
|
+
* <p>Name of the matchmaker to use for this request. You can use either the configuration
|
|
267
|
+
* name or ARN value. The ARN of the matchmaker that was used with the original game
|
|
268
|
+
* session is listed in the <code>GameSession</code> object, <code>MatchmakerData</code>
|
|
269
|
+
* property.</p>
|
|
270
|
+
* @public
|
|
271
|
+
*/
|
|
272
|
+
ConfigurationName: string | undefined;
|
|
273
|
+
/**
|
|
274
|
+
* <p>A unique identifier for the game session. Use the game session ID. When using FlexMatch as a standalone matchmaking
|
|
275
|
+
* solution, this parameter is not needed. </p>
|
|
276
|
+
* @public
|
|
277
|
+
*/
|
|
278
|
+
GameSessionArn?: string;
|
|
279
|
+
/**
|
|
280
|
+
* <p>Match information on all players that are currently assigned to the game session. This
|
|
281
|
+
* information is used by the matchmaker to find new players and add them to the existing
|
|
282
|
+
* game.</p>
|
|
283
|
+
* <p>You can include up to 199 <code>Players</code> in a <code>StartMatchBackfill</code>
|
|
284
|
+
* request.</p>
|
|
285
|
+
* <ul>
|
|
286
|
+
* <li>
|
|
287
|
+
* <p>PlayerID, PlayerAttributes, Team -- This information is maintained in the
|
|
288
|
+
* <code>GameSession</code> object, <code>MatchmakerData</code> property, for
|
|
289
|
+
* all players who are currently assigned to the game session. The matchmaker data
|
|
290
|
+
* is in JSON syntax, formatted as a string. For more details, see <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data">
|
|
291
|
+
* Match Data</a>. </p>
|
|
292
|
+
* <p>The backfill request must specify the team membership for every player. Do not
|
|
293
|
+
* specify team if you are not using backfill.</p>
|
|
294
|
+
* </li>
|
|
295
|
+
* <li>
|
|
296
|
+
* <p>LatencyInMs -- If the matchmaker uses player latency, include a latency value,
|
|
297
|
+
* in milliseconds, for the Region that the game session is currently in. Do not
|
|
298
|
+
* include latency values for any other Region.</p>
|
|
299
|
+
* </li>
|
|
300
|
+
* </ul>
|
|
301
|
+
* @public
|
|
302
|
+
*/
|
|
303
|
+
Players: Player[] | undefined;
|
|
304
|
+
}
|
|
305
|
+
/**
|
|
306
|
+
* @public
|
|
307
|
+
*/
|
|
308
|
+
export interface StartMatchBackfillOutput {
|
|
309
|
+
/**
|
|
310
|
+
* <p>Ticket representing the backfill matchmaking request. This object includes the
|
|
311
|
+
* information in the request, ticket status, and match results as generated during the
|
|
312
|
+
* matchmaking process.</p>
|
|
313
|
+
* @public
|
|
314
|
+
*/
|
|
315
|
+
MatchmakingTicket?: MatchmakingTicket;
|
|
316
|
+
}
|
|
317
|
+
/**
|
|
318
|
+
* @public
|
|
319
|
+
*/
|
|
320
|
+
export interface StartMatchmakingInput {
|
|
321
|
+
/**
|
|
322
|
+
* <p>A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a
|
|
323
|
+
* UUID. Use this identifier to track the matchmaking ticket status and retrieve match
|
|
324
|
+
* results.</p>
|
|
325
|
+
* @public
|
|
326
|
+
*/
|
|
327
|
+
TicketId?: string;
|
|
328
|
+
/**
|
|
329
|
+
* <p>Name of the matchmaking configuration to use for this request. Matchmaking
|
|
330
|
+
* configurations must exist in the same Region as this request. You can use either the
|
|
331
|
+
* configuration name or ARN value.</p>
|
|
332
|
+
* @public
|
|
333
|
+
*/
|
|
334
|
+
ConfigurationName: string | undefined;
|
|
335
|
+
/**
|
|
336
|
+
* <p>Information on each player to be matched. This information must include a player ID,
|
|
337
|
+
* and may contain player attributes and latency data to be used in the matchmaking
|
|
338
|
+
* process. After a successful match, <code>Player</code> objects contain the name of the
|
|
339
|
+
* team the player is assigned to.</p>
|
|
340
|
+
* <p>You can include up to 10 <code>Players</code> in a <code>StartMatchmaking</code>
|
|
341
|
+
* request.</p>
|
|
342
|
+
* @public
|
|
343
|
+
*/
|
|
344
|
+
Players: Player[] | undefined;
|
|
345
|
+
}
|
|
346
|
+
/**
|
|
347
|
+
* @public
|
|
348
|
+
*/
|
|
349
|
+
export interface StartMatchmakingOutput {
|
|
350
|
+
/**
|
|
351
|
+
* <p>Ticket representing the matchmaking request. This object include the information
|
|
352
|
+
* included in the request, ticket status, and match results as generated during the
|
|
353
|
+
* matchmaking process.</p>
|
|
354
|
+
* @public
|
|
355
|
+
*/
|
|
356
|
+
MatchmakingTicket?: MatchmakingTicket;
|
|
357
|
+
}
|
|
358
|
+
/**
|
|
359
|
+
* @public
|
|
360
|
+
*/
|
|
361
|
+
export interface StopFleetActionsInput {
|
|
362
|
+
/**
|
|
363
|
+
* <p>A unique identifier for the fleet to stop actions on. You can use either the fleet ID or ARN value.</p>
|
|
364
|
+
* @public
|
|
365
|
+
*/
|
|
366
|
+
FleetId: string | undefined;
|
|
367
|
+
/**
|
|
368
|
+
* <p>List of actions to suspend on the fleet. </p>
|
|
369
|
+
* @public
|
|
370
|
+
*/
|
|
371
|
+
Actions: FleetAction[] | undefined;
|
|
372
|
+
/**
|
|
373
|
+
* <p>The fleet location to stop fleet actions for. Specify a location in the form of an
|
|
374
|
+
* Amazon Web Services Region code, such as <code>us-west-2</code>.</p>
|
|
375
|
+
* @public
|
|
376
|
+
*/
|
|
377
|
+
Location?: string;
|
|
378
|
+
}
|
|
379
|
+
/**
|
|
380
|
+
* @public
|
|
381
|
+
*/
|
|
382
|
+
export interface StopFleetActionsOutput {
|
|
383
|
+
/**
|
|
384
|
+
* <p>A unique identifier for the fleet to stop actions on.</p>
|
|
385
|
+
* @public
|
|
386
|
+
*/
|
|
387
|
+
FleetId?: string;
|
|
388
|
+
/**
|
|
389
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
390
|
+
* @public
|
|
391
|
+
*/
|
|
392
|
+
FleetArn?: string;
|
|
393
|
+
}
|
|
394
|
+
/**
|
|
395
|
+
* @public
|
|
396
|
+
*/
|
|
397
|
+
export interface StopGameSessionPlacementInput {
|
|
398
|
+
/**
|
|
399
|
+
* <p>A unique identifier for a game session placement to stop.</p>
|
|
400
|
+
* @public
|
|
401
|
+
*/
|
|
402
|
+
PlacementId: string | undefined;
|
|
403
|
+
}
|
|
404
|
+
/**
|
|
405
|
+
* @public
|
|
406
|
+
*/
|
|
407
|
+
export interface StopGameSessionPlacementOutput {
|
|
408
|
+
/**
|
|
409
|
+
* <p>Object that describes the canceled game session placement, with <code>CANCELLED</code>
|
|
410
|
+
* status and an end time stamp. </p>
|
|
411
|
+
* @public
|
|
412
|
+
*/
|
|
413
|
+
GameSessionPlacement?: GameSessionPlacement;
|
|
414
|
+
}
|
|
415
|
+
/**
|
|
416
|
+
* @public
|
|
417
|
+
*/
|
|
418
|
+
export interface StopMatchmakingInput {
|
|
419
|
+
/**
|
|
420
|
+
* <p>A unique identifier for a matchmaking ticket.</p>
|
|
421
|
+
* @public
|
|
422
|
+
*/
|
|
423
|
+
TicketId: string | undefined;
|
|
424
|
+
}
|
|
425
|
+
/**
|
|
426
|
+
* @public
|
|
427
|
+
*/
|
|
428
|
+
export interface StopMatchmakingOutput {
|
|
429
|
+
}
|
|
430
|
+
/**
|
|
431
|
+
* @public
|
|
432
|
+
*/
|
|
433
|
+
export interface SuspendGameServerGroupInput {
|
|
434
|
+
/**
|
|
435
|
+
* <p>A unique identifier for the game server group. Use either the name or ARN value.</p>
|
|
436
|
+
* @public
|
|
437
|
+
*/
|
|
438
|
+
GameServerGroupName: string | undefined;
|
|
439
|
+
/**
|
|
440
|
+
* <p>The activity to suspend for this game server group.</p>
|
|
441
|
+
* @public
|
|
442
|
+
*/
|
|
443
|
+
SuspendActions: GameServerGroupAction[] | undefined;
|
|
444
|
+
}
|
|
445
|
+
/**
|
|
446
|
+
* @public
|
|
447
|
+
*/
|
|
448
|
+
export interface SuspendGameServerGroupOutput {
|
|
449
|
+
/**
|
|
450
|
+
* <p>An object that describes the game server group resource, with the
|
|
451
|
+
* <code>SuspendedActions</code> property updated to reflect the suspended
|
|
452
|
+
* activity.</p>
|
|
453
|
+
* @public
|
|
454
|
+
*/
|
|
455
|
+
GameServerGroup?: GameServerGroup;
|
|
456
|
+
}
|
|
457
|
+
/**
|
|
458
|
+
* @public
|
|
459
|
+
*/
|
|
460
|
+
export interface TagResourceRequest {
|
|
461
|
+
/**
|
|
462
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that uniquely identifies
|
|
463
|
+
* the Amazon GameLift resource that you want to assign tags to. Amazon GameLift includes resource ARNs in
|
|
464
|
+
* the data object for the resource. You can retrieve the ARN by calling a
|
|
465
|
+
* <code>List</code> or <code>Describe</code> operation for the resource type. </p>
|
|
466
|
+
* @public
|
|
467
|
+
*/
|
|
468
|
+
ResourceARN: string | undefined;
|
|
469
|
+
/**
|
|
470
|
+
* <p>A list of one or more tags to assign to the specified Amazon GameLift resource. Tags are
|
|
471
|
+
* developer-defined and structured as key-value pairs. The maximum tag limit may be lower
|
|
472
|
+
* than stated. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">
|
|
473
|
+
* Tagging Amazon Web Services Resources</a> for tagging limits.</p>
|
|
474
|
+
* @public
|
|
475
|
+
*/
|
|
476
|
+
Tags: Tag[] | undefined;
|
|
477
|
+
}
|
|
478
|
+
/**
|
|
479
|
+
* @public
|
|
480
|
+
*/
|
|
481
|
+
export interface TagResourceResponse {
|
|
482
|
+
}
|
|
483
|
+
/**
|
|
484
|
+
* @public
|
|
485
|
+
*/
|
|
486
|
+
export interface UntagResourceRequest {
|
|
487
|
+
/**
|
|
488
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that uniquely identifies
|
|
489
|
+
* the Amazon GameLift resource that you want to remove tags from. Amazon GameLift includes resource ARNs in
|
|
490
|
+
* the data object for the resource. You can retrieve the ARN by calling a
|
|
491
|
+
* <code>List</code> or <code>Describe</code> operation for the resource type. </p>
|
|
492
|
+
* @public
|
|
493
|
+
*/
|
|
494
|
+
ResourceARN: string | undefined;
|
|
495
|
+
/**
|
|
496
|
+
* <p>A list of one or more tag keys to remove from the specified Amazon GameLift resource. </p>
|
|
497
|
+
* @public
|
|
498
|
+
*/
|
|
499
|
+
TagKeys: string[] | undefined;
|
|
500
|
+
}
|
|
501
|
+
/**
|
|
502
|
+
* @public
|
|
503
|
+
*/
|
|
504
|
+
export interface UntagResourceResponse {
|
|
505
|
+
}
|
|
506
|
+
/**
|
|
507
|
+
* @public
|
|
508
|
+
*/
|
|
509
|
+
export interface UpdateAliasInput {
|
|
510
|
+
/**
|
|
511
|
+
* <p>A unique identifier for the alias that you want to update. You can use either the
|
|
512
|
+
* alias ID or ARN value.</p>
|
|
513
|
+
* @public
|
|
514
|
+
*/
|
|
515
|
+
AliasId: string | undefined;
|
|
516
|
+
/**
|
|
517
|
+
* <p>A descriptive label that is associated with an alias. Alias names do not need to be unique.</p>
|
|
518
|
+
* @public
|
|
519
|
+
*/
|
|
520
|
+
Name?: string;
|
|
521
|
+
/**
|
|
522
|
+
* <p>A human-readable description of the alias.</p>
|
|
523
|
+
* @public
|
|
524
|
+
*/
|
|
525
|
+
Description?: string;
|
|
526
|
+
/**
|
|
527
|
+
* <p>The routing configuration, including routing type and fleet target, for the
|
|
528
|
+
* alias.</p>
|
|
529
|
+
* @public
|
|
530
|
+
*/
|
|
531
|
+
RoutingStrategy?: RoutingStrategy;
|
|
532
|
+
}
|
|
533
|
+
/**
|
|
534
|
+
* @public
|
|
535
|
+
*/
|
|
536
|
+
export interface UpdateAliasOutput {
|
|
537
|
+
/**
|
|
538
|
+
* <p>The updated alias resource.</p>
|
|
539
|
+
* @public
|
|
540
|
+
*/
|
|
541
|
+
Alias?: Alias;
|
|
542
|
+
}
|
|
543
|
+
/**
|
|
544
|
+
* @public
|
|
545
|
+
*/
|
|
546
|
+
export interface UpdateBuildInput {
|
|
547
|
+
/**
|
|
548
|
+
* <p>A unique identifier for the build to update. You can use either the build ID or ARN value. </p>
|
|
549
|
+
* @public
|
|
550
|
+
*/
|
|
551
|
+
BuildId: string | undefined;
|
|
552
|
+
/**
|
|
553
|
+
* <p>A descriptive label associated with a build. Build names don't need to be unique. </p>
|
|
554
|
+
* @public
|
|
555
|
+
*/
|
|
556
|
+
Name?: string;
|
|
557
|
+
/**
|
|
558
|
+
* <p>Version information associated with a build or script. Version strings don't need to be unique.</p>
|
|
559
|
+
* @public
|
|
560
|
+
*/
|
|
561
|
+
Version?: string;
|
|
562
|
+
}
|
|
563
|
+
/**
|
|
564
|
+
* @public
|
|
565
|
+
*/
|
|
566
|
+
export interface UpdateBuildOutput {
|
|
567
|
+
/**
|
|
568
|
+
* <p>The updated build resource.</p>
|
|
569
|
+
* @public
|
|
570
|
+
*/
|
|
571
|
+
Build?: Build;
|
|
572
|
+
}
|
|
573
|
+
/**
|
|
574
|
+
* @public
|
|
575
|
+
*/
|
|
576
|
+
export interface UpdateFleetAttributesInput {
|
|
577
|
+
/**
|
|
578
|
+
* <p>A unique identifier for the fleet to update attribute metadata for. You can use either the fleet ID or ARN
|
|
579
|
+
* value.</p>
|
|
580
|
+
* @public
|
|
581
|
+
*/
|
|
582
|
+
FleetId: string | undefined;
|
|
583
|
+
/**
|
|
584
|
+
* <p>A descriptive label that is associated with a fleet. Fleet names do not need to be unique.</p>
|
|
585
|
+
* @public
|
|
586
|
+
*/
|
|
587
|
+
Name?: string;
|
|
588
|
+
/**
|
|
589
|
+
* <p>A human-readable description of a fleet.</p>
|
|
590
|
+
* @public
|
|
591
|
+
*/
|
|
592
|
+
Description?: string;
|
|
593
|
+
/**
|
|
594
|
+
* <p>The game session protection policy to apply to all new game sessions created in this
|
|
595
|
+
* fleet. Game sessions that already exist are not affected. You can set protection for
|
|
596
|
+
* individual game sessions using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html">UpdateGameSession</a> .</p>
|
|
597
|
+
* <ul>
|
|
598
|
+
* <li>
|
|
599
|
+
* <p>
|
|
600
|
+
* <b>NoProtection</b> -- The game session can be
|
|
601
|
+
* terminated during a scale-down event.</p>
|
|
602
|
+
* </li>
|
|
603
|
+
* <li>
|
|
604
|
+
* <p>
|
|
605
|
+
* <b>FullProtection</b> -- If the game session is in an
|
|
606
|
+
* <code>ACTIVE</code> status, it cannot be terminated during a scale-down
|
|
607
|
+
* event.</p>
|
|
608
|
+
* </li>
|
|
609
|
+
* </ul>
|
|
610
|
+
* @public
|
|
611
|
+
*/
|
|
612
|
+
NewGameSessionProtectionPolicy?: ProtectionPolicy;
|
|
613
|
+
/**
|
|
614
|
+
* <p>Policy settings that limit the number of game sessions an individual player can create
|
|
615
|
+
* over a span of time. </p>
|
|
616
|
+
* @public
|
|
617
|
+
*/
|
|
618
|
+
ResourceCreationLimitPolicy?: ResourceCreationLimitPolicy;
|
|
619
|
+
/**
|
|
620
|
+
* <p>The name of a metric group to add this fleet to. Use a metric group in Amazon
|
|
621
|
+
* CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric
|
|
622
|
+
* group name, or create a new metric group by providing a new name. A fleet can only be in
|
|
623
|
+
* one metric group at a time.</p>
|
|
624
|
+
* @public
|
|
625
|
+
*/
|
|
626
|
+
MetricGroups?: string[];
|
|
627
|
+
/**
|
|
628
|
+
* <p>Amazon GameLift Anywhere configuration options.</p>
|
|
629
|
+
* @public
|
|
630
|
+
*/
|
|
631
|
+
AnywhereConfiguration?: AnywhereConfiguration;
|
|
632
|
+
}
|
|
633
|
+
/**
|
|
634
|
+
* @public
|
|
635
|
+
*/
|
|
636
|
+
export interface UpdateFleetAttributesOutput {
|
|
637
|
+
/**
|
|
638
|
+
* <p>A unique identifier for the fleet that was updated.</p>
|
|
639
|
+
* @public
|
|
640
|
+
*/
|
|
641
|
+
FleetId?: string;
|
|
642
|
+
/**
|
|
643
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
644
|
+
* @public
|
|
645
|
+
*/
|
|
646
|
+
FleetArn?: string;
|
|
647
|
+
}
|
|
2
648
|
/**
|
|
3
649
|
* @public
|
|
4
650
|
*/
|
|
@@ -494,10 +1140,10 @@ export interface UpdateRuntimeConfigurationInput {
|
|
|
494
1140
|
*/
|
|
495
1141
|
FleetId: string | undefined;
|
|
496
1142
|
/**
|
|
497
|
-
* <p>Instructions for launching server processes on
|
|
498
|
-
*
|
|
499
|
-
*
|
|
500
|
-
*
|
|
1143
|
+
* <p>Instructions for launching server processes on fleet computes. Server processes run
|
|
1144
|
+
* either a custom game build executable or a Realtime Servers script. The runtime configuration lists
|
|
1145
|
+
* the types of server processes to run, how to launch them, and the number of processes to
|
|
1146
|
+
* run concurrently.</p>
|
|
501
1147
|
* @public
|
|
502
1148
|
*/
|
|
503
1149
|
RuntimeConfiguration: RuntimeConfiguration | undefined;
|
|
@@ -507,8 +1153,8 @@ export interface UpdateRuntimeConfigurationInput {
|
|
|
507
1153
|
*/
|
|
508
1154
|
export interface UpdateRuntimeConfigurationOutput {
|
|
509
1155
|
/**
|
|
510
|
-
* <p>The runtime configuration currently in use by
|
|
511
|
-
*
|
|
1156
|
+
* <p>The runtime configuration currently in use by computes in the fleet. If the update is
|
|
1157
|
+
* successful, all property changes are shown. </p>
|
|
512
1158
|
* @public
|
|
513
1159
|
*/
|
|
514
1160
|
RuntimeConfiguration?: RuntimeConfiguration;
|
|
@@ -589,6 +1235,38 @@ export interface ValidateMatchmakingRuleSetOutput {
|
|
|
589
1235
|
*/
|
|
590
1236
|
Valid?: boolean;
|
|
591
1237
|
}
|
|
1238
|
+
/**
|
|
1239
|
+
* @internal
|
|
1240
|
+
*/
|
|
1241
|
+
export declare const SearchGameSessionsOutputFilterSensitiveLog: (obj: SearchGameSessionsOutput) => any;
|
|
1242
|
+
/**
|
|
1243
|
+
* @internal
|
|
1244
|
+
*/
|
|
1245
|
+
export declare const StartGameSessionPlacementInputFilterSensitiveLog: (obj: StartGameSessionPlacementInput) => any;
|
|
1246
|
+
/**
|
|
1247
|
+
* @internal
|
|
1248
|
+
*/
|
|
1249
|
+
export declare const StartGameSessionPlacementOutputFilterSensitiveLog: (obj: StartGameSessionPlacementOutput) => any;
|
|
1250
|
+
/**
|
|
1251
|
+
* @internal
|
|
1252
|
+
*/
|
|
1253
|
+
export declare const StartMatchBackfillInputFilterSensitiveLog: (obj: StartMatchBackfillInput) => any;
|
|
1254
|
+
/**
|
|
1255
|
+
* @internal
|
|
1256
|
+
*/
|
|
1257
|
+
export declare const StartMatchBackfillOutputFilterSensitiveLog: (obj: StartMatchBackfillOutput) => any;
|
|
1258
|
+
/**
|
|
1259
|
+
* @internal
|
|
1260
|
+
*/
|
|
1261
|
+
export declare const StartMatchmakingInputFilterSensitiveLog: (obj: StartMatchmakingInput) => any;
|
|
1262
|
+
/**
|
|
1263
|
+
* @internal
|
|
1264
|
+
*/
|
|
1265
|
+
export declare const StartMatchmakingOutputFilterSensitiveLog: (obj: StartMatchmakingOutput) => any;
|
|
1266
|
+
/**
|
|
1267
|
+
* @internal
|
|
1268
|
+
*/
|
|
1269
|
+
export declare const StopGameSessionPlacementOutputFilterSensitiveLog: (obj: StopGameSessionPlacementOutput) => any;
|
|
592
1270
|
/**
|
|
593
1271
|
* @internal
|
|
594
1272
|
*/
|