@aws-sdk/client-gamelift 3.714.0 → 3.721.0

package/dist-types/commands/DescribeInstancesCommand.d.ts

@@ -30,7 +30,7 @@ declare const DescribeInstancesCommand_base: {
  * <p>Retrieves information about the EC2 instances in an Amazon GameLift managed fleet, including
  *             instance ID, connection data, and status. You can use this operation with a
  *             multi-location fleet to get location-specific instance information. As an alternative,
- *             use the operations <a>ListCompute</a> and <a>DescribeCompute</a>
+ *             use the operations <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListCompute">https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListCompute</a> and <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeCompute">https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeCompute</a>
  *             to retrieve information for compute resources, including EC2 and Anywhere fleets.</p>
  *          <p>You can call this operation in the following ways:</p>
  *          <ul>

package/dist-types/commands/DescribeRuntimeConfigurationCommand.d.ts

@@ -28,9 +28,11 @@ declare const DescribeRuntimeConfigurationCommand_base: {
 };
 /**
  * <p>Retrieves a fleet's runtime configuration settings. The runtime configuration
- *             determines which server processes run, and how they run, and how many run concurrently
- *             on computes in managed EC2 and Anywhere fleets. You can update a fleet's runtime configuration
- *             at any time using <a>UpdateRuntimeConfiguration</a>.</p>
+ *             determines which server processes run, and how, on computes in the fleet. For managed
+ *             EC2 fleets, the runtime configuration describes server processes that run on each fleet
+ *             instance.
+ *             can update a fleet's runtime configuration at any time using
+ *             <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateRuntimeConfiguration.html">UpdateRuntimeConfiguration</a>.</p>
  *          <p>To get the current runtime configuration for a fleet, provide the fleet ID. </p>
  *          <p>If successful, a <code>RuntimeConfiguration</code> object is returned for the
  *             requested fleet. If the requested fleet has been deleted, the result set is

package/dist-types/commands/GetInstanceAccessCommand.d.ts

@@ -30,7 +30,7 @@ declare const GetInstanceAccessCommand_base: {
  * <p>Requests authorization to remotely connect to an instance in an Amazon GameLift managed fleet.
  *             Use this operation to connect to instances with game servers that use Amazon GameLift server SDK
  *             4.x or earlier. To connect to instances with game servers that use server SDK 5.x or
- *             later, call <a>GetComputeAccess</a>.</p>
+ *             later, call <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetComputeAccess">https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetComputeAccess</a>.</p>
  *          <p>To request access to an instance, specify IDs for the instance and the fleet it
  *             belongs to. You can retrieve instance IDs for a fleet by calling <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeInstances.html">DescribeInstances</a> with the fleet ID. </p>
  *          <p>If successful, this operation returns an IP address and credentials. The returned

package/dist-types/commands/ListContainerGroupDefinitionsCommand.d.ts

@@ -30,7 +30,7 @@ declare const ListContainerGroupDefinitionsCommand_base: {
  * <p>Retrieves container group definitions for the Amazon Web Services account and Amazon Web Services Region. Use the pagination parameters to retrieve results in a set of sequential
  *       pages.</p>
  *          <p>This operation returns only the latest version of each definition. To retrieve all
- *       versions of a container group definition, use <a>ListContainerGroupDefinitionVersions</a>.</p>
+ *       versions of a container group definition, use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListContainerGroupDefinitionVersions.html">ListContainerGroupDefinitionVersions</a>.</p>
  *          <p>
  *             <b>Request options:</b>
  *          </p>
@@ -51,16 +51,6 @@ declare const ListContainerGroupDefinitionsCommand_base: {
  *          <note>
  *             <p>This operation returns the list of container group definitions in no particular order. </p>
  *          </note>
- *          <p>
- *             <b>Learn more</b>
- *          </p>
- *          <ul>
- *             <li>
- *                <p>
- *                   <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-create-groups.html">Manage a container group definition</a>
- *                </p>
- *             </li>
- *          </ul>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/ListFleetDeploymentsCommand.d.ts

@@ -27,7 +27,8 @@ declare const ListFleetDeploymentsCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Retrieves a collection of container fleet deployments in an Amazon Web Services Region. </p>
+ * <p>Retrieves a collection of container fleet deployments in an Amazon Web Services Region. Use the
+ *             pagination parameters to retrieve results as a set of sequential pages.  </p>
  *          <p>
  *             <b>Request options</b>
  *          </p>
@@ -38,12 +39,7 @@ declare const ListFleetDeploymentsCommand_base: {
  *             <li>
  *                <p>Get a list of all deployments for a fleet. Specify the container fleet ID or ARN value.</p>
  *             </li>
- *             <li>
- *                <p>To get a list of all Realtime Servers fleets with a specific configuration script,
- *                     provide the script ID. </p>
- *             </li>
  *          </ul>
- *          <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p>
  *          <p>
  *             <b>Results</b>
  *          </p>
@@ -51,7 +47,7 @@ declare const ListFleetDeploymentsCommand_base: {
  *             parameters. A NextToken value is also returned if there are more result pages to
  *             retrieve.</p>
  *          <note>
- *             <p>Fleet IDs are returned in no particular order.</p>
+ *             <p>Deployments are returned starting with the latest.</p>
  *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

package/dist-types/commands/SearchGameSessionsCommand.d.ts

@@ -50,7 +50,7 @@ declare const SearchGameSessionsCommand_base: {
  *          <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p>
  *          <p>If successful, a <code>GameSession</code> object is returned for each game session
  *             that matches the request. Search finds game sessions that are in <code>ACTIVE</code>
- *             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>
+ *             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>
  *          <p>To set search and sort criteria, create a filter expression using the following game session attributes. For game session search examples, see the Examples section of this topic.</p>
  *          <ul>
  *             <li>
@@ -67,7 +67,7 @@ declare const SearchGameSessionsCommand_base: {
  *                <p>
  *                   <b>gameSessionProperties</b> -- A set of key-value pairs that can store custom data in a game session.
  *   For example: <code>\{"Key": "difficulty", "Value": "novice"\}</code>.
- *                     The filter expression must specify the <a>GameProperty</a> -- a <code>Key</code> and a string <code>Value</code> to search for the game sessions.</p>
+ *                     The filter expression must specify the <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameProperty">https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameProperty</a> -- a <code>Key</code> and a string <code>Value</code> to search for the game sessions.</p>
  *                <p>For example, to search for the above key-value pair, specify the following search filter: <code>gameSessionProperties.difficulty = "novice"</code>.
  *                     All game property values are searched as strings.</p>
  *                <p>
@@ -138,7 +138,7 @@ declare const SearchGameSessionsCommand_base: {
  * //       CurrentPlayerSessionCount: Number("int"),
  * //       MaximumPlayerSessionCount: Number("int"),
  * //       Status: "ACTIVE" || "ACTIVATING" || "TERMINATED" || "TERMINATING" || "ERROR",
- * //       StatusReason: "INTERRUPTED",
+ * //       StatusReason: "INTERRUPTED" || "TRIGGERED_ON_PROCESS_TERMINATE" || "FORCE_TERMINATED",
  * //       GameProperties: [ // GamePropertyList
  * //         { // GameProperty
  * //           Key: "STRING_VALUE", // required

package/dist-types/commands/StartGameSessionPlacementCommand.d.ts

@@ -65,8 +65,8 @@ declare const StartGameSessionPlacementCommand_base: {
  *          <p>If successful, a new game session placement is created.</p>
  *          <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
  *             is <code>FULFILLED</code>, a new game session has been created and a game session ARN
- *             and Region are referenced. If the placement request times out, submit a new request to the same
- *             queue or a different queue.</p>
+ *             and Region are referenced. If the placement request times out, you can resubmit the
+ *             request or retry it with a different queue. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/TerminateGameSessionCommand.d.ts

@@ -0,0 +1,160 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { GameLiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GameLiftClient";
+import { TerminateGameSessionInput, TerminateGameSessionOutput } from "../models/models_1";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link TerminateGameSessionCommand}.
+ */
+export interface TerminateGameSessionCommandInput extends TerminateGameSessionInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link TerminateGameSessionCommand}.
+ */
+export interface TerminateGameSessionCommandOutput extends TerminateGameSessionOutput, __MetadataBearer {
+}
+declare const TerminateGameSessionCommand_base: {
+    new (input: TerminateGameSessionCommandInput): import("@smithy/smithy-client").CommandImpl<TerminateGameSessionCommandInput, TerminateGameSessionCommandOutput, GameLiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: TerminateGameSessionCommandInput): import("@smithy/smithy-client").CommandImpl<TerminateGameSessionCommandInput, TerminateGameSessionCommandOutput, GameLiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Ends a game session that's currently in progress. You can use this action to terminate
+ *             any game session that isn't in <code>TERMINATED</code> or <code>TERMINATING</code>
+ *             status. Terminating a game session is the most efficient way to free up a server process
+ *             when it's hosting a game session that's in a bad state or not ending naturally. You can
+ *             use this action to terminate a game session that's being hosted on any type of Amazon GameLift
+ *             fleet compute, including computes for managed EC2, managed container, and Anywhere
+ *             fleets.</p>
+ *          <p>There are two potential methods for terminating a game session:</p>
+ *          <ul>
+ *             <li>
+ *                <p>With a graceful termination, the Amazon GameLift service prompts the server process to initiate its
+ *                     normal game session shutdown sequence. This sequence is implemented in the game
+ *                     server code and might involve a variety of actions to gracefully end a game
+ *                     session, such as notifying players, and stop the server process. </p>
+ *             </li>
+ *             <li>
+ *                <p>With a forceful termination, the Amazon GameLift service takes immediate action to terminate the game
+ *                     session by stopping the server process. Termination occurs without the normal
+ *                     game session shutdown sequence. </p>
+ *             </li>
+ *          </ul>
+ *          <p>
+ *             <b>Request options</b>
+ *          </p>
+ *          <ul>
+ *             <li>
+ *                <p>Request termination for a single game session. Provide the game session ID and
+ *                     the termination method. </p>
+ *             </li>
+ *          </ul>
+ *          <p>
+ *             <b>Results</b>
+ *          </p>
+ *          <p>If successful, game session termination is initiated, which includes changing the game
+ *             session status to <code>TERMINATING</code>. As a result of this action, and depending on
+ *             the implementation of <code>OnProcessTerminate()</code>, the server process either
+ *             becomes available to host a new game session, or it's recycled and a new server process
+ *             started with availability to host a game session. The game session status is changed to
+ *                 <code>TERMINATED</code>, with a status reason that indicates the termination method
+ *             used.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { GameLiftClient, TerminateGameSessionCommand } from "@aws-sdk/client-gamelift"; // ES Modules import
+ * // const { GameLiftClient, TerminateGameSessionCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import
+ * const client = new GameLiftClient(config);
+ * const input = { // TerminateGameSessionInput
+ *   GameSessionId: "STRING_VALUE", // required
+ *   TerminationMode: "TRIGGER_ON_PROCESS_TERMINATE" || "FORCE_TERMINATE", // required
+ * };
+ * const command = new TerminateGameSessionCommand(input);
+ * const response = await client.send(command);
+ * // { // TerminateGameSessionOutput
+ * //   GameSession: { // GameSession
+ * //     GameSessionId: "STRING_VALUE",
+ * //     Name: "STRING_VALUE",
+ * //     FleetId: "STRING_VALUE",
+ * //     FleetArn: "STRING_VALUE",
+ * //     CreationTime: new Date("TIMESTAMP"),
+ * //     TerminationTime: new Date("TIMESTAMP"),
+ * //     CurrentPlayerSessionCount: Number("int"),
+ * //     MaximumPlayerSessionCount: Number("int"),
+ * //     Status: "ACTIVE" || "ACTIVATING" || "TERMINATED" || "TERMINATING" || "ERROR",
+ * //     StatusReason: "INTERRUPTED" || "TRIGGERED_ON_PROCESS_TERMINATE" || "FORCE_TERMINATED",
+ * //     GameProperties: [ // GamePropertyList
+ * //       { // GameProperty
+ * //         Key: "STRING_VALUE", // required
+ * //         Value: "STRING_VALUE", // required
+ * //       },
+ * //     ],
+ * //     IpAddress: "STRING_VALUE",
+ * //     DnsName: "STRING_VALUE",
+ * //     Port: Number("int"),
+ * //     PlayerSessionCreationPolicy: "ACCEPT_ALL" || "DENY_ALL",
+ * //     CreatorId: "STRING_VALUE",
+ * //     GameSessionData: "STRING_VALUE",
+ * //     MatchmakerData: "STRING_VALUE",
+ * //     Location: "STRING_VALUE",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param TerminateGameSessionCommandInput - {@link TerminateGameSessionCommandInput}
+ * @returns {@link TerminateGameSessionCommandOutput}
+ * @see {@link TerminateGameSessionCommandInput} for command's `input` shape.
+ * @see {@link TerminateGameSessionCommandOutput} for command's `response` shape.
+ * @see {@link GameLiftClientResolvedConfig | config} for GameLiftClient's `config` shape.
+ *
+ * @throws {@link InternalServiceException} (server fault)
+ *  <p>The service encountered an unrecoverable internal failure while processing the
+ *             request. Clients can retry such requests immediately or after a waiting period.</p>
+ *
+ * @throws {@link InvalidGameSessionStatusException} (client fault)
+ *  <p>The requested operation would cause a conflict with the current state of a resource
+ *             associated with the request and/or the game instance. Resolve the conflict before
+ *             retrying.</p>
+ *
+ * @throws {@link InvalidRequestException} (client fault)
+ *  <p>One or more parameter values in the request are invalid. Correct the invalid parameter
+ *             values before retrying.</p>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The requested resources was not found. The resource was either not created yet or deleted.</p>
+ *
+ * @throws {@link NotReadyException} (client fault)
+ *  <p> The operation failed because Amazon GameLift has not yet finished validating this compute. We
+ *             recommend attempting 8 to 10 retries over 3 to 5 minutes with <a href="http://aws.amazon.com/blogs/https:/aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/">exponential
+ *                 backoffs and jitter</a>. </p>
+ *
+ * @throws {@link UnauthorizedException} (client fault)
+ *  <p>The client failed authentication. Clients should not retry such requests.</p>
+ *
+ * @throws {@link GameLiftServiceException}
+ * <p>Base exception class for all service exceptions from GameLift service.</p>
+ *
+ * @public
+ */
+export declare class TerminateGameSessionCommand extends TerminateGameSessionCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: TerminateGameSessionInput;
+            output: TerminateGameSessionOutput;
+        };
+        sdk: {
+            input: TerminateGameSessionCommandInput;
+            output: TerminateGameSessionCommandOutput;
+        };
+    };
+}

package/dist-types/commands/UpdateContainerFleetCommand.d.ts

@@ -29,7 +29,7 @@ declare const UpdateContainerFleetCommand_base: {
 /**
  * <p>Updates the properties of a managed container fleet. Depending on the properties being
  *             updated, this operation might initiate a fleet deployment. You can track deployments for
- *             a fleet using <a>DescribeFleetDeployment</a>.</p>
+ *             a fleet using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetDeployment.html">https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetDeployment.html</a>.</p>
  *          <p>
  *             <b>Request options</b>
  *          </p>

package/dist-types/commands/UpdateContainerGroupDefinitionCommand.d.ts

@@ -68,7 +68,7 @@ declare const UpdateContainerGroupDefinitionCommand_base: {
  *       definition version.</p>
  *          <p>If the container group definition version is used in an active fleets, the update
  *       automatically initiates a new fleet deployment of the new version. You can track a fleet's
- *       deployments using <a>ListFleetDeployments</a>.</p>
+ *       deployments using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListFleetDeployments.html">ListFleetDeployments</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/UpdateFleetPortSettingsCommand.d.ts

@@ -34,8 +34,6 @@ declare const UpdateFleetPortSettingsCommand_base: {
  *                 <code>InboundPermissionAuthorizations</code>, and permissions you want to remove in
  *                 <code>InboundPermissionRevocations</code>. Permissions to be removed must match
  *             existing fleet permissions. </p>
- *          <p>For a container fleet, inbound permissions must specify port numbers that are defined
- *             in the fleet's connection port settings.</p>
  *          <p>If successful, the fleet ID for the updated fleet is returned. For fleets with remote
  *             locations, port setting updates can take time to propagate across all locations. You can
  *             check the status of updates in each location by calling

package/dist-types/commands/UpdateGameSessionCommand.d.ts

@@ -66,7 +66,7 @@ declare const UpdateGameSessionCommand_base: {
  * //     CurrentPlayerSessionCount: Number("int"),
  * //     MaximumPlayerSessionCount: Number("int"),
  * //     Status: "ACTIVE" || "ACTIVATING" || "TERMINATED" || "TERMINATING" || "ERROR",
- * //     StatusReason: "INTERRUPTED",
+ * //     StatusReason: "INTERRUPTED" || "TRIGGERED_ON_PROCESS_TERMINATE" || "FORCE_TERMINATED",
  * //     GameProperties: [ // GamePropertyList
  * //       { // GameProperty
  * //         Key: "STRING_VALUE", // required

package/dist-types/commands/index.d.ts

@@ -99,6 +99,7 @@ export * from "./StopGameSessionPlacementCommand";
 export * from "./StopMatchmakingCommand";
 export * from "./SuspendGameServerGroupCommand";
 export * from "./TagResourceCommand";
+export * from "./TerminateGameSessionCommand";
 export * from "./UntagResourceCommand";
 export * from "./UpdateAliasCommand";
 export * from "./UpdateBuildCommand";