@aws-sdk/client-gamelift 3.686.0 → 3.690.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 (116) hide show
  1. package/README.md +72 -0
  2. package/dist-cjs/index.js +830 -188
  3. package/dist-es/GameLift.js +18 -0
  4. package/dist-es/commands/CreateContainerFleetCommand.js +23 -0
  5. package/dist-es/commands/CreateFleetCommand.js +2 -2
  6. package/dist-es/commands/DeleteContainerFleetCommand.js +22 -0
  7. package/dist-es/commands/DescribeContainerFleetCommand.js +23 -0
  8. package/dist-es/commands/DescribeFleetAttributesCommand.js +1 -2
  9. package/dist-es/commands/DescribeFleetDeploymentCommand.js +22 -0
  10. package/dist-es/commands/ListContainerFleetsCommand.js +23 -0
  11. package/dist-es/commands/ListContainerGroupDefinitionVersionsCommand.js +23 -0
  12. package/dist-es/commands/ListContainerGroupDefinitionsCommand.js +1 -1
  13. package/dist-es/commands/ListFleetDeploymentsCommand.js +22 -0
  14. package/dist-es/commands/RegisterComputeCommand.js +1 -1
  15. package/dist-es/commands/RequestUploadCredentialsCommand.js +1 -1
  16. package/dist-es/commands/UpdateContainerFleetCommand.js +23 -0
  17. package/dist-es/commands/UpdateContainerGroupDefinitionCommand.js +23 -0
  18. package/dist-es/commands/index.js +9 -0
  19. package/dist-es/models/models_0.js +132 -81
  20. package/dist-es/models/models_1.js +50 -1
  21. package/dist-es/pagination/ListContainerFleetsPaginator.js +4 -0
  22. package/dist-es/pagination/ListContainerGroupDefinitionVersionsPaginator.js +4 -0
  23. package/dist-es/pagination/ListFleetDeploymentsPaginator.js +4 -0
  24. package/dist-es/pagination/index.js +3 -0
  25. package/dist-es/protocols/Aws_json1_1.js +352 -7
  26. package/dist-types/GameLift.d.ts +65 -0
  27. package/dist-types/GameLiftClient.d.ts +11 -2
  28. package/dist-types/commands/CreateBuildCommand.d.ts +27 -21
  29. package/dist-types/commands/CreateContainerFleetCommand.d.ts +283 -0
  30. package/dist-types/commands/CreateContainerGroupDefinitionCommand.d.ts +278 -119
  31. package/dist-types/commands/CreateFleetCommand.d.ts +5 -88
  32. package/dist-types/commands/CreateFleetLocationsCommand.d.ts +3 -6
  33. package/dist-types/commands/CreateScriptCommand.d.ts +9 -12
  34. package/dist-types/commands/DeleteContainerFleetCommand.d.ts +102 -0
  35. package/dist-types/commands/DeleteContainerGroupDefinitionCommand.d.ts +24 -7
  36. package/dist-types/commands/DeleteScalingPolicyCommand.d.ts +3 -0
  37. package/dist-types/commands/DeregisterComputeCommand.d.ts +2 -5
  38. package/dist-types/commands/DescribeComputeCommand.d.ts +14 -21
  39. package/dist-types/commands/DescribeContainerFleetCommand.d.ts +157 -0
  40. package/dist-types/commands/DescribeContainerGroupDefinitionCommand.d.ts +95 -48
  41. package/dist-types/commands/DescribeFleetAttributesCommand.d.ts +2 -21
  42. package/dist-types/commands/DescribeFleetCapacityCommand.d.ts +8 -8
  43. package/dist-types/commands/DescribeFleetDeploymentCommand.d.ts +125 -0
  44. package/dist-types/commands/DescribeFleetEventsCommand.d.ts +4 -1
  45. package/dist-types/commands/DescribeFleetLocationCapacityCommand.d.ts +4 -4
  46. package/dist-types/commands/DescribeFleetPortSettingsCommand.d.ts +3 -3
  47. package/dist-types/commands/DescribeRuntimeConfigurationCommand.d.ts +2 -4
  48. package/dist-types/commands/GetComputeAccessCommand.d.ts +20 -30
  49. package/dist-types/commands/GetComputeAuthTokenCommand.d.ts +18 -13
  50. package/dist-types/commands/ListComputeCommand.d.ts +36 -28
  51. package/dist-types/commands/ListContainerFleetsCommand.d.ts +165 -0
  52. package/dist-types/commands/ListContainerGroupDefinitionVersionsCommand.d.ts +216 -0
  53. package/dist-types/commands/ListContainerGroupDefinitionsCommand.d.ts +97 -49
  54. package/dist-types/commands/ListFleetDeploymentsCommand.d.ts +132 -0
  55. package/dist-types/commands/ListFleetsCommand.d.ts +2 -10
  56. package/dist-types/commands/ListGameServerGroupsCommand.d.ts +1 -1
  57. package/dist-types/commands/ListGameServersCommand.d.ts +1 -1
  58. package/dist-types/commands/ListLocationsCommand.d.ts +1 -1
  59. package/dist-types/commands/ListScriptsCommand.d.ts +1 -1
  60. package/dist-types/commands/ListTagsForResourceCommand.d.ts +4 -1
  61. package/dist-types/commands/PutScalingPolicyCommand.d.ts +4 -1
  62. package/dist-types/commands/RegisterComputeCommand.d.ts +13 -19
  63. package/dist-types/commands/RegisterGameServerCommand.d.ts +1 -1
  64. package/dist-types/commands/RequestUploadCredentialsCommand.d.ts +1 -1
  65. package/dist-types/commands/ResolveAliasCommand.d.ts +1 -1
  66. package/dist-types/commands/ResumeGameServerGroupCommand.d.ts +1 -2
  67. package/dist-types/commands/StartGameSessionPlacementCommand.d.ts +2 -2
  68. package/dist-types/commands/StopFleetActionsCommand.d.ts +1 -1
  69. package/dist-types/commands/TagResourceCommand.d.ts +3 -0
  70. package/dist-types/commands/UntagResourceCommand.d.ts +3 -0
  71. package/dist-types/commands/UpdateContainerFleetCommand.d.ts +253 -0
  72. package/dist-types/commands/UpdateContainerGroupDefinitionCommand.d.ts +310 -0
  73. package/dist-types/commands/UpdateFleetCapacityCommand.d.ts +6 -9
  74. package/dist-types/commands/UpdateRuntimeConfigurationCommand.d.ts +1 -3
  75. package/dist-types/commands/index.d.ts +9 -0
  76. package/dist-types/models/models_0.d.ts +5518 -5258
  77. package/dist-types/models/models_1.d.ts +897 -18
  78. package/dist-types/pagination/ListContainerFleetsPaginator.d.ts +7 -0
  79. package/dist-types/pagination/ListContainerGroupDefinitionVersionsPaginator.d.ts +7 -0
  80. package/dist-types/pagination/ListFleetDeploymentsPaginator.d.ts +7 -0
  81. package/dist-types/pagination/index.d.ts +3 -0
  82. package/dist-types/protocols/Aws_json1_1.d.ts +81 -0
  83. package/dist-types/ts3.4/GameLift.d.ts +161 -0
  84. package/dist-types/ts3.4/GameLiftClient.d.ts +54 -0
  85. package/dist-types/ts3.4/commands/CreateContainerFleetCommand.d.ts +51 -0
  86. package/dist-types/ts3.4/commands/DeleteContainerFleetCommand.d.ts +51 -0
  87. package/dist-types/ts3.4/commands/DeleteContainerGroupDefinitionCommand.d.ts +6 -2
  88. package/dist-types/ts3.4/commands/DescribeContainerFleetCommand.d.ts +51 -0
  89. package/dist-types/ts3.4/commands/DescribeFleetDeploymentCommand.d.ts +51 -0
  90. package/dist-types/ts3.4/commands/ListContainerFleetsCommand.d.ts +51 -0
  91. package/dist-types/ts3.4/commands/ListContainerGroupDefinitionVersionsCommand.d.ts +51 -0
  92. package/dist-types/ts3.4/commands/ListContainerGroupDefinitionsCommand.d.ts +1 -1
  93. package/dist-types/ts3.4/commands/ListFleetDeploymentsCommand.d.ts +51 -0
  94. package/dist-types/ts3.4/commands/ListFleetsCommand.d.ts +1 -1
  95. package/dist-types/ts3.4/commands/ListGameServerGroupsCommand.d.ts +1 -1
  96. package/dist-types/ts3.4/commands/ListGameServersCommand.d.ts +1 -1
  97. package/dist-types/ts3.4/commands/ListLocationsCommand.d.ts +1 -1
  98. package/dist-types/ts3.4/commands/ListScriptsCommand.d.ts +1 -1
  99. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
  100. package/dist-types/ts3.4/commands/PutScalingPolicyCommand.d.ts +1 -1
  101. package/dist-types/ts3.4/commands/RegisterComputeCommand.d.ts +1 -1
  102. package/dist-types/ts3.4/commands/RegisterGameServerCommand.d.ts +1 -1
  103. package/dist-types/ts3.4/commands/RequestUploadCredentialsCommand.d.ts +1 -1
  104. package/dist-types/ts3.4/commands/ResolveAliasCommand.d.ts +1 -1
  105. package/dist-types/ts3.4/commands/ResumeGameServerGroupCommand.d.ts +4 -2
  106. package/dist-types/ts3.4/commands/UpdateContainerFleetCommand.d.ts +51 -0
  107. package/dist-types/ts3.4/commands/UpdateContainerGroupDefinitionCommand.d.ts +51 -0
  108. package/dist-types/ts3.4/commands/index.d.ts +9 -0
  109. package/dist-types/ts3.4/models/models_0.d.ts +333 -261
  110. package/dist-types/ts3.4/models/models_1.d.ts +222 -0
  111. package/dist-types/ts3.4/pagination/ListContainerFleetsPaginator.d.ts +11 -0
  112. package/dist-types/ts3.4/pagination/ListContainerGroupDefinitionVersionsPaginator.d.ts +11 -0
  113. package/dist-types/ts3.4/pagination/ListFleetDeploymentsPaginator.d.ts +11 -0
  114. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  115. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +108 -0
  116. package/package.json +6 -6
@@ -27,13 +27,13 @@ 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 Realtime Servers script. Realtime scripts are JavaScript that
31
- * provide configuration settings and optional custom game logic for your game. The script
32
- * is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is
33
- * executed during an active game session. </p>
34
- * <p>To create a new script record, specify a script name and provide the script file(s).
35
- * The script files and all dependencies must be zipped into a single file. You can pull
36
- * the zip file from either of these locations: </p>
30
+ * <p>Creates a script resource for your Realtime Servers script. Realtime scripts are JavaScript files
31
+ * that provide configuration settings and optional custom game logic for your game. Script
32
+ * logic is executed during an active game session. To deploy Realtime Servers for hosting, create an
33
+ * Amazon GameLift managed fleet with the script.</p>
34
+ * <p>To create a script resource, specify a script name and provide the script file(s). The
35
+ * script files and all dependencies must be combined into a single .zip file. You can
36
+ * upload the .zip file from either of these locations: </p>
37
37
  * <ul>
38
38
  * <li>
39
39
  * <p>A locally available directory. Use the <i>ZipFile</i> parameter
@@ -46,11 +46,8 @@ declare const CreateScriptCommand_base: {
46
46
  * to access your S3 bucket. </p>
47
47
  * </li>
48
48
  * </ul>
49
- * <p>If the call is successful, a new script record is created with a unique script ID. If
50
- * the script file is provided as a local file, the file is uploaded to an Amazon GameLift-owned S3
51
- * bucket and the script record's storage location reflects this location. If the script
52
- * file is provided as an S3 bucket, Amazon GameLift accesses the file at this storage location as
53
- * needed for deployment.</p>
49
+ * <p>If the call is successful, Amazon GameLift creates a new script resource with a unique script
50
+ * ID. The script is uploaded to an Amazon S3 bucket that is owned by Amazon GameLift.</p>
54
51
  * <p>
55
52
  * <b>Learn more</b>
56
53
  * </p>
@@ -0,0 +1,102 @@
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 { DeleteContainerFleetInput, DeleteContainerFleetOutput } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DeleteContainerFleetCommand}.
14
+ */
15
+ export interface DeleteContainerFleetCommandInput extends DeleteContainerFleetInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeleteContainerFleetCommand}.
21
+ */
22
+ export interface DeleteContainerFleetCommandOutput extends DeleteContainerFleetOutput, __MetadataBearer {
23
+ }
24
+ declare const DeleteContainerFleetCommand_base: {
25
+ new (input: DeleteContainerFleetCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteContainerFleetCommandInput, DeleteContainerFleetCommandOutput, GameLiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: DeleteContainerFleetCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteContainerFleetCommandInput, DeleteContainerFleetCommandOutput, GameLiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Deletes all resources and information related to a container fleet and shuts down
31
+ * currently running fleet instances, including those in remote locations. The container
32
+ * fleet must be in <code>ACTIVE</code> status to be deleted.</p>
33
+ * <p>To delete a fleet, specify the fleet ID to be terminated. During the deletion process,
34
+ * the fleet status is changed to <code>DELETING</code>. </p>
35
+ * <p>
36
+ * <b>Learn more</b>
37
+ * </p>
38
+ * <p>
39
+ * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift
40
+ * Fleets</a>
41
+ * </p>
42
+ * @example
43
+ * Use a bare-bones client and the command you need to make an API call.
44
+ * ```javascript
45
+ * import { GameLiftClient, DeleteContainerFleetCommand } from "@aws-sdk/client-gamelift"; // ES Modules import
46
+ * // const { GameLiftClient, DeleteContainerFleetCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import
47
+ * const client = new GameLiftClient(config);
48
+ * const input = { // DeleteContainerFleetInput
49
+ * FleetId: "STRING_VALUE", // required
50
+ * };
51
+ * const command = new DeleteContainerFleetCommand(input);
52
+ * const response = await client.send(command);
53
+ * // {};
54
+ *
55
+ * ```
56
+ *
57
+ * @param DeleteContainerFleetCommandInput - {@link DeleteContainerFleetCommandInput}
58
+ * @returns {@link DeleteContainerFleetCommandOutput}
59
+ * @see {@link DeleteContainerFleetCommandInput} for command's `input` shape.
60
+ * @see {@link DeleteContainerFleetCommandOutput} for command's `response` shape.
61
+ * @see {@link GameLiftClientResolvedConfig | config} for GameLiftClient's `config` shape.
62
+ *
63
+ * @throws {@link InternalServiceException} (server fault)
64
+ * <p>The service encountered an unrecoverable internal failure while processing the
65
+ * request. Clients can retry such requests immediately or after a waiting period.</p>
66
+ *
67
+ * @throws {@link InvalidRequestException} (client fault)
68
+ * <p>One or more parameter values in the request are invalid. Correct the invalid parameter
69
+ * values before retrying.</p>
70
+ *
71
+ * @throws {@link NotFoundException} (client fault)
72
+ * <p>The requested resources was not found. The resource was either not created yet or deleted.</p>
73
+ *
74
+ * @throws {@link TaggingFailedException} (client fault)
75
+ * <p>The requested tagging operation did not succeed. This may be due to invalid tag format
76
+ * or the maximum tag limit may have been exceeded. Resolve the issue before
77
+ * retrying.</p>
78
+ *
79
+ * @throws {@link UnauthorizedException} (client fault)
80
+ * <p>The client failed authentication. Clients should not retry such requests.</p>
81
+ *
82
+ * @throws {@link UnsupportedRegionException} (client fault)
83
+ * <p>The requested operation is not supported in the Region specified.</p>
84
+ *
85
+ * @throws {@link GameLiftServiceException}
86
+ * <p>Base exception class for all service exceptions from GameLift service.</p>
87
+ *
88
+ * @public
89
+ */
90
+ export declare class DeleteContainerFleetCommand extends DeleteContainerFleetCommand_base {
91
+ /** @internal type navigation helper, not in runtime. */
92
+ protected static __types: {
93
+ api: {
94
+ input: DeleteContainerFleetInput;
95
+ output: {};
96
+ };
97
+ sdk: {
98
+ input: DeleteContainerFleetCommandInput;
99
+ output: DeleteContainerFleetCommandOutput;
100
+ };
101
+ };
102
+ }
@@ -1,7 +1,7 @@
1
1
  import { Command as $Command } from "@smithy/smithy-client";
2
2
  import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
3
  import { GameLiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../GameLiftClient";
4
- import { DeleteContainerGroupDefinitionInput } from "../models/models_0";
4
+ import { DeleteContainerGroupDefinitionInput, DeleteContainerGroupDefinitionOutput } from "../models/models_0";
5
5
  /**
6
6
  * @public
7
7
  */
@@ -19,7 +19,7 @@ export interface DeleteContainerGroupDefinitionCommandInput extends DeleteContai
19
19
  *
20
20
  * The output of {@link DeleteContainerGroupDefinitionCommand}.
21
21
  */
22
- export interface DeleteContainerGroupDefinitionCommandOutput extends __MetadataBearer {
22
+ export interface DeleteContainerGroupDefinitionCommandOutput extends DeleteContainerGroupDefinitionOutput, __MetadataBearer {
23
23
  }
24
24
  declare const DeleteContainerGroupDefinitionCommand_base: {
25
25
  new (input: DeleteContainerGroupDefinitionCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteContainerGroupDefinitionCommandInput, DeleteContainerGroupDefinitionCommandOutput, GameLiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
@@ -27,12 +27,27 @@ declare const DeleteContainerGroupDefinitionCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>
31
- * <b>This operation is used with the Amazon GameLift containers feature, which is currently in public preview. </b>
30
+ * <p>Deletes a container group definition. You can delete a container group definition if there
31
+ * are no fleets using the definition. </p>
32
+ * <p>
33
+ * <b>Request options:</b>
32
34
  * </p>
33
- * <p>Deletes a container group definition resource. You can delete a container group definition
34
- * if there are no fleets using the definition. </p>
35
- * <p>To delete a container group definition, identify the resource to delete.</p>
35
+ * <ul>
36
+ * <li>
37
+ * <p>Delete an entire container group definition, including all versions. Specify the
38
+ * container group definition name, or use an ARN value without the version number.</p>
39
+ * </li>
40
+ * <li>
41
+ * <p>Delete a particular version. Specify the container group definition name and a version
42
+ * number, or use an ARN value that includes the version number.</p>
43
+ * </li>
44
+ * <li>
45
+ * <p>Keep the newest versions and delete all older versions. Specify the container group
46
+ * definition name and the number of versions to retain. For example, set
47
+ * <code>VersionCountToRetain</code> to 5 to delete all but the five most recent
48
+ * versions.</p>
49
+ * </li>
50
+ * </ul>
36
51
  * <p>
37
52
  * <b>Learn more</b>
38
53
  * </p>
@@ -51,6 +66,8 @@ declare const DeleteContainerGroupDefinitionCommand_base: {
51
66
  * const client = new GameLiftClient(config);
52
67
  * const input = { // DeleteContainerGroupDefinitionInput
53
68
  * Name: "STRING_VALUE", // required
69
+ * VersionNumber: Number("int"),
70
+ * VersionCountToRetain: Number("int"),
54
71
  * };
55
72
  * const command = new DeleteContainerGroupDefinitionCommand(input);
56
73
  * const response = await client.send(command);
@@ -68,6 +68,9 @@ declare const DeleteScalingPolicyCommand_base: {
68
68
  * @throws {@link UnauthorizedException} (client fault)
69
69
  * <p>The client failed authentication. Clients should not retry such requests.</p>
70
70
  *
71
+ * @throws {@link UnsupportedRegionException} (client fault)
72
+ * <p>The requested operation is not supported in the Region specified.</p>
73
+ *
71
74
  * @throws {@link GameLiftServiceException}
72
75
  * <p>Base exception class for all service exceptions from GameLift service.</p>
73
76
  *
@@ -27,12 +27,9 @@ declare const DeregisterComputeCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>
31
- * <b>This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.</b>
32
- * </p>
33
- * <p>Removes a compute resource from an Amazon GameLift Anywhere fleet or container fleet.
30
+ * <p>Removes a compute resource from an Amazon GameLift Anywhere fleet.
34
31
  * Deregistered computes can no longer host game sessions through Amazon GameLift.</p>
35
- * <p>For an Anywhere fleet or a container fleet that's running the Amazon GameLift Agent, the Agent
32
+ * <p>For an Anywhere fleet that's running the Amazon GameLift Agent, the Agent
36
33
  * handles all compute registry tasks for you. For an Anywhere fleet that doesn't use the
37
34
  * Agent, call this operation to deregister fleet computes. </p>
38
35
  * <p>To deregister a compute, call this operation from the compute that's being
@@ -27,10 +27,7 @@ declare const DescribeComputeCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>
31
- * <b>This operation has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.</b>
32
- * </p>
33
- * <p>Retrieves properties for a compute resource in an Amazon GameLift fleet. To get a list of all
30
+ * <p>Retrieves properties for a compute resource in an Amazon GameLift fleet. To get a list of all
34
31
  * computes in a fleet, call <a>ListCompute</a>. </p>
35
32
  * <p>To request information on a specific compute, provide the fleet ID and compute
36
33
  * name.</p>
@@ -38,18 +35,13 @@ declare const DescribeComputeCommand_base: {
38
35
  * Depending on the fleet's compute type, the result includes the following information: </p>
39
36
  * <ul>
40
37
  * <li>
41
- * <p>For <code>EC2</code> fleets, this operation returns information about the EC2
38
+ * <p>For managed EC2 fleets, this operation returns information about the EC2
42
39
  * instance.</p>
43
40
  * </li>
44
41
  * <li>
45
- * <p>For <code>ANYWHERE</code> fleets, this operation returns information about the
42
+ * <p>For Anywhere fleets, this operation returns information about the
46
43
  * registered compute.</p>
47
44
  * </li>
48
- * <li>
49
- * <p>For <code>CONTAINER</code> fleets, this operation returns information about
50
- * the container that's registered as a compute, and the instance it's running on.
51
- * The compute name is the container name.</p>
52
- * </li>
53
45
  * </ul>
54
46
  * @example
55
47
  * Use a bare-bones client and the command you need to make an API call.
@@ -71,7 +63,7 @@ declare const DescribeComputeCommand_base: {
71
63
  * // ComputeArn: "STRING_VALUE",
72
64
  * // IpAddress: "STRING_VALUE",
73
65
  * // DnsName: "STRING_VALUE",
74
- * // ComputeStatus: "PENDING" || "ACTIVE" || "TERMINATING",
66
+ * // ComputeStatus: "PENDING" || "ACTIVE" || "TERMINATING" || "IMPAIRED",
75
67
  * // Location: "STRING_VALUE",
76
68
  * // CreationTime: new Date("TIMESTAMP"),
77
69
  * // OperatingSystem: "WINDOWS_2012" || "AMAZON_LINUX" || "AMAZON_LINUX_2" || "WINDOWS_2016" || "AMAZON_LINUX_2023",
@@ -79,15 +71,13 @@ declare const DescribeComputeCommand_base: {
79
71
  * // GameLiftServiceSdkEndpoint: "STRING_VALUE",
80
72
  * // GameLiftAgentEndpoint: "STRING_VALUE",
81
73
  * // InstanceId: "STRING_VALUE",
82
- * // ContainerAttributes: { // ContainerAttributes
83
- * // ContainerPortMappings: [ // ContainerPortMappingList
84
- * // { // ContainerPortMapping
85
- * // ContainerPort: Number("int"),
86
- * // ConnectionPort: Number("int"),
87
- * // Protocol: "TCP" || "UDP",
88
- * // },
89
- * // ],
90
- * // },
74
+ * // ContainerAttributes: [ // ContainerAttributes
75
+ * // { // ContainerAttribute
76
+ * // ContainerName: "STRING_VALUE",
77
+ * // ContainerRuntimeId: "STRING_VALUE",
78
+ * // },
79
+ * // ],
80
+ * // GameServerContainerGroupDefinitionArn: "STRING_VALUE",
91
81
  * // },
92
82
  * // };
93
83
  *
@@ -113,6 +103,9 @@ declare const DescribeComputeCommand_base: {
113
103
  * @throws {@link UnauthorizedException} (client fault)
114
104
  * <p>The client failed authentication. Clients should not retry such requests.</p>
115
105
  *
106
+ * @throws {@link UnsupportedRegionException} (client fault)
107
+ * <p>The requested operation is not supported in the Region specified.</p>
108
+ *
116
109
  * @throws {@link GameLiftServiceException}
117
110
  * <p>Base exception class for all service exceptions from GameLift service.</p>
118
111
  *
@@ -0,0 +1,157 @@
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 { DescribeContainerFleetInput, DescribeContainerFleetOutput } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DescribeContainerFleetCommand}.
14
+ */
15
+ export interface DescribeContainerFleetCommandInput extends DescribeContainerFleetInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DescribeContainerFleetCommand}.
21
+ */
22
+ export interface DescribeContainerFleetCommandOutput extends DescribeContainerFleetOutput, __MetadataBearer {
23
+ }
24
+ declare const DescribeContainerFleetCommand_base: {
25
+ new (input: DescribeContainerFleetCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeContainerFleetCommandInput, DescribeContainerFleetCommandOutput, GameLiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: DescribeContainerFleetCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeContainerFleetCommandInput, DescribeContainerFleetCommandOutput, GameLiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Retrieves the properties for a container fleet. When requesting attributes for
31
+ * multiple fleets, use the pagination parameters to retrieve results as a set of
32
+ * sequential pages. </p>
33
+ * <p>
34
+ * <b>Request options</b>
35
+ * </p>
36
+ * <ul>
37
+ * <li>
38
+ * <p>Get container fleet properties for a single fleet. Provide either the fleet ID or ARN value. </p>
39
+ * </li>
40
+ * </ul>
41
+ * <p>
42
+ * <b>Results</b>
43
+ * </p>
44
+ * <p>If successful, a <code>ContainerFleet</code> object is returned. This object includes
45
+ * the fleet properties, including information about the most recent deployment.</p>
46
+ * <note>
47
+ * <p>Some API operations limit the number of fleet IDs that allowed in one request. If
48
+ * a request exceeds this limit, the request fails and the error message contains the
49
+ * maximum allowed number.</p>
50
+ * </note>
51
+ * @example
52
+ * Use a bare-bones client and the command you need to make an API call.
53
+ * ```javascript
54
+ * import { GameLiftClient, DescribeContainerFleetCommand } from "@aws-sdk/client-gamelift"; // ES Modules import
55
+ * // const { GameLiftClient, DescribeContainerFleetCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import
56
+ * const client = new GameLiftClient(config);
57
+ * const input = { // DescribeContainerFleetInput
58
+ * FleetId: "STRING_VALUE", // required
59
+ * };
60
+ * const command = new DescribeContainerFleetCommand(input);
61
+ * const response = await client.send(command);
62
+ * // { // DescribeContainerFleetOutput
63
+ * // ContainerFleet: { // ContainerFleet
64
+ * // FleetId: "STRING_VALUE",
65
+ * // FleetArn: "STRING_VALUE",
66
+ * // FleetRoleArn: "STRING_VALUE",
67
+ * // GameServerContainerGroupDefinitionName: "STRING_VALUE",
68
+ * // GameServerContainerGroupDefinitionArn: "STRING_VALUE",
69
+ * // PerInstanceContainerGroupDefinitionName: "STRING_VALUE",
70
+ * // PerInstanceContainerGroupDefinitionArn: "STRING_VALUE",
71
+ * // InstanceConnectionPortRange: { // ConnectionPortRange
72
+ * // FromPort: Number("int"), // required
73
+ * // ToPort: Number("int"), // required
74
+ * // },
75
+ * // InstanceInboundPermissions: [ // IpPermissionsList
76
+ * // { // IpPermission
77
+ * // FromPort: Number("int"), // required
78
+ * // ToPort: Number("int"), // required
79
+ * // IpRange: "STRING_VALUE", // required
80
+ * // Protocol: "TCP" || "UDP", // required
81
+ * // },
82
+ * // ],
83
+ * // GameServerContainerGroupsPerInstance: Number("int"),
84
+ * // MaximumGameServerContainerGroupsPerInstance: Number("int"),
85
+ * // InstanceType: "STRING_VALUE",
86
+ * // BillingType: "ON_DEMAND" || "SPOT",
87
+ * // Description: "STRING_VALUE",
88
+ * // CreationTime: new Date("TIMESTAMP"),
89
+ * // MetricGroups: [ // MetricGroupList
90
+ * // "STRING_VALUE",
91
+ * // ],
92
+ * // NewGameSessionProtectionPolicy: "NoProtection" || "FullProtection",
93
+ * // GameSessionCreationLimitPolicy: { // GameSessionCreationLimitPolicy
94
+ * // NewGameSessionsPerCreator: Number("int"),
95
+ * // PolicyPeriodInMinutes: Number("int"),
96
+ * // },
97
+ * // Status: "PENDING" || "CREATING" || "CREATED" || "ACTIVATING" || "ACTIVE" || "UPDATING" || "DELETING",
98
+ * // DeploymentDetails: { // DeploymentDetails
99
+ * // LatestDeploymentId: "STRING_VALUE",
100
+ * // },
101
+ * // LogConfiguration: { // LogConfiguration
102
+ * // LogDestination: "NONE" || "CLOUDWATCH" || "S3",
103
+ * // S3BucketName: "STRING_VALUE",
104
+ * // LogGroupArn: "STRING_VALUE",
105
+ * // },
106
+ * // LocationAttributes: [ // ContainerFleetLocationAttributesList
107
+ * // { // ContainerFleetLocationAttributes
108
+ * // Location: "STRING_VALUE",
109
+ * // Status: "PENDING" || "CREATING" || "CREATED" || "ACTIVATING" || "ACTIVE" || "UPDATING" || "DELETING",
110
+ * // },
111
+ * // ],
112
+ * // },
113
+ * // };
114
+ *
115
+ * ```
116
+ *
117
+ * @param DescribeContainerFleetCommandInput - {@link DescribeContainerFleetCommandInput}
118
+ * @returns {@link DescribeContainerFleetCommandOutput}
119
+ * @see {@link DescribeContainerFleetCommandInput} for command's `input` shape.
120
+ * @see {@link DescribeContainerFleetCommandOutput} for command's `response` shape.
121
+ * @see {@link GameLiftClientResolvedConfig | config} for GameLiftClient's `config` shape.
122
+ *
123
+ * @throws {@link InternalServiceException} (server fault)
124
+ * <p>The service encountered an unrecoverable internal failure while processing the
125
+ * request. Clients can retry such requests immediately or after a waiting period.</p>
126
+ *
127
+ * @throws {@link InvalidRequestException} (client fault)
128
+ * <p>One or more parameter values in the request are invalid. Correct the invalid parameter
129
+ * values before retrying.</p>
130
+ *
131
+ * @throws {@link NotFoundException} (client fault)
132
+ * <p>The requested resources was not found. The resource was either not created yet or deleted.</p>
133
+ *
134
+ * @throws {@link UnauthorizedException} (client fault)
135
+ * <p>The client failed authentication. Clients should not retry such requests.</p>
136
+ *
137
+ * @throws {@link UnsupportedRegionException} (client fault)
138
+ * <p>The requested operation is not supported in the Region specified.</p>
139
+ *
140
+ * @throws {@link GameLiftServiceException}
141
+ * <p>Base exception class for all service exceptions from GameLift service.</p>
142
+ *
143
+ * @public
144
+ */
145
+ export declare class DescribeContainerFleetCommand extends DescribeContainerFleetCommand_base {
146
+ /** @internal type navigation helper, not in runtime. */
147
+ protected static __types: {
148
+ api: {
149
+ input: DescribeContainerFleetInput;
150
+ output: DescribeContainerFleetOutput;
151
+ };
152
+ sdk: {
153
+ input: DescribeContainerFleetCommandInput;
154
+ output: DescribeContainerFleetCommandOutput;
155
+ };
156
+ };
157
+ }
@@ -27,13 +27,26 @@ declare const DescribeContainerGroupDefinitionCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>
31
- * <b>This operation is used with the Amazon GameLift containers feature, which is currently in public preview. </b>
32
- * </p>
33
- * <p>Retrieves the properties of a container group definition, including all container
30
+ * <p>Retrieves the properties of a container group definition, including all container
34
31
  * definitions in the group. </p>
35
- * <p>To retrieve a container group definition, provide a resource identifier. If successful,
36
- * this operation returns the complete properties of the container group definition.</p>
32
+ * <p>
33
+ * <b>Request options:</b>
34
+ * </p>
35
+ * <ul>
36
+ * <li>
37
+ * <p>Retrieve the latest version of a container group definition. Specify the container
38
+ * group definition name only, or use an ARN value without a version number.</p>
39
+ * </li>
40
+ * <li>
41
+ * <p>Retrieve a particular version. Specify the container group definition name and a
42
+ * version number, or use an ARN value that includes the version number.</p>
43
+ * </li>
44
+ * </ul>
45
+ * <p>
46
+ * <b>Results:</b>
47
+ * </p>
48
+ * <p>If successful, this operation returns the complete properties of a container group
49
+ * definition version.</p>
37
50
  * <p>
38
51
  * <b>Learn more</b>
39
52
  * </p>
@@ -52,6 +65,7 @@ declare const DescribeContainerGroupDefinitionCommand_base: {
52
65
  * const client = new GameLiftClient(config);
53
66
  * const input = { // DescribeContainerGroupDefinitionInput
54
67
  * Name: "STRING_VALUE", // required
68
+ * VersionNumber: Number("int"),
55
69
  * };
56
70
  * const command = new DescribeContainerGroupDefinitionCommand(input);
57
71
  * const response = await client.send(command);
@@ -60,60 +74,93 @@ declare const DescribeContainerGroupDefinitionCommand_base: {
60
74
  * // ContainerGroupDefinitionArn: "STRING_VALUE",
61
75
  * // CreationTime: new Date("TIMESTAMP"),
62
76
  * // OperatingSystem: "AMAZON_LINUX_2023",
63
- * // Name: "STRING_VALUE",
64
- * // SchedulingStrategy: "REPLICA" || "DAEMON",
65
- * // TotalMemoryLimit: Number("int"),
66
- * // TotalCpuLimit: Number("int"),
67
- * // ContainerDefinitions: [ // ContainerDefinitionList
68
- * // { // ContainerDefinition
69
- * // ContainerName: "STRING_VALUE", // required
70
- * // ImageUri: "STRING_VALUE", // required
71
- * // ResolvedImageDigest: "STRING_VALUE",
72
- * // MemoryLimits: { // ContainerMemoryLimits
73
- * // SoftLimit: Number("int"),
74
- * // HardLimit: Number("int"),
77
+ * // Name: "STRING_VALUE", // required
78
+ * // ContainerGroupType: "GAME_SERVER" || "PER_INSTANCE",
79
+ * // TotalMemoryLimitMebibytes: Number("int"),
80
+ * // TotalVcpuLimit: Number("double"),
81
+ * // GameServerContainerDefinition: { // GameServerContainerDefinition
82
+ * // ContainerName: "STRING_VALUE",
83
+ * // DependsOn: [ // ContainerDependencyList
84
+ * // { // ContainerDependency
85
+ * // ContainerName: "STRING_VALUE", // required
86
+ * // Condition: "START" || "COMPLETE" || "SUCCESS" || "HEALTHY", // required
75
87
  * // },
76
- * // PortConfiguration: { // ContainerPortConfiguration
77
- * // ContainerPortRanges: [ // ContainerPortRangeList // required
78
- * // { // ContainerPortRange
79
- * // FromPort: Number("int"), // required
80
- * // ToPort: Number("int"), // required
81
- * // Protocol: "TCP" || "UDP", // required
82
- * // },
83
- * // ],
88
+ * // ],
89
+ * // MountPoints: [ // ContainerMountPointList
90
+ * // { // ContainerMountPoint
91
+ * // InstancePath: "STRING_VALUE", // required
92
+ * // ContainerPath: "STRING_VALUE",
93
+ * // AccessLevel: "READ_ONLY" || "READ_AND_WRITE",
84
94
  * // },
85
- * // Cpu: Number("int"),
95
+ * // ],
96
+ * // EnvironmentOverride: [ // ContainerEnvironmentList
97
+ * // { // ContainerEnvironment
98
+ * // Name: "STRING_VALUE", // required
99
+ * // Value: "STRING_VALUE", // required
100
+ * // },
101
+ * // ],
102
+ * // ImageUri: "STRING_VALUE",
103
+ * // PortConfiguration: { // ContainerPortConfiguration
104
+ * // ContainerPortRanges: [ // ContainerPortRangeList // required
105
+ * // { // ContainerPortRange
106
+ * // FromPort: Number("int"), // required
107
+ * // ToPort: Number("int"), // required
108
+ * // Protocol: "TCP" || "UDP", // required
109
+ * // },
110
+ * // ],
111
+ * // },
112
+ * // ResolvedImageDigest: "STRING_VALUE",
113
+ * // ServerSdkVersion: "STRING_VALUE",
114
+ * // },
115
+ * // SupportContainerDefinitions: [ // SupportContainerDefinitionList
116
+ * // { // SupportContainerDefinition
117
+ * // ContainerName: "STRING_VALUE",
118
+ * // DependsOn: [
119
+ * // {
120
+ * // ContainerName: "STRING_VALUE", // required
121
+ * // Condition: "START" || "COMPLETE" || "SUCCESS" || "HEALTHY", // required
122
+ * // },
123
+ * // ],
124
+ * // MountPoints: [
125
+ * // {
126
+ * // InstancePath: "STRING_VALUE", // required
127
+ * // ContainerPath: "STRING_VALUE",
128
+ * // AccessLevel: "READ_ONLY" || "READ_AND_WRITE",
129
+ * // },
130
+ * // ],
131
+ * // EnvironmentOverride: [
132
+ * // {
133
+ * // Name: "STRING_VALUE", // required
134
+ * // Value: "STRING_VALUE", // required
135
+ * // },
136
+ * // ],
137
+ * // Essential: true || false,
86
138
  * // HealthCheck: { // ContainerHealthCheck
87
139
  * // Command: [ // ContainerCommandStringList // required
88
140
  * // "STRING_VALUE",
89
141
  * // ],
90
142
  * // Interval: Number("int"),
91
- * // Timeout: Number("int"),
92
143
  * // Retries: Number("int"),
93
144
  * // StartPeriod: Number("int"),
145
+ * // Timeout: Number("int"),
94
146
  * // },
95
- * // Command: [
96
- * // "STRING_VALUE",
97
- * // ],
98
- * // Essential: true || false,
99
- * // EntryPoint: [ // ContainerEntryPointList
100
- * // "STRING_VALUE",
101
- * // ],
102
- * // WorkingDirectory: "STRING_VALUE",
103
- * // Environment: [ // ContainerEnvironmentList
104
- * // { // ContainerEnvironment
105
- * // Name: "STRING_VALUE", // required
106
- * // Value: "STRING_VALUE", // required
107
- * // },
108
- * // ],
109
- * // DependsOn: [ // ContainerDependencyList
110
- * // { // ContainerDependency
111
- * // ContainerName: "STRING_VALUE", // required
112
- * // Condition: "START" || "COMPLETE" || "SUCCESS" || "HEALTHY", // required
113
- * // },
114
- * // ],
147
+ * // ImageUri: "STRING_VALUE",
148
+ * // MemoryHardLimitMebibytes: Number("int"),
149
+ * // PortConfiguration: {
150
+ * // ContainerPortRanges: [ // required
151
+ * // {
152
+ * // FromPort: Number("int"), // required
153
+ * // ToPort: Number("int"), // required
154
+ * // Protocol: "TCP" || "UDP", // required
155
+ * // },
156
+ * // ],
157
+ * // },
158
+ * // ResolvedImageDigest: "STRING_VALUE",
159
+ * // Vcpu: Number("double"),
115
160
  * // },
116
161
  * // ],
162
+ * // VersionNumber: Number("int"),
163
+ * // VersionDescription: "STRING_VALUE",
117
164
  * // Status: "READY" || "COPYING" || "FAILED",
118
165
  * // StatusReason: "STRING_VALUE",
119
166
  * // },