@aws-sdk/client-gamelift 3.315.0 → 3.317.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/GameLift.js +108 -1456
- 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/GameLift.js +108 -1456
- 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 +169 -2437
- 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/GameLift.d.ts +2 -1
- 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 +6 -6
|
@@ -23,56 +23,56 @@ export interface DescribeEC2InstanceLimitsCommandOutput extends DescribeEC2Insta
|
|
|
23
23
|
* Instance limits control the number of instances, per instance type, per location, that
|
|
24
24
|
* your Amazon Web Services account can use. Learn more at <a href="http://aws.amazon.com/ec2/instance-types/">Amazon EC2 Instance Types</a>. The information
|
|
25
25
|
* returned includes the maximum number of instances allowed and your account's current
|
|
26
|
-
* usage across all fleets. This information can affect your ability to scale your GameLift
|
|
27
|
-
* fleets. You can request a limit increase for your account by using the <b>Service limits</b> page in the GameLift console.</p>
|
|
28
|
-
*
|
|
26
|
+
* usage across all fleets. This information can affect your ability to scale your Amazon GameLift
|
|
27
|
+
* fleets. You can request a limit increase for your account by using the <b>Service limits</b> page in the Amazon GameLift console.</p>
|
|
28
|
+
* <p>Instance limits differ based on whether the instances are deployed in a fleet's home
|
|
29
29
|
* Region or in a remote location. For remote locations, limits also differ based on the
|
|
30
30
|
* combination of home Region and remote location. All requests must specify an Amazon Web Services
|
|
31
31
|
* Region (either explicitly or as your default settings). To get the limit for a remote
|
|
32
32
|
* location, you must also specify the location. For example, the following requests all
|
|
33
33
|
* return different results: </p>
|
|
34
|
-
*
|
|
34
|
+
* <ul>
|
|
35
35
|
* <li>
|
|
36
|
-
*
|
|
36
|
+
* <p>Request specifies the Region <code>ap-northeast-1</code> with no location. The
|
|
37
37
|
* result is limits and usage data on all instance types that are deployed in
|
|
38
38
|
* <code>us-east-2</code>, by all of the fleets that reside in
|
|
39
39
|
* <code>ap-northeast-1</code>. </p>
|
|
40
40
|
* </li>
|
|
41
41
|
* <li>
|
|
42
|
-
*
|
|
42
|
+
* <p>Request specifies the Region <code>us-east-1</code> with location
|
|
43
43
|
* <code>ca-central-1</code>. The result is limits and usage data on all
|
|
44
44
|
* instance types that are deployed in <code>ca-central-1</code>, by all of the
|
|
45
45
|
* fleets that reside in <code>us-east-2</code>. These limits do not affect fleets
|
|
46
46
|
* in any other Regions that deploy instances to <code>ca-central-1</code>.</p>
|
|
47
47
|
* </li>
|
|
48
48
|
* <li>
|
|
49
|
-
*
|
|
49
|
+
* <p>Request specifies the Region <code>eu-west-1</code> with location
|
|
50
50
|
* <code>ca-central-1</code>. The result is limits and usage data on all
|
|
51
51
|
* instance types that are deployed in <code>ca-central-1</code>, by all of the
|
|
52
52
|
* fleets that reside in <code>eu-west-1</code>.</p>
|
|
53
53
|
* </li>
|
|
54
54
|
* </ul>
|
|
55
|
-
*
|
|
56
|
-
*
|
|
55
|
+
* <p>This operation can be used in the following ways:</p>
|
|
56
|
+
* <ul>
|
|
57
57
|
* <li>
|
|
58
|
-
*
|
|
58
|
+
* <p>To get limit and usage data for all instance types that are deployed in an
|
|
59
59
|
* Amazon Web Services Region by fleets that reside in the same Region: Specify the Region only.
|
|
60
60
|
* Optionally, specify a single instance type to retrieve information for.</p>
|
|
61
61
|
* </li>
|
|
62
62
|
* <li>
|
|
63
|
-
*
|
|
63
|
+
* <p>To get limit and usage data for all instance types that are deployed to a
|
|
64
64
|
* remote location by fleets that reside in different Amazon Web Services Region: Provide both
|
|
65
65
|
* the Amazon Web Services Region and the remote location. Optionally, specify a single instance
|
|
66
66
|
* type to retrieve information for.</p>
|
|
67
67
|
* </li>
|
|
68
68
|
* </ul>
|
|
69
|
-
*
|
|
69
|
+
* <p>If successful, an <code>EC2InstanceLimits</code> object is returned with limits and
|
|
70
70
|
* usage data for each requested instance type.</p>
|
|
71
|
-
*
|
|
71
|
+
* <p>
|
|
72
72
|
* <b>Learn more</b>
|
|
73
73
|
* </p>
|
|
74
|
-
*
|
|
75
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift fleets</a>
|
|
74
|
+
* <p>
|
|
75
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift fleets</a>
|
|
76
76
|
* </p>
|
|
77
77
|
* @example
|
|
78
78
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -21,30 +21,30 @@ export interface DescribeFleetAttributesCommandOutput extends DescribeFleetAttri
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Retrieves core fleet-wide properties, including the computing hardware and deployment
|
|
23
23
|
* configuration for all instances in the fleet.</p>
|
|
24
|
-
*
|
|
25
|
-
*
|
|
24
|
+
* <p>This operation can be used in the following ways: </p>
|
|
25
|
+
* <ul>
|
|
26
26
|
* <li>
|
|
27
|
-
*
|
|
27
|
+
* <p>To get attributes for one or more specific fleets, provide a list of fleet IDs
|
|
28
28
|
* or fleet ARNs. </p>
|
|
29
29
|
* </li>
|
|
30
30
|
* <li>
|
|
31
|
-
*
|
|
31
|
+
* <p>To get attributes for all fleets, do not provide a fleet identifier. </p>
|
|
32
32
|
* </li>
|
|
33
33
|
* </ul>
|
|
34
|
-
*
|
|
34
|
+
* <p>When requesting attributes for multiple fleets, use the pagination parameters to
|
|
35
35
|
* retrieve results as a set of sequential pages. </p>
|
|
36
|
-
*
|
|
36
|
+
* <p>If successful, a <code>FleetAttributes</code> object is returned for each fleet
|
|
37
37
|
* requested, unless the fleet identifier is not found. </p>
|
|
38
|
-
*
|
|
38
|
+
* <note>
|
|
39
39
|
* <p>Some API operations limit the number of fleet IDs that allowed in one request. If
|
|
40
40
|
* a request exceeds this limit, the request fails and the error message contains the
|
|
41
41
|
* maximum allowed number.</p>
|
|
42
|
-
*
|
|
42
|
+
* </note>
|
|
43
43
|
* <p>
|
|
44
44
|
* <b>Learn more</b>
|
|
45
45
|
* </p>
|
|
46
46
|
* <p>
|
|
47
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
|
|
47
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift
|
|
48
48
|
* fleets</a>
|
|
49
49
|
* </p>
|
|
50
50
|
* @example
|
|
@@ -23,36 +23,36 @@ export interface DescribeFleetCapacityCommandOutput extends DescribeFleetCapacit
|
|
|
23
23
|
* includes the current fleet capacity (number of EC2 instances), and settings that can
|
|
24
24
|
* control how capacity scaling. For fleets with remote locations, this operation retrieves
|
|
25
25
|
* data for the fleet's home Region only.</p>
|
|
26
|
-
*
|
|
27
|
-
*
|
|
26
|
+
* <p>This operation can be used in the following ways: </p>
|
|
27
|
+
* <ul>
|
|
28
28
|
* <li>
|
|
29
|
-
*
|
|
29
|
+
* <p>To get capacity data for one or more specific fleets, provide a list of fleet
|
|
30
30
|
* IDs or fleet ARNs. </p>
|
|
31
31
|
* </li>
|
|
32
32
|
* <li>
|
|
33
|
-
*
|
|
33
|
+
* <p>To get capacity data for all fleets, do not provide a fleet identifier.
|
|
34
34
|
* </p>
|
|
35
35
|
* </li>
|
|
36
36
|
* </ul>
|
|
37
|
-
*
|
|
37
|
+
* <p>When requesting multiple fleets, use the pagination parameters to retrieve results as
|
|
38
38
|
* a set of sequential pages. </p>
|
|
39
|
-
*
|
|
39
|
+
* <p>If successful, a <code>FleetCapacity</code> object is returned for each requested
|
|
40
40
|
* fleet ID. Each FleetCapacity object includes a <code>Location</code> property, which is
|
|
41
41
|
* set to the fleet's home Region. When a list of fleet IDs is provided, attribute objects
|
|
42
42
|
* are returned only for fleets that currently exist.</p>
|
|
43
|
-
*
|
|
43
|
+
* <note>
|
|
44
44
|
* <p>Some API operations may limit the number of fleet IDs that are allowed in one
|
|
45
45
|
* request. If a request exceeds this limit, the request fails and the error message
|
|
46
46
|
* includes the maximum allowed.</p>
|
|
47
|
-
*
|
|
47
|
+
* </note>
|
|
48
48
|
* <p>
|
|
49
49
|
* <b>Learn more</b>
|
|
50
50
|
* </p>
|
|
51
51
|
* <p>
|
|
52
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
|
|
52
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift
|
|
53
53
|
* fleets</a>
|
|
54
54
|
* </p>
|
|
55
|
-
*
|
|
55
|
+
* <p>
|
|
56
56
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet">GameLift metrics for fleets</a>
|
|
57
57
|
* </p>
|
|
58
58
|
* @example
|
|
@@ -23,15 +23,15 @@ export interface DescribeFleetEventsCommandOutput extends DescribeFleetEventsOut
|
|
|
23
23
|
* status, such as during fleet creation and termination, changes in capacity, etc. If a
|
|
24
24
|
* fleet has multiple locations, events are also initiated by changes to status and
|
|
25
25
|
* capacity in remote locations. </p>
|
|
26
|
-
*
|
|
26
|
+
* <p>You can specify a time range to limit the result set. Use the pagination parameters to
|
|
27
27
|
* retrieve results as a set of sequential pages. </p>
|
|
28
|
-
*
|
|
28
|
+
* <p>If successful, a collection of event log entries matching the request are
|
|
29
29
|
* returned.</p>
|
|
30
30
|
* <p>
|
|
31
31
|
* <b>Learn more</b>
|
|
32
32
|
* </p>
|
|
33
33
|
* <p>
|
|
34
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
|
|
34
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift
|
|
35
35
|
* fleets</a>
|
|
36
36
|
* </p>
|
|
37
37
|
* @example
|
|
@@ -21,20 +21,20 @@ export interface DescribeFleetLocationAttributesCommandOutput extends DescribeFl
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Retrieves information on a fleet's remote locations, including life-cycle status and
|
|
23
23
|
* any suspended fleet activity. </p>
|
|
24
|
-
*
|
|
25
|
-
*
|
|
24
|
+
* <p>This operation can be used in the following ways: </p>
|
|
25
|
+
* <ul>
|
|
26
26
|
* <li>
|
|
27
|
-
*
|
|
27
|
+
* <p>To get data for specific locations, provide a fleet identifier and a list of
|
|
28
28
|
* locations. Location data is returned in the order that it is requested. </p>
|
|
29
29
|
* </li>
|
|
30
30
|
* <li>
|
|
31
|
-
*
|
|
31
|
+
* <p>To get data for all locations, provide a fleet identifier only. Location data
|
|
32
32
|
* is returned in no particular order. </p>
|
|
33
33
|
* </li>
|
|
34
34
|
* </ul>
|
|
35
|
-
*
|
|
35
|
+
* <p>When requesting attributes for multiple locations, use the pagination parameters to
|
|
36
36
|
* retrieve results as a set of sequential pages. </p>
|
|
37
|
-
*
|
|
37
|
+
* <p>If successful, a <code>LocationAttributes</code> object is returned for each requested
|
|
38
38
|
* location. If the fleet does not have a requested location, no information is returned.
|
|
39
39
|
* This operation does not return the home Region. To get information on a fleet's home
|
|
40
40
|
* Region, call <code>DescribeFleetAttributes</code>.</p>
|
|
@@ -43,7 +43,7 @@ export interface DescribeFleetLocationAttributesCommandOutput extends DescribeFl
|
|
|
43
43
|
* </p>
|
|
44
44
|
* <p>
|
|
45
45
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting
|
|
46
|
-
* up GameLift fleets</a>
|
|
46
|
+
* up Amazon GameLift fleets</a>
|
|
47
47
|
* </p>
|
|
48
48
|
* @example
|
|
49
49
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -24,17 +24,17 @@ export interface DescribeFleetLocationCapacityCommandOutput extends DescribeFlee
|
|
|
24
24
|
* the requested fleet location. Use this operation to retrieve capacity information for a
|
|
25
25
|
* fleet's remote location or home Region (you can also retrieve home Region capacity by
|
|
26
26
|
* calling <code>DescribeFleetCapacity</code>).</p>
|
|
27
|
-
*
|
|
28
|
-
*
|
|
27
|
+
* <p>To retrieve capacity data, identify a fleet and location. </p>
|
|
28
|
+
* <p>If successful, a <code>FleetCapacity</code> object is returned for the requested fleet
|
|
29
29
|
* location. </p>
|
|
30
30
|
* <p>
|
|
31
31
|
* <b>Learn more</b>
|
|
32
32
|
* </p>
|
|
33
33
|
* <p>
|
|
34
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
|
|
34
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift
|
|
35
35
|
* fleets</a>
|
|
36
36
|
* </p>
|
|
37
|
-
*
|
|
37
|
+
* <p>
|
|
38
38
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet">GameLift metrics for fleets</a>
|
|
39
39
|
* </p>
|
|
40
40
|
* @example
|
|
@@ -24,17 +24,17 @@ export interface DescribeFleetLocationUtilizationCommandOutput extends DescribeF
|
|
|
24
24
|
* to retrieve utilization information for a fleet's remote location or home Region (you
|
|
25
25
|
* can also retrieve home Region utilization by calling
|
|
26
26
|
* <code>DescribeFleetUtilization</code>).</p>
|
|
27
|
-
*
|
|
28
|
-
*
|
|
27
|
+
* <p>To retrieve utilization data, identify a fleet and location. </p>
|
|
28
|
+
* <p>If successful, a <code>FleetUtilization</code> object is returned for the requested
|
|
29
29
|
* fleet location. </p>
|
|
30
30
|
* <p>
|
|
31
31
|
* <b>Learn more</b>
|
|
32
32
|
* </p>
|
|
33
33
|
* <p>
|
|
34
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
|
|
34
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift
|
|
35
35
|
* fleets</a>
|
|
36
36
|
* </p>
|
|
37
|
-
*
|
|
37
|
+
* <p>
|
|
38
38
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet">GameLift metrics for fleets</a>
|
|
39
39
|
* </p>
|
|
40
40
|
* @example
|
|
@@ -23,26 +23,26 @@ export interface DescribeFleetPortSettingsCommandOutput extends DescribeFleetPor
|
|
|
23
23
|
* range of IP addresses and port settings that incoming traffic can use to access server
|
|
24
24
|
* processes in the fleet. Game sessions that are running on instances in the fleet must
|
|
25
25
|
* use connections that fall in this range.</p>
|
|
26
|
-
*
|
|
27
|
-
*
|
|
26
|
+
* <p>This operation can be used in the following ways: </p>
|
|
27
|
+
* <ul>
|
|
28
28
|
* <li>
|
|
29
|
-
*
|
|
29
|
+
* <p>To retrieve the inbound connection permissions for a fleet, identify the
|
|
30
30
|
* fleet's unique identifier. </p>
|
|
31
31
|
* </li>
|
|
32
32
|
* <li>
|
|
33
|
-
*
|
|
33
|
+
* <p>To check the status of recent updates to a fleet remote location, specify the
|
|
34
34
|
* fleet ID and a location. Port setting updates can take time to propagate across
|
|
35
35
|
* all locations. </p>
|
|
36
36
|
* </li>
|
|
37
37
|
* </ul>
|
|
38
|
-
*
|
|
38
|
+
* <p>If successful, a set of <code>IpPermission</code> objects is returned for the
|
|
39
39
|
* requested fleet ID. When a location is specified, a pending status is included. If the
|
|
40
40
|
* requested fleet has been deleted, the result set is empty.</p>
|
|
41
41
|
* <p>
|
|
42
42
|
* <b>Learn more</b>
|
|
43
43
|
* </p>
|
|
44
|
-
*
|
|
45
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
|
|
44
|
+
* <p>
|
|
45
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift
|
|
46
46
|
* fleets</a>
|
|
47
47
|
* </p>
|
|
48
48
|
* @example
|
|
@@ -24,35 +24,35 @@ export interface DescribeFleetUtilizationCommandOutput extends DescribeFleetUtil
|
|
|
24
24
|
* remote locations, this operation retrieves data for the fleet's home Region only. See
|
|
25
25
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationUtilization.html">DescribeFleetLocationUtilization</a> to get utilization statistics for a
|
|
26
26
|
* fleet's remote locations.</p>
|
|
27
|
-
*
|
|
28
|
-
*
|
|
27
|
+
* <p>This operation can be used in the following ways: </p>
|
|
28
|
+
* <ul>
|
|
29
29
|
* <li>
|
|
30
|
-
*
|
|
30
|
+
* <p>To get utilization data for one or more specific fleets, provide a list of
|
|
31
31
|
* fleet IDs or fleet ARNs. </p>
|
|
32
32
|
* </li>
|
|
33
33
|
* <li>
|
|
34
|
-
*
|
|
34
|
+
* <p>To get utilization data for all fleets, do not provide a fleet identifier.
|
|
35
35
|
* </p>
|
|
36
36
|
* </li>
|
|
37
37
|
* </ul>
|
|
38
|
-
*
|
|
38
|
+
* <p>When requesting multiple fleets, use the pagination parameters to retrieve results as
|
|
39
39
|
* a set of sequential pages. </p>
|
|
40
|
-
*
|
|
40
|
+
* <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
|
|
41
41
|
* fleet identifier is not found. Each fleet utilization object includes a
|
|
42
42
|
* <code>Location</code> property, which is set to the fleet's home Region. </p>
|
|
43
|
-
*
|
|
43
|
+
* <note>
|
|
44
44
|
* <p>Some API operations may limit the number of fleet IDs allowed in one request. If a
|
|
45
45
|
* request exceeds this limit, the request fails and the error message includes the
|
|
46
46
|
* maximum allowed.</p>
|
|
47
|
-
*
|
|
47
|
+
* </note>
|
|
48
48
|
* <p>
|
|
49
49
|
* <b>Learn more</b>
|
|
50
50
|
* </p>
|
|
51
51
|
* <p>
|
|
52
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
|
|
52
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift
|
|
53
53
|
* Fleets</a>
|
|
54
54
|
* </p>
|
|
55
|
-
*
|
|
55
|
+
* <p>
|
|
56
56
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet">GameLift Metrics for Fleets</a>
|
|
57
57
|
* </p>
|
|
58
58
|
* @example
|
|
@@ -20,20 +20,20 @@ export interface DescribeGameServerCommandOutput extends DescribeGameServerOutpu
|
|
|
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>Retrieves information for a
|
|
26
26
|
* registered game server. Information includes game server status, health check info, and
|
|
27
27
|
* the instance that the game server is running on. </p>
|
|
28
|
-
*
|
|
28
|
+
* <p>To retrieve game server information, specify the game server ID. If successful, the
|
|
29
29
|
* requested game server object is returned. </p>
|
|
30
|
-
*
|
|
30
|
+
* <p>
|
|
31
31
|
* <b>Learn more</b>
|
|
32
32
|
* </p>
|
|
33
|
-
*
|
|
34
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ
|
|
33
|
+
* <p>
|
|
34
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">Amazon GameLift FleetIQ
|
|
35
35
|
* Guide</a>
|
|
36
|
-
*
|
|
36
|
+
* </p>
|
|
37
37
|
* @example
|
|
38
38
|
* Use a bare-bones client and the command you need to make an API call.
|
|
39
39
|
* ```javascript
|
|
@@ -20,22 +20,22 @@ export interface DescribeGameServerGroupCommandOutput extends DescribeGameServer
|
|
|
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>Retrieves information on a
|
|
26
|
-
* game server group. This operation returns only properties related to GameLift FleetIQ. To view or
|
|
26
|
+
* game server group. This operation returns only properties related to Amazon GameLift FleetIQ. To view or
|
|
27
27
|
* update properties for the corresponding Auto Scaling group, such as launch template,
|
|
28
28
|
* auto scaling policies, and maximum/minimum group size, access the Auto Scaling group
|
|
29
29
|
* directly.</p>
|
|
30
|
-
*
|
|
30
|
+
* <p>To get attributes for a game server group, provide a group name or ARN value. If
|
|
31
31
|
* successful, a <code>GameServerGroup</code> object is returned.</p>
|
|
32
|
-
*
|
|
32
|
+
* <p>
|
|
33
33
|
* <b>Learn more</b>
|
|
34
34
|
* </p>
|
|
35
|
-
*
|
|
36
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ
|
|
35
|
+
* <p>
|
|
36
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">Amazon GameLift FleetIQ
|
|
37
37
|
* Guide</a>
|
|
38
|
-
*
|
|
38
|
+
* </p>
|
|
39
39
|
* @example
|
|
40
40
|
* Use a bare-bones client and the command you need to make an API call.
|
|
41
41
|
* ```javascript
|
|
@@ -20,28 +20,28 @@ export interface DescribeGameServerInstancesCommandOutput extends DescribeGameSe
|
|
|
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>Retrieves status
|
|
26
|
-
* information about the Amazon EC2 instances associated with a GameLift FleetIQ game server group.
|
|
26
|
+
* information about the Amazon EC2 instances associated with a Amazon GameLift FleetIQ game server group.
|
|
27
27
|
* Use this operation to detect when instances are active or not available to host new game
|
|
28
28
|
* servers.</p>
|
|
29
|
-
*
|
|
29
|
+
* <p>To request status for all instances in the game server group, provide a game server
|
|
30
30
|
* group ID only. To request status for specific instances, provide the game server group
|
|
31
31
|
* ID and one or more instance IDs. Use the pagination parameters to retrieve results in
|
|
32
32
|
* sequential segments. If successful, a collection of <code>GameServerInstance</code>
|
|
33
33
|
* objects is returned. </p>
|
|
34
|
-
*
|
|
34
|
+
* <p>This operation is not designed to be called with every game server claim request; this
|
|
35
35
|
* practice can cause you to exceed your API limit, which results in errors. Instead, as a
|
|
36
36
|
* best practice, cache the results and refresh your cache no more than once every 10
|
|
37
37
|
* seconds.</p>
|
|
38
|
-
*
|
|
38
|
+
* <p>
|
|
39
39
|
* <b>Learn more</b>
|
|
40
40
|
* </p>
|
|
41
|
-
*
|
|
42
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ
|
|
41
|
+
* <p>
|
|
42
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">Amazon GameLift FleetIQ
|
|
43
43
|
* Guide</a>
|
|
44
|
-
*
|
|
44
|
+
* </p>
|
|
45
45
|
* @example
|
|
46
46
|
* Use a bare-bones client and the command you need to make an API call.
|
|
47
47
|
* ```javascript
|
|
@@ -22,28 +22,28 @@ export interface DescribeGameSessionDetailsCommandOutput extends DescribeGameSes
|
|
|
22
22
|
* <p>Retrieves additional game session properties, including the game session protection
|
|
23
23
|
* policy in force, a set of one or more game sessions in a specific fleet location. You
|
|
24
24
|
* can optionally filter the results by current game session status.</p>
|
|
25
|
-
*
|
|
26
|
-
*
|
|
25
|
+
* <p>This operation can be used in the following ways: </p>
|
|
26
|
+
* <ul>
|
|
27
27
|
* <li>
|
|
28
|
-
*
|
|
28
|
+
* <p>To retrieve details for all game sessions that are currently running on all
|
|
29
29
|
* locations in a fleet, provide a fleet or alias ID, with an optional status
|
|
30
30
|
* filter. This approach returns details from the fleet's home Region and all
|
|
31
31
|
* remote locations.</p>
|
|
32
32
|
* </li>
|
|
33
33
|
* <li>
|
|
34
|
-
*
|
|
34
|
+
* <p>To retrieve details for all game sessions that are currently running on a
|
|
35
35
|
* specific fleet location, provide a fleet or alias ID and a location name, with
|
|
36
36
|
* optional status filter. The location can be the fleet's home Region or any
|
|
37
37
|
* remote location.</p>
|
|
38
38
|
* </li>
|
|
39
39
|
* <li>
|
|
40
|
-
*
|
|
40
|
+
* <p>To retrieve details for a specific game session, provide the game session ID.
|
|
41
41
|
* This approach looks for the game session ID in all fleets that reside in the
|
|
42
42
|
* Amazon Web Services Region defined in the request.</p>
|
|
43
43
|
* </li>
|
|
44
44
|
* </ul>
|
|
45
|
-
*
|
|
46
|
-
*
|
|
45
|
+
* <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p>
|
|
46
|
+
* <p>If successful, a <code>GameSessionDetail</code> object is returned for each game
|
|
47
47
|
* session that matches the request.</p>
|
|
48
48
|
* <p>
|
|
49
49
|
* <b>Learn more</b>
|
|
@@ -52,7 +52,7 @@ export interface DescribeGameSessionDetailsCommandOutput extends DescribeGameSes
|
|
|
52
52
|
* <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>
|
|
53
53
|
* </p>
|
|
54
54
|
* <p>
|
|
55
|
-
*
|
|
55
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
56
56
|
* </p>
|
|
57
57
|
* @example
|
|
58
58
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -21,8 +21,8 @@ export interface DescribeGameSessionPlacementCommandOutput extends DescribeGameS
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Retrieves information, including current status, about a game session placement
|
|
23
23
|
* request. </p>
|
|
24
|
-
*
|
|
25
|
-
*
|
|
24
|
+
* <p>To get game session placement details, specify the placement ID.</p>
|
|
25
|
+
* <p>This operation is not designed to be continually called to track game session status.
|
|
26
26
|
* This practice can cause you to exceed your API limit, which results in errors. Instead,
|
|
27
27
|
* you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from
|
|
28
28
|
* FlexMatch or queues. Continuously polling with <code>DescribeGameSessionPlacement</code>
|
|
@@ -23,13 +23,13 @@ export interface DescribeGameSessionQueuesCommandOutput extends DescribeGameSess
|
|
|
23
23
|
* queues, use the pagination parameters to retrieve results as a set of sequential pages.
|
|
24
24
|
* When specifying a list of queues, objects are returned only for queues that currently
|
|
25
25
|
* exist in the Region.</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-console.html">
|
|
31
31
|
* View Your 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
|
|
@@ -21,35 +21,35 @@ export interface DescribeGameSessionsCommandOutput extends DescribeGameSessionsO
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Retrieves a set of one or more game sessions in a specific fleet location. You can
|
|
23
23
|
* optionally filter the results by current game session status.</p>
|
|
24
|
-
*
|
|
25
|
-
*
|
|
24
|
+
* <p>This operation can be used in the following ways: </p>
|
|
25
|
+
* <ul>
|
|
26
26
|
* <li>
|
|
27
|
-
*
|
|
27
|
+
* <p>To retrieve all game sessions that are currently running on all locations in a
|
|
28
28
|
* fleet, provide a fleet or alias ID, with an optional status filter. This
|
|
29
29
|
* approach returns all game sessions in the fleet's home Region and all remote
|
|
30
30
|
* locations.</p>
|
|
31
31
|
* </li>
|
|
32
32
|
* <li>
|
|
33
|
-
*
|
|
33
|
+
* <p>To retrieve all game sessions that are currently running on a specific fleet
|
|
34
34
|
* location, provide a fleet or alias ID and a location name, with optional status
|
|
35
35
|
* filter. The location can be the fleet's home Region or any remote
|
|
36
36
|
* location.</p>
|
|
37
37
|
* </li>
|
|
38
38
|
* <li>
|
|
39
|
-
*
|
|
39
|
+
* <p>To retrieve a specific game session, provide the game session ID. This
|
|
40
40
|
* approach looks for the game session ID in all fleets that reside in the Amazon Web Services
|
|
41
41
|
* Region defined in the request.</p>
|
|
42
42
|
* </li>
|
|
43
43
|
* </ul>
|
|
44
|
-
*
|
|
45
|
-
*
|
|
44
|
+
* <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p>
|
|
45
|
+
* <p>If successful, a <code>GameSession</code> object is returned for each game session
|
|
46
46
|
* that matches the request.</p>
|
|
47
|
-
*
|
|
47
|
+
* <p>This operation is not designed to be continually called to track game session status.
|
|
48
48
|
* This practice can cause you to exceed your API limit, which results in errors. Instead,
|
|
49
49
|
* you must configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or
|
|
50
50
|
* queues. Continuously polling with <code>DescribeGameSessions</code> should only be used
|
|
51
51
|
* for games in development with low game session usage. </p>
|
|
52
|
-
*
|
|
52
|
+
* <p>
|
|
53
53
|
* <i>Available in Amazon GameLift Local.</i>
|
|
54
54
|
* </p>
|
|
55
55
|
* <p>
|
|
@@ -59,7 +59,7 @@ export interface DescribeGameSessionsCommandOutput extends DescribeGameSessionsO
|
|
|
59
59
|
* <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
60
|
* </p>
|
|
61
61
|
* <p>
|
|
62
|
-
*
|
|
62
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
63
63
|
* </p>
|
|
64
64
|
* @example
|
|
65
65
|
* Use a bare-bones client and the command you need to make an API call.
|