@aws-sdk/client-gamelift 3.216.0 → 3.222.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 +19 -20
- package/dist-cjs/GameLift.js +135 -0
- package/dist-cjs/commands/CreateLocationCommand.js +46 -0
- package/dist-cjs/commands/DeleteLocationCommand.js +46 -0
- package/dist-cjs/commands/DeregisterComputeCommand.js +46 -0
- package/dist-cjs/commands/DescribeComputeCommand.js +46 -0
- package/dist-cjs/commands/GetComputeAccessCommand.js +46 -0
- package/dist-cjs/commands/GetComputeAuthTokenCommand.js +46 -0
- package/dist-cjs/commands/ListComputeCommand.js +46 -0
- package/dist-cjs/commands/ListLocationsCommand.js +46 -0
- package/dist-cjs/commands/RegisterComputeCommand.js +46 -0
- package/dist-cjs/commands/UpdateFleetPortSettingsCommand.js +2 -1
- package/dist-cjs/commands/UpdateGameServerCommand.js +3 -3
- package/dist-cjs/commands/UpdateGameServerGroupCommand.js +3 -3
- package/dist-cjs/commands/UpdateGameSessionCommand.js +3 -3
- package/dist-cjs/commands/UpdateGameSessionQueueCommand.js +3 -3
- package/dist-cjs/commands/UpdateMatchmakingConfigurationCommand.js +3 -3
- package/dist-cjs/commands/UpdateRuntimeConfigurationCommand.js +3 -3
- package/dist-cjs/commands/UpdateScriptCommand.js +3 -3
- package/dist-cjs/commands/ValidateMatchmakingRuleSetCommand.js +3 -3
- package/dist-cjs/commands/index.js +9 -0
- package/dist-cjs/endpoint/ruleset.js +1 -1
- package/dist-cjs/models/index.js +1 -0
- package/dist-cjs/models/models_0.js +348 -78
- package/dist-cjs/models/models_1.js +75 -0
- package/dist-cjs/pagination/ListComputePaginator.js +36 -0
- package/dist-cjs/pagination/ListLocationsPaginator.js +36 -0
- package/dist-cjs/pagination/index.js +2 -0
- package/dist-cjs/protocols/Aws_json1_1.js +731 -34
- package/dist-es/GameLift.js +135 -0
- package/dist-es/commands/CreateLocationCommand.js +42 -0
- package/dist-es/commands/DeleteLocationCommand.js +42 -0
- package/dist-es/commands/DeregisterComputeCommand.js +42 -0
- package/dist-es/commands/DescribeComputeCommand.js +42 -0
- package/dist-es/commands/GetComputeAccessCommand.js +42 -0
- package/dist-es/commands/GetComputeAuthTokenCommand.js +42 -0
- package/dist-es/commands/ListComputeCommand.js +42 -0
- package/dist-es/commands/ListLocationsCommand.js +42 -0
- package/dist-es/commands/RegisterComputeCommand.js +42 -0
- package/dist-es/commands/UpdateFleetPortSettingsCommand.js +2 -1
- package/dist-es/commands/UpdateGameServerCommand.js +1 -1
- package/dist-es/commands/UpdateGameServerGroupCommand.js +1 -1
- package/dist-es/commands/UpdateGameSessionCommand.js +1 -1
- package/dist-es/commands/UpdateGameSessionQueueCommand.js +1 -1
- package/dist-es/commands/UpdateMatchmakingConfigurationCommand.js +1 -1
- package/dist-es/commands/UpdateRuntimeConfigurationCommand.js +1 -1
- package/dist-es/commands/UpdateScriptCommand.js +1 -1
- package/dist-es/commands/ValidateMatchmakingRuleSetCommand.js +1 -1
- package/dist-es/commands/index.js +9 -0
- package/dist-es/endpoint/ruleset.js +1 -1
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +321 -55
- package/dist-es/models/models_1.js +55 -0
- package/dist-es/pagination/ListComputePaginator.js +32 -0
- package/dist-es/pagination/ListLocationsPaginator.js +32 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_json1_1.js +729 -51
- package/dist-types/GameLift.d.ts +756 -1757
- package/dist-types/GameLiftClient.d.ts +32 -23
- package/dist-types/commands/AcceptMatchCommand.d.ts +3 -13
- package/dist-types/commands/ClaimGameServerCommand.d.ts +15 -26
- package/dist-types/commands/CreateAliasCommand.d.ts +2 -8
- package/dist-types/commands/CreateBuildCommand.d.ts +15 -26
- package/dist-types/commands/CreateFleetCommand.d.ts +9 -28
- package/dist-types/commands/CreateFleetLocationsCommand.d.ts +11 -30
- package/dist-types/commands/CreateGameServerGroupCommand.d.ts +13 -25
- package/dist-types/commands/CreateGameSessionCommand.d.ts +8 -21
- package/dist-types/commands/CreateGameSessionQueueCommand.d.ts +9 -14
- package/dist-types/commands/CreateLocationCommand.d.ts +37 -0
- package/dist-types/commands/CreateMatchmakingConfigurationCommand.d.ts +7 -23
- package/dist-types/commands/CreateMatchmakingRuleSetCommand.d.ts +3 -19
- package/dist-types/commands/CreatePlayerSessionCommand.d.ts +12 -20
- package/dist-types/commands/CreatePlayerSessionsCommand.d.ts +11 -18
- package/dist-types/commands/CreateScriptCommand.d.ts +11 -15
- package/dist-types/commands/CreateVpcPeeringAuthorizationCommand.d.ts +14 -21
- package/dist-types/commands/CreateVpcPeeringConnectionCommand.d.ts +18 -25
- package/dist-types/commands/DeleteAliasCommand.d.ts +1 -7
- package/dist-types/commands/DeleteBuildCommand.d.ts +6 -14
- package/dist-types/commands/DeleteFleetCommand.d.ts +6 -22
- package/dist-types/commands/DeleteFleetLocationsCommand.d.ts +3 -18
- package/dist-types/commands/DeleteGameServerGroupCommand.d.ts +10 -23
- package/dist-types/commands/DeleteGameSessionQueueCommand.d.ts +2 -24
- package/dist-types/commands/DeleteLocationCommand.d.ts +39 -0
- package/dist-types/commands/DeleteMatchmakingConfigurationCommand.d.ts +0 -14
- package/dist-types/commands/DeleteMatchmakingRuleSetCommand.d.ts +2 -16
- package/dist-types/commands/DeleteScalingPolicyCommand.d.ts +4 -18
- package/dist-types/commands/DeleteScriptCommand.d.ts +2 -7
- package/dist-types/commands/DeleteVpcPeeringAuthorizationCommand.d.ts +3 -9
- package/dist-types/commands/DeleteVpcPeeringConnectionCommand.d.ts +5 -13
- package/dist-types/commands/DeregisterComputeCommand.d.ts +38 -0
- package/dist-types/commands/DeregisterGameServerCommand.d.ts +5 -16
- package/dist-types/commands/DescribeAliasCommand.d.ts +1 -7
- package/dist-types/commands/DescribeBuildCommand.d.ts +3 -11
- package/dist-types/commands/DescribeComputeCommand.d.ts +39 -0
- package/dist-types/commands/DescribeEC2InstanceLimitsCommand.d.ts +9 -25
- package/dist-types/commands/DescribeFleetAttributesCommand.d.ts +6 -21
- package/dist-types/commands/DescribeFleetCapacityCommand.d.ts +8 -22
- package/dist-types/commands/DescribeFleetEventsCommand.d.ts +4 -19
- package/dist-types/commands/DescribeFleetLocationAttributesCommand.d.ts +4 -19
- package/dist-types/commands/DescribeFleetLocationCapacityCommand.d.ts +4 -19
- package/dist-types/commands/DescribeFleetLocationUtilizationCommand.d.ts +4 -19
- package/dist-types/commands/DescribeFleetPortSettingsCommand.d.ts +8 -23
- package/dist-types/commands/DescribeFleetUtilizationCommand.d.ts +9 -24
- package/dist-types/commands/DescribeGameServerCommand.d.ts +5 -15
- package/dist-types/commands/DescribeGameServerGroupCommand.d.ts +8 -20
- package/dist-types/commands/DescribeGameServerInstancesCommand.d.ts +7 -23
- package/dist-types/commands/DescribeGameSessionDetailsCommand.d.ts +6 -20
- package/dist-types/commands/DescribeGameSessionPlacementCommand.d.ts +8 -26
- package/dist-types/commands/DescribeGameSessionQueuesCommand.d.ts +5 -20
- package/dist-types/commands/DescribeGameSessionsCommand.d.ts +9 -32
- package/dist-types/commands/DescribeInstancesCommand.d.ts +5 -7
- package/dist-types/commands/DescribeMatchmakingCommand.d.ts +6 -19
- package/dist-types/commands/DescribeMatchmakingConfigurationsCommand.d.ts +1 -16
- package/dist-types/commands/DescribeMatchmakingRuleSetsCommand.d.ts +2 -16
- package/dist-types/commands/DescribePlayerSessionsCommand.d.ts +3 -11
- package/dist-types/commands/DescribeRuntimeConfigurationCommand.d.ts +5 -20
- package/dist-types/commands/DescribeScalingPoliciesCommand.d.ts +6 -22
- package/dist-types/commands/DescribeScriptCommand.d.ts +3 -8
- package/dist-types/commands/DescribeVpcPeeringAuthorizationsCommand.d.ts +2 -8
- package/dist-types/commands/DescribeVpcPeeringConnectionsCommand.d.ts +7 -13
- package/dist-types/commands/GetComputeAccessCommand.d.ts +59 -0
- package/dist-types/commands/GetComputeAuthTokenCommand.d.ts +40 -0
- package/dist-types/commands/GetGameSessionLogUrlCommand.d.ts +3 -15
- package/dist-types/commands/GetInstanceAccessCommand.d.ts +2 -8
- package/dist-types/commands/ListAliasesCommand.d.ts +4 -10
- package/dist-types/commands/ListBuildsCommand.d.ts +3 -11
- package/dist-types/commands/ListComputeCommand.d.ts +37 -0
- package/dist-types/commands/ListFleetsCommand.d.ts +9 -23
- package/dist-types/commands/ListGameServerGroupsCommand.d.ts +1 -26
- package/dist-types/commands/ListGameServersCommand.d.ts +6 -16
- package/dist-types/commands/ListLocationsCommand.d.ts +37 -0
- package/dist-types/commands/ListScriptsCommand.d.ts +3 -7
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -13
- package/dist-types/commands/PutScalingPolicyCommand.d.ts +21 -40
- package/dist-types/commands/RegisterComputeCommand.d.ts +57 -0
- package/dist-types/commands/RegisterGameServerCommand.d.ts +9 -21
- package/dist-types/commands/RequestUploadCredentialsCommand.d.ts +3 -12
- package/dist-types/commands/ResolveAliasCommand.d.ts +1 -7
- package/dist-types/commands/ResumeGameServerGroupCommand.d.ts +11 -23
- package/dist-types/commands/SearchGameSessionsCommand.d.ts +21 -38
- package/dist-types/commands/StartFleetActionsCommand.d.ts +7 -21
- package/dist-types/commands/StartGameSessionPlacementCommand.d.ts +31 -46
- package/dist-types/commands/StartMatchBackfillCommand.d.ts +19 -29
- package/dist-types/commands/StartMatchmakingCommand.d.ts +4 -15
- package/dist-types/commands/StopFleetActionsCommand.d.ts +5 -21
- package/dist-types/commands/StopGameSessionPlacementCommand.d.ts +2 -17
- package/dist-types/commands/StopMatchmakingCommand.d.ts +3 -14
- package/dist-types/commands/SuspendGameServerGroupCommand.d.ts +7 -19
- package/dist-types/commands/TagResourceCommand.d.ts +7 -10
- package/dist-types/commands/UntagResourceCommand.d.ts +12 -16
- package/dist-types/commands/UpdateAliasCommand.d.ts +1 -7
- package/dist-types/commands/UpdateBuildCommand.d.ts +3 -11
- package/dist-types/commands/UpdateFleetAttributesCommand.d.ts +3 -19
- package/dist-types/commands/UpdateFleetCapacityCommand.d.ts +10 -26
- package/dist-types/commands/UpdateFleetPortSettingsCommand.d.ts +6 -21
- package/dist-types/commands/UpdateGameServerCommand.d.ts +20 -29
- package/dist-types/commands/UpdateGameServerGroupCommand.d.ts +9 -21
- package/dist-types/commands/UpdateGameSessionCommand.d.ts +1 -13
- package/dist-types/commands/UpdateGameSessionQueueCommand.d.ts +2 -16
- package/dist-types/commands/UpdateMatchmakingConfigurationCommand.d.ts +6 -20
- package/dist-types/commands/UpdateRuntimeConfigurationCommand.d.ts +5 -21
- package/dist-types/commands/UpdateScriptCommand.d.ts +2 -7
- package/dist-types/commands/ValidateMatchmakingRuleSetCommand.d.ts +4 -18
- package/dist-types/commands/index.d.ts +9 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +1598 -1987
- package/dist-types/models/models_1.d.ts +452 -0
- package/dist-types/pagination/ListComputePaginator.d.ts +4 -0
- package/dist-types/pagination/ListLocationsPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +27 -0
- package/dist-types/ts3.4/GameLift.d.ts +153 -0
- package/dist-types/ts3.4/GameLiftClient.d.ts +54 -0
- package/dist-types/ts3.4/commands/CreateLocationCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/DeleteLocationCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/DeregisterComputeCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/DescribeComputeCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/GetComputeAccessCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/GetComputeAuthTokenCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/ListComputeCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/ListLocationsCommand.d.ts +34 -0
- package/dist-types/ts3.4/commands/RegisterComputeCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/UpdateFleetPortSettingsCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/UpdateGameServerCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateGameServerGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateGameSessionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateGameSessionQueueCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateMatchmakingConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateRuntimeConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateScriptCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ValidateMatchmakingRuleSetCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +9 -0
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +417 -370
- package/dist-types/ts3.4/models/models_1.d.ts +166 -0
- package/dist-types/ts3.4/pagination/ListComputePaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListLocationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +108 -0
- package/package.json +29 -28
|
@@ -16,31 +16,16 @@ export interface DescribeFleetLocationCapacityCommandOutput extends DescribeFlee
|
|
|
16
16
|
* <p>To retrieve capacity data, identify a fleet and location. </p>
|
|
17
17
|
* <p>If successful, a <code>FleetCapacity</code> object is returned for the requested fleet
|
|
18
18
|
* location. </p>
|
|
19
|
-
*
|
|
19
|
+
* <p>
|
|
20
20
|
* <b>Learn more</b>
|
|
21
21
|
* </p>
|
|
22
|
-
*
|
|
23
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
|
|
22
|
+
* <p>
|
|
23
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
|
|
24
|
+
* fleets</a>
|
|
24
25
|
* </p>
|
|
25
26
|
* <p>
|
|
26
27
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet">GameLift metrics for fleets</a>
|
|
27
28
|
* </p>
|
|
28
|
-
* <p>
|
|
29
|
-
* <b>Related actions</b>
|
|
30
|
-
* </p>
|
|
31
|
-
* <p>
|
|
32
|
-
* <a>CreateFleetLocations</a> |
|
|
33
|
-
* <a>DescribeFleetLocationAttributes</a> |
|
|
34
|
-
* <a>DescribeFleetLocationCapacity</a> |
|
|
35
|
-
* <a>DescribeFleetLocationUtilization</a> |
|
|
36
|
-
* <a>DescribeFleetAttributes</a> |
|
|
37
|
-
* <a>DescribeFleetCapacity</a> |
|
|
38
|
-
* <a>DescribeFleetUtilization</a> |
|
|
39
|
-
* <a>UpdateFleetCapacity</a> |
|
|
40
|
-
* <a>StopFleetActions</a> |
|
|
41
|
-
* <a>DeleteFleetLocations</a> |
|
|
42
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
43
|
-
* </p>
|
|
44
29
|
* @example
|
|
45
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
46
31
|
* ```javascript
|
|
@@ -16,31 +16,16 @@ export interface DescribeFleetLocationUtilizationCommandOutput extends DescribeF
|
|
|
16
16
|
* <p>To retrieve utilization data, identify a fleet and location. </p>
|
|
17
17
|
* <p>If successful, a <code>FleetUtilization</code> object is returned for the requested
|
|
18
18
|
* fleet location. </p>
|
|
19
|
-
*
|
|
19
|
+
* <p>
|
|
20
20
|
* <b>Learn more</b>
|
|
21
21
|
* </p>
|
|
22
|
-
*
|
|
23
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
|
|
22
|
+
* <p>
|
|
23
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
|
|
24
|
+
* fleets</a>
|
|
24
25
|
* </p>
|
|
25
26
|
* <p>
|
|
26
27
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet">GameLift metrics for fleets</a>
|
|
27
28
|
* </p>
|
|
28
|
-
* <p>
|
|
29
|
-
* <b>Related actions</b>
|
|
30
|
-
* </p>
|
|
31
|
-
* <p>
|
|
32
|
-
* <a>CreateFleetLocations</a> |
|
|
33
|
-
* <a>DescribeFleetLocationAttributes</a> |
|
|
34
|
-
* <a>DescribeFleetLocationCapacity</a> |
|
|
35
|
-
* <a>DescribeFleetLocationUtilization</a> |
|
|
36
|
-
* <a>DescribeFleetAttributes</a> |
|
|
37
|
-
* <a>DescribeFleetCapacity</a> |
|
|
38
|
-
* <a>DescribeFleetUtilization</a> |
|
|
39
|
-
* <a>UpdateFleetCapacity</a> |
|
|
40
|
-
* <a>StopFleetActions</a> |
|
|
41
|
-
* <a>DeleteFleetLocations</a> |
|
|
42
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
43
|
-
* </p>
|
|
44
29
|
* @example
|
|
45
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
46
31
|
* ```javascript
|
|
@@ -19,35 +19,20 @@ export interface DescribeFleetPortSettingsCommandOutput extends DescribeFleetPor
|
|
|
19
19
|
* fleet's unique identifier. </p>
|
|
20
20
|
* </li>
|
|
21
21
|
* <li>
|
|
22
|
-
* <p>To check the status of recent updates to a fleet remote location, specify
|
|
23
|
-
*
|
|
24
|
-
*
|
|
22
|
+
* <p>To check the status of recent updates to a fleet remote location, specify the
|
|
23
|
+
* fleet ID and a location. Port setting updates can take time to propagate across
|
|
24
|
+
* all locations. </p>
|
|
25
25
|
* </li>
|
|
26
26
|
* </ul>
|
|
27
|
-
* <p>If successful, a set of <
|
|
27
|
+
* <p>If successful, a set of <code>IpPermission</code> objects is returned for the
|
|
28
28
|
* requested fleet ID. When a location is specified, a pending status is included. If the
|
|
29
29
|
* requested fleet has been deleted, the result set is empty.</p>
|
|
30
|
-
*
|
|
30
|
+
* <p>
|
|
31
31
|
* <b>Learn more</b>
|
|
32
32
|
* </p>
|
|
33
|
-
*
|
|
34
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
|
|
35
|
-
*
|
|
36
|
-
* <p>
|
|
37
|
-
* <b>Related actions</b>
|
|
38
|
-
* </p>
|
|
39
|
-
* <p>
|
|
40
|
-
* <a>ListFleets</a> |
|
|
41
|
-
* <a>DescribeEC2InstanceLimits</a> |
|
|
42
|
-
* <a>DescribeFleetAttributes</a> |
|
|
43
|
-
* <a>DescribeFleetCapacity</a> |
|
|
44
|
-
* <a>DescribeFleetEvents</a> |
|
|
45
|
-
* <a>DescribeFleetLocationAttributes</a> |
|
|
46
|
-
* <a>DescribeFleetPortSettings</a> |
|
|
47
|
-
* <a>DescribeFleetUtilization</a> |
|
|
48
|
-
* <a>DescribeRuntimeConfiguration</a> |
|
|
49
|
-
* <a>DescribeScalingPolicies</a> |
|
|
50
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
33
|
+
* <p>
|
|
34
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
|
|
35
|
+
* fleets</a>
|
|
51
36
|
* </p>
|
|
52
37
|
* @example
|
|
53
38
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,7 +10,8 @@ export interface DescribeFleetUtilizationCommandOutput extends DescribeFleetUtil
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Retrieves utilization statistics for one or more fleets. Utilization data provides a
|
|
12
12
|
* snapshot of how the fleet's hosting resources are currently being used. For fleets with
|
|
13
|
-
* remote locations, this operation retrieves data for the fleet's home Region only. See
|
|
13
|
+
* remote locations, this operation retrieves data for the fleet's home Region only. See
|
|
14
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationUtilization.html">DescribeFleetLocationUtilization</a> to get utilization statistics for a
|
|
14
15
|
* fleet's remote locations.</p>
|
|
15
16
|
* <p>This operation can be used in the following ways: </p>
|
|
16
17
|
* <ul>
|
|
@@ -25,40 +26,24 @@ export interface DescribeFleetUtilizationCommandOutput extends DescribeFleetUtil
|
|
|
25
26
|
* </ul>
|
|
26
27
|
* <p>When requesting multiple fleets, use the pagination parameters to retrieve results as
|
|
27
28
|
* a set of sequential pages. </p>
|
|
28
|
-
* <p>If successful, a <a>FleetUtilization</a> object is returned for each
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* Region. </p>
|
|
29
|
+
* <p>If successful, a <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_FleetUtilization.html">FleetUtilization</a> object is returned for each requested fleet ID, unless the
|
|
30
|
+
* fleet identifier is not found. Each fleet utilization object includes a
|
|
31
|
+
* <code>Location</code> property, which is set to the fleet's home Region. </p>
|
|
32
32
|
* <note>
|
|
33
33
|
* <p>Some API operations may limit the number of fleet IDs allowed in one request. If a
|
|
34
34
|
* request exceeds this limit, the request fails and the error message includes the
|
|
35
35
|
* maximum allowed.</p>
|
|
36
36
|
* </note>
|
|
37
|
-
*
|
|
37
|
+
* <p>
|
|
38
38
|
* <b>Learn more</b>
|
|
39
39
|
* </p>
|
|
40
|
-
*
|
|
41
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
|
|
40
|
+
* <p>
|
|
41
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
|
|
42
|
+
* Fleets</a>
|
|
42
43
|
* </p>
|
|
43
44
|
* <p>
|
|
44
45
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet">GameLift Metrics for Fleets</a>
|
|
45
46
|
* </p>
|
|
46
|
-
* <p>
|
|
47
|
-
* <b>Related actions</b>
|
|
48
|
-
* </p>
|
|
49
|
-
* <p>
|
|
50
|
-
* <a>ListFleets</a> |
|
|
51
|
-
* <a>DescribeEC2InstanceLimits</a> |
|
|
52
|
-
* <a>DescribeFleetAttributes</a> |
|
|
53
|
-
* <a>DescribeFleetCapacity</a> |
|
|
54
|
-
* <a>DescribeFleetEvents</a> |
|
|
55
|
-
* <a>DescribeFleetLocationAttributes</a> |
|
|
56
|
-
* <a>DescribeFleetPortSettings</a> |
|
|
57
|
-
* <a>DescribeFleetUtilization</a> |
|
|
58
|
-
* <a>DescribeRuntimeConfiguration</a> |
|
|
59
|
-
* <a>DescribeScalingPolicies</a> |
|
|
60
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
61
|
-
* </p>
|
|
62
47
|
* @example
|
|
63
48
|
* Use a bare-bones client and the command you need to make an API call.
|
|
64
49
|
* ```javascript
|
|
@@ -11,28 +11,18 @@ export interface DescribeGameServerCommandOutput extends DescribeGameServerOutpu
|
|
|
11
11
|
* <p>
|
|
12
12
|
* <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b>
|
|
13
13
|
* </p>
|
|
14
|
-
*
|
|
15
|
-
*
|
|
14
|
+
* <p>Retrieves information for a
|
|
15
|
+
* registered game server. Information includes game server status, health check info, and
|
|
16
|
+
* the instance that the game server is running on. </p>
|
|
16
17
|
* <p>To retrieve game server information, specify the game server ID. If successful, the
|
|
17
18
|
* requested game server object is returned. </p>
|
|
18
19
|
* <p>
|
|
19
20
|
* <b>Learn more</b>
|
|
20
21
|
* </p>
|
|
21
22
|
* <p>
|
|
22
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ
|
|
23
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ
|
|
24
|
+
* Guide</a>
|
|
23
25
|
* </p>
|
|
24
|
-
* <p>
|
|
25
|
-
* <b>Related actions</b>
|
|
26
|
-
* </p>
|
|
27
|
-
* <p>
|
|
28
|
-
* <a>RegisterGameServer</a> |
|
|
29
|
-
* <a>ListGameServers</a> |
|
|
30
|
-
* <a>ClaimGameServer</a> |
|
|
31
|
-
* <a>DescribeGameServer</a> |
|
|
32
|
-
* <a>UpdateGameServer</a> |
|
|
33
|
-
* <a>DeregisterGameServer</a> |
|
|
34
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html">All APIs by task</a>
|
|
35
|
-
* </p>
|
|
36
26
|
* @example
|
|
37
27
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
28
|
* ```javascript
|
|
@@ -11,32 +11,20 @@ export interface DescribeGameServerGroupCommandOutput extends DescribeGameServer
|
|
|
11
11
|
* <p>
|
|
12
12
|
* <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b>
|
|
13
13
|
* </p>
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
* the Auto Scaling group
|
|
14
|
+
* <p>Retrieves information on a
|
|
15
|
+
* game server group. This operation returns only properties related to GameLift FleetIQ. To view or
|
|
16
|
+
* update properties for the corresponding Auto Scaling group, such as launch template,
|
|
17
|
+
* auto scaling policies, and maximum/minimum group size, access the Auto Scaling group
|
|
18
|
+
* directly.</p>
|
|
18
19
|
* <p>To get attributes for a game server group, provide a group name or ARN value. If
|
|
19
|
-
* successful, a <
|
|
20
|
+
* successful, a <code>GameServerGroup</code> object is returned.</p>
|
|
20
21
|
* <p>
|
|
21
22
|
* <b>Learn more</b>
|
|
22
23
|
* </p>
|
|
23
24
|
* <p>
|
|
24
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ
|
|
25
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ
|
|
26
|
+
* Guide</a>
|
|
25
27
|
* </p>
|
|
26
|
-
* <p>
|
|
27
|
-
* <b>Related actions</b>
|
|
28
|
-
* </p>
|
|
29
|
-
* <p>
|
|
30
|
-
* <a>CreateGameServerGroup</a> |
|
|
31
|
-
* <a>ListGameServerGroups</a> |
|
|
32
|
-
* <a>DescribeGameServerGroup</a> |
|
|
33
|
-
* <a>UpdateGameServerGroup</a> |
|
|
34
|
-
* <a>DeleteGameServerGroup</a> |
|
|
35
|
-
* <a>ResumeGameServerGroup</a> |
|
|
36
|
-
* <a>SuspendGameServerGroup</a> |
|
|
37
|
-
* <a>DescribeGameServerInstances</a> |
|
|
38
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html">All APIs by task</a>
|
|
39
|
-
* </p>
|
|
40
28
|
* @example
|
|
41
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
42
30
|
* ```javascript
|
|
@@ -11,18 +11,15 @@ export interface DescribeGameServerInstancesCommandOutput extends DescribeGameSe
|
|
|
11
11
|
* <p>
|
|
12
12
|
* <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b>
|
|
13
13
|
* </p>
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
* Auto Scaling group properties.</p>
|
|
14
|
+
* <p>Retrieves status
|
|
15
|
+
* information about the Amazon EC2 instances associated with a GameLift FleetIQ game server group.
|
|
16
|
+
* Use this operation to detect when instances are active or not available to host new game
|
|
17
|
+
* servers.</p>
|
|
19
18
|
* <p>To request status for all instances in the game server group, provide a game server
|
|
20
19
|
* group ID only. To request status for specific instances, provide the game server group
|
|
21
20
|
* ID and one or more instance IDs. Use the pagination parameters to retrieve results in
|
|
22
21
|
* sequential segments. If successful, a collection of <code>GameServerInstance</code>
|
|
23
|
-
* objects is returned.
|
|
24
|
-
*
|
|
25
|
-
* </p>
|
|
22
|
+
* objects is returned. </p>
|
|
26
23
|
* <p>This operation is not designed to be called with every game server claim request; this
|
|
27
24
|
* practice can cause you to exceed your API limit, which results in errors. Instead, as a
|
|
28
25
|
* best practice, cache the results and refresh your cache no more than once every 10
|
|
@@ -31,22 +28,9 @@ export interface DescribeGameServerInstancesCommandOutput extends DescribeGameSe
|
|
|
31
28
|
* <b>Learn more</b>
|
|
32
29
|
* </p>
|
|
33
30
|
* <p>
|
|
34
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ
|
|
31
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ
|
|
32
|
+
* Guide</a>
|
|
35
33
|
* </p>
|
|
36
|
-
* <p>
|
|
37
|
-
* <b>Related actions</b>
|
|
38
|
-
* </p>
|
|
39
|
-
* <p>
|
|
40
|
-
* <a>CreateGameServerGroup</a> |
|
|
41
|
-
* <a>ListGameServerGroups</a> |
|
|
42
|
-
* <a>DescribeGameServerGroup</a> |
|
|
43
|
-
* <a>UpdateGameServerGroup</a> |
|
|
44
|
-
* <a>DeleteGameServerGroup</a> |
|
|
45
|
-
* <a>ResumeGameServerGroup</a> |
|
|
46
|
-
* <a>SuspendGameServerGroup</a> |
|
|
47
|
-
* <a>DescribeGameServerInstances</a> |
|
|
48
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html">All APIs by task</a>
|
|
49
|
-
* </p>
|
|
50
34
|
* @example
|
|
51
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
52
36
|
* ```javascript
|
|
@@ -10,9 +10,7 @@ export interface DescribeGameSessionDetailsCommandOutput extends DescribeGameSes
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Retrieves additional game session properties, including the game session protection
|
|
12
12
|
* policy in force, a set of one or more game sessions in a specific fleet location. You
|
|
13
|
-
* can optionally filter the results by current game session status
|
|
14
|
-
* <a>SearchGameSessions</a> to request a set of active game sessions that
|
|
15
|
-
* are filtered by certain criteria. To retrieve all game session properties, use <a>DescribeGameSessions</a>. </p>
|
|
13
|
+
* can optionally filter the results by current game session status.</p>
|
|
16
14
|
* <p>This operation can be used in the following ways: </p>
|
|
17
15
|
* <ul>
|
|
18
16
|
* <li>
|
|
@@ -29,32 +27,20 @@ export interface DescribeGameSessionDetailsCommandOutput extends DescribeGameSes
|
|
|
29
27
|
* </li>
|
|
30
28
|
* <li>
|
|
31
29
|
* <p>To retrieve details for a specific game session, provide the game session ID.
|
|
32
|
-
* This approach looks for the game session ID in all fleets that reside in the
|
|
33
|
-
* Region defined in the request.</p>
|
|
30
|
+
* This approach looks for the game session ID in all fleets that reside in the
|
|
31
|
+
* Amazon Web Services Region defined in the request.</p>
|
|
34
32
|
* </li>
|
|
35
33
|
* </ul>
|
|
36
34
|
* <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p>
|
|
37
35
|
* <p>If successful, a <code>GameSessionDetail</code> object is returned for each game
|
|
38
36
|
* session that matches the request.</p>
|
|
39
|
-
*
|
|
37
|
+
* <p>
|
|
40
38
|
* <b>Learn more</b>
|
|
41
39
|
* </p>
|
|
42
|
-
*
|
|
40
|
+
* <p>
|
|
43
41
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-find">Find a game session</a>
|
|
44
42
|
* </p>
|
|
45
|
-
*
|
|
46
|
-
* <b>Related actions</b>
|
|
47
|
-
* </p>
|
|
48
|
-
* <p>
|
|
49
|
-
* <a>CreateGameSession</a> |
|
|
50
|
-
* <a>DescribeGameSessions</a> |
|
|
51
|
-
* <a>DescribeGameSessionDetails</a> |
|
|
52
|
-
* <a>SearchGameSessions</a> |
|
|
53
|
-
* <a>UpdateGameSession</a> |
|
|
54
|
-
* <a>GetGameSessionLogUrl</a> |
|
|
55
|
-
* <a>StartGameSessionPlacement</a> |
|
|
56
|
-
* <a>DescribeGameSessionPlacement</a> |
|
|
57
|
-
* <a>StopGameSessionPlacement</a> |
|
|
43
|
+
* <p>
|
|
58
44
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
59
45
|
* </p>
|
|
60
46
|
* @example
|
|
@@ -8,32 +8,14 @@ export interface DescribeGameSessionPlacementCommandInput extends DescribeGameSe
|
|
|
8
8
|
export interface DescribeGameSessionPlacementCommandOutput extends DescribeGameSessionPlacementOutput, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Retrieves information, including current status, about a game session placement
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
* This
|
|
15
|
-
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*
|
|
19
|
-
* </p>
|
|
20
|
-
*
|
|
21
|
-
* <p>If successful, a <a>GameSessionPlacement</a> object is returned.</p>
|
|
22
|
-
* <p>
|
|
23
|
-
* <b>Related actions</b>
|
|
24
|
-
* </p>
|
|
25
|
-
* <p>
|
|
26
|
-
* <a>CreateGameSession</a> |
|
|
27
|
-
* <a>DescribeGameSessions</a> |
|
|
28
|
-
* <a>DescribeGameSessionDetails</a> |
|
|
29
|
-
* <a>SearchGameSessions</a> |
|
|
30
|
-
* <a>UpdateGameSession</a> |
|
|
31
|
-
* <a>GetGameSessionLogUrl</a> |
|
|
32
|
-
* <a>StartGameSessionPlacement</a> |
|
|
33
|
-
* <a>DescribeGameSessionPlacement</a> |
|
|
34
|
-
* <a>StopGameSessionPlacement</a> |
|
|
35
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
36
|
-
* </p>
|
|
11
|
+
* <p>Retrieves information, including current status, about a game session placement
|
|
12
|
+
* request. </p>
|
|
13
|
+
* <p>To get game session placement details, specify the placement ID.</p>
|
|
14
|
+
* <p>This operation is not designed to be continually called to track game session status.
|
|
15
|
+
* This practice can cause you to exceed your API limit, which results in errors. Instead,
|
|
16
|
+
* you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from
|
|
17
|
+
* FlexMatch or queues. Continuously polling with <code>DescribeGameSessionPlacement</code>
|
|
18
|
+
* should only be used for games in development with low game session usage. </p>
|
|
37
19
|
* @example
|
|
38
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
39
21
|
* ```javascript
|
|
@@ -8,32 +8,17 @@ export interface DescribeGameSessionQueuesCommandInput extends DescribeGameSessi
|
|
|
8
8
|
export interface DescribeGameSessionQueuesCommandOutput extends DescribeGameSessionQueuesOutput, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Retrieves the properties for one or more game session queues. When requesting
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
* for queues that currently exist in the Region.</p>
|
|
11
|
+
* <p>Retrieves the properties for one or more game session queues. When requesting multiple
|
|
12
|
+
* queues, use the pagination parameters to retrieve results as a set of sequential pages.
|
|
13
|
+
* When specifying a list of queues, objects are returned only for queues that currently
|
|
14
|
+
* exist in the Region.</p>
|
|
16
15
|
* <p>
|
|
17
16
|
* <b>Learn more</b>
|
|
18
17
|
* </p>
|
|
19
18
|
* <p>
|
|
20
19
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-console.html">
|
|
21
|
-
*
|
|
20
|
+
* View Your Queues</a>
|
|
22
21
|
* </p>
|
|
23
|
-
* <p>
|
|
24
|
-
* <b>Related actions</b>
|
|
25
|
-
* </p>
|
|
26
|
-
* <p>
|
|
27
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html">CreateGameSessionQueue</a>
|
|
28
|
-
* |
|
|
29
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html">DescribeGameSessionQueues</a>
|
|
30
|
-
* |
|
|
31
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html">UpdateGameSessionQueue</a>
|
|
32
|
-
* |
|
|
33
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteGameSessionQueue.html">DeleteGameSessionQueue</a>
|
|
34
|
-
* |
|
|
35
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
36
|
-
* </p>
|
|
37
22
|
* @example
|
|
38
23
|
* Use a bare-bones client and the command you need to make an API call.
|
|
39
24
|
* ```javascript
|
|
@@ -9,17 +9,7 @@ export interface DescribeGameSessionsCommandOutput extends DescribeGameSessionsO
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Retrieves a set of one or more game sessions in a specific fleet location. You can
|
|
12
|
-
* optionally filter the results by current game session status
|
|
13
|
-
* filtered by certain criteria. To retrieve the protection policy for game sessions, use
|
|
14
|
-
* <a>DescribeGameSessionDetails</a>.</p>
|
|
15
|
-
* <p>This operation is not designed to be continually called to track game session status.
|
|
16
|
-
* This practice can cause you to exceed your API limit, which results in errors. Instead,
|
|
17
|
-
* you must configure configure an
|
|
18
|
-
* Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling
|
|
19
|
-
* with <code>DescribeGameSessions</code> should only be used for games in development with
|
|
20
|
-
* low game session usage.
|
|
21
|
-
* </p>
|
|
22
|
-
*
|
|
12
|
+
* optionally filter the results by current game session status.</p>
|
|
23
13
|
* <p>This operation can be used in the following ways: </p>
|
|
24
14
|
* <ul>
|
|
25
15
|
* <li>
|
|
@@ -43,34 +33,21 @@ export interface DescribeGameSessionsCommandOutput extends DescribeGameSessionsO
|
|
|
43
33
|
* <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p>
|
|
44
34
|
* <p>If successful, a <code>GameSession</code> object is returned for each game session
|
|
45
35
|
* that matches the request.</p>
|
|
46
|
-
* <p>This operation is not designed to be continually called to track
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
* with low matchmaking usage.</p>
|
|
36
|
+
* <p>This operation is not designed to be continually called to track game session status.
|
|
37
|
+
* This practice can cause you to exceed your API limit, which results in errors. Instead,
|
|
38
|
+
* you must configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or
|
|
39
|
+
* queues. Continuously polling with <code>DescribeGameSessions</code> should only be used
|
|
40
|
+
* for games in development with low game session usage. </p>
|
|
52
41
|
* <p>
|
|
53
42
|
* <i>Available in Amazon GameLift Local.</i>
|
|
54
43
|
* </p>
|
|
55
|
-
*
|
|
44
|
+
* <p>
|
|
56
45
|
* <b>Learn more</b>
|
|
57
46
|
* </p>
|
|
58
|
-
*
|
|
47
|
+
* <p>
|
|
59
48
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-find">Find a game session</a>
|
|
60
49
|
* </p>
|
|
61
|
-
*
|
|
62
|
-
* <b>Related actions</b>
|
|
63
|
-
* </p>
|
|
64
|
-
* <p>
|
|
65
|
-
* <a>CreateGameSession</a> |
|
|
66
|
-
* <a>DescribeGameSessions</a> |
|
|
67
|
-
* <a>DescribeGameSessionDetails</a> |
|
|
68
|
-
* <a>SearchGameSessions</a> |
|
|
69
|
-
* <a>UpdateGameSession</a> |
|
|
70
|
-
* <a>GetGameSessionLogUrl</a> |
|
|
71
|
-
* <a>StartGameSessionPlacement</a> |
|
|
72
|
-
* <a>DescribeGameSessionPlacement</a> |
|
|
73
|
-
* <a>StopGameSessionPlacement</a> |
|
|
50
|
+
* <p>
|
|
74
51
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
75
52
|
* </p>
|
|
76
53
|
* @example
|
|
@@ -32,19 +32,17 @@ export interface DescribeInstancesCommandOutput extends DescribeInstancesOutput,
|
|
|
32
32
|
* <b>Learn more</b>
|
|
33
33
|
* </p>
|
|
34
34
|
* <p>
|
|
35
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html">Remotely Access Fleet
|
|
35
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html">Remotely Access Fleet
|
|
36
|
+
* Instances</a>
|
|
36
37
|
* </p>
|
|
37
38
|
* <p>
|
|
38
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html">Debug Fleet
|
|
39
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html">Debug Fleet
|
|
40
|
+
* Issues</a>
|
|
39
41
|
* </p>
|
|
40
|
-
*
|
|
41
|
-
* <p>
|
|
42
|
+
* <p>
|
|
42
43
|
* <b>Related actions</b>
|
|
43
44
|
* </p>
|
|
44
45
|
* <p>
|
|
45
|
-
* <a>DescribeInstances</a> |
|
|
46
|
-
* <a>GetInstanceAccess</a> |
|
|
47
|
-
* <a>DescribeEC2InstanceLimits</a> |
|
|
48
46
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
49
47
|
* </p>
|
|
50
48
|
* @example
|
|
@@ -11,37 +11,24 @@ export interface DescribeMatchmakingCommandOutput extends DescribeMatchmakingOut
|
|
|
11
11
|
* <p>Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket
|
|
12
12
|
* information, including--after a successful match is made--connection information for the
|
|
13
13
|
* resulting new game session. </p>
|
|
14
|
-
* <p>To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the
|
|
15
|
-
*
|
|
14
|
+
* <p>To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request
|
|
15
|
+
* is successful, a ticket object is returned for each requested ID that currently
|
|
16
16
|
* exists.</p>
|
|
17
17
|
* <p>This operation is not designed to be continually called to track matchmaking ticket
|
|
18
18
|
* status. This practice can cause you to exceed your API limit, which results in errors.
|
|
19
19
|
* Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide
|
|
20
|
-
* the topic ARN in the matchmaking configuration
|
|
21
|
-
* <a>DescribeMatchmaking</a> should only be used for games in development
|
|
22
|
-
* with low matchmaking usage.</p>
|
|
20
|
+
* the topic ARN in the matchmaking configuration.</p>
|
|
23
21
|
* <p></p>
|
|
24
22
|
* <p>
|
|
25
23
|
* <b>Learn more</b>
|
|
26
24
|
* </p>
|
|
27
25
|
* <p>
|
|
28
26
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html">
|
|
29
|
-
*
|
|
27
|
+
* Add FlexMatch to a game client</a>
|
|
30
28
|
* </p>
|
|
31
29
|
* <p>
|
|
32
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html">
|
|
33
|
-
*
|
|
34
|
-
* </p>
|
|
35
|
-
* <p>
|
|
36
|
-
* <b>Related actions</b>
|
|
37
|
-
* </p>
|
|
38
|
-
* <p>
|
|
39
|
-
* <a>StartMatchmaking</a> |
|
|
40
|
-
* <a>DescribeMatchmaking</a> |
|
|
41
|
-
* <a>StopMatchmaking</a> |
|
|
42
|
-
* <a>AcceptMatch</a> |
|
|
43
|
-
* <a>StartMatchBackfill</a> |
|
|
44
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
30
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html"> Set Up FlexMatch event
|
|
31
|
+
* notification</a>
|
|
45
32
|
* </p>
|
|
46
33
|
* @example
|
|
47
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -19,22 +19,7 @@ export interface DescribeMatchmakingConfigurationsCommandOutput extends Describe
|
|
|
19
19
|
* <b>Learn more</b>
|
|
20
20
|
* </p>
|
|
21
21
|
* <p>
|
|
22
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/matchmaker-build.html"> Setting up FlexMatch
|
|
23
|
-
* matchmakers</a>
|
|
24
|
-
* </p>
|
|
25
|
-
* <p>
|
|
26
|
-
* <b>Related actions</b>
|
|
27
|
-
* </p>
|
|
28
|
-
* <p>
|
|
29
|
-
* <a>CreateMatchmakingConfiguration</a> |
|
|
30
|
-
* <a>DescribeMatchmakingConfigurations</a> |
|
|
31
|
-
* <a>UpdateMatchmakingConfiguration</a> |
|
|
32
|
-
* <a>DeleteMatchmakingConfiguration</a> |
|
|
33
|
-
* <a>CreateMatchmakingRuleSet</a> |
|
|
34
|
-
* <a>DescribeMatchmakingRuleSets</a> |
|
|
35
|
-
* <a>ValidateMatchmakingRuleSet</a> |
|
|
36
|
-
* <a>DeleteMatchmakingRuleSet</a> |
|
|
37
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
22
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/matchmaker-build.html"> Setting up FlexMatch matchmakers</a>
|
|
38
23
|
* </p>
|
|
39
24
|
* @example
|
|
40
25
|
* Use a bare-bones client and the command you need to make an API call.
|