@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
|
@@ -21,40 +21,40 @@ export interface DescribeInstancesCommandOutput extends DescribeInstancesOutput,
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Retrieves information about a fleet's instances, including instance IDs, connection
|
|
23
23
|
* data, and 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 get information on all instances that are deployed to a fleet's home
|
|
28
28
|
* Region, provide the fleet ID.</p>
|
|
29
29
|
* </li>
|
|
30
30
|
* <li>
|
|
31
|
-
*
|
|
31
|
+
* <p>To get information on all instances that are deployed to a fleet's remote
|
|
32
32
|
* location, provide the fleet ID and location name.</p>
|
|
33
33
|
* </li>
|
|
34
34
|
* <li>
|
|
35
|
-
*
|
|
35
|
+
* <p>To get information on a specific instance in a fleet, provide the fleet ID and
|
|
36
36
|
* instance ID.</p>
|
|
37
37
|
* </li>
|
|
38
38
|
* </ul>
|
|
39
|
-
*
|
|
40
|
-
*
|
|
39
|
+
* <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p>
|
|
40
|
+
* <p>If successful, an <code>Instance</code> object is returned for each requested
|
|
41
41
|
* instance. Instances are not returned in any particular order. </p>
|
|
42
|
-
*
|
|
42
|
+
* <p>
|
|
43
43
|
* <b>Learn more</b>
|
|
44
44
|
* </p>
|
|
45
|
-
*
|
|
45
|
+
* <p>
|
|
46
46
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html">Remotely Access Fleet
|
|
47
47
|
* Instances</a>
|
|
48
48
|
* </p>
|
|
49
|
-
*
|
|
49
|
+
* <p>
|
|
50
50
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html">Debug Fleet
|
|
51
51
|
* Issues</a>
|
|
52
52
|
* </p>
|
|
53
53
|
* <p>
|
|
54
54
|
* <b>Related actions</b>
|
|
55
55
|
* </p>
|
|
56
|
-
*
|
|
57
|
-
*
|
|
56
|
+
* <p>
|
|
57
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
58
58
|
* </p>
|
|
59
59
|
* @example
|
|
60
60
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -22,22 +22,22 @@ export interface DescribeMatchmakingCommandOutput extends DescribeMatchmakingOut
|
|
|
22
22
|
* <p>Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket
|
|
23
23
|
* information, including--after a successful match is made--connection information for the
|
|
24
24
|
* resulting new game session. </p>
|
|
25
|
-
*
|
|
25
|
+
* <p>To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request
|
|
26
26
|
* is successful, a ticket object is returned for each requested ID that currently
|
|
27
27
|
* exists.</p>
|
|
28
|
-
*
|
|
28
|
+
* <p>This operation is not designed to be continually called to track matchmaking ticket
|
|
29
29
|
* status. This practice can cause you to exceed your API limit, which results in errors.
|
|
30
30
|
* Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide
|
|
31
31
|
* the topic ARN in the matchmaking configuration.</p>
|
|
32
|
-
*
|
|
33
|
-
*
|
|
32
|
+
* <p></p>
|
|
33
|
+
* <p>
|
|
34
34
|
* <b>Learn more</b>
|
|
35
35
|
* </p>
|
|
36
|
-
*
|
|
36
|
+
* <p>
|
|
37
37
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html">
|
|
38
38
|
* Add FlexMatch to a game client</a>
|
|
39
39
|
* </p>
|
|
40
|
-
*
|
|
40
|
+
* <p>
|
|
41
41
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html"> Set Up FlexMatch event
|
|
42
42
|
* notification</a>
|
|
43
43
|
* </p>
|
|
@@ -20,16 +20,16 @@ export interface DescribeMatchmakingConfigurationsCommandOutput extends Describe
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Retrieves the details of FlexMatch matchmaking configurations. </p>
|
|
23
|
-
*
|
|
23
|
+
* <p>This operation offers the following options: (1) retrieve all matchmaking
|
|
24
24
|
* configurations, (2) retrieve configurations for a specified list, or (3) retrieve all
|
|
25
25
|
* configurations that use a specified rule set name. When requesting multiple items, use
|
|
26
26
|
* the pagination parameters to retrieve results as a set of sequential pages. </p>
|
|
27
|
-
*
|
|
27
|
+
* <p>If successful, a configuration is returned for each requested name. When specifying a
|
|
28
28
|
* list of names, only configurations that currently exist are returned. </p>
|
|
29
|
-
*
|
|
29
|
+
* <p>
|
|
30
30
|
* <b>Learn more</b>
|
|
31
31
|
* </p>
|
|
32
|
-
*
|
|
32
|
+
* <p>
|
|
33
33
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/matchmaker-build.html"> Setting up FlexMatch matchmakers</a>
|
|
34
34
|
* </p>
|
|
35
35
|
* @example
|
|
@@ -23,12 +23,12 @@ export interface DescribeMatchmakingRuleSetsCommandOutput extends DescribeMatchm
|
|
|
23
23
|
* rule sets for the Region, or provide a list of one or more rule set names. When
|
|
24
24
|
* requesting multiple items, use the pagination parameters to retrieve results as a set of
|
|
25
25
|
* sequential pages. If successful, a rule set is returned for each requested name. </p>
|
|
26
|
-
*
|
|
26
|
+
* <p>
|
|
27
27
|
* <b>Learn more</b>
|
|
28
28
|
* </p>
|
|
29
|
-
*
|
|
29
|
+
* <ul>
|
|
30
30
|
* <li>
|
|
31
|
-
*
|
|
31
|
+
* <p>
|
|
32
32
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html">Build a rule
|
|
33
33
|
* set</a>
|
|
34
34
|
* </p>
|
|
@@ -20,31 +20,31 @@ export interface DescribePlayerSessionsCommandOutput extends DescribePlayerSessi
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Retrieves properties for one or more player sessions. </p>
|
|
23
|
-
*
|
|
24
|
-
*
|
|
23
|
+
* <p>This action can be used in the following ways: </p>
|
|
24
|
+
* <ul>
|
|
25
25
|
* <li>
|
|
26
|
-
*
|
|
26
|
+
* <p>To retrieve a specific player session, provide the player session ID
|
|
27
27
|
* only.</p>
|
|
28
28
|
* </li>
|
|
29
29
|
* <li>
|
|
30
|
-
*
|
|
30
|
+
* <p>To retrieve all player sessions in a game session, provide the game session ID
|
|
31
31
|
* only.</p>
|
|
32
32
|
* </li>
|
|
33
33
|
* <li>
|
|
34
|
-
*
|
|
34
|
+
* <p>To retrieve all player sessions for a specific player, provide a player ID
|
|
35
35
|
* only.</p>
|
|
36
36
|
* </li>
|
|
37
37
|
* </ul>
|
|
38
|
-
*
|
|
38
|
+
* <p>To request player sessions, specify either a player session ID, game session ID, or
|
|
39
39
|
* player ID. You can filter this request by player session status. Use the pagination
|
|
40
40
|
* parameters to retrieve results as a set of sequential pages. </p>
|
|
41
|
-
*
|
|
41
|
+
* <p>If successful, a <code>PlayerSession</code> object is returned for each session that
|
|
42
42
|
* matches the request.</p>
|
|
43
43
|
* <p>
|
|
44
44
|
* <b>Related actions</b>
|
|
45
45
|
* </p>
|
|
46
|
-
*
|
|
47
|
-
*
|
|
46
|
+
* <p>
|
|
47
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
48
48
|
* </p>
|
|
49
49
|
* @example
|
|
50
50
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -20,20 +20,20 @@ export interface DescribeRuntimeConfigurationCommandOutput extends DescribeRunti
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Retrieves a fleet's runtime configuration settings. The runtime configuration tells
|
|
23
|
-
* GameLift which server processes to run (and how) on each instance in the fleet.</p>
|
|
24
|
-
*
|
|
23
|
+
* Amazon GameLift which server processes to run (and how) on each instance in the fleet.</p>
|
|
24
|
+
* <p>To get the runtime configuration that is currently in forces for a fleet, provide the
|
|
25
25
|
* fleet ID. </p>
|
|
26
|
-
*
|
|
26
|
+
* <p>If successful, a <code>RuntimeConfiguration</code> object is returned for the
|
|
27
27
|
* requested fleet. If the requested fleet has been deleted, the result set is
|
|
28
28
|
* empty.</p>
|
|
29
29
|
* <p>
|
|
30
30
|
* <b>Learn more</b>
|
|
31
31
|
* </p>
|
|
32
32
|
* <p>
|
|
33
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
|
|
33
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift
|
|
34
34
|
* fleets</a>
|
|
35
35
|
* </p>
|
|
36
|
-
*
|
|
36
|
+
* <p>
|
|
37
37
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html">Running multiple
|
|
38
38
|
* processes on a fleet</a>
|
|
39
39
|
* </p>
|
|
@@ -20,11 +20,11 @@ export interface DescribeScalingPoliciesCommandOutput extends DescribeScalingPol
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Retrieves all scaling policies applied to a fleet.</p>
|
|
23
|
-
*
|
|
23
|
+
* <p>To get a fleet's scaling policies, specify the fleet ID. You can filter this request
|
|
24
24
|
* by policy status, such as to retrieve only active scaling policies. Use the pagination
|
|
25
25
|
* parameters to retrieve results as a set of sequential pages. If successful, set of
|
|
26
26
|
* <code>ScalingPolicy</code> objects is returned for the fleet.</p>
|
|
27
|
-
*
|
|
27
|
+
* <p>A fleet may have all of its scaling policies suspended. This operation does not affect
|
|
28
28
|
* the status of the scaling policies, which remains ACTIVE.</p>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -20,19 +20,19 @@ export interface DescribeScriptCommandOutput extends DescribeScriptOutput, __Met
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Retrieves properties for a Realtime script. </p>
|
|
23
|
-
*
|
|
23
|
+
* <p>To request a script record, specify the script ID. If successful, an object containing
|
|
24
24
|
* the script properties 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/realtime-intro.html">Amazon GameLift Realtime Servers</a>
|
|
30
|
-
*
|
|
30
|
+
* </p>
|
|
31
31
|
* <p>
|
|
32
32
|
* <b>Related actions</b>
|
|
33
33
|
* </p>
|
|
34
|
-
*
|
|
35
|
-
*
|
|
34
|
+
* <p>
|
|
35
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
36
36
|
* </p>
|
|
37
37
|
* @example
|
|
38
38
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -25,7 +25,7 @@ export interface DescribeVpcPeeringAuthorizationsCommandOutput extends DescribeV
|
|
|
25
25
|
* <p>
|
|
26
26
|
* <b>Related actions</b>
|
|
27
27
|
* </p>
|
|
28
|
-
*
|
|
28
|
+
* <p>
|
|
29
29
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
30
30
|
* </p>
|
|
31
31
|
* @example
|
|
@@ -21,7 +21,7 @@ export interface DescribeVpcPeeringConnectionsCommandOutput extends DescribeVpcP
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Retrieves information on VPC peering connections. Use this operation to get peering
|
|
23
23
|
* information for all fleets or for one specific fleet ID. </p>
|
|
24
|
-
*
|
|
24
|
+
* <p>To retrieve connection information, call this operation from the Amazon Web Services account that is
|
|
25
25
|
* used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty to
|
|
26
26
|
* retrieve all connection records. If successful, the retrieved information includes both
|
|
27
27
|
* active and pending connections. Active connections identify the IpV4 CIDR block that the
|
|
@@ -29,7 +29,7 @@ export interface DescribeVpcPeeringConnectionsCommandOutput extends DescribeVpcP
|
|
|
29
29
|
* <p>
|
|
30
30
|
* <b>Related actions</b>
|
|
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
|
|
@@ -21,24 +21,24 @@ export interface GetComputeAccessCommandOutput extends GetComputeAccessOutput, _
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Requests remote access to a fleet instance. Remote access is useful for debugging,
|
|
23
23
|
* gathering benchmarking data, or observing activity in real time. </p>
|
|
24
|
-
*
|
|
25
|
-
* of the instance. For a Windows instance, GameLift returns a user name and password as
|
|
26
|
-
* strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift
|
|
24
|
+
* <p>To remotely access an instance, you need credentials that match the operating system
|
|
25
|
+
* of the instance. For a Windows instance, Amazon GameLift returns a user name and password as
|
|
26
|
+
* strings for use with a Windows Remote Desktop client. For a Linux instance, Amazon GameLift
|
|
27
27
|
* returns a user name and RSA private key, also as strings, for use with an SSH client.
|
|
28
28
|
* The private key must be saved in the proper format to a <code>.pem</code> file before
|
|
29
29
|
* using. If you're making this request using the CLI, saving the secret can be handled
|
|
30
30
|
* as part of the <code>GetInstanceAccess</code> request, as shown in one of the examples
|
|
31
31
|
* for this operation. </p>
|
|
32
|
-
*
|
|
32
|
+
* <p>To request access to a specific instance, specify the IDs of both the instance and the
|
|
33
33
|
* fleet it belongs to.</p>
|
|
34
|
-
*
|
|
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/developerguide/fleets-remote-access.html">Remotely Access Fleet
|
|
39
39
|
* Instances</a>
|
|
40
40
|
* </p>
|
|
41
|
-
*
|
|
41
|
+
* <p>
|
|
42
42
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html">Debug Fleet
|
|
43
43
|
* Issues</a>
|
|
44
44
|
* </p>
|
|
@@ -19,10 +19,10 @@ export interface GetComputeAuthTokenCommandOutput extends GetComputeAuthTokenOut
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Requests an
|
|
23
|
-
* game server to authenticate with GameLift. Each authentication token has an
|
|
24
|
-
*
|
|
25
|
-
* retrieve a new authorization token.</p>
|
|
22
|
+
* <p>Requests an authentication token from Amazon GameLift. The authentication token is used by
|
|
23
|
+
* your game server to authenticate with Amazon GameLift. Each authentication token has an
|
|
24
|
+
* expiration time. To continue using the compute resource to host your game server,
|
|
25
|
+
* regularly retrieve a new authorization token.</p>
|
|
26
26
|
* @example
|
|
27
27
|
* Use a bare-bones client and the command you need to make an API call.
|
|
28
28
|
* ```javascript
|
|
@@ -20,15 +20,15 @@ export interface GetGameSessionLogUrlCommandOutput extends GetGameSessionLogUrlO
|
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Retrieves the location of stored game session logs for a specified game session. When
|
|
23
|
-
* a game session is terminated, GameLift automatically stores the logs in Amazon S3 and
|
|
23
|
+
* a game session is terminated, Amazon GameLift automatically stores the logs in Amazon S3 and
|
|
24
24
|
* retains them for 14 days. Use this URL to download the logs.</p>
|
|
25
|
-
*
|
|
25
|
+
* <note>
|
|
26
26
|
* <p>See the <a href="https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_gamelift">Amazon Web Services Service
|
|
27
27
|
* Limits</a> page for maximum log file sizes. Log files that exceed this limit
|
|
28
28
|
* are not saved.</p>
|
|
29
|
-
*
|
|
29
|
+
* </note>
|
|
30
30
|
* <p>
|
|
31
|
-
*
|
|
31
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
32
32
|
* </p>
|
|
33
33
|
* @example
|
|
34
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -21,32 +21,32 @@ export interface GetInstanceAccessCommandOutput extends GetInstanceAccessOutput,
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Requests remote access to a fleet instance. Remote access is useful for debugging,
|
|
23
23
|
* gathering benchmarking data, or observing activity in real time. </p>
|
|
24
|
-
*
|
|
25
|
-
* of the instance. For a Windows instance, GameLift returns a user name and password as
|
|
26
|
-
* strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift
|
|
24
|
+
* <p>To remotely access an instance, you need credentials that match the operating system
|
|
25
|
+
* of the instance. For a Windows instance, Amazon GameLift returns a user name and password as
|
|
26
|
+
* strings for use with a Windows Remote Desktop client. For a Linux instance, Amazon GameLift
|
|
27
27
|
* returns a user name and RSA private key, also as strings, for use with an SSH client.
|
|
28
28
|
* The private key must be saved in the proper format to a <code>.pem</code> file before
|
|
29
29
|
* using. If you're making this request using the CLI, saving the secret can be handled
|
|
30
30
|
* as part of the <code>GetInstanceAccess</code> request, as shown in one of the examples
|
|
31
31
|
* for this operation. </p>
|
|
32
|
-
*
|
|
32
|
+
* <p>To request access to a specific instance, specify the IDs of both the instance and the
|
|
33
33
|
* fleet it belongs to. You can retrieve a fleet's instance IDs by calling <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeInstances.html">DescribeInstances</a>. </p>
|
|
34
|
-
*
|
|
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/developerguide/fleets-remote-access.html">Remotely Access Fleet
|
|
39
39
|
* Instances</a>
|
|
40
40
|
* </p>
|
|
41
|
-
*
|
|
41
|
+
* <p>
|
|
42
42
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html">Debug Fleet
|
|
43
43
|
* Issues</a>
|
|
44
44
|
* </p>
|
|
45
45
|
* <p>
|
|
46
46
|
* <b>Related actions</b>
|
|
47
47
|
* </p>
|
|
48
|
-
*
|
|
49
|
-
*
|
|
48
|
+
* <p>
|
|
49
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
50
50
|
* </p>
|
|
51
51
|
* @example
|
|
52
52
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -22,14 +22,14 @@ export interface ListAliasesCommandOutput extends ListAliasesOutput, __MetadataB
|
|
|
22
22
|
* <p>Retrieves all aliases for this Amazon Web Services account. You can filter the result set by alias
|
|
23
23
|
* name and/or routing strategy type. Use the pagination parameters to retrieve results in
|
|
24
24
|
* sequential pages.</p>
|
|
25
|
-
*
|
|
25
|
+
* <note>
|
|
26
26
|
* <p>Returned aliases are not listed in any particular order.</p>
|
|
27
|
-
*
|
|
27
|
+
* </note>
|
|
28
28
|
* <p>
|
|
29
29
|
* <b>Related actions</b>
|
|
30
30
|
* </p>
|
|
31
|
-
*
|
|
32
|
-
*
|
|
31
|
+
* <p>
|
|
32
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
33
33
|
* </p>
|
|
34
34
|
* @example
|
|
35
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,18 +23,18 @@ export interface ListBuildsCommandOutput extends ListBuildsOutput, __MetadataBea
|
|
|
23
23
|
* can limit results to builds that are in a specific status by using the
|
|
24
24
|
* <code>Status</code> parameter. Use the pagination parameters to retrieve results in
|
|
25
25
|
* a set of sequential pages. </p>
|
|
26
|
-
*
|
|
26
|
+
* <note>
|
|
27
27
|
* <p>Build resources are not listed in any particular order.</p>
|
|
28
|
-
*
|
|
29
|
-
*
|
|
28
|
+
* </note>
|
|
29
|
+
* <p>
|
|
30
30
|
* <b>Learn more</b>
|
|
31
31
|
* </p>
|
|
32
|
-
*
|
|
32
|
+
* <p>
|
|
33
33
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html"> Upload a Custom
|
|
34
34
|
* Server Build</a>
|
|
35
35
|
* </p>
|
|
36
36
|
* <p>
|
|
37
|
-
*
|
|
37
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
38
38
|
* </p>
|
|
39
39
|
* @example
|
|
40
40
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -24,32 +24,32 @@ export interface ListFleetsCommandOutput extends ListFleetsOutput, __MetadataBea
|
|
|
24
24
|
* specify a Region in your request. You can filter the result set to find only those
|
|
25
25
|
* fleets that are deployed with a specific build or script. For fleets that have multiple
|
|
26
26
|
* locations, this operation retrieves fleets based on their home Region only.</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 a list of all fleets in a Region, don't provide a build or script
|
|
31
31
|
* identifier. </p>
|
|
32
32
|
* </li>
|
|
33
33
|
* <li>
|
|
34
|
-
*
|
|
34
|
+
* <p>To get a list of all fleets where a specific custom game build is deployed,
|
|
35
35
|
* provide the build ID.</p>
|
|
36
36
|
* </li>
|
|
37
37
|
* <li>
|
|
38
|
-
*
|
|
38
|
+
* <p>To get a list of all Realtime Servers fleets with a specific configuration script,
|
|
39
39
|
* provide the script ID. </p>
|
|
40
40
|
* </li>
|
|
41
41
|
* </ul>
|
|
42
|
-
*
|
|
43
|
-
*
|
|
42
|
+
* <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p>
|
|
43
|
+
* <p>If successful, a list of fleet IDs that match the request parameters is returned. A
|
|
44
44
|
* NextToken value is also returned if there are more result pages to retrieve.</p>
|
|
45
|
-
*
|
|
45
|
+
* <note>
|
|
46
46
|
* <p>Fleet resources are not listed in a particular order.</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
|
* @example
|
|
@@ -20,19 +20,19 @@ export interface ListGameServersCommandOutput extends ListGameServersOutput, __M
|
|
|
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 all game
|
|
26
26
|
* servers that are currently active in a specified game server group. You can opt to sort
|
|
27
27
|
* the list by game server age. Use the pagination parameters to retrieve results in a set
|
|
28
28
|
* of sequential segments. </p>
|
|
29
|
-
*
|
|
29
|
+
* <p>
|
|
30
30
|
* <b>Learn more</b>
|
|
31
31
|
* </p>
|
|
32
|
-
*
|
|
33
|
-
* <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ
|
|
32
|
+
* <p>
|
|
33
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">Amazon GameLift FleetIQ
|
|
34
34
|
* Guide</a>
|
|
35
|
-
*
|
|
35
|
+
* </p>
|
|
36
36
|
* @example
|
|
37
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
38
|
* ```javascript
|
|
@@ -21,17 +21,17 @@ export interface ListScriptsCommandOutput extends ListScriptsOutput, __MetadataB
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services
|
|
23
23
|
* account in use. </p>
|
|
24
|
-
*
|
|
24
|
+
* <p>
|
|
25
25
|
* <b>Learn more</b>
|
|
26
26
|
* </p>
|
|
27
|
-
*
|
|
27
|
+
* <p>
|
|
28
28
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon GameLift Realtime Servers</a>
|
|
29
|
-
*
|
|
29
|
+
* </p>
|
|
30
30
|
* <p>
|
|
31
31
|
* <b>Related actions</b>
|
|
32
32
|
* </p>
|
|
33
|
-
*
|
|
34
|
-
*
|
|
33
|
+
* <p>
|
|
34
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
35
35
|
* </p>
|
|
36
36
|
* @example
|
|
37
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -19,48 +19,25 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Retrieves all tags
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
* <p>Build</p>
|
|
28
|
-
* </li>
|
|
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 list tags for a resource, specify the unique ARN value for the resource.</p>
|
|
49
|
-
* <p>
|
|
22
|
+
* <p>Retrieves all tags assigned to a Amazon GameLift resource. Use resource tags to organize Amazon Web Services
|
|
23
|
+
* resources for a range of purposes. This operation handles the permissions necessary to
|
|
24
|
+
* manage tags for Amazon GameLift resources that support tagging.</p>
|
|
25
|
+
* <p>To list tags for a resource, specify the unique ARN value for the resource.</p>
|
|
26
|
+
* <p>
|
|
50
27
|
* <b>Learn more</b>
|
|
51
28
|
* </p>
|
|
52
|
-
*
|
|
29
|
+
* <p>
|
|
53
30
|
* <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
|
|
54
31
|
* Resources</a> in the <i>Amazon Web Services General Reference</i>
|
|
55
32
|
* </p>
|
|
56
|
-
*
|
|
33
|
+
* <p>
|
|
57
34
|
* <a href="http://aws.amazon.com/answers/account-management/aws-tagging-strategies/">
|
|
58
35
|
* Amazon Web Services Tagging Strategies</a>
|
|
59
36
|
* </p>
|
|
60
37
|
* <p>
|
|
61
38
|
* <b>Related actions</b>
|
|
62
39
|
* </p>
|
|
63
|
-
*
|
|
40
|
+
* <p>
|
|
64
41
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
65
42
|
* </p>
|
|
66
43
|
* @example
|