@aws-sdk/client-ecs 3.935.0 → 3.937.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 +526 -45
- package/dist-es/ECS.js +8 -0
- package/dist-es/commands/CreateExpressGatewayServiceCommand.js +16 -0
- package/dist-es/commands/DeleteExpressGatewayServiceCommand.js +16 -0
- package/dist-es/commands/DescribeExpressGatewayServiceCommand.js +16 -0
- package/dist-es/commands/UpdateExpressGatewayServiceCommand.js +16 -0
- package/dist-es/commands/index.js +4 -0
- package/dist-es/models/enums.js +28 -0
- package/dist-es/models/errors.js +8 -8
- package/dist-es/schemas/schemas_0.js +429 -37
- package/dist-types/ECS.d.ts +28 -0
- package/dist-types/ECSClient.d.ts +6 -2
- package/dist-types/commands/CreateExpressGatewayServiceCommand.d.ts +240 -0
- package/dist-types/commands/CreateServiceCommand.d.ts +10 -0
- package/dist-types/commands/DeleteExpressGatewayServiceCommand.d.ts +187 -0
- package/dist-types/commands/DeleteServiceCommand.d.ts +10 -0
- package/dist-types/commands/DescribeExpressGatewayServiceCommand.d.ts +184 -0
- package/dist-types/commands/DescribeServiceRevisionsCommand.d.ts +105 -0
- package/dist-types/commands/DescribeServicesCommand.d.ts +10 -0
- package/dist-types/commands/ListServicesCommand.d.ts +1 -0
- package/dist-types/commands/UpdateExpressGatewayServiceCommand.d.ts +222 -0
- package/dist-types/commands/UpdateServiceCommand.d.ts +10 -0
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/models/enums.d.ts +76 -0
- package/dist-types/models/errors.d.ts +12 -12
- package/dist-types/models/models_0.d.ts +3808 -2758
- package/dist-types/schemas/schemas_0.d.ts +46 -0
- package/dist-types/ts3.4/ECS.d.ts +68 -0
- package/dist-types/ts3.4/ECSClient.d.ts +24 -0
- package/dist-types/ts3.4/commands/CreateExpressGatewayServiceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteExpressGatewayServiceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeExpressGatewayServiceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateExpressGatewayServiceCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +4 -0
- package/dist-types/ts3.4/models/enums.d.ts +39 -0
- package/dist-types/ts3.4/models/errors.d.ts +6 -6
- package/dist-types/ts3.4/models/models_0.d.ts +229 -4
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +46 -0
- package/package.json +12 -12
|
@@ -0,0 +1,184 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ECSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ECSClient";
|
|
4
|
+
import { DescribeExpressGatewayServiceRequest, DescribeExpressGatewayServiceResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DescribeExpressGatewayServiceCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DescribeExpressGatewayServiceCommandInput extends DescribeExpressGatewayServiceRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DescribeExpressGatewayServiceCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DescribeExpressGatewayServiceCommandOutput extends DescribeExpressGatewayServiceResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DescribeExpressGatewayServiceCommand_base: {
|
|
25
|
+
new (input: DescribeExpressGatewayServiceCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeExpressGatewayServiceCommandInput, DescribeExpressGatewayServiceCommandOutput, ECSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: DescribeExpressGatewayServiceCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeExpressGatewayServiceCommandInput, DescribeExpressGatewayServiceCommandOutput, ECSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves detailed information about an Express service, including current status,
|
|
31
|
+
* configuration, managed infrastructure, and service revisions.</p>
|
|
32
|
+
* <p>Returns comprehensive service details, active service revisions, ingress paths with
|
|
33
|
+
* endpoints, and managed Amazon Web Services resource status including load balancers and auto-scaling
|
|
34
|
+
* policies.</p>
|
|
35
|
+
* <p>Use the <code>include</code> parameter to retrieve additional information such as
|
|
36
|
+
* resource tags.</p>
|
|
37
|
+
* @example
|
|
38
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
39
|
+
* ```javascript
|
|
40
|
+
* import { ECSClient, DescribeExpressGatewayServiceCommand } from "@aws-sdk/client-ecs"; // ES Modules import
|
|
41
|
+
* // const { ECSClient, DescribeExpressGatewayServiceCommand } = require("@aws-sdk/client-ecs"); // CommonJS import
|
|
42
|
+
* // import type { ECSClientConfig } from "@aws-sdk/client-ecs";
|
|
43
|
+
* const config = {}; // type is ECSClientConfig
|
|
44
|
+
* const client = new ECSClient(config);
|
|
45
|
+
* const input = { // DescribeExpressGatewayServiceRequest
|
|
46
|
+
* serviceArn: "STRING_VALUE", // required
|
|
47
|
+
* include: [ // ExpressGatewayServiceIncludeList
|
|
48
|
+
* "TAGS",
|
|
49
|
+
* ],
|
|
50
|
+
* };
|
|
51
|
+
* const command = new DescribeExpressGatewayServiceCommand(input);
|
|
52
|
+
* const response = await client.send(command);
|
|
53
|
+
* // { // DescribeExpressGatewayServiceResponse
|
|
54
|
+
* // service: { // ECSExpressGatewayService
|
|
55
|
+
* // cluster: "STRING_VALUE",
|
|
56
|
+
* // serviceName: "STRING_VALUE",
|
|
57
|
+
* // serviceArn: "STRING_VALUE",
|
|
58
|
+
* // infrastructureRoleArn: "STRING_VALUE",
|
|
59
|
+
* // status: { // ExpressGatewayServiceStatus
|
|
60
|
+
* // statusCode: "ACTIVE" || "DRAINING" || "INACTIVE",
|
|
61
|
+
* // statusReason: "STRING_VALUE",
|
|
62
|
+
* // },
|
|
63
|
+
* // currentDeployment: "STRING_VALUE",
|
|
64
|
+
* // activeConfigurations: [ // ExpressGatewayServiceConfigurations
|
|
65
|
+
* // { // ExpressGatewayServiceConfiguration
|
|
66
|
+
* // serviceRevisionArn: "STRING_VALUE",
|
|
67
|
+
* // executionRoleArn: "STRING_VALUE",
|
|
68
|
+
* // taskRoleArn: "STRING_VALUE",
|
|
69
|
+
* // cpu: "STRING_VALUE",
|
|
70
|
+
* // memory: "STRING_VALUE",
|
|
71
|
+
* // networkConfiguration: { // ExpressGatewayServiceNetworkConfiguration
|
|
72
|
+
* // securityGroups: [ // StringList
|
|
73
|
+
* // "STRING_VALUE",
|
|
74
|
+
* // ],
|
|
75
|
+
* // subnets: [
|
|
76
|
+
* // "STRING_VALUE",
|
|
77
|
+
* // ],
|
|
78
|
+
* // },
|
|
79
|
+
* // healthCheckPath: "STRING_VALUE",
|
|
80
|
+
* // primaryContainer: { // ExpressGatewayContainer
|
|
81
|
+
* // image: "STRING_VALUE", // required
|
|
82
|
+
* // containerPort: Number("int"),
|
|
83
|
+
* // awsLogsConfiguration: { // ExpressGatewayServiceAwsLogsConfiguration
|
|
84
|
+
* // logGroup: "STRING_VALUE", // required
|
|
85
|
+
* // logStreamPrefix: "STRING_VALUE", // required
|
|
86
|
+
* // },
|
|
87
|
+
* // repositoryCredentials: { // ExpressGatewayRepositoryCredentials
|
|
88
|
+
* // credentialsParameter: "STRING_VALUE",
|
|
89
|
+
* // },
|
|
90
|
+
* // command: [
|
|
91
|
+
* // "STRING_VALUE",
|
|
92
|
+
* // ],
|
|
93
|
+
* // environment: [ // EnvironmentVariables
|
|
94
|
+
* // { // KeyValuePair
|
|
95
|
+
* // name: "STRING_VALUE",
|
|
96
|
+
* // value: "STRING_VALUE",
|
|
97
|
+
* // },
|
|
98
|
+
* // ],
|
|
99
|
+
* // secrets: [ // SecretList
|
|
100
|
+
* // { // Secret
|
|
101
|
+
* // name: "STRING_VALUE", // required
|
|
102
|
+
* // valueFrom: "STRING_VALUE", // required
|
|
103
|
+
* // },
|
|
104
|
+
* // ],
|
|
105
|
+
* // },
|
|
106
|
+
* // scalingTarget: { // ExpressGatewayScalingTarget
|
|
107
|
+
* // minTaskCount: Number("int"),
|
|
108
|
+
* // maxTaskCount: Number("int"),
|
|
109
|
+
* // autoScalingMetric: "AVERAGE_CPU" || "AVERAGE_MEMORY" || "REQUEST_COUNT_PER_TARGET",
|
|
110
|
+
* // autoScalingTargetValue: Number("int"),
|
|
111
|
+
* // },
|
|
112
|
+
* // ingressPaths: [ // IngressPathSummaries
|
|
113
|
+
* // { // IngressPathSummary
|
|
114
|
+
* // accessType: "PUBLIC" || "PRIVATE", // required
|
|
115
|
+
* // endpoint: "STRING_VALUE", // required
|
|
116
|
+
* // },
|
|
117
|
+
* // ],
|
|
118
|
+
* // createdAt: new Date("TIMESTAMP"),
|
|
119
|
+
* // },
|
|
120
|
+
* // ],
|
|
121
|
+
* // tags: [ // Tags
|
|
122
|
+
* // { // Tag
|
|
123
|
+
* // key: "STRING_VALUE",
|
|
124
|
+
* // value: "STRING_VALUE",
|
|
125
|
+
* // },
|
|
126
|
+
* // ],
|
|
127
|
+
* // createdAt: new Date("TIMESTAMP"),
|
|
128
|
+
* // updatedAt: new Date("TIMESTAMP"),
|
|
129
|
+
* // },
|
|
130
|
+
* // };
|
|
131
|
+
*
|
|
132
|
+
* ```
|
|
133
|
+
*
|
|
134
|
+
* @param DescribeExpressGatewayServiceCommandInput - {@link DescribeExpressGatewayServiceCommandInput}
|
|
135
|
+
* @returns {@link DescribeExpressGatewayServiceCommandOutput}
|
|
136
|
+
* @see {@link DescribeExpressGatewayServiceCommandInput} for command's `input` shape.
|
|
137
|
+
* @see {@link DescribeExpressGatewayServiceCommandOutput} for command's `response` shape.
|
|
138
|
+
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
139
|
+
*
|
|
140
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
141
|
+
* <p>You don't have authorization to perform the requested action.</p>
|
|
142
|
+
*
|
|
143
|
+
* @throws {@link ClientException} (client fault)
|
|
144
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
145
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
146
|
+
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
147
|
+
*
|
|
148
|
+
* @throws {@link ClusterNotFoundException} (client fault)
|
|
149
|
+
* <p>The specified cluster wasn't found. You can view your available clusters with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html">ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
150
|
+
*
|
|
151
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
152
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
153
|
+
* request.</p>
|
|
154
|
+
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
155
|
+
* service event messages</a>. </p>
|
|
156
|
+
*
|
|
157
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
158
|
+
* <p>The specified resource wasn't found.</p>
|
|
159
|
+
*
|
|
160
|
+
* @throws {@link ServerException} (server fault)
|
|
161
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
162
|
+
*
|
|
163
|
+
* @throws {@link UnsupportedFeatureException} (client fault)
|
|
164
|
+
* <p>The specified task isn't supported in this Region.</p>
|
|
165
|
+
*
|
|
166
|
+
* @throws {@link ECSServiceException}
|
|
167
|
+
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
168
|
+
*
|
|
169
|
+
*
|
|
170
|
+
* @public
|
|
171
|
+
*/
|
|
172
|
+
export declare class DescribeExpressGatewayServiceCommand extends DescribeExpressGatewayServiceCommand_base {
|
|
173
|
+
/** @internal type navigation helper, not in runtime. */
|
|
174
|
+
protected static __types: {
|
|
175
|
+
api: {
|
|
176
|
+
input: DescribeExpressGatewayServiceRequest;
|
|
177
|
+
output: DescribeExpressGatewayServiceResponse;
|
|
178
|
+
};
|
|
179
|
+
sdk: {
|
|
180
|
+
input: DescribeExpressGatewayServiceCommandInput;
|
|
181
|
+
output: DescribeExpressGatewayServiceCommandOutput;
|
|
182
|
+
};
|
|
183
|
+
};
|
|
184
|
+
}
|
|
@@ -205,6 +205,111 @@ declare const DescribeServiceRevisionsCommand_base: {
|
|
|
205
205
|
* // },
|
|
206
206
|
* // ],
|
|
207
207
|
* // },
|
|
208
|
+
* // ecsManagedResources: { // ECSManagedResources
|
|
209
|
+
* // ingressPaths: [ // ManagedIngressPaths
|
|
210
|
+
* // { // ManagedIngressPath
|
|
211
|
+
* // accessType: "PUBLIC" || "PRIVATE", // required
|
|
212
|
+
* // endpoint: "STRING_VALUE", // required
|
|
213
|
+
* // loadBalancer: { // ManagedLoadBalancer
|
|
214
|
+
* // arn: "STRING_VALUE",
|
|
215
|
+
* // status: "PROVISIONING" || "ACTIVE" || "DEPROVISIONING" || "DELETED" || "FAILED", // required
|
|
216
|
+
* // statusReason: "STRING_VALUE",
|
|
217
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
218
|
+
* // scheme: "STRING_VALUE", // required
|
|
219
|
+
* // subnetIds: [
|
|
220
|
+
* // "STRING_VALUE",
|
|
221
|
+
* // ],
|
|
222
|
+
* // securityGroupIds: [
|
|
223
|
+
* // "STRING_VALUE",
|
|
224
|
+
* // ],
|
|
225
|
+
* // },
|
|
226
|
+
* // loadBalancerSecurityGroups: [ // ManagedSecurityGroups
|
|
227
|
+
* // { // ManagedSecurityGroup
|
|
228
|
+
* // arn: "STRING_VALUE",
|
|
229
|
+
* // status: "PROVISIONING" || "ACTIVE" || "DEPROVISIONING" || "DELETED" || "FAILED", // required
|
|
230
|
+
* // statusReason: "STRING_VALUE",
|
|
231
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
232
|
+
* // },
|
|
233
|
+
* // ],
|
|
234
|
+
* // certificate: { // ManagedCertificate
|
|
235
|
+
* // arn: "STRING_VALUE",
|
|
236
|
+
* // status: "PROVISIONING" || "ACTIVE" || "DEPROVISIONING" || "DELETED" || "FAILED", // required
|
|
237
|
+
* // statusReason: "STRING_VALUE",
|
|
238
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
239
|
+
* // domainName: "STRING_VALUE", // required
|
|
240
|
+
* // },
|
|
241
|
+
* // listener: { // ManagedListener
|
|
242
|
+
* // arn: "STRING_VALUE",
|
|
243
|
+
* // status: "PROVISIONING" || "ACTIVE" || "DEPROVISIONING" || "DELETED" || "FAILED", // required
|
|
244
|
+
* // statusReason: "STRING_VALUE",
|
|
245
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
246
|
+
* // },
|
|
247
|
+
* // rule: { // ManagedListenerRule
|
|
248
|
+
* // arn: "STRING_VALUE",
|
|
249
|
+
* // status: "PROVISIONING" || "ACTIVE" || "DEPROVISIONING" || "DELETED" || "FAILED", // required
|
|
250
|
+
* // statusReason: "STRING_VALUE",
|
|
251
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
252
|
+
* // },
|
|
253
|
+
* // targetGroups: [ // ManagedTargetGroups
|
|
254
|
+
* // { // ManagedTargetGroup
|
|
255
|
+
* // arn: "STRING_VALUE",
|
|
256
|
+
* // status: "PROVISIONING" || "ACTIVE" || "DEPROVISIONING" || "DELETED" || "FAILED", // required
|
|
257
|
+
* // statusReason: "STRING_VALUE",
|
|
258
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
259
|
+
* // healthCheckPath: "STRING_VALUE", // required
|
|
260
|
+
* // healthCheckPort: Number("int"), // required
|
|
261
|
+
* // port: Number("int"), // required
|
|
262
|
+
* // },
|
|
263
|
+
* // ],
|
|
264
|
+
* // },
|
|
265
|
+
* // ],
|
|
266
|
+
* // autoScaling: { // ManagedAutoScaling
|
|
267
|
+
* // scalableTarget: { // ManagedScalableTarget
|
|
268
|
+
* // arn: "STRING_VALUE",
|
|
269
|
+
* // status: "PROVISIONING" || "ACTIVE" || "DEPROVISIONING" || "DELETED" || "FAILED", // required
|
|
270
|
+
* // statusReason: "STRING_VALUE",
|
|
271
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
272
|
+
* // minCapacity: Number("int"), // required
|
|
273
|
+
* // maxCapacity: Number("int"), // required
|
|
274
|
+
* // },
|
|
275
|
+
* // applicationAutoScalingPolicies: [ // ManagedApplicationAutoScalingPolicies
|
|
276
|
+
* // { // ManagedApplicationAutoScalingPolicy
|
|
277
|
+
* // arn: "STRING_VALUE",
|
|
278
|
+
* // status: "PROVISIONING" || "ACTIVE" || "DEPROVISIONING" || "DELETED" || "FAILED", // required
|
|
279
|
+
* // statusReason: "STRING_VALUE",
|
|
280
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
281
|
+
* // policyType: "STRING_VALUE", // required
|
|
282
|
+
* // targetValue: Number("double"), // required
|
|
283
|
+
* // metric: "STRING_VALUE", // required
|
|
284
|
+
* // },
|
|
285
|
+
* // ],
|
|
286
|
+
* // },
|
|
287
|
+
* // metricAlarms: [ // ManagedMetricAlarms
|
|
288
|
+
* // { // ManagedMetricAlarm
|
|
289
|
+
* // arn: "STRING_VALUE",
|
|
290
|
+
* // status: "PROVISIONING" || "ACTIVE" || "DEPROVISIONING" || "DELETED" || "FAILED", // required
|
|
291
|
+
* // statusReason: "STRING_VALUE",
|
|
292
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
293
|
+
* // },
|
|
294
|
+
* // ],
|
|
295
|
+
* // serviceSecurityGroups: [
|
|
296
|
+
* // {
|
|
297
|
+
* // arn: "STRING_VALUE",
|
|
298
|
+
* // status: "PROVISIONING" || "ACTIVE" || "DEPROVISIONING" || "DELETED" || "FAILED", // required
|
|
299
|
+
* // statusReason: "STRING_VALUE",
|
|
300
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
301
|
+
* // },
|
|
302
|
+
* // ],
|
|
303
|
+
* // logGroups: [ // ManagedLogGroups
|
|
304
|
+
* // { // ManagedLogGroup
|
|
305
|
+
* // arn: "STRING_VALUE",
|
|
306
|
+
* // status: "PROVISIONING" || "ACTIVE" || "DEPROVISIONING" || "DELETED" || "FAILED", // required
|
|
307
|
+
* // statusReason: "STRING_VALUE",
|
|
308
|
+
* // updatedAt: new Date("TIMESTAMP"), // required
|
|
309
|
+
* // logGroupName: "STRING_VALUE", // required
|
|
310
|
+
* // },
|
|
311
|
+
* // ],
|
|
312
|
+
* // },
|
|
208
313
|
* // },
|
|
209
314
|
* // ],
|
|
210
315
|
* // failures: [ // Failures
|
|
@@ -342,6 +342,15 @@ declare const DescribeServicesCommand_base: {
|
|
|
342
342
|
* // },
|
|
343
343
|
* // ],
|
|
344
344
|
* // createdAt: new Date("TIMESTAMP"),
|
|
345
|
+
* // currentServiceDeployment: "STRING_VALUE",
|
|
346
|
+
* // currentServiceRevisions: [ // ServiceCurrentRevisionSummaryList
|
|
347
|
+
* // { // ServiceCurrentRevisionSummary
|
|
348
|
+
* // arn: "STRING_VALUE",
|
|
349
|
+
* // requestedTaskCount: Number("int"),
|
|
350
|
+
* // runningTaskCount: Number("int"),
|
|
351
|
+
* // pendingTaskCount: Number("int"),
|
|
352
|
+
* // },
|
|
353
|
+
* // ],
|
|
345
354
|
* // placementConstraints: [ // PlacementConstraints
|
|
346
355
|
* // { // PlacementConstraint
|
|
347
356
|
* // type: "distinctInstance" || "memberOf",
|
|
@@ -372,6 +381,7 @@ declare const DescribeServicesCommand_base: {
|
|
|
372
381
|
* // propagateTags: "TASK_DEFINITION" || "SERVICE" || "NONE",
|
|
373
382
|
* // enableExecuteCommand: true || false,
|
|
374
383
|
* // availabilityZoneRebalancing: "ENABLED" || "DISABLED",
|
|
384
|
+
* // resourceManagementType: "CUSTOMER" || "ECS",
|
|
375
385
|
* // },
|
|
376
386
|
* // ],
|
|
377
387
|
* // failures: [ // Failures
|
|
@@ -43,6 +43,7 @@ declare const ListServicesCommand_base: {
|
|
|
43
43
|
* maxResults: Number("int"),
|
|
44
44
|
* launchType: "EC2" || "FARGATE" || "EXTERNAL" || "MANAGED_INSTANCES",
|
|
45
45
|
* schedulingStrategy: "REPLICA" || "DAEMON",
|
|
46
|
+
* resourceManagementType: "CUSTOMER" || "ECS",
|
|
46
47
|
* };
|
|
47
48
|
* const command = new ListServicesCommand(input);
|
|
48
49
|
* const response = await client.send(command);
|
|
@@ -0,0 +1,222 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ECSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ECSClient";
|
|
4
|
+
import { UpdateExpressGatewayServiceRequest, UpdateExpressGatewayServiceResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link UpdateExpressGatewayServiceCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateExpressGatewayServiceCommandInput extends UpdateExpressGatewayServiceRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateExpressGatewayServiceCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateExpressGatewayServiceCommandOutput extends UpdateExpressGatewayServiceResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateExpressGatewayServiceCommand_base: {
|
|
25
|
+
new (input: UpdateExpressGatewayServiceCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateExpressGatewayServiceCommandInput, UpdateExpressGatewayServiceCommandOutput, ECSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: UpdateExpressGatewayServiceCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateExpressGatewayServiceCommandInput, UpdateExpressGatewayServiceCommandOutput, ECSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Updates an existing Express service configuration. Modifies container settings, resource
|
|
31
|
+
* allocation, auto-scaling configuration, and other service parameters without recreating the
|
|
32
|
+
* service.</p>
|
|
33
|
+
* <p>Amazon ECS creates a new service revision with updated configuration and performs a rolling
|
|
34
|
+
* deployment to replace existing tasks. The service remains available during updates,
|
|
35
|
+
* ensuring zero-downtime deployments.</p>
|
|
36
|
+
* <p>Some parameters like the infrastructure role cannot be modified after service creation
|
|
37
|
+
* and require creating a new service.</p>
|
|
38
|
+
* @example
|
|
39
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
40
|
+
* ```javascript
|
|
41
|
+
* import { ECSClient, UpdateExpressGatewayServiceCommand } from "@aws-sdk/client-ecs"; // ES Modules import
|
|
42
|
+
* // const { ECSClient, UpdateExpressGatewayServiceCommand } = require("@aws-sdk/client-ecs"); // CommonJS import
|
|
43
|
+
* // import type { ECSClientConfig } from "@aws-sdk/client-ecs";
|
|
44
|
+
* const config = {}; // type is ECSClientConfig
|
|
45
|
+
* const client = new ECSClient(config);
|
|
46
|
+
* const input = { // UpdateExpressGatewayServiceRequest
|
|
47
|
+
* serviceArn: "STRING_VALUE", // required
|
|
48
|
+
* executionRoleArn: "STRING_VALUE",
|
|
49
|
+
* healthCheckPath: "STRING_VALUE",
|
|
50
|
+
* primaryContainer: { // ExpressGatewayContainer
|
|
51
|
+
* image: "STRING_VALUE", // required
|
|
52
|
+
* containerPort: Number("int"),
|
|
53
|
+
* awsLogsConfiguration: { // ExpressGatewayServiceAwsLogsConfiguration
|
|
54
|
+
* logGroup: "STRING_VALUE", // required
|
|
55
|
+
* logStreamPrefix: "STRING_VALUE", // required
|
|
56
|
+
* },
|
|
57
|
+
* repositoryCredentials: { // ExpressGatewayRepositoryCredentials
|
|
58
|
+
* credentialsParameter: "STRING_VALUE",
|
|
59
|
+
* },
|
|
60
|
+
* command: [ // StringList
|
|
61
|
+
* "STRING_VALUE",
|
|
62
|
+
* ],
|
|
63
|
+
* environment: [ // EnvironmentVariables
|
|
64
|
+
* { // KeyValuePair
|
|
65
|
+
* name: "STRING_VALUE",
|
|
66
|
+
* value: "STRING_VALUE",
|
|
67
|
+
* },
|
|
68
|
+
* ],
|
|
69
|
+
* secrets: [ // SecretList
|
|
70
|
+
* { // Secret
|
|
71
|
+
* name: "STRING_VALUE", // required
|
|
72
|
+
* valueFrom: "STRING_VALUE", // required
|
|
73
|
+
* },
|
|
74
|
+
* ],
|
|
75
|
+
* },
|
|
76
|
+
* taskRoleArn: "STRING_VALUE",
|
|
77
|
+
* networkConfiguration: { // ExpressGatewayServiceNetworkConfiguration
|
|
78
|
+
* securityGroups: [
|
|
79
|
+
* "STRING_VALUE",
|
|
80
|
+
* ],
|
|
81
|
+
* subnets: [
|
|
82
|
+
* "STRING_VALUE",
|
|
83
|
+
* ],
|
|
84
|
+
* },
|
|
85
|
+
* cpu: "STRING_VALUE",
|
|
86
|
+
* memory: "STRING_VALUE",
|
|
87
|
+
* scalingTarget: { // ExpressGatewayScalingTarget
|
|
88
|
+
* minTaskCount: Number("int"),
|
|
89
|
+
* maxTaskCount: Number("int"),
|
|
90
|
+
* autoScalingMetric: "AVERAGE_CPU" || "AVERAGE_MEMORY" || "REQUEST_COUNT_PER_TARGET",
|
|
91
|
+
* autoScalingTargetValue: Number("int"),
|
|
92
|
+
* },
|
|
93
|
+
* };
|
|
94
|
+
* const command = new UpdateExpressGatewayServiceCommand(input);
|
|
95
|
+
* const response = await client.send(command);
|
|
96
|
+
* // { // UpdateExpressGatewayServiceResponse
|
|
97
|
+
* // service: { // UpdatedExpressGatewayService
|
|
98
|
+
* // serviceArn: "STRING_VALUE",
|
|
99
|
+
* // cluster: "STRING_VALUE",
|
|
100
|
+
* // serviceName: "STRING_VALUE",
|
|
101
|
+
* // status: { // ExpressGatewayServiceStatus
|
|
102
|
+
* // statusCode: "ACTIVE" || "DRAINING" || "INACTIVE",
|
|
103
|
+
* // statusReason: "STRING_VALUE",
|
|
104
|
+
* // },
|
|
105
|
+
* // targetConfiguration: { // ExpressGatewayServiceConfiguration
|
|
106
|
+
* // serviceRevisionArn: "STRING_VALUE",
|
|
107
|
+
* // executionRoleArn: "STRING_VALUE",
|
|
108
|
+
* // taskRoleArn: "STRING_VALUE",
|
|
109
|
+
* // cpu: "STRING_VALUE",
|
|
110
|
+
* // memory: "STRING_VALUE",
|
|
111
|
+
* // networkConfiguration: { // ExpressGatewayServiceNetworkConfiguration
|
|
112
|
+
* // securityGroups: [ // StringList
|
|
113
|
+
* // "STRING_VALUE",
|
|
114
|
+
* // ],
|
|
115
|
+
* // subnets: [
|
|
116
|
+
* // "STRING_VALUE",
|
|
117
|
+
* // ],
|
|
118
|
+
* // },
|
|
119
|
+
* // healthCheckPath: "STRING_VALUE",
|
|
120
|
+
* // primaryContainer: { // ExpressGatewayContainer
|
|
121
|
+
* // image: "STRING_VALUE", // required
|
|
122
|
+
* // containerPort: Number("int"),
|
|
123
|
+
* // awsLogsConfiguration: { // ExpressGatewayServiceAwsLogsConfiguration
|
|
124
|
+
* // logGroup: "STRING_VALUE", // required
|
|
125
|
+
* // logStreamPrefix: "STRING_VALUE", // required
|
|
126
|
+
* // },
|
|
127
|
+
* // repositoryCredentials: { // ExpressGatewayRepositoryCredentials
|
|
128
|
+
* // credentialsParameter: "STRING_VALUE",
|
|
129
|
+
* // },
|
|
130
|
+
* // command: [
|
|
131
|
+
* // "STRING_VALUE",
|
|
132
|
+
* // ],
|
|
133
|
+
* // environment: [ // EnvironmentVariables
|
|
134
|
+
* // { // KeyValuePair
|
|
135
|
+
* // name: "STRING_VALUE",
|
|
136
|
+
* // value: "STRING_VALUE",
|
|
137
|
+
* // },
|
|
138
|
+
* // ],
|
|
139
|
+
* // secrets: [ // SecretList
|
|
140
|
+
* // { // Secret
|
|
141
|
+
* // name: "STRING_VALUE", // required
|
|
142
|
+
* // valueFrom: "STRING_VALUE", // required
|
|
143
|
+
* // },
|
|
144
|
+
* // ],
|
|
145
|
+
* // },
|
|
146
|
+
* // scalingTarget: { // ExpressGatewayScalingTarget
|
|
147
|
+
* // minTaskCount: Number("int"),
|
|
148
|
+
* // maxTaskCount: Number("int"),
|
|
149
|
+
* // autoScalingMetric: "AVERAGE_CPU" || "AVERAGE_MEMORY" || "REQUEST_COUNT_PER_TARGET",
|
|
150
|
+
* // autoScalingTargetValue: Number("int"),
|
|
151
|
+
* // },
|
|
152
|
+
* // ingressPaths: [ // IngressPathSummaries
|
|
153
|
+
* // { // IngressPathSummary
|
|
154
|
+
* // accessType: "PUBLIC" || "PRIVATE", // required
|
|
155
|
+
* // endpoint: "STRING_VALUE", // required
|
|
156
|
+
* // },
|
|
157
|
+
* // ],
|
|
158
|
+
* // createdAt: new Date("TIMESTAMP"),
|
|
159
|
+
* // },
|
|
160
|
+
* // createdAt: new Date("TIMESTAMP"),
|
|
161
|
+
* // updatedAt: new Date("TIMESTAMP"),
|
|
162
|
+
* // },
|
|
163
|
+
* // };
|
|
164
|
+
*
|
|
165
|
+
* ```
|
|
166
|
+
*
|
|
167
|
+
* @param UpdateExpressGatewayServiceCommandInput - {@link UpdateExpressGatewayServiceCommandInput}
|
|
168
|
+
* @returns {@link UpdateExpressGatewayServiceCommandOutput}
|
|
169
|
+
* @see {@link UpdateExpressGatewayServiceCommandInput} for command's `input` shape.
|
|
170
|
+
* @see {@link UpdateExpressGatewayServiceCommandOutput} for command's `response` shape.
|
|
171
|
+
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
172
|
+
*
|
|
173
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
174
|
+
* <p>You don't have authorization to perform the requested action.</p>
|
|
175
|
+
*
|
|
176
|
+
* @throws {@link ClientException} (client fault)
|
|
177
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
178
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
179
|
+
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
180
|
+
*
|
|
181
|
+
* @throws {@link ClusterNotFoundException} (client fault)
|
|
182
|
+
* <p>The specified cluster wasn't found. You can view your available clusters with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html">ListClusters</a>. Amazon ECS clusters are Region specific.</p>
|
|
183
|
+
*
|
|
184
|
+
* @throws {@link InvalidParameterException} (client fault)
|
|
185
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
186
|
+
* request.</p>
|
|
187
|
+
* <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS
|
|
188
|
+
* service event messages</a>. </p>
|
|
189
|
+
*
|
|
190
|
+
* @throws {@link ServerException} (server fault)
|
|
191
|
+
* <p>These errors are usually caused by a server issue.</p>
|
|
192
|
+
*
|
|
193
|
+
* @throws {@link ServiceNotActiveException} (client fault)
|
|
194
|
+
* <p>The specified service isn't active. You can't update a service that's inactive. If you
|
|
195
|
+
* have previously deleted a service, you can re-create it with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html">CreateService</a>.</p>
|
|
196
|
+
*
|
|
197
|
+
* @throws {@link ServiceNotFoundException} (client fault)
|
|
198
|
+
* <p>The specified service wasn't found. You can view your available services with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListServices.html">ListServices</a>. Amazon ECS services are cluster specific and Region
|
|
199
|
+
* specific.</p>
|
|
200
|
+
*
|
|
201
|
+
* @throws {@link UnsupportedFeatureException} (client fault)
|
|
202
|
+
* <p>The specified task isn't supported in this Region.</p>
|
|
203
|
+
*
|
|
204
|
+
* @throws {@link ECSServiceException}
|
|
205
|
+
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
206
|
+
*
|
|
207
|
+
*
|
|
208
|
+
* @public
|
|
209
|
+
*/
|
|
210
|
+
export declare class UpdateExpressGatewayServiceCommand extends UpdateExpressGatewayServiceCommand_base {
|
|
211
|
+
/** @internal type navigation helper, not in runtime. */
|
|
212
|
+
protected static __types: {
|
|
213
|
+
api: {
|
|
214
|
+
input: UpdateExpressGatewayServiceRequest;
|
|
215
|
+
output: UpdateExpressGatewayServiceResponse;
|
|
216
|
+
};
|
|
217
|
+
sdk: {
|
|
218
|
+
input: UpdateExpressGatewayServiceCommandInput;
|
|
219
|
+
output: UpdateExpressGatewayServiceCommandOutput;
|
|
220
|
+
};
|
|
221
|
+
};
|
|
222
|
+
}
|
|
@@ -647,6 +647,15 @@ declare const UpdateServiceCommand_base: {
|
|
|
647
647
|
* // },
|
|
648
648
|
* // ],
|
|
649
649
|
* // createdAt: new Date("TIMESTAMP"),
|
|
650
|
+
* // currentServiceDeployment: "STRING_VALUE",
|
|
651
|
+
* // currentServiceRevisions: [ // ServiceCurrentRevisionSummaryList
|
|
652
|
+
* // { // ServiceCurrentRevisionSummary
|
|
653
|
+
* // arn: "STRING_VALUE",
|
|
654
|
+
* // requestedTaskCount: Number("int"),
|
|
655
|
+
* // runningTaskCount: Number("int"),
|
|
656
|
+
* // pendingTaskCount: Number("int"),
|
|
657
|
+
* // },
|
|
658
|
+
* // ],
|
|
650
659
|
* // placementConstraints: [ // PlacementConstraints
|
|
651
660
|
* // { // PlacementConstraint
|
|
652
661
|
* // type: "distinctInstance" || "memberOf",
|
|
@@ -677,6 +686,7 @@ declare const UpdateServiceCommand_base: {
|
|
|
677
686
|
* // propagateTags: "TASK_DEFINITION" || "SERVICE" || "NONE",
|
|
678
687
|
* // enableExecuteCommand: true || false,
|
|
679
688
|
* // availabilityZoneRebalancing: "ENABLED" || "DISABLED",
|
|
689
|
+
* // resourceManagementType: "CUSTOMER" || "ECS",
|
|
680
690
|
* // },
|
|
681
691
|
* // };
|
|
682
692
|
*
|
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
export * from "./CreateCapacityProviderCommand";
|
|
2
2
|
export * from "./CreateClusterCommand";
|
|
3
|
+
export * from "./CreateExpressGatewayServiceCommand";
|
|
3
4
|
export * from "./CreateServiceCommand";
|
|
4
5
|
export * from "./CreateTaskSetCommand";
|
|
5
6
|
export * from "./DeleteAccountSettingCommand";
|
|
6
7
|
export * from "./DeleteAttributesCommand";
|
|
7
8
|
export * from "./DeleteCapacityProviderCommand";
|
|
8
9
|
export * from "./DeleteClusterCommand";
|
|
10
|
+
export * from "./DeleteExpressGatewayServiceCommand";
|
|
9
11
|
export * from "./DeleteServiceCommand";
|
|
10
12
|
export * from "./DeleteTaskDefinitionsCommand";
|
|
11
13
|
export * from "./DeleteTaskSetCommand";
|
|
@@ -14,6 +16,7 @@ export * from "./DeregisterTaskDefinitionCommand";
|
|
|
14
16
|
export * from "./DescribeCapacityProvidersCommand";
|
|
15
17
|
export * from "./DescribeClustersCommand";
|
|
16
18
|
export * from "./DescribeContainerInstancesCommand";
|
|
19
|
+
export * from "./DescribeExpressGatewayServiceCommand";
|
|
17
20
|
export * from "./DescribeServiceDeploymentsCommand";
|
|
18
21
|
export * from "./DescribeServiceRevisionsCommand";
|
|
19
22
|
export * from "./DescribeServicesCommand";
|
|
@@ -54,6 +57,7 @@ export * from "./UpdateClusterCommand";
|
|
|
54
57
|
export * from "./UpdateClusterSettingsCommand";
|
|
55
58
|
export * from "./UpdateContainerAgentCommand";
|
|
56
59
|
export * from "./UpdateContainerInstancesStateCommand";
|
|
60
|
+
export * from "./UpdateExpressGatewayServiceCommand";
|
|
57
61
|
export * from "./UpdateServiceCommand";
|
|
58
62
|
export * from "./UpdateServicePrimaryTaskSetCommand";
|
|
59
63
|
export * from "./UpdateTaskProtectionCommand";
|