@aws-sdk/client-gamelift 3.686.0 → 3.690.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 +5518 -5258
- package/dist-types/models/models_1.d.ts +897 -18
- 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 +333 -261
- package/dist-types/ts3.4/models/models_1.d.ts +222 -0
- 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 +6 -6
|
@@ -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;
|
|
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;
|
|
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;
|
|
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[];
|
|
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;
|
|
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;
|
|
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;
|
|
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[];
|
|
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;
|
|
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;
|
|
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;
|
|
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;
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
export interface ListFleetDeploymentsOutput {
|
|
99
|
+
/**
|
|
100
|
+
* <p>The requested deployment information.</p>
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
FleetDeployments?: FleetDeployment[];
|
|
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;
|
|
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;
|
|
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;
|
|
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;
|
|
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;
|
|
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[];
|
|
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;
|
|
151
|
+
}
|
|
152
|
+
/**
|
|
153
|
+
* @public
|
|
154
|
+
*/
|
|
155
|
+
export interface ListGameServerGroupsInput {
|
|
156
|
+
/**
|
|
157
|
+
* <p>The game server groups' limit.</p>
|
|
158
|
+
* @public
|
|
159
|
+
*/
|
|
160
|
+
Limit?: number;
|
|
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;
|
|
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[];
|
|
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;
|
|
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;
|
|
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;
|
|
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;
|
|
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[];
|
|
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;
|
|
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[];
|
|
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;
|
|
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;
|
|
271
|
+
}
|
|
272
|
+
/**
|
|
273
|
+
* @public
|
|
274
|
+
*/
|
|
275
|
+
export interface ListLocationsOutput {
|
|
276
|
+
/**
|
|
277
|
+
* <p>A collection of locations.</p>
|
|
278
|
+
* @public
|
|
279
|
+
*/
|
|
280
|
+
Locations?: LocationModel[];
|
|
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;
|
|
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;
|
|
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;
|
|
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[];
|
|
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;
|
|
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[];
|
|
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;
|
|
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;
|
|
385
|
+
/**
|
|
386
|
+
* <p>Metric value used to trigger a scaling event.</p>
|
|
387
|
+
* @public
|
|
388
|
+
*/
|
|
389
|
+
Threshold?: number;
|
|
390
|
+
/**
|
|
391
|
+
* <p>Comparison operator to use when measuring the metric against the threshold
|
|
392
|
+
* value.</p>
|
|
393
|
+
* @public
|
|
394
|
+
*/
|
|
395
|
+
ComparisonOperator?: ComparisonOperatorType;
|
|
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;
|
|
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;
|
|
484
|
+
/**
|
|
485
|
+
* <p>An object that contains settings for a target-based scaling policy.</p>
|
|
486
|
+
* @public
|
|
487
|
+
*/
|
|
488
|
+
TargetConfiguration?: TargetConfiguration;
|
|
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;
|
|
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;
|
|
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;
|
|
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;
|
|
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;
|
|
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;
|
|
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;
|
|
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;
|
|
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;
|
|
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;
|
|
615
|
+
/**
|
|
616
|
+
* <p>Amazon S3 path and key, identifying where the game build files are
|
|
617
|
+
* stored.</p>
|
|
618
|
+
* @public
|
|
619
|
+
*/
|
|
620
|
+
StorageLocation?: S3Location;
|
|
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;
|
|
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;
|
|
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
|
*/
|
|
@@ -222,7 +884,7 @@ export interface StartGameSessionPlacementInput {
|
|
|
222
884
|
*/
|
|
223
885
|
GameSessionName?: string;
|
|
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
|
*/
|
|
@@ -233,8 +895,7 @@ export interface StartGameSessionPlacementInput {
|
|
|
233
895
|
*/
|
|
234
896
|
DesiredPlayerSessions?: DesiredPlayerSession[];
|
|
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
901
|
GameSessionData?: string;
|
|
@@ -550,12 +1211,12 @@ 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
1217
|
Name?: string;
|
|
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
1222
|
Version?: string;
|
|
@@ -570,6 +1231,190 @@ export interface UpdateBuildOutput {
|
|
|
570
1231
|
*/
|
|
571
1232
|
Build?: Build;
|
|
572
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;
|
|
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;
|
|
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;
|
|
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;
|
|
1283
|
+
/**
|
|
1284
|
+
* <p>A set of ports to add to the container fleet's inbound permissions.</p>
|
|
1285
|
+
* @public
|
|
1286
|
+
*/
|
|
1287
|
+
InstanceInboundPermissionAuthorizations?: IpPermission[];
|
|
1288
|
+
/**
|
|
1289
|
+
* <p>A set of ports to remove from the container fleet's inbound permissions.</p>
|
|
1290
|
+
* @public
|
|
1291
|
+
*/
|
|
1292
|
+
InstanceInboundPermissionRevocations?: IpPermission[];
|
|
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;
|
|
1300
|
+
/**
|
|
1301
|
+
* <p>A meaningful description of the container fleet.</p>
|
|
1302
|
+
* @public
|
|
1303
|
+
*/
|
|
1304
|
+
Description?: string;
|
|
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[];
|
|
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;
|
|
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;
|
|
1322
|
+
/**
|
|
1323
|
+
* <p>The method for collecting container logs for the fleet. </p>
|
|
1324
|
+
* @public
|
|
1325
|
+
*/
|
|
1326
|
+
LogConfiguration?: LogConfiguration;
|
|
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[];
|
|
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;
|
|
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;
|
|
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[];
|
|
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;
|
|
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;
|
|
1383
|
+
/**
|
|
1384
|
+
* <p>A description for this update to the container group definition. </p>
|
|
1385
|
+
* @public
|
|
1386
|
+
*/
|
|
1387
|
+
VersionDescription?: string;
|
|
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;
|
|
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;
|
|
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;
|
|
1417
|
+
}
|
|
573
1418
|
/**
|
|
574
1419
|
* @public
|
|
575
1420
|
*/
|
|
@@ -593,7 +1438,7 @@ export interface UpdateFleetAttributesInput {
|
|
|
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>
|
|
@@ -698,7 +1543,7 @@ export interface UpdateFleetCapacityOutput {
|
|
|
698
1543
|
FleetArn?: string;
|
|
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
1549
|
Location?: string;
|
|
@@ -949,16 +1794,14 @@ 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
1800
|
TimeoutInSeconds?: number;
|
|
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
1807
|
PlayerLatencyPolicies?: PlayerLatencyPolicy[];
|
|
@@ -1064,7 +1907,7 @@ export interface UpdateMatchmakingConfigurationInput {
|
|
|
1064
1907
|
NotificationTarget?: string;
|
|
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
|
*/
|
|
@@ -1083,7 +1926,7 @@ export interface UpdateMatchmakingConfigurationInput {
|
|
|
1083
1926
|
*/
|
|
1084
1927
|
GameProperties?: GameProperty[];
|
|
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
|
|
@@ -1169,12 +2012,12 @@ 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
2018
|
Name?: string;
|
|
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
2023
|
Version?: string;
|
|
@@ -1235,6 +2078,26 @@ export interface ValidateMatchmakingRuleSetOutput {
|
|
|
1235
2078
|
*/
|
|
1236
2079
|
Valid?: boolean;
|
|
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
|
*/
|