@aws-sdk/client-ecs 3.51.0 → 3.54.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/CHANGELOG.md +30 -0
- package/dist-cjs/index.js +3 -0
- package/dist-cjs/models/ECSServiceException.js +11 -0
- package/dist-cjs/models/models_0.js +320 -5
- package/dist-cjs/protocols/Aws_json1_1.js +638 -2138
- package/dist-es/index.js +1 -0
- package/dist-es/models/ECSServiceException.js +12 -0
- package/dist-es/models/models_0.js +291 -1
- package/dist-es/protocols/Aws_json1_1.js +1295 -2302
- package/dist-types/ECS.d.ts +40 -21
- package/dist-types/ECSClient.d.ts +2 -2
- package/dist-types/commands/CreateServiceCommand.d.ts +1 -2
- package/dist-types/commands/PutAccountSettingCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContainerInstancesStateCommand.d.ts +1 -2
- package/dist-types/commands/UpdateServiceCommand.d.ts +37 -16
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/ECSServiceException.d.ts +10 -0
- package/dist-types/models/models_0.d.ts +292 -144
- 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/ts3.4/ECSClient.d.ts +2 -2
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/ECSServiceException.d.ts +6 -0
- package/dist-types/ts3.4/models/models_0.d.ts +131 -97
- 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/package.json +34 -34
package/dist-types/ECS.d.ts
CHANGED
|
@@ -109,8 +109,7 @@ export declare class ECS extends ECSClient {
|
|
|
109
109
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
110
110
|
* <p>Tasks for services that don't use a load balancer are considered healthy if they're in
|
|
111
111
|
* the <code>RUNNING</code> state. Tasks for services that use a load balancer are
|
|
112
|
-
* considered healthy if they're in the <code>RUNNING</code> state and the
|
|
113
|
-
* instance that they're hosted on is reported as healthy by the load balancer.</p>
|
|
112
|
+
* considered healthy if they're in the <code>RUNNING</code> state and are reported as healthy by the load balancer.</p>
|
|
114
113
|
* <p>There are two service scheduler strategies available:</p>
|
|
115
114
|
* <ul>
|
|
116
115
|
* <li>
|
|
@@ -490,7 +489,7 @@ export declare class ECS extends ECSClient {
|
|
|
490
489
|
* the root user for an account is affected. The opt-in and opt-out account setting must be
|
|
491
490
|
* set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is
|
|
492
491
|
* defined by the opt-in status of the IAM user or role that created the resource. You must
|
|
493
|
-
*
|
|
492
|
+
* turn on this setting to use Amazon ECS features such as resource tagging.</p>
|
|
494
493
|
* <p>When <code>awsvpcTrunking</code> is specified, the elastic network interface (ENI)
|
|
495
494
|
* limit for any new container instances that support the feature is changed. If
|
|
496
495
|
* <code>awsvpcTrunking</code> is enabled, any new container instances that support the
|
|
@@ -750,8 +749,7 @@ export declare class ECS extends ECSClient {
|
|
|
750
749
|
* replacement tasks are considered healthy. Tasks for services that do not use a
|
|
751
750
|
* load balancer are considered healthy if they're in the <code>RUNNING</code>
|
|
752
751
|
* state. Tasks for services that use a load balancer are considered healthy if
|
|
753
|
-
* they're in the <code>RUNNING</code> state and the
|
|
754
|
-
* hosted on is reported as healthy by the load balancer.</p>
|
|
752
|
+
* they're in the <code>RUNNING</code> state and are reported as healthy by the load balancer..</p>
|
|
755
753
|
* </li>
|
|
756
754
|
* <li>
|
|
757
755
|
* <p>The <code>maximumPercent</code> parameter represents an upper limit on the
|
|
@@ -782,19 +780,21 @@ export declare class ECS extends ECSClient {
|
|
|
782
780
|
* apply to your participation in this preview.</p>
|
|
783
781
|
* </important>
|
|
784
782
|
* <p>Modifies the parameters of a service.</p>
|
|
785
|
-
* <p>For services using the rolling update (<code>ECS</code>)
|
|
786
|
-
*
|
|
787
|
-
*
|
|
788
|
-
*
|
|
789
|
-
*
|
|
790
|
-
*
|
|
791
|
-
*
|
|
792
|
-
*
|
|
793
|
-
*
|
|
794
|
-
*
|
|
795
|
-
*
|
|
796
|
-
* task
|
|
797
|
-
*
|
|
783
|
+
* <p>For services using the rolling update (<code>ECS</code>) you can update the desired count,
|
|
784
|
+
* the deployment configuration, the network configuration, load balancers, service
|
|
785
|
+
* registries, enable ECS managed tags option, propagate tags option, task placement
|
|
786
|
+
* constraints and strategies, and the task definition. When you update any of these
|
|
787
|
+
* parameters, Amazon ECS starts new tasks with the new configuration. </p>
|
|
788
|
+
* <p>For services using the blue/green (<code>CODE_DEPLOY</code>) deployment controller, only the
|
|
789
|
+
* desired count, deployment configuration, task placement constraints and strategies,
|
|
790
|
+
* enable ECS managed tags option, and propagate tags can be updated using this API. If the
|
|
791
|
+
* network configuration, platform version, task definition, or load balancer need to be
|
|
792
|
+
* updated, create a new CodeDeploy deployment. For more information, see <a href="https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html">CreateDeployment</a> in the <i>CodeDeploy API Reference</i>.</p>
|
|
793
|
+
* <p>For services using an external deployment controller, you can update only the desired count,
|
|
794
|
+
* task placement constraints and strategies, health check grace period, enable ECS managed
|
|
795
|
+
* tags option, and propagate tags option, using this API. If the launch type, load
|
|
796
|
+
* balancer, network configuration, platform version, or task definition need to be
|
|
797
|
+
* updated, create a new task set For more information, see <a>CreateTaskSet</a>.</p>
|
|
798
798
|
* <p>You can add to or subtract from the number of instantiations of a task definition in a
|
|
799
799
|
* service by specifying the cluster that the service is running in and a new
|
|
800
800
|
* <code>desiredCount</code> parameter.</p>
|
|
@@ -822,9 +822,8 @@ export declare class ECS extends ECSClient {
|
|
|
822
822
|
* scheduler to stop two existing tasks before starting two new tasks. Tasks for
|
|
823
823
|
* services that don't use a load balancer are considered healthy if they're in the
|
|
824
824
|
* <code>RUNNING</code> state. Tasks for services that use a load balancer are
|
|
825
|
-
* considered healthy if they're in the <code>RUNNING</code> state and
|
|
826
|
-
*
|
|
827
|
-
* balancer.</p>
|
|
825
|
+
* considered healthy if they're in the <code>RUNNING</code> state and are reported
|
|
826
|
+
* as healthy by the load balancer.</p>
|
|
828
827
|
* </li>
|
|
829
828
|
* <li>
|
|
830
829
|
* <p>The <code>maximumPercent</code> parameter represents an upper limit on the
|
|
@@ -869,6 +868,7 @@ export declare class ECS extends ECSClient {
|
|
|
869
868
|
* </ul>
|
|
870
869
|
* </li>
|
|
871
870
|
* </ul>
|
|
871
|
+
*
|
|
872
872
|
* <p>When the service scheduler stops running tasks, it attempts to maintain balance across
|
|
873
873
|
* the Availability Zones in your cluster using the following logic: </p>
|
|
874
874
|
* <ul>
|
|
@@ -884,6 +884,25 @@ export declare class ECS extends ECSClient {
|
|
|
884
884
|
* running tasks for this service.</p>
|
|
885
885
|
* </li>
|
|
886
886
|
* </ul>
|
|
887
|
+
* <note>
|
|
888
|
+
* <p>You must have a service-linked role when you update any of the following service properties.
|
|
889
|
+
* If you specified a custom IAM role when you created the service, Amazon ECS automatically
|
|
890
|
+
* replaces the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Service.html#ECS-Type-Service-roleArn">roleARN</a> associated with the service with the ARN of your service-linked
|
|
891
|
+
* role. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Service-linked
|
|
892
|
+
* roles</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
893
|
+
* <ul>
|
|
894
|
+
* <li>
|
|
895
|
+
* <p>
|
|
896
|
+
* <code>loadBalancers,</code>
|
|
897
|
+
* </p>
|
|
898
|
+
* </li>
|
|
899
|
+
* <li>
|
|
900
|
+
* <p>
|
|
901
|
+
* <code>serviceRegistries</code>
|
|
902
|
+
* </p>
|
|
903
|
+
* </li>
|
|
904
|
+
* </ul>
|
|
905
|
+
* </note>
|
|
887
906
|
*/
|
|
888
907
|
updateService(args: UpdateServiceCommandInput, options?: __HttpHandlerOptions): Promise<UpdateServiceCommandOutput>;
|
|
889
908
|
updateService(args: UpdateServiceCommandInput, cb: (err: any, data?: UpdateServiceCommandOutput) => void): void;
|
|
@@ -5,7 +5,7 @@ import { AwsAuthInputConfig, AwsAuthResolvedConfig } from "@aws-sdk/middleware-s
|
|
|
5
5
|
import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
|
|
6
6
|
import { HttpHandler as __HttpHandler } from "@aws-sdk/protocol-http";
|
|
7
7
|
import { Client as __Client, DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
|
|
8
|
-
import { Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
|
|
8
|
+
import { BodyLengthCalculator as __BodyLengthCalculator, Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
|
|
9
9
|
import { CreateCapacityProviderCommandInput, CreateCapacityProviderCommandOutput } from "./commands/CreateCapacityProviderCommand";
|
|
10
10
|
import { CreateClusterCommandInput, CreateClusterCommandOutput } from "./commands/CreateClusterCommand";
|
|
11
11
|
import { CreateServiceCommandInput, CreateServiceCommandOutput } from "./commands/CreateServiceCommand";
|
|
@@ -80,7 +80,7 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
80
80
|
* A function that can calculate the length of a request body.
|
|
81
81
|
* @internal
|
|
82
82
|
*/
|
|
83
|
-
bodyLengthChecker?:
|
|
83
|
+
bodyLengthChecker?: __BodyLengthCalculator;
|
|
84
84
|
/**
|
|
85
85
|
* A function that converts a stream into an array of bytes.
|
|
86
86
|
* @internal
|
|
@@ -18,8 +18,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
|
|
|
18
18
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
19
19
|
* <p>Tasks for services that don't use a load balancer are considered healthy if they're in
|
|
20
20
|
* the <code>RUNNING</code> state. Tasks for services that use a load balancer are
|
|
21
|
-
* considered healthy if they're in the <code>RUNNING</code> state and the
|
|
22
|
-
* instance that they're hosted on is reported as healthy by the load balancer.</p>
|
|
21
|
+
* considered healthy if they're in the <code>RUNNING</code> state and are reported as healthy by the load balancer.</p>
|
|
23
22
|
* <p>There are two service scheduler strategies available:</p>
|
|
24
23
|
* <ul>
|
|
25
24
|
* <li>
|
|
@@ -18,7 +18,7 @@ export interface PutAccountSettingCommandOutput extends PutAccountSettingRespons
|
|
|
18
18
|
* the root user for an account is affected. The opt-in and opt-out account setting must be
|
|
19
19
|
* set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is
|
|
20
20
|
* defined by the opt-in status of the IAM user or role that created the resource. You must
|
|
21
|
-
*
|
|
21
|
+
* turn on this setting to use Amazon ECS features such as resource tagging.</p>
|
|
22
22
|
* <p>When <code>awsvpcTrunking</code> is specified, the elastic network interface (ENI)
|
|
23
23
|
* limit for any new container instances that support the feature is changed. If
|
|
24
24
|
* <code>awsvpcTrunking</code> is enabled, any new container instances that support the
|
|
@@ -36,8 +36,7 @@ export interface UpdateContainerInstancesStateCommandOutput extends UpdateContai
|
|
|
36
36
|
* replacement tasks are considered healthy. Tasks for services that do not use a
|
|
37
37
|
* load balancer are considered healthy if they're in the <code>RUNNING</code>
|
|
38
38
|
* state. Tasks for services that use a load balancer are considered healthy if
|
|
39
|
-
* they're in the <code>RUNNING</code> state and the
|
|
40
|
-
* hosted on is reported as healthy by the load balancer.</p>
|
|
39
|
+
* they're in the <code>RUNNING</code> state and are reported as healthy by the load balancer..</p>
|
|
41
40
|
* </li>
|
|
42
41
|
* <li>
|
|
43
42
|
* <p>The <code>maximumPercent</code> parameter represents an upper limit on the
|
|
@@ -14,19 +14,21 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met
|
|
|
14
14
|
* apply to your participation in this preview.</p>
|
|
15
15
|
* </important>
|
|
16
16
|
* <p>Modifies the parameters of a service.</p>
|
|
17
|
-
* <p>For services using the rolling update (<code>ECS</code>)
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
* task
|
|
29
|
-
*
|
|
17
|
+
* <p>For services using the rolling update (<code>ECS</code>) you can update the desired count,
|
|
18
|
+
* the deployment configuration, the network configuration, load balancers, service
|
|
19
|
+
* registries, enable ECS managed tags option, propagate tags option, task placement
|
|
20
|
+
* constraints and strategies, and the task definition. When you update any of these
|
|
21
|
+
* parameters, Amazon ECS starts new tasks with the new configuration. </p>
|
|
22
|
+
* <p>For services using the blue/green (<code>CODE_DEPLOY</code>) deployment controller, only the
|
|
23
|
+
* desired count, deployment configuration, task placement constraints and strategies,
|
|
24
|
+
* enable ECS managed tags option, and propagate tags can be updated using this API. If the
|
|
25
|
+
* network configuration, platform version, task definition, or load balancer need to be
|
|
26
|
+
* updated, create a new CodeDeploy deployment. For more information, see <a href="https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html">CreateDeployment</a> in the <i>CodeDeploy API Reference</i>.</p>
|
|
27
|
+
* <p>For services using an external deployment controller, you can update only the desired count,
|
|
28
|
+
* task placement constraints and strategies, health check grace period, enable ECS managed
|
|
29
|
+
* tags option, and propagate tags option, using this API. If the launch type, load
|
|
30
|
+
* balancer, network configuration, platform version, or task definition need to be
|
|
31
|
+
* updated, create a new task set For more information, see <a>CreateTaskSet</a>.</p>
|
|
30
32
|
* <p>You can add to or subtract from the number of instantiations of a task definition in a
|
|
31
33
|
* service by specifying the cluster that the service is running in and a new
|
|
32
34
|
* <code>desiredCount</code> parameter.</p>
|
|
@@ -54,9 +56,8 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met
|
|
|
54
56
|
* scheduler to stop two existing tasks before starting two new tasks. Tasks for
|
|
55
57
|
* services that don't use a load balancer are considered healthy if they're in the
|
|
56
58
|
* <code>RUNNING</code> state. Tasks for services that use a load balancer are
|
|
57
|
-
* considered healthy if they're in the <code>RUNNING</code> state and
|
|
58
|
-
*
|
|
59
|
-
* balancer.</p>
|
|
59
|
+
* considered healthy if they're in the <code>RUNNING</code> state and are reported
|
|
60
|
+
* as healthy by the load balancer.</p>
|
|
60
61
|
* </li>
|
|
61
62
|
* <li>
|
|
62
63
|
* <p>The <code>maximumPercent</code> parameter represents an upper limit on the
|
|
@@ -101,6 +102,7 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met
|
|
|
101
102
|
* </ul>
|
|
102
103
|
* </li>
|
|
103
104
|
* </ul>
|
|
105
|
+
*
|
|
104
106
|
* <p>When the service scheduler stops running tasks, it attempts to maintain balance across
|
|
105
107
|
* the Availability Zones in your cluster using the following logic: </p>
|
|
106
108
|
* <ul>
|
|
@@ -116,6 +118,25 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met
|
|
|
116
118
|
* running tasks for this service.</p>
|
|
117
119
|
* </li>
|
|
118
120
|
* </ul>
|
|
121
|
+
* <note>
|
|
122
|
+
* <p>You must have a service-linked role when you update any of the following service properties.
|
|
123
|
+
* If you specified a custom IAM role when you created the service, Amazon ECS automatically
|
|
124
|
+
* replaces the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Service.html#ECS-Type-Service-roleArn">roleARN</a> associated with the service with the ARN of your service-linked
|
|
125
|
+
* role. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Service-linked
|
|
126
|
+
* roles</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
127
|
+
* <ul>
|
|
128
|
+
* <li>
|
|
129
|
+
* <p>
|
|
130
|
+
* <code>loadBalancers,</code>
|
|
131
|
+
* </p>
|
|
132
|
+
* </li>
|
|
133
|
+
* <li>
|
|
134
|
+
* <p>
|
|
135
|
+
* <code>serviceRegistries</code>
|
|
136
|
+
* </p>
|
|
137
|
+
* </li>
|
|
138
|
+
* </ul>
|
|
139
|
+
* </note>
|
|
119
140
|
* @example
|
|
120
141
|
* Use a bare-bones client and the command you need to make an API call.
|
|
121
142
|
* ```javascript
|
package/dist-types/index.d.ts
CHANGED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
|
|
2
|
+
/**
|
|
3
|
+
* Base exception class for all service exceptions from ECS service.
|
|
4
|
+
*/
|
|
5
|
+
export declare class ECSServiceException extends __ServiceException {
|
|
6
|
+
/**
|
|
7
|
+
* @internal
|
|
8
|
+
*/
|
|
9
|
+
constructor(options: __ServiceExceptionOptions);
|
|
10
|
+
}
|