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