@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.
Files changed (115) hide show
  1. package/README.md +13 -13
  2. package/dist-cjs/GameLift.js +108 -1456
  3. package/dist-cjs/endpoint/ruleset.js +3 -3
  4. package/dist-cjs/models/models_0.js +1 -0
  5. package/dist-cjs/protocols/Aws_json1_1.js +3 -0
  6. package/dist-es/GameLift.js +108 -1456
  7. package/dist-es/endpoint/ruleset.js +3 -3
  8. package/dist-es/models/models_0.js +1 -0
  9. package/dist-es/protocols/Aws_json1_1.js +3 -0
  10. package/dist-types/GameLift.d.ts +169 -2437
  11. package/dist-types/GameLiftClient.d.ts +20 -20
  12. package/dist-types/commands/AcceptMatchCommand.d.ts +6 -6
  13. package/dist-types/commands/ClaimGameServerCommand.d.ts +16 -16
  14. package/dist-types/commands/CreateAliasCommand.d.ts +5 -5
  15. package/dist-types/commands/CreateBuildCommand.d.ts +16 -16
  16. package/dist-types/commands/CreateFleetCommand.d.ts +13 -13
  17. package/dist-types/commands/CreateFleetLocationsCommand.d.ts +11 -7
  18. package/dist-types/commands/CreateGameServerGroupCommand.d.ts +17 -17
  19. package/dist-types/commands/CreateGameSessionCommand.d.ts +11 -11
  20. package/dist-types/commands/CreateGameSessionQueueCommand.d.ts +10 -10
  21. package/dist-types/commands/CreateLocationCommand.d.ts +1 -1
  22. package/dist-types/commands/CreateMatchmakingConfigurationCommand.d.ts +9 -9
  23. package/dist-types/commands/CreateMatchmakingRuleSetCommand.d.ts +7 -7
  24. package/dist-types/commands/CreatePlayerSessionCommand.d.ts +7 -7
  25. package/dist-types/commands/CreatePlayerSessionsCommand.d.ts +8 -8
  26. package/dist-types/commands/CreateScriptCommand.d.ts +11 -12
  27. package/dist-types/commands/CreateVpcPeeringAuthorizationCommand.d.ts +5 -5
  28. package/dist-types/commands/CreateVpcPeeringConnectionCommand.d.ts +3 -3
  29. package/dist-types/commands/DeleteAliasCommand.d.ts +2 -2
  30. package/dist-types/commands/DeleteBuildCommand.d.ts +4 -4
  31. package/dist-types/commands/DeleteFleetCommand.d.ts +4 -4
  32. package/dist-types/commands/DeleteFleetLocationsCommand.d.ts +4 -4
  33. package/dist-types/commands/DeleteGameServerGroupCommand.d.ts +13 -13
  34. package/dist-types/commands/DeleteLocationCommand.d.ts +1 -1
  35. package/dist-types/commands/DeleteMatchmakingRuleSetCommand.d.ts +3 -3
  36. package/dist-types/commands/DeleteScalingPolicyCommand.d.ts +2 -2
  37. package/dist-types/commands/DeleteScriptCommand.d.ts +6 -6
  38. package/dist-types/commands/DeleteVpcPeeringAuthorizationCommand.d.ts +1 -1
  39. package/dist-types/commands/DeleteVpcPeeringConnectionCommand.d.ts +2 -2
  40. package/dist-types/commands/DeregisterGameServerCommand.d.ts +6 -6
  41. package/dist-types/commands/DescribeAliasCommand.d.ts +3 -3
  42. package/dist-types/commands/DescribeBuildCommand.d.ts +3 -3
  43. package/dist-types/commands/DescribeComputeCommand.d.ts +1 -1
  44. package/dist-types/commands/DescribeEC2InstanceLimitsCommand.d.ts +15 -15
  45. package/dist-types/commands/DescribeFleetAttributesCommand.d.ts +9 -9
  46. package/dist-types/commands/DescribeFleetCapacityCommand.d.ts +10 -10
  47. package/dist-types/commands/DescribeFleetEventsCommand.d.ts +3 -3
  48. package/dist-types/commands/DescribeFleetLocationAttributesCommand.d.ts +7 -7
  49. package/dist-types/commands/DescribeFleetLocationCapacityCommand.d.ts +4 -4
  50. package/dist-types/commands/DescribeFleetLocationUtilizationCommand.d.ts +4 -4
  51. package/dist-types/commands/DescribeFleetPortSettingsCommand.d.ts +7 -7
  52. package/dist-types/commands/DescribeFleetUtilizationCommand.d.ts +10 -10
  53. package/dist-types/commands/DescribeGameServerCommand.d.ts +6 -6
  54. package/dist-types/commands/DescribeGameServerGroupCommand.d.ts +7 -7
  55. package/dist-types/commands/DescribeGameServerInstancesCommand.d.ts +8 -8
  56. package/dist-types/commands/DescribeGameSessionDetailsCommand.d.ts +8 -8
  57. package/dist-types/commands/DescribeGameSessionPlacementCommand.d.ts +2 -2
  58. package/dist-types/commands/DescribeGameSessionQueuesCommand.d.ts +3 -3
  59. package/dist-types/commands/DescribeGameSessionsCommand.d.ts +10 -10
  60. package/dist-types/commands/DescribeInstancesCommand.d.ts +12 -12
  61. package/dist-types/commands/DescribeMatchmakingCommand.d.ts +6 -6
  62. package/dist-types/commands/DescribeMatchmakingConfigurationsCommand.d.ts +4 -4
  63. package/dist-types/commands/DescribeMatchmakingRuleSetsCommand.d.ts +3 -3
  64. package/dist-types/commands/DescribePlayerSessionsCommand.d.ts +9 -9
  65. package/dist-types/commands/DescribeRuntimeConfigurationCommand.d.ts +5 -5
  66. package/dist-types/commands/DescribeScalingPoliciesCommand.d.ts +2 -2
  67. package/dist-types/commands/DescribeScriptCommand.d.ts +6 -6
  68. package/dist-types/commands/DescribeVpcPeeringAuthorizationsCommand.d.ts +1 -1
  69. package/dist-types/commands/DescribeVpcPeeringConnectionsCommand.d.ts +2 -2
  70. package/dist-types/commands/GetComputeAccessCommand.d.ts +7 -7
  71. package/dist-types/commands/GetComputeAuthTokenCommand.d.ts +4 -4
  72. package/dist-types/commands/GetGameSessionLogUrlCommand.d.ts +4 -4
  73. package/dist-types/commands/GetInstanceAccessCommand.d.ts +9 -9
  74. package/dist-types/commands/ListAliasesCommand.d.ts +4 -4
  75. package/dist-types/commands/ListBuildsCommand.d.ts +5 -5
  76. package/dist-types/commands/ListFleetsCommand.d.ts +10 -10
  77. package/dist-types/commands/ListGameServersCommand.d.ts +5 -5
  78. package/dist-types/commands/ListScriptsCommand.d.ts +5 -5
  79. package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -31
  80. package/dist-types/commands/PutScalingPolicyCommand.d.ts +14 -14
  81. package/dist-types/commands/RegisterComputeCommand.d.ts +5 -5
  82. package/dist-types/commands/RegisterGameServerCommand.d.ts +10 -10
  83. package/dist-types/commands/RequestUploadCredentialsCommand.d.ts +5 -5
  84. package/dist-types/commands/ResolveAliasCommand.d.ts +2 -2
  85. package/dist-types/commands/ResumeGameServerGroupCommand.d.ts +6 -6
  86. package/dist-types/commands/SearchGameSessionsCommand.d.ts +20 -20
  87. package/dist-types/commands/StartFleetActionsCommand.d.ts +6 -6
  88. package/dist-types/commands/StartGameSessionPlacementCommand.d.ts +11 -11
  89. package/dist-types/commands/StartMatchBackfillCommand.d.ts +9 -9
  90. package/dist-types/commands/StartMatchmakingCommand.d.ts +8 -8
  91. package/dist-types/commands/StopFleetActionsCommand.d.ts +7 -7
  92. package/dist-types/commands/StopMatchmakingCommand.d.ts +5 -5
  93. package/dist-types/commands/SuspendGameServerGroupCommand.d.ts +8 -8
  94. package/dist-types/commands/TagResourceCommand.d.ts +10 -34
  95. package/dist-types/commands/UntagResourceCommand.d.ts +10 -34
  96. package/dist-types/commands/UpdateAliasCommand.d.ts +2 -2
  97. package/dist-types/commands/UpdateBuildCommand.d.ts +3 -3
  98. package/dist-types/commands/UpdateFleetAttributesCommand.d.ts +5 -5
  99. package/dist-types/commands/UpdateFleetCapacityCommand.d.ts +10 -10
  100. package/dist-types/commands/UpdateFleetPortSettingsCommand.d.ts +5 -5
  101. package/dist-types/commands/UpdateGameServerCommand.d.ts +12 -12
  102. package/dist-types/commands/UpdateGameServerGroupCommand.d.ts +8 -8
  103. package/dist-types/commands/UpdateGameSessionCommand.d.ts +5 -5
  104. package/dist-types/commands/UpdateGameSessionQueueCommand.d.ts +3 -3
  105. package/dist-types/commands/UpdateMatchmakingConfigurationCommand.d.ts +2 -2
  106. package/dist-types/commands/UpdateRuntimeConfigurationCommand.d.ts +5 -5
  107. package/dist-types/commands/UpdateScriptCommand.d.ts +8 -8
  108. package/dist-types/commands/ValidateMatchmakingRuleSetCommand.d.ts +3 -3
  109. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  110. package/dist-types/models/models_0.d.ts +591 -591
  111. package/dist-types/models/models_1.d.ts +22 -22
  112. package/dist-types/ts3.4/GameLift.d.ts +2 -1
  113. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  114. package/dist-types/ts3.4/models/models_0.d.ts +1 -0
  115. package/package.json +6 -6
@@ -26,52 +26,52 @@ export interface PutScalingPolicyCommandOutput extends PutScalingPolicyOutput, _
26
26
  * target-based and rule-based. Use a target-based policy to quickly and efficiently manage
27
27
  * fleet scaling; this option is the most commonly used. Use rule-based policies when you
28
28
  * need to exert fine-grained control over auto-scaling. </p>
29
- * <p>Fleets can have multiple scaling policies of each type in force at the same time; you
29
+ * <p>Fleets can have multiple scaling policies of each type in force at the same time; you
30
30
  * can have one target-based policy, one or multiple rule-based scaling policies, or both.
31
31
  * We recommend caution, however, because multiple auto-scaling policies can have
32
32
  * unintended consequences.</p>
33
- * <p>Learn more about how to work with auto-scaling in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-autoscaling.html">Set Up Fleet Automatic
33
+ * <p>Learn more about how to work with auto-scaling in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-autoscaling.html">Set Up Fleet Automatic
34
34
  * Scaling</a>.</p>
35
- * <p>
35
+ * <p>
36
36
  * <b>Target-based policy</b>
37
37
  * </p>
38
- * <p>A target-based policy tracks a single metric: PercentAvailableGameSessions. This
38
+ * <p>A target-based policy tracks a single metric: PercentAvailableGameSessions. This
39
39
  * metric tells us how much of a fleet's hosting capacity is ready to host game sessions
40
40
  * but is not currently in use. This is the fleet's buffer; it measures the additional
41
41
  * player demand that the fleet could handle at current capacity. With a target-based
42
42
  * policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action is
43
43
  * needed to maintain that target. </p>
44
- * <p>For example, you might choose to maintain a 10% buffer for a fleet that has the
44
+ * <p>For example, you might choose to maintain a 10% buffer for a fleet that has the
45
45
  * capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take action
46
46
  * whenever the fleet's available capacity falls below or rises above 10 game sessions.
47
47
  * Amazon GameLift will start new instances or stop unused instances in order to return to the 10%
48
48
  * buffer. </p>
49
- * <p>To create or update a target-based policy, specify a fleet ID and name, and set the
49
+ * <p>To create or update a target-based policy, specify a fleet ID and name, and set the
50
50
  * policy type to "TargetBased". Specify the metric to track (PercentAvailableGameSessions)
51
51
  * and reference a <code>TargetConfiguration</code> object with your desired buffer value.
52
52
  * Exclude all other parameters. On a successful request, the policy name is returned. The
53
53
  * scaling policy is automatically in force as soon as it's successfully created. If the
54
54
  * fleet's auto-scaling actions are temporarily suspended, the new policy will be in force
55
55
  * once the fleet actions are restarted.</p>
56
- * <p>
56
+ * <p>
57
57
  * <b>Rule-based policy</b>
58
58
  * </p>
59
- * <p>A rule-based policy tracks specified fleet metric, sets a threshold value, and
59
+ * <p>A rule-based policy tracks specified fleet metric, sets a threshold value, and
60
60
  * specifies the type of action to initiate when triggered. With a rule-based policy, you
61
61
  * can select from several available fleet metrics. Each policy specifies whether to scale
62
62
  * up or scale down (and by how much), so you need one policy for each type of action. </p>
63
- * <p>For example, a policy may make the following statement: "If the percentage of idle
63
+ * <p>For example, a policy may make the following statement: "If the percentage of idle
64
64
  * instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity
65
65
  * by 10%."</p>
66
- * <p>A policy's rule statement has the following structure:</p>
67
- * <p>If <code>[MetricName]</code> is <code>[ComparisonOperator]</code>
66
+ * <p>A policy's rule statement has the following structure:</p>
67
+ * <p>If <code>[MetricName]</code> is <code>[ComparisonOperator]</code>
68
68
  * <code>[Threshold]</code> for <code>[EvaluationPeriods]</code> minutes, then
69
69
  * <code>[ScalingAdjustmentType]</code> to/by <code>[ScalingAdjustment]</code>.</p>
70
- * <p>To implement the example, the rule statement would look like this:</p>
71
- * <p>If <code>[PercentIdleInstances]</code> is <code>[GreaterThanThreshold]</code>
70
+ * <p>To implement the example, the rule statement would look like this:</p>
71
+ * <p>If <code>[PercentIdleInstances]</code> is <code>[GreaterThanThreshold]</code>
72
72
  * <code>[20]</code> for <code>[15]</code> minutes, then
73
73
  * <code>[PercentChangeInCapacity]</code> to/by <code>[10]</code>.</p>
74
- * <p>To create or update a scaling policy, specify a unique combination of name and fleet
74
+ * <p>To create or update a scaling policy, specify a unique combination of name and fleet
75
75
  * ID, and set the policy type to "RuleBased". Specify the parameter values for a policy
76
76
  * rule statement. On a successful request, the policy name is returned. Scaling policies
77
77
  * are automatically in force as soon as they're successfully created. If the fleet's
@@ -20,21 +20,21 @@ export interface RegisterComputeCommandOutput extends RegisterComputeOutput, __M
20
20
  /**
21
21
  * @public
22
22
  * <p>Registers your compute resources in a fleet you previously created. After you register
23
- * a compute to your fleet, you can monitor and manage your compute using GameLift. The
23
+ * a compute to your fleet, you can monitor and manage your compute using Amazon GameLift. The
24
24
  * operation returns the compute resource containing SDK endpoint you can use to connect
25
- * your game server to GameLift.</p>
25
+ * your game server to Amazon GameLift.</p>
26
26
  * <p>
27
27
  * <b>Learn more</b>
28
28
  * </p>
29
29
  * <ul>
30
30
  * <li>
31
- * <p>
31
+ * <p>
32
32
  * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-anywhere.html">Create an
33
33
  * Anywhere fleet</a>
34
34
  * </p>
35
35
  * </li>
36
36
  * <li>
37
- * <p>
37
+ * <p>
38
38
  * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-testing.html">Test your
39
39
  * integration</a>
40
40
  * </p>
@@ -68,7 +68,7 @@ export interface RegisterComputeCommandOutput extends RegisterComputeOutput, __M
68
68
  * <p>The requested operation would cause a conflict with the current state of a service
69
69
  * resource associated with the request. Resolve the conflict before retrying this
70
70
  * request.</p>
71
- * <p></p>
71
+ * <p></p>
72
72
  *
73
73
  * @throws {@link InternalServiceException} (server fault)
74
74
  * <p>The service encountered an unrecoverable internal failure while processing the
@@ -20,28 +20,28 @@ export interface RegisterGameServerCommandOutput extends RegisterGameServerOutpu
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>Creates a new game server
26
- * resource and notifies GameLift FleetIQ that the game server is ready to host gameplay and players.
26
+ * resource and notifies Amazon GameLift FleetIQ that the game server is ready to host gameplay and players.
27
27
  * This operation is called by a game server process that is running on an instance in a
28
- * game server group. Registering game servers enables GameLift FleetIQ to track available game
28
+ * game server group. Registering game servers enables Amazon GameLift FleetIQ to track available game
29
29
  * servers and enables game clients and services to claim a game server for a new game
30
30
  * session. </p>
31
- * <p>To register a game server, identify the game server group and instance where the game
31
+ * <p>To register a game server, identify the game server group and instance where the game
32
32
  * server is running, and provide a unique identifier for the game server. You can also
33
33
  * include connection and game server data.</p>
34
- * <p>Once a game server is successfully registered, it is put in status
34
+ * <p>Once a game server is successfully registered, it is put in status
35
35
  * <code>AVAILABLE</code>. A request to register a game server may fail if the instance
36
36
  * it is running on is in the process of shutting down as part of instance balancing or
37
37
  * scale-down activity. </p>
38
- * <p>
38
+ * <p>
39
39
  * <b>Learn more</b>
40
40
  * </p>
41
- * <p>
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
- * </p>
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
@@ -69,7 +69,7 @@ export interface RegisterGameServerCommandOutput extends RegisterGameServerOutpu
69
69
  * <p>The requested operation would cause a conflict with the current state of a service
70
70
  * resource associated with the request. Resolve the conflict before retrying this
71
71
  * request.</p>
72
- * <p></p>
72
+ * <p></p>
73
73
  *
74
74
  * @throws {@link InternalServiceException} (server fault)
75
75
  * <p>The service encountered an unrecoverable internal failure while processing the
@@ -22,17 +22,17 @@ export interface RequestUploadCredentialsCommandOutput extends RequestUploadCred
22
22
  * <p>Retrieves a fresh set of credentials for use when uploading a new set of game build
23
23
  * files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see
24
24
  * <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateBuild.html">GameSession</a>.</p>
25
- * <p>To request new credentials, specify the build ID as returned with an initial
25
+ * <p>To request new credentials, specify the build ID as returned with an initial
26
26
  * <code>CreateBuild</code> request. If successful, a new set of credentials are
27
27
  * returned, along with the S3 storage location associated with the build ID.</p>
28
- * <p>
28
+ * <p>
29
29
  * <b>Learn more</b>
30
30
  * </p>
31
- * <p>
31
+ * <p>
32
32
  * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-create-build"> Create a Build with Files in S3</a>
33
- * </p>
33
+ * </p>
34
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>
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.
@@ -23,8 +23,8 @@ export interface ResolveAliasCommandOutput extends ResolveAliasOutput, __Metadat
23
23
  * <p>
24
24
  * <b>Related actions</b>
25
25
  * </p>
26
- * <p>
27
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
26
+ * <p>
27
+ * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
28
28
  * </p>
29
29
  * @example
30
30
  * Use a bare-bones client and the command you need to make an API call.
@@ -20,7 +20,7 @@ export interface ResumeGameServerGroupCommandOutput extends ResumeGameServerGrou
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>Reinstates activity on a game
26
26
  * server group after it has been suspended. A game server group might be suspended by the
@@ -29,16 +29,16 @@ export interface ResumeGameServerGroupCommandOutput extends ResumeGameServerGrou
29
29
  * the group once the configuration problem has been resolved. Refer to the game server
30
30
  * group status and status reason for more information on why group activity is
31
31
  * suspended.</p>
32
- * <p>To resume activity, specify a game server group ARN and the type of activity to be
32
+ * <p>To resume activity, specify a game server group ARN and the type of activity to be
33
33
  * resumed. If successful, a <code>GameServerGroup</code> object is returned showing that
34
34
  * the resumed activity is no longer listed in <code>SuspendedActions</code>. </p>
35
- * <p>
35
+ * <p>
36
36
  * <b>Learn more</b>
37
37
  * </p>
38
- * <p>
39
- * <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ
38
+ * <p>
39
+ * <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">Amazon GameLift FleetIQ
40
40
  * Guide</a>
41
- * </p>
41
+ * </p>
42
42
  * @example
43
43
  * Use a bare-bones client and the command you need to make an API call.
44
44
  * ```javascript
@@ -21,47 +21,47 @@ export interface SearchGameSessionsCommandOutput extends SearchGameSessionsOutpu
21
21
  * @public
22
22
  * <p>Retrieves all active game sessions that match a set of search criteria and sorts them
23
23
  * into a specified order. </p>
24
- * <p>This operation is not designed to be continually called to track game session status.
24
+ * <p>This operation is not designed to be continually called to track game session status.
25
25
  * This practice can cause you to exceed your API limit, which results in errors. Instead,
26
26
  * you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from
27
27
  * FlexMatch or queues. Continuously polling game session status with
28
28
  * <code>DescribeGameSessions</code> should only be used for games in development with
29
29
  * low game session usage. </p>
30
- * <p>When searching for game sessions, you specify exactly where you want to search and
30
+ * <p>When searching for game sessions, you specify exactly where you want to search and
31
31
  * provide a search filter expression, a sort expression, or both. A search request can
32
32
  * search only one fleet, but it can search all of a fleet's locations. </p>
33
- * <p>This operation can be used in the following ways: </p>
34
- * <ul>
33
+ * <p>This operation can be used in the following ways: </p>
34
+ * <ul>
35
35
  * <li>
36
- * <p>To search all game sessions that are currently running on all locations in a
36
+ * <p>To search all game sessions that are currently running on all locations in a
37
37
  * fleet, provide a fleet or alias ID. This approach returns game sessions in the
38
38
  * fleet's home Region and all remote locations that fit the search
39
39
  * criteria.</p>
40
40
  * </li>
41
41
  * <li>
42
- * <p>To search all game sessions that are currently running on a specific fleet
42
+ * <p>To search all game sessions that are currently running on a specific fleet
43
43
  * location, provide a fleet or alias ID and a location name. For location, you can
44
44
  * specify a fleet's home Region or any remote location.</p>
45
45
  * </li>
46
46
  * </ul>
47
- * <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p>
48
- * <p>If successful, a <code>GameSession</code> object is returned for each game session
47
+ * <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p>
48
+ * <p>If successful, a <code>GameSession</code> object is returned for each game session
49
49
  * that matches the request. Search finds game sessions that are in <code>ACTIVE</code>
50
50
  * status only. To retrieve information on game sessions in other statuses, use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessions.html">DescribeGameSessions</a> .</p>
51
- * <p>You can search or sort by the following game session attributes:</p>
52
- * <ul>
51
+ * <p>You can search or sort by the following game session attributes:</p>
52
+ * <ul>
53
53
  * <li>
54
- * <p>
54
+ * <p>
55
55
  * <b>gameSessionId</b> -- A unique identifier for the game session. You can use either a
56
56
  * <code>GameSessionId</code> or <code>GameSessionArn</code> value. </p>
57
57
  * </li>
58
58
  * <li>
59
- * <p>
59
+ * <p>
60
60
  * <b>gameSessionName</b> -- Name assigned to a game
61
61
  * session. Game session names do not need to be unique to a game session.</p>
62
62
  * </li>
63
63
  * <li>
64
- * <p>
64
+ * <p>
65
65
  * <b>gameSessionProperties</b> -- Custom data defined
66
66
  * in a game session's <code>GameProperty</code> parameter.
67
67
  * <code>GameProperty</code> values are stored as key:value pairs; the filter
@@ -72,23 +72,23 @@ export interface SearchGameSessionsCommandOutput extends SearchGameSessionsOutpu
72
72
  * values are searched as strings.</p>
73
73
  * </li>
74
74
  * <li>
75
- * <p>
75
+ * <p>
76
76
  * <b>maximumSessions</b> -- Maximum number of player
77
77
  * sessions allowed for a game session.</p>
78
78
  * </li>
79
79
  * <li>
80
- * <p>
80
+ * <p>
81
81
  * <b>creationTimeMillis</b> -- Value indicating when a
82
82
  * game session was created. It is expressed in Unix time as milliseconds.</p>
83
83
  * </li>
84
84
  * <li>
85
- * <p>
85
+ * <p>
86
86
  * <b>playerSessionCount</b> -- Number of players
87
87
  * currently connected to a game session. This value changes rapidly as players
88
88
  * join the session or drop out.</p>
89
89
  * </li>
90
90
  * <li>
91
- * <p>
91
+ * <p>
92
92
  * <b>hasAvailablePlayerSessions</b> -- Boolean value
93
93
  * indicating whether a game session has reached its maximum number of players. It
94
94
  * is highly recommended that all search requests include this filter attribute to
@@ -96,15 +96,15 @@ export interface SearchGameSessionsCommandOutput extends SearchGameSessionsOutpu
96
96
  * </p>
97
97
  * </li>
98
98
  * </ul>
99
- * <note>
99
+ * <note>
100
100
  * <p>Returned values for <code>playerSessionCount</code> and
101
101
  * <code>hasAvailablePlayerSessions</code> change quickly as players join sessions
102
102
  * and others drop out. Results should be considered a snapshot in time. Be sure to
103
103
  * refresh search results often, and handle sessions that fill up before a player can
104
104
  * join. </p>
105
- * </note>
105
+ * </note>
106
106
  * <p>
107
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
107
+ * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
108
108
  * </p>
109
109
  * @example
110
110
  * Use a bare-bones client and the command you need to make an API call.
@@ -22,25 +22,25 @@ export interface StartFleetActionsCommandOutput extends StartFleetActionsOutput,
22
22
  * <p>Resumes certain types of activity on fleet instances that were suspended with <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleetActions.html">StopFleetActions</a>. For multi-location fleets, fleet actions are managed
23
23
  * separately for each location. Currently, this operation is used to restart a fleet's
24
24
  * auto-scaling activity.</p>
25
- * <p>This operation can be used in the following ways: </p>
26
- * <ul>
25
+ * <p>This operation can be used in the following ways: </p>
26
+ * <ul>
27
27
  * <li>
28
- * <p>To restart actions on instances in the fleet's home Region, provide a fleet ID
28
+ * <p>To restart actions on instances in the fleet's home Region, provide a fleet ID
29
29
  * and the type of actions to resume. </p>
30
30
  * </li>
31
31
  * <li>
32
- * <p>To restart actions on instances in one of the fleet's remote locations,
32
+ * <p>To restart actions on instances in one of the fleet's remote locations,
33
33
  * provide a fleet ID, a location name, and the type of actions to resume. </p>
34
34
  * </li>
35
35
  * </ul>
36
- * <p>If successful, GameLift once again initiates scaling events as triggered by the fleet's
36
+ * <p>If successful, Amazon GameLift once again initiates scaling events as triggered by the fleet's
37
37
  * scaling policies. If actions on the fleet location were never stopped, this operation
38
38
  * will have no effect.</p>
39
39
  * <p>
40
40
  * <b>Learn more</b>
41
41
  * </p>
42
42
  * <p>
43
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
43
+ * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift
44
44
  * fleets</a>
45
45
  * </p>
46
46
  * @example
@@ -22,40 +22,40 @@ export interface StartGameSessionPlacementCommandOutput extends StartGameSession
22
22
  * <p>Places a request for a new game session in a queue. When processing a placement
23
23
  * request, Amazon GameLift searches for available resources on the queue's destinations, scanning
24
24
  * each until it finds resources or the placement request times out.</p>
25
- * <p>A game session placement request can also request player sessions. When a new game
25
+ * <p>A game session placement request can also request player sessions. When a new game
26
26
  * session is successfully created, Amazon GameLift creates a player session for each player
27
27
  * included in the request.</p>
28
- * <p>When placing a game session, by default Amazon GameLift tries each fleet in the order they are
28
+ * <p>When placing a game session, by default Amazon GameLift tries each fleet in the order they are
29
29
  * listed in the queue configuration. Ideally, a queue's destinations are listed in
30
30
  * preference order.</p>
31
- * <p>Alternatively, when requesting a game session with players, you can also provide
31
+ * <p>Alternatively, when requesting a game session with players, you can also provide
32
32
  * latency data for each player in relevant Regions. Latency data indicates the performance
33
33
  * lag a player experiences when connected to a fleet in the Region. Amazon GameLift uses latency
34
34
  * data to reorder the list of destinations to place the game session in a Region with
35
35
  * minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each
36
36
  * Region's average lag for all players and reorders to get the best game play across all
37
37
  * players. </p>
38
- * <p>To place a new game session request, specify the following:</p>
39
- * <ul>
38
+ * <p>To place a new game session request, specify the following:</p>
39
+ * <ul>
40
40
  * <li>
41
- * <p>The queue name and a set of game session properties and settings</p>
41
+ * <p>The queue name and a set of game session properties and settings</p>
42
42
  * </li>
43
43
  * <li>
44
- * <p>A unique ID (such as a UUID) for the placement. You use this ID to track the
44
+ * <p>A unique ID (such as a UUID) for the placement. You use this ID to track the
45
45
  * status of the placement request</p>
46
46
  * </li>
47
47
  * <li>
48
- * <p>(Optional) A set of player data and a unique player ID for each player that
48
+ * <p>(Optional) A set of player data and a unique player ID for each player that
49
49
  * you are joining to the new game session (player data is optional, but if you
50
50
  * include it, you must also provide a unique ID for each player)</p>
51
51
  * </li>
52
52
  * <li>
53
- * <p>Latency data for all players (if you want to optimize game play for the
53
+ * <p>Latency data for all players (if you want to optimize game play for the
54
54
  * players)</p>
55
55
  * </li>
56
56
  * </ul>
57
- * <p>If successful, a new game session placement is created.</p>
58
- * <p>To track the status of a placement request, call <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionPlacement.html">DescribeGameSessionPlacement</a> and check the request's status. If the status
57
+ * <p>If successful, a new game session placement is created.</p>
58
+ * <p>To track the status of a placement request, call <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionPlacement.html">DescribeGameSessionPlacement</a> and check the request's status. If the status
59
59
  * is <code>FULFILLED</code>, a new game session has been created and a game session ARN
60
60
  * and Region are referenced. If the placement request times out, you can resubmit the
61
61
  * request or retry it with a different queue. </p>
@@ -25,7 +25,7 @@ export interface StartMatchBackfillCommandOutput extends StartMatchBackfillOutpu
25
25
  * provide matchmaking data for all players currently in the game session. FlexMatch uses
26
26
  * this information to select new players so that backfilled match continues to meet the
27
27
  * original match requirements. </p>
28
- * <p>When using FlexMatch with GameLift managed hosting, you can request a backfill match from
28
+ * <p>When using FlexMatch with Amazon GameLift managed hosting, you can request a backfill match from
29
29
  * a client service by calling this operation with a <code>GameSessions</code> ID. You also
30
30
  * have the option of making backfill requests directly from your game server. In response
31
31
  * to a request, FlexMatch creates player sessions for the new players, updates the
@@ -33,29 +33,29 @@ export interface StartMatchBackfillCommandOutput extends StartMatchBackfillOutpu
33
33
  * server. You can request a backfill match at any point after a game session is started.
34
34
  * Each game session can have only one active backfill request at a time; a subsequent
35
35
  * request automatically replaces the earlier request.</p>
36
- * <p>When using FlexMatch as a standalone component, request a backfill match by calling this
36
+ * <p>When using FlexMatch as a standalone component, request a backfill match by calling this
37
37
  * operation without a game session identifier. As with newly formed matches, matchmaking
38
38
  * results are returned in a matchmaking event so that your game can update the game
39
39
  * session that is being backfilled.</p>
40
- * <p>To request a backfill match, specify a unique ticket ID, the original matchmaking
40
+ * <p>To request a backfill match, specify a unique ticket ID, the original matchmaking
41
41
  * configuration, and matchmaking data for all current players in the game session being
42
42
  * backfilled. Optionally, specify the <code>GameSession</code> ARN. If successful, a match
43
43
  * backfill ticket is created and returned with status set to QUEUED. Track the status of
44
44
  * backfill tickets using the same method for tracking tickets for new matches.</p>
45
- * <p>Only game sessions created by FlexMatch are supported for match backfill.</p>
46
- * <p>
45
+ * <p>Only game sessions created by FlexMatch are supported for match backfill.</p>
46
+ * <p>
47
47
  * <b>Learn more</b>
48
48
  * </p>
49
- * <p>
49
+ * <p>
50
50
  * <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html">
51
51
  * Backfill existing games with FlexMatch</a>
52
52
  * </p>
53
- * <p>
53
+ * <p>
54
54
  * <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html">
55
55
  * Matchmaking events</a> (reference)</p>
56
- * <p>
56
+ * <p>
57
57
  * <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html">
58
- * How GameLift FlexMatch works</a>
58
+ * How Amazon GameLift FlexMatch works</a>
59
59
  * </p>
60
60
  * @example
61
61
  * Use a bare-bones client and the command you need to make an API call.
@@ -20,34 +20,34 @@ export interface StartMatchmakingCommandOutput extends StartMatchmakingOutput, _
20
20
  /**
21
21
  * @public
22
22
  * <p>Uses FlexMatch to create a game match for a group of players based on custom matchmaking
23
- * rules. With games that use GameLift managed hosting, this operation also triggers GameLift
23
+ * rules. With games that use Amazon GameLift managed hosting, this operation also triggers Amazon GameLift
24
24
  * to find hosting resources and start a new game session for the new match. Each
25
25
  * matchmaking request includes information on one or more players and specifies the
26
26
  * FlexMatch matchmaker to use. When a request is for multiple players, FlexMatch attempts to
27
27
  * build a match that includes all players in the request, placing them in the same team
28
28
  * and finding additional players as needed to fill the match. </p>
29
- * <p>To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration,
29
+ * <p>To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration,
30
30
  * and include the players to be matched. You must also include any player attributes that
31
31
  * are required by the matchmaking configuration's rule set. If successful, a matchmaking
32
32
  * ticket is returned with status set to <code>QUEUED</code>. </p>
33
- * <p>Track matchmaking events to respond as needed and acquire game session connection
33
+ * <p>Track matchmaking events to respond as needed and acquire game session connection
34
34
  * information for successfully completed matches. Ticket status updates are tracked using
35
35
  * event notification through Amazon Simple Notification Service, which is defined in the matchmaking
36
36
  * configuration.</p>
37
- * <p>
37
+ * <p>
38
38
  * <b>Learn more</b>
39
39
  * </p>
40
- * <p>
40
+ * <p>
41
41
  * <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html">
42
42
  * Add FlexMatch to a game client</a>
43
43
  * </p>
44
- * <p>
44
+ * <p>
45
45
  * <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html"> Set Up FlexMatch event
46
46
  * notification</a>
47
47
  * </p>
48
- * <p>
48
+ * <p>
49
49
  * <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html">
50
- * How GameLift FlexMatch works</a>
50
+ * How Amazon GameLift FlexMatch works</a>
51
51
  * </p>
52
52
  * @example
53
53
  * Use a bare-bones client and the command you need to make an API call.
@@ -22,28 +22,28 @@ export interface StopFleetActionsCommandOutput extends StopFleetActionsOutput, _
22
22
  * <p>Suspends certain types of activity in a fleet location. Currently, this operation is
23
23
  * used to stop auto-scaling activity. For multi-location fleets, fleet actions are managed
24
24
  * separately for each location. </p>
25
- * <p>Stopping fleet actions has several potential purposes. It allows you to temporarily
25
+ * <p>Stopping fleet actions has several potential purposes. It allows you to temporarily
26
26
  * stop auto-scaling activity but retain your scaling policies for use in the future. For
27
27
  * multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out of it
28
28
  * for certain locations. </p>
29
- * <p>This operation can be used in the following ways: </p>
30
- * <ul>
29
+ * <p>This operation can be used in the following ways: </p>
30
+ * <ul>
31
31
  * <li>
32
- * <p>To stop actions on instances in the fleet's home Region, provide a fleet ID
32
+ * <p>To stop actions on instances in the fleet's home Region, provide a fleet ID
33
33
  * and the type of actions to suspend. </p>
34
34
  * </li>
35
35
  * <li>
36
- * <p>To stop actions on instances in one of the fleet's remote locations, provide a
36
+ * <p>To stop actions on instances in one of the fleet's remote locations, provide a
37
37
  * fleet ID, a location name, and the type of actions to suspend. </p>
38
38
  * </li>
39
39
  * </ul>
40
- * <p>If successful, GameLift no longer initiates scaling events except in response to manual
40
+ * <p>If successful, Amazon GameLift no longer initiates scaling events except in response to manual
41
41
  * changes using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html">UpdateFleetCapacity</a>.</p>
42
42
  * <p>
43
43
  * <b>Learn more</b>
44
44
  * </p>
45
45
  * <p>
46
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
46
+ * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift
47
47
  * Fleets</a>
48
48
  * </p>
49
49
  * @example
@@ -23,18 +23,18 @@ export interface StopMatchmakingCommandOutput extends StopMatchmakingOutput, __M
23
23
  * processed. To stop the matchmaking operation, specify the ticket ID. If successful, work
24
24
  * on the ticket is stopped, and the ticket status is changed to
25
25
  * <code>CANCELLED</code>.</p>
26
- * <p>This call is also used to turn off automatic backfill for an individual game session.
26
+ * <p>This call is also used to turn off automatic backfill for an individual game session.
27
27
  * This is for game sessions that are created with a matchmaking configuration that has
28
28
  * automatic backfill enabled. The ticket ID is included in the <code>MatchmakerData</code>
29
29
  * of an updated game session object, which is provided to the game server.</p>
30
- * <note>
30
+ * <note>
31
31
  * <p>If the operation is successful, the service sends back an empty JSON struct with
32
32
  * the HTTP 200 response (not an empty HTTP body).</p>
33
- * </note>
34
- * <p>
33
+ * </note>
34
+ * <p>
35
35
  * <b>Learn more</b>
36
36
  * </p>
37
- * <p>
37
+ * <p>
38
38
  * <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html">
39
39
  * Add FlexMatch to a game client</a>
40
40
  * </p>
@@ -20,14 +20,14 @@ export interface SuspendGameServerGroupCommandOutput extends SuspendGameServerGr
20
20
  /**
21
21
  * @public
22
22
  * <p>
23
- * <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b>
23
+ * <b>This operation is used with the Amazon GameLift FleetIQ solution and game server groups.</b>
24
24
  * </p>
25
25
  * <p>Temporarily stops activity on
26
26
  * a game server group without terminating instances or the game server group. You can
27
27
  * restart activity by calling <a href="gamelift/latest/apireference/API_ResumeGameServerGroup.html">ResumeGameServerGroup</a>. You can suspend the following activity:</p>
28
- * <ul>
28
+ * <ul>
29
29
  * <li>
30
- * <p>
30
+ * <p>
31
31
  * <b>Instance type replacement</b> - This activity
32
32
  * evaluates the current game hosting viability of all Spot instance types that are
33
33
  * defined for the game server group. It updates the Auto Scaling group to remove
@@ -39,16 +39,16 @@ export interface SuspendGameServerGroupCommandOutput extends SuspendGameServerGr
39
39
  * active. </p>
40
40
  * </li>
41
41
  * </ul>
42
- * <p>To suspend activity, specify a game server group ARN and the type of activity to be
42
+ * <p>To suspend activity, specify a game server group ARN and the type of activity to be
43
43
  * suspended. If successful, a <code>GameServerGroup</code> object is returned showing that
44
44
  * the activity is listed in <code>SuspendedActions</code>.</p>
45
- * <p>
45
+ * <p>
46
46
  * <b>Learn more</b>
47
47
  * </p>
48
- * <p>
49
- * <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ
48
+ * <p>
49
+ * <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">Amazon GameLift FleetIQ
50
50
  * Guide</a>
51
- * </p>
51
+ * </p>
52
52
  * @example
53
53
  * Use a bare-bones client and the command you need to make an API call.
54
54
  * ```javascript