@aws-sdk/client-ecs 3.1047.0 → 3.1049.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 +7 -0
- package/dist-cjs/endpoint/endpointResolver.js +2 -2
- package/dist-cjs/index.js +42 -13
- package/dist-cjs/models/errors.js +14 -14
- package/dist-cjs/runtimeConfig.browser.js +5 -5
- package/dist-cjs/runtimeConfig.js +2 -3
- package/dist-cjs/schemas/schemas_0.js +69 -28
- package/dist-es/ECS.js +2 -0
- package/dist-es/ECSClient.js +1 -4
- package/dist-es/commands/ContinueServiceDeploymentCommand.js +16 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/endpoint/endpointResolver.js +1 -1
- package/dist-es/models/enums.js +16 -0
- package/dist-es/models/errors.js +12 -12
- package/dist-es/runtimeConfig.browser.js +1 -1
- package/dist-es/runtimeConfig.js +1 -2
- package/dist-es/runtimeExtensions.js +1 -1
- package/dist-es/schemas/schemas_0.js +60 -20
- package/dist-types/ECS.d.ts +7 -0
- package/dist-types/ECSClient.d.ts +4 -4
- package/dist-types/commands/ContinueServiceDeploymentCommand.d.ts +130 -0
- package/dist-types/commands/CreateServiceCommand.d.ts +85 -2
- package/dist-types/commands/DeleteServiceCommand.d.ts +6 -1
- package/dist-types/commands/DeleteTaskDefinitionsCommand.d.ts +1 -2
- package/dist-types/commands/DescribeServiceDeploymentsCommand.d.ts +79 -1
- package/dist-types/commands/DescribeServiceRevisionsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeServicesCommand.d.ts +67 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateServiceCommand.d.ts +40 -2
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/enums.d.ts +40 -0
- package/dist-types/models/errors.d.ts +12 -12
- package/dist-types/models/models_0.d.ts +101 -49
- package/dist-types/models/models_1.d.ts +46 -1
- package/dist-types/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/runtimeConfig.native.d.ts +1 -1
- package/dist-types/schemas/schemas_0.d.ts +5 -0
- package/dist-types/ts3.4/ECS.d.ts +17 -0
- package/dist-types/ts3.4/ECSClient.d.ts +7 -3
- package/dist-types/ts3.4/commands/ContinueServiceDeploymentCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/DeleteTaskDefinitionsCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/DescribeServiceRevisionsCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/enums.d.ts +22 -0
- package/dist-types/ts3.4/models/errors.d.ts +10 -10
- package/dist-types/ts3.4/models/models_0.d.ts +28 -12
- package/dist-types/ts3.4/models/models_1.d.ts +13 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -1
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +5 -0
- package/package.json +6 -14
|
@@ -95,12 +95,17 @@ declare const CreateServiceCommand_base: {
|
|
|
95
95
|
* bakeTimeInMinutes: Number("int"),
|
|
96
96
|
* lifecycleHooks: [ // DeploymentLifecycleHookList
|
|
97
97
|
* { // DeploymentLifecycleHook
|
|
98
|
+
* targetType: "AWS_LAMBDA" || "PAUSE",
|
|
98
99
|
* hookTargetArn: "STRING_VALUE",
|
|
99
100
|
* roleArn: "STRING_VALUE",
|
|
100
101
|
* lifecycleStages: [ // DeploymentLifecycleHookStageList
|
|
101
|
-
* "RECONCILE_SERVICE" || "PRE_SCALE_UP" || "POST_SCALE_UP" || "TEST_TRAFFIC_SHIFT" || "POST_TEST_TRAFFIC_SHIFT" || "PRODUCTION_TRAFFIC_SHIFT" || "POST_PRODUCTION_TRAFFIC_SHIFT",
|
|
102
|
+
* "RECONCILE_SERVICE" || "PRE_SCALE_UP" || "POST_SCALE_UP" || "TEST_TRAFFIC_SHIFT" || "POST_TEST_TRAFFIC_SHIFT" || "PRE_PRODUCTION_TRAFFIC_SHIFT" || "PRODUCTION_TRAFFIC_SHIFT" || "POST_PRODUCTION_TRAFFIC_SHIFT",
|
|
102
103
|
* ],
|
|
103
104
|
* hookDetails: "DOCUMENT_VALUE",
|
|
105
|
+
* timeoutConfiguration: { // DeploymentLifecycleHookTimeoutConfiguration
|
|
106
|
+
* timeoutInMinutes: Number("int"),
|
|
107
|
+
* action: "ROLLBACK" || "CONTINUE",
|
|
108
|
+
* },
|
|
104
109
|
* },
|
|
105
110
|
* ],
|
|
106
111
|
* linearConfiguration: { // LinearConfiguration
|
|
@@ -300,12 +305,17 @@ declare const CreateServiceCommand_base: {
|
|
|
300
305
|
* // bakeTimeInMinutes: Number("int"),
|
|
301
306
|
* // lifecycleHooks: [ // DeploymentLifecycleHookList
|
|
302
307
|
* // { // DeploymentLifecycleHook
|
|
308
|
+
* // targetType: "AWS_LAMBDA" || "PAUSE",
|
|
303
309
|
* // hookTargetArn: "STRING_VALUE",
|
|
304
310
|
* // roleArn: "STRING_VALUE",
|
|
305
311
|
* // lifecycleStages: [ // DeploymentLifecycleHookStageList
|
|
306
|
-
* // "RECONCILE_SERVICE" || "PRE_SCALE_UP" || "POST_SCALE_UP" || "TEST_TRAFFIC_SHIFT" || "POST_TEST_TRAFFIC_SHIFT" || "PRODUCTION_TRAFFIC_SHIFT" || "POST_PRODUCTION_TRAFFIC_SHIFT",
|
|
312
|
+
* // "RECONCILE_SERVICE" || "PRE_SCALE_UP" || "POST_SCALE_UP" || "TEST_TRAFFIC_SHIFT" || "POST_TEST_TRAFFIC_SHIFT" || "PRE_PRODUCTION_TRAFFIC_SHIFT" || "PRODUCTION_TRAFFIC_SHIFT" || "POST_PRODUCTION_TRAFFIC_SHIFT",
|
|
307
313
|
* // ],
|
|
308
314
|
* // hookDetails: "DOCUMENT_VALUE",
|
|
315
|
+
* // timeoutConfiguration: { // DeploymentLifecycleHookTimeoutConfiguration
|
|
316
|
+
* // timeoutInMinutes: Number("int"),
|
|
317
|
+
* // action: "ROLLBACK" || "CONTINUE",
|
|
318
|
+
* // },
|
|
309
319
|
* // },
|
|
310
320
|
* // ],
|
|
311
321
|
* // linearConfiguration: { // LinearConfiguration
|
|
@@ -731,6 +741,79 @@ declare const CreateServiceCommand_base: {
|
|
|
731
741
|
* *\/
|
|
732
742
|
* ```
|
|
733
743
|
*
|
|
744
|
+
* @example To create a service with a pause lifecycle hook
|
|
745
|
+
* ```javascript
|
|
746
|
+
* // This example creates a service with a blue/green deployment strategy that includes a pause lifecycle hook at the POST_PRODUCTION_TRAFFIC_SHIFT stage. The deployment will pause at that stage until you explicitly continue or roll back using the ContinueServiceDeployment API, or until the 60-minute timeout expires and triggers a rollback.
|
|
747
|
+
* const input = {
|
|
748
|
+
* deploymentConfiguration: {
|
|
749
|
+
* lifecycleHooks: [
|
|
750
|
+
* {
|
|
751
|
+
* lifecycleStages: [
|
|
752
|
+
* "POST_PRODUCTION_TRAFFIC_SHIFT"
|
|
753
|
+
* ],
|
|
754
|
+
* targetType: "PAUSE",
|
|
755
|
+
* timeoutConfiguration: {
|
|
756
|
+
* action: "ROLLBACK",
|
|
757
|
+
* timeoutInMinutes: 60
|
|
758
|
+
* }
|
|
759
|
+
* }
|
|
760
|
+
* ],
|
|
761
|
+
* strategy: "BLUE_GREEN"
|
|
762
|
+
* },
|
|
763
|
+
* desiredCount: 2,
|
|
764
|
+
* serviceName: "ecs-service-with-pause-hook",
|
|
765
|
+
* taskDefinition: "ecs-demo"
|
|
766
|
+
* };
|
|
767
|
+
* const command = new CreateServiceCommand(input);
|
|
768
|
+
* const response = await client.send(command);
|
|
769
|
+
* /* response is
|
|
770
|
+
* {
|
|
771
|
+
* service: {
|
|
772
|
+
* clusterArn: "arn:aws:ecs:us-east-1:012345678910:cluster/default",
|
|
773
|
+
* createdAt: "2026-05-06T16:00:00.000Z",
|
|
774
|
+
* deploymentConfiguration: {
|
|
775
|
+
* lifecycleHooks: [
|
|
776
|
+
* {
|
|
777
|
+
* lifecycleStages: [
|
|
778
|
+
* "POST_PRODUCTION_TRAFFIC_SHIFT"
|
|
779
|
+
* ],
|
|
780
|
+
* targetType: "PAUSE",
|
|
781
|
+
* timeoutConfiguration: {
|
|
782
|
+
* action: "ROLLBACK",
|
|
783
|
+
* timeoutInMinutes: 60
|
|
784
|
+
* }
|
|
785
|
+
* }
|
|
786
|
+
* ],
|
|
787
|
+
* maximumPercent: 200,
|
|
788
|
+
* minimumHealthyPercent: 100,
|
|
789
|
+
* strategy: "BLUE_GREEN"
|
|
790
|
+
* },
|
|
791
|
+
* deployments: [
|
|
792
|
+
* {
|
|
793
|
+
* createdAt: "2026-05-06T16:00:00.000Z",
|
|
794
|
+
* desiredCount: 2,
|
|
795
|
+
* id: "ecs-svc/9223370564342348388",
|
|
796
|
+
* pendingCount: 0,
|
|
797
|
+
* runningCount: 0,
|
|
798
|
+
* status: "PRIMARY",
|
|
799
|
+
* taskDefinition: "arn:aws:ecs:us-east-1:012345678910:task-definition/ecs-demo:1",
|
|
800
|
+
* updatedAt: "2026-05-06T16:00:00.000Z"
|
|
801
|
+
* }
|
|
802
|
+
* ],
|
|
803
|
+
* desiredCount: 2,
|
|
804
|
+
* events: [],
|
|
805
|
+
* loadBalancers: [],
|
|
806
|
+
* pendingCount: 0,
|
|
807
|
+
* runningCount: 0,
|
|
808
|
+
* serviceArn: "arn:aws:ecs:us-east-1:012345678910:service/default/ecs-service-with-pause-hook",
|
|
809
|
+
* serviceName: "ecs-service-with-pause-hook",
|
|
810
|
+
* status: "ACTIVE",
|
|
811
|
+
* taskDefinition: "arn:aws:ecs:us-east-1:012345678910:task-definition/ecs-demo:1"
|
|
812
|
+
* }
|
|
813
|
+
* }
|
|
814
|
+
* *\/
|
|
815
|
+
* ```
|
|
816
|
+
*
|
|
734
817
|
* @public
|
|
735
818
|
*/
|
|
736
819
|
export declare class CreateServiceCommand extends CreateServiceCommand_base {
|
|
@@ -105,12 +105,17 @@ declare const DeleteServiceCommand_base: {
|
|
|
105
105
|
* // bakeTimeInMinutes: Number("int"),
|
|
106
106
|
* // lifecycleHooks: [ // DeploymentLifecycleHookList
|
|
107
107
|
* // { // DeploymentLifecycleHook
|
|
108
|
+
* // targetType: "AWS_LAMBDA" || "PAUSE",
|
|
108
109
|
* // hookTargetArn: "STRING_VALUE",
|
|
109
110
|
* // roleArn: "STRING_VALUE",
|
|
110
111
|
* // lifecycleStages: [ // DeploymentLifecycleHookStageList
|
|
111
|
-
* // "RECONCILE_SERVICE" || "PRE_SCALE_UP" || "POST_SCALE_UP" || "TEST_TRAFFIC_SHIFT" || "POST_TEST_TRAFFIC_SHIFT" || "PRODUCTION_TRAFFIC_SHIFT" || "POST_PRODUCTION_TRAFFIC_SHIFT",
|
|
112
|
+
* // "RECONCILE_SERVICE" || "PRE_SCALE_UP" || "POST_SCALE_UP" || "TEST_TRAFFIC_SHIFT" || "POST_TEST_TRAFFIC_SHIFT" || "PRE_PRODUCTION_TRAFFIC_SHIFT" || "PRODUCTION_TRAFFIC_SHIFT" || "POST_PRODUCTION_TRAFFIC_SHIFT",
|
|
112
113
|
* // ],
|
|
113
114
|
* // hookDetails: "DOCUMENT_VALUE",
|
|
115
|
+
* // timeoutConfiguration: { // DeploymentLifecycleHookTimeoutConfiguration
|
|
116
|
+
* // timeoutInMinutes: Number("int"),
|
|
117
|
+
* // action: "ROLLBACK" || "CONTINUE",
|
|
118
|
+
* // },
|
|
114
119
|
* // },
|
|
115
120
|
* // ],
|
|
116
121
|
* // linearConfiguration: { // LinearConfiguration
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/core/client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import type { ECSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ECSClient";
|
|
4
|
-
import type { DeleteTaskDefinitionsRequest } from "../models/
|
|
5
|
-
import type { DeleteTaskDefinitionsResponse } from "../models/models_1";
|
|
4
|
+
import type { DeleteTaskDefinitionsRequest, DeleteTaskDefinitionsResponse } from "../models/models_1";
|
|
6
5
|
/**
|
|
7
6
|
* @public
|
|
8
7
|
*/
|
|
@@ -77,6 +77,16 @@ declare const DescribeServiceDeploymentsCommand_base: {
|
|
|
77
77
|
* // status: "PENDING" || "SUCCESSFUL" || "STOPPED" || "STOP_REQUESTED" || "IN_PROGRESS" || "ROLLBACK_REQUESTED" || "ROLLBACK_IN_PROGRESS" || "ROLLBACK_SUCCESSFUL" || "ROLLBACK_FAILED",
|
|
78
78
|
* // statusReason: "STRING_VALUE",
|
|
79
79
|
* // lifecycleStage: "RECONCILE_SERVICE" || "PRE_SCALE_UP" || "SCALE_UP" || "POST_SCALE_UP" || "TEST_TRAFFIC_SHIFT" || "POST_TEST_TRAFFIC_SHIFT" || "PRODUCTION_TRAFFIC_SHIFT" || "POST_PRODUCTION_TRAFFIC_SHIFT" || "BAKE_TIME" || "CLEAN_UP",
|
|
80
|
+
* // lifecycleHookDetails: [ // DeploymentLifecycleHookDetailList
|
|
81
|
+
* // { // DeploymentLifecycleHookDetail
|
|
82
|
+
* // hookId: "STRING_VALUE",
|
|
83
|
+
* // targetType: "AWS_LAMBDA" || "PAUSE",
|
|
84
|
+
* // targetArn: "STRING_VALUE",
|
|
85
|
+
* // status: "AWAITING_ACTION" || "IN_PROGRESS" || "SUCCEEDED" || "FAILED" || "TIMED_OUT",
|
|
86
|
+
* // expiresAt: new Date("TIMESTAMP"),
|
|
87
|
+
* // timeoutAction: "ROLLBACK" || "CONTINUE",
|
|
88
|
+
* // },
|
|
89
|
+
* // ],
|
|
80
90
|
* // deploymentConfiguration: { // DeploymentConfiguration
|
|
81
91
|
* // deploymentCircuitBreaker: { // DeploymentCircuitBreaker
|
|
82
92
|
* // enable: true || false, // required
|
|
@@ -95,12 +105,17 @@ declare const DescribeServiceDeploymentsCommand_base: {
|
|
|
95
105
|
* // bakeTimeInMinutes: Number("int"),
|
|
96
106
|
* // lifecycleHooks: [ // DeploymentLifecycleHookList
|
|
97
107
|
* // { // DeploymentLifecycleHook
|
|
108
|
+
* // targetType: "AWS_LAMBDA" || "PAUSE",
|
|
98
109
|
* // hookTargetArn: "STRING_VALUE",
|
|
99
110
|
* // roleArn: "STRING_VALUE",
|
|
100
111
|
* // lifecycleStages: [ // DeploymentLifecycleHookStageList
|
|
101
|
-
* // "RECONCILE_SERVICE" || "PRE_SCALE_UP" || "POST_SCALE_UP" || "TEST_TRAFFIC_SHIFT" || "POST_TEST_TRAFFIC_SHIFT" || "PRODUCTION_TRAFFIC_SHIFT" || "POST_PRODUCTION_TRAFFIC_SHIFT",
|
|
112
|
+
* // "RECONCILE_SERVICE" || "PRE_SCALE_UP" || "POST_SCALE_UP" || "TEST_TRAFFIC_SHIFT" || "POST_TEST_TRAFFIC_SHIFT" || "PRE_PRODUCTION_TRAFFIC_SHIFT" || "PRODUCTION_TRAFFIC_SHIFT" || "POST_PRODUCTION_TRAFFIC_SHIFT",
|
|
102
113
|
* // ],
|
|
103
114
|
* // hookDetails: "DOCUMENT_VALUE",
|
|
115
|
+
* // timeoutConfiguration: { // DeploymentLifecycleHookTimeoutConfiguration
|
|
116
|
+
* // timeoutInMinutes: Number("int"),
|
|
117
|
+
* // action: "ROLLBACK" || "CONTINUE",
|
|
118
|
+
* // },
|
|
104
119
|
* // },
|
|
105
120
|
* // ],
|
|
106
121
|
* // linearConfiguration: { // LinearConfiguration
|
|
@@ -215,6 +230,69 @@ declare const DescribeServiceDeploymentsCommand_base: {
|
|
|
215
230
|
* *\/
|
|
216
231
|
* ```
|
|
217
232
|
*
|
|
233
|
+
* @example To describe a service deployment with a paused lifecycle hook
|
|
234
|
+
* ```javascript
|
|
235
|
+
* // This example describes a service deployment that is currently paused at a lifecycle hook. The lifecycleHookDetails field shows the status of the pause hook, including when it will expire and what action will be taken if the timeout is reached.
|
|
236
|
+
* const input = {
|
|
237
|
+
* serviceDeploymentArns: [
|
|
238
|
+
* "arn:aws:ecs:us-east-1:123456789012:service-deployment/MyCluster/MyService/r9i43YFjvgF_xlg7m2eJ1r"
|
|
239
|
+
* ]
|
|
240
|
+
* };
|
|
241
|
+
* const command = new DescribeServiceDeploymentsCommand(input);
|
|
242
|
+
* const response = await client.send(command);
|
|
243
|
+
* /* response is
|
|
244
|
+
* {
|
|
245
|
+
* failures: [],
|
|
246
|
+
* serviceDeployments: [
|
|
247
|
+
* {
|
|
248
|
+
* clusterArn: "arn:aws:ecs:us-east-1:123456789012:cluster/MyCluster",
|
|
249
|
+
* deploymentConfiguration: {
|
|
250
|
+
* deploymentCircuitBreaker: {
|
|
251
|
+
* enable: false,
|
|
252
|
+
* rollback: false
|
|
253
|
+
* },
|
|
254
|
+
* lifecycleHooks: [
|
|
255
|
+
* {
|
|
256
|
+
* lifecycleStages: [
|
|
257
|
+
* "POST_PRODUCTION_TRAFFIC_SHIFT"
|
|
258
|
+
* ],
|
|
259
|
+
* targetType: "PAUSE",
|
|
260
|
+
* timeoutConfiguration: {
|
|
261
|
+
* action: "ROLLBACK",
|
|
262
|
+
* timeoutInMinutes: 60
|
|
263
|
+
* }
|
|
264
|
+
* }
|
|
265
|
+
* ],
|
|
266
|
+
* maximumPercent: 200,
|
|
267
|
+
* minimumHealthyPercent: 100,
|
|
268
|
+
* strategy: "BLUE_GREEN"
|
|
269
|
+
* },
|
|
270
|
+
* lifecycleHookDetails: [
|
|
271
|
+
* {
|
|
272
|
+
* expiresAt: "2026-05-06T17:00:00.000Z",
|
|
273
|
+
* hookId: "ABCDEFGHIJKLMNOPQRSTUVWXYZ234567",
|
|
274
|
+
* status: "AWAITING_ACTION",
|
|
275
|
+
* targetType: "PAUSE",
|
|
276
|
+
* timeoutAction: "ROLLBACK"
|
|
277
|
+
* }
|
|
278
|
+
* ],
|
|
279
|
+
* lifecycleStage: "POST_PRODUCTION_TRAFFIC_SHIFT",
|
|
280
|
+
* serviceArn: "arn:aws:ecs:us-east-1:123456789012:service/MyCluster/MyService",
|
|
281
|
+
* serviceDeploymentArn: "arn:aws:ecs:us-east-1:123456789012:service-deployment/MyCluster/MyService/r9i43YFjvgF_xlg7m2eJ1r",
|
|
282
|
+
* status: "IN_PROGRESS",
|
|
283
|
+
* targetServiceRevision: {
|
|
284
|
+
* arn: "arn:aws:ecs:us-east-1:123456789012:service-revision/MyCluster/MyService/1234567890123456789",
|
|
285
|
+
* pendingTaskCount: 1,
|
|
286
|
+
* requestedTaskCount: 2,
|
|
287
|
+
* runningTaskCount: 1
|
|
288
|
+
* },
|
|
289
|
+
* updatedAt: "2026-05-06T16:00:00.000Z"
|
|
290
|
+
* }
|
|
291
|
+
* ]
|
|
292
|
+
* }
|
|
293
|
+
* *\/
|
|
294
|
+
* ```
|
|
295
|
+
*
|
|
218
296
|
* @public
|
|
219
297
|
*/
|
|
220
298
|
export declare class DescribeServiceDeploymentsCommand extends DescribeServiceDeploymentsCommand_base {
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/core/client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import type { ECSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ECSClient";
|
|
4
|
-
import type { DescribeServiceRevisionsRequest
|
|
4
|
+
import type { DescribeServiceRevisionsRequest } from "../models/models_0";
|
|
5
|
+
import type { DescribeServiceRevisionsResponse } from "../models/models_1";
|
|
5
6
|
/**
|
|
6
7
|
* @public
|
|
7
8
|
*/
|
|
@@ -110,12 +110,17 @@ declare const DescribeServicesCommand_base: {
|
|
|
110
110
|
* // bakeTimeInMinutes: Number("int"),
|
|
111
111
|
* // lifecycleHooks: [ // DeploymentLifecycleHookList
|
|
112
112
|
* // { // DeploymentLifecycleHook
|
|
113
|
+
* // targetType: "AWS_LAMBDA" || "PAUSE",
|
|
113
114
|
* // hookTargetArn: "STRING_VALUE",
|
|
114
115
|
* // roleArn: "STRING_VALUE",
|
|
115
116
|
* // lifecycleStages: [ // DeploymentLifecycleHookStageList
|
|
116
|
-
* // "RECONCILE_SERVICE" || "PRE_SCALE_UP" || "POST_SCALE_UP" || "TEST_TRAFFIC_SHIFT" || "POST_TEST_TRAFFIC_SHIFT" || "PRODUCTION_TRAFFIC_SHIFT" || "POST_PRODUCTION_TRAFFIC_SHIFT",
|
|
117
|
+
* // "RECONCILE_SERVICE" || "PRE_SCALE_UP" || "POST_SCALE_UP" || "TEST_TRAFFIC_SHIFT" || "POST_TEST_TRAFFIC_SHIFT" || "PRE_PRODUCTION_TRAFFIC_SHIFT" || "PRODUCTION_TRAFFIC_SHIFT" || "POST_PRODUCTION_TRAFFIC_SHIFT",
|
|
117
118
|
* // ],
|
|
118
119
|
* // hookDetails: "DOCUMENT_VALUE",
|
|
120
|
+
* // timeoutConfiguration: { // DeploymentLifecycleHookTimeoutConfiguration
|
|
121
|
+
* // timeoutInMinutes: Number("int"),
|
|
122
|
+
* // action: "ROLLBACK" || "CONTINUE",
|
|
123
|
+
* // },
|
|
119
124
|
* // },
|
|
120
125
|
* // ],
|
|
121
126
|
* // linearConfiguration: { // LinearConfiguration
|
|
@@ -476,6 +481,67 @@ declare const DescribeServicesCommand_base: {
|
|
|
476
481
|
* *\/
|
|
477
482
|
* ```
|
|
478
483
|
*
|
|
484
|
+
* @example To describe a service with a pause lifecycle hook
|
|
485
|
+
* ```javascript
|
|
486
|
+
* // This example provides descriptive information about the service ``ecs-service-with-pause-hook``, which is configured with a pause lifecycle hook in its deployment configuration.
|
|
487
|
+
* const input = {
|
|
488
|
+
* services: [
|
|
489
|
+
* "ecs-service-with-pause-hook"
|
|
490
|
+
* ]
|
|
491
|
+
* };
|
|
492
|
+
* const command = new DescribeServicesCommand(input);
|
|
493
|
+
* const response = await client.send(command);
|
|
494
|
+
* /* response is
|
|
495
|
+
* {
|
|
496
|
+
* failures: [],
|
|
497
|
+
* services: [
|
|
498
|
+
* {
|
|
499
|
+
* clusterArn: "arn:aws:ecs:us-east-1:012345678910:cluster/default",
|
|
500
|
+
* createdAt: "2026-05-06T16:00:00.000Z",
|
|
501
|
+
* deploymentConfiguration: {
|
|
502
|
+
* lifecycleHooks: [
|
|
503
|
+
* {
|
|
504
|
+
* lifecycleStages: [
|
|
505
|
+
* "POST_PRODUCTION_TRAFFIC_SHIFT"
|
|
506
|
+
* ],
|
|
507
|
+
* targetType: "PAUSE",
|
|
508
|
+
* timeoutConfiguration: {
|
|
509
|
+
* action: "ROLLBACK",
|
|
510
|
+
* timeoutInMinutes: 60
|
|
511
|
+
* }
|
|
512
|
+
* }
|
|
513
|
+
* ],
|
|
514
|
+
* maximumPercent: 200,
|
|
515
|
+
* minimumHealthyPercent: 100,
|
|
516
|
+
* strategy: "BLUE_GREEN"
|
|
517
|
+
* },
|
|
518
|
+
* deployments: [
|
|
519
|
+
* {
|
|
520
|
+
* createdAt: "2026-05-06T16:00:00.000Z",
|
|
521
|
+
* desiredCount: 2,
|
|
522
|
+
* id: "ecs-svc/9223370564341623665",
|
|
523
|
+
* pendingCount: 0,
|
|
524
|
+
* runningCount: 2,
|
|
525
|
+
* status: "PRIMARY",
|
|
526
|
+
* taskDefinition: "arn:aws:ecs:us-east-1:012345678910:task-definition/ecs-demo:1",
|
|
527
|
+
* updatedAt: "2026-05-06T16:00:00.000Z"
|
|
528
|
+
* }
|
|
529
|
+
* ],
|
|
530
|
+
* desiredCount: 2,
|
|
531
|
+
* events: [],
|
|
532
|
+
* loadBalancers: [],
|
|
533
|
+
* pendingCount: 0,
|
|
534
|
+
* runningCount: 2,
|
|
535
|
+
* serviceArn: "arn:aws:ecs:us-east-1:012345678910:service/default/ecs-service-with-pause-hook",
|
|
536
|
+
* serviceName: "ecs-service-with-pause-hook",
|
|
537
|
+
* status: "ACTIVE",
|
|
538
|
+
* taskDefinition: "arn:aws:ecs:us-east-1:012345678910:task-definition/ecs-demo:1"
|
|
539
|
+
* }
|
|
540
|
+
* ]
|
|
541
|
+
* }
|
|
542
|
+
* *\/
|
|
543
|
+
* ```
|
|
544
|
+
*
|
|
479
545
|
* @public
|
|
480
546
|
*/
|
|
481
547
|
export declare class DescribeServicesCommand extends DescribeServicesCommand_base {
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/core/client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import type { ECSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ECSClient";
|
|
4
|
-
import type { TagResourceRequest, TagResourceResponse } from "../models/
|
|
4
|
+
import type { TagResourceRequest, TagResourceResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -68,12 +68,17 @@ declare const UpdateServiceCommand_base: {
|
|
|
68
68
|
* bakeTimeInMinutes: Number("int"),
|
|
69
69
|
* lifecycleHooks: [ // DeploymentLifecycleHookList
|
|
70
70
|
* { // DeploymentLifecycleHook
|
|
71
|
+
* targetType: "AWS_LAMBDA" || "PAUSE",
|
|
71
72
|
* hookTargetArn: "STRING_VALUE",
|
|
72
73
|
* roleArn: "STRING_VALUE",
|
|
73
74
|
* lifecycleStages: [ // DeploymentLifecycleHookStageList
|
|
74
|
-
* "RECONCILE_SERVICE" || "PRE_SCALE_UP" || "POST_SCALE_UP" || "TEST_TRAFFIC_SHIFT" || "POST_TEST_TRAFFIC_SHIFT" || "PRODUCTION_TRAFFIC_SHIFT" || "POST_PRODUCTION_TRAFFIC_SHIFT",
|
|
75
|
+
* "RECONCILE_SERVICE" || "PRE_SCALE_UP" || "POST_SCALE_UP" || "TEST_TRAFFIC_SHIFT" || "POST_TEST_TRAFFIC_SHIFT" || "PRE_PRODUCTION_TRAFFIC_SHIFT" || "PRODUCTION_TRAFFIC_SHIFT" || "POST_PRODUCTION_TRAFFIC_SHIFT",
|
|
75
76
|
* ],
|
|
76
77
|
* hookDetails: "DOCUMENT_VALUE",
|
|
78
|
+
* timeoutConfiguration: { // DeploymentLifecycleHookTimeoutConfiguration
|
|
79
|
+
* timeoutInMinutes: Number("int"),
|
|
80
|
+
* action: "ROLLBACK" || "CONTINUE",
|
|
81
|
+
* },
|
|
77
82
|
* },
|
|
78
83
|
* ],
|
|
79
84
|
* linearConfiguration: { // LinearConfiguration
|
|
@@ -291,12 +296,17 @@ declare const UpdateServiceCommand_base: {
|
|
|
291
296
|
* // bakeTimeInMinutes: Number("int"),
|
|
292
297
|
* // lifecycleHooks: [ // DeploymentLifecycleHookList
|
|
293
298
|
* // { // DeploymentLifecycleHook
|
|
299
|
+
* // targetType: "AWS_LAMBDA" || "PAUSE",
|
|
294
300
|
* // hookTargetArn: "STRING_VALUE",
|
|
295
301
|
* // roleArn: "STRING_VALUE",
|
|
296
302
|
* // lifecycleStages: [ // DeploymentLifecycleHookStageList
|
|
297
|
-
* // "RECONCILE_SERVICE" || "PRE_SCALE_UP" || "POST_SCALE_UP" || "TEST_TRAFFIC_SHIFT" || "POST_TEST_TRAFFIC_SHIFT" || "PRODUCTION_TRAFFIC_SHIFT" || "POST_PRODUCTION_TRAFFIC_SHIFT",
|
|
303
|
+
* // "RECONCILE_SERVICE" || "PRE_SCALE_UP" || "POST_SCALE_UP" || "TEST_TRAFFIC_SHIFT" || "POST_TEST_TRAFFIC_SHIFT" || "PRE_PRODUCTION_TRAFFIC_SHIFT" || "PRODUCTION_TRAFFIC_SHIFT" || "POST_PRODUCTION_TRAFFIC_SHIFT",
|
|
298
304
|
* // ],
|
|
299
305
|
* // hookDetails: "DOCUMENT_VALUE",
|
|
306
|
+
* // timeoutConfiguration: { // DeploymentLifecycleHookTimeoutConfiguration
|
|
307
|
+
* // timeoutInMinutes: Number("int"),
|
|
308
|
+
* // action: "ROLLBACK" || "CONTINUE",
|
|
309
|
+
* // },
|
|
300
310
|
* // },
|
|
301
311
|
* // ],
|
|
302
312
|
* // linearConfiguration: { // LinearConfiguration
|
|
@@ -641,6 +651,34 @@ declare const UpdateServiceCommand_base: {
|
|
|
641
651
|
* *\/
|
|
642
652
|
* ```
|
|
643
653
|
*
|
|
654
|
+
* @example To update a service to add a pause lifecycle hook
|
|
655
|
+
* ```javascript
|
|
656
|
+
* // This example updates the my-blue-green-service service to add a pause lifecycle hook at the POST_PRODUCTION_TRAFFIC_SHIFT stage. The deployment will pause at that stage until you explicitly continue or roll back using the ContinueServiceDeployment API, or until the 30-minute timeout expires and triggers a continue.
|
|
657
|
+
* const input = {
|
|
658
|
+
* deploymentConfiguration: {
|
|
659
|
+
* lifecycleHooks: [
|
|
660
|
+
* {
|
|
661
|
+
* lifecycleStages: [
|
|
662
|
+
* "POST_PRODUCTION_TRAFFIC_SHIFT"
|
|
663
|
+
* ],
|
|
664
|
+
* targetType: "PAUSE",
|
|
665
|
+
* timeoutConfiguration: {
|
|
666
|
+
* action: "CONTINUE",
|
|
667
|
+
* timeoutInMinutes: 30
|
|
668
|
+
* }
|
|
669
|
+
* }
|
|
670
|
+
* ],
|
|
671
|
+
* strategy: "BLUE_GREEN"
|
|
672
|
+
* },
|
|
673
|
+
* service: "my-blue-green-service"
|
|
674
|
+
* };
|
|
675
|
+
* const command = new UpdateServiceCommand(input);
|
|
676
|
+
* const response = await client.send(command);
|
|
677
|
+
* /* response is
|
|
678
|
+
* { /* empty *\/ }
|
|
679
|
+
* *\/
|
|
680
|
+
* ```
|
|
681
|
+
*
|
|
644
682
|
* @public
|
|
645
683
|
*/
|
|
646
684
|
export declare class UpdateServiceCommand extends UpdateServiceCommand_base {
|
|
@@ -473,6 +473,18 @@ export declare const PlatformDeviceType: {
|
|
|
473
473
|
* @public
|
|
474
474
|
*/
|
|
475
475
|
export type PlatformDeviceType = (typeof PlatformDeviceType)[keyof typeof PlatformDeviceType];
|
|
476
|
+
/**
|
|
477
|
+
* @public
|
|
478
|
+
* @enum
|
|
479
|
+
*/
|
|
480
|
+
export declare const DeploymentLifecycleHookAction: {
|
|
481
|
+
readonly CONTINUE: "CONTINUE";
|
|
482
|
+
readonly ROLLBACK: "ROLLBACK";
|
|
483
|
+
};
|
|
484
|
+
/**
|
|
485
|
+
* @public
|
|
486
|
+
*/
|
|
487
|
+
export type DeploymentLifecycleHookAction = (typeof DeploymentLifecycleHookAction)[keyof typeof DeploymentLifecycleHookAction];
|
|
476
488
|
/**
|
|
477
489
|
* @public
|
|
478
490
|
* @enum
|
|
@@ -943,6 +955,7 @@ export declare const DeploymentLifecycleHookStage: {
|
|
|
943
955
|
readonly POST_PRODUCTION_TRAFFIC_SHIFT: "POST_PRODUCTION_TRAFFIC_SHIFT";
|
|
944
956
|
readonly POST_SCALE_UP: "POST_SCALE_UP";
|
|
945
957
|
readonly POST_TEST_TRAFFIC_SHIFT: "POST_TEST_TRAFFIC_SHIFT";
|
|
958
|
+
readonly PRE_PRODUCTION_TRAFFIC_SHIFT: "PRE_PRODUCTION_TRAFFIC_SHIFT";
|
|
946
959
|
readonly PRE_SCALE_UP: "PRE_SCALE_UP";
|
|
947
960
|
readonly PRODUCTION_TRAFFIC_SHIFT: "PRODUCTION_TRAFFIC_SHIFT";
|
|
948
961
|
readonly RECONCILE_SERVICE: "RECONCILE_SERVICE";
|
|
@@ -952,6 +965,18 @@ export declare const DeploymentLifecycleHookStage: {
|
|
|
952
965
|
* @public
|
|
953
966
|
*/
|
|
954
967
|
export type DeploymentLifecycleHookStage = (typeof DeploymentLifecycleHookStage)[keyof typeof DeploymentLifecycleHookStage];
|
|
968
|
+
/**
|
|
969
|
+
* @public
|
|
970
|
+
* @enum
|
|
971
|
+
*/
|
|
972
|
+
export declare const DeploymentLifecycleHookTargetType: {
|
|
973
|
+
readonly AWS_LAMBDA: "AWS_LAMBDA";
|
|
974
|
+
readonly PAUSE: "PAUSE";
|
|
975
|
+
};
|
|
976
|
+
/**
|
|
977
|
+
* @public
|
|
978
|
+
*/
|
|
979
|
+
export type DeploymentLifecycleHookTargetType = (typeof DeploymentLifecycleHookTargetType)[keyof typeof DeploymentLifecycleHookTargetType];
|
|
955
980
|
/**
|
|
956
981
|
* @public
|
|
957
982
|
* @enum
|
|
@@ -966,6 +991,21 @@ export declare const DeploymentStrategy: {
|
|
|
966
991
|
* @public
|
|
967
992
|
*/
|
|
968
993
|
export type DeploymentStrategy = (typeof DeploymentStrategy)[keyof typeof DeploymentStrategy];
|
|
994
|
+
/**
|
|
995
|
+
* @public
|
|
996
|
+
* @enum
|
|
997
|
+
*/
|
|
998
|
+
export declare const DeploymentLifecycleHookStatus: {
|
|
999
|
+
readonly AWAITING_ACTION: "AWAITING_ACTION";
|
|
1000
|
+
readonly FAILED: "FAILED";
|
|
1001
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
1002
|
+
readonly SUCCEEDED: "SUCCEEDED";
|
|
1003
|
+
readonly TIMED_OUT: "TIMED_OUT";
|
|
1004
|
+
};
|
|
1005
|
+
/**
|
|
1006
|
+
* @public
|
|
1007
|
+
*/
|
|
1008
|
+
export type DeploymentLifecycleHookStatus = (typeof DeploymentLifecycleHookStatus)[keyof typeof DeploymentLifecycleHookStatus];
|
|
969
1009
|
/**
|
|
970
1010
|
* @public
|
|
971
1011
|
* @enum
|
|
@@ -240,6 +240,18 @@ export declare class NoUpdateAvailableException extends __BaseException {
|
|
|
240
240
|
*/
|
|
241
241
|
constructor(opts: __ExceptionOptionType<NoUpdateAvailableException, __BaseException>);
|
|
242
242
|
}
|
|
243
|
+
/**
|
|
244
|
+
* <p>The service deploy ARN that you specified in the <code>StopServiceDeployment</code> doesn't exist. You can use <code>ListServiceDeployments</code> to retrieve the service deployment ARNs.</p>
|
|
245
|
+
* @public
|
|
246
|
+
*/
|
|
247
|
+
export declare class ServiceDeploymentNotFoundException extends __BaseException {
|
|
248
|
+
readonly name: "ServiceDeploymentNotFoundException";
|
|
249
|
+
readonly $fault: "client";
|
|
250
|
+
/**
|
|
251
|
+
* @internal
|
|
252
|
+
*/
|
|
253
|
+
constructor(opts: __ExceptionOptionType<ServiceDeploymentNotFoundException, __BaseException>);
|
|
254
|
+
}
|
|
243
255
|
/**
|
|
244
256
|
* <p>The specified platform version doesn't exist.</p>
|
|
245
257
|
* @public
|
|
@@ -329,18 +341,6 @@ export declare class ConflictException extends __BaseException {
|
|
|
329
341
|
*/
|
|
330
342
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
331
343
|
}
|
|
332
|
-
/**
|
|
333
|
-
* <p>The service deploy ARN that you specified in the <code>StopServiceDeployment</code> doesn't exist. You can use <code>ListServiceDeployments</code> to retrieve the service deployment ARNs.</p>
|
|
334
|
-
* @public
|
|
335
|
-
*/
|
|
336
|
-
export declare class ServiceDeploymentNotFoundException extends __BaseException {
|
|
337
|
-
readonly name: "ServiceDeploymentNotFoundException";
|
|
338
|
-
readonly $fault: "client";
|
|
339
|
-
/**
|
|
340
|
-
* @internal
|
|
341
|
-
*/
|
|
342
|
-
constructor(opts: __ExceptionOptionType<ServiceDeploymentNotFoundException, __BaseException>);
|
|
343
|
-
}
|
|
344
344
|
/**
|
|
345
345
|
* <p>The specified task set wasn't found. You can view your available task sets with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTaskSets.html">DescribeTaskSets</a>. Task sets are specific to each cluster, service and Region.</p>
|
|
346
346
|
* @public
|