@aws-sdk/client-ecs 3.693.0 → 3.695.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 +11 -12
- package/dist-cjs/index.js +4 -2
- package/dist-es/protocols/Aws_json1_1.js +2 -0
- package/dist-types/ECS.d.ts +11 -12
- package/dist-types/ECSClient.d.ts +11 -12
- package/dist-types/commands/CreateCapacityProviderCommand.d.ts +17 -22
- package/dist-types/commands/CreateClusterCommand.d.ts +17 -19
- package/dist-types/commands/CreateServiceCommand.d.ts +89 -80
- package/dist-types/commands/CreateTaskSetCommand.d.ts +15 -19
- package/dist-types/commands/DeleteAccountSettingCommand.d.ts +9 -12
- package/dist-types/commands/DeleteAttributesCommand.d.ts +2 -4
- package/dist-types/commands/DeleteCapacityProviderCommand.d.ts +17 -21
- package/dist-types/commands/DeleteClusterCommand.d.ts +23 -27
- package/dist-types/commands/DeleteServiceCommand.d.ts +30 -29
- package/dist-types/commands/DeleteTaskDefinitionsCommand.d.ts +23 -28
- package/dist-types/commands/DeleteTaskSetCommand.d.ts +14 -17
- package/dist-types/commands/DeregisterContainerInstanceCommand.d.ts +19 -22
- package/dist-types/commands/DeregisterTaskDefinitionCommand.d.ts +23 -26
- package/dist-types/commands/DescribeCapacityProvidersCommand.d.ts +8 -10
- package/dist-types/commands/DescribeClustersCommand.d.ts +8 -10
- package/dist-types/commands/DescribeContainerInstancesCommand.d.ts +10 -12
- package/dist-types/commands/DescribeServiceDeploymentsCommand.d.ts +9 -12
- package/dist-types/commands/DescribeServiceRevisionsCommand.d.ts +16 -12
- package/dist-types/commands/DescribeServicesCommand.d.ts +15 -10
- package/dist-types/commands/DescribeTaskDefinitionCommand.d.ts +13 -16
- package/dist-types/commands/DescribeTaskSetsCommand.d.ts +13 -17
- package/dist-types/commands/DescribeTasksCommand.d.ts +11 -13
- package/dist-types/commands/DiscoverPollEndpointCommand.d.ts +7 -8
- package/dist-types/commands/ExecuteCommandCommand.d.ts +19 -23
- package/dist-types/commands/GetTaskProtectionCommand.d.ts +8 -10
- package/dist-types/commands/ListAccountSettingsCommand.d.ts +8 -10
- package/dist-types/commands/ListAttributesCommand.d.ts +6 -8
- package/dist-types/commands/ListClustersCommand.d.ts +8 -10
- package/dist-types/commands/ListContainerInstancesCommand.d.ts +12 -13
- package/dist-types/commands/ListServiceDeploymentsCommand.d.ts +9 -12
- package/dist-types/commands/ListServicesByNamespaceCommand.d.ts +12 -15
- package/dist-types/commands/ListServicesCommand.d.ts +10 -12
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -10
- package/dist-types/commands/ListTaskDefinitionFamiliesCommand.d.ts +13 -17
- package/dist-types/commands/ListTaskDefinitionsCommand.d.ts +11 -13
- package/dist-types/commands/ListTasksCommand.d.ts +12 -15
- package/dist-types/commands/PutAccountSettingCommand.d.ts +11 -14
- package/dist-types/commands/PutAccountSettingDefaultCommand.d.ts +10 -12
- package/dist-types/commands/PutAttributesCommand.d.ts +7 -11
- package/dist-types/commands/PutClusterCapacityProvidersCommand.d.ts +24 -29
- package/dist-types/commands/RegisterContainerInstanceCommand.d.ts +10 -12
- package/dist-types/commands/RegisterTaskDefinitionCommand.d.ts +21 -23
- package/dist-types/commands/RunTaskCommand.d.ts +33 -37
- package/dist-types/commands/StartTaskCommand.d.ts +16 -16
- package/dist-types/commands/StopTaskCommand.d.ts +18 -22
- package/dist-types/commands/SubmitAttachmentStateChangesCommand.d.ts +8 -10
- package/dist-types/commands/SubmitContainerStateChangeCommand.d.ts +7 -8
- package/dist-types/commands/SubmitTaskStateChangeCommand.d.ts +8 -10
- package/dist-types/commands/TagResourceCommand.d.ts +11 -14
- package/dist-types/commands/UntagResourceCommand.d.ts +8 -10
- package/dist-types/commands/UpdateCapacityProviderCommand.d.ts +10 -11
- package/dist-types/commands/UpdateClusterCommand.d.ts +8 -10
- package/dist-types/commands/UpdateClusterSettingsCommand.d.ts +8 -10
- package/dist-types/commands/UpdateContainerAgentCommand.d.ts +33 -37
- package/dist-types/commands/UpdateContainerInstancesStateCommand.d.ts +42 -48
- package/dist-types/commands/UpdateServiceCommand.d.ts +105 -101
- package/dist-types/commands/UpdateServicePrimaryTaskSetCommand.d.ts +15 -20
- package/dist-types/commands/UpdateTaskProtectionCommand.d.ts +20 -25
- package/dist-types/commands/UpdateTaskSetCommand.d.ts +15 -19
- package/dist-types/index.d.ts +11 -12
- package/dist-types/models/models_0.d.ts +2860 -3324
- package/dist-types/models/models_1.d.ts +150 -152
- package/dist-types/ts3.4/commands/UpdateCapacityProviderCommand.d.ts +2 -4
- package/dist-types/ts3.4/models/models_0.d.ts +8 -3
- package/dist-types/ts3.4/models/models_1.d.ts +6 -0
- package/package.json +1 -1
|
@@ -27,10 +27,9 @@ declare const TagResourceCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Associates the specified tags to a resource with the specified
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* associated with that resource are deleted as well.</p>
|
|
30
|
+
* <p>Associates the specified tags to a resource with the specified <code>resourceArn</code>. If existing
|
|
31
|
+
* tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is
|
|
32
|
+
* deleted, the tags that are associated with that resource are deleted as well.</p>
|
|
34
33
|
* @example
|
|
35
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
35
|
* ```javascript
|
|
@@ -59,17 +58,16 @@ declare const TagResourceCommand_base: {
|
|
|
59
58
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
60
59
|
*
|
|
61
60
|
* @throws {@link ClientException} (client fault)
|
|
62
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
63
|
-
*
|
|
64
|
-
*
|
|
61
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or
|
|
62
|
+
* resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
|
|
63
|
+
* be specifying an identifier that isn't valid.</p>
|
|
65
64
|
* <p>The following list includes additional causes for the error:</p>
|
|
66
65
|
* <ul>
|
|
67
66
|
* <li>
|
|
68
|
-
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
69
|
-
*
|
|
70
|
-
*
|
|
71
|
-
*
|
|
72
|
-
* service quotas</a>.</p>
|
|
67
|
+
* <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
|
|
68
|
+
* a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
|
|
69
|
+
* been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service
|
|
70
|
+
* quotas</a>.</p>
|
|
73
71
|
* </li>
|
|
74
72
|
* </ul>
|
|
75
73
|
*
|
|
@@ -77,8 +75,7 @@ declare const TagResourceCommand_base: {
|
|
|
77
75
|
* <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>
|
|
78
76
|
*
|
|
79
77
|
* @throws {@link InvalidParameterException} (client fault)
|
|
80
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
81
|
-
* request.</p>
|
|
78
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
|
|
82
79
|
*
|
|
83
80
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
84
81
|
* <p>The specified resource wasn't found.</p>
|
|
@@ -53,17 +53,16 @@ declare const UntagResourceCommand_base: {
|
|
|
53
53
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
54
54
|
*
|
|
55
55
|
* @throws {@link ClientException} (client fault)
|
|
56
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
57
|
-
*
|
|
58
|
-
*
|
|
56
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or
|
|
57
|
+
* resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
|
|
58
|
+
* be specifying an identifier that isn't valid.</p>
|
|
59
59
|
* <p>The following list includes additional causes for the error:</p>
|
|
60
60
|
* <ul>
|
|
61
61
|
* <li>
|
|
62
|
-
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
63
|
-
*
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
* service quotas</a>.</p>
|
|
62
|
+
* <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
|
|
63
|
+
* a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
|
|
64
|
+
* been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service
|
|
65
|
+
* quotas</a>.</p>
|
|
67
66
|
* </li>
|
|
68
67
|
* </ul>
|
|
69
68
|
*
|
|
@@ -71,8 +70,7 @@ declare const UntagResourceCommand_base: {
|
|
|
71
70
|
* <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>
|
|
72
71
|
*
|
|
73
72
|
* @throws {@link InvalidParameterException} (client fault)
|
|
74
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
75
|
-
* request.</p>
|
|
73
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
|
|
76
74
|
*
|
|
77
75
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
78
76
|
* <p>The specified resource wasn't found.</p>
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
2
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import { ECSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ECSClient";
|
|
4
|
-
import { UpdateCapacityProviderRequest
|
|
4
|
+
import { UpdateCapacityProviderRequest } from "../models/models_0";
|
|
5
|
+
import { UpdateCapacityProviderResponse } from "../models/models_1";
|
|
5
6
|
/**
|
|
6
7
|
* @public
|
|
7
8
|
*/
|
|
@@ -87,23 +88,21 @@ declare const UpdateCapacityProviderCommand_base: {
|
|
|
87
88
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
88
89
|
*
|
|
89
90
|
* @throws {@link ClientException} (client fault)
|
|
90
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
91
|
-
*
|
|
92
|
-
*
|
|
91
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or
|
|
92
|
+
* resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
|
|
93
|
+
* be specifying an identifier that isn't valid.</p>
|
|
93
94
|
* <p>The following list includes additional causes for the error:</p>
|
|
94
95
|
* <ul>
|
|
95
96
|
* <li>
|
|
96
|
-
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
97
|
-
*
|
|
98
|
-
*
|
|
99
|
-
*
|
|
100
|
-
* service quotas</a>.</p>
|
|
97
|
+
* <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
|
|
98
|
+
* a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
|
|
99
|
+
* been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service
|
|
100
|
+
* quotas</a>.</p>
|
|
101
101
|
* </li>
|
|
102
102
|
* </ul>
|
|
103
103
|
*
|
|
104
104
|
* @throws {@link InvalidParameterException} (client fault)
|
|
105
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
106
|
-
* request.</p>
|
|
105
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
|
|
107
106
|
*
|
|
108
107
|
* @throws {@link ServerException} (server fault)
|
|
109
108
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -148,17 +148,16 @@ declare const UpdateClusterCommand_base: {
|
|
|
148
148
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
149
149
|
*
|
|
150
150
|
* @throws {@link ClientException} (client fault)
|
|
151
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
152
|
-
*
|
|
153
|
-
*
|
|
151
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or
|
|
152
|
+
* resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
|
|
153
|
+
* be specifying an identifier that isn't valid.</p>
|
|
154
154
|
* <p>The following list includes additional causes for the error:</p>
|
|
155
155
|
* <ul>
|
|
156
156
|
* <li>
|
|
157
|
-
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
158
|
-
*
|
|
159
|
-
*
|
|
160
|
-
*
|
|
161
|
-
* service quotas</a>.</p>
|
|
157
|
+
* <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
|
|
158
|
+
* a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
|
|
159
|
+
* been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service
|
|
160
|
+
* quotas</a>.</p>
|
|
162
161
|
* </li>
|
|
163
162
|
* </ul>
|
|
164
163
|
*
|
|
@@ -166,8 +165,7 @@ declare const UpdateClusterCommand_base: {
|
|
|
166
165
|
* <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>
|
|
167
166
|
*
|
|
168
167
|
* @throws {@link InvalidParameterException} (client fault)
|
|
169
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
170
|
-
* request.</p>
|
|
168
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
|
|
171
169
|
*
|
|
172
170
|
* @throws {@link NamespaceNotFoundException} (client fault)
|
|
173
171
|
* <p>The specified namespace wasn't found.</p>
|
|
@@ -128,17 +128,16 @@ declare const UpdateClusterSettingsCommand_base: {
|
|
|
128
128
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
129
129
|
*
|
|
130
130
|
* @throws {@link ClientException} (client fault)
|
|
131
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
132
|
-
*
|
|
133
|
-
*
|
|
131
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or
|
|
132
|
+
* resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
|
|
133
|
+
* be specifying an identifier that isn't valid.</p>
|
|
134
134
|
* <p>The following list includes additional causes for the error:</p>
|
|
135
135
|
* <ul>
|
|
136
136
|
* <li>
|
|
137
|
-
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
138
|
-
*
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
* service quotas</a>.</p>
|
|
137
|
+
* <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
|
|
138
|
+
* a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
|
|
139
|
+
* been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service
|
|
140
|
+
* quotas</a>.</p>
|
|
142
141
|
* </li>
|
|
143
142
|
* </ul>
|
|
144
143
|
*
|
|
@@ -146,8 +145,7 @@ declare const UpdateClusterSettingsCommand_base: {
|
|
|
146
145
|
* <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>
|
|
147
146
|
*
|
|
148
147
|
* @throws {@link InvalidParameterException} (client fault)
|
|
149
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
150
|
-
* request.</p>
|
|
148
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
|
|
151
149
|
*
|
|
152
150
|
* @throws {@link ServerException} (server fault)
|
|
153
151
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -27,25 +27,25 @@ declare const UpdateContainerAgentCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Updates the Amazon ECS container agent on a specified container instance. Updating the
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
30
|
+
* <p>Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container
|
|
31
|
+
* agent doesn't interrupt running tasks or services on the container instance. The process for updating
|
|
32
|
+
* the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized
|
|
33
|
+
* AMI or another operating system.</p>
|
|
34
34
|
* <note>
|
|
35
|
-
* <p>The <code>UpdateContainerAgent</code> API isn't supported for container instances
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
* Amazon ECS container agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
35
|
+
* <p>The <code>UpdateContainerAgent</code> API isn't supported for container instances using the
|
|
36
|
+
* Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent, you can update the
|
|
37
|
+
* <code>ecs-init</code> package. This updates the agent. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/agent-update-ecs-ami.html">Updating
|
|
38
|
+
* the Amazon ECS container agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
40
39
|
* </note>
|
|
41
40
|
* <note>
|
|
42
|
-
* <p>Agent updates with the <code>UpdateContainerAgent</code> API operation do not
|
|
43
|
-
*
|
|
44
|
-
*
|
|
41
|
+
* <p>Agent updates with the <code>UpdateContainerAgent</code> API operation do not apply to Windows
|
|
42
|
+
* container instances. We recommend that you launch new container instances to update the agent
|
|
43
|
+
* version in your Windows clusters.</p>
|
|
45
44
|
* </note>
|
|
46
|
-
* <p>The <code>UpdateContainerAgent</code> API requires an Amazon ECS-optimized AMI or Amazon
|
|
47
|
-
*
|
|
48
|
-
*
|
|
45
|
+
* <p>The <code>UpdateContainerAgent</code> API requires an Amazon ECS-optimized AMI or Amazon Linux AMI with
|
|
46
|
+
* the <code>ecs-init</code> service installed and running. For help updating the Amazon ECS container agent on
|
|
47
|
+
* other operating systems, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent">Manually updating
|
|
48
|
+
* the Amazon ECS container agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
49
49
|
* @example
|
|
50
50
|
* Use a bare-bones client and the command you need to make an API call.
|
|
51
51
|
* ```javascript
|
|
@@ -150,17 +150,16 @@ declare const UpdateContainerAgentCommand_base: {
|
|
|
150
150
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
151
151
|
*
|
|
152
152
|
* @throws {@link ClientException} (client fault)
|
|
153
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
154
|
-
*
|
|
155
|
-
*
|
|
153
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or
|
|
154
|
+
* resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
|
|
155
|
+
* be specifying an identifier that isn't valid.</p>
|
|
156
156
|
* <p>The following list includes additional causes for the error:</p>
|
|
157
157
|
* <ul>
|
|
158
158
|
* <li>
|
|
159
|
-
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
160
|
-
*
|
|
161
|
-
*
|
|
162
|
-
*
|
|
163
|
-
* service quotas</a>.</p>
|
|
159
|
+
* <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
|
|
160
|
+
* a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
|
|
161
|
+
* been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service
|
|
162
|
+
* quotas</a>.</p>
|
|
164
163
|
* </li>
|
|
165
164
|
* </ul>
|
|
166
165
|
*
|
|
@@ -168,29 +167,26 @@ declare const UpdateContainerAgentCommand_base: {
|
|
|
168
167
|
* <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>
|
|
169
168
|
*
|
|
170
169
|
* @throws {@link InvalidParameterException} (client fault)
|
|
171
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
172
|
-
* request.</p>
|
|
170
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
|
|
173
171
|
*
|
|
174
172
|
* @throws {@link MissingVersionException} (client fault)
|
|
175
|
-
* <p>Amazon ECS can't determine the current version of the Amazon ECS container agent on the
|
|
176
|
-
*
|
|
177
|
-
*
|
|
178
|
-
* version that doesn't use our version information.</p>
|
|
173
|
+
* <p>Amazon ECS can't determine the current version of the Amazon ECS container agent on the container instance and
|
|
174
|
+
* doesn't have enough information to proceed with an update. This could be because the agent running on
|
|
175
|
+
* the container instance is a previous or custom version that doesn't use our version information.</p>
|
|
179
176
|
*
|
|
180
177
|
* @throws {@link NoUpdateAvailableException} (client fault)
|
|
181
|
-
* <p>There's no update available for this Amazon ECS container agent. This might be because the
|
|
182
|
-
*
|
|
183
|
-
*
|
|
178
|
+
* <p>There's no update available for this Amazon ECS container agent. This might be because the agent is
|
|
179
|
+
* already running the latest version or because it's so old that there's no update path to the current
|
|
180
|
+
* version.</p>
|
|
184
181
|
*
|
|
185
182
|
* @throws {@link ServerException} (server fault)
|
|
186
183
|
* <p>These errors are usually caused by a server issue.</p>
|
|
187
184
|
*
|
|
188
185
|
* @throws {@link UpdateInProgressException} (client fault)
|
|
189
|
-
* <p>There's already a current Amazon ECS container agent update in progress on the container
|
|
190
|
-
*
|
|
191
|
-
*
|
|
192
|
-
*
|
|
193
|
-
* where it stopped previously.</p>
|
|
186
|
+
* <p>There's already a current Amazon ECS container agent update in progress on the container instance that's
|
|
187
|
+
* specified. If the container agent becomes disconnected while it's in a transitional stage, such as
|
|
188
|
+
* <code>PENDING</code> or <code>STAGING</code>, the update process can get stuck in that state.
|
|
189
|
+
* However, when the agent reconnects, it resumes where it stopped previously.</p>
|
|
194
190
|
*
|
|
195
191
|
* @throws {@link ECSServiceException}
|
|
196
192
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
@@ -28,54 +28,50 @@ declare const UpdateContainerInstancesStateCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Modifies the status of an Amazon ECS container instance.</p>
|
|
31
|
-
* <p>Once a container instance has reached an <code>ACTIVE</code> state, you can change the
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
* scale down the cluster size.</p>
|
|
31
|
+
* <p>Once a container instance has reached an <code>ACTIVE</code> state, you can change the status of a
|
|
32
|
+
* container instance to <code>DRAINING</code> to manually remove an instance from a cluster, for example
|
|
33
|
+
* to perform system updates, update the Docker daemon, or scale down the cluster size.</p>
|
|
35
34
|
* <important>
|
|
36
|
-
* <p>A container instance can't be changed to <code>DRAINING</code> until it has
|
|
37
|
-
*
|
|
38
|
-
*
|
|
35
|
+
* <p>A container instance can't be changed to <code>DRAINING</code> until it has reached an
|
|
36
|
+
* <code>ACTIVE</code> status. If the instance is in any other status, an error will be
|
|
37
|
+
* received.</p>
|
|
39
38
|
* </important>
|
|
40
|
-
* <p>When you set a container instance to <code>DRAINING</code>, Amazon ECS prevents new tasks
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
* the deployment configuration of your service using <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>.</p>
|
|
39
|
+
* <p>When you set a container instance to <code>DRAINING</code>, Amazon ECS prevents new tasks from being
|
|
40
|
+
* scheduled for placement on the container instance and replacement service tasks are started on other
|
|
41
|
+
* container instances in the cluster if the resources are available. Service tasks on the container
|
|
42
|
+
* instance that are in the <code>PENDING</code> state are stopped immediately.</p>
|
|
43
|
+
* <p>Service tasks on the container instance that are in the <code>RUNNING</code> state are stopped and
|
|
44
|
+
* replaced according to the service's deployment configuration parameters,
|
|
45
|
+
* <code>minimumHealthyPercent</code> and <code>maximumPercent</code>. You can change the deployment
|
|
46
|
+
* configuration of your service using <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_UpdateService.html">UpdateService</a>.</p>
|
|
49
47
|
* <ul>
|
|
50
48
|
* <li>
|
|
51
49
|
* <p>If <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore
|
|
52
50
|
* <code>desiredCount</code> temporarily during task replacement. For example,
|
|
53
|
-
* <code>desiredCount</code> is four tasks, a minimum of 50% allows the
|
|
54
|
-
*
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
*
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
* load balancer.</p>
|
|
51
|
+
* <code>desiredCount</code> is four tasks, a minimum of 50% allows the scheduler to stop two
|
|
52
|
+
* existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler
|
|
53
|
+
* can't remove existing tasks until the replacement tasks are considered healthy. Tasks for
|
|
54
|
+
* services that do not use a load balancer are considered healthy if they're in the
|
|
55
|
+
* <code>RUNNING</code> state. Tasks for services that use a load balancer are considered
|
|
56
|
+
* healthy if they're in the <code>RUNNING</code> state and are reported as healthy by the load
|
|
57
|
+
* balancer.</p>
|
|
61
58
|
* </li>
|
|
62
59
|
* <li>
|
|
63
|
-
* <p>The <code>maximumPercent</code> parameter represents an upper limit on the
|
|
64
|
-
*
|
|
65
|
-
*
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
*
|
|
69
|
-
* tasks have stopped.</p>
|
|
60
|
+
* <p>The <code>maximumPercent</code> parameter represents an upper limit on the number of running
|
|
61
|
+
* tasks during task replacement. You can use this to define the replacement batch size. For
|
|
62
|
+
* example, if <code>desiredCount</code> is four tasks, a maximum of 200% starts four new tasks
|
|
63
|
+
* before stopping the four tasks to be drained, provided that the cluster resources required to
|
|
64
|
+
* do this are available. If the maximum is 100%, then replacement tasks can't start until the
|
|
65
|
+
* draining tasks have stopped.</p>
|
|
70
66
|
* </li>
|
|
71
67
|
* </ul>
|
|
72
|
-
* <p>Any <code>PENDING</code> or <code>RUNNING</code> tasks that do not belong to a service
|
|
73
|
-
*
|
|
74
|
-
* <p>A container instance has completed draining when it has no more <code>RUNNING</code>
|
|
75
|
-
*
|
|
76
|
-
* <p>When a container instance has been drained, you can set a container instance to
|
|
77
|
-
*
|
|
78
|
-
*
|
|
68
|
+
* <p>Any <code>PENDING</code> or <code>RUNNING</code> tasks that do not belong to a service aren't
|
|
69
|
+
* affected. You must wait for them to finish or stop them manually.</p>
|
|
70
|
+
* <p>A container instance has completed draining when it has no more <code>RUNNING</code> tasks. You can
|
|
71
|
+
* verify this using <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListTasks.html">ListTasks</a>.</p>
|
|
72
|
+
* <p>When a container instance has been drained, you can set a container instance to <code>ACTIVE</code>
|
|
73
|
+
* status and once it has reached that status the Amazon ECS scheduler can begin scheduling tasks on the
|
|
74
|
+
* instance again.</p>
|
|
79
75
|
* @example
|
|
80
76
|
* Use a bare-bones client and the command you need to make an API call.
|
|
81
77
|
* ```javascript
|
|
@@ -192,17 +188,16 @@ declare const UpdateContainerInstancesStateCommand_base: {
|
|
|
192
188
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
193
189
|
*
|
|
194
190
|
* @throws {@link ClientException} (client fault)
|
|
195
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
196
|
-
*
|
|
197
|
-
*
|
|
191
|
+
* <p>These errors are usually caused by a client action. This client action might be using an action or
|
|
192
|
+
* resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might
|
|
193
|
+
* be specifying an identifier that isn't valid.</p>
|
|
198
194
|
* <p>The following list includes additional causes for the error:</p>
|
|
199
195
|
* <ul>
|
|
200
196
|
* <li>
|
|
201
|
-
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
202
|
-
*
|
|
203
|
-
*
|
|
204
|
-
*
|
|
205
|
-
* service quotas</a>.</p>
|
|
197
|
+
* <p>The <code>RunTask</code> could not be processed because you use managed scaling and there is
|
|
198
|
+
* a capacity error because the quota of tasks in the <code>PROVISIONING</code> per cluster has
|
|
199
|
+
* been reached. For information about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS service
|
|
200
|
+
* quotas</a>.</p>
|
|
206
201
|
* </li>
|
|
207
202
|
* </ul>
|
|
208
203
|
*
|
|
@@ -210,8 +205,7 @@ declare const UpdateContainerInstancesStateCommand_base: {
|
|
|
210
205
|
* <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>
|
|
211
206
|
*
|
|
212
207
|
* @throws {@link InvalidParameterException} (client fault)
|
|
213
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
214
|
-
* request.</p>
|
|
208
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
|
|
215
209
|
*
|
|
216
210
|
* @throws {@link ServerException} (server fault)
|
|
217
211
|
* <p>These errors are usually caused by a server issue.</p>
|