@aws-sdk/client-gamelift 3.316.0 → 3.319.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 +13 -13
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +1 -0
- package/dist-cjs/protocols/Aws_json1_1.js +3 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +1 -0
- package/dist-es/protocols/Aws_json1_1.js +3 -0
- package/dist-types/GameLift.d.ts +20 -20
- package/dist-types/GameLiftClient.d.ts +20 -20
- package/dist-types/commands/AcceptMatchCommand.d.ts +6 -6
- package/dist-types/commands/ClaimGameServerCommand.d.ts +16 -16
- package/dist-types/commands/CreateAliasCommand.d.ts +5 -5
- package/dist-types/commands/CreateBuildCommand.d.ts +16 -16
- package/dist-types/commands/CreateFleetCommand.d.ts +13 -13
- package/dist-types/commands/CreateFleetLocationsCommand.d.ts +11 -7
- package/dist-types/commands/CreateGameServerGroupCommand.d.ts +17 -17
- package/dist-types/commands/CreateGameSessionCommand.d.ts +11 -11
- package/dist-types/commands/CreateGameSessionQueueCommand.d.ts +10 -10
- package/dist-types/commands/CreateLocationCommand.d.ts +1 -1
- package/dist-types/commands/CreateMatchmakingConfigurationCommand.d.ts +9 -9
- package/dist-types/commands/CreateMatchmakingRuleSetCommand.d.ts +7 -7
- package/dist-types/commands/CreatePlayerSessionCommand.d.ts +7 -7
- package/dist-types/commands/CreatePlayerSessionsCommand.d.ts +8 -8
- package/dist-types/commands/CreateScriptCommand.d.ts +11 -12
- package/dist-types/commands/CreateVpcPeeringAuthorizationCommand.d.ts +5 -5
- package/dist-types/commands/CreateVpcPeeringConnectionCommand.d.ts +3 -3
- package/dist-types/commands/DeleteAliasCommand.d.ts +2 -2
- package/dist-types/commands/DeleteBuildCommand.d.ts +4 -4
- package/dist-types/commands/DeleteFleetCommand.d.ts +4 -4
- package/dist-types/commands/DeleteFleetLocationsCommand.d.ts +4 -4
- package/dist-types/commands/DeleteGameServerGroupCommand.d.ts +13 -13
- package/dist-types/commands/DeleteLocationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteMatchmakingRuleSetCommand.d.ts +3 -3
- package/dist-types/commands/DeleteScalingPolicyCommand.d.ts +2 -2
- package/dist-types/commands/DeleteScriptCommand.d.ts +6 -6
- package/dist-types/commands/DeleteVpcPeeringAuthorizationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteVpcPeeringConnectionCommand.d.ts +2 -2
- package/dist-types/commands/DeregisterGameServerCommand.d.ts +6 -6
- package/dist-types/commands/DescribeAliasCommand.d.ts +3 -3
- package/dist-types/commands/DescribeBuildCommand.d.ts +3 -3
- package/dist-types/commands/DescribeComputeCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEC2InstanceLimitsCommand.d.ts +15 -15
- package/dist-types/commands/DescribeFleetAttributesCommand.d.ts +9 -9
- package/dist-types/commands/DescribeFleetCapacityCommand.d.ts +10 -10
- package/dist-types/commands/DescribeFleetEventsCommand.d.ts +3 -3
- package/dist-types/commands/DescribeFleetLocationAttributesCommand.d.ts +7 -7
- package/dist-types/commands/DescribeFleetLocationCapacityCommand.d.ts +4 -4
- package/dist-types/commands/DescribeFleetLocationUtilizationCommand.d.ts +4 -4
- package/dist-types/commands/DescribeFleetPortSettingsCommand.d.ts +7 -7
- package/dist-types/commands/DescribeFleetUtilizationCommand.d.ts +10 -10
- package/dist-types/commands/DescribeGameServerCommand.d.ts +6 -6
- package/dist-types/commands/DescribeGameServerGroupCommand.d.ts +7 -7
- package/dist-types/commands/DescribeGameServerInstancesCommand.d.ts +8 -8
- package/dist-types/commands/DescribeGameSessionDetailsCommand.d.ts +8 -8
- package/dist-types/commands/DescribeGameSessionPlacementCommand.d.ts +2 -2
- package/dist-types/commands/DescribeGameSessionQueuesCommand.d.ts +3 -3
- package/dist-types/commands/DescribeGameSessionsCommand.d.ts +10 -10
- package/dist-types/commands/DescribeInstancesCommand.d.ts +12 -12
- package/dist-types/commands/DescribeMatchmakingCommand.d.ts +6 -6
- package/dist-types/commands/DescribeMatchmakingConfigurationsCommand.d.ts +4 -4
- package/dist-types/commands/DescribeMatchmakingRuleSetsCommand.d.ts +3 -3
- package/dist-types/commands/DescribePlayerSessionsCommand.d.ts +9 -9
- package/dist-types/commands/DescribeRuntimeConfigurationCommand.d.ts +5 -5
- package/dist-types/commands/DescribeScalingPoliciesCommand.d.ts +2 -2
- package/dist-types/commands/DescribeScriptCommand.d.ts +6 -6
- package/dist-types/commands/DescribeVpcPeeringAuthorizationsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeVpcPeeringConnectionsCommand.d.ts +2 -2
- package/dist-types/commands/GetComputeAccessCommand.d.ts +7 -7
- package/dist-types/commands/GetComputeAuthTokenCommand.d.ts +4 -4
- package/dist-types/commands/GetGameSessionLogUrlCommand.d.ts +4 -4
- package/dist-types/commands/GetInstanceAccessCommand.d.ts +9 -9
- package/dist-types/commands/ListAliasesCommand.d.ts +4 -4
- package/dist-types/commands/ListBuildsCommand.d.ts +5 -5
- package/dist-types/commands/ListFleetsCommand.d.ts +10 -10
- package/dist-types/commands/ListGameServersCommand.d.ts +5 -5
- package/dist-types/commands/ListScriptsCommand.d.ts +5 -5
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -31
- package/dist-types/commands/PutScalingPolicyCommand.d.ts +14 -14
- package/dist-types/commands/RegisterComputeCommand.d.ts +5 -5
- package/dist-types/commands/RegisterGameServerCommand.d.ts +10 -10
- package/dist-types/commands/RequestUploadCredentialsCommand.d.ts +5 -5
- package/dist-types/commands/ResolveAliasCommand.d.ts +2 -2
- package/dist-types/commands/ResumeGameServerGroupCommand.d.ts +6 -6
- package/dist-types/commands/SearchGameSessionsCommand.d.ts +20 -20
- package/dist-types/commands/StartFleetActionsCommand.d.ts +6 -6
- package/dist-types/commands/StartGameSessionPlacementCommand.d.ts +11 -11
- package/dist-types/commands/StartMatchBackfillCommand.d.ts +9 -9
- package/dist-types/commands/StartMatchmakingCommand.d.ts +8 -8
- package/dist-types/commands/StopFleetActionsCommand.d.ts +7 -7
- package/dist-types/commands/StopMatchmakingCommand.d.ts +5 -5
- package/dist-types/commands/SuspendGameServerGroupCommand.d.ts +8 -8
- package/dist-types/commands/TagResourceCommand.d.ts +10 -34
- package/dist-types/commands/UntagResourceCommand.d.ts +10 -34
- package/dist-types/commands/UpdateAliasCommand.d.ts +2 -2
- package/dist-types/commands/UpdateBuildCommand.d.ts +3 -3
- package/dist-types/commands/UpdateFleetAttributesCommand.d.ts +5 -5
- package/dist-types/commands/UpdateFleetCapacityCommand.d.ts +10 -10
- package/dist-types/commands/UpdateFleetPortSettingsCommand.d.ts +5 -5
- package/dist-types/commands/UpdateGameServerCommand.d.ts +12 -12
- package/dist-types/commands/UpdateGameServerGroupCommand.d.ts +8 -8
- package/dist-types/commands/UpdateGameSessionCommand.d.ts +5 -5
- package/dist-types/commands/UpdateGameSessionQueueCommand.d.ts +3 -3
- package/dist-types/commands/UpdateMatchmakingConfigurationCommand.d.ts +2 -2
- package/dist-types/commands/UpdateRuntimeConfigurationCommand.d.ts +5 -5
- package/dist-types/commands/UpdateScriptCommand.d.ts +8 -8
- package/dist-types/commands/ValidateMatchmakingRuleSetCommand.d.ts +3 -3
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +591 -591
- package/dist-types/models/models_1.d.ts +22 -22
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +1 -0
- package/package.json +5 -5
|
@@ -25,7 +25,7 @@ export interface StartMatchBackfillCommandOutput extends StartMatchBackfillOutpu
|
|
|
25
25
|
* provide matchmaking data for all players currently in the game session. FlexMatch uses
|
|
26
26
|
* this information to select new players so that backfilled match continues to meet the
|
|
27
27
|
* original match requirements. </p>
|
|
28
|
-
*
|
|
28
|
+
* <p>When using FlexMatch with Amazon GameLift managed hosting, you can request a backfill match from
|
|
29
29
|
* a client service by calling this operation with a <code>GameSessions</code> ID. You also
|
|
30
30
|
* have the option of making backfill requests directly from your game server. In response
|
|
31
31
|
* to a request, FlexMatch creates player sessions for the new players, updates the
|
|
@@ -33,29 +33,29 @@ export interface StartMatchBackfillCommandOutput extends StartMatchBackfillOutpu
|
|
|
33
33
|
* server. You can request a backfill match at any point after a game session is started.
|
|
34
34
|
* Each game session can have only one active backfill request at a time; a subsequent
|
|
35
35
|
* request automatically replaces the earlier request.</p>
|
|
36
|
-
*
|
|
36
|
+
* <p>When using FlexMatch as a standalone component, request a backfill match by calling this
|
|
37
37
|
* operation without a game session identifier. As with newly formed matches, matchmaking
|
|
38
38
|
* results are returned in a matchmaking event so that your game can update the game
|
|
39
39
|
* session that is being backfilled.</p>
|
|
40
|
-
*
|
|
40
|
+
* <p>To request a backfill match, specify a unique ticket ID, the original matchmaking
|
|
41
41
|
* configuration, and matchmaking data for all current players in the game session being
|
|
42
42
|
* backfilled. Optionally, specify the <code>GameSession</code> ARN. If successful, a match
|
|
43
43
|
* backfill ticket is created and returned with status set to QUEUED. Track the status of
|
|
44
44
|
* backfill tickets using the same method for tracking tickets for new matches.</p>
|
|
45
|
-
*
|
|
46
|
-
*
|
|
45
|
+
* <p>Only game sessions created by FlexMatch are supported for match backfill.</p>
|
|
46
|
+
* <p>
|
|
47
47
|
* <b>Learn more</b>
|
|
48
48
|
* </p>
|
|
49
|
-
*
|
|
49
|
+
* <p>
|
|
50
50
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html">
|
|
51
51
|
* Backfill existing games with FlexMatch</a>
|
|
52
52
|
* </p>
|
|
53
|
-
*
|
|
53
|
+
* <p>
|
|
54
54
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html">
|
|
55
55
|
* Matchmaking events</a> (reference)</p>
|
|
56
|
-
*
|
|
56
|
+
* <p>
|
|
57
57
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html">
|
|
58
|
-
* How GameLift FlexMatch works</a>
|
|
58
|
+
* How Amazon GameLift FlexMatch works</a>
|
|
59
59
|
* </p>
|
|
60
60
|
* @example
|
|
61
61
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -20,34 +20,34 @@ export interface StartMatchmakingCommandOutput extends StartMatchmakingOutput, _
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Uses FlexMatch to create a game match for a group of players based on custom matchmaking
|
|
23
|
-
* rules. With games that use GameLift managed hosting, this operation also triggers GameLift
|
|
23
|
+
* rules. With games that use Amazon GameLift managed hosting, this operation also triggers Amazon GameLift
|
|
24
24
|
* to find hosting resources and start a new game session for the new match. Each
|
|
25
25
|
* matchmaking request includes information on one or more players and specifies the
|
|
26
26
|
* FlexMatch matchmaker to use. When a request is for multiple players, FlexMatch attempts to
|
|
27
27
|
* build a match that includes all players in the request, placing them in the same team
|
|
28
28
|
* and finding additional players as needed to fill the match. </p>
|
|
29
|
-
*
|
|
29
|
+
* <p>To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration,
|
|
30
30
|
* and include the players to be matched. You must also include any player attributes that
|
|
31
31
|
* are required by the matchmaking configuration's rule set. If successful, a matchmaking
|
|
32
32
|
* ticket is returned with status set to <code>QUEUED</code>. </p>
|
|
33
|
-
*
|
|
33
|
+
* <p>Track matchmaking events to respond as needed and acquire game session connection
|
|
34
34
|
* information for successfully completed matches. Ticket status updates are tracked using
|
|
35
35
|
* event notification through Amazon Simple Notification Service, which is defined in the matchmaking
|
|
36
36
|
* configuration.</p>
|
|
37
|
-
*
|
|
37
|
+
* <p>
|
|
38
38
|
* <b>Learn more</b>
|
|
39
39
|
* </p>
|
|
40
|
-
*
|
|
40
|
+
* <p>
|
|
41
41
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html">
|
|
42
42
|
* Add FlexMatch to a game client</a>
|
|
43
43
|
* </p>
|
|
44
|
-
*
|
|
44
|
+
* <p>
|
|
45
45
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html"> Set Up FlexMatch event
|
|
46
46
|
* notification</a>
|
|
47
47
|
* </p>
|
|
48
|
-
*
|
|
48
|
+
* <p>
|
|
49
49
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html">
|
|
50
|
-
* How GameLift FlexMatch works</a>
|
|
50
|
+
* How Amazon GameLift FlexMatch works</a>
|
|
51
51
|
* </p>
|
|
52
52
|
* @example
|
|
53
53
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -22,28 +22,28 @@ export interface StopFleetActionsCommandOutput extends StopFleetActionsOutput, _
|
|
|
22
22
|
* <p>Suspends certain types of activity in a fleet location. Currently, this operation is
|
|
23
23
|
* used to stop auto-scaling activity. For multi-location fleets, fleet actions are managed
|
|
24
24
|
* separately for each location. </p>
|
|
25
|
-
*
|
|
25
|
+
* <p>Stopping fleet actions has several potential purposes. It allows you to temporarily
|
|
26
26
|
* stop auto-scaling activity but retain your scaling policies for use in the future. For
|
|
27
27
|
* multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out of it
|
|
28
28
|
* for certain locations. </p>
|
|
29
|
-
*
|
|
30
|
-
*
|
|
29
|
+
* <p>This operation can be used in the following ways: </p>
|
|
30
|
+
* <ul>
|
|
31
31
|
* <li>
|
|
32
|
-
*
|
|
32
|
+
* <p>To stop actions on instances in the fleet's home Region, provide a fleet ID
|
|
33
33
|
* and the type of actions to suspend. </p>
|
|
34
34
|
* </li>
|
|
35
35
|
* <li>
|
|
36
|
-
*
|
|
36
|
+
* <p>To stop actions on instances in one of the fleet's remote locations, provide a
|
|
37
37
|
* fleet ID, a location name, and the type of actions to suspend. </p>
|
|
38
38
|
* </li>
|
|
39
39
|
* </ul>
|
|
40
|
-
*
|
|
40
|
+
* <p>If successful, Amazon GameLift no longer initiates scaling events except in response to manual
|
|
41
41
|
* changes using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html">UpdateFleetCapacity</a>.</p>
|
|
42
42
|
* <p>
|
|
43
43
|
* <b>Learn more</b>
|
|
44
44
|
* </p>
|
|
45
45
|
* <p>
|
|
46
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
|
|
46
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift
|
|
47
47
|
* Fleets</a>
|
|
48
48
|
* </p>
|
|
49
49
|
* @example
|
|
@@ -23,18 +23,18 @@ export interface StopMatchmakingCommandOutput extends StopMatchmakingOutput, __M
|
|
|
23
23
|
* processed. To stop the matchmaking operation, specify the ticket ID. If successful, work
|
|
24
24
|
* on the ticket is stopped, and the ticket status is changed to
|
|
25
25
|
* <code>CANCELLED</code>.</p>
|
|
26
|
-
*
|
|
26
|
+
* <p>This call is also used to turn off automatic backfill for an individual game session.
|
|
27
27
|
* This is for game sessions that are created with a matchmaking configuration that has
|
|
28
28
|
* automatic backfill enabled. The ticket ID is included in the <code>MatchmakerData</code>
|
|
29
29
|
* of an updated game session object, which is provided to the game server.</p>
|
|
30
|
-
*
|
|
30
|
+
* <note>
|
|
31
31
|
* <p>If the operation is successful, the service sends back an empty JSON struct with
|
|
32
32
|
* the HTTP 200 response (not an empty HTTP body).</p>
|
|
33
|
-
*
|
|
34
|
-
*
|
|
33
|
+
* </note>
|
|
34
|
+
* <p>
|
|
35
35
|
* <b>Learn more</b>
|
|
36
36
|
* </p>
|
|
37
|
-
*
|
|
37
|
+
* <p>
|
|
38
38
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html">
|
|
39
39
|
* Add FlexMatch to a game client</a>
|
|
40
40
|
* </p>
|
|
@@ -20,14 +20,14 @@ export interface SuspendGameServerGroupCommandOutput extends SuspendGameServerGr
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>
|
|
23
|
-
* <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b>
|
|
23
|
+
* <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b>
|
|
24
24
|
* </p>
|
|
25
25
|
* <p>Temporarily stops activity on
|
|
26
26
|
* a game server group without terminating instances or the game server group. You can
|
|
27
27
|
* restart activity by calling <a href="gamelift/latest/apireference/API_ResumeGameServerGroup.html">ResumeGameServerGroup</a>. You can suspend the following activity:</p>
|
|
28
|
-
*
|
|
28
|
+
* <ul>
|
|
29
29
|
* <li>
|
|
30
|
-
*
|
|
30
|
+
* <p>
|
|
31
31
|
* <b>Instance type replacement</b> - This activity
|
|
32
32
|
* evaluates the current game hosting viability of all Spot instance types that are
|
|
33
33
|
* defined for the game server group. It updates the Auto Scaling group to remove
|
|
@@ -39,16 +39,16 @@ export interface SuspendGameServerGroupCommandOutput extends SuspendGameServerGr
|
|
|
39
39
|
* active. </p>
|
|
40
40
|
* </li>
|
|
41
41
|
* </ul>
|
|
42
|
-
*
|
|
42
|
+
* <p>To suspend activity, specify a game server group ARN and the type of activity to be
|
|
43
43
|
* suspended. If successful, a <code>GameServerGroup</code> object is returned showing that
|
|
44
44
|
* the activity is listed in <code>SuspendedActions</code>.</p>
|
|
45
|
-
*
|
|
45
|
+
* <p>
|
|
46
46
|
* <b>Learn more</b>
|
|
47
47
|
* </p>
|
|
48
|
-
*
|
|
49
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ
|
|
48
|
+
* <p>
|
|
49
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">Amazon GameLift FleetIQ
|
|
50
50
|
* Guide</a>
|
|
51
|
-
*
|
|
51
|
+
* </p>
|
|
52
52
|
* @example
|
|
53
53
|
* Use a bare-bones client and the command you need to make an API call.
|
|
54
54
|
* ```javascript
|
|
@@ -19,52 +19,28 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
* <ul>
|
|
28
|
-
* <li>
|
|
29
|
-
* <p>Build</p>
|
|
30
|
-
* </li>
|
|
31
|
-
* <li>
|
|
32
|
-
* <p>Script</p>
|
|
33
|
-
* </li>
|
|
34
|
-
* <li>
|
|
35
|
-
* <p>Fleet</p>
|
|
36
|
-
* </li>
|
|
37
|
-
* <li>
|
|
38
|
-
* <p>Alias</p>
|
|
39
|
-
* </li>
|
|
40
|
-
* <li>
|
|
41
|
-
* <p>GameSessionQueue</p>
|
|
42
|
-
* </li>
|
|
43
|
-
* <li>
|
|
44
|
-
* <p>MatchmakingConfiguration</p>
|
|
45
|
-
* </li>
|
|
46
|
-
* <li>
|
|
47
|
-
* <p>MatchmakingRuleSet</p>
|
|
48
|
-
* </li>
|
|
49
|
-
* </ul>
|
|
50
|
-
* <p>To add a tag to a resource, specify the unique ARN value for the resource and provide
|
|
22
|
+
* <p>Assigns a tag to an Amazon GameLift resource. You can use tags to organize resources, create
|
|
23
|
+
* IAM permissions policies to manage access to groups of resources, customize Amazon Web Services cost
|
|
24
|
+
* breakdowns, and more. This operation handles the permissions necessary to manage tags
|
|
25
|
+
* for Amazon GameLift resources that support tagging.</p>
|
|
26
|
+
* <p>To add a tag to a resource, specify the unique ARN value for the resource and provide
|
|
51
27
|
* a tag list containing one or more tags. The operation succeeds even if the list includes
|
|
52
|
-
* tags that are already assigned to the
|
|
53
|
-
*
|
|
28
|
+
* tags that are already assigned to the resource. </p>
|
|
29
|
+
* <p>
|
|
54
30
|
* <b>Learn more</b>
|
|
55
31
|
* </p>
|
|
56
|
-
*
|
|
32
|
+
* <p>
|
|
57
33
|
* <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
|
|
58
34
|
* Resources</a> in the <i>Amazon Web Services General Reference</i>
|
|
59
35
|
* </p>
|
|
60
|
-
*
|
|
36
|
+
* <p>
|
|
61
37
|
* <a href="http://aws.amazon.com/answers/account-management/aws-tagging-strategies/">
|
|
62
38
|
* Amazon Web Services Tagging Strategies</a>
|
|
63
39
|
* </p>
|
|
64
40
|
* <p>
|
|
65
41
|
* <b>Related actions</b>
|
|
66
42
|
* </p>
|
|
67
|
-
*
|
|
43
|
+
* <p>
|
|
68
44
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
69
45
|
* </p>
|
|
70
46
|
* @example
|
|
@@ -19,51 +19,27 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Removes a tag
|
|
23
|
-
*
|
|
24
|
-
* necessary to manage tags for
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
* <li>
|
|
30
|
-
* <p>Script</p>
|
|
31
|
-
* </li>
|
|
32
|
-
* <li>
|
|
33
|
-
* <p>Fleet</p>
|
|
34
|
-
* </li>
|
|
35
|
-
* <li>
|
|
36
|
-
* <p>Alias</p>
|
|
37
|
-
* </li>
|
|
38
|
-
* <li>
|
|
39
|
-
* <p>GameSessionQueue</p>
|
|
40
|
-
* </li>
|
|
41
|
-
* <li>
|
|
42
|
-
* <p>MatchmakingConfiguration</p>
|
|
43
|
-
* </li>
|
|
44
|
-
* <li>
|
|
45
|
-
* <p>MatchmakingRuleSet</p>
|
|
46
|
-
* </li>
|
|
47
|
-
* </ul>
|
|
48
|
-
* <p>To remove a tag from a resource, specify the unique ARN value for the resource and
|
|
49
|
-
* provide a string list containing one or more tags to be removed. This operation succeeds
|
|
50
|
-
* even if the list includes tags that are not currently assigned to the specified
|
|
51
|
-
* resource.</p>
|
|
52
|
-
* <p>
|
|
22
|
+
* <p>Removes a tag assigned to a Amazon GameLift resource. You can use resource tags to organize
|
|
23
|
+
* Amazon Web Services resources for a range of purposes. This operation handles the permissions
|
|
24
|
+
* necessary to manage tags for Amazon GameLift resources that support tagging.</p>
|
|
25
|
+
* <p>To remove a tag from a resource, specify the unique ARN value for the resource and
|
|
26
|
+
* provide a string list containing one or more tags to remove. This operation succeeds
|
|
27
|
+
* even if the list includes tags that aren't assigned to the resource.</p>
|
|
28
|
+
* <p>
|
|
53
29
|
* <b>Learn more</b>
|
|
54
30
|
* </p>
|
|
55
|
-
*
|
|
31
|
+
* <p>
|
|
56
32
|
* <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
|
|
57
33
|
* Resources</a> in the <i>Amazon Web Services General Reference</i>
|
|
58
34
|
* </p>
|
|
59
|
-
*
|
|
35
|
+
* <p>
|
|
60
36
|
* <a href="http://aws.amazon.com/answers/account-management/aws-tagging-strategies/">
|
|
61
37
|
* Amazon Web Services Tagging Strategies</a>
|
|
62
38
|
* </p>
|
|
63
39
|
* <p>
|
|
64
40
|
* <b>Related actions</b>
|
|
65
41
|
* </p>
|
|
66
|
-
*
|
|
42
|
+
* <p>
|
|
67
43
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
68
44
|
* </p>
|
|
69
45
|
* @example
|
|
@@ -26,8 +26,8 @@ export interface UpdateAliasCommandOutput extends UpdateAliasOutput, __MetadataB
|
|
|
26
26
|
* <p>
|
|
27
27
|
* <b>Related actions</b>
|
|
28
28
|
* </p>
|
|
29
|
-
*
|
|
30
|
-
*
|
|
29
|
+
* <p>
|
|
30
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
31
31
|
* </p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -22,15 +22,15 @@ export interface UpdateBuildCommandOutput extends UpdateBuildOutput, __MetadataB
|
|
|
22
22
|
* <p>Updates metadata in a build resource, including the build name and version. To update
|
|
23
23
|
* the metadata, specify the build ID to update and provide the new values. If successful,
|
|
24
24
|
* a build object containing the updated metadata is returned.</p>
|
|
25
|
-
*
|
|
25
|
+
* <p>
|
|
26
26
|
* <b>Learn more</b>
|
|
27
27
|
* </p>
|
|
28
|
-
*
|
|
28
|
+
* <p>
|
|
29
29
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html"> Upload a Custom
|
|
30
30
|
* Server Build</a>
|
|
31
31
|
* </p>
|
|
32
32
|
* <p>
|
|
33
|
-
*
|
|
33
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
34
34
|
* </p>
|
|
35
35
|
* @example
|
|
36
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -21,14 +21,14 @@ export interface UpdateFleetAttributesCommandOutput extends UpdateFleetAttribute
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Updates a fleet's mutable attributes, including game session protection and resource
|
|
23
23
|
* creation limits.</p>
|
|
24
|
-
*
|
|
24
|
+
* <p>To update fleet attributes, specify the fleet ID and the property values that you want
|
|
25
25
|
* to change. </p>
|
|
26
|
-
*
|
|
27
|
-
*
|
|
26
|
+
* <p>If successful, an updated <code>FleetAttributes</code> object is returned.</p>
|
|
27
|
+
* <p>
|
|
28
28
|
* <b>Learn more</b>
|
|
29
29
|
* </p>
|
|
30
30
|
* <p>
|
|
31
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
|
|
31
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift
|
|
32
32
|
* fleets</a>
|
|
33
33
|
* </p>
|
|
34
34
|
* @example
|
|
@@ -67,7 +67,7 @@ export interface UpdateFleetAttributesCommandOutput extends UpdateFleetAttribute
|
|
|
67
67
|
* <p>The requested operation would cause a conflict with the current state of a service
|
|
68
68
|
* resource associated with the request. Resolve the conflict before retrying this
|
|
69
69
|
* request.</p>
|
|
70
|
-
*
|
|
70
|
+
* <p></p>
|
|
71
71
|
*
|
|
72
72
|
* @throws {@link InternalServiceException} (server fault)
|
|
73
73
|
* <p>The service encountered an unrecoverable internal failure while processing the
|
|
@@ -23,35 +23,35 @@ export interface UpdateFleetCapacityCommandOutput extends UpdateFleetCapacityOut
|
|
|
23
23
|
* operation to manage capacity settings in each location individually. Fleet capacity
|
|
24
24
|
* determines the number of game sessions and players that can be hosted based on the fleet
|
|
25
25
|
* configuration. Use this operation to set the following fleet capacity properties: </p>
|
|
26
|
-
*
|
|
26
|
+
* <ul>
|
|
27
27
|
* <li>
|
|
28
|
-
*
|
|
28
|
+
* <p>Minimum/maximum size: Set hard limits on fleet capacity. Amazon GameLift cannot set
|
|
29
29
|
* the fleet's capacity to a value outside of this range, whether the capacity is
|
|
30
30
|
* changed manually or through automatic scaling. </p>
|
|
31
31
|
* </li>
|
|
32
32
|
* <li>
|
|
33
|
-
*
|
|
33
|
+
* <p>Desired capacity: Manually set the number of Amazon EC2 instances to be maintained
|
|
34
34
|
* in a fleet location. Before changing a fleet's desired capacity, you may want to
|
|
35
35
|
* call <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeEC2InstanceLimits.html">DescribeEC2InstanceLimits</a> to get the maximum capacity of the
|
|
36
36
|
* fleet's Amazon EC2 instance type. Alternatively, consider using automatic scaling to
|
|
37
37
|
* adjust capacity based on player demand.</p>
|
|
38
38
|
* </li>
|
|
39
39
|
* </ul>
|
|
40
|
-
*
|
|
41
|
-
*
|
|
40
|
+
* <p>This operation can be used in the following ways: </p>
|
|
41
|
+
* <ul>
|
|
42
42
|
* <li>
|
|
43
|
-
*
|
|
43
|
+
* <p>To update capacity for a fleet's home Region, or if the fleet has no remote
|
|
44
44
|
* locations, omit the <code>Location</code> parameter. The fleet must be in
|
|
45
45
|
* <code>ACTIVE</code> status. </p>
|
|
46
46
|
* </li>
|
|
47
47
|
* <li>
|
|
48
|
-
*
|
|
48
|
+
* <p>To update capacity for a fleet's remote location, include the
|
|
49
49
|
* <code>Location</code> parameter set to the location to be updated. The
|
|
50
50
|
* location must be in <code>ACTIVE</code> status.</p>
|
|
51
51
|
* </li>
|
|
52
52
|
* </ul>
|
|
53
|
-
*
|
|
54
|
-
* desired capacity, GameLift initiates steps to start new instances or terminate existing
|
|
53
|
+
* <p>If successful, capacity settings are updated immediately. In response a change in
|
|
54
|
+
* desired capacity, Amazon GameLift initiates steps to start new instances or terminate existing
|
|
55
55
|
* instances in the requested fleet location. This continues until the location's active
|
|
56
56
|
* instance count matches the new desired instance count. You can track a fleet's current
|
|
57
57
|
* capacity by calling <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html">DescribeFleetCapacity</a> or <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html">DescribeFleetLocationCapacity</a>. If the requested desired instance count is
|
|
@@ -91,7 +91,7 @@ export interface UpdateFleetCapacityCommandOutput extends UpdateFleetCapacityOut
|
|
|
91
91
|
* <p>The requested operation would cause a conflict with the current state of a service
|
|
92
92
|
* resource associated with the request. Resolve the conflict before retrying this
|
|
93
93
|
* request.</p>
|
|
94
|
-
*
|
|
94
|
+
* <p></p>
|
|
95
95
|
*
|
|
96
96
|
* @throws {@link InternalServiceException} (server fault)
|
|
97
97
|
* <p>The service encountered an unrecoverable internal failure while processing the
|
|
@@ -22,20 +22,20 @@ export interface UpdateFleetPortSettingsCommandOutput extends UpdateFleetPortSet
|
|
|
22
22
|
* @public
|
|
23
23
|
* <p>Updates permissions that allow inbound traffic to connect to game sessions that are
|
|
24
24
|
* being hosted on instances in the fleet. </p>
|
|
25
|
-
*
|
|
25
|
+
* <p>To update settings, specify the fleet ID to be updated and specify the changes to be
|
|
26
26
|
* made. List the permissions you want to add in
|
|
27
27
|
* <code>InboundPermissionAuthorizations</code>, and permissions you want to remove in
|
|
28
28
|
* <code>InboundPermissionRevocations</code>. Permissions to be removed must match
|
|
29
29
|
* existing fleet permissions. </p>
|
|
30
|
-
*
|
|
30
|
+
* <p>If successful, the fleet ID for the updated fleet is returned. For fleets with remote
|
|
31
31
|
* locations, port setting updates can take time to propagate across all locations. You can
|
|
32
32
|
* check the status of updates in each location by calling
|
|
33
33
|
* <code>DescribeFleetPortSettings</code> with a location name.</p>
|
|
34
34
|
* <p>
|
|
35
35
|
* <b>Learn more</b>
|
|
36
36
|
* </p>
|
|
37
|
-
*
|
|
38
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
|
|
37
|
+
* <p>
|
|
38
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift
|
|
39
39
|
* fleets</a>
|
|
40
40
|
* </p>
|
|
41
41
|
* @example
|
|
@@ -77,7 +77,7 @@ export interface UpdateFleetPortSettingsCommandOutput extends UpdateFleetPortSet
|
|
|
77
77
|
* <p>The requested operation would cause a conflict with the current state of a service
|
|
78
78
|
* resource associated with the request. Resolve the conflict before retrying this
|
|
79
79
|
* request.</p>
|
|
80
|
-
*
|
|
80
|
+
* <p></p>
|
|
81
81
|
*
|
|
82
82
|
* @throws {@link InternalServiceException} (server fault)
|
|
83
83
|
* <p>The service encountered an unrecoverable internal failure while processing the
|
|
@@ -20,23 +20,23 @@ export interface UpdateGameServerCommandOutput extends UpdateGameServerOutput, _
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>
|
|
23
|
-
* <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b>
|
|
23
|
+
* <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b>
|
|
24
24
|
* </p>
|
|
25
25
|
* <p>Updates information about a
|
|
26
|
-
* registered game server to help GameLift FleetIQ to track game server availability. This operation
|
|
26
|
+
* registered game server to help Amazon GameLift FleetIQ to track game server availability. This operation
|
|
27
27
|
* is called by a game server process that is running on an instance in a game server
|
|
28
28
|
* group. </p>
|
|
29
|
-
*
|
|
29
|
+
* <p>Use this operation to update the following types of game server information. You can
|
|
30
30
|
* make all three types of updates in the same request:</p>
|
|
31
|
-
*
|
|
31
|
+
* <ul>
|
|
32
32
|
* <li>
|
|
33
|
-
*
|
|
33
|
+
* <p>To update the game server's utilization status, identify the game server and
|
|
34
34
|
* game server group and specify the current utilization status. Use this status to
|
|
35
35
|
* identify when game servers are currently hosting games and when they are
|
|
36
36
|
* available to be claimed.</p>
|
|
37
37
|
* </li>
|
|
38
38
|
* <li>
|
|
39
|
-
*
|
|
39
|
+
* <p>To report health status, identify the game server and game server group and
|
|
40
40
|
* set health check to <code>HEALTHY</code>. If a game server does not report
|
|
41
41
|
* health status for a certain length of time, the game server is no longer
|
|
42
42
|
* considered healthy. As a result, it will be eventually deregistered from the
|
|
@@ -44,18 +44,18 @@ export interface UpdateGameServerCommandOutput extends UpdateGameServerOutput, _
|
|
|
44
44
|
* to report health every 60 seconds.</p>
|
|
45
45
|
* </li>
|
|
46
46
|
* <li>
|
|
47
|
-
*
|
|
47
|
+
* <p>To change game server metadata, provide updated game server data.</p>
|
|
48
48
|
* </li>
|
|
49
49
|
* </ul>
|
|
50
|
-
*
|
|
50
|
+
* <p>Once a game server is successfully updated, the relevant statuses and timestamps are
|
|
51
51
|
* updated.</p>
|
|
52
|
-
*
|
|
52
|
+
* <p>
|
|
53
53
|
* <b>Learn more</b>
|
|
54
54
|
* </p>
|
|
55
|
-
*
|
|
56
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ
|
|
55
|
+
* <p>
|
|
56
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">Amazon GameLift FleetIQ
|
|
57
57
|
* Guide</a>
|
|
58
|
-
*
|
|
58
|
+
* </p>
|
|
59
59
|
* @example
|
|
60
60
|
* Use a bare-bones client and the command you need to make an API call.
|
|
61
61
|
* ```javascript
|
|
@@ -20,23 +20,23 @@ export interface UpdateGameServerGroupCommandOutput extends UpdateGameServerGrou
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>
|
|
23
|
-
* <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b>
|
|
23
|
+
* <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b>
|
|
24
24
|
* </p>
|
|
25
|
-
* <p>Updates GameLift FleetIQ-specific
|
|
25
|
+
* <p>Updates Amazon GameLift FleetIQ-specific
|
|
26
26
|
* properties for a game server group. Many Auto Scaling group properties are updated on
|
|
27
27
|
* the Auto Scaling group directly, including the launch template, Auto Scaling policies,
|
|
28
28
|
* and maximum/minimum/desired instance counts.</p>
|
|
29
|
-
*
|
|
29
|
+
* <p>To update the game server group, specify the game server group ID and provide the
|
|
30
30
|
* updated values. Before applying the updates, the new values are validated to ensure that
|
|
31
|
-
* GameLift FleetIQ can continue to perform instance balancing activity. If successful, a
|
|
31
|
+
* Amazon GameLift FleetIQ can continue to perform instance balancing activity. If successful, a
|
|
32
32
|
* <code>GameServerGroup</code> object is returned.</p>
|
|
33
|
-
*
|
|
33
|
+
* <p>
|
|
34
34
|
* <b>Learn more</b>
|
|
35
35
|
* </p>
|
|
36
|
-
*
|
|
37
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ
|
|
36
|
+
* <p>
|
|
37
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">Amazon GameLift FleetIQ
|
|
38
38
|
* Guide</a>
|
|
39
|
-
*
|
|
39
|
+
* </p>
|
|
40
40
|
* @example
|
|
41
41
|
* Use a bare-bones client and the command you need to make an API call.
|
|
42
42
|
* ```javascript
|
|
@@ -20,11 +20,11 @@ export interface UpdateGameSessionCommandOutput extends UpdateGameSessionOutput,
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Updates the mutable properties of a game session. </p>
|
|
23
|
-
*
|
|
23
|
+
* <p>To update a game session, specify the game session ID and the values you want to
|
|
24
24
|
* change. </p>
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
25
|
+
* <p>If successful, the updated <code>GameSession</code> object is returned. </p>
|
|
26
|
+
* <p>
|
|
27
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
28
28
|
* </p>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -53,7 +53,7 @@ export interface UpdateGameSessionCommandOutput extends UpdateGameSessionOutput,
|
|
|
53
53
|
* <p>The requested operation would cause a conflict with the current state of a service
|
|
54
54
|
* resource associated with the request. Resolve the conflict before retrying this
|
|
55
55
|
* request.</p>
|
|
56
|
-
*
|
|
56
|
+
* <p></p>
|
|
57
57
|
*
|
|
58
58
|
* @throws {@link InternalServiceException} (server fault)
|
|
59
59
|
* <p>The service encountered an unrecoverable internal failure while processing the
|
|
@@ -23,13 +23,13 @@ export interface UpdateGameSessionQueueCommandOutput extends UpdateGameSessionQu
|
|
|
23
23
|
* processes new game session requests. To update settings, specify the queue name to be
|
|
24
24
|
* updated and provide the new settings. When updating destinations, provide a complete
|
|
25
25
|
* list of destinations. </p>
|
|
26
|
-
*
|
|
26
|
+
* <p>
|
|
27
27
|
* <b>Learn more</b>
|
|
28
28
|
* </p>
|
|
29
|
-
*
|
|
29
|
+
* <p>
|
|
30
30
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html">
|
|
31
31
|
* Using Multi-Region Queues</a>
|
|
32
|
-
*
|
|
32
|
+
* </p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
35
|
* ```javascript
|
|
@@ -22,10 +22,10 @@ export interface UpdateMatchmakingConfigurationCommandOutput extends UpdateMatch
|
|
|
22
22
|
* <p>Updates settings for a FlexMatch matchmaking configuration. These changes affect all
|
|
23
23
|
* matches and game sessions that are created after the update. To update settings, specify
|
|
24
24
|
* the configuration name to be updated and provide the new settings. </p>
|
|
25
|
-
*
|
|
25
|
+
* <p>
|
|
26
26
|
* <b>Learn more</b>
|
|
27
27
|
* </p>
|
|
28
|
-
*
|
|
28
|
+
* <p>
|
|
29
29
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html"> Design a FlexMatch
|
|
30
30
|
* matchmaker</a>
|
|
31
31
|
* </p>
|