@aws-sdk/client-gamelift 3.687.0 → 3.691.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 +72 -0
- package/dist-cjs/index.js +830 -188
- package/dist-es/GameLift.js +18 -0
- package/dist-es/commands/CreateContainerFleetCommand.js +23 -0
- package/dist-es/commands/CreateFleetCommand.js +2 -2
- package/dist-es/commands/DeleteContainerFleetCommand.js +22 -0
- package/dist-es/commands/DescribeContainerFleetCommand.js +23 -0
- package/dist-es/commands/DescribeFleetAttributesCommand.js +1 -2
- package/dist-es/commands/DescribeFleetDeploymentCommand.js +22 -0
- package/dist-es/commands/ListContainerFleetsCommand.js +23 -0
- package/dist-es/commands/ListContainerGroupDefinitionVersionsCommand.js +23 -0
- package/dist-es/commands/ListContainerGroupDefinitionsCommand.js +1 -1
- package/dist-es/commands/ListFleetDeploymentsCommand.js +22 -0
- package/dist-es/commands/RegisterComputeCommand.js +1 -1
- package/dist-es/commands/RequestUploadCredentialsCommand.js +1 -1
- package/dist-es/commands/UpdateContainerFleetCommand.js +23 -0
- package/dist-es/commands/UpdateContainerGroupDefinitionCommand.js +23 -0
- package/dist-es/commands/index.js +9 -0
- package/dist-es/models/models_0.js +132 -81
- package/dist-es/models/models_1.js +50 -1
- package/dist-es/pagination/ListContainerFleetsPaginator.js +4 -0
- package/dist-es/pagination/ListContainerGroupDefinitionVersionsPaginator.js +4 -0
- package/dist-es/pagination/ListFleetDeploymentsPaginator.js +4 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/protocols/Aws_json1_1.js +352 -7
- package/dist-types/GameLift.d.ts +65 -0
- package/dist-types/GameLiftClient.d.ts +11 -2
- package/dist-types/commands/CreateBuildCommand.d.ts +27 -21
- package/dist-types/commands/CreateContainerFleetCommand.d.ts +283 -0
- package/dist-types/commands/CreateContainerGroupDefinitionCommand.d.ts +278 -119
- package/dist-types/commands/CreateFleetCommand.d.ts +5 -88
- package/dist-types/commands/CreateFleetLocationsCommand.d.ts +3 -6
- package/dist-types/commands/CreateScriptCommand.d.ts +9 -12
- package/dist-types/commands/DeleteContainerFleetCommand.d.ts +102 -0
- package/dist-types/commands/DeleteContainerGroupDefinitionCommand.d.ts +24 -7
- package/dist-types/commands/DeleteScalingPolicyCommand.d.ts +3 -0
- package/dist-types/commands/DeregisterComputeCommand.d.ts +2 -5
- package/dist-types/commands/DescribeComputeCommand.d.ts +14 -21
- package/dist-types/commands/DescribeContainerFleetCommand.d.ts +157 -0
- package/dist-types/commands/DescribeContainerGroupDefinitionCommand.d.ts +95 -48
- package/dist-types/commands/DescribeFleetAttributesCommand.d.ts +2 -21
- package/dist-types/commands/DescribeFleetCapacityCommand.d.ts +8 -8
- package/dist-types/commands/DescribeFleetDeploymentCommand.d.ts +125 -0
- package/dist-types/commands/DescribeFleetEventsCommand.d.ts +4 -1
- package/dist-types/commands/DescribeFleetLocationCapacityCommand.d.ts +4 -4
- package/dist-types/commands/DescribeFleetPortSettingsCommand.d.ts +3 -3
- package/dist-types/commands/DescribeRuntimeConfigurationCommand.d.ts +2 -4
- package/dist-types/commands/GetComputeAccessCommand.d.ts +20 -30
- package/dist-types/commands/GetComputeAuthTokenCommand.d.ts +18 -13
- package/dist-types/commands/ListComputeCommand.d.ts +36 -28
- package/dist-types/commands/ListContainerFleetsCommand.d.ts +165 -0
- package/dist-types/commands/ListContainerGroupDefinitionVersionsCommand.d.ts +216 -0
- package/dist-types/commands/ListContainerGroupDefinitionsCommand.d.ts +97 -49
- package/dist-types/commands/ListFleetDeploymentsCommand.d.ts +132 -0
- package/dist-types/commands/ListFleetsCommand.d.ts +2 -10
- package/dist-types/commands/ListGameServerGroupsCommand.d.ts +1 -1
- package/dist-types/commands/ListGameServersCommand.d.ts +1 -1
- package/dist-types/commands/ListLocationsCommand.d.ts +1 -1
- package/dist-types/commands/ListScriptsCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +4 -1
- package/dist-types/commands/PutScalingPolicyCommand.d.ts +4 -1
- package/dist-types/commands/RegisterComputeCommand.d.ts +13 -19
- package/dist-types/commands/RegisterGameServerCommand.d.ts +1 -1
- package/dist-types/commands/RequestUploadCredentialsCommand.d.ts +1 -1
- package/dist-types/commands/ResolveAliasCommand.d.ts +1 -1
- package/dist-types/commands/ResumeGameServerGroupCommand.d.ts +1 -2
- package/dist-types/commands/StartGameSessionPlacementCommand.d.ts +2 -2
- package/dist-types/commands/StopFleetActionsCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +3 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +3 -0
- package/dist-types/commands/UpdateContainerFleetCommand.d.ts +253 -0
- package/dist-types/commands/UpdateContainerGroupDefinitionCommand.d.ts +310 -0
- package/dist-types/commands/UpdateFleetCapacityCommand.d.ts +6 -9
- package/dist-types/commands/UpdateRuntimeConfigurationCommand.d.ts +1 -3
- package/dist-types/commands/index.d.ts +9 -0
- package/dist-types/models/models_0.d.ts +4498 -4238
- package/dist-types/models/models_1.d.ts +996 -117
- package/dist-types/pagination/ListContainerFleetsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListContainerGroupDefinitionVersionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListFleetDeploymentsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +81 -0
- package/dist-types/ts3.4/GameLift.d.ts +161 -0
- package/dist-types/ts3.4/GameLiftClient.d.ts +54 -0
- package/dist-types/ts3.4/commands/CreateContainerFleetCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteContainerFleetCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteContainerGroupDefinitionCommand.d.ts +6 -2
- package/dist-types/ts3.4/commands/DescribeContainerFleetCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeFleetDeploymentCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListContainerFleetsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListContainerGroupDefinitionVersionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListContainerGroupDefinitionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListFleetDeploymentsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListFleetsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListGameServerGroupsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListGameServersCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListLocationsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListScriptsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutScalingPolicyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RegisterComputeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RegisterGameServerCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RequestUploadCredentialsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ResolveAliasCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ResumeGameServerGroupCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/UpdateContainerFleetCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateContainerGroupDefinitionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +9 -0
- package/dist-types/ts3.4/models/models_0.d.ts +918 -844
- package/dist-types/ts3.4/models/models_1.d.ts +323 -99
- package/dist-types/ts3.4/pagination/ListContainerFleetsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListContainerGroupDefinitionVersionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListFleetDeploymentsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +108 -0
- package/package.json +7 -7
|
@@ -1,4 +1,666 @@
|
|
|
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";
|
|
1
|
+
import { Alias, AnywhereConfiguration, AwsCredentials, BackfillMode, BalancingStrategy, Build, ComparisonOperatorType, Compute, ConnectionPortRange, ContainerFleet, ContainerFleetRemoveAttribute, ContainerGroupDefinition, ContainerGroupType, ContainerOperatingSystem, DeploymentConfiguration, DesiredPlayerSession, FilterConfiguration, FleetAction, FleetDeployment, FlexMatchMode, GameProperty, GameServer, GameServerContainerDefinitionInput, GameServerGroup, GameServerGroupAction, GameServerProtectionPolicy, GameServerUtilizationStatus, GameSession, GameSessionCreationLimitPolicy, GameSessionPlacement, GameSessionQueue, GameSessionQueueDestination, InstanceDefinition, IpPermission, LocationModel, LogConfiguration, MatchmakingConfiguration, MatchmakingTicket, MetricName, Player, PlayerLatency, PlayerLatencyPolicy, PlayerSessionCreationPolicy, PolicyType, PriorityConfiguration, ProtectionPolicy, ResourceCreationLimitPolicy, RoutingStrategy, RuntimeConfiguration, S3Location, ScalingAdjustmentType, Script, SupportContainerDefinitionInput, Tag, TargetConfiguration } from "./models_0";
|
|
2
|
+
/**
|
|
3
|
+
* @public
|
|
4
|
+
*/
|
|
5
|
+
export interface ListContainerGroupDefinitionsInput {
|
|
6
|
+
/**
|
|
7
|
+
* <p>The type of container group to retrieve. Container group type determines how Amazon GameLift
|
|
8
|
+
* deploys the container group on each fleet instance.</p>
|
|
9
|
+
* @public
|
|
10
|
+
*/
|
|
11
|
+
ContainerGroupType?: ContainerGroupType | undefined;
|
|
12
|
+
/**
|
|
13
|
+
* <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>
|
|
14
|
+
* @public
|
|
15
|
+
*/
|
|
16
|
+
Limit?: number | undefined;
|
|
17
|
+
/**
|
|
18
|
+
* <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>
|
|
19
|
+
* @public
|
|
20
|
+
*/
|
|
21
|
+
NextToken?: string | undefined;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* @public
|
|
25
|
+
*/
|
|
26
|
+
export interface ListContainerGroupDefinitionsOutput {
|
|
27
|
+
/**
|
|
28
|
+
* <p>A result set of container group definitions that match the request.</p>
|
|
29
|
+
* @public
|
|
30
|
+
*/
|
|
31
|
+
ContainerGroupDefinitions?: ContainerGroupDefinition[] | undefined;
|
|
32
|
+
/**
|
|
33
|
+
* <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>
|
|
34
|
+
* @public
|
|
35
|
+
*/
|
|
36
|
+
NextToken?: string | undefined;
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* @public
|
|
40
|
+
*/
|
|
41
|
+
export interface ListContainerGroupDefinitionVersionsInput {
|
|
42
|
+
/**
|
|
43
|
+
* <p>The unique identifier for the container group definition to retrieve properties for. You can use either the <code>Name</code> or
|
|
44
|
+
* <code>ARN</code> value.</p>
|
|
45
|
+
* @public
|
|
46
|
+
*/
|
|
47
|
+
Name: string | undefined;
|
|
48
|
+
/**
|
|
49
|
+
* <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>
|
|
50
|
+
* @public
|
|
51
|
+
*/
|
|
52
|
+
Limit?: number | undefined;
|
|
53
|
+
/**
|
|
54
|
+
* <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>
|
|
55
|
+
* @public
|
|
56
|
+
*/
|
|
57
|
+
NextToken?: string | undefined;
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* @public
|
|
61
|
+
*/
|
|
62
|
+
export interface ListContainerGroupDefinitionVersionsOutput {
|
|
63
|
+
/**
|
|
64
|
+
* <p>A result set of container group definitions that match the request.</p>
|
|
65
|
+
* @public
|
|
66
|
+
*/
|
|
67
|
+
ContainerGroupDefinitions?: ContainerGroupDefinition[] | undefined;
|
|
68
|
+
/**
|
|
69
|
+
* <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>
|
|
70
|
+
* @public
|
|
71
|
+
*/
|
|
72
|
+
NextToken?: string | undefined;
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* @public
|
|
76
|
+
*/
|
|
77
|
+
export interface ListFleetDeploymentsInput {
|
|
78
|
+
/**
|
|
79
|
+
* <p>A unique identifier for the container fleet. You can use either the fleet ID or ARN
|
|
80
|
+
* value.</p>
|
|
81
|
+
* @public
|
|
82
|
+
*/
|
|
83
|
+
FleetId?: string | undefined;
|
|
84
|
+
/**
|
|
85
|
+
* <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>
|
|
86
|
+
* @public
|
|
87
|
+
*/
|
|
88
|
+
Limit?: number | undefined;
|
|
89
|
+
/**
|
|
90
|
+
* <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>
|
|
91
|
+
* @public
|
|
92
|
+
*/
|
|
93
|
+
NextToken?: string | undefined;
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
export interface ListFleetDeploymentsOutput {
|
|
99
|
+
/**
|
|
100
|
+
* <p>The requested deployment information.</p>
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
FleetDeployments?: FleetDeployment[] | undefined;
|
|
104
|
+
/**
|
|
105
|
+
* <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>
|
|
106
|
+
* @public
|
|
107
|
+
*/
|
|
108
|
+
NextToken?: string | undefined;
|
|
109
|
+
}
|
|
110
|
+
/**
|
|
111
|
+
* @public
|
|
112
|
+
*/
|
|
113
|
+
export interface ListFleetsInput {
|
|
114
|
+
/**
|
|
115
|
+
* <p>A unique identifier for the build to request fleets for. Use this parameter to return only fleets using a
|
|
116
|
+
* specified build. Use either the build ID or ARN value.</p>
|
|
117
|
+
* @public
|
|
118
|
+
*/
|
|
119
|
+
BuildId?: string | undefined;
|
|
120
|
+
/**
|
|
121
|
+
* <p>A unique identifier for the Realtime script to request fleets for. Use this parameter to return only fleets using a
|
|
122
|
+
* specified script. Use either the script ID or ARN value.</p>
|
|
123
|
+
* @public
|
|
124
|
+
*/
|
|
125
|
+
ScriptId?: string | undefined;
|
|
126
|
+
/**
|
|
127
|
+
* <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>
|
|
128
|
+
* @public
|
|
129
|
+
*/
|
|
130
|
+
Limit?: number | undefined;
|
|
131
|
+
/**
|
|
132
|
+
* <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>
|
|
133
|
+
* @public
|
|
134
|
+
*/
|
|
135
|
+
NextToken?: string | undefined;
|
|
136
|
+
}
|
|
137
|
+
/**
|
|
138
|
+
* @public
|
|
139
|
+
*/
|
|
140
|
+
export interface ListFleetsOutput {
|
|
141
|
+
/**
|
|
142
|
+
* <p>A set of fleet IDs that match the list request.</p>
|
|
143
|
+
* @public
|
|
144
|
+
*/
|
|
145
|
+
FleetIds?: string[] | undefined;
|
|
146
|
+
/**
|
|
147
|
+
* <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>
|
|
148
|
+
* @public
|
|
149
|
+
*/
|
|
150
|
+
NextToken?: string | undefined;
|
|
151
|
+
}
|
|
152
|
+
/**
|
|
153
|
+
* @public
|
|
154
|
+
*/
|
|
155
|
+
export interface ListGameServerGroupsInput {
|
|
156
|
+
/**
|
|
157
|
+
* <p>The game server groups' limit.</p>
|
|
158
|
+
* @public
|
|
159
|
+
*/
|
|
160
|
+
Limit?: number | undefined;
|
|
161
|
+
/**
|
|
162
|
+
* <p>Specify the pagination token from a previous request to retrieve the next page of
|
|
163
|
+
* results.</p>
|
|
164
|
+
* @public
|
|
165
|
+
*/
|
|
166
|
+
NextToken?: string | undefined;
|
|
167
|
+
}
|
|
168
|
+
/**
|
|
169
|
+
* @public
|
|
170
|
+
*/
|
|
171
|
+
export interface ListGameServerGroupsOutput {
|
|
172
|
+
/**
|
|
173
|
+
* <p>The game server groups' game server groups.</p>
|
|
174
|
+
* @public
|
|
175
|
+
*/
|
|
176
|
+
GameServerGroups?: GameServerGroup[] | undefined;
|
|
177
|
+
/**
|
|
178
|
+
* <p>Specify the pagination token from a previous request to retrieve the next page of
|
|
179
|
+
* results.</p>
|
|
180
|
+
* @public
|
|
181
|
+
*/
|
|
182
|
+
NextToken?: string | undefined;
|
|
183
|
+
}
|
|
184
|
+
/**
|
|
185
|
+
* @public
|
|
186
|
+
* @enum
|
|
187
|
+
*/
|
|
188
|
+
export declare const SortOrder: {
|
|
189
|
+
readonly ASCENDING: "ASCENDING";
|
|
190
|
+
readonly DESCENDING: "DESCENDING";
|
|
191
|
+
};
|
|
192
|
+
/**
|
|
193
|
+
* @public
|
|
194
|
+
*/
|
|
195
|
+
export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
|
|
196
|
+
/**
|
|
197
|
+
* @public
|
|
198
|
+
*/
|
|
199
|
+
export interface ListGameServersInput {
|
|
200
|
+
/**
|
|
201
|
+
* <p>An identifier for the game server group to retrieve a list of game servers from. Use
|
|
202
|
+
* either the name or ARN value.</p>
|
|
203
|
+
* @public
|
|
204
|
+
*/
|
|
205
|
+
GameServerGroupName: string | undefined;
|
|
206
|
+
/**
|
|
207
|
+
* <p>Indicates how to sort the returned data based on game server registration timestamp.
|
|
208
|
+
* Use <code>ASCENDING</code> to retrieve oldest game servers first, or use
|
|
209
|
+
* <code>DESCENDING</code> to retrieve newest game servers first. If this parameter is
|
|
210
|
+
* left empty, game servers are returned in no particular order.</p>
|
|
211
|
+
* @public
|
|
212
|
+
*/
|
|
213
|
+
SortOrder?: SortOrder | undefined;
|
|
214
|
+
/**
|
|
215
|
+
* <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>
|
|
216
|
+
* @public
|
|
217
|
+
*/
|
|
218
|
+
Limit?: number | undefined;
|
|
219
|
+
/**
|
|
220
|
+
* <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>
|
|
221
|
+
* @public
|
|
222
|
+
*/
|
|
223
|
+
NextToken?: string | undefined;
|
|
224
|
+
}
|
|
225
|
+
/**
|
|
226
|
+
* @public
|
|
227
|
+
*/
|
|
228
|
+
export interface ListGameServersOutput {
|
|
229
|
+
/**
|
|
230
|
+
* <p>A collection of game server objects that match the request.</p>
|
|
231
|
+
* @public
|
|
232
|
+
*/
|
|
233
|
+
GameServers?: GameServer[] | undefined;
|
|
234
|
+
/**
|
|
235
|
+
* <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>
|
|
236
|
+
* @public
|
|
237
|
+
*/
|
|
238
|
+
NextToken?: string | undefined;
|
|
239
|
+
}
|
|
240
|
+
/**
|
|
241
|
+
* @public
|
|
242
|
+
* @enum
|
|
243
|
+
*/
|
|
244
|
+
export declare const LocationFilter: {
|
|
245
|
+
readonly AWS: "AWS";
|
|
246
|
+
readonly CUSTOM: "CUSTOM";
|
|
247
|
+
};
|
|
248
|
+
/**
|
|
249
|
+
* @public
|
|
250
|
+
*/
|
|
251
|
+
export type LocationFilter = (typeof LocationFilter)[keyof typeof LocationFilter];
|
|
252
|
+
/**
|
|
253
|
+
* @public
|
|
254
|
+
*/
|
|
255
|
+
export interface ListLocationsInput {
|
|
256
|
+
/**
|
|
257
|
+
* <p>Filters the list for <code>AWS</code> or <code>CUSTOM</code> locations.</p>
|
|
258
|
+
* @public
|
|
259
|
+
*/
|
|
260
|
+
Filters?: LocationFilter[] | undefined;
|
|
261
|
+
/**
|
|
262
|
+
* <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>
|
|
263
|
+
* @public
|
|
264
|
+
*/
|
|
265
|
+
Limit?: number | undefined;
|
|
266
|
+
/**
|
|
267
|
+
* <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>
|
|
268
|
+
* @public
|
|
269
|
+
*/
|
|
270
|
+
NextToken?: string | undefined;
|
|
271
|
+
}
|
|
272
|
+
/**
|
|
273
|
+
* @public
|
|
274
|
+
*/
|
|
275
|
+
export interface ListLocationsOutput {
|
|
276
|
+
/**
|
|
277
|
+
* <p>A collection of locations.</p>
|
|
278
|
+
* @public
|
|
279
|
+
*/
|
|
280
|
+
Locations?: LocationModel[] | undefined;
|
|
281
|
+
/**
|
|
282
|
+
* <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>
|
|
283
|
+
* @public
|
|
284
|
+
*/
|
|
285
|
+
NextToken?: string | undefined;
|
|
286
|
+
}
|
|
287
|
+
/**
|
|
288
|
+
* @public
|
|
289
|
+
*/
|
|
290
|
+
export interface ListScriptsInput {
|
|
291
|
+
/**
|
|
292
|
+
* <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>
|
|
293
|
+
* @public
|
|
294
|
+
*/
|
|
295
|
+
Limit?: number | undefined;
|
|
296
|
+
/**
|
|
297
|
+
* <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>
|
|
298
|
+
* @public
|
|
299
|
+
*/
|
|
300
|
+
NextToken?: string | undefined;
|
|
301
|
+
}
|
|
302
|
+
/**
|
|
303
|
+
* @public
|
|
304
|
+
*/
|
|
305
|
+
export interface ListScriptsOutput {
|
|
306
|
+
/**
|
|
307
|
+
* <p>A set of properties describing the requested script.</p>
|
|
308
|
+
* @public
|
|
309
|
+
*/
|
|
310
|
+
Scripts?: Script[] | undefined;
|
|
311
|
+
/**
|
|
312
|
+
* <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>
|
|
313
|
+
* @public
|
|
314
|
+
*/
|
|
315
|
+
NextToken?: string | undefined;
|
|
316
|
+
}
|
|
317
|
+
/**
|
|
318
|
+
* @public
|
|
319
|
+
*/
|
|
320
|
+
export interface ListTagsForResourceRequest {
|
|
321
|
+
/**
|
|
322
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that uniquely identifies
|
|
323
|
+
* the Amazon GameLift resource that you want to retrieve tags for. Amazon GameLift includes resource ARNs in
|
|
324
|
+
* the data object for the resource. You can retrieve the ARN by calling a
|
|
325
|
+
* <code>List</code> or <code>Describe</code> operation for the resource type. </p>
|
|
326
|
+
* @public
|
|
327
|
+
*/
|
|
328
|
+
ResourceARN: string | undefined;
|
|
329
|
+
}
|
|
330
|
+
/**
|
|
331
|
+
* @public
|
|
332
|
+
*/
|
|
333
|
+
export interface ListTagsForResourceResponse {
|
|
334
|
+
/**
|
|
335
|
+
* <p>The collection of tags assigned to the resource. </p>
|
|
336
|
+
* @public
|
|
337
|
+
*/
|
|
338
|
+
Tags?: Tag[] | undefined;
|
|
339
|
+
}
|
|
340
|
+
/**
|
|
341
|
+
* @public
|
|
342
|
+
*/
|
|
343
|
+
export interface PutScalingPolicyInput {
|
|
344
|
+
/**
|
|
345
|
+
* <p>A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.</p>
|
|
346
|
+
* @public
|
|
347
|
+
*/
|
|
348
|
+
Name: string | undefined;
|
|
349
|
+
/**
|
|
350
|
+
* <p>A unique identifier for the fleet to apply this policy to. You can use either the fleet ID or ARN value. The fleet
|
|
351
|
+
* cannot be in any of the following statuses: ERROR or DELETING.</p>
|
|
352
|
+
* @public
|
|
353
|
+
*/
|
|
354
|
+
FleetId: string | undefined;
|
|
355
|
+
/**
|
|
356
|
+
* <p>Amount of adjustment to make, based on the scaling adjustment type.</p>
|
|
357
|
+
* @public
|
|
358
|
+
*/
|
|
359
|
+
ScalingAdjustment?: number | undefined;
|
|
360
|
+
/**
|
|
361
|
+
* <p>The type of adjustment to make to a fleet's instance count:</p>
|
|
362
|
+
* <ul>
|
|
363
|
+
* <li>
|
|
364
|
+
* <p>
|
|
365
|
+
* <b>ChangeInCapacity</b> -- add (or subtract) the
|
|
366
|
+
* scaling adjustment value from the current instance count. Positive values scale
|
|
367
|
+
* up while negative values scale down.</p>
|
|
368
|
+
* </li>
|
|
369
|
+
* <li>
|
|
370
|
+
* <p>
|
|
371
|
+
* <b>ExactCapacity</b> -- set the instance count to the
|
|
372
|
+
* scaling adjustment value.</p>
|
|
373
|
+
* </li>
|
|
374
|
+
* <li>
|
|
375
|
+
* <p>
|
|
376
|
+
* <b>PercentChangeInCapacity</b> -- increase or reduce
|
|
377
|
+
* the current instance count by the scaling adjustment, read as a percentage.
|
|
378
|
+
* Positive values scale up while negative values scale down; for example, a value
|
|
379
|
+
* of "-10" scales the fleet down by 10%.</p>
|
|
380
|
+
* </li>
|
|
381
|
+
* </ul>
|
|
382
|
+
* @public
|
|
383
|
+
*/
|
|
384
|
+
ScalingAdjustmentType?: ScalingAdjustmentType | undefined;
|
|
385
|
+
/**
|
|
386
|
+
* <p>Metric value used to trigger a scaling event.</p>
|
|
387
|
+
* @public
|
|
388
|
+
*/
|
|
389
|
+
Threshold?: number | undefined;
|
|
390
|
+
/**
|
|
391
|
+
* <p>Comparison operator to use when measuring the metric against the threshold
|
|
392
|
+
* value.</p>
|
|
393
|
+
* @public
|
|
394
|
+
*/
|
|
395
|
+
ComparisonOperator?: ComparisonOperatorType | undefined;
|
|
396
|
+
/**
|
|
397
|
+
* <p>Length of time (in minutes) the metric must be at or beyond the threshold before a
|
|
398
|
+
* scaling event is triggered.</p>
|
|
399
|
+
* @public
|
|
400
|
+
*/
|
|
401
|
+
EvaluationPeriods?: number | undefined;
|
|
402
|
+
/**
|
|
403
|
+
* <p>Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For
|
|
404
|
+
* detailed descriptions of fleet metrics, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html">Monitor Amazon GameLift
|
|
405
|
+
* with Amazon CloudWatch</a>. </p>
|
|
406
|
+
* <ul>
|
|
407
|
+
* <li>
|
|
408
|
+
* <p>
|
|
409
|
+
* <b>ActivatingGameSessions</b> -- Game sessions in
|
|
410
|
+
* the process of being created.</p>
|
|
411
|
+
* </li>
|
|
412
|
+
* <li>
|
|
413
|
+
* <p>
|
|
414
|
+
* <b>ActiveGameSessions</b> -- Game sessions that
|
|
415
|
+
* are currently running.</p>
|
|
416
|
+
* </li>
|
|
417
|
+
* <li>
|
|
418
|
+
* <p>
|
|
419
|
+
* <b>ActiveInstances</b> -- Fleet instances that
|
|
420
|
+
* are currently running at least one game session.</p>
|
|
421
|
+
* </li>
|
|
422
|
+
* <li>
|
|
423
|
+
* <p>
|
|
424
|
+
* <b>AvailableGameSessions</b> -- Additional game
|
|
425
|
+
* sessions that fleet could host simultaneously, given current capacity.</p>
|
|
426
|
+
* </li>
|
|
427
|
+
* <li>
|
|
428
|
+
* <p>
|
|
429
|
+
* <b>AvailablePlayerSessions</b> -- Empty player
|
|
430
|
+
* slots in currently active game sessions. This includes game sessions that are
|
|
431
|
+
* not currently accepting players. Reserved player slots are not
|
|
432
|
+
* included.</p>
|
|
433
|
+
* </li>
|
|
434
|
+
* <li>
|
|
435
|
+
* <p>
|
|
436
|
+
* <b>CurrentPlayerSessions</b> -- Player slots in
|
|
437
|
+
* active game sessions that are being used by a player or are reserved for a
|
|
438
|
+
* player. </p>
|
|
439
|
+
* </li>
|
|
440
|
+
* <li>
|
|
441
|
+
* <p>
|
|
442
|
+
* <b>IdleInstances</b> -- Active instances that are
|
|
443
|
+
* currently hosting zero game sessions. </p>
|
|
444
|
+
* </li>
|
|
445
|
+
* <li>
|
|
446
|
+
* <p>
|
|
447
|
+
* <b>PercentAvailableGameSessions</b> -- Unused
|
|
448
|
+
* percentage of the total number of game sessions that a fleet could host
|
|
449
|
+
* simultaneously, given current capacity. Use this metric for a target-based
|
|
450
|
+
* scaling policy.</p>
|
|
451
|
+
* </li>
|
|
452
|
+
* <li>
|
|
453
|
+
* <p>
|
|
454
|
+
* <b>PercentIdleInstances</b> -- Percentage of the
|
|
455
|
+
* total number of active instances that are hosting zero game sessions.</p>
|
|
456
|
+
* </li>
|
|
457
|
+
* <li>
|
|
458
|
+
* <p>
|
|
459
|
+
* <b>QueueDepth</b> -- Pending game session
|
|
460
|
+
* placement requests, in any queue, where the current fleet is the top-priority
|
|
461
|
+
* destination.</p>
|
|
462
|
+
* </li>
|
|
463
|
+
* <li>
|
|
464
|
+
* <p>
|
|
465
|
+
* <b>WaitTime</b> -- Current wait time for pending
|
|
466
|
+
* game session placement requests, in any queue, where the current fleet is the
|
|
467
|
+
* top-priority destination. </p>
|
|
468
|
+
* </li>
|
|
469
|
+
* </ul>
|
|
470
|
+
* @public
|
|
471
|
+
*/
|
|
472
|
+
MetricName: MetricName | undefined;
|
|
473
|
+
/**
|
|
474
|
+
* <p>The type of scaling policy to create. For a target-based policy, set the parameter
|
|
475
|
+
* <i>MetricName</i> to 'PercentAvailableGameSessions' and specify a
|
|
476
|
+
* <i>TargetConfiguration</i>. For a rule-based policy set the following
|
|
477
|
+
* parameters: <i>MetricName</i>, <i>ComparisonOperator</i>,
|
|
478
|
+
* <i>Threshold</i>, <i>EvaluationPeriods</i>,
|
|
479
|
+
* <i>ScalingAdjustmentType</i>, and
|
|
480
|
+
* <i>ScalingAdjustment</i>.</p>
|
|
481
|
+
* @public
|
|
482
|
+
*/
|
|
483
|
+
PolicyType?: PolicyType | undefined;
|
|
484
|
+
/**
|
|
485
|
+
* <p>An object that contains settings for a target-based scaling policy.</p>
|
|
486
|
+
* @public
|
|
487
|
+
*/
|
|
488
|
+
TargetConfiguration?: TargetConfiguration | undefined;
|
|
489
|
+
}
|
|
490
|
+
/**
|
|
491
|
+
* @public
|
|
492
|
+
*/
|
|
493
|
+
export interface PutScalingPolicyOutput {
|
|
494
|
+
/**
|
|
495
|
+
* <p>A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.</p>
|
|
496
|
+
* @public
|
|
497
|
+
*/
|
|
498
|
+
Name?: string | undefined;
|
|
499
|
+
}
|
|
500
|
+
/**
|
|
501
|
+
* @public
|
|
502
|
+
*/
|
|
503
|
+
export interface RegisterComputeInput {
|
|
504
|
+
/**
|
|
505
|
+
* <p>A unique identifier for the fleet to register the compute to. You can use either the fleet ID or ARN value.</p>
|
|
506
|
+
* @public
|
|
507
|
+
*/
|
|
508
|
+
FleetId: string | undefined;
|
|
509
|
+
/**
|
|
510
|
+
* <p>A descriptive label for the compute resource.</p>
|
|
511
|
+
* @public
|
|
512
|
+
*/
|
|
513
|
+
ComputeName: string | undefined;
|
|
514
|
+
/**
|
|
515
|
+
* <p>The path to a TLS certificate on your compute resource. Amazon GameLift doesn't validate the
|
|
516
|
+
* path and certificate.</p>
|
|
517
|
+
* @public
|
|
518
|
+
*/
|
|
519
|
+
CertificatePath?: string | undefined;
|
|
520
|
+
/**
|
|
521
|
+
* <p>The DNS name of the compute resource. Amazon GameLift requires either a DNS name or IP
|
|
522
|
+
* address.</p>
|
|
523
|
+
* @public
|
|
524
|
+
*/
|
|
525
|
+
DnsName?: string | undefined;
|
|
526
|
+
/**
|
|
527
|
+
* <p>The IP address of the compute resource. Amazon GameLift requires either a DNS name or IP
|
|
528
|
+
* address. When registering an Anywhere fleet, an IP address is required.</p>
|
|
529
|
+
* @public
|
|
530
|
+
*/
|
|
531
|
+
IpAddress?: string | undefined;
|
|
532
|
+
/**
|
|
533
|
+
* <p>The name of a custom location to associate with the compute resource being registered.
|
|
534
|
+
* This parameter is required when registering a compute for an Anywhere fleet.</p>
|
|
535
|
+
* @public
|
|
536
|
+
*/
|
|
537
|
+
Location?: string | undefined;
|
|
538
|
+
}
|
|
539
|
+
/**
|
|
540
|
+
* @public
|
|
541
|
+
*/
|
|
542
|
+
export interface RegisterComputeOutput {
|
|
543
|
+
/**
|
|
544
|
+
* <p>The details of the compute resource you registered.</p>
|
|
545
|
+
* @public
|
|
546
|
+
*/
|
|
547
|
+
Compute?: Compute | undefined;
|
|
548
|
+
}
|
|
549
|
+
/**
|
|
550
|
+
* @public
|
|
551
|
+
*/
|
|
552
|
+
export interface RegisterGameServerInput {
|
|
553
|
+
/**
|
|
554
|
+
* <p>A unique identifier for the game server group where the game server is running.</p>
|
|
555
|
+
* @public
|
|
556
|
+
*/
|
|
557
|
+
GameServerGroupName: string | undefined;
|
|
558
|
+
/**
|
|
559
|
+
* <p>A custom string that uniquely identifies the game server to register. Game server IDs are developer-defined and must be unique
|
|
560
|
+
* across all game server groups in your Amazon Web Services account.</p>
|
|
561
|
+
* @public
|
|
562
|
+
*/
|
|
563
|
+
GameServerId: string | undefined;
|
|
564
|
+
/**
|
|
565
|
+
* <p>The unique identifier for the instance where the game server is running. This ID is
|
|
566
|
+
* available in the instance metadata. EC2 instance IDs
|
|
567
|
+
* use a 17-character format, for example: <code>i-1234567890abcdef0</code>.</p>
|
|
568
|
+
* @public
|
|
569
|
+
*/
|
|
570
|
+
InstanceId: string | undefined;
|
|
571
|
+
/**
|
|
572
|
+
* <p>Information that is needed to make inbound client connections to the game server. This
|
|
573
|
+
* might include the IP address and port, DNS name, and other information.</p>
|
|
574
|
+
* @public
|
|
575
|
+
*/
|
|
576
|
+
ConnectionInfo?: string | undefined;
|
|
577
|
+
/**
|
|
578
|
+
* <p>A set of custom game server properties, formatted as a single string value. This data
|
|
579
|
+
* is passed to a game client or service when it requests information on game servers. </p>
|
|
580
|
+
* @public
|
|
581
|
+
*/
|
|
582
|
+
GameServerData?: string | undefined;
|
|
583
|
+
}
|
|
584
|
+
/**
|
|
585
|
+
* @public
|
|
586
|
+
*/
|
|
587
|
+
export interface RegisterGameServerOutput {
|
|
588
|
+
/**
|
|
589
|
+
* <p>Object that describes the newly registered game server.</p>
|
|
590
|
+
* @public
|
|
591
|
+
*/
|
|
592
|
+
GameServer?: GameServer | undefined;
|
|
593
|
+
}
|
|
594
|
+
/**
|
|
595
|
+
* @public
|
|
596
|
+
*/
|
|
597
|
+
export interface RequestUploadCredentialsInput {
|
|
598
|
+
/**
|
|
599
|
+
* <p>A unique identifier for the build to get credentials for. You can use either the build ID or ARN value. </p>
|
|
600
|
+
* @public
|
|
601
|
+
*/
|
|
602
|
+
BuildId: string | undefined;
|
|
603
|
+
}
|
|
604
|
+
/**
|
|
605
|
+
* @public
|
|
606
|
+
*/
|
|
607
|
+
export interface RequestUploadCredentialsOutput {
|
|
608
|
+
/**
|
|
609
|
+
* <p>Amazon Web Services credentials required when uploading a game build to the storage location. These
|
|
610
|
+
* credentials have a limited lifespan and are valid only for the build they were issued
|
|
611
|
+
* for.</p>
|
|
612
|
+
* @public
|
|
613
|
+
*/
|
|
614
|
+
UploadCredentials?: AwsCredentials | undefined;
|
|
615
|
+
/**
|
|
616
|
+
* <p>Amazon S3 path and key, identifying where the game build files are
|
|
617
|
+
* stored.</p>
|
|
618
|
+
* @public
|
|
619
|
+
*/
|
|
620
|
+
StorageLocation?: S3Location | undefined;
|
|
621
|
+
}
|
|
622
|
+
/**
|
|
623
|
+
* @public
|
|
624
|
+
*/
|
|
625
|
+
export interface ResolveAliasInput {
|
|
626
|
+
/**
|
|
627
|
+
* <p>The unique identifier of the alias that you want to retrieve a fleet ID for. You can
|
|
628
|
+
* use either the alias ID or ARN value.</p>
|
|
629
|
+
* @public
|
|
630
|
+
*/
|
|
631
|
+
AliasId: string | undefined;
|
|
632
|
+
}
|
|
633
|
+
/**
|
|
634
|
+
* @public
|
|
635
|
+
*/
|
|
636
|
+
export interface ResolveAliasOutput {
|
|
637
|
+
/**
|
|
638
|
+
* <p>The fleet identifier that the alias is pointing to.</p>
|
|
639
|
+
* @public
|
|
640
|
+
*/
|
|
641
|
+
FleetId?: string | undefined;
|
|
642
|
+
/**
|
|
643
|
+
* <p> The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) associated with the GameLift fleet resource that this alias points to.
|
|
644
|
+
* </p>
|
|
645
|
+
* @public
|
|
646
|
+
*/
|
|
647
|
+
FleetArn?: string | undefined;
|
|
648
|
+
}
|
|
649
|
+
/**
|
|
650
|
+
* @public
|
|
651
|
+
*/
|
|
652
|
+
export interface ResumeGameServerGroupInput {
|
|
653
|
+
/**
|
|
654
|
+
* <p>A unique identifier for the game server group. Use either the name or ARN value.</p>
|
|
655
|
+
* @public
|
|
656
|
+
*/
|
|
657
|
+
GameServerGroupName: string | undefined;
|
|
658
|
+
/**
|
|
659
|
+
* <p>The activity to resume for this game server group.</p>
|
|
660
|
+
* @public
|
|
661
|
+
*/
|
|
662
|
+
ResumeActions: GameServerGroupAction[] | undefined;
|
|
663
|
+
}
|
|
2
664
|
/**
|
|
3
665
|
* @public
|
|
4
666
|
*/
|
|
@@ -9,7 +671,7 @@ export interface ResumeGameServerGroupOutput {
|
|
|
9
671
|
* activity.</p>
|
|
10
672
|
* @public
|
|
11
673
|
*/
|
|
12
|
-
GameServerGroup?: GameServerGroup;
|
|
674
|
+
GameServerGroup?: GameServerGroup | undefined;
|
|
13
675
|
}
|
|
14
676
|
/**
|
|
15
677
|
* @public
|
|
@@ -20,21 +682,21 @@ export interface SearchGameSessionsInput {
|
|
|
20
682
|
* value. Each request must reference either a fleet ID or alias ID, but not both.</p>
|
|
21
683
|
* @public
|
|
22
684
|
*/
|
|
23
|
-
FleetId?: string;
|
|
685
|
+
FleetId?: string | undefined;
|
|
24
686
|
/**
|
|
25
687
|
* <p>A unique identifier for the alias associated with the fleet to search for active game sessions. You can use either
|
|
26
688
|
* the alias ID or ARN value. Each request must reference either a fleet ID or alias ID,
|
|
27
689
|
* but not both.</p>
|
|
28
690
|
* @public
|
|
29
691
|
*/
|
|
30
|
-
AliasId?: string;
|
|
692
|
+
AliasId?: string | undefined;
|
|
31
693
|
/**
|
|
32
694
|
* <p>A fleet location to search for game sessions. You can specify a fleet's home Region or
|
|
33
695
|
* a remote location. Use the Amazon Web Services Region code format, such as <code>us-west-2</code>.
|
|
34
696
|
* </p>
|
|
35
697
|
* @public
|
|
36
698
|
*/
|
|
37
|
-
Location?: string;
|
|
699
|
+
Location?: string | undefined;
|
|
38
700
|
/**
|
|
39
701
|
* <p>String containing the search criteria for the session search. If no filter expression
|
|
40
702
|
* is included, the request returns results for all game sessions in the fleet that are in
|
|
@@ -98,7 +760,7 @@ export interface SearchGameSessionsInput {
|
|
|
98
760
|
* hasAvailablePlayerSessions=true"</code>. </p>
|
|
99
761
|
* @public
|
|
100
762
|
*/
|
|
101
|
-
FilterExpression?: string;
|
|
763
|
+
FilterExpression?: string | undefined;
|
|
102
764
|
/**
|
|
103
765
|
* <p>Instructions on how to sort the search results. If no sort expression is included, the
|
|
104
766
|
* request returns results in random order. A sort expression consists of the following
|
|
@@ -123,18 +785,18 @@ export interface SearchGameSessionsInput {
|
|
|
123
785
|
* for the sort operand are returned at the end of the list.</p>
|
|
124
786
|
* @public
|
|
125
787
|
*/
|
|
126
|
-
SortExpression?: string;
|
|
788
|
+
SortExpression?: string | undefined;
|
|
127
789
|
/**
|
|
128
790
|
* <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
791
|
* is set higher than 20. </p>
|
|
130
792
|
* @public
|
|
131
793
|
*/
|
|
132
|
-
Limit?: number;
|
|
794
|
+
Limit?: number | undefined;
|
|
133
795
|
/**
|
|
134
796
|
* <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
797
|
* @public
|
|
136
798
|
*/
|
|
137
|
-
NextToken?: string;
|
|
799
|
+
NextToken?: string | undefined;
|
|
138
800
|
}
|
|
139
801
|
/**
|
|
140
802
|
* @public
|
|
@@ -145,12 +807,12 @@ export interface SearchGameSessionsOutput {
|
|
|
145
807
|
* matches the request.</p>
|
|
146
808
|
* @public
|
|
147
809
|
*/
|
|
148
|
-
GameSessions?: GameSession[];
|
|
810
|
+
GameSessions?: GameSession[] | undefined;
|
|
149
811
|
/**
|
|
150
812
|
* <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
813
|
* @public
|
|
152
814
|
*/
|
|
153
|
-
NextToken?: string;
|
|
815
|
+
NextToken?: string | undefined;
|
|
154
816
|
}
|
|
155
817
|
/**
|
|
156
818
|
* @public
|
|
@@ -171,7 +833,7 @@ export interface StartFleetActionsInput {
|
|
|
171
833
|
* Amazon Web Services Region code, such as <code>us-west-2</code>.</p>
|
|
172
834
|
* @public
|
|
173
835
|
*/
|
|
174
|
-
Location?: string;
|
|
836
|
+
Location?: string | undefined;
|
|
175
837
|
}
|
|
176
838
|
/**
|
|
177
839
|
* @public
|
|
@@ -181,12 +843,12 @@ export interface StartFleetActionsOutput {
|
|
|
181
843
|
* <p>A unique identifier for the fleet to restart actions on.</p>
|
|
182
844
|
* @public
|
|
183
845
|
*/
|
|
184
|
-
FleetId?: string;
|
|
846
|
+
FleetId?: string | undefined;
|
|
185
847
|
/**
|
|
186
848
|
* <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
849
|
* @public
|
|
188
850
|
*/
|
|
189
|
-
FleetArn?: string;
|
|
851
|
+
FleetArn?: string | undefined;
|
|
190
852
|
}
|
|
191
853
|
/**
|
|
192
854
|
* @public
|
|
@@ -210,7 +872,7 @@ export interface StartGameSessionPlacementInput {
|
|
|
210
872
|
* For example: <code>\{"Key": "difficulty", "Value": "novice"\}</code>.</p>
|
|
211
873
|
* @public
|
|
212
874
|
*/
|
|
213
|
-
GameProperties?: GameProperty[];
|
|
875
|
+
GameProperties?: GameProperty[] | undefined;
|
|
214
876
|
/**
|
|
215
877
|
* <p>The maximum number of players that can be connected simultaneously to the game session.</p>
|
|
216
878
|
* @public
|
|
@@ -220,24 +882,23 @@ export interface StartGameSessionPlacementInput {
|
|
|
220
882
|
* <p>A descriptive label that is associated with a game session. Session names do not need to be unique.</p>
|
|
221
883
|
* @public
|
|
222
884
|
*/
|
|
223
|
-
GameSessionName?: string;
|
|
885
|
+
GameSessionName?: string | undefined;
|
|
224
886
|
/**
|
|
225
|
-
* <p>A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to
|
|
887
|
+
* <p>A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to @aws; Regions. This information is used to try to place the new game session where it
|
|
226
888
|
* can offer the best possible gameplay experience for the players. </p>
|
|
227
889
|
* @public
|
|
228
890
|
*/
|
|
229
|
-
PlayerLatencies?: PlayerLatency[];
|
|
891
|
+
PlayerLatencies?: PlayerLatency[] | undefined;
|
|
230
892
|
/**
|
|
231
893
|
* <p>Set of information on each player to create a player session for.</p>
|
|
232
894
|
* @public
|
|
233
895
|
*/
|
|
234
|
-
DesiredPlayerSessions?: DesiredPlayerSession[];
|
|
896
|
+
DesiredPlayerSessions?: DesiredPlayerSession[] | undefined;
|
|
235
897
|
/**
|
|
236
|
-
* <p>A set of custom game session properties, formatted as a single string value. This data is passed to a game server process
|
|
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>
|
|
898
|
+
* <p>A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session. For more information, 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
899
|
* @public
|
|
239
900
|
*/
|
|
240
|
-
GameSessionData?: string;
|
|
901
|
+
GameSessionData?: string | undefined;
|
|
241
902
|
}
|
|
242
903
|
/**
|
|
243
904
|
* @public
|
|
@@ -249,7 +910,7 @@ export interface StartGameSessionPlacementOutput {
|
|
|
249
910
|
* placement status. </p>
|
|
250
911
|
* @public
|
|
251
912
|
*/
|
|
252
|
-
GameSessionPlacement?: GameSessionPlacement;
|
|
913
|
+
GameSessionPlacement?: GameSessionPlacement | undefined;
|
|
253
914
|
}
|
|
254
915
|
/**
|
|
255
916
|
* @public
|
|
@@ -261,7 +922,7 @@ export interface StartMatchBackfillInput {
|
|
|
261
922
|
* results.</p>
|
|
262
923
|
* @public
|
|
263
924
|
*/
|
|
264
|
-
TicketId?: string;
|
|
925
|
+
TicketId?: string | undefined;
|
|
265
926
|
/**
|
|
266
927
|
* <p>Name of the matchmaker to use for this request. You can use either the configuration
|
|
267
928
|
* name or ARN value. The ARN of the matchmaker that was used with the original game
|
|
@@ -275,7 +936,7 @@ export interface StartMatchBackfillInput {
|
|
|
275
936
|
* solution, this parameter is not needed. </p>
|
|
276
937
|
* @public
|
|
277
938
|
*/
|
|
278
|
-
GameSessionArn?: string;
|
|
939
|
+
GameSessionArn?: string | undefined;
|
|
279
940
|
/**
|
|
280
941
|
* <p>Match information on all players that are currently assigned to the game session. This
|
|
281
942
|
* information is used by the matchmaker to find new players and add them to the existing
|
|
@@ -312,7 +973,7 @@ export interface StartMatchBackfillOutput {
|
|
|
312
973
|
* matchmaking process.</p>
|
|
313
974
|
* @public
|
|
314
975
|
*/
|
|
315
|
-
MatchmakingTicket?: MatchmakingTicket;
|
|
976
|
+
MatchmakingTicket?: MatchmakingTicket | undefined;
|
|
316
977
|
}
|
|
317
978
|
/**
|
|
318
979
|
* @public
|
|
@@ -324,7 +985,7 @@ export interface StartMatchmakingInput {
|
|
|
324
985
|
* results.</p>
|
|
325
986
|
* @public
|
|
326
987
|
*/
|
|
327
|
-
TicketId?: string;
|
|
988
|
+
TicketId?: string | undefined;
|
|
328
989
|
/**
|
|
329
990
|
* <p>Name of the matchmaking configuration to use for this request. Matchmaking
|
|
330
991
|
* configurations must exist in the same Region as this request. You can use either the
|
|
@@ -353,7 +1014,7 @@ export interface StartMatchmakingOutput {
|
|
|
353
1014
|
* matchmaking process.</p>
|
|
354
1015
|
* @public
|
|
355
1016
|
*/
|
|
356
|
-
MatchmakingTicket?: MatchmakingTicket;
|
|
1017
|
+
MatchmakingTicket?: MatchmakingTicket | undefined;
|
|
357
1018
|
}
|
|
358
1019
|
/**
|
|
359
1020
|
* @public
|
|
@@ -374,7 +1035,7 @@ export interface StopFleetActionsInput {
|
|
|
374
1035
|
* Amazon Web Services Region code, such as <code>us-west-2</code>.</p>
|
|
375
1036
|
* @public
|
|
376
1037
|
*/
|
|
377
|
-
Location?: string;
|
|
1038
|
+
Location?: string | undefined;
|
|
378
1039
|
}
|
|
379
1040
|
/**
|
|
380
1041
|
* @public
|
|
@@ -384,12 +1045,12 @@ export interface StopFleetActionsOutput {
|
|
|
384
1045
|
* <p>A unique identifier for the fleet to stop actions on.</p>
|
|
385
1046
|
* @public
|
|
386
1047
|
*/
|
|
387
|
-
FleetId?: string;
|
|
1048
|
+
FleetId?: string | undefined;
|
|
388
1049
|
/**
|
|
389
1050
|
* <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
1051
|
* @public
|
|
391
1052
|
*/
|
|
392
|
-
FleetArn?: string;
|
|
1053
|
+
FleetArn?: string | undefined;
|
|
393
1054
|
}
|
|
394
1055
|
/**
|
|
395
1056
|
* @public
|
|
@@ -410,7 +1071,7 @@ export interface StopGameSessionPlacementOutput {
|
|
|
410
1071
|
* status and an end time stamp. </p>
|
|
411
1072
|
* @public
|
|
412
1073
|
*/
|
|
413
|
-
GameSessionPlacement?: GameSessionPlacement;
|
|
1074
|
+
GameSessionPlacement?: GameSessionPlacement | undefined;
|
|
414
1075
|
}
|
|
415
1076
|
/**
|
|
416
1077
|
* @public
|
|
@@ -452,7 +1113,7 @@ export interface SuspendGameServerGroupOutput {
|
|
|
452
1113
|
* activity.</p>
|
|
453
1114
|
* @public
|
|
454
1115
|
*/
|
|
455
|
-
GameServerGroup?: GameServerGroup;
|
|
1116
|
+
GameServerGroup?: GameServerGroup | undefined;
|
|
456
1117
|
}
|
|
457
1118
|
/**
|
|
458
1119
|
* @public
|
|
@@ -517,18 +1178,18 @@ export interface UpdateAliasInput {
|
|
|
517
1178
|
* <p>A descriptive label that is associated with an alias. Alias names do not need to be unique.</p>
|
|
518
1179
|
* @public
|
|
519
1180
|
*/
|
|
520
|
-
Name?: string;
|
|
1181
|
+
Name?: string | undefined;
|
|
521
1182
|
/**
|
|
522
1183
|
* <p>A human-readable description of the alias.</p>
|
|
523
1184
|
* @public
|
|
524
1185
|
*/
|
|
525
|
-
Description?: string;
|
|
1186
|
+
Description?: string | undefined;
|
|
526
1187
|
/**
|
|
527
1188
|
* <p>The routing configuration, including routing type and fleet target, for the
|
|
528
1189
|
* alias.</p>
|
|
529
1190
|
* @public
|
|
530
1191
|
*/
|
|
531
|
-
RoutingStrategy?: RoutingStrategy;
|
|
1192
|
+
RoutingStrategy?: RoutingStrategy | undefined;
|
|
532
1193
|
}
|
|
533
1194
|
/**
|
|
534
1195
|
* @public
|
|
@@ -538,7 +1199,7 @@ export interface UpdateAliasOutput {
|
|
|
538
1199
|
* <p>The updated alias resource.</p>
|
|
539
1200
|
* @public
|
|
540
1201
|
*/
|
|
541
|
-
Alias?: Alias;
|
|
1202
|
+
Alias?: Alias | undefined;
|
|
542
1203
|
}
|
|
543
1204
|
/**
|
|
544
1205
|
* @public
|
|
@@ -550,15 +1211,15 @@ export interface UpdateBuildInput {
|
|
|
550
1211
|
*/
|
|
551
1212
|
BuildId: string | undefined;
|
|
552
1213
|
/**
|
|
553
|
-
* <p>A descriptive label associated with a build. Build names
|
|
1214
|
+
* <p>A descriptive label that is associated with a build. Build names do not need to be unique. </p>
|
|
554
1215
|
* @public
|
|
555
1216
|
*/
|
|
556
|
-
Name?: string;
|
|
1217
|
+
Name?: string | undefined;
|
|
557
1218
|
/**
|
|
558
|
-
* <p>Version information associated with a build or script. Version strings
|
|
1219
|
+
* <p>Version information that is associated with a build or script. Version strings do not need to be unique.</p>
|
|
559
1220
|
* @public
|
|
560
1221
|
*/
|
|
561
|
-
Version?: string;
|
|
1222
|
+
Version?: string | undefined;
|
|
562
1223
|
}
|
|
563
1224
|
/**
|
|
564
1225
|
* @public
|
|
@@ -568,7 +1229,191 @@ export interface UpdateBuildOutput {
|
|
|
568
1229
|
* <p>The updated build resource.</p>
|
|
569
1230
|
* @public
|
|
570
1231
|
*/
|
|
571
|
-
Build?: Build;
|
|
1232
|
+
Build?: Build | undefined;
|
|
1233
|
+
}
|
|
1234
|
+
/**
|
|
1235
|
+
* @public
|
|
1236
|
+
*/
|
|
1237
|
+
export interface UpdateContainerFleetInput {
|
|
1238
|
+
/**
|
|
1239
|
+
* <p>A unique identifier for the container fleet to update. You can use either the fleet ID
|
|
1240
|
+
* or ARN value.</p>
|
|
1241
|
+
* @public
|
|
1242
|
+
*/
|
|
1243
|
+
FleetId: string | undefined;
|
|
1244
|
+
/**
|
|
1245
|
+
* <p>The name or ARN value of a new game server container group definition to deploy on the
|
|
1246
|
+
* fleet. If you're updating the fleet to a specific version of a container group
|
|
1247
|
+
* definition, use the ARN value and include the version number. If you're updating the
|
|
1248
|
+
* fleet to the latest version of a container group definition, you can use the name value.
|
|
1249
|
+
* You can't remove a fleet's game server container group definition, you can only update
|
|
1250
|
+
* or replace it with another definition.</p>
|
|
1251
|
+
* <p>Update a container group definition by calling <a>UpdateContainerGroupDefinition</a>. This operation creates a <a>ContainerGroupDefinition</a> resource with an incremented version. </p>
|
|
1252
|
+
* @public
|
|
1253
|
+
*/
|
|
1254
|
+
GameServerContainerGroupDefinitionName?: string | undefined;
|
|
1255
|
+
/**
|
|
1256
|
+
* <p>The name or ARN value of a new per-instance container group definition to deploy on
|
|
1257
|
+
* the fleet. If you're updating the fleet to a specific version of a container group
|
|
1258
|
+
* definition, use the ARN value and include the version number. If you're updating the
|
|
1259
|
+
* fleet to the latest version of a container group definition, you can use the name
|
|
1260
|
+
* value.</p>
|
|
1261
|
+
* <p>Update a container group definition by calling <a>UpdateContainerGroupDefinition</a>. This operation creates a <a>ContainerGroupDefinition</a> resource with an incremented version. </p>
|
|
1262
|
+
* <p>To remove a fleet's per-instance container group definition, leave this parameter empty
|
|
1263
|
+
* and use the parameter <code>RemoveAttributes</code>.</p>
|
|
1264
|
+
* @public
|
|
1265
|
+
*/
|
|
1266
|
+
PerInstanceContainerGroupDefinitionName?: string | undefined;
|
|
1267
|
+
/**
|
|
1268
|
+
* <p>The number of times to replicate the game server container group on each fleet
|
|
1269
|
+
* instance. By default, Amazon GameLift calculates the maximum number of game server container
|
|
1270
|
+
* groups that can fit on each instance. You can remove this property value to use the
|
|
1271
|
+
* calculated value, or set it manually. If you set this number manually, Amazon GameLift uses your
|
|
1272
|
+
* value as long as it's less than the calculated maximum.</p>
|
|
1273
|
+
* @public
|
|
1274
|
+
*/
|
|
1275
|
+
GameServerContainerGroupsPerInstance?: number | undefined;
|
|
1276
|
+
/**
|
|
1277
|
+
* <p>A revised set of port numbers to open on each fleet instance. By default, Amazon GameLift
|
|
1278
|
+
* calculates an optimal port range based on your fleet configuration. If you previously
|
|
1279
|
+
* set this parameter manually, you can't reset this to use the calculated settings.</p>
|
|
1280
|
+
* @public
|
|
1281
|
+
*/
|
|
1282
|
+
InstanceConnectionPortRange?: ConnectionPortRange | undefined;
|
|
1283
|
+
/**
|
|
1284
|
+
* <p>A set of ports to add to the container fleet's inbound permissions.</p>
|
|
1285
|
+
* @public
|
|
1286
|
+
*/
|
|
1287
|
+
InstanceInboundPermissionAuthorizations?: IpPermission[] | undefined;
|
|
1288
|
+
/**
|
|
1289
|
+
* <p>A set of ports to remove from the container fleet's inbound permissions.</p>
|
|
1290
|
+
* @public
|
|
1291
|
+
*/
|
|
1292
|
+
InstanceInboundPermissionRevocations?: IpPermission[] | undefined;
|
|
1293
|
+
/**
|
|
1294
|
+
* <p>Instructions for how to deploy updates to a container fleet, if the fleet update
|
|
1295
|
+
* initiates a deployment. The deployment configuration lets you determine how to replace
|
|
1296
|
+
* fleet instances and what actions to take if the deployment fails.</p>
|
|
1297
|
+
* @public
|
|
1298
|
+
*/
|
|
1299
|
+
DeploymentConfiguration?: DeploymentConfiguration | undefined;
|
|
1300
|
+
/**
|
|
1301
|
+
* <p>A meaningful description of the container fleet.</p>
|
|
1302
|
+
* @public
|
|
1303
|
+
*/
|
|
1304
|
+
Description?: string | undefined;
|
|
1305
|
+
/**
|
|
1306
|
+
* <p>The name of an Amazon Web Services CloudWatch metric group to add this fleet to. </p>
|
|
1307
|
+
* @public
|
|
1308
|
+
*/
|
|
1309
|
+
MetricGroups?: string[] | undefined;
|
|
1310
|
+
/**
|
|
1311
|
+
* <p>The game session protection policy to apply to all new game sessions that are started
|
|
1312
|
+
* in this fleet. Game sessions that already exist are not affected. </p>
|
|
1313
|
+
* @public
|
|
1314
|
+
*/
|
|
1315
|
+
NewGameSessionProtectionPolicy?: ProtectionPolicy | undefined;
|
|
1316
|
+
/**
|
|
1317
|
+
* <p>A policy that limits the number of game sessions that each individual player can create
|
|
1318
|
+
* on instances in this fleet. The limit applies for a specified span of time.</p>
|
|
1319
|
+
* @public
|
|
1320
|
+
*/
|
|
1321
|
+
GameSessionCreationLimitPolicy?: GameSessionCreationLimitPolicy | undefined;
|
|
1322
|
+
/**
|
|
1323
|
+
* <p>The method for collecting container logs for the fleet. </p>
|
|
1324
|
+
* @public
|
|
1325
|
+
*/
|
|
1326
|
+
LogConfiguration?: LogConfiguration | undefined;
|
|
1327
|
+
/**
|
|
1328
|
+
* <p>If set, this update removes a fleet's per-instance container group definition. You
|
|
1329
|
+
* can't remove a fleet's game server container group definition.</p>
|
|
1330
|
+
* @public
|
|
1331
|
+
*/
|
|
1332
|
+
RemoveAttributes?: ContainerFleetRemoveAttribute[] | undefined;
|
|
1333
|
+
}
|
|
1334
|
+
/**
|
|
1335
|
+
* @public
|
|
1336
|
+
*/
|
|
1337
|
+
export interface UpdateContainerFleetOutput {
|
|
1338
|
+
/**
|
|
1339
|
+
* <p>A collection of container fleet objects for all fleets that match the request
|
|
1340
|
+
* criteria.</p>
|
|
1341
|
+
* @public
|
|
1342
|
+
*/
|
|
1343
|
+
ContainerFleet?: ContainerFleet | undefined;
|
|
1344
|
+
}
|
|
1345
|
+
/**
|
|
1346
|
+
* @public
|
|
1347
|
+
*/
|
|
1348
|
+
export interface UpdateContainerGroupDefinitionInput {
|
|
1349
|
+
/**
|
|
1350
|
+
* <p>A descriptive identifier for the container group definition. The name value must be unique in an Amazon Web Services Region.</p>
|
|
1351
|
+
* @public
|
|
1352
|
+
*/
|
|
1353
|
+
Name: string | undefined;
|
|
1354
|
+
/**
|
|
1355
|
+
* <p>An updated definition for the game server container in this group. Define a game server
|
|
1356
|
+
* container only when the container group type is <code>GAME_SERVER</code>. You can pass in your
|
|
1357
|
+
* container definitions as a JSON file.</p>
|
|
1358
|
+
* @public
|
|
1359
|
+
*/
|
|
1360
|
+
GameServerContainerDefinition?: GameServerContainerDefinitionInput | undefined;
|
|
1361
|
+
/**
|
|
1362
|
+
* <p>One or more definitions for support containers in this group. You can define a support
|
|
1363
|
+
* container in any type of container group. You can pass in your container definitions as a JSON
|
|
1364
|
+
* file.</p>
|
|
1365
|
+
* @public
|
|
1366
|
+
*/
|
|
1367
|
+
SupportContainerDefinitions?: SupportContainerDefinitionInput[] | undefined;
|
|
1368
|
+
/**
|
|
1369
|
+
* <p>The maximum amount of memory (in MiB) to allocate to the container group. All containers in
|
|
1370
|
+
* the group share this memory. If you specify memory limits for an individual container, the
|
|
1371
|
+
* total value must be greater than any individual container's memory limit.</p>
|
|
1372
|
+
* @public
|
|
1373
|
+
*/
|
|
1374
|
+
TotalMemoryLimitMebibytes?: number | undefined;
|
|
1375
|
+
/**
|
|
1376
|
+
* <p>The maximum amount of vCPU units to allocate to the container group (1 vCPU is equal to 1024
|
|
1377
|
+
* CPU units). All containers in the group share this memory. If you specify vCPU limits for
|
|
1378
|
+
* individual containers, the total value must be equal to or greater than the sum of the CPU
|
|
1379
|
+
* limits for all containers in the group.</p>
|
|
1380
|
+
* @public
|
|
1381
|
+
*/
|
|
1382
|
+
TotalVcpuLimit?: number | undefined;
|
|
1383
|
+
/**
|
|
1384
|
+
* <p>A description for this update to the container group definition. </p>
|
|
1385
|
+
* @public
|
|
1386
|
+
*/
|
|
1387
|
+
VersionDescription?: string | undefined;
|
|
1388
|
+
/**
|
|
1389
|
+
* <p>The container group definition version to update. The new version starts with values from
|
|
1390
|
+
* the source version, and then updates values included in this request. </p>
|
|
1391
|
+
* @public
|
|
1392
|
+
*/
|
|
1393
|
+
SourceVersionNumber?: number | undefined;
|
|
1394
|
+
/**
|
|
1395
|
+
* <p>The platform that all containers in the group use. Containers in a group must run on the
|
|
1396
|
+
* same operating system.</p>
|
|
1397
|
+
* <note>
|
|
1398
|
+
* <p>Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the <a href="https://aws.amazon.com/amazon-linux-2/faqs/">Amazon Linux 2 FAQs</a>. For game
|
|
1399
|
+
* servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x, first update the game
|
|
1400
|
+
* server build to server SDK 5.x, and then deploy to AL2023 instances. See <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html"> Migrate to
|
|
1401
|
+
* Amazon GameLift server SDK version 5.</a>
|
|
1402
|
+
* </p>
|
|
1403
|
+
* </note>
|
|
1404
|
+
* @public
|
|
1405
|
+
*/
|
|
1406
|
+
OperatingSystem?: ContainerOperatingSystem | undefined;
|
|
1407
|
+
}
|
|
1408
|
+
/**
|
|
1409
|
+
* @public
|
|
1410
|
+
*/
|
|
1411
|
+
export interface UpdateContainerGroupDefinitionOutput {
|
|
1412
|
+
/**
|
|
1413
|
+
* <p>The properties of the updated container group definition version.</p>
|
|
1414
|
+
* @public
|
|
1415
|
+
*/
|
|
1416
|
+
ContainerGroupDefinition?: ContainerGroupDefinition | undefined;
|
|
572
1417
|
}
|
|
573
1418
|
/**
|
|
574
1419
|
* @public
|
|
@@ -584,16 +1429,16 @@ export interface UpdateFleetAttributesInput {
|
|
|
584
1429
|
* <p>A descriptive label that is associated with a fleet. Fleet names do not need to be unique.</p>
|
|
585
1430
|
* @public
|
|
586
1431
|
*/
|
|
587
|
-
Name?: string;
|
|
1432
|
+
Name?: string | undefined;
|
|
588
1433
|
/**
|
|
589
1434
|
* <p>A human-readable description of a fleet.</p>
|
|
590
1435
|
* @public
|
|
591
1436
|
*/
|
|
592
|
-
Description?: string;
|
|
1437
|
+
Description?: string | undefined;
|
|
593
1438
|
/**
|
|
594
1439
|
* <p>The game session protection policy to apply to all new game sessions created in this
|
|
595
1440
|
* 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
|
|
1441
|
+
* individual game sessions using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html">UpdateGameSession</a>.</p>
|
|
597
1442
|
* <ul>
|
|
598
1443
|
* <li>
|
|
599
1444
|
* <p>
|
|
@@ -609,13 +1454,13 @@ export interface UpdateFleetAttributesInput {
|
|
|
609
1454
|
* </ul>
|
|
610
1455
|
* @public
|
|
611
1456
|
*/
|
|
612
|
-
NewGameSessionProtectionPolicy?: ProtectionPolicy;
|
|
1457
|
+
NewGameSessionProtectionPolicy?: ProtectionPolicy | undefined;
|
|
613
1458
|
/**
|
|
614
1459
|
* <p>Policy settings that limit the number of game sessions an individual player can create
|
|
615
1460
|
* over a span of time. </p>
|
|
616
1461
|
* @public
|
|
617
1462
|
*/
|
|
618
|
-
ResourceCreationLimitPolicy?: ResourceCreationLimitPolicy;
|
|
1463
|
+
ResourceCreationLimitPolicy?: ResourceCreationLimitPolicy | undefined;
|
|
619
1464
|
/**
|
|
620
1465
|
* <p>The name of a metric group to add this fleet to. Use a metric group in Amazon
|
|
621
1466
|
* CloudWatch to aggregate the metrics from multiple fleets. Provide an existing metric
|
|
@@ -623,12 +1468,12 @@ export interface UpdateFleetAttributesInput {
|
|
|
623
1468
|
* one metric group at a time.</p>
|
|
624
1469
|
* @public
|
|
625
1470
|
*/
|
|
626
|
-
MetricGroups?: string[];
|
|
1471
|
+
MetricGroups?: string[] | undefined;
|
|
627
1472
|
/**
|
|
628
1473
|
* <p>Amazon GameLift Anywhere configuration options.</p>
|
|
629
1474
|
* @public
|
|
630
1475
|
*/
|
|
631
|
-
AnywhereConfiguration?: AnywhereConfiguration;
|
|
1476
|
+
AnywhereConfiguration?: AnywhereConfiguration | undefined;
|
|
632
1477
|
}
|
|
633
1478
|
/**
|
|
634
1479
|
* @public
|
|
@@ -638,12 +1483,12 @@ export interface UpdateFleetAttributesOutput {
|
|
|
638
1483
|
* <p>A unique identifier for the fleet that was updated.</p>
|
|
639
1484
|
* @public
|
|
640
1485
|
*/
|
|
641
|
-
FleetId?: string;
|
|
1486
|
+
FleetId?: string | undefined;
|
|
642
1487
|
/**
|
|
643
1488
|
* <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
1489
|
* @public
|
|
645
1490
|
*/
|
|
646
|
-
FleetArn?: string;
|
|
1491
|
+
FleetArn?: string | undefined;
|
|
647
1492
|
}
|
|
648
1493
|
/**
|
|
649
1494
|
* @public
|
|
@@ -662,25 +1507,25 @@ export interface UpdateFleetCapacityInput {
|
|
|
662
1507
|
* settings.</p>
|
|
663
1508
|
* @public
|
|
664
1509
|
*/
|
|
665
|
-
DesiredInstances?: number;
|
|
1510
|
+
DesiredInstances?: number | undefined;
|
|
666
1511
|
/**
|
|
667
1512
|
* <p>The minimum number of instances that are allowed in the specified fleet location. If
|
|
668
1513
|
* this parameter is not set, the default is 0.</p>
|
|
669
1514
|
* @public
|
|
670
1515
|
*/
|
|
671
|
-
MinSize?: number;
|
|
1516
|
+
MinSize?: number | undefined;
|
|
672
1517
|
/**
|
|
673
1518
|
* <p>The maximum number of instances that are allowed in the specified fleet location. If
|
|
674
1519
|
* this parameter is not set, the default is 1.</p>
|
|
675
1520
|
* @public
|
|
676
1521
|
*/
|
|
677
|
-
MaxSize?: number;
|
|
1522
|
+
MaxSize?: number | undefined;
|
|
678
1523
|
/**
|
|
679
1524
|
* <p>The name of a remote location to update fleet capacity settings for, in the form of an
|
|
680
1525
|
* Amazon Web Services Region code such as <code>us-west-2</code>.</p>
|
|
681
1526
|
* @public
|
|
682
1527
|
*/
|
|
683
|
-
Location?: string;
|
|
1528
|
+
Location?: string | undefined;
|
|
684
1529
|
}
|
|
685
1530
|
/**
|
|
686
1531
|
* @public
|
|
@@ -690,18 +1535,18 @@ export interface UpdateFleetCapacityOutput {
|
|
|
690
1535
|
* <p>A unique identifier for the fleet that was updated.</p>
|
|
691
1536
|
* @public
|
|
692
1537
|
*/
|
|
693
|
-
FleetId?: string;
|
|
1538
|
+
FleetId?: string | undefined;
|
|
694
1539
|
/**
|
|
695
1540
|
* <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>
|
|
696
1541
|
* @public
|
|
697
1542
|
*/
|
|
698
|
-
FleetArn?: string;
|
|
1543
|
+
FleetArn?: string | undefined;
|
|
699
1544
|
/**
|
|
700
1545
|
* <p>The remote location being updated, expressed as an Amazon Web Services Region code, such as
|
|
701
|
-
*
|
|
1546
|
+
* <code>us-west-2</code>.</p>
|
|
702
1547
|
* @public
|
|
703
1548
|
*/
|
|
704
|
-
Location?: string;
|
|
1549
|
+
Location?: string | undefined;
|
|
705
1550
|
}
|
|
706
1551
|
/**
|
|
707
1552
|
* @public
|
|
@@ -717,12 +1562,12 @@ export interface UpdateFleetPortSettingsInput {
|
|
|
717
1562
|
* <p>A collection of port settings to be added to the fleet resource.</p>
|
|
718
1563
|
* @public
|
|
719
1564
|
*/
|
|
720
|
-
InboundPermissionAuthorizations?: IpPermission[];
|
|
1565
|
+
InboundPermissionAuthorizations?: IpPermission[] | undefined;
|
|
721
1566
|
/**
|
|
722
1567
|
* <p>A collection of port settings to be removed from the fleet resource.</p>
|
|
723
1568
|
* @public
|
|
724
1569
|
*/
|
|
725
|
-
InboundPermissionRevocations?: IpPermission[];
|
|
1570
|
+
InboundPermissionRevocations?: IpPermission[] | undefined;
|
|
726
1571
|
}
|
|
727
1572
|
/**
|
|
728
1573
|
* @public
|
|
@@ -732,12 +1577,12 @@ export interface UpdateFleetPortSettingsOutput {
|
|
|
732
1577
|
* <p>A unique identifier for the fleet that was updated.</p>
|
|
733
1578
|
* @public
|
|
734
1579
|
*/
|
|
735
|
-
FleetId?: string;
|
|
1580
|
+
FleetId?: string | undefined;
|
|
736
1581
|
/**
|
|
737
1582
|
* <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>
|
|
738
1583
|
* @public
|
|
739
1584
|
*/
|
|
740
|
-
FleetArn?: string;
|
|
1585
|
+
FleetArn?: string | undefined;
|
|
741
1586
|
}
|
|
742
1587
|
/**
|
|
743
1588
|
* @public
|
|
@@ -769,7 +1614,7 @@ export interface UpdateGameServerInput {
|
|
|
769
1614
|
* is passed to a game client or service when it requests information on game servers. </p>
|
|
770
1615
|
* @public
|
|
771
1616
|
*/
|
|
772
|
-
GameServerData?: string;
|
|
1617
|
+
GameServerData?: string | undefined;
|
|
773
1618
|
/**
|
|
774
1619
|
* <p>Indicates if the game server is available or is currently hosting gameplay. You can
|
|
775
1620
|
* update a game server status from <code>AVAILABLE</code> to <code>UTILIZED</code>, but
|
|
@@ -777,13 +1622,13 @@ export interface UpdateGameServerInput {
|
|
|
777
1622
|
* <code>AVAILABLE</code>.</p>
|
|
778
1623
|
* @public
|
|
779
1624
|
*/
|
|
780
|
-
UtilizationStatus?: GameServerUtilizationStatus;
|
|
1625
|
+
UtilizationStatus?: GameServerUtilizationStatus | undefined;
|
|
781
1626
|
/**
|
|
782
1627
|
* <p>Indicates health status of the game server. A request that includes this parameter
|
|
783
1628
|
* updates the game server's <i>LastHealthCheckTime</i> timestamp. </p>
|
|
784
1629
|
* @public
|
|
785
1630
|
*/
|
|
786
|
-
HealthCheck?: GameServerHealthCheck;
|
|
1631
|
+
HealthCheck?: GameServerHealthCheck | undefined;
|
|
787
1632
|
}
|
|
788
1633
|
/**
|
|
789
1634
|
* @public
|
|
@@ -793,7 +1638,7 @@ export interface UpdateGameServerOutput {
|
|
|
793
1638
|
* <p>Object that describes the newly updated game server.</p>
|
|
794
1639
|
* @public
|
|
795
1640
|
*/
|
|
796
|
-
GameServer?: GameServer;
|
|
1641
|
+
GameServer?: GameServer | undefined;
|
|
797
1642
|
}
|
|
798
1643
|
/**
|
|
799
1644
|
* @public
|
|
@@ -809,7 +1654,7 @@ export interface UpdateGameServerGroupInput {
|
|
|
809
1654
|
* allows Amazon GameLift to access your Amazon EC2 Auto Scaling groups.</p>
|
|
810
1655
|
* @public
|
|
811
1656
|
*/
|
|
812
|
-
RoleArn?: string;
|
|
1657
|
+
RoleArn?: string | undefined;
|
|
813
1658
|
/**
|
|
814
1659
|
* <p>An updated list of Amazon EC2 instance types to use in the Auto Scaling group. The instance
|
|
815
1660
|
* definitions must specify at least two different instance types that are supported by
|
|
@@ -822,7 +1667,7 @@ export interface UpdateGameServerGroupInput {
|
|
|
822
1667
|
* Amazon EC2 Auto Scaling</a> in the Amazon EC2 Auto Scaling User Guide.</p>
|
|
823
1668
|
* @public
|
|
824
1669
|
*/
|
|
825
|
-
InstanceDefinitions?: InstanceDefinition[];
|
|
1670
|
+
InstanceDefinitions?: InstanceDefinition[] | undefined;
|
|
826
1671
|
/**
|
|
827
1672
|
* <p>A flag that indicates whether instances in the game server group are protected
|
|
828
1673
|
* from early termination. Unprotected instances that have active game servers running might
|
|
@@ -832,7 +1677,7 @@ export interface UpdateGameServerGroupInput {
|
|
|
832
1677
|
* Instances, which can be terminated by Amazon Web Services regardless of protection status. This property is set to <code>NO_PROTECTION</code> by default.</p>
|
|
833
1678
|
* @public
|
|
834
1679
|
*/
|
|
835
|
-
GameServerProtectionPolicy?: GameServerProtectionPolicy;
|
|
1680
|
+
GameServerProtectionPolicy?: GameServerProtectionPolicy | undefined;
|
|
836
1681
|
/**
|
|
837
1682
|
* <p>Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the
|
|
838
1683
|
* game server group. Method options include the following:</p>
|
|
@@ -862,7 +1707,7 @@ export interface UpdateGameServerGroupInput {
|
|
|
862
1707
|
* </ul>
|
|
863
1708
|
* @public
|
|
864
1709
|
*/
|
|
865
|
-
BalancingStrategy?: BalancingStrategy;
|
|
1710
|
+
BalancingStrategy?: BalancingStrategy | undefined;
|
|
866
1711
|
}
|
|
867
1712
|
/**
|
|
868
1713
|
* @public
|
|
@@ -873,7 +1718,7 @@ export interface UpdateGameServerGroupOutput {
|
|
|
873
1718
|
* </p>
|
|
874
1719
|
* @public
|
|
875
1720
|
*/
|
|
876
|
-
GameServerGroup?: GameServerGroup;
|
|
1721
|
+
GameServerGroup?: GameServerGroup | undefined;
|
|
877
1722
|
}
|
|
878
1723
|
/**
|
|
879
1724
|
* @public
|
|
@@ -888,17 +1733,17 @@ export interface UpdateGameSessionInput {
|
|
|
888
1733
|
* <p>The maximum number of players that can be connected simultaneously to the game session.</p>
|
|
889
1734
|
* @public
|
|
890
1735
|
*/
|
|
891
|
-
MaximumPlayerSessionCount?: number;
|
|
1736
|
+
MaximumPlayerSessionCount?: number | undefined;
|
|
892
1737
|
/**
|
|
893
1738
|
* <p>A descriptive label that is associated with a game session. Session names do not need to be unique.</p>
|
|
894
1739
|
* @public
|
|
895
1740
|
*/
|
|
896
|
-
Name?: string;
|
|
1741
|
+
Name?: string | undefined;
|
|
897
1742
|
/**
|
|
898
1743
|
* <p>A policy that determines whether the game session is accepting new players.</p>
|
|
899
1744
|
* @public
|
|
900
1745
|
*/
|
|
901
|
-
PlayerSessionCreationPolicy?: PlayerSessionCreationPolicy;
|
|
1746
|
+
PlayerSessionCreationPolicy?: PlayerSessionCreationPolicy | undefined;
|
|
902
1747
|
/**
|
|
903
1748
|
* <p>Game session protection policy to apply to this game session only.</p>
|
|
904
1749
|
* <ul>
|
|
@@ -916,7 +1761,7 @@ export interface UpdateGameSessionInput {
|
|
|
916
1761
|
* </ul>
|
|
917
1762
|
* @public
|
|
918
1763
|
*/
|
|
919
|
-
ProtectionPolicy?: ProtectionPolicy;
|
|
1764
|
+
ProtectionPolicy?: ProtectionPolicy | undefined;
|
|
920
1765
|
/**
|
|
921
1766
|
* <p>A set of key-value pairs that can store custom data in a game session.
|
|
922
1767
|
* For example: <code>\{"Key": "difficulty", "Value": "novice"\}</code>.
|
|
@@ -927,7 +1772,7 @@ export interface UpdateGameSessionInput {
|
|
|
927
1772
|
* </p>
|
|
928
1773
|
* @public
|
|
929
1774
|
*/
|
|
930
|
-
GameProperties?: GameProperty[];
|
|
1775
|
+
GameProperties?: GameProperty[] | undefined;
|
|
931
1776
|
}
|
|
932
1777
|
/**
|
|
933
1778
|
* @public
|
|
@@ -937,7 +1782,7 @@ export interface UpdateGameSessionOutput {
|
|
|
937
1782
|
* <p>The updated game session properties.</p>
|
|
938
1783
|
* @public
|
|
939
1784
|
*/
|
|
940
|
-
GameSession?: GameSession;
|
|
1785
|
+
GameSession?: GameSession | undefined;
|
|
941
1786
|
}
|
|
942
1787
|
/**
|
|
943
1788
|
* @public
|
|
@@ -949,52 +1794,50 @@ export interface UpdateGameSessionQueueInput {
|
|
|
949
1794
|
*/
|
|
950
1795
|
Name: string | undefined;
|
|
951
1796
|
/**
|
|
952
|
-
* <p>The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a <code>TIMED_OUT</code> status
|
|
1797
|
+
* <p>The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a <code>TIMED_OUT</code> status.</p>
|
|
953
1798
|
* @public
|
|
954
1799
|
*/
|
|
955
|
-
TimeoutInSeconds?: number;
|
|
1800
|
+
TimeoutInSeconds?: number | undefined;
|
|
956
1801
|
/**
|
|
957
|
-
* <p>A set of policies that
|
|
958
|
-
*
|
|
959
|
-
*
|
|
960
|
-
* policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their
|
|
961
|
-
* maximum allowed latency, starting with the lowest value. When updating policies, provide a complete collection of policies.</p>
|
|
1802
|
+
* <p>A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests.
|
|
1803
|
+
* Use multiple policies to gradually relax the cap over time if Amazon GameLift can't make a placement.
|
|
1804
|
+
* Policies are evaluated in order starting with the lowest maximum latency value. When updating policies, provide a complete collection of policies.</p>
|
|
962
1805
|
* @public
|
|
963
1806
|
*/
|
|
964
|
-
PlayerLatencyPolicies?: PlayerLatencyPolicy[];
|
|
1807
|
+
PlayerLatencyPolicies?: PlayerLatencyPolicy[] | undefined;
|
|
965
1808
|
/**
|
|
966
1809
|
* <p>A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue.
|
|
967
1810
|
* Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference. When updating this list, provide a complete list of destinations.</p>
|
|
968
1811
|
* @public
|
|
969
1812
|
*/
|
|
970
|
-
Destinations?: GameSessionQueueDestination[];
|
|
1813
|
+
Destinations?: GameSessionQueueDestination[] | undefined;
|
|
971
1814
|
/**
|
|
972
1815
|
* <p>A list of locations where a queue is allowed to place new game sessions. Locations
|
|
973
1816
|
* are specified in the form of Amazon Web Services Region codes, such as <code>us-west-2</code>. If this parameter is
|
|
974
1817
|
* not set, game sessions can be placed in any queue location. To remove an existing filter configuration, pass in an empty set.</p>
|
|
975
1818
|
* @public
|
|
976
1819
|
*/
|
|
977
|
-
FilterConfiguration?: FilterConfiguration;
|
|
1820
|
+
FilterConfiguration?: FilterConfiguration | undefined;
|
|
978
1821
|
/**
|
|
979
1822
|
* <p>Custom settings to use when prioritizing destinations and locations for game session placements. This
|
|
980
1823
|
* configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly
|
|
981
1824
|
* named will be automatically applied at the end of the prioritization process. To remove an existing priority configuration, pass in an empty set.</p>
|
|
982
1825
|
* @public
|
|
983
1826
|
*/
|
|
984
|
-
PriorityConfiguration?: PriorityConfiguration;
|
|
1827
|
+
PriorityConfiguration?: PriorityConfiguration | undefined;
|
|
985
1828
|
/**
|
|
986
1829
|
* <p>Information to be added to all events that are related to this game session
|
|
987
1830
|
* queue.</p>
|
|
988
1831
|
* @public
|
|
989
1832
|
*/
|
|
990
|
-
CustomEventData?: string;
|
|
1833
|
+
CustomEventData?: string | undefined;
|
|
991
1834
|
/**
|
|
992
1835
|
* <p>An SNS topic ARN that is set up to receive game session placement notifications. See
|
|
993
1836
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html"> Setting up
|
|
994
1837
|
* notifications for game session placement</a>.</p>
|
|
995
1838
|
* @public
|
|
996
1839
|
*/
|
|
997
|
-
NotificationTarget?: string;
|
|
1840
|
+
NotificationTarget?: string | undefined;
|
|
998
1841
|
}
|
|
999
1842
|
/**
|
|
1000
1843
|
* @public
|
|
@@ -1004,7 +1847,7 @@ export interface UpdateGameSessionQueueOutput {
|
|
|
1004
1847
|
* <p>An object that describes the newly updated game session queue.</p>
|
|
1005
1848
|
* @public
|
|
1006
1849
|
*/
|
|
1007
|
-
GameSessionQueue?: GameSessionQueue;
|
|
1850
|
+
GameSessionQueue?: GameSessionQueue | undefined;
|
|
1008
1851
|
}
|
|
1009
1852
|
/**
|
|
1010
1853
|
* @public
|
|
@@ -1019,7 +1862,7 @@ export interface UpdateMatchmakingConfigurationInput {
|
|
|
1019
1862
|
* <p>A description for the matchmaking configuration.</p>
|
|
1020
1863
|
* @public
|
|
1021
1864
|
*/
|
|
1022
|
-
Description?: string;
|
|
1865
|
+
Description?: string | undefined;
|
|
1023
1866
|
/**
|
|
1024
1867
|
* <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 game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::gamesessionqueue/<queue name></code>. Queues can be located in any Region. Queues are used to start new
|
|
1025
1868
|
* Amazon GameLift-hosted game sessions for matches that are created with this matchmaking
|
|
@@ -1027,20 +1870,20 @@ export interface UpdateMatchmakingConfigurationInput {
|
|
|
1027
1870
|
* set this parameter.</p>
|
|
1028
1871
|
* @public
|
|
1029
1872
|
*/
|
|
1030
|
-
GameSessionQueueArns?: string[];
|
|
1873
|
+
GameSessionQueueArns?: string[] | undefined;
|
|
1031
1874
|
/**
|
|
1032
1875
|
* <p>The maximum duration, in seconds, that a matchmaking ticket can remain in process
|
|
1033
1876
|
* before timing out. Requests that fail due to timing out can be resubmitted as
|
|
1034
1877
|
* needed.</p>
|
|
1035
1878
|
* @public
|
|
1036
1879
|
*/
|
|
1037
|
-
RequestTimeoutSeconds?: number;
|
|
1880
|
+
RequestTimeoutSeconds?: number | undefined;
|
|
1038
1881
|
/**
|
|
1039
1882
|
* <p>The length of time (in seconds) to wait for players to accept a proposed match, if
|
|
1040
1883
|
* acceptance is required.</p>
|
|
1041
1884
|
* @public
|
|
1042
1885
|
*/
|
|
1043
|
-
AcceptanceTimeoutSeconds?: number;
|
|
1886
|
+
AcceptanceTimeoutSeconds?: number | undefined;
|
|
1044
1887
|
/**
|
|
1045
1888
|
* <p>A flag that indicates whether a match that was created with this configuration must be
|
|
1046
1889
|
* accepted by the matched players. To require acceptance, set to TRUE. With this option
|
|
@@ -1048,32 +1891,32 @@ export interface UpdateMatchmakingConfigurationInput {
|
|
|
1048
1891
|
* when a completed potential match is waiting for player acceptance. </p>
|
|
1049
1892
|
* @public
|
|
1050
1893
|
*/
|
|
1051
|
-
AcceptanceRequired?: boolean;
|
|
1894
|
+
AcceptanceRequired?: boolean | undefined;
|
|
1052
1895
|
/**
|
|
1053
1896
|
* <p>A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN
|
|
1054
1897
|
* value. A matchmaking configuration can only use rule sets that are defined in the same
|
|
1055
1898
|
* Region.</p>
|
|
1056
1899
|
* @public
|
|
1057
1900
|
*/
|
|
1058
|
-
RuleSetName?: string;
|
|
1901
|
+
RuleSetName?: string | undefined;
|
|
1059
1902
|
/**
|
|
1060
1903
|
* <p>An SNS topic ARN that is set up to receive matchmaking notifications. See <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html">
|
|
1061
1904
|
* Setting up notifications for matchmaking</a> for more information.</p>
|
|
1062
1905
|
* @public
|
|
1063
1906
|
*/
|
|
1064
|
-
NotificationTarget?: string;
|
|
1907
|
+
NotificationTarget?: string | undefined;
|
|
1065
1908
|
/**
|
|
1066
1909
|
* <p>The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies
|
|
1067
|
-
* a match for a single
|
|
1910
|
+
* a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used if <code>FlexMatchMode</code> is set to
|
|
1068
1911
|
* <code>STANDALONE</code>.</p>
|
|
1069
1912
|
* @public
|
|
1070
1913
|
*/
|
|
1071
|
-
AdditionalPlayerCount?: number;
|
|
1914
|
+
AdditionalPlayerCount?: number | undefined;
|
|
1072
1915
|
/**
|
|
1073
1916
|
* <p>Information to add to all events related to the matchmaking configuration. </p>
|
|
1074
1917
|
* @public
|
|
1075
1918
|
*/
|
|
1076
|
-
CustomEventData?: string;
|
|
1919
|
+
CustomEventData?: string | undefined;
|
|
1077
1920
|
/**
|
|
1078
1921
|
* <p>A set of key-value pairs that can store custom data in a game session.
|
|
1079
1922
|
* For example: <code>\{"Key": "difficulty", "Value": "novice"\}</code>. This information is added to the new <code>GameSession</code> object that is
|
|
@@ -1081,14 +1924,14 @@ export interface UpdateMatchmakingConfigurationInput {
|
|
|
1081
1924
|
* is set to <code>STANDALONE</code>.</p>
|
|
1082
1925
|
* @public
|
|
1083
1926
|
*/
|
|
1084
|
-
GameProperties?: GameProperty[];
|
|
1927
|
+
GameProperties?: GameProperty[] | undefined;
|
|
1085
1928
|
/**
|
|
1086
|
-
* <p>A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session
|
|
1929
|
+
* <p>A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session. For more information, 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>. This information is added to the game session
|
|
1087
1930
|
* that is created for a successful match. This parameter is not used if
|
|
1088
1931
|
* <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
|
|
1089
1932
|
* @public
|
|
1090
1933
|
*/
|
|
1091
|
-
GameSessionData?: string;
|
|
1934
|
+
GameSessionData?: string | undefined;
|
|
1092
1935
|
/**
|
|
1093
1936
|
* <p>The method that is used to backfill game sessions created with this matchmaking
|
|
1094
1937
|
* configuration. Specify MANUAL when your game manages backfill requests manually or does
|
|
@@ -1099,7 +1942,7 @@ export interface UpdateMatchmakingConfigurationInput {
|
|
|
1099
1942
|
* <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
|
|
1100
1943
|
* @public
|
|
1101
1944
|
*/
|
|
1102
|
-
BackfillMode?: BackfillMode;
|
|
1945
|
+
BackfillMode?: BackfillMode | undefined;
|
|
1103
1946
|
/**
|
|
1104
1947
|
* <p>Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or
|
|
1105
1948
|
* as a standalone matchmaking solution. </p>
|
|
@@ -1117,7 +1960,7 @@ export interface UpdateMatchmakingConfigurationInput {
|
|
|
1117
1960
|
* </ul>
|
|
1118
1961
|
* @public
|
|
1119
1962
|
*/
|
|
1120
|
-
FlexMatchMode?: FlexMatchMode;
|
|
1963
|
+
FlexMatchMode?: FlexMatchMode | undefined;
|
|
1121
1964
|
}
|
|
1122
1965
|
/**
|
|
1123
1966
|
* @public
|
|
@@ -1127,7 +1970,7 @@ export interface UpdateMatchmakingConfigurationOutput {
|
|
|
1127
1970
|
* <p>The updated matchmaking configuration.</p>
|
|
1128
1971
|
* @public
|
|
1129
1972
|
*/
|
|
1130
|
-
Configuration?: MatchmakingConfiguration;
|
|
1973
|
+
Configuration?: MatchmakingConfiguration | undefined;
|
|
1131
1974
|
}
|
|
1132
1975
|
/**
|
|
1133
1976
|
* @public
|
|
@@ -1157,7 +2000,7 @@ export interface UpdateRuntimeConfigurationOutput {
|
|
|
1157
2000
|
* successful, all property changes are shown. </p>
|
|
1158
2001
|
* @public
|
|
1159
2002
|
*/
|
|
1160
|
-
RuntimeConfiguration?: RuntimeConfiguration;
|
|
2003
|
+
RuntimeConfiguration?: RuntimeConfiguration | undefined;
|
|
1161
2004
|
}
|
|
1162
2005
|
/**
|
|
1163
2006
|
* @public
|
|
@@ -1169,15 +2012,15 @@ export interface UpdateScriptInput {
|
|
|
1169
2012
|
*/
|
|
1170
2013
|
ScriptId: string | undefined;
|
|
1171
2014
|
/**
|
|
1172
|
-
* <p>A descriptive label that is associated with a script. Script names
|
|
2015
|
+
* <p>A descriptive label that is associated with a script. Script names do not need to be unique.</p>
|
|
1173
2016
|
* @public
|
|
1174
2017
|
*/
|
|
1175
|
-
Name?: string;
|
|
2018
|
+
Name?: string | undefined;
|
|
1176
2019
|
/**
|
|
1177
|
-
* <p>Version information associated with a build or script. Version strings
|
|
2020
|
+
* <p>Version information that is associated with a build or script. Version strings do not need to be unique.</p>
|
|
1178
2021
|
* @public
|
|
1179
2022
|
*/
|
|
1180
|
-
Version?: string;
|
|
2023
|
+
Version?: string | undefined;
|
|
1181
2024
|
/**
|
|
1182
2025
|
* <p>The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is
|
|
1183
2026
|
* stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the
|
|
@@ -1188,7 +2031,7 @@ export interface UpdateScriptInput {
|
|
|
1188
2031
|
* version. </p>
|
|
1189
2032
|
* @public
|
|
1190
2033
|
*/
|
|
1191
|
-
StorageLocation?: S3Location;
|
|
2034
|
+
StorageLocation?: S3Location | undefined;
|
|
1192
2035
|
/**
|
|
1193
2036
|
* <p>A data object containing your Realtime scripts and dependencies as a zip file. The zip
|
|
1194
2037
|
* file can have one or multiple files. Maximum size of a zip file is 5 MB.</p>
|
|
@@ -1198,7 +2041,7 @@ export interface UpdateScriptInput {
|
|
|
1198
2041
|
* fileb://myRealtimeScript.zip</code>.</p>
|
|
1199
2042
|
* @public
|
|
1200
2043
|
*/
|
|
1201
|
-
ZipFile?: Uint8Array;
|
|
2044
|
+
ZipFile?: Uint8Array | undefined;
|
|
1202
2045
|
}
|
|
1203
2046
|
/**
|
|
1204
2047
|
* @public
|
|
@@ -1213,7 +2056,7 @@ export interface UpdateScriptOutput {
|
|
|
1213
2056
|
* service.</p>
|
|
1214
2057
|
* @public
|
|
1215
2058
|
*/
|
|
1216
|
-
Script?: Script;
|
|
2059
|
+
Script?: Script | undefined;
|
|
1217
2060
|
}
|
|
1218
2061
|
/**
|
|
1219
2062
|
* @public
|
|
@@ -1233,8 +2076,28 @@ export interface ValidateMatchmakingRuleSetOutput {
|
|
|
1233
2076
|
* <p>A response indicating whether the rule set is valid.</p>
|
|
1234
2077
|
* @public
|
|
1235
2078
|
*/
|
|
1236
|
-
Valid?: boolean;
|
|
2079
|
+
Valid?: boolean | undefined;
|
|
1237
2080
|
}
|
|
2081
|
+
/**
|
|
2082
|
+
* @internal
|
|
2083
|
+
*/
|
|
2084
|
+
export declare const ListContainerGroupDefinitionsOutputFilterSensitiveLog: (obj: ListContainerGroupDefinitionsOutput) => any;
|
|
2085
|
+
/**
|
|
2086
|
+
* @internal
|
|
2087
|
+
*/
|
|
2088
|
+
export declare const ListContainerGroupDefinitionVersionsOutputFilterSensitiveLog: (obj: ListContainerGroupDefinitionVersionsOutput) => any;
|
|
2089
|
+
/**
|
|
2090
|
+
* @internal
|
|
2091
|
+
*/
|
|
2092
|
+
export declare const RegisterComputeInputFilterSensitiveLog: (obj: RegisterComputeInput) => any;
|
|
2093
|
+
/**
|
|
2094
|
+
* @internal
|
|
2095
|
+
*/
|
|
2096
|
+
export declare const RegisterComputeOutputFilterSensitiveLog: (obj: RegisterComputeOutput) => any;
|
|
2097
|
+
/**
|
|
2098
|
+
* @internal
|
|
2099
|
+
*/
|
|
2100
|
+
export declare const RequestUploadCredentialsOutputFilterSensitiveLog: (obj: RequestUploadCredentialsOutput) => any;
|
|
1238
2101
|
/**
|
|
1239
2102
|
* @internal
|
|
1240
2103
|
*/
|
|
@@ -1267,6 +2130,22 @@ export declare const StartMatchmakingOutputFilterSensitiveLog: (obj: StartMatchm
|
|
|
1267
2130
|
* @internal
|
|
1268
2131
|
*/
|
|
1269
2132
|
export declare const StopGameSessionPlacementOutputFilterSensitiveLog: (obj: StopGameSessionPlacementOutput) => any;
|
|
2133
|
+
/**
|
|
2134
|
+
* @internal
|
|
2135
|
+
*/
|
|
2136
|
+
export declare const UpdateContainerFleetInputFilterSensitiveLog: (obj: UpdateContainerFleetInput) => any;
|
|
2137
|
+
/**
|
|
2138
|
+
* @internal
|
|
2139
|
+
*/
|
|
2140
|
+
export declare const UpdateContainerFleetOutputFilterSensitiveLog: (obj: UpdateContainerFleetOutput) => any;
|
|
2141
|
+
/**
|
|
2142
|
+
* @internal
|
|
2143
|
+
*/
|
|
2144
|
+
export declare const UpdateContainerGroupDefinitionInputFilterSensitiveLog: (obj: UpdateContainerGroupDefinitionInput) => any;
|
|
2145
|
+
/**
|
|
2146
|
+
* @internal
|
|
2147
|
+
*/
|
|
2148
|
+
export declare const UpdateContainerGroupDefinitionOutputFilterSensitiveLog: (obj: UpdateContainerGroupDefinitionOutput) => any;
|
|
1270
2149
|
/**
|
|
1271
2150
|
* @internal
|
|
1272
2151
|
*/
|