@aws-sdk/client-gamelift 3.1038.0 → 3.1039.0

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

@@ -0,0 +1,160 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { GameLiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GameLiftClient";
+import type { DescribeContainerGroupPortMappingsInput, DescribeContainerGroupPortMappingsOutput } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link DescribeContainerGroupPortMappingsCommand}.
+ */
+export interface DescribeContainerGroupPortMappingsCommandInput extends DescribeContainerGroupPortMappingsInput {
+}
+/**
+ * @public
+ *
+ * The output of {@link DescribeContainerGroupPortMappingsCommand}.
+ */
+export interface DescribeContainerGroupPortMappingsCommandOutput extends DescribeContainerGroupPortMappingsOutput, __MetadataBearer {
+}
+declare const DescribeContainerGroupPortMappingsCommand_base: {
+    new (input: DescribeContainerGroupPortMappingsCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeContainerGroupPortMappingsCommandInput, DescribeContainerGroupPortMappingsCommandOutput, GameLiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (input: DescribeContainerGroupPortMappingsCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeContainerGroupPortMappingsCommandInput, DescribeContainerGroupPortMappingsCommandOutput, GameLiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>
+ *             <b>This API works with the following fleet types:</b> Container</p>
+ *          <p>Retrieves the port mappings for a container group running on a container fleet. Port
+ *             mappings show how container ports are mapped to connection ports on the fleet instance.
+ *             Use this operation to find the connection port for a specific container on a fleet
+ *             instance.</p>
+ *          <p>
+ *             <b>Request options</b>
+ *          </p>
+ *          <ul>
+ *             <li>
+ *                <p>Get port mappings for a game server container group. Provide the fleet ID,
+ *                 set <code>ContainerGroupType</code> to <code>GAME_SERVER</code>, and specify the
+ *                 <code>ComputeName</code> for the game server container group.</p>
+ *             </li>
+ *             <li>
+ *                <p>Get port mappings for a per-instance container group. Provide the fleet ID,
+ *                 set <code>ContainerGroupType</code> to <code>PER_INSTANCE</code>, and specify the
+ *                 <code>InstanceId</code> for the instance.</p>
+ *             </li>
+ *             <li>
+ *                <p>Optionally filter results to a single container by providing a
+ *                 <code>ContainerName</code>.</p>
+ *             </li>
+ *          </ul>
+ *          <p>
+ *             <b>Results</b>
+ *          </p>
+ *          <p>This operation returns the fleet ID, location, container group definition
+ *             ARN, container group type, compute name (for game server container groups), instance ID,
+ *             and a list of <code>ContainerGroupPortMapping</code> objects. Each object contains the
+ *             container name, runtime ID, and a list of port mappings that show how container ports map
+ *             to connection ports on the instance.</p>
+ *          <p>
+ *             <b>Learn more</b>
+ *          </p>
+ *          <p>
+ *             <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-remote-access.html">Connect to
+ *             containers</a>
+ *          </p>
+ *          <p>
+ *             <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-create-groups.html">Create a
+ *             container group definition</a>
+ *          </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { GameLiftClient, DescribeContainerGroupPortMappingsCommand } from "@aws-sdk/client-gamelift"; // ES Modules import
+ * // const { GameLiftClient, DescribeContainerGroupPortMappingsCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import
+ * // import type { GameLiftClientConfig } from "@aws-sdk/client-gamelift";
+ * const config = {}; // type is GameLiftClientConfig
+ * const client = new GameLiftClient(config);
+ * const input = { // DescribeContainerGroupPortMappingsInput
+ *   FleetId: "STRING_VALUE", // required
+ *   ContainerGroupType: "GAME_SERVER" || "PER_INSTANCE", // required
+ *   ComputeName: "STRING_VALUE",
+ *   InstanceId: "STRING_VALUE",
+ *   ContainerName: "STRING_VALUE",
+ * };
+ * const command = new DescribeContainerGroupPortMappingsCommand(input);
+ * const response = await client.send(command);
+ * // { // DescribeContainerGroupPortMappingsOutput
+ * //   FleetId: "STRING_VALUE",
+ * //   Location: "STRING_VALUE",
+ * //   ContainerGroupDefinitionArn: "STRING_VALUE",
+ * //   ContainerGroupType: "GAME_SERVER" || "PER_INSTANCE",
+ * //   ComputeName: "STRING_VALUE",
+ * //   InstanceId: "STRING_VALUE",
+ * //   ContainerGroupPortMappings: [ // ContainerGroupPortMappingList
+ * //     { // ContainerGroupPortMapping
+ * //       ContainerName: "STRING_VALUE",
+ * //       ContainerRuntimeId: "STRING_VALUE",
+ * //       ContainerPortMappings: [ // ContainerPortMappingList
+ * //         { // ContainerPortMapping
+ * //           ContainerPort: Number("int"),
+ * //           ConnectionPort: Number("int"),
+ * //           Protocol: "TCP" || "UDP",
+ * //         },
+ * //       ],
+ * //     },
+ * //   ],
+ * // };
+ *
+ * ```
+ *
+ * @param DescribeContainerGroupPortMappingsCommandInput - {@link DescribeContainerGroupPortMappingsCommandInput}
+ * @returns {@link DescribeContainerGroupPortMappingsCommandOutput}
+ * @see {@link DescribeContainerGroupPortMappingsCommandInput} for command's `input` shape.
+ * @see {@link DescribeContainerGroupPortMappingsCommandOutput} 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 InvalidRequestException} (client fault)
+ *  <p>One or more parameter values in the request are invalid. Correct the invalid parameter
+ *             values before retrying.</p>
+ *
+ * @throws {@link LimitExceededException} (client fault)
+ *  <p>The requested operation would cause the resource to exceed the allowed service limit.
+ *             Resolve the issue 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 UnauthorizedException} (client fault)
+ *  <p>The client failed authentication. Clients should not retry such requests.</p>
+ *
+ * @throws {@link UnsupportedRegionException} (client fault)
+ *  <p>The requested operation is not supported in the Region specified.</p>
+ *
+ * @throws {@link GameLiftServiceException}
+ * <p>Base exception class for all service exceptions from GameLift service.</p>
+ *
+ *
+ * @public
+ */
+export declare class DescribeContainerGroupPortMappingsCommand extends DescribeContainerGroupPortMappingsCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: DescribeContainerGroupPortMappingsInput;
+            output: DescribeContainerGroupPortMappingsOutput;
+        };
+        sdk: {
+            input: DescribeContainerGroupPortMappingsCommandInput;
+            output: DescribeContainerGroupPortMappingsCommandOutput;
+        };
+    };
+}

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

@@ -39,27 +39,30 @@ declare const DescribeEC2InstanceLimitsCommand_base: {
  *             Region or in a remote location. For remote locations, limits also differ based on the
  *             combination of home Region and remote location. All requests must specify an Amazon Web Services
  *             Region (either explicitly or as your default settings). To get the limit for a remote
- *             location, you must also specify the location. For example, the following requests all
+ *             location, you must also specify the location. To learn more about how Amazon GameLift Servers handles
+ *             locations, see <a href="https://docs.aws.amazon.com/gameliftservers/latest/developerguide/gamelift-regions.html">Amazon GameLift Servers service
+ *                 locations</a>. For example, the following requests all
  *             return different results: </p>
  *          <ul>
  *             <li>
  *                <p>Request specifies the Region <code>ap-northeast-1</code> with no location. The
- *                     result is limits and usage data on all instance types that are deployed in
- *                         <code>us-east-2</code>, by all of the fleets that reside in
+ *                     result is limits and usage data on all of the fleets that reside in
+ *                         <code>ap-northeast-1</code>, for all instance types that are deployed in
  *                         <code>ap-northeast-1</code>. </p>
  *             </li>
  *             <li>
- *                <p>Request specifies the Region <code>us-east-1</code> with location
- *                         <code>ca-central-1</code>. The result is limits and usage data on all
- *                     instance types that are deployed in <code>ca-central-1</code>, by all of the
- *                     fleets that reside in <code>us-east-2</code>. These limits do not affect fleets
- *                     in any other Regions that deploy instances to <code>ca-central-1</code>.</p>
+ *                <p>Request specifies the Region <code>ap-northeast-1</code> with location
+ *                         <code>us-west-2</code>. The result is limits and usage data on all of the
+ *                     fleets that reside in <code>ap-northeast-1</code>, for all instance types
+ *                     that are deployed in <code>us-west-2</code>.</p>
  *             </li>
  *             <li>
- *                <p>Request specifies the Region <code>eu-west-1</code> with location
- *                         <code>ca-central-1</code>. The result is limits and usage data on all
- *                     instance types that are deployed in <code>ca-central-1</code>, by all of the
- *                     fleets that reside in <code>eu-west-1</code>.</p>
+ *                <p>Request specifies the Region <code>us-east-1</code> with location
+ *                         <code>ap-northeast-1</code>. The result is limits and usage data on all of
+ *                     the fleets that reside in <code>us-east-1</code>, for all instance types
+ *                     that are deployed in <code>ap-northeast-1</code>. These limits do not affect
+ *                     fleets in any other Regions that deploy instances to
+ *                         <code>ap-northeast-1</code>.</p>
  *             </li>
  *          </ul>
  *          <p>This operation can be used in the following ways:</p>

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

@@ -57,8 +57,8 @@ declare const SearchGameSessionsCommand_base: {
  *          <ul>
  *             <li>
  *                <p>
- *                   <b>gameSessionId</b> -- A unique identifier for the game session. You can use either a
- *                         <code>GameSessionId</code> or <code>GameSessionArn</code> value. </p>
+ *                   <b>gameSessionId</b> -- An identifier for the game session that is unique across all regions. You must use the
+ *                         full ARN value. </p>
  *             </li>
  *             <li>
  *                <p>

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

@@ -1,7 +1,7 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
 import type { GameLiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GameLiftClient";
-import type { UpdateContainerFleetInput, UpdateContainerFleetOutput } from "../models/models_0";
+import type { UpdateContainerFleetInput, UpdateContainerFleetOutput } from "../models/models_1";
 /**
  * @public
  */

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

@@ -1,7 +1,7 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
 import type { GameLiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GameLiftClient";
-import type { UpdateContainerGroupDefinitionInput, UpdateContainerGroupDefinitionOutput } from "../models/models_0";
+import type { UpdateContainerGroupDefinitionInput, UpdateContainerGroupDefinitionOutput } from "../models/models_1";
 /**
  * @public
  */

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

@@ -39,6 +39,7 @@ export * from "./DescribeBuildCommand";
 export * from "./DescribeComputeCommand";
 export * from "./DescribeContainerFleetCommand";
 export * from "./DescribeContainerGroupDefinitionCommand";
+export * from "./DescribeContainerGroupPortMappingsCommand";
 export * from "./DescribeEC2InstanceLimitsCommand";
 export * from "./DescribeFleetAttributesCommand";
 export * from "./DescribeFleetCapacityCommand";