@aws-sdk/client-gamelift 3.554.0 → 3.562.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +32 -0
- package/dist-cjs/index.js +453 -72
- package/dist-es/GameLift.js +8 -0
- package/dist-es/commands/CreateContainerGroupDefinitionCommand.js +25 -0
- package/dist-es/commands/CreateFleetCommand.js +2 -2
- package/dist-es/commands/DeleteContainerGroupDefinitionCommand.js +24 -0
- package/dist-es/commands/DescribeContainerGroupDefinitionCommand.js +25 -0
- package/dist-es/commands/DescribeFleetAttributesCommand.js +2 -1
- package/dist-es/commands/ListContainerGroupDefinitionsCommand.js +25 -0
- package/dist-es/commands/SearchGameSessionsCommand.js +1 -1
- package/dist-es/commands/StartGameSessionPlacementCommand.js +1 -1
- package/dist-es/commands/StartMatchBackfillCommand.js +1 -1
- package/dist-es/commands/StartMatchmakingCommand.js +1 -1
- package/dist-es/commands/StopGameSessionPlacementCommand.js +1 -1
- package/dist-es/commands/index.js +4 -0
- package/dist-es/models/models_0.js +124 -45
- package/dist-es/models/models_1.js +42 -1
- package/dist-es/pagination/ListContainerGroupDefinitionsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_json1_1.js +129 -1
- package/dist-types/GameLift.d.ts +29 -0
- package/dist-types/GameLiftClient.d.ts +6 -2
- package/dist-types/commands/CreateContainerGroupDefinitionCommand.d.ts +262 -0
- package/dist-types/commands/CreateFleetCommand.d.ts +169 -29
- package/dist-types/commands/CreateFleetLocationsCommand.d.ts +14 -6
- package/dist-types/commands/DeleteContainerGroupDefinitionCommand.d.ts +94 -0
- package/dist-types/commands/DeleteFleetCommand.d.ts +5 -6
- package/dist-types/commands/DeregisterComputeCommand.d.ts +10 -2
- package/dist-types/commands/DescribeComputeCommand.d.ts +35 -6
- package/dist-types/commands/DescribeContainerGroupDefinitionCommand.d.ts +152 -0
- package/dist-types/commands/DescribeFleetAttributesCommand.d.ts +25 -7
- package/dist-types/commands/DescribeFleetCapacityCommand.d.ts +17 -7
- package/dist-types/commands/DescribeFleetEventsCommand.d.ts +1 -0
- package/dist-types/commands/DescribeFleetLocationCapacityCommand.d.ts +11 -3
- package/dist-types/commands/DescribeFleetPortSettingsCommand.d.ts +10 -9
- package/dist-types/commands/DescribeRuntimeConfigurationCommand.d.ts +7 -4
- package/dist-types/commands/GetComputeAccessCommand.d.ts +39 -14
- package/dist-types/commands/GetComputeAuthTokenCommand.d.ts +20 -6
- package/dist-types/commands/ListComputeCommand.d.ts +38 -8
- package/dist-types/commands/ListContainerGroupDefinitionsCommand.d.ts +156 -0
- package/dist-types/commands/ListFleetsCommand.d.ts +20 -19
- package/dist-types/commands/RegisterComputeCommand.d.ts +31 -8
- package/dist-types/commands/RequestUploadCredentialsCommand.d.ts +1 -1
- package/dist-types/commands/ResolveAliasCommand.d.ts +5 -1
- package/dist-types/commands/ResumeGameServerGroupCommand.d.ts +2 -1
- package/dist-types/commands/SearchGameSessionsCommand.d.ts +2 -2
- package/dist-types/commands/StartFleetActionsCommand.d.ts +1 -1
- package/dist-types/commands/StartGameSessionPlacementCommand.d.ts +1 -1
- package/dist-types/commands/StartMatchBackfillCommand.d.ts +1 -1
- package/dist-types/commands/StartMatchmakingCommand.d.ts +1 -1
- package/dist-types/commands/StopFleetActionsCommand.d.ts +3 -2
- package/dist-types/commands/StopGameSessionPlacementCommand.d.ts +1 -1
- package/dist-types/commands/StopMatchmakingCommand.d.ts +1 -1
- package/dist-types/commands/SuspendGameServerGroupCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAliasCommand.d.ts +4 -5
- package/dist-types/commands/UpdateBuildCommand.d.ts +1 -1
- package/dist-types/commands/UpdateFleetAttributesCommand.d.ts +3 -4
- package/dist-types/commands/UpdateFleetCapacityCommand.d.ts +27 -30
- package/dist-types/commands/UpdateFleetPortSettingsCommand.d.ts +4 -2
- package/dist-types/commands/UpdateRuntimeConfigurationCommand.d.ts +16 -9
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/models/models_0.d.ts +5561 -4910
- package/dist-types/models/models_1.d.ts +685 -7
- package/dist-types/pagination/ListContainerGroupDefinitionsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +36 -0
- package/dist-types/ts3.4/GameLift.d.ts +69 -0
- package/dist-types/ts3.4/GameLiftClient.d.ts +24 -0
- package/dist-types/ts3.4/commands/CreateContainerGroupDefinitionCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/DeleteContainerGroupDefinitionCommand.d.ts +35 -0
- package/dist-types/ts3.4/commands/DescribeContainerGroupDefinitionCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListContainerGroupDefinitionsCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ResumeGameServerGroupCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/SearchGameSessionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartFleetActionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartGameSessionPlacementCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartMatchBackfillCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartMatchmakingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopFleetActionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopGameSessionPlacementCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopMatchmakingCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SuspendGameServerGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAliasCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateBuildCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateFleetAttributesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/models/models_0.d.ts +232 -150
- package/dist-types/ts3.4/models/models_1.d.ts +158 -0
- package/dist-types/ts3.4/pagination/ListContainerGroupDefinitionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +48 -0
- package/package.json +4 -4
|
@@ -26,18 +26,17 @@ declare const DeleteFleetCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Deletes all resources and information related a fleet
|
|
30
|
-
* including those in remote locations
|
|
31
|
-
* <code>DeleteFleetLocations</code> separately.</p>
|
|
29
|
+
* <p>Deletes all resources and information related to a fleet and shuts down any currently
|
|
30
|
+
* running fleet instances, including those in remote locations.</p>
|
|
32
31
|
* <note>
|
|
33
32
|
* <p>If the fleet being deleted has a VPC peering connection, you first need to get a
|
|
34
|
-
* valid authorization (good for 24 hours) by calling <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringAuthorization.html">CreateVpcPeeringAuthorization</a>. You
|
|
33
|
+
* valid authorization (good for 24 hours) by calling <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringAuthorization.html">CreateVpcPeeringAuthorization</a>. You don't need to explicitly delete the
|
|
35
34
|
* VPC peering connection.</p>
|
|
36
35
|
* </note>
|
|
37
|
-
* <p>To delete a fleet, specify the fleet ID to be terminated. During the deletion process
|
|
36
|
+
* <p>To delete a fleet, specify the fleet ID to be terminated. During the deletion process,
|
|
38
37
|
* the fleet status is changed to <code>DELETING</code>. When completed, the status
|
|
39
38
|
* switches to <code>TERMINATED</code> and the fleet event <code>FLEET_DELETED</code> is
|
|
40
|
-
*
|
|
39
|
+
* emitted.</p>
|
|
41
40
|
* <p>
|
|
42
41
|
* <b>Learn more</b>
|
|
43
42
|
* </p>
|
|
@@ -26,8 +26,16 @@ declare const DeregisterComputeCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>
|
|
30
|
-
*
|
|
29
|
+
* <p>
|
|
30
|
+
* <b>This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.</b>
|
|
31
|
+
* </p>
|
|
32
|
+
* <p>Removes a compute resource from an Amazon GameLift Anywhere fleet or container fleet.
|
|
33
|
+
* Deregistered computes can no longer host game sessions through Amazon GameLift.</p>
|
|
34
|
+
* <p>For an Anywhere fleet or a container fleet that's running the Amazon GameLift Agent, the Agent
|
|
35
|
+
* handles all compute registry tasks for you. For an Anywhere fleet that doesn't use the
|
|
36
|
+
* Agent, call this operation to deregister fleet computes. </p>
|
|
37
|
+
* <p>To deregister a compute, call this operation from the compute that's being
|
|
38
|
+
* deregistered and specify the compute name and the fleet ID. </p>
|
|
31
39
|
* @example
|
|
32
40
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
41
|
* ```javascript
|
|
@@ -26,12 +26,30 @@ declare const DescribeComputeCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
* <p>
|
|
33
|
-
*
|
|
34
|
-
*
|
|
29
|
+
* <p>
|
|
30
|
+
* <b>This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.</b>
|
|
31
|
+
* </p>
|
|
32
|
+
* <p>Retrieves properties for a compute resource in an Amazon GameLift fleet. To get a list of all
|
|
33
|
+
* computes in a fleet, call <a>ListCompute</a>. </p>
|
|
34
|
+
* <p>To request information on a specific compute, provide the fleet ID and compute
|
|
35
|
+
* name.</p>
|
|
36
|
+
* <p>If successful, this operation returns details for the requested compute resource.
|
|
37
|
+
* Depending on the fleet's compute type, the result includes the following information: </p>
|
|
38
|
+
* <ul>
|
|
39
|
+
* <li>
|
|
40
|
+
* <p>For <code>EC2</code> fleets, this operation returns information about the EC2
|
|
41
|
+
* instance.</p>
|
|
42
|
+
* </li>
|
|
43
|
+
* <li>
|
|
44
|
+
* <p>For <code>ANYWHERE</code> fleets, this operation returns information about the
|
|
45
|
+
* registered compute.</p>
|
|
46
|
+
* </li>
|
|
47
|
+
* <li>
|
|
48
|
+
* <p>For <code>CONTAINER</code> fleets, this operation returns information about
|
|
49
|
+
* the container that's registered as a compute, and the instance it's running on.
|
|
50
|
+
* The compute name is the container name.</p>
|
|
51
|
+
* </li>
|
|
52
|
+
* </ul>
|
|
35
53
|
* @example
|
|
36
54
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
55
|
* ```javascript
|
|
@@ -58,6 +76,17 @@ declare const DescribeComputeCommand_base: {
|
|
|
58
76
|
* // OperatingSystem: "WINDOWS_2012" || "AMAZON_LINUX" || "AMAZON_LINUX_2" || "WINDOWS_2016" || "AMAZON_LINUX_2023",
|
|
59
77
|
* // Type: "t2.micro" || "t2.small" || "t2.medium" || "t2.large" || "c3.large" || "c3.xlarge" || "c3.2xlarge" || "c3.4xlarge" || "c3.8xlarge" || "c4.large" || "c4.xlarge" || "c4.2xlarge" || "c4.4xlarge" || "c4.8xlarge" || "c5.large" || "c5.xlarge" || "c5.2xlarge" || "c5.4xlarge" || "c5.9xlarge" || "c5.12xlarge" || "c5.18xlarge" || "c5.24xlarge" || "c5a.large" || "c5a.xlarge" || "c5a.2xlarge" || "c5a.4xlarge" || "c5a.8xlarge" || "c5a.12xlarge" || "c5a.16xlarge" || "c5a.24xlarge" || "r3.large" || "r3.xlarge" || "r3.2xlarge" || "r3.4xlarge" || "r3.8xlarge" || "r4.large" || "r4.xlarge" || "r4.2xlarge" || "r4.4xlarge" || "r4.8xlarge" || "r4.16xlarge" || "r5.large" || "r5.xlarge" || "r5.2xlarge" || "r5.4xlarge" || "r5.8xlarge" || "r5.12xlarge" || "r5.16xlarge" || "r5.24xlarge" || "r5a.large" || "r5a.xlarge" || "r5a.2xlarge" || "r5a.4xlarge" || "r5a.8xlarge" || "r5a.12xlarge" || "r5a.16xlarge" || "r5a.24xlarge" || "m3.medium" || "m3.large" || "m3.xlarge" || "m3.2xlarge" || "m4.large" || "m4.xlarge" || "m4.2xlarge" || "m4.4xlarge" || "m4.10xlarge" || "m5.large" || "m5.xlarge" || "m5.2xlarge" || "m5.4xlarge" || "m5.8xlarge" || "m5.12xlarge" || "m5.16xlarge" || "m5.24xlarge" || "m5a.large" || "m5a.xlarge" || "m5a.2xlarge" || "m5a.4xlarge" || "m5a.8xlarge" || "m5a.12xlarge" || "m5a.16xlarge" || "m5a.24xlarge" || "c5d.large" || "c5d.xlarge" || "c5d.2xlarge" || "c5d.4xlarge" || "c5d.9xlarge" || "c5d.12xlarge" || "c5d.18xlarge" || "c5d.24xlarge" || "c6a.large" || "c6a.xlarge" || "c6a.2xlarge" || "c6a.4xlarge" || "c6a.8xlarge" || "c6a.12xlarge" || "c6a.16xlarge" || "c6a.24xlarge" || "c6i.large" || "c6i.xlarge" || "c6i.2xlarge" || "c6i.4xlarge" || "c6i.8xlarge" || "c6i.12xlarge" || "c6i.16xlarge" || "c6i.24xlarge" || "r5d.large" || "r5d.xlarge" || "r5d.2xlarge" || "r5d.4xlarge" || "r5d.8xlarge" || "r5d.12xlarge" || "r5d.16xlarge" || "r5d.24xlarge" || "m6g.medium" || "m6g.large" || "m6g.xlarge" || "m6g.2xlarge" || "m6g.4xlarge" || "m6g.8xlarge" || "m6g.12xlarge" || "m6g.16xlarge" || "c6g.medium" || "c6g.large" || "c6g.xlarge" || "c6g.2xlarge" || "c6g.4xlarge" || "c6g.8xlarge" || "c6g.12xlarge" || "c6g.16xlarge" || "r6g.medium" || "r6g.large" || "r6g.xlarge" || "r6g.2xlarge" || "r6g.4xlarge" || "r6g.8xlarge" || "r6g.12xlarge" || "r6g.16xlarge" || "c6gn.medium" || "c6gn.large" || "c6gn.xlarge" || "c6gn.2xlarge" || "c6gn.4xlarge" || "c6gn.8xlarge" || "c6gn.12xlarge" || "c6gn.16xlarge" || "c7g.medium" || "c7g.large" || "c7g.xlarge" || "c7g.2xlarge" || "c7g.4xlarge" || "c7g.8xlarge" || "c7g.12xlarge" || "c7g.16xlarge" || "r7g.medium" || "r7g.large" || "r7g.xlarge" || "r7g.2xlarge" || "r7g.4xlarge" || "r7g.8xlarge" || "r7g.12xlarge" || "r7g.16xlarge" || "m7g.medium" || "m7g.large" || "m7g.xlarge" || "m7g.2xlarge" || "m7g.4xlarge" || "m7g.8xlarge" || "m7g.12xlarge" || "m7g.16xlarge" || "g5g.xlarge" || "g5g.2xlarge" || "g5g.4xlarge" || "g5g.8xlarge" || "g5g.16xlarge",
|
|
60
78
|
* // GameLiftServiceSdkEndpoint: "STRING_VALUE",
|
|
79
|
+
* // GameLiftAgentEndpoint: "STRING_VALUE",
|
|
80
|
+
* // InstanceId: "STRING_VALUE",
|
|
81
|
+
* // ContainerAttributes: { // ContainerAttributes
|
|
82
|
+
* // ContainerPortMappings: [ // ContainerPortMappingList
|
|
83
|
+
* // { // ContainerPortMapping
|
|
84
|
+
* // ContainerPort: Number("int"),
|
|
85
|
+
* // ConnectionPort: Number("int"),
|
|
86
|
+
* // Protocol: "TCP" || "UDP",
|
|
87
|
+
* // },
|
|
88
|
+
* // ],
|
|
89
|
+
* // },
|
|
61
90
|
* // },
|
|
62
91
|
* // };
|
|
63
92
|
*
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { GameLiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GameLiftClient";
|
|
4
|
+
import { DescribeContainerGroupDefinitionInput, DescribeContainerGroupDefinitionOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export { __MetadataBearer, $Command };
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*
|
|
12
|
+
* The input for {@link DescribeContainerGroupDefinitionCommand}.
|
|
13
|
+
*/
|
|
14
|
+
export interface DescribeContainerGroupDefinitionCommandInput extends DescribeContainerGroupDefinitionInput {
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @public
|
|
18
|
+
*
|
|
19
|
+
* The output of {@link DescribeContainerGroupDefinitionCommand}.
|
|
20
|
+
*/
|
|
21
|
+
export interface DescribeContainerGroupDefinitionCommandOutput extends DescribeContainerGroupDefinitionOutput, __MetadataBearer {
|
|
22
|
+
}
|
|
23
|
+
declare const DescribeContainerGroupDefinitionCommand_base: {
|
|
24
|
+
new (input: DescribeContainerGroupDefinitionCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeContainerGroupDefinitionCommandInput, DescribeContainerGroupDefinitionCommandOutput, GameLiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: DescribeContainerGroupDefinitionCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeContainerGroupDefinitionCommandInput, DescribeContainerGroupDefinitionCommandOutput, GameLiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* <p>
|
|
30
|
+
* <b>This operation is used with the Amazon GameLift containers feature, which is currently in public preview. </b>
|
|
31
|
+
* </p>
|
|
32
|
+
* <p>Retrieves the properties of a container group definition, including all container
|
|
33
|
+
* definitions in the group. </p>
|
|
34
|
+
* <p>To retrieve a container group definition, provide a resource identifier. If successful,
|
|
35
|
+
* this operation returns the complete properties of the container group definition.</p>
|
|
36
|
+
* <p>
|
|
37
|
+
* <b>Learn more</b>
|
|
38
|
+
* </p>
|
|
39
|
+
* <ul>
|
|
40
|
+
* <li>
|
|
41
|
+
* <p>
|
|
42
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-create-groups.html">Manage a container group definition</a>
|
|
43
|
+
* </p>
|
|
44
|
+
* </li>
|
|
45
|
+
* </ul>
|
|
46
|
+
* @example
|
|
47
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
48
|
+
* ```javascript
|
|
49
|
+
* import { GameLiftClient, DescribeContainerGroupDefinitionCommand } from "@aws-sdk/client-gamelift"; // ES Modules import
|
|
50
|
+
* // const { GameLiftClient, DescribeContainerGroupDefinitionCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import
|
|
51
|
+
* const client = new GameLiftClient(config);
|
|
52
|
+
* const input = { // DescribeContainerGroupDefinitionInput
|
|
53
|
+
* Name: "STRING_VALUE", // required
|
|
54
|
+
* };
|
|
55
|
+
* const command = new DescribeContainerGroupDefinitionCommand(input);
|
|
56
|
+
* const response = await client.send(command);
|
|
57
|
+
* // { // DescribeContainerGroupDefinitionOutput
|
|
58
|
+
* // ContainerGroupDefinition: { // ContainerGroupDefinition
|
|
59
|
+
* // ContainerGroupDefinitionArn: "STRING_VALUE",
|
|
60
|
+
* // CreationTime: new Date("TIMESTAMP"),
|
|
61
|
+
* // OperatingSystem: "AMAZON_LINUX_2023",
|
|
62
|
+
* // Name: "STRING_VALUE",
|
|
63
|
+
* // SchedulingStrategy: "REPLICA" || "DAEMON",
|
|
64
|
+
* // TotalMemoryLimit: Number("int"),
|
|
65
|
+
* // TotalCpuLimit: Number("int"),
|
|
66
|
+
* // ContainerDefinitions: [ // ContainerDefinitionList
|
|
67
|
+
* // { // ContainerDefinition
|
|
68
|
+
* // ContainerName: "STRING_VALUE", // required
|
|
69
|
+
* // ImageUri: "STRING_VALUE", // required
|
|
70
|
+
* // ResolvedImageDigest: "STRING_VALUE",
|
|
71
|
+
* // MemoryLimits: { // ContainerMemoryLimits
|
|
72
|
+
* // SoftLimit: Number("int"),
|
|
73
|
+
* // HardLimit: Number("int"),
|
|
74
|
+
* // },
|
|
75
|
+
* // PortConfiguration: { // ContainerPortConfiguration
|
|
76
|
+
* // ContainerPortRanges: [ // ContainerPortRangeList // required
|
|
77
|
+
* // { // ContainerPortRange
|
|
78
|
+
* // FromPort: Number("int"), // required
|
|
79
|
+
* // ToPort: Number("int"), // required
|
|
80
|
+
* // Protocol: "TCP" || "UDP", // required
|
|
81
|
+
* // },
|
|
82
|
+
* // ],
|
|
83
|
+
* // },
|
|
84
|
+
* // Cpu: Number("int"),
|
|
85
|
+
* // HealthCheck: { // ContainerHealthCheck
|
|
86
|
+
* // Command: [ // ContainerCommandStringList // required
|
|
87
|
+
* // "STRING_VALUE",
|
|
88
|
+
* // ],
|
|
89
|
+
* // Interval: Number("int"),
|
|
90
|
+
* // Timeout: Number("int"),
|
|
91
|
+
* // Retries: Number("int"),
|
|
92
|
+
* // StartPeriod: Number("int"),
|
|
93
|
+
* // },
|
|
94
|
+
* // Command: [
|
|
95
|
+
* // "STRING_VALUE",
|
|
96
|
+
* // ],
|
|
97
|
+
* // Essential: true || false,
|
|
98
|
+
* // EntryPoint: [ // ContainerEntryPointList
|
|
99
|
+
* // "STRING_VALUE",
|
|
100
|
+
* // ],
|
|
101
|
+
* // WorkingDirectory: "STRING_VALUE",
|
|
102
|
+
* // Environment: [ // ContainerEnvironmentList
|
|
103
|
+
* // { // ContainerEnvironment
|
|
104
|
+
* // Name: "STRING_VALUE", // required
|
|
105
|
+
* // Value: "STRING_VALUE", // required
|
|
106
|
+
* // },
|
|
107
|
+
* // ],
|
|
108
|
+
* // DependsOn: [ // ContainerDependencyList
|
|
109
|
+
* // { // ContainerDependency
|
|
110
|
+
* // ContainerName: "STRING_VALUE", // required
|
|
111
|
+
* // Condition: "START" || "COMPLETE" || "SUCCESS" || "HEALTHY", // required
|
|
112
|
+
* // },
|
|
113
|
+
* // ],
|
|
114
|
+
* // },
|
|
115
|
+
* // ],
|
|
116
|
+
* // Status: "READY" || "COPYING" || "FAILED",
|
|
117
|
+
* // StatusReason: "STRING_VALUE",
|
|
118
|
+
* // },
|
|
119
|
+
* // };
|
|
120
|
+
*
|
|
121
|
+
* ```
|
|
122
|
+
*
|
|
123
|
+
* @param DescribeContainerGroupDefinitionCommandInput - {@link DescribeContainerGroupDefinitionCommandInput}
|
|
124
|
+
* @returns {@link DescribeContainerGroupDefinitionCommandOutput}
|
|
125
|
+
* @see {@link DescribeContainerGroupDefinitionCommandInput} for command's `input` shape.
|
|
126
|
+
* @see {@link DescribeContainerGroupDefinitionCommandOutput} for command's `response` shape.
|
|
127
|
+
* @see {@link GameLiftClientResolvedConfig | config} for GameLiftClient's `config` shape.
|
|
128
|
+
*
|
|
129
|
+
* @throws {@link InternalServiceException} (server fault)
|
|
130
|
+
* <p>The service encountered an unrecoverable internal failure while processing the
|
|
131
|
+
* request. Clients can retry such requests immediately or after a waiting period.</p>
|
|
132
|
+
*
|
|
133
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
134
|
+
* <p>One or more parameter values in the request are invalid. Correct the invalid parameter
|
|
135
|
+
* values before retrying.</p>
|
|
136
|
+
*
|
|
137
|
+
* @throws {@link NotFoundException} (client fault)
|
|
138
|
+
* <p>THe requested resources was not found. The resource was either not created yet or deleted.</p>
|
|
139
|
+
*
|
|
140
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
141
|
+
* <p>The client failed authentication. Clients should not retry such requests.</p>
|
|
142
|
+
*
|
|
143
|
+
* @throws {@link UnsupportedRegionException} (client fault)
|
|
144
|
+
* <p>The requested operation is not supported in the Region specified.</p>
|
|
145
|
+
*
|
|
146
|
+
* @throws {@link GameLiftServiceException}
|
|
147
|
+
* <p>Base exception class for all service exceptions from GameLift service.</p>
|
|
148
|
+
*
|
|
149
|
+
* @public
|
|
150
|
+
*/
|
|
151
|
+
export declare class DescribeContainerGroupDefinitionCommand extends DescribeContainerGroupDefinitionCommand_base {
|
|
152
|
+
}
|
|
@@ -26,16 +26,18 @@ declare const DescribeFleetAttributesCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>
|
|
30
|
-
*
|
|
31
|
-
*
|
|
29
|
+
* <p>
|
|
30
|
+
* <b>This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.</b>
|
|
31
|
+
* </p>
|
|
32
|
+
* <p>Retrieves core fleet-wide properties for fleets in an Amazon Web Services Region. Properties include the computing
|
|
33
|
+
* hardware and deployment configuration for instances in the fleet.</p>
|
|
34
|
+
* <p>You can use this operation in the following ways: </p>
|
|
32
35
|
* <ul>
|
|
33
36
|
* <li>
|
|
34
|
-
* <p>To get attributes for
|
|
35
|
-
* or fleet ARNs. </p>
|
|
37
|
+
* <p>To get attributes for specific fleets, provide a list of fleet IDs or fleet ARNs.</p>
|
|
36
38
|
* </li>
|
|
37
39
|
* <li>
|
|
38
|
-
* <p>To get attributes for all fleets, do not provide a fleet identifier
|
|
40
|
+
* <p>To get attributes for all fleets, do not provide a fleet identifier.</p>
|
|
39
41
|
* </li>
|
|
40
42
|
* </ul>
|
|
41
43
|
* <p>When requesting attributes for multiple fleets, use the pagination parameters to
|
|
@@ -106,11 +108,27 @@ declare const DescribeFleetAttributesCommand_base: {
|
|
|
106
108
|
* // CertificateConfiguration: { // CertificateConfiguration
|
|
107
109
|
* // CertificateType: "DISABLED" || "GENERATED", // required
|
|
108
110
|
* // },
|
|
109
|
-
* // ComputeType: "EC2" || "ANYWHERE",
|
|
111
|
+
* // ComputeType: "EC2" || "ANYWHERE" || "CONTAINER",
|
|
110
112
|
* // AnywhereConfiguration: { // AnywhereConfiguration
|
|
111
113
|
* // Cost: "STRING_VALUE", // required
|
|
112
114
|
* // },
|
|
113
115
|
* // InstanceRoleCredentialsProvider: "SHARED_CREDENTIAL_FILE",
|
|
116
|
+
* // ContainerGroupsAttributes: { // ContainerGroupsAttributes
|
|
117
|
+
* // ContainerGroupDefinitionProperties: [ // ContainerGroupDefinitionPropertiesList
|
|
118
|
+
* // { // ContainerGroupDefinitionProperty
|
|
119
|
+
* // SchedulingStrategy: "REPLICA" || "DAEMON",
|
|
120
|
+
* // ContainerGroupDefinitionName: "STRING_VALUE",
|
|
121
|
+
* // },
|
|
122
|
+
* // ],
|
|
123
|
+
* // ConnectionPortRange: { // ConnectionPortRange
|
|
124
|
+
* // FromPort: Number("int"), // required
|
|
125
|
+
* // ToPort: Number("int"), // required
|
|
126
|
+
* // },
|
|
127
|
+
* // ContainerGroupsPerInstance: { // ContainerGroupsPerInstance
|
|
128
|
+
* // DesiredReplicaContainerGroupsPerInstance: Number("int"),
|
|
129
|
+
* // MaxReplicaContainerGroupsPerInstance: Number("int"),
|
|
130
|
+
* // },
|
|
131
|
+
* // },
|
|
114
132
|
* // },
|
|
115
133
|
* // ],
|
|
116
134
|
* // NextToken: "STRING_VALUE",
|
|
@@ -26,10 +26,14 @@ declare const DescribeFleetCapacityCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
29
|
+
* <p>
|
|
30
|
+
* <b>This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.</b>
|
|
31
|
+
* </p>
|
|
32
|
+
* <p>Retrieves the resource capacity settings for one or more fleets. For a container
|
|
33
|
+
* fleet, this operation also returns counts for replica container groups.</p>
|
|
34
|
+
* <p>With multi-location fleets, this operation retrieves data for the fleet's home Region
|
|
35
|
+
* only. To retrieve capacity for remote locations, see
|
|
36
|
+
* <a>DescribeFleetLocationCapacity</a>.</p>
|
|
33
37
|
* <p>This operation can be used in the following ways: </p>
|
|
34
38
|
* <ul>
|
|
35
39
|
* <li>
|
|
@@ -44,9 +48,9 @@ declare const DescribeFleetCapacityCommand_base: {
|
|
|
44
48
|
* <p>When requesting multiple fleets, use the pagination parameters to retrieve results as
|
|
45
49
|
* a set of sequential pages. </p>
|
|
46
50
|
* <p>If successful, a <code>FleetCapacity</code> object is returned for each requested
|
|
47
|
-
* fleet ID. Each FleetCapacity object includes a <code>Location</code>
|
|
48
|
-
* set to the fleet's home Region.
|
|
49
|
-
*
|
|
51
|
+
* fleet ID. Each <code>FleetCapacity</code> object includes a <code>Location</code>
|
|
52
|
+
* property, which is set to the fleet's home Region. Capacity values are returned only for
|
|
53
|
+
* fleets that currently exist.</p>
|
|
50
54
|
* <note>
|
|
51
55
|
* <p>Some API operations may limit the number of fleet IDs that are allowed in one
|
|
52
56
|
* request. If a request exceeds this limit, the request fails and the error message
|
|
@@ -93,6 +97,12 @@ declare const DescribeFleetCapacityCommand_base: {
|
|
|
93
97
|
* // TERMINATING: Number("int"),
|
|
94
98
|
* // },
|
|
95
99
|
* // Location: "STRING_VALUE",
|
|
100
|
+
* // ReplicaContainerGroupCounts: { // ReplicaContainerGroupCounts
|
|
101
|
+
* // PENDING: Number("int"),
|
|
102
|
+
* // ACTIVE: Number("int"),
|
|
103
|
+
* // IDLE: Number("int"),
|
|
104
|
+
* // TERMINATING: Number("int"),
|
|
105
|
+
* // },
|
|
96
106
|
* // },
|
|
97
107
|
* // ],
|
|
98
108
|
* // NextToken: "STRING_VALUE",
|
|
@@ -28,9 +28,11 @@ declare const DescribeFleetLocationCapacityCommand_base: {
|
|
|
28
28
|
/**
|
|
29
29
|
* <p>Retrieves the resource capacity settings for a fleet location. The data returned
|
|
30
30
|
* includes the current capacity (number of EC2 instances) and some scaling settings for
|
|
31
|
-
* the requested fleet location.
|
|
32
|
-
*
|
|
33
|
-
*
|
|
31
|
+
* the requested fleet location. For a container fleet, this operation also returns counts
|
|
32
|
+
* for replica container groups.</p>
|
|
33
|
+
* <p>Use this operation to retrieve capacity information for a fleet's remote location or
|
|
34
|
+
* home Region (you can also retrieve home Region capacity by calling
|
|
35
|
+
* <code>DescribeFleetCapacity</code>).</p>
|
|
34
36
|
* <p>To retrieve capacity data, identify a fleet and location. </p>
|
|
35
37
|
* <p>If successful, a <code>FleetCapacity</code> object is returned for the requested fleet
|
|
36
38
|
* location. </p>
|
|
@@ -71,6 +73,12 @@ declare const DescribeFleetLocationCapacityCommand_base: {
|
|
|
71
73
|
* // TERMINATING: Number("int"),
|
|
72
74
|
* // },
|
|
73
75
|
* // Location: "STRING_VALUE",
|
|
76
|
+
* // ReplicaContainerGroupCounts: { // ReplicaContainerGroupCounts
|
|
77
|
+
* // PENDING: Number("int"),
|
|
78
|
+
* // ACTIVE: Number("int"),
|
|
79
|
+
* // IDLE: Number("int"),
|
|
80
|
+
* // TERMINATING: Number("int"),
|
|
81
|
+
* // },
|
|
74
82
|
* // },
|
|
75
83
|
* // };
|
|
76
84
|
*
|
|
@@ -26,15 +26,16 @@ declare const DescribeFleetPortSettingsCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Retrieves a fleet's inbound connection permissions. Connection permissions specify
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
29
|
+
* <p>Retrieves a fleet's inbound connection permissions. Connection permissions specify IP
|
|
30
|
+
* addresses and port settings that incoming traffic can use to access server processes in
|
|
31
|
+
* the fleet. Game server processes that are running in the fleet must use a port that
|
|
32
|
+
* falls within this range. To connect to game server processes on a container fleet, the
|
|
33
|
+
* port settings should include one or more of the fleet's connection ports. </p>
|
|
34
|
+
* <p>Use this operation in the following ways: </p>
|
|
34
35
|
* <ul>
|
|
35
36
|
* <li>
|
|
36
|
-
* <p>To retrieve the
|
|
37
|
-
*
|
|
37
|
+
* <p>To retrieve the port settings for a fleet, identify the fleet's unique
|
|
38
|
+
* identifier. </p>
|
|
38
39
|
* </li>
|
|
39
40
|
* <li>
|
|
40
41
|
* <p>To check the status of recent updates to a fleet remote location, specify the
|
|
@@ -43,8 +44,8 @@ declare const DescribeFleetPortSettingsCommand_base: {
|
|
|
43
44
|
* </li>
|
|
44
45
|
* </ul>
|
|
45
46
|
* <p>If successful, a set of <code>IpPermission</code> objects is returned for the
|
|
46
|
-
* requested fleet ID. When a location
|
|
47
|
-
* requested fleet has been deleted, the result set is empty.</p>
|
|
47
|
+
* requested fleet ID. When specifying a location, this operation returns a pending status.
|
|
48
|
+
* If the requested fleet has been deleted, the result set is empty.</p>
|
|
48
49
|
* <p>
|
|
49
50
|
* <b>Learn more</b>
|
|
50
51
|
* </p>
|
|
@@ -26,10 +26,13 @@ declare const DescribeRuntimeConfigurationCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Retrieves a fleet's runtime configuration settings. The runtime configuration
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
29
|
+
* <p>Retrieves a fleet's runtime configuration settings. The runtime configuration
|
|
30
|
+
* determines which server processes run, and how, on computes in the fleet. For managed
|
|
31
|
+
* EC2 fleets, the runtime configuration describes server processes that run on each fleet
|
|
32
|
+
* instance. For container fleets, the runtime configuration describes server processes
|
|
33
|
+
* that run in each replica container group. You can update a fleet's runtime configuration
|
|
34
|
+
* at any time using <a>UpdateRuntimeConfiguration</a>.</p>
|
|
35
|
+
* <p>To get the current runtime configuration for a fleet, provide the fleet ID. </p>
|
|
33
36
|
* <p>If successful, a <code>RuntimeConfiguration</code> object is returned for the
|
|
34
37
|
* requested fleet. If the requested fleet has been deleted, the result set is
|
|
35
38
|
* empty.</p>
|
|
@@ -26,26 +26,50 @@ declare const GetComputeAccessCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
* to start a session with the compute. For more details, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-sessions-start.html#sessions-start-cli"> Starting a session (CLI)</a> in the <i>Amazon EC2 Systems Manager User Guide</i>.</p>
|
|
29
|
+
* <p>
|
|
30
|
+
* <b>This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.</b>
|
|
31
|
+
* </p>
|
|
32
|
+
* <p>Requests authorization to remotely connect to a hosting resource in a Amazon GameLift managed
|
|
33
|
+
* fleet. This operation is not used with Amazon GameLift Anywhere fleets</p>
|
|
34
|
+
* <p>To request access, specify the compute name and the fleet ID. If successful, this
|
|
35
|
+
* operation returns a set of temporary Amazon Web Services credentials, including a two-part access key
|
|
36
|
+
* and a session token.</p>
|
|
38
37
|
* <p>
|
|
39
|
-
* <b>
|
|
38
|
+
* <b>EC2 fleets</b>
|
|
40
39
|
* </p>
|
|
40
|
+
* <p>With an EC2 fleet (where compute type is <code>EC2</code>), use these credentials with
|
|
41
|
+
* Amazon EC2 Systems Manager (SSM) to start a session with the compute. For more details, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-sessions-start.html#sessions-start-cli"> Starting a session (CLI)</a> in the <i>Amazon EC2 Systems Manager User
|
|
42
|
+
* Guide</i>.</p>
|
|
41
43
|
* <p>
|
|
42
|
-
* <
|
|
43
|
-
* instances</a>
|
|
44
|
+
* <b>Container fleets</b>
|
|
44
45
|
* </p>
|
|
46
|
+
* <p>With a container fleet (where compute type is <code>CONTAINER</code>), use
|
|
47
|
+
* these credentials and the target value with SSM to connect to the fleet instance where
|
|
48
|
+
* the container is running. After you're connected to the instance, use Docker commands to
|
|
49
|
+
* interact with the container.</p>
|
|
45
50
|
* <p>
|
|
46
|
-
* <
|
|
47
|
-
* issues</a>
|
|
51
|
+
* <b>Learn more</b>
|
|
48
52
|
* </p>
|
|
53
|
+
* <ul>
|
|
54
|
+
* <li>
|
|
55
|
+
* <p>
|
|
56
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html">Remotely connect to fleet
|
|
57
|
+
* instances</a>
|
|
58
|
+
* </p>
|
|
59
|
+
* </li>
|
|
60
|
+
* <li>
|
|
61
|
+
* <p>
|
|
62
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html">Debug fleet
|
|
63
|
+
* issues</a>
|
|
64
|
+
* </p>
|
|
65
|
+
* </li>
|
|
66
|
+
* <li>
|
|
67
|
+
* <p>
|
|
68
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-remote-access.html">
|
|
69
|
+
* Remotely connect to a container fleet</a>
|
|
70
|
+
* </p>
|
|
71
|
+
* </li>
|
|
72
|
+
* </ul>
|
|
49
73
|
* @example
|
|
50
74
|
* Use a bare-bones client and the command you need to make an API call.
|
|
51
75
|
* ```javascript
|
|
@@ -68,6 +92,7 @@ declare const GetComputeAccessCommand_base: {
|
|
|
68
92
|
* // SecretAccessKey: "STRING_VALUE",
|
|
69
93
|
* // SessionToken: "STRING_VALUE",
|
|
70
94
|
* // },
|
|
95
|
+
* // Target: "STRING_VALUE",
|
|
71
96
|
* // };
|
|
72
97
|
*
|
|
73
98
|
* ```
|
|
@@ -26,12 +26,26 @@ declare const GetComputeAuthTokenCommand_base: {
|
|
|
26
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
27
27
|
};
|
|
28
28
|
/**
|
|
29
|
-
* <p>Requests an authentication token from Amazon GameLift for a
|
|
30
|
-
* fleet.
|
|
31
|
-
* with the Amazon GameLift service
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
29
|
+
* <p>Requests an authentication token from Amazon GameLift for a compute resource in an Amazon GameLift
|
|
30
|
+
* Anywhere fleet or container fleet. Game servers that are running on the compute use this
|
|
31
|
+
* token to communicate with the Amazon GameLift service, such as when calling the Amazon GameLift server
|
|
32
|
+
* SDK action <code>InitSDK()</code>. Authentication tokens are valid for a limited time
|
|
33
|
+
* span, so you need to request a fresh token before the current token expires.</p>
|
|
34
|
+
* <p>Use this operation based on the fleet compute type:</p>
|
|
35
|
+
* <ul>
|
|
36
|
+
* <li>
|
|
37
|
+
* <p>For <code>EC2</code> fleets, auth token retrieval and refresh is handled
|
|
38
|
+
* automatically. All game servers that are running on all fleet instances have
|
|
39
|
+
* access to a valid auth token.</p>
|
|
40
|
+
* </li>
|
|
41
|
+
* <li>
|
|
42
|
+
* <p>For <code>ANYWHERE</code> and <code>CONTAINER</code> fleets, if you're using
|
|
43
|
+
* the Amazon GameLift Agent, auth token retrieval and refresh is handled automatically for
|
|
44
|
+
* any container or Anywhere compute where the Agent is running. If you're not
|
|
45
|
+
* using the Agent, create a mechanism to retrieve and refresh auth tokens for
|
|
46
|
+
* computes that are running game server processes. </p>
|
|
47
|
+
* </li>
|
|
48
|
+
* </ul>
|
|
35
49
|
* <p>
|
|
36
50
|
* <b>Learn more</b>
|
|
37
51
|
* </p>
|