@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.
- package/README.md +72 -0
- package/dist-cjs/index.js +830 -188
- package/dist-es/GameLift.js +18 -0
- package/dist-es/commands/CreateContainerFleetCommand.js +23 -0
- package/dist-es/commands/CreateFleetCommand.js +2 -2
- package/dist-es/commands/DeleteContainerFleetCommand.js +22 -0
- package/dist-es/commands/DescribeContainerFleetCommand.js +23 -0
- package/dist-es/commands/DescribeFleetAttributesCommand.js +1 -2
- package/dist-es/commands/DescribeFleetDeploymentCommand.js +22 -0
- package/dist-es/commands/ListContainerFleetsCommand.js +23 -0
- package/dist-es/commands/ListContainerGroupDefinitionVersionsCommand.js +23 -0
- package/dist-es/commands/ListContainerGroupDefinitionsCommand.js +1 -1
- package/dist-es/commands/ListFleetDeploymentsCommand.js +22 -0
- package/dist-es/commands/RegisterComputeCommand.js +1 -1
- package/dist-es/commands/RequestUploadCredentialsCommand.js +1 -1
- package/dist-es/commands/UpdateContainerFleetCommand.js +23 -0
- package/dist-es/commands/UpdateContainerGroupDefinitionCommand.js +23 -0
- package/dist-es/commands/index.js +9 -0
- package/dist-es/models/models_0.js +132 -81
- package/dist-es/models/models_1.js +50 -1
- package/dist-es/pagination/ListContainerFleetsPaginator.js +4 -0
- package/dist-es/pagination/ListContainerGroupDefinitionVersionsPaginator.js +4 -0
- package/dist-es/pagination/ListFleetDeploymentsPaginator.js +4 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/protocols/Aws_json1_1.js +352 -7
- package/dist-types/GameLift.d.ts +65 -0
- package/dist-types/GameLiftClient.d.ts +11 -2
- package/dist-types/commands/CreateBuildCommand.d.ts +27 -21
- package/dist-types/commands/CreateContainerFleetCommand.d.ts +283 -0
- package/dist-types/commands/CreateContainerGroupDefinitionCommand.d.ts +278 -119
- package/dist-types/commands/CreateFleetCommand.d.ts +5 -88
- package/dist-types/commands/CreateFleetLocationsCommand.d.ts +3 -6
- package/dist-types/commands/CreateScriptCommand.d.ts +9 -12
- package/dist-types/commands/DeleteContainerFleetCommand.d.ts +102 -0
- package/dist-types/commands/DeleteContainerGroupDefinitionCommand.d.ts +24 -7
- package/dist-types/commands/DeleteScalingPolicyCommand.d.ts +3 -0
- package/dist-types/commands/DeregisterComputeCommand.d.ts +2 -5
- package/dist-types/commands/DescribeComputeCommand.d.ts +14 -21
- package/dist-types/commands/DescribeContainerFleetCommand.d.ts +157 -0
- package/dist-types/commands/DescribeContainerGroupDefinitionCommand.d.ts +95 -48
- package/dist-types/commands/DescribeFleetAttributesCommand.d.ts +2 -21
- package/dist-types/commands/DescribeFleetCapacityCommand.d.ts +8 -8
- package/dist-types/commands/DescribeFleetDeploymentCommand.d.ts +125 -0
- package/dist-types/commands/DescribeFleetEventsCommand.d.ts +4 -1
- package/dist-types/commands/DescribeFleetLocationCapacityCommand.d.ts +4 -4
- package/dist-types/commands/DescribeFleetPortSettingsCommand.d.ts +3 -3
- package/dist-types/commands/DescribeRuntimeConfigurationCommand.d.ts +2 -4
- package/dist-types/commands/GetComputeAccessCommand.d.ts +20 -30
- package/dist-types/commands/GetComputeAuthTokenCommand.d.ts +18 -13
- package/dist-types/commands/ListComputeCommand.d.ts +36 -28
- package/dist-types/commands/ListContainerFleetsCommand.d.ts +165 -0
- package/dist-types/commands/ListContainerGroupDefinitionVersionsCommand.d.ts +216 -0
- package/dist-types/commands/ListContainerGroupDefinitionsCommand.d.ts +97 -49
- package/dist-types/commands/ListFleetDeploymentsCommand.d.ts +132 -0
- package/dist-types/commands/ListFleetsCommand.d.ts +2 -10
- package/dist-types/commands/ListGameServerGroupsCommand.d.ts +1 -1
- package/dist-types/commands/ListGameServersCommand.d.ts +1 -1
- package/dist-types/commands/ListLocationsCommand.d.ts +1 -1
- package/dist-types/commands/ListScriptsCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +4 -1
- package/dist-types/commands/PutScalingPolicyCommand.d.ts +4 -1
- package/dist-types/commands/RegisterComputeCommand.d.ts +13 -19
- package/dist-types/commands/RegisterGameServerCommand.d.ts +1 -1
- package/dist-types/commands/RequestUploadCredentialsCommand.d.ts +1 -1
- package/dist-types/commands/ResolveAliasCommand.d.ts +1 -1
- package/dist-types/commands/ResumeGameServerGroupCommand.d.ts +1 -2
- package/dist-types/commands/StartGameSessionPlacementCommand.d.ts +2 -2
- package/dist-types/commands/StopFleetActionsCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +3 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +3 -0
- package/dist-types/commands/UpdateContainerFleetCommand.d.ts +253 -0
- package/dist-types/commands/UpdateContainerGroupDefinitionCommand.d.ts +310 -0
- package/dist-types/commands/UpdateFleetCapacityCommand.d.ts +6 -9
- package/dist-types/commands/UpdateRuntimeConfigurationCommand.d.ts +1 -3
- package/dist-types/commands/index.d.ts +9 -0
- package/dist-types/models/models_0.d.ts +5518 -5258
- package/dist-types/models/models_1.d.ts +897 -18
- package/dist-types/pagination/ListContainerFleetsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListContainerGroupDefinitionVersionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListFleetDeploymentsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +81 -0
- package/dist-types/ts3.4/GameLift.d.ts +161 -0
- package/dist-types/ts3.4/GameLiftClient.d.ts +54 -0
- package/dist-types/ts3.4/commands/CreateContainerFleetCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteContainerFleetCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteContainerGroupDefinitionCommand.d.ts +6 -2
- package/dist-types/ts3.4/commands/DescribeContainerFleetCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeFleetDeploymentCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListContainerFleetsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListContainerGroupDefinitionVersionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListContainerGroupDefinitionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListFleetDeploymentsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListFleetsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListGameServerGroupsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListGameServersCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListLocationsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListScriptsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutScalingPolicyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RegisterComputeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RegisterGameServerCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RequestUploadCredentialsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ResolveAliasCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ResumeGameServerGroupCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/UpdateContainerFleetCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateContainerGroupDefinitionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +9 -0
- package/dist-types/ts3.4/models/models_0.d.ts +333 -261
- package/dist-types/ts3.4/models/models_1.d.ts +222 -0
- package/dist-types/ts3.4/pagination/ListContainerFleetsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListContainerGroupDefinitionVersionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListFleetDeploymentsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +108 -0
- package/package.json +6 -6
|
@@ -0,0 +1,165 @@
|
|
|
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 { ListContainerFleetsInput, ListContainerFleetsOutput } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListContainerFleetsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListContainerFleetsCommandInput extends ListContainerFleetsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListContainerFleetsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListContainerFleetsCommandOutput extends ListContainerFleetsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListContainerFleetsCommand_base: {
|
|
25
|
+
new (input: ListContainerFleetsCommandInput): import("@smithy/smithy-client").CommandImpl<ListContainerFleetsCommandInput, ListContainerFleetsCommandOutput, GameLiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [ListContainerFleetsCommandInput]): import("@smithy/smithy-client").CommandImpl<ListContainerFleetsCommandInput, ListContainerFleetsCommandOutput, GameLiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves a collection of container fleet resources in an Amazon Web Services Region. For fleets
|
|
31
|
+
* that have multiple locations, this operation retrieves fleets based on their home Region
|
|
32
|
+
* only.</p>
|
|
33
|
+
* <p>
|
|
34
|
+
* <b>Request options</b>
|
|
35
|
+
* </p>
|
|
36
|
+
* <ul>
|
|
37
|
+
* <li>
|
|
38
|
+
* <p>Get a list of all fleets. Call this operation without specifying a container
|
|
39
|
+
* group definition. </p>
|
|
40
|
+
* </li>
|
|
41
|
+
* <li>
|
|
42
|
+
* <p>Get a list of fleets filtered by container group definition. Provide the
|
|
43
|
+
* container group definition name or ARN value.</p>
|
|
44
|
+
* </li>
|
|
45
|
+
* <li>
|
|
46
|
+
* <p>To get a list of all Realtime Servers fleets with a specific configuration script,
|
|
47
|
+
* provide the script ID. </p>
|
|
48
|
+
* </li>
|
|
49
|
+
* </ul>
|
|
50
|
+
* <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p>
|
|
51
|
+
* <p>If successful, this operation returns a collection of container fleets that match the request
|
|
52
|
+
* parameters. A NextToken value is also returned if there are more result pages to
|
|
53
|
+
* retrieve.</p>
|
|
54
|
+
* <note>
|
|
55
|
+
* <p>Fleet IDs are returned in no particular order.</p>
|
|
56
|
+
* </note>
|
|
57
|
+
* @example
|
|
58
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
59
|
+
* ```javascript
|
|
60
|
+
* import { GameLiftClient, ListContainerFleetsCommand } from "@aws-sdk/client-gamelift"; // ES Modules import
|
|
61
|
+
* // const { GameLiftClient, ListContainerFleetsCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import
|
|
62
|
+
* const client = new GameLiftClient(config);
|
|
63
|
+
* const input = { // ListContainerFleetsInput
|
|
64
|
+
* ContainerGroupDefinitionName: "STRING_VALUE",
|
|
65
|
+
* Limit: Number("int"),
|
|
66
|
+
* NextToken: "STRING_VALUE",
|
|
67
|
+
* };
|
|
68
|
+
* const command = new ListContainerFleetsCommand(input);
|
|
69
|
+
* const response = await client.send(command);
|
|
70
|
+
* // { // ListContainerFleetsOutput
|
|
71
|
+
* // ContainerFleets: [ // ContainerFleetList
|
|
72
|
+
* // { // ContainerFleet
|
|
73
|
+
* // FleetId: "STRING_VALUE",
|
|
74
|
+
* // FleetArn: "STRING_VALUE",
|
|
75
|
+
* // FleetRoleArn: "STRING_VALUE",
|
|
76
|
+
* // GameServerContainerGroupDefinitionName: "STRING_VALUE",
|
|
77
|
+
* // GameServerContainerGroupDefinitionArn: "STRING_VALUE",
|
|
78
|
+
* // PerInstanceContainerGroupDefinitionName: "STRING_VALUE",
|
|
79
|
+
* // PerInstanceContainerGroupDefinitionArn: "STRING_VALUE",
|
|
80
|
+
* // InstanceConnectionPortRange: { // ConnectionPortRange
|
|
81
|
+
* // FromPort: Number("int"), // required
|
|
82
|
+
* // ToPort: Number("int"), // required
|
|
83
|
+
* // },
|
|
84
|
+
* // InstanceInboundPermissions: [ // IpPermissionsList
|
|
85
|
+
* // { // IpPermission
|
|
86
|
+
* // FromPort: Number("int"), // required
|
|
87
|
+
* // ToPort: Number("int"), // required
|
|
88
|
+
* // IpRange: "STRING_VALUE", // required
|
|
89
|
+
* // Protocol: "TCP" || "UDP", // required
|
|
90
|
+
* // },
|
|
91
|
+
* // ],
|
|
92
|
+
* // GameServerContainerGroupsPerInstance: Number("int"),
|
|
93
|
+
* // MaximumGameServerContainerGroupsPerInstance: Number("int"),
|
|
94
|
+
* // InstanceType: "STRING_VALUE",
|
|
95
|
+
* // BillingType: "ON_DEMAND" || "SPOT",
|
|
96
|
+
* // Description: "STRING_VALUE",
|
|
97
|
+
* // CreationTime: new Date("TIMESTAMP"),
|
|
98
|
+
* // MetricGroups: [ // MetricGroupList
|
|
99
|
+
* // "STRING_VALUE",
|
|
100
|
+
* // ],
|
|
101
|
+
* // NewGameSessionProtectionPolicy: "NoProtection" || "FullProtection",
|
|
102
|
+
* // GameSessionCreationLimitPolicy: { // GameSessionCreationLimitPolicy
|
|
103
|
+
* // NewGameSessionsPerCreator: Number("int"),
|
|
104
|
+
* // PolicyPeriodInMinutes: Number("int"),
|
|
105
|
+
* // },
|
|
106
|
+
* // Status: "PENDING" || "CREATING" || "CREATED" || "ACTIVATING" || "ACTIVE" || "UPDATING" || "DELETING",
|
|
107
|
+
* // DeploymentDetails: { // DeploymentDetails
|
|
108
|
+
* // LatestDeploymentId: "STRING_VALUE",
|
|
109
|
+
* // },
|
|
110
|
+
* // LogConfiguration: { // LogConfiguration
|
|
111
|
+
* // LogDestination: "NONE" || "CLOUDWATCH" || "S3",
|
|
112
|
+
* // S3BucketName: "STRING_VALUE",
|
|
113
|
+
* // LogGroupArn: "STRING_VALUE",
|
|
114
|
+
* // },
|
|
115
|
+
* // LocationAttributes: [ // ContainerFleetLocationAttributesList
|
|
116
|
+
* // { // ContainerFleetLocationAttributes
|
|
117
|
+
* // Location: "STRING_VALUE",
|
|
118
|
+
* // Status: "PENDING" || "CREATING" || "CREATED" || "ACTIVATING" || "ACTIVE" || "UPDATING" || "DELETING",
|
|
119
|
+
* // },
|
|
120
|
+
* // ],
|
|
121
|
+
* // },
|
|
122
|
+
* // ],
|
|
123
|
+
* // NextToken: "STRING_VALUE",
|
|
124
|
+
* // };
|
|
125
|
+
*
|
|
126
|
+
* ```
|
|
127
|
+
*
|
|
128
|
+
* @param ListContainerFleetsCommandInput - {@link ListContainerFleetsCommandInput}
|
|
129
|
+
* @returns {@link ListContainerFleetsCommandOutput}
|
|
130
|
+
* @see {@link ListContainerFleetsCommandInput} for command's `input` shape.
|
|
131
|
+
* @see {@link ListContainerFleetsCommandOutput} for command's `response` shape.
|
|
132
|
+
* @see {@link GameLiftClientResolvedConfig | config} for GameLiftClient's `config` shape.
|
|
133
|
+
*
|
|
134
|
+
* @throws {@link InternalServiceException} (server fault)
|
|
135
|
+
* <p>The service encountered an unrecoverable internal failure while processing the
|
|
136
|
+
* request. Clients can retry such requests immediately or after a waiting period.</p>
|
|
137
|
+
*
|
|
138
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
139
|
+
* <p>One or more parameter values in the request are invalid. Correct the invalid parameter
|
|
140
|
+
* values before retrying.</p>
|
|
141
|
+
*
|
|
142
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
143
|
+
* <p>The client failed authentication. Clients should not retry such requests.</p>
|
|
144
|
+
*
|
|
145
|
+
* @throws {@link UnsupportedRegionException} (client fault)
|
|
146
|
+
* <p>The requested operation is not supported in the Region specified.</p>
|
|
147
|
+
*
|
|
148
|
+
* @throws {@link GameLiftServiceException}
|
|
149
|
+
* <p>Base exception class for all service exceptions from GameLift service.</p>
|
|
150
|
+
*
|
|
151
|
+
* @public
|
|
152
|
+
*/
|
|
153
|
+
export declare class ListContainerFleetsCommand extends ListContainerFleetsCommand_base {
|
|
154
|
+
/** @internal type navigation helper, not in runtime. */
|
|
155
|
+
protected static __types: {
|
|
156
|
+
api: {
|
|
157
|
+
input: ListContainerFleetsInput;
|
|
158
|
+
output: ListContainerFleetsOutput;
|
|
159
|
+
};
|
|
160
|
+
sdk: {
|
|
161
|
+
input: ListContainerFleetsCommandInput;
|
|
162
|
+
output: ListContainerFleetsCommandOutput;
|
|
163
|
+
};
|
|
164
|
+
};
|
|
165
|
+
}
|
|
@@ -0,0 +1,216 @@
|
|
|
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 { ListContainerGroupDefinitionVersionsInput, ListContainerGroupDefinitionVersionsOutput } from "../models/models_1";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListContainerGroupDefinitionVersionsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListContainerGroupDefinitionVersionsCommandInput extends ListContainerGroupDefinitionVersionsInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListContainerGroupDefinitionVersionsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListContainerGroupDefinitionVersionsCommandOutput extends ListContainerGroupDefinitionVersionsOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListContainerGroupDefinitionVersionsCommand_base: {
|
|
25
|
+
new (input: ListContainerGroupDefinitionVersionsCommandInput): import("@smithy/smithy-client").CommandImpl<ListContainerGroupDefinitionVersionsCommandInput, ListContainerGroupDefinitionVersionsCommandOutput, GameLiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: ListContainerGroupDefinitionVersionsCommandInput): import("@smithy/smithy-client").CommandImpl<ListContainerGroupDefinitionVersionsCommandInput, ListContainerGroupDefinitionVersionsCommandOutput, GameLiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves all versions of a container group definition. Use the pagination parameters to
|
|
31
|
+
* retrieve results in a set of sequential pages.</p>
|
|
32
|
+
* <p>
|
|
33
|
+
* <b>Request options:</b>
|
|
34
|
+
* </p>
|
|
35
|
+
* <ul>
|
|
36
|
+
* <li>
|
|
37
|
+
* <p>Get all versions of a specified container group definition. Specify the container
|
|
38
|
+
* group definition name or ARN value. (If the ARN value has a version number, it's
|
|
39
|
+
* ignored.)</p>
|
|
40
|
+
* </li>
|
|
41
|
+
* </ul>
|
|
42
|
+
* <p>
|
|
43
|
+
* <b>Results:</b>
|
|
44
|
+
* </p>
|
|
45
|
+
* <p>If successful, this operation returns the complete properties of a set of container group
|
|
46
|
+
* definition versions that match the request.</p>
|
|
47
|
+
* <note>
|
|
48
|
+
* <p>This operation returns the list of container group definitions in descending version
|
|
49
|
+
* order (latest first). </p>
|
|
50
|
+
* </note>
|
|
51
|
+
* <p>
|
|
52
|
+
* <b>Learn more</b>
|
|
53
|
+
* </p>
|
|
54
|
+
* <ul>
|
|
55
|
+
* <li>
|
|
56
|
+
* <p>
|
|
57
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-create-groups.html">Manage a container group definition</a>
|
|
58
|
+
* </p>
|
|
59
|
+
* </li>
|
|
60
|
+
* </ul>
|
|
61
|
+
* @example
|
|
62
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
63
|
+
* ```javascript
|
|
64
|
+
* import { GameLiftClient, ListContainerGroupDefinitionVersionsCommand } from "@aws-sdk/client-gamelift"; // ES Modules import
|
|
65
|
+
* // const { GameLiftClient, ListContainerGroupDefinitionVersionsCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import
|
|
66
|
+
* const client = new GameLiftClient(config);
|
|
67
|
+
* const input = { // ListContainerGroupDefinitionVersionsInput
|
|
68
|
+
* Name: "STRING_VALUE", // required
|
|
69
|
+
* Limit: Number("int"),
|
|
70
|
+
* NextToken: "STRING_VALUE",
|
|
71
|
+
* };
|
|
72
|
+
* const command = new ListContainerGroupDefinitionVersionsCommand(input);
|
|
73
|
+
* const response = await client.send(command);
|
|
74
|
+
* // { // ListContainerGroupDefinitionVersionsOutput
|
|
75
|
+
* // ContainerGroupDefinitions: [ // ContainerGroupDefinitionList
|
|
76
|
+
* // { // ContainerGroupDefinition
|
|
77
|
+
* // ContainerGroupDefinitionArn: "STRING_VALUE",
|
|
78
|
+
* // CreationTime: new Date("TIMESTAMP"),
|
|
79
|
+
* // OperatingSystem: "AMAZON_LINUX_2023",
|
|
80
|
+
* // Name: "STRING_VALUE", // required
|
|
81
|
+
* // ContainerGroupType: "GAME_SERVER" || "PER_INSTANCE",
|
|
82
|
+
* // TotalMemoryLimitMebibytes: Number("int"),
|
|
83
|
+
* // TotalVcpuLimit: Number("double"),
|
|
84
|
+
* // GameServerContainerDefinition: { // GameServerContainerDefinition
|
|
85
|
+
* // ContainerName: "STRING_VALUE",
|
|
86
|
+
* // DependsOn: [ // ContainerDependencyList
|
|
87
|
+
* // { // ContainerDependency
|
|
88
|
+
* // ContainerName: "STRING_VALUE", // required
|
|
89
|
+
* // Condition: "START" || "COMPLETE" || "SUCCESS" || "HEALTHY", // required
|
|
90
|
+
* // },
|
|
91
|
+
* // ],
|
|
92
|
+
* // MountPoints: [ // ContainerMountPointList
|
|
93
|
+
* // { // ContainerMountPoint
|
|
94
|
+
* // InstancePath: "STRING_VALUE", // required
|
|
95
|
+
* // ContainerPath: "STRING_VALUE",
|
|
96
|
+
* // AccessLevel: "READ_ONLY" || "READ_AND_WRITE",
|
|
97
|
+
* // },
|
|
98
|
+
* // ],
|
|
99
|
+
* // EnvironmentOverride: [ // ContainerEnvironmentList
|
|
100
|
+
* // { // ContainerEnvironment
|
|
101
|
+
* // Name: "STRING_VALUE", // required
|
|
102
|
+
* // Value: "STRING_VALUE", // required
|
|
103
|
+
* // },
|
|
104
|
+
* // ],
|
|
105
|
+
* // ImageUri: "STRING_VALUE",
|
|
106
|
+
* // PortConfiguration: { // ContainerPortConfiguration
|
|
107
|
+
* // ContainerPortRanges: [ // ContainerPortRangeList // required
|
|
108
|
+
* // { // ContainerPortRange
|
|
109
|
+
* // FromPort: Number("int"), // required
|
|
110
|
+
* // ToPort: Number("int"), // required
|
|
111
|
+
* // Protocol: "TCP" || "UDP", // required
|
|
112
|
+
* // },
|
|
113
|
+
* // ],
|
|
114
|
+
* // },
|
|
115
|
+
* // ResolvedImageDigest: "STRING_VALUE",
|
|
116
|
+
* // ServerSdkVersion: "STRING_VALUE",
|
|
117
|
+
* // },
|
|
118
|
+
* // SupportContainerDefinitions: [ // SupportContainerDefinitionList
|
|
119
|
+
* // { // SupportContainerDefinition
|
|
120
|
+
* // ContainerName: "STRING_VALUE",
|
|
121
|
+
* // DependsOn: [
|
|
122
|
+
* // {
|
|
123
|
+
* // ContainerName: "STRING_VALUE", // required
|
|
124
|
+
* // Condition: "START" || "COMPLETE" || "SUCCESS" || "HEALTHY", // required
|
|
125
|
+
* // },
|
|
126
|
+
* // ],
|
|
127
|
+
* // MountPoints: [
|
|
128
|
+
* // {
|
|
129
|
+
* // InstancePath: "STRING_VALUE", // required
|
|
130
|
+
* // ContainerPath: "STRING_VALUE",
|
|
131
|
+
* // AccessLevel: "READ_ONLY" || "READ_AND_WRITE",
|
|
132
|
+
* // },
|
|
133
|
+
* // ],
|
|
134
|
+
* // EnvironmentOverride: [
|
|
135
|
+
* // {
|
|
136
|
+
* // Name: "STRING_VALUE", // required
|
|
137
|
+
* // Value: "STRING_VALUE", // required
|
|
138
|
+
* // },
|
|
139
|
+
* // ],
|
|
140
|
+
* // Essential: true || false,
|
|
141
|
+
* // HealthCheck: { // ContainerHealthCheck
|
|
142
|
+
* // Command: [ // ContainerCommandStringList // required
|
|
143
|
+
* // "STRING_VALUE",
|
|
144
|
+
* // ],
|
|
145
|
+
* // Interval: Number("int"),
|
|
146
|
+
* // Retries: Number("int"),
|
|
147
|
+
* // StartPeriod: Number("int"),
|
|
148
|
+
* // Timeout: Number("int"),
|
|
149
|
+
* // },
|
|
150
|
+
* // ImageUri: "STRING_VALUE",
|
|
151
|
+
* // MemoryHardLimitMebibytes: Number("int"),
|
|
152
|
+
* // PortConfiguration: {
|
|
153
|
+
* // ContainerPortRanges: [ // required
|
|
154
|
+
* // {
|
|
155
|
+
* // FromPort: Number("int"), // required
|
|
156
|
+
* // ToPort: Number("int"), // required
|
|
157
|
+
* // Protocol: "TCP" || "UDP", // required
|
|
158
|
+
* // },
|
|
159
|
+
* // ],
|
|
160
|
+
* // },
|
|
161
|
+
* // ResolvedImageDigest: "STRING_VALUE",
|
|
162
|
+
* // Vcpu: Number("double"),
|
|
163
|
+
* // },
|
|
164
|
+
* // ],
|
|
165
|
+
* // VersionNumber: Number("int"),
|
|
166
|
+
* // VersionDescription: "STRING_VALUE",
|
|
167
|
+
* // Status: "READY" || "COPYING" || "FAILED",
|
|
168
|
+
* // StatusReason: "STRING_VALUE",
|
|
169
|
+
* // },
|
|
170
|
+
* // ],
|
|
171
|
+
* // NextToken: "STRING_VALUE",
|
|
172
|
+
* // };
|
|
173
|
+
*
|
|
174
|
+
* ```
|
|
175
|
+
*
|
|
176
|
+
* @param ListContainerGroupDefinitionVersionsCommandInput - {@link ListContainerGroupDefinitionVersionsCommandInput}
|
|
177
|
+
* @returns {@link ListContainerGroupDefinitionVersionsCommandOutput}
|
|
178
|
+
* @see {@link ListContainerGroupDefinitionVersionsCommandInput} for command's `input` shape.
|
|
179
|
+
* @see {@link ListContainerGroupDefinitionVersionsCommandOutput} for command's `response` shape.
|
|
180
|
+
* @see {@link GameLiftClientResolvedConfig | config} for GameLiftClient's `config` shape.
|
|
181
|
+
*
|
|
182
|
+
* @throws {@link InternalServiceException} (server fault)
|
|
183
|
+
* <p>The service encountered an unrecoverable internal failure while processing the
|
|
184
|
+
* request. Clients can retry such requests immediately or after a waiting period.</p>
|
|
185
|
+
*
|
|
186
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
187
|
+
* <p>One or more parameter values in the request are invalid. Correct the invalid parameter
|
|
188
|
+
* values before retrying.</p>
|
|
189
|
+
*
|
|
190
|
+
* @throws {@link NotFoundException} (client fault)
|
|
191
|
+
* <p>The requested resources was not found. The resource was either not created yet or deleted.</p>
|
|
192
|
+
*
|
|
193
|
+
* @throws {@link UnauthorizedException} (client fault)
|
|
194
|
+
* <p>The client failed authentication. Clients should not retry such requests.</p>
|
|
195
|
+
*
|
|
196
|
+
* @throws {@link UnsupportedRegionException} (client fault)
|
|
197
|
+
* <p>The requested operation is not supported in the Region specified.</p>
|
|
198
|
+
*
|
|
199
|
+
* @throws {@link GameLiftServiceException}
|
|
200
|
+
* <p>Base exception class for all service exceptions from GameLift service.</p>
|
|
201
|
+
*
|
|
202
|
+
* @public
|
|
203
|
+
*/
|
|
204
|
+
export declare class ListContainerGroupDefinitionVersionsCommand extends ListContainerGroupDefinitionVersionsCommand_base {
|
|
205
|
+
/** @internal type navigation helper, not in runtime. */
|
|
206
|
+
protected static __types: {
|
|
207
|
+
api: {
|
|
208
|
+
input: ListContainerGroupDefinitionVersionsInput;
|
|
209
|
+
output: ListContainerGroupDefinitionVersionsOutput;
|
|
210
|
+
};
|
|
211
|
+
sdk: {
|
|
212
|
+
input: ListContainerGroupDefinitionVersionsCommandInput;
|
|
213
|
+
output: ListContainerGroupDefinitionVersionsCommandOutput;
|
|
214
|
+
};
|
|
215
|
+
};
|
|
216
|
+
}
|
|
@@ -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 { ListContainerGroupDefinitionsInput, ListContainerGroupDefinitionsOutput } from "../models/
|
|
4
|
+
import { ListContainerGroupDefinitionsInput, ListContainerGroupDefinitionsOutput } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -27,12 +27,27 @@ declare const ListContainerGroupDefinitionsCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>
|
|
31
|
-
*
|
|
30
|
+
* <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
|
|
31
|
+
* pages.</p>
|
|
32
|
+
* <p>This operation returns only the latest version of each definition. To retrieve all
|
|
33
|
+
* versions of a container group definition, use <a>ListContainerGroupDefinitionVersions</a>.</p>
|
|
34
|
+
* <p>
|
|
35
|
+
* <b>Request options:</b>
|
|
32
36
|
* </p>
|
|
33
|
-
* <
|
|
34
|
-
*
|
|
35
|
-
*
|
|
37
|
+
* <ul>
|
|
38
|
+
* <li>
|
|
39
|
+
* <p>Retrieve the most recent versions of all container group definitions. </p>
|
|
40
|
+
* </li>
|
|
41
|
+
* <li>
|
|
42
|
+
* <p>Retrieve the most recent versions of all container group definitions, filtered by
|
|
43
|
+
* type. Specify the container group type to filter on. </p>
|
|
44
|
+
* </li>
|
|
45
|
+
* </ul>
|
|
46
|
+
* <p>
|
|
47
|
+
* <b>Results:</b>
|
|
48
|
+
* </p>
|
|
49
|
+
* <p>If successful, this operation returns the complete properties of a set of container group
|
|
50
|
+
* definition versions that match the request.</p>
|
|
36
51
|
* <note>
|
|
37
52
|
* <p>This operation returns the list of container group definitions in no particular order. </p>
|
|
38
53
|
* </note>
|
|
@@ -53,7 +68,7 @@ declare const ListContainerGroupDefinitionsCommand_base: {
|
|
|
53
68
|
* // const { GameLiftClient, ListContainerGroupDefinitionsCommand } = require("@aws-sdk/client-gamelift"); // CommonJS import
|
|
54
69
|
* const client = new GameLiftClient(config);
|
|
55
70
|
* const input = { // ListContainerGroupDefinitionsInput
|
|
56
|
-
*
|
|
71
|
+
* ContainerGroupType: "GAME_SERVER" || "PER_INSTANCE",
|
|
57
72
|
* Limit: Number("int"),
|
|
58
73
|
* NextToken: "STRING_VALUE",
|
|
59
74
|
* };
|
|
@@ -65,60 +80,93 @@ declare const ListContainerGroupDefinitionsCommand_base: {
|
|
|
65
80
|
* // ContainerGroupDefinitionArn: "STRING_VALUE",
|
|
66
81
|
* // CreationTime: new Date("TIMESTAMP"),
|
|
67
82
|
* // OperatingSystem: "AMAZON_LINUX_2023",
|
|
68
|
-
* // Name: "STRING_VALUE",
|
|
69
|
-
* //
|
|
70
|
-
* //
|
|
71
|
-
* //
|
|
72
|
-
* //
|
|
73
|
-
* //
|
|
74
|
-
* //
|
|
75
|
-
* //
|
|
76
|
-
* //
|
|
77
|
-
* //
|
|
78
|
-
* // SoftLimit: Number("int"),
|
|
79
|
-
* // HardLimit: Number("int"),
|
|
83
|
+
* // Name: "STRING_VALUE", // required
|
|
84
|
+
* // ContainerGroupType: "GAME_SERVER" || "PER_INSTANCE",
|
|
85
|
+
* // TotalMemoryLimitMebibytes: Number("int"),
|
|
86
|
+
* // TotalVcpuLimit: Number("double"),
|
|
87
|
+
* // GameServerContainerDefinition: { // GameServerContainerDefinition
|
|
88
|
+
* // ContainerName: "STRING_VALUE",
|
|
89
|
+
* // DependsOn: [ // ContainerDependencyList
|
|
90
|
+
* // { // ContainerDependency
|
|
91
|
+
* // ContainerName: "STRING_VALUE", // required
|
|
92
|
+
* // Condition: "START" || "COMPLETE" || "SUCCESS" || "HEALTHY", // required
|
|
80
93
|
* // },
|
|
81
|
-
* //
|
|
82
|
-
* //
|
|
83
|
-
* //
|
|
84
|
-
* //
|
|
85
|
-
* //
|
|
86
|
-
* //
|
|
87
|
-
* //
|
|
88
|
-
* //
|
|
94
|
+
* // ],
|
|
95
|
+
* // MountPoints: [ // ContainerMountPointList
|
|
96
|
+
* // { // ContainerMountPoint
|
|
97
|
+
* // InstancePath: "STRING_VALUE", // required
|
|
98
|
+
* // ContainerPath: "STRING_VALUE",
|
|
99
|
+
* // AccessLevel: "READ_ONLY" || "READ_AND_WRITE",
|
|
100
|
+
* // },
|
|
101
|
+
* // ],
|
|
102
|
+
* // EnvironmentOverride: [ // ContainerEnvironmentList
|
|
103
|
+
* // { // ContainerEnvironment
|
|
104
|
+
* // Name: "STRING_VALUE", // required
|
|
105
|
+
* // Value: "STRING_VALUE", // required
|
|
89
106
|
* // },
|
|
90
|
-
* //
|
|
107
|
+
* // ],
|
|
108
|
+
* // ImageUri: "STRING_VALUE",
|
|
109
|
+
* // PortConfiguration: { // ContainerPortConfiguration
|
|
110
|
+
* // ContainerPortRanges: [ // ContainerPortRangeList // required
|
|
111
|
+
* // { // ContainerPortRange
|
|
112
|
+
* // FromPort: Number("int"), // required
|
|
113
|
+
* // ToPort: Number("int"), // required
|
|
114
|
+
* // Protocol: "TCP" || "UDP", // required
|
|
115
|
+
* // },
|
|
116
|
+
* // ],
|
|
117
|
+
* // },
|
|
118
|
+
* // ResolvedImageDigest: "STRING_VALUE",
|
|
119
|
+
* // ServerSdkVersion: "STRING_VALUE",
|
|
120
|
+
* // },
|
|
121
|
+
* // SupportContainerDefinitions: [ // SupportContainerDefinitionList
|
|
122
|
+
* // { // SupportContainerDefinition
|
|
123
|
+
* // ContainerName: "STRING_VALUE",
|
|
124
|
+
* // DependsOn: [
|
|
125
|
+
* // {
|
|
126
|
+
* // ContainerName: "STRING_VALUE", // required
|
|
127
|
+
* // Condition: "START" || "COMPLETE" || "SUCCESS" || "HEALTHY", // required
|
|
128
|
+
* // },
|
|
129
|
+
* // ],
|
|
130
|
+
* // MountPoints: [
|
|
131
|
+
* // {
|
|
132
|
+
* // InstancePath: "STRING_VALUE", // required
|
|
133
|
+
* // ContainerPath: "STRING_VALUE",
|
|
134
|
+
* // AccessLevel: "READ_ONLY" || "READ_AND_WRITE",
|
|
135
|
+
* // },
|
|
136
|
+
* // ],
|
|
137
|
+
* // EnvironmentOverride: [
|
|
138
|
+
* // {
|
|
139
|
+
* // Name: "STRING_VALUE", // required
|
|
140
|
+
* // Value: "STRING_VALUE", // required
|
|
141
|
+
* // },
|
|
142
|
+
* // ],
|
|
143
|
+
* // Essential: true || false,
|
|
91
144
|
* // HealthCheck: { // ContainerHealthCheck
|
|
92
145
|
* // Command: [ // ContainerCommandStringList // required
|
|
93
146
|
* // "STRING_VALUE",
|
|
94
147
|
* // ],
|
|
95
148
|
* // Interval: Number("int"),
|
|
96
|
-
* // Timeout: Number("int"),
|
|
97
149
|
* // Retries: Number("int"),
|
|
98
150
|
* // StartPeriod: Number("int"),
|
|
151
|
+
* // Timeout: Number("int"),
|
|
99
152
|
* // },
|
|
100
|
-
* //
|
|
101
|
-
* //
|
|
102
|
-
* //
|
|
103
|
-
* //
|
|
104
|
-
* //
|
|
105
|
-
* //
|
|
106
|
-
* //
|
|
107
|
-
* //
|
|
108
|
-
* //
|
|
109
|
-
* //
|
|
110
|
-
* //
|
|
111
|
-
* //
|
|
112
|
-
* //
|
|
113
|
-
* // ],
|
|
114
|
-
* // DependsOn: [ // ContainerDependencyList
|
|
115
|
-
* // { // ContainerDependency
|
|
116
|
-
* // ContainerName: "STRING_VALUE", // required
|
|
117
|
-
* // Condition: "START" || "COMPLETE" || "SUCCESS" || "HEALTHY", // required
|
|
118
|
-
* // },
|
|
119
|
-
* // ],
|
|
153
|
+
* // ImageUri: "STRING_VALUE",
|
|
154
|
+
* // MemoryHardLimitMebibytes: Number("int"),
|
|
155
|
+
* // PortConfiguration: {
|
|
156
|
+
* // ContainerPortRanges: [ // required
|
|
157
|
+
* // {
|
|
158
|
+
* // FromPort: Number("int"), // required
|
|
159
|
+
* // ToPort: Number("int"), // required
|
|
160
|
+
* // Protocol: "TCP" || "UDP", // required
|
|
161
|
+
* // },
|
|
162
|
+
* // ],
|
|
163
|
+
* // },
|
|
164
|
+
* // ResolvedImageDigest: "STRING_VALUE",
|
|
165
|
+
* // Vcpu: Number("double"),
|
|
120
166
|
* // },
|
|
121
167
|
* // ],
|
|
168
|
+
* // VersionNumber: Number("int"),
|
|
169
|
+
* // VersionDescription: "STRING_VALUE",
|
|
122
170
|
* // Status: "READY" || "COPYING" || "FAILED",
|
|
123
171
|
* // StatusReason: "STRING_VALUE",
|
|
124
172
|
* // },
|