@aws-sdk/client-gamelift 3.922.0 → 3.926.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 (124) hide show
  1. package/dist-cjs/index.js +1 -0
  2. package/dist-es/models/models_0.js +1 -0
  3. package/dist-types/auth/httpAuthSchemeProvider.d.ts +1 -1
  4. package/dist-types/commands/AcceptMatchCommand.d.ts +3 -1
  5. package/dist-types/commands/ClaimGameServerCommand.d.ts +1 -2
  6. package/dist-types/commands/CreateAliasCommand.d.ts +3 -1
  7. package/dist-types/commands/CreateBuildCommand.d.ts +5 -3
  8. package/dist-types/commands/CreateContainerFleetCommand.d.ts +16 -3
  9. package/dist-types/commands/CreateContainerGroupDefinitionCommand.d.ts +3 -1
  10. package/dist-types/commands/CreateFleetCommand.d.ts +15 -3
  11. package/dist-types/commands/CreateFleetLocationsCommand.d.ts +3 -1
  12. package/dist-types/commands/CreateGameServerGroupCommand.d.ts +1 -2
  13. package/dist-types/commands/CreateGameSessionCommand.d.ts +3 -1
  14. package/dist-types/commands/CreateGameSessionQueueCommand.d.ts +3 -1
  15. package/dist-types/commands/CreateLocationCommand.d.ts +3 -1
  16. package/dist-types/commands/CreateMatchmakingConfigurationCommand.d.ts +3 -1
  17. package/dist-types/commands/CreateMatchmakingRuleSetCommand.d.ts +3 -1
  18. package/dist-types/commands/CreatePlayerSessionCommand.d.ts +3 -1
  19. package/dist-types/commands/CreatePlayerSessionsCommand.d.ts +3 -1
  20. package/dist-types/commands/CreateScriptCommand.d.ts +3 -1
  21. package/dist-types/commands/CreateVpcPeeringAuthorizationCommand.d.ts +3 -1
  22. package/dist-types/commands/CreateVpcPeeringConnectionCommand.d.ts +3 -1
  23. package/dist-types/commands/DeleteAliasCommand.d.ts +3 -1
  24. package/dist-types/commands/DeleteBuildCommand.d.ts +3 -1
  25. package/dist-types/commands/DeleteContainerFleetCommand.d.ts +3 -1
  26. package/dist-types/commands/DeleteContainerGroupDefinitionCommand.d.ts +3 -1
  27. package/dist-types/commands/DeleteFleetCommand.d.ts +3 -1
  28. package/dist-types/commands/DeleteFleetLocationsCommand.d.ts +3 -1
  29. package/dist-types/commands/DeleteGameServerGroupCommand.d.ts +1 -2
  30. package/dist-types/commands/DeleteGameSessionQueueCommand.d.ts +3 -1
  31. package/dist-types/commands/DeleteLocationCommand.d.ts +3 -1
  32. package/dist-types/commands/DeleteMatchmakingConfigurationCommand.d.ts +3 -1
  33. package/dist-types/commands/DeleteMatchmakingRuleSetCommand.d.ts +3 -1
  34. package/dist-types/commands/DeleteScalingPolicyCommand.d.ts +3 -1
  35. package/dist-types/commands/DeleteScriptCommand.d.ts +3 -1
  36. package/dist-types/commands/DeleteVpcPeeringAuthorizationCommand.d.ts +3 -1
  37. package/dist-types/commands/DeleteVpcPeeringConnectionCommand.d.ts +3 -1
  38. package/dist-types/commands/DeregisterComputeCommand.d.ts +3 -1
  39. package/dist-types/commands/DeregisterGameServerCommand.d.ts +1 -2
  40. package/dist-types/commands/DescribeAliasCommand.d.ts +3 -1
  41. package/dist-types/commands/DescribeBuildCommand.d.ts +4 -2
  42. package/dist-types/commands/DescribeComputeCommand.d.ts +4 -2
  43. package/dist-types/commands/DescribeContainerFleetCommand.d.ts +3 -1
  44. package/dist-types/commands/DescribeContainerGroupDefinitionCommand.d.ts +3 -1
  45. package/dist-types/commands/DescribeEC2InstanceLimitsCommand.d.ts +3 -1
  46. package/dist-types/commands/DescribeFleetAttributesCommand.d.ts +4 -2
  47. package/dist-types/commands/DescribeFleetCapacityCommand.d.ts +3 -1
  48. package/dist-types/commands/DescribeFleetDeploymentCommand.d.ts +3 -1
  49. package/dist-types/commands/DescribeFleetEventsCommand.d.ts +4 -3
  50. package/dist-types/commands/DescribeFleetLocationAttributesCommand.d.ts +3 -1
  51. package/dist-types/commands/DescribeFleetLocationCapacityCommand.d.ts +3 -1
  52. package/dist-types/commands/DescribeFleetLocationUtilizationCommand.d.ts +3 -1
  53. package/dist-types/commands/DescribeFleetPortSettingsCommand.d.ts +3 -1
  54. package/dist-types/commands/DescribeFleetUtilizationCommand.d.ts +3 -1
  55. package/dist-types/commands/DescribeGameServerCommand.d.ts +1 -2
  56. package/dist-types/commands/DescribeGameServerGroupCommand.d.ts +1 -2
  57. package/dist-types/commands/DescribeGameServerInstancesCommand.d.ts +1 -2
  58. package/dist-types/commands/DescribeGameSessionDetailsCommand.d.ts +3 -1
  59. package/dist-types/commands/DescribeGameSessionPlacementCommand.d.ts +3 -1
  60. package/dist-types/commands/DescribeGameSessionQueuesCommand.d.ts +3 -1
  61. package/dist-types/commands/DescribeGameSessionsCommand.d.ts +3 -1
  62. package/dist-types/commands/DescribeInstancesCommand.d.ts +4 -2
  63. package/dist-types/commands/DescribeMatchmakingCommand.d.ts +3 -1
  64. package/dist-types/commands/DescribeMatchmakingConfigurationsCommand.d.ts +3 -1
  65. package/dist-types/commands/DescribeMatchmakingRuleSetsCommand.d.ts +3 -1
  66. package/dist-types/commands/DescribePlayerSessionsCommand.d.ts +3 -1
  67. package/dist-types/commands/DescribeRuntimeConfigurationCommand.d.ts +4 -3
  68. package/dist-types/commands/DescribeScalingPoliciesCommand.d.ts +3 -1
  69. package/dist-types/commands/DescribeScriptCommand.d.ts +3 -1
  70. package/dist-types/commands/DescribeVpcPeeringAuthorizationsCommand.d.ts +3 -1
  71. package/dist-types/commands/DescribeVpcPeeringConnectionsCommand.d.ts +3 -1
  72. package/dist-types/commands/GetComputeAccessCommand.d.ts +3 -1
  73. package/dist-types/commands/GetComputeAuthTokenCommand.d.ts +3 -1
  74. package/dist-types/commands/GetGameSessionLogUrlCommand.d.ts +3 -1
  75. package/dist-types/commands/GetInstanceAccessCommand.d.ts +4 -2
  76. package/dist-types/commands/ListAliasesCommand.d.ts +3 -1
  77. package/dist-types/commands/ListBuildsCommand.d.ts +5 -3
  78. package/dist-types/commands/ListComputeCommand.d.ts +4 -2
  79. package/dist-types/commands/ListContainerFleetsCommand.d.ts +3 -1
  80. package/dist-types/commands/ListContainerGroupDefinitionVersionsCommand.d.ts +3 -1
  81. package/dist-types/commands/ListContainerGroupDefinitionsCommand.d.ts +3 -1
  82. package/dist-types/commands/ListFleetDeploymentsCommand.d.ts +3 -1
  83. package/dist-types/commands/ListFleetsCommand.d.ts +3 -1
  84. package/dist-types/commands/ListGameServerGroupsCommand.d.ts +3 -1
  85. package/dist-types/commands/ListGameServersCommand.d.ts +1 -2
  86. package/dist-types/commands/ListLocationsCommand.d.ts +3 -1
  87. package/dist-types/commands/ListScriptsCommand.d.ts +3 -1
  88. package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -1
  89. package/dist-types/commands/PutScalingPolicyCommand.d.ts +3 -1
  90. package/dist-types/commands/RegisterComputeCommand.d.ts +4 -2
  91. package/dist-types/commands/RegisterGameServerCommand.d.ts +1 -2
  92. package/dist-types/commands/RequestUploadCredentialsCommand.d.ts +3 -1
  93. package/dist-types/commands/ResolveAliasCommand.d.ts +3 -1
  94. package/dist-types/commands/ResumeGameServerGroupCommand.d.ts +1 -2
  95. package/dist-types/commands/SearchGameSessionsCommand.d.ts +3 -1
  96. package/dist-types/commands/StartFleetActionsCommand.d.ts +3 -1
  97. package/dist-types/commands/StartGameSessionPlacementCommand.d.ts +3 -1
  98. package/dist-types/commands/StartMatchBackfillCommand.d.ts +3 -1
  99. package/dist-types/commands/StartMatchmakingCommand.d.ts +3 -1
  100. package/dist-types/commands/StopFleetActionsCommand.d.ts +3 -1
  101. package/dist-types/commands/StopGameSessionPlacementCommand.d.ts +3 -1
  102. package/dist-types/commands/StopMatchmakingCommand.d.ts +3 -1
  103. package/dist-types/commands/SuspendGameServerGroupCommand.d.ts +1 -2
  104. package/dist-types/commands/TagResourceCommand.d.ts +3 -1
  105. package/dist-types/commands/TerminateGameSessionCommand.d.ts +3 -1
  106. package/dist-types/commands/UntagResourceCommand.d.ts +3 -1
  107. package/dist-types/commands/UpdateAliasCommand.d.ts +5 -2
  108. package/dist-types/commands/UpdateBuildCommand.d.ts +4 -2
  109. package/dist-types/commands/UpdateContainerFleetCommand.d.ts +11 -1
  110. package/dist-types/commands/UpdateContainerGroupDefinitionCommand.d.ts +3 -1
  111. package/dist-types/commands/UpdateFleetAttributesCommand.d.ts +11 -1
  112. package/dist-types/commands/UpdateFleetCapacityCommand.d.ts +3 -1
  113. package/dist-types/commands/UpdateFleetPortSettingsCommand.d.ts +3 -1
  114. package/dist-types/commands/UpdateGameServerCommand.d.ts +1 -2
  115. package/dist-types/commands/UpdateGameServerGroupCommand.d.ts +1 -2
  116. package/dist-types/commands/UpdateGameSessionCommand.d.ts +8 -1
  117. package/dist-types/commands/UpdateGameSessionQueueCommand.d.ts +3 -1
  118. package/dist-types/commands/UpdateMatchmakingConfigurationCommand.d.ts +3 -1
  119. package/dist-types/commands/UpdateRuntimeConfigurationCommand.d.ts +3 -1
  120. package/dist-types/commands/UpdateScriptCommand.d.ts +3 -1
  121. package/dist-types/commands/ValidateMatchmakingRuleSetCommand.d.ts +3 -1
  122. package/dist-types/models/models_0.d.ts +12 -32
  123. package/dist-types/ts3.4/models/models_0.d.ts +1 -0
  124. package/package.json +8 -8
package/dist-cjs/index.js CHANGED
@@ -196,6 +196,7 @@ const OperatingSystem = {
196
196
  AMAZON_LINUX_2023: "AMAZON_LINUX_2023",
197
197
  WINDOWS_2012: "WINDOWS_2012",
198
198
  WINDOWS_2016: "WINDOWS_2016",
199
+ WINDOWS_2022: "WINDOWS_2022",
199
200
  };
200
201
  const BuildStatus = {
201
202
  FAILED: "FAILED",
@@ -79,6 +79,7 @@ export const OperatingSystem = {
79
79
  AMAZON_LINUX_2023: "AMAZON_LINUX_2023",
80
80
  WINDOWS_2012: "WINDOWS_2012",
81
81
  WINDOWS_2016: "WINDOWS_2016",
82
+ WINDOWS_2022: "WINDOWS_2022",
82
83
  };
83
84
  export const BuildStatus = {
84
85
  FAILED: "FAILED",
@@ -26,7 +26,7 @@ export interface GameLiftHttpAuthSchemeProvider extends HttpAuthSchemeProvider<G
26
26
  */
27
27
  export declare const defaultGameLiftHttpAuthSchemeProvider: GameLiftHttpAuthSchemeProvider;
28
28
  /**
29
- * @internal
29
+ * @public
30
30
  */
31
31
  export interface HttpAuthSchemeInputConfig extends AwsSdkSigV4AuthInputConfig {
32
32
  /**
@@ -27,7 +27,9 @@ declare const AcceptMatchCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Registers a player's acceptance or rejection of a proposed FlexMatch match. A
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> EC2, Anywhere, Container</p>
32
+ * <p>Registers a player's acceptance or rejection of a proposed FlexMatch match. A
31
33
  * matchmaking configuration may require player acceptance; if so, then matches built with
32
34
  * that configuration cannot be completed unless all players accept the proposed match
33
35
  * within a specified time limit. </p>
@@ -28,8 +28,7 @@ declare const ClaimGameServerCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>
31
- * <b>This operation is used with the Amazon GameLift Servers FleetIQ solution and game server groups.</b>
32
- * </p>
31
+ * <b>This API works with the following fleet types:</b> EC2 (FleetIQ)</p>
33
32
  * <p>Locates an available game server and
34
33
  * temporarily reserves it to host gameplay and players. This operation is called from a
35
34
  * game client or client service (such as a matchmaker) to request hosting resources for a
@@ -27,7 +27,9 @@ declare const CreateAliasCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates an alias for a fleet. In most situations, you can use an alias ID in place of
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> EC2, Anywhere, Container</p>
32
+ * <p>Creates an alias for a fleet. In most situations, you can use an alias ID in place of
31
33
  * a fleet ID. An alias provides a level of abstraction for a fleet that is useful when
32
34
  * redirecting player traffic from one fleet to another, such as when updating your game
33
35
  * build. </p>
@@ -27,7 +27,9 @@ declare const CreateBuildCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a new Amazon GameLift Servers build resource for your game server binary files. Combine game
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> EC2, Anywhere</p>
32
+ * <p>Creates a new Amazon GameLift Servers build resource for your game server binary files. Combine game
31
33
  * server binaries into a zip file for use with Amazon GameLift Servers. </p>
32
34
  * <important>
33
35
  * <p>When setting up a new game build for Amazon GameLift Servers, we recommend using the CLI command <b>
@@ -87,7 +89,7 @@ declare const CreateBuildCommand_base: {
87
89
  * RoleArn: "STRING_VALUE",
88
90
  * ObjectVersion: "STRING_VALUE",
89
91
  * },
90
- * OperatingSystem: "WINDOWS_2012" || "AMAZON_LINUX" || "AMAZON_LINUX_2" || "WINDOWS_2016" || "AMAZON_LINUX_2023",
92
+ * OperatingSystem: "WINDOWS_2012" || "AMAZON_LINUX" || "AMAZON_LINUX_2" || "WINDOWS_2016" || "AMAZON_LINUX_2023" || "WINDOWS_2022",
91
93
  * Tags: [ // TagList
92
94
  * { // Tag
93
95
  * Key: "STRING_VALUE", // required
@@ -106,7 +108,7 @@ declare const CreateBuildCommand_base: {
106
108
  * // Version: "STRING_VALUE",
107
109
  * // Status: "INITIALIZED" || "READY" || "FAILED",
108
110
  * // SizeOnDisk: Number("long"),
109
- * // OperatingSystem: "WINDOWS_2012" || "AMAZON_LINUX" || "AMAZON_LINUX_2" || "WINDOWS_2016" || "AMAZON_LINUX_2023",
111
+ * // OperatingSystem: "WINDOWS_2012" || "AMAZON_LINUX" || "AMAZON_LINUX_2" || "WINDOWS_2016" || "AMAZON_LINUX_2023" || "WINDOWS_2022",
110
112
  * // CreationTime: new Date("TIMESTAMP"),
111
113
  * // ServerSdkVersion: "STRING_VALUE",
112
114
  * // },
@@ -27,7 +27,9 @@ declare const CreateContainerFleetCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a managed fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances to host your containerized game
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> Container</p>
32
+ * <p>Creates a managed fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances to host your containerized game
31
33
  * servers. Use this operation to define how to deploy a container architecture onto each
32
34
  * fleet instance and configure fleet settings. You can create a container fleet in any
33
35
  * Amazon Web Services Regions that Amazon GameLift Servers supports for multi-location fleets. A container fleet can be
@@ -118,8 +120,19 @@ declare const CreateContainerFleetCommand_base: {
118
120
  * starts a fleet deployment and transitions the status to <code>ACTIVE</code>. Fleets
119
121
  * without a container group are placed in <code>CREATED</code> status.</p>
120
122
  * <p>You can update most of the properties of a fleet, including container group
121
- * definitions, and deploy the update across all fleet instances. Use a fleet update to
122
- * deploy a new game server version update across the container fleet. </p>
123
+ * definitions, and deploy the update across all fleet instances. Use
124
+ * <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateContainerFleet.html">UpdateContainerFleet</a>
125
+ * to deploy a new game server version update across the container fleet. </p>
126
+ * <note>
127
+ * <p>A managed fleet's runtime environment depends on the Amazon Machine Image (AMI)
128
+ * version it uses. When a new fleet is created, Amazon GameLift Servers assigns the
129
+ * latest available AMI version to the fleet, and all compute instances in that fleet
130
+ * are deployed with that version. To update the AMI version, you must create a new
131
+ * fleet. As a best practice, we recommend replacing your managed fleets every 30
132
+ * days to maintain a secure and up-to-date runtime environment for your hosted game
133
+ * servers. For guidance, see <a href="https://docs.aws.amazon.com/gameliftservers/latest/developerguide/security-best-practices.html">
134
+ * Security best practices for Amazon GameLift Servers</a>.</p>
135
+ * </note>
123
136
  * @example
124
137
  * Use a bare-bones client and the command you need to make an API call.
125
138
  * ```javascript
@@ -27,7 +27,9 @@ declare const CreateContainerGroupDefinitionCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a <code>ContainerGroupDefinition</code> that describes a set of containers for
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> Container</p>
32
+ * <p>Creates a <code>ContainerGroupDefinition</code> that describes a set of containers for
31
33
  * hosting your game server with Amazon GameLift Servers managed containers hosting. An Amazon GameLift Servers container group
32
34
  * is similar to a container task or pod. Use container group definitions when you create a
33
35
  * container fleet with <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateContainerFleet.html">CreateContainerFleet</a>. </p>
@@ -27,8 +27,10 @@ declare const CreateFleetCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a fleet of compute resources to host your game servers. Use this operation to
31
- * set up the following types of fleets based on compute type: </p>
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> EC2, Anywhere, Container</p>
32
+ * <p>Creates a fleet of compute resources to host your game servers. Use this operation to
33
+ * set up a fleet for the following compute types: </p>
32
34
  * <p>
33
35
  * <b>Managed EC2 fleet</b>
34
36
  * </p>
@@ -80,6 +82,16 @@ declare const CreateFleetCommand_base: {
80
82
  * need them and closing them when you're finished. </p>
81
83
  * <p>When the fleet status is ACTIVE, you can adjust capacity settings and turn autoscaling
82
84
  * on/off for each location.</p>
85
+ * <note>
86
+ * <p>A managed fleet's runtime environment depends on the Amazon Machine Image (AMI)
87
+ * version it uses. When a new fleet is created, Amazon GameLift Servers assigns the
88
+ * latest available AMI version to the fleet, and all compute instances in that fleet
89
+ * are deployed with that version. To update the AMI version, you must create a new
90
+ * fleet. As a best practice, we recommend replacing your managed fleets every 30
91
+ * days to maintain a secure and up-to-date runtime environment for your hosted game
92
+ * servers. For guidance, see <a href="https://docs.aws.amazon.com/gameliftservers/latest/developerguide/security-best-practices.html">
93
+ * Security best practices for Amazon GameLift Servers</a>.</p>
94
+ * </note>
83
95
  * <p>
84
96
  * <b>Anywhere fleet</b>
85
97
  * </p>
@@ -212,7 +224,7 @@ declare const CreateFleetCommand_base: {
212
224
  * // "STRING_VALUE",
213
225
  * // ],
214
226
  * // NewGameSessionProtectionPolicy: "NoProtection" || "FullProtection",
215
- * // OperatingSystem: "WINDOWS_2012" || "AMAZON_LINUX" || "AMAZON_LINUX_2" || "WINDOWS_2016" || "AMAZON_LINUX_2023",
227
+ * // OperatingSystem: "WINDOWS_2012" || "AMAZON_LINUX" || "AMAZON_LINUX_2" || "WINDOWS_2016" || "AMAZON_LINUX_2023" || "WINDOWS_2022",
216
228
  * // ResourceCreationLimitPolicy: { // ResourceCreationLimitPolicy
217
229
  * // NewGameSessionsPerCreator: Number("int"),
218
230
  * // PolicyPeriodInMinutes: Number("int"),
@@ -27,7 +27,9 @@ declare const CreateFleetLocationsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Adds remote locations to an EC2 and begins populating the new locations with
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> EC2, Container</p>
32
+ * <p>Adds remote locations to an EC2 and begins populating the new locations with
31
33
  * instances. The new instances conform to the fleet's instance type, auto-scaling, and
32
34
  * other configuration settings.</p>
33
35
  * <note>
@@ -28,8 +28,7 @@ declare const CreateGameServerGroupCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>
31
- * <b>This operation is used with the Amazon GameLift Servers FleetIQ solution and game server groups.</b>
32
- * </p>
31
+ * <b>This API works with the following fleet types:</b> EC2 (FleetIQ)</p>
33
32
  * <p>Creates a Amazon GameLift Servers FleetIQ game server
34
33
  * group for managing game hosting on a collection of Amazon Elastic Compute Cloud instances for game hosting.
35
34
  * This operation creates the game server group, creates an Auto Scaling group in your
@@ -27,7 +27,9 @@ declare const CreateGameSessionCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a multiplayer game session for players in a specific fleet location. This
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> EC2, Anywhere, Container</p>
32
+ * <p>Creates a multiplayer game session for players in a specific fleet location. This
31
33
  * operation prompts an available server process to start a game session and retrieves
32
34
  * connection information for the new game session. As an alternative, consider using the
33
35
  * Amazon GameLift Servers game session placement feature with <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html">StartGameSessionPlacement</a>, which uses the FleetIQ algorithm and queues to
@@ -27,7 +27,9 @@ declare const CreateGameSessionQueueCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a placement queue that processes requests for new game sessions. A queue uses
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> EC2, Anywhere, Container</p>
32
+ * <p>Creates a placement queue that processes requests for new game sessions. A queue uses
31
33
  * FleetIQ algorithms to locate the best available placement locations for a new game
32
34
  * session, and then prompts the game server process to start a new game session.</p>
33
35
  * <p>A game session queue is configured with a set of destinations (Amazon GameLift Servers fleets or
@@ -27,7 +27,9 @@ declare const CreateLocationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a custom location for use in an Anywhere fleet.</p>
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> Anywhere</p>
32
+ * <p>Creates a custom location for use in an Anywhere fleet.</p>
31
33
  * @example
32
34
  * Use a bare-bones client and the command you need to make an API call.
33
35
  * ```javascript
@@ -27,7 +27,9 @@ declare const CreateMatchmakingConfigurationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Defines a new matchmaking configuration for use with FlexMatch. Whether your are using
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> EC2, Anywhere, Container</p>
32
+ * <p>Defines a new matchmaking configuration for use with FlexMatch. Whether your are using
31
33
  * FlexMatch with Amazon GameLift Servers hosting or as a standalone matchmaking service, the matchmaking
32
34
  * configuration sets out rules for matching players and forming teams. If you're also
33
35
  * using Amazon GameLift Servers hosting, it defines how to start game sessions for each match. Your
@@ -27,7 +27,9 @@ declare const CreateMatchmakingRuleSetCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> EC2, Anywhere, Container</p>
32
+ * <p>Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match
31
33
  * to create, such as the number and size of teams. It also sets the parameters for
32
34
  * acceptable player matches, such as minimum skill level or character type.</p>
33
35
  * <p>To create a matchmaking rule set, provide unique rule set name and the rule set body
@@ -27,7 +27,9 @@ declare const CreatePlayerSessionCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Reserves an open player slot in a game session for a player. New player sessions can
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> EC2, Anywhere, Container</p>
32
+ * <p>Reserves an open player slot in a game session for a player. New player sessions can
31
33
  * be created in any game session with an open slot that is in <code>ACTIVE</code> status
32
34
  * and has a player creation policy of <code>ACCEPT_ALL</code>. You can add a group of
33
35
  * players to a game session with <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreatePlayerSessions.html">CreatePlayerSessions</a> . </p>
@@ -27,7 +27,9 @@ declare const CreatePlayerSessionsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Reserves open slots in a game session for a group of players. New player sessions can
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> EC2, Anywhere, Container</p>
32
+ * <p>Reserves open slots in a game session for a group of players. New player sessions can
31
33
  * be created in any game session with an open slot that is in <code>ACTIVE</code> status
32
34
  * and has a player creation policy of <code>ACCEPT_ALL</code>. To add a single player to a
33
35
  * game session, use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreatePlayerSession.html">CreatePlayerSession</a>
@@ -27,7 +27,9 @@ declare const CreateScriptCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a new script record for your Amazon GameLift Servers Realtime script. Realtime scripts are JavaScript that
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> EC2, Anywhere</p>
32
+ * <p>Creates a new script record for your Amazon GameLift Servers Realtime script. Realtime scripts are JavaScript that
31
33
  * provide configuration settings and optional custom game logic for your game. The script
32
34
  * is deployed when you create a Amazon GameLift Servers Realtime fleet to host your game sessions. Script logic is
33
35
  * executed during an active game session. </p>
@@ -27,7 +27,9 @@ declare const CreateVpcPeeringAuthorizationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Requests authorization to create or delete a peer connection between the VPC for your
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> EC2</p>
32
+ * <p>Requests authorization to create or delete a peer connection between the VPC for your
31
33
  * Amazon GameLift Servers fleet and a virtual private cloud (VPC) in your Amazon Web Services account. VPC peering enables the game servers on
32
34
  * your fleet to communicate directly with other Amazon Web Services resources. After you've received
33
35
  * authorization, use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringConnection.html">CreateVpcPeeringConnection</a> to establish the peering connection. For more
@@ -27,7 +27,9 @@ declare const CreateVpcPeeringConnectionCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web Services account with the VPC
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> EC2</p>
32
+ * <p>Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web Services account with the VPC
31
33
  * for your Amazon GameLift Servers fleet. VPC peering enables the game servers on your fleet to communicate
32
34
  * directly with other Amazon Web Services resources. You can peer with VPCs in any Amazon Web Services account that
33
35
  * you have access to, including the account that you use to manage your Amazon GameLift Servers fleets. You
@@ -27,7 +27,9 @@ declare const DeleteAliasCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes an alias. This operation removes all record of the alias. Game clients
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> EC2, Anywhere, Container</p>
32
+ * <p>Deletes an alias. This operation removes all record of the alias. Game clients
31
33
  * attempting to access a server process using the deleted alias receive an error. To
32
34
  * delete an alias, specify the alias ID to be deleted.</p>
33
35
  * <p>
@@ -27,7 +27,9 @@ declare const DeleteBuildCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a build. This operation permanently deletes the build resource and any
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> EC2</p>
32
+ * <p>Deletes a build. This operation permanently deletes the build resource and any
31
33
  * uploaded build files. Deleting a build does not affect the status of any active fleets
32
34
  * using the build, but you can no longer create new fleets with the deleted build.</p>
33
35
  * <p>To delete a build, specify the build ID. </p>
@@ -27,7 +27,9 @@ declare const DeleteContainerFleetCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes all resources and information related to a container fleet and shuts down
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> Container</p>
32
+ * <p>Deletes all resources and information related to a container fleet and shuts down
31
33
  * currently running fleet instances, including those in remote locations. The container
32
34
  * fleet must be in <code>ACTIVE</code> status to be deleted.</p>
33
35
  * <p>To delete a fleet, specify the fleet ID to be terminated. During the deletion process,
@@ -27,10 +27,12 @@ declare const DeleteContainerGroupDefinitionCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a container group definition. </p>
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> Container</p>
31
32
  * <p>
32
33
  * <b>Request options:</b>
33
34
  * </p>
35
+ * <p>Deletes a container group definition. </p>
34
36
  * <ul>
35
37
  * <li>
36
38
  * <p>Delete an entire container group definition, including all versions. Specify the
@@ -27,7 +27,9 @@ declare const DeleteFleetCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes all resources and information related to a fleet and shuts down any currently
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> EC2, Anywhere, Container</p>
32
+ * <p>Deletes all resources and information related to a fleet and shuts down any currently
31
33
  * running fleet instances, including those in remote locations.</p>
32
34
  * <note>
33
35
  * <p>If the fleet being deleted has a VPC peering connection, you first need to get a
@@ -27,7 +27,9 @@ declare const DeleteFleetLocationsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Removes locations from a multi-location fleet. When deleting a location, all game
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> EC2, Container</p>
32
+ * <p>Removes locations from a multi-location fleet. When deleting a location, all game
31
33
  * server process and all instances that are still active in the location are shut down. </p>
32
34
  * <p>To delete fleet locations, identify the fleet ID and provide a list of the locations
33
35
  * to be deleted. </p>
@@ -28,8 +28,7 @@ declare const DeleteGameServerGroupCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>
31
- * <b>This operation is used with the Amazon GameLift Servers FleetIQ solution and game server groups.</b>
32
- * </p>
31
+ * <b>This API works with the following fleet types:</b> EC2 (FleetIQ)</p>
33
32
  * <p>Terminates a game server group
34
33
  * and permanently deletes the game server group record. You have several options for how
35
34
  * these resources are impacted when deleting the game server group. Depending on the type
@@ -27,7 +27,9 @@ declare const DeleteGameSessionQueueCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a game session queue. Once a queue is successfully deleted, unfulfilled <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html">StartGameSessionPlacement</a> requests that reference the queue will fail. To
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> EC2, Anywhere, Container</p>
32
+ * <p>Deletes a game session queue. Once a queue is successfully deleted, unfulfilled <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html">StartGameSessionPlacement</a> requests that reference the queue will fail. To
31
33
  * delete a queue, specify the queue name.</p>
32
34
  * @example
33
35
  * Use a bare-bones client and the command you need to make an API call.
@@ -27,7 +27,9 @@ declare const DeleteLocationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a custom location.</p>
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> Anywhere</p>
32
+ * <p>Deletes a custom location.</p>
31
33
  * <p>Before deleting a custom location, review any fleets currently using the custom
32
34
  * location and deregister the location if it is in use. For more information, see <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeregisterCompute.html">DeregisterCompute</a>.</p>
33
35
  * @example
@@ -27,7 +27,9 @@ declare const DeleteMatchmakingConfigurationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Permanently removes a FlexMatch matchmaking configuration. To delete, specify the
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> EC2, Anywhere, Container</p>
32
+ * <p>Permanently removes a FlexMatch matchmaking configuration. To delete, specify the
31
33
  * configuration name. A matchmaking configuration cannot be deleted if it is being used in
32
34
  * any active matchmaking tickets.</p>
33
35
  * @example
@@ -27,7 +27,9 @@ declare const DeleteMatchmakingRuleSetCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes an existing matchmaking rule set. To delete the rule set, provide the rule set
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> EC2, Anywhere, Container</p>
32
+ * <p>Deletes an existing matchmaking rule set. To delete the rule set, provide the rule set
31
33
  * name. Rule sets cannot be deleted if they are currently being used by a matchmaking
32
34
  * configuration. </p>
33
35
  * <p>
@@ -27,7 +27,9 @@ declare const DeleteScalingPolicyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> EC2</p>
32
+ * <p>Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and
31
33
  * Amazon GameLift Servers removes all record of it. To delete a scaling policy, specify both the scaling
32
34
  * policy name and the fleet ID it is associated with.</p>
33
35
  * <p>To temporarily suspend scaling policies, use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleetActions.html">StopFleetActions</a>. This operation suspends all policies for the
@@ -27,7 +27,9 @@ declare const DeleteScriptCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a Realtime script. This operation permanently deletes the script record. If
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> EC2</p>
32
+ * <p>Deletes a Realtime script. This operation permanently deletes the script record. If
31
33
  * script files were uploaded, they are also deleted (files stored in an S3 bucket are not
32
34
  * deleted). </p>
33
35
  * <p>To delete a script, specify the script ID. Before deleting a script, be sure to
@@ -27,7 +27,9 @@ declare const DeleteVpcPeeringAuthorizationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Cancels a pending VPC peering authorization for the specified VPC. If you need to
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> EC2</p>
32
+ * <p>Cancels a pending VPC peering authorization for the specified VPC. If you need to
31
33
  * delete an existing VPC peering connection, use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteVpcPeeringConnection.html">DeleteVpcPeeringConnection</a>.</p>
32
34
  * <p>
33
35
  * <b>Related actions</b>
@@ -27,7 +27,9 @@ declare const DeleteVpcPeeringConnectionCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Removes a VPC peering connection. To delete the connection, you must have a valid
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> EC2</p>
32
+ * <p>Removes a VPC peering connection. To delete the connection, you must have a valid
31
33
  * authorization for the VPC peering connection that you want to delete.. </p>
32
34
  * <p>Once a valid authorization exists, call this operation from the Amazon Web Services account that is
33
35
  * used to manage the Amazon GameLift Servers fleets. Identify the connection to delete by the connection ID
@@ -27,7 +27,9 @@ declare const DeregisterComputeCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Removes a compute resource from an Anywhere fleet. Deregistered computes can no longer
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> Anywhere</p>
32
+ * <p>Removes a compute resource from an Anywhere fleet. Deregistered computes can no longer
31
33
  * host game sessions through Amazon GameLift Servers. Use this operation with an Anywhere fleet that
32
34
  * doesn't use the Amazon GameLift Servers Agent For Anywhere fleets with the Agent, the Agent handles all
33
35
  * compute registry tasks for you. </p>
@@ -28,8 +28,7 @@ declare const DeregisterGameServerCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>
31
- * <b>This operation is used with the Amazon GameLift Servers FleetIQ solution and game server groups.</b>
32
- * </p>
31
+ * <b>This API works with the following fleet types:</b> EC2 (FleetIQ)</p>
33
32
  * <p>Removes the game server from a
34
33
  * game server group. As a result of this operation, the deregistered game server can no
35
34
  * longer be claimed and will not be returned in a list of active game servers. </p>
@@ -27,7 +27,9 @@ declare const DescribeAliasCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Retrieves properties for an alias. This operation returns all alias metadata and
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> EC2, Anywhere, Container</p>
32
+ * <p>Retrieves properties for an alias. This operation returns all alias metadata and
31
33
  * settings. To get an alias's target fleet ID only, use <code>ResolveAlias</code>. </p>
32
34
  * <p>To get alias properties, specify the alias ID. If successful, the requested alias
33
35
  * record is returned.</p>
@@ -27,7 +27,9 @@ declare const DescribeBuildCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Retrieves properties for a custom game build. To request a build resource, specify a
30
+ * <p>
31
+ * <b>This API works with the following fleet types:</b> EC2</p>
32
+ * <p>Retrieves properties for a custom game build. To request a build resource, specify a
31
33
  * build ID. If successful, an object containing the build properties is returned.</p>
32
34
  * <p>
33
35
  * <b>Learn more</b>
@@ -60,7 +62,7 @@ declare const DescribeBuildCommand_base: {
60
62
  * // Version: "STRING_VALUE",
61
63
  * // Status: "INITIALIZED" || "READY" || "FAILED",
62
64
  * // SizeOnDisk: Number("long"),
63
- * // OperatingSystem: "WINDOWS_2012" || "AMAZON_LINUX" || "AMAZON_LINUX_2" || "WINDOWS_2016" || "AMAZON_LINUX_2023",
65
+ * // OperatingSystem: "WINDOWS_2012" || "AMAZON_LINUX" || "AMAZON_LINUX_2" || "WINDOWS_2016" || "AMAZON_LINUX_2023" || "WINDOWS_2022",
64
66
  * // CreationTime: new Date("TIMESTAMP"),
65
67
  * // ServerSdkVersion: "STRING_VALUE",
66
68
  * // },