@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
|
@@ -27,18 +27,20 @@ declare const PutClusterCapacityProvidersCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Modifies the available capacity providers and the default capacity provider strategy
|
|
31
|
-
* cluster.</p>
|
|
32
|
-
* <p>You must specify both the available capacity providers and a default capacity provider
|
|
33
|
-
* the cluster. If the specified cluster has existing capacity providers
|
|
34
|
-
* specify all existing capacity providers in addition to any
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
30
|
+
* <p>Modifies the available capacity providers and the default capacity provider strategy
|
|
31
|
+
* for a cluster.</p>
|
|
32
|
+
* <p>You must specify both the available capacity providers and a default capacity provider
|
|
33
|
+
* strategy for the cluster. If the specified cluster has existing capacity providers
|
|
34
|
+
* associated with it, you must specify all existing capacity providers in addition to any
|
|
35
|
+
* new ones you want to add. Any existing capacity providers that are associated with a
|
|
36
|
+
* cluster that are omitted from a <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html">PutClusterCapacityProviders</a> API call will be disassociated with the
|
|
37
|
+
* cluster. You can only disassociate an existing capacity provider from a cluster if it's
|
|
38
|
+
* not being used by any existing tasks.</p>
|
|
39
|
+
* <p>When creating a service or running a task on a cluster, if no capacity provider or
|
|
40
|
+
* launch type is specified, then the cluster's default capacity provider strategy is used.
|
|
41
|
+
* We recommend that you define a default capacity provider strategy for your cluster.
|
|
42
|
+
* However, you must specify an empty array (<code>[]</code>) to bypass defining a default
|
|
43
|
+
* strategy.</p>
|
|
42
44
|
* @example
|
|
43
45
|
* Use a bare-bones client and the command you need to make an API call.
|
|
44
46
|
* ```javascript
|
|
@@ -143,16 +145,17 @@ declare const PutClusterCapacityProvidersCommand_base: {
|
|
|
143
145
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
144
146
|
*
|
|
145
147
|
* @throws {@link ClientException} (client fault)
|
|
146
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
147
|
-
* resource on behalf of a user that doesn't have permissions to use the
|
|
148
|
-
* be specifying an identifier that isn't valid.</p>
|
|
148
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
149
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
150
|
+
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
149
151
|
* <p>The following list includes additional causes for the error:</p>
|
|
150
152
|
* <ul>
|
|
151
153
|
* <li>
|
|
152
|
-
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
153
|
-
* a capacity error because the quota of tasks in the
|
|
154
|
-
*
|
|
155
|
-
*
|
|
154
|
+
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
155
|
+
* scaling and there is a capacity error because the quota of tasks in the
|
|
156
|
+
* <code>PROVISIONING</code> per cluster has been reached. For information
|
|
157
|
+
* about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
|
|
158
|
+
* service quotas</a>.</p>
|
|
156
159
|
* </li>
|
|
157
160
|
* </ul>
|
|
158
161
|
*
|
|
@@ -160,7 +163,8 @@ declare const PutClusterCapacityProvidersCommand_base: {
|
|
|
160
163
|
* <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>
|
|
161
164
|
*
|
|
162
165
|
* @throws {@link InvalidParameterException} (client fault)
|
|
163
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
166
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
167
|
+
* request.</p>
|
|
164
168
|
*
|
|
165
169
|
* @throws {@link ResourceInUseException} (client fault)
|
|
166
170
|
* <p>The specified resource is in-use and can't be removed.</p>
|
|
@@ -169,10 +173,11 @@ declare const PutClusterCapacityProvidersCommand_base: {
|
|
|
169
173
|
* <p>These errors are usually caused by a server issue.</p>
|
|
170
174
|
*
|
|
171
175
|
* @throws {@link UpdateInProgressException} (client fault)
|
|
172
|
-
* <p>There's already a current Amazon ECS container agent update in progress on the container
|
|
173
|
-
* specified. If the container agent becomes disconnected while it's in a
|
|
174
|
-
*
|
|
175
|
-
* However, when the agent reconnects, it resumes
|
|
176
|
+
* <p>There's already a current Amazon ECS container agent update in progress on the container
|
|
177
|
+
* instance that's specified. If the container agent becomes disconnected while it's in a
|
|
178
|
+
* transitional stage, such as <code>PENDING</code> or <code>STAGING</code>, the update
|
|
179
|
+
* process can get stuck in that state. However, when the agent reconnects, it resumes
|
|
180
|
+
* where it stopped previously.</p>
|
|
176
181
|
*
|
|
177
182
|
* @throws {@link ECSServiceException}
|
|
178
183
|
* <p>Base exception class for all service exceptions from ECS service.</p>
|
|
@@ -30,8 +30,8 @@ declare const RegisterContainerInstanceCommand_base: {
|
|
|
30
30
|
* <note>
|
|
31
31
|
* <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p>
|
|
32
32
|
* </note>
|
|
33
|
-
* <p>Registers an EC2 instance into the specified cluster. This instance becomes available
|
|
34
|
-
* containers on.</p>
|
|
33
|
+
* <p>Registers an EC2 instance into the specified cluster. This instance becomes available
|
|
34
|
+
* to place containers on.</p>
|
|
35
35
|
* @example
|
|
36
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
37
|
* ```javascript
|
|
@@ -175,21 +175,23 @@ declare const RegisterContainerInstanceCommand_base: {
|
|
|
175
175
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
176
176
|
*
|
|
177
177
|
* @throws {@link ClientException} (client fault)
|
|
178
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
179
|
-
* resource on behalf of a user that doesn't have permissions to use the
|
|
180
|
-
* be specifying an identifier that isn't valid.</p>
|
|
178
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
179
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
180
|
+
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
181
181
|
* <p>The following list includes additional causes for the error:</p>
|
|
182
182
|
* <ul>
|
|
183
183
|
* <li>
|
|
184
|
-
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
185
|
-
* a capacity error because the quota of tasks in the
|
|
186
|
-
*
|
|
187
|
-
*
|
|
184
|
+
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
185
|
+
* scaling and there is a capacity error because the quota of tasks in the
|
|
186
|
+
* <code>PROVISIONING</code> per cluster has been reached. For information
|
|
187
|
+
* about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
|
|
188
|
+
* service quotas</a>.</p>
|
|
188
189
|
* </li>
|
|
189
190
|
* </ul>
|
|
190
191
|
*
|
|
191
192
|
* @throws {@link InvalidParameterException} (client fault)
|
|
192
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
193
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
194
|
+
* request.</p>
|
|
193
195
|
*
|
|
194
196
|
* @throws {@link ServerException} (server fault)
|
|
195
197
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -28,20 +28,21 @@ declare const RegisterTaskDefinitionCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Registers a new task definition from the supplied <code>family</code> and
|
|
31
|
-
* <code>containerDefinitions</code>. Optionally, you can add data volumes to your
|
|
32
|
-
*
|
|
33
|
-
* see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html">Amazon ECS Task
|
|
31
|
+
* <code>containerDefinitions</code>. Optionally, you can add data volumes to your
|
|
32
|
+
* containers with the <code>volumes</code> parameter. For more information about task
|
|
33
|
+
* definition parameters and defaults, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html">Amazon ECS Task
|
|
34
34
|
* Definitions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
35
|
-
* <p>You can specify a role for your task with the <code>taskRoleArn</code> parameter. When
|
|
36
|
-
* role for a task, its containers can then use the latest versions of the
|
|
37
|
-
* requests to the Amazon Web Services services that are specified in the
|
|
38
|
-
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html">IAM
|
|
39
|
-
*
|
|
40
|
-
* <p>You can specify a Docker networking mode for the containers in your task definition
|
|
41
|
-
*
|
|
42
|
-
* is allocated an elastic network interface, and you must specify a
|
|
43
|
-
*
|
|
44
|
-
*
|
|
35
|
+
* <p>You can specify a role for your task with the <code>taskRoleArn</code> parameter. When
|
|
36
|
+
* you specify a role for a task, its containers can then use the latest versions of the
|
|
37
|
+
* CLI or SDKs to make API requests to the Amazon Web Services services that are specified in the
|
|
38
|
+
* policy that's associated with the role. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html">IAM
|
|
39
|
+
* Roles for Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
40
|
+
* <p>You can specify a Docker networking mode for the containers in your task definition
|
|
41
|
+
* with the <code>networkMode</code> parameter. If you specify the <code>awsvpc</code>
|
|
42
|
+
* network mode, the task is allocated an elastic network interface, and you must specify a
|
|
43
|
+
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_NetworkConfiguration.html">NetworkConfiguration</a> when you create a service or run a task with the task
|
|
44
|
+
* definition. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html">Task Networking</a>
|
|
45
|
+
* in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
45
46
|
* @example
|
|
46
47
|
* Use a bare-bones client and the command you need to make an API call.
|
|
47
48
|
* ```javascript
|
|
@@ -599,21 +600,23 @@ declare const RegisterTaskDefinitionCommand_base: {
|
|
|
599
600
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
600
601
|
*
|
|
601
602
|
* @throws {@link ClientException} (client fault)
|
|
602
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
603
|
-
* resource on behalf of a user that doesn't have permissions to use the
|
|
604
|
-
* be specifying an identifier that isn't valid.</p>
|
|
603
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
604
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
605
|
+
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
605
606
|
* <p>The following list includes additional causes for the error:</p>
|
|
606
607
|
* <ul>
|
|
607
608
|
* <li>
|
|
608
|
-
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
609
|
-
* a capacity error because the quota of tasks in the
|
|
610
|
-
*
|
|
611
|
-
*
|
|
609
|
+
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
610
|
+
* scaling and there is a capacity error because the quota of tasks in the
|
|
611
|
+
* <code>PROVISIONING</code> per cluster has been reached. For information
|
|
612
|
+
* about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
|
|
613
|
+
* service quotas</a>.</p>
|
|
612
614
|
* </li>
|
|
613
615
|
* </ul>
|
|
614
616
|
*
|
|
615
617
|
* @throws {@link InvalidParameterException} (client fault)
|
|
616
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
618
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
619
|
+
* request.</p>
|
|
617
620
|
*
|
|
618
621
|
* @throws {@link ServerException} (server fault)
|
|
619
622
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -34,31 +34,33 @@ declare const RunTaskCommand_base: {
|
|
|
34
34
|
* <note>
|
|
35
35
|
* <p>Amazon Elastic Inference (EI) is no longer available to customers.</p>
|
|
36
36
|
* </note>
|
|
37
|
-
* <p>You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places
|
|
38
|
-
* placement constraints and placement strategies. For more information, see
|
|
39
|
-
* Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
40
|
-
* <p>Alternatively, you can use <code>StartTask</code> to use your own scheduler or place
|
|
41
|
-
* on specific container instances.</p>
|
|
42
|
-
* <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or
|
|
43
|
-
* service. For more infomation, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
37
|
+
* <p>You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places
|
|
38
|
+
* tasks using placement constraints and placement strategies. For more information, see
|
|
39
|
+
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html">Scheduling Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
40
|
+
* <p>Alternatively, you can use <code>StartTask</code> to use your own scheduler or place
|
|
41
|
+
* tasks manually on specific container instances.</p>
|
|
42
|
+
* <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or
|
|
43
|
+
* updating a service. For more infomation, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
44
|
+
* <p>The Amazon ECS API follows an eventual consistency model. This is because of the
|
|
45
|
+
* distributed nature of the system supporting the API. This means that the result of an
|
|
46
|
+
* API command you run that affects your Amazon ECS resources might not be immediately visible
|
|
47
|
+
* to all subsequent commands you run. Keep this in mind when you carry out an API command
|
|
48
|
+
* that immediately follows a previous API command.</p>
|
|
49
49
|
* <p>To manage eventual consistency, you can do the following:</p>
|
|
50
50
|
* <ul>
|
|
51
51
|
* <li>
|
|
52
|
-
* <p>Confirm the state of the resource before you run a command to modify it. Run
|
|
53
|
-
* DescribeTasks command using an exponential backoff algorithm to ensure that
|
|
54
|
-
* time for the previous command to propagate through the system.
|
|
55
|
-
* DescribeTasks command repeatedly, starting with a couple of
|
|
56
|
-
* gradually up to five minutes of wait
|
|
52
|
+
* <p>Confirm the state of the resource before you run a command to modify it. Run
|
|
53
|
+
* the DescribeTasks command using an exponential backoff algorithm to ensure that
|
|
54
|
+
* you allow enough time for the previous command to propagate through the system.
|
|
55
|
+
* To do this, run the DescribeTasks command repeatedly, starting with a couple of
|
|
56
|
+
* seconds of wait time and increasing gradually up to five minutes of wait
|
|
57
|
+
* time.</p>
|
|
57
58
|
* </li>
|
|
58
59
|
* <li>
|
|
59
|
-
* <p>Add wait time between subsequent commands, even if the DescribeTasks command
|
|
60
|
-
* accurate response. Apply an exponential backoff algorithm starting
|
|
61
|
-
* wait time, and increase gradually up to about five
|
|
60
|
+
* <p>Add wait time between subsequent commands, even if the DescribeTasks command
|
|
61
|
+
* returns an accurate response. Apply an exponential backoff algorithm starting
|
|
62
|
+
* with a couple of seconds of wait time, and increase gradually up to about five
|
|
63
|
+
* minutes of wait time.</p>
|
|
62
64
|
* </li>
|
|
63
65
|
* </ul>
|
|
64
66
|
* @example
|
|
@@ -382,16 +384,17 @@ declare const RunTaskCommand_base: {
|
|
|
382
384
|
* Amazon Web Services Support</a>.</p>
|
|
383
385
|
*
|
|
384
386
|
* @throws {@link ClientException} (client fault)
|
|
385
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
386
|
-
* resource on behalf of a user that doesn't have permissions to use the
|
|
387
|
-
* be specifying an identifier that isn't valid.</p>
|
|
387
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
388
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
389
|
+
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
388
390
|
* <p>The following list includes additional causes for the error:</p>
|
|
389
391
|
* <ul>
|
|
390
392
|
* <li>
|
|
391
|
-
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
392
|
-
* a capacity error because the quota of tasks in the
|
|
393
|
-
*
|
|
394
|
-
*
|
|
393
|
+
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
394
|
+
* scaling and there is a capacity error because the quota of tasks in the
|
|
395
|
+
* <code>PROVISIONING</code> per cluster has been reached. For information
|
|
396
|
+
* about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
|
|
397
|
+
* service quotas</a>.</p>
|
|
395
398
|
* </li>
|
|
396
399
|
* </ul>
|
|
397
400
|
*
|
|
@@ -400,22 +403,23 @@ declare const RunTaskCommand_base: {
|
|
|
400
403
|
*
|
|
401
404
|
* @throws {@link ConflictException} (client fault)
|
|
402
405
|
* <p>The <code>RunTask</code> request could not be processed due to conflicts. The provided
|
|
403
|
-
* <code>clientToken</code> is already in use with a different <code>RunTask</code>
|
|
404
|
-
*
|
|
405
|
-
*
|
|
406
|
+
* <code>clientToken</code> is already in use with a different <code>RunTask</code>
|
|
407
|
+
* request. The <code>resourceIds</code> are the existing task ARNs which are already
|
|
408
|
+
* associated with the <code>clientToken</code>. </p>
|
|
406
409
|
* <p>To fix this issue:</p>
|
|
407
410
|
* <ul>
|
|
408
411
|
* <li>
|
|
409
412
|
* <p>Run <code>RunTask</code> with a unique <code>clientToken</code>.</p>
|
|
410
413
|
* </li>
|
|
411
414
|
* <li>
|
|
412
|
-
* <p>Run <code>RunTask</code> with the <code>clientToken</code> and the original
|
|
413
|
-
* parameters</p>
|
|
415
|
+
* <p>Run <code>RunTask</code> with the <code>clientToken</code> and the original
|
|
416
|
+
* set of parameters</p>
|
|
414
417
|
* </li>
|
|
415
418
|
* </ul>
|
|
416
419
|
*
|
|
417
420
|
* @throws {@link InvalidParameterException} (client fault)
|
|
418
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
421
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
422
|
+
* request.</p>
|
|
419
423
|
*
|
|
420
424
|
* @throws {@link PlatformTaskDefinitionIncompatibilityException} (client fault)
|
|
421
425
|
* <p>The specified platform version doesn't satisfy the required capabilities of the task
|
|
@@ -27,20 +27,18 @@ declare const StartTaskCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* <p>Starts a new task from the specified task definition on the specified container
|
|
31
|
-
* instances.</p>
|
|
30
|
+
* <p>Starts a new task from the specified task definition on the specified container
|
|
31
|
+
* instance or instances.</p>
|
|
32
32
|
* <note>
|
|
33
33
|
* <p>On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.</p>
|
|
34
34
|
* </note>
|
|
35
35
|
* <note>
|
|
36
36
|
* <p>Amazon Elastic Inference (EI) is no longer available to customers.</p>
|
|
37
37
|
* </note>
|
|
38
|
-
* <p>Alternatively, you can use<code>RunTask</code> to place tasks for you. For more
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
* service. For more infomation, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS
|
|
43
|
-
* volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
38
|
+
* <p>Alternatively, you can use<code>RunTask</code> to place tasks for you. For more
|
|
39
|
+
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html">Scheduling Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
40
|
+
* <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or
|
|
41
|
+
* updating a service. For more infomation, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
44
42
|
* @example
|
|
45
43
|
* Use a bare-bones client and the command you need to make an API call.
|
|
46
44
|
* ```javascript
|
|
@@ -333,16 +331,17 @@ declare const StartTaskCommand_base: {
|
|
|
333
331
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
334
332
|
*
|
|
335
333
|
* @throws {@link ClientException} (client fault)
|
|
336
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
337
|
-
* resource on behalf of a user that doesn't have permissions to use the
|
|
338
|
-
* be specifying an identifier that isn't valid.</p>
|
|
334
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
335
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
336
|
+
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
339
337
|
* <p>The following list includes additional causes for the error:</p>
|
|
340
338
|
* <ul>
|
|
341
339
|
* <li>
|
|
342
|
-
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
343
|
-
* a capacity error because the quota of tasks in the
|
|
344
|
-
*
|
|
345
|
-
*
|
|
340
|
+
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
341
|
+
* scaling and there is a capacity error because the quota of tasks in the
|
|
342
|
+
* <code>PROVISIONING</code> per cluster has been reached. For information
|
|
343
|
+
* about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
|
|
344
|
+
* service quotas</a>.</p>
|
|
346
345
|
* </li>
|
|
347
346
|
* </ul>
|
|
348
347
|
*
|
|
@@ -350,7 +349,8 @@ declare const StartTaskCommand_base: {
|
|
|
350
349
|
* <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>
|
|
351
350
|
*
|
|
352
351
|
* @throws {@link InvalidParameterException} (client fault)
|
|
353
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
352
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
353
|
+
* request.</p>
|
|
354
354
|
*
|
|
355
355
|
* @throws {@link ServerException} (server fault)
|
|
356
356
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -28,18 +28,20 @@ declare const StopTaskCommand_base: {
|
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
30
|
* <p>Stops a running task. Any tags associated with the task will be deleted.</p>
|
|
31
|
-
* <p>When you call <code>StopTask</code> on a task, the equivalent of <code>docker
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
31
|
+
* <p>When you call <code>StopTask</code> on a task, the equivalent of <code>docker
|
|
32
|
+
* stop</code> is issued to the containers running in the task. This results in a
|
|
33
|
+
* <code>SIGTERM</code> value and a default 30-second timeout, after which the
|
|
34
|
+
* <code>SIGKILL</code> value is sent and the containers are forcibly stopped. If the
|
|
35
|
+
* container handles the <code>SIGTERM</code> value gracefully and exits within 30 seconds
|
|
35
36
|
* from receiving it, no <code>SIGKILL</code> value is sent.</p>
|
|
36
|
-
* <p>For Windows containers, POSIX signals do not work and runtime stops the container by
|
|
37
|
-
*
|
|
38
|
-
* container #25982</a> on GitHub.</p>
|
|
37
|
+
* <p>For Windows containers, POSIX signals do not work and runtime stops the container by
|
|
38
|
+
* sending a <code>CTRL_SHUTDOWN_EVENT</code>. For more information, see <a href="https://github.com/moby/moby/issues/25982">Unable to react to graceful shutdown
|
|
39
|
+
* of (Windows) container #25982</a> on GitHub.</p>
|
|
39
40
|
* <note>
|
|
40
|
-
* <p>The default 30-second timeout can be configured on the Amazon ECS container agent with
|
|
41
|
-
*
|
|
42
|
-
* Container Agent Configuration</a> in the
|
|
41
|
+
* <p>The default 30-second timeout can be configured on the Amazon ECS container agent with
|
|
42
|
+
* the <code>ECS_CONTAINER_STOP_TIMEOUT</code> variable. For more information, see
|
|
43
|
+
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html">Amazon ECS Container Agent Configuration</a> in the
|
|
44
|
+
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
43
45
|
* </note>
|
|
44
46
|
* @example
|
|
45
47
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -226,16 +228,17 @@ declare const StopTaskCommand_base: {
|
|
|
226
228
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
227
229
|
*
|
|
228
230
|
* @throws {@link ClientException} (client fault)
|
|
229
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
230
|
-
* resource on behalf of a user that doesn't have permissions to use the
|
|
231
|
-
* be specifying an identifier that isn't valid.</p>
|
|
231
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
232
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
233
|
+
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
232
234
|
* <p>The following list includes additional causes for the error:</p>
|
|
233
235
|
* <ul>
|
|
234
236
|
* <li>
|
|
235
|
-
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
236
|
-
* a capacity error because the quota of tasks in the
|
|
237
|
-
*
|
|
238
|
-
*
|
|
237
|
+
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
238
|
+
* scaling and there is a capacity error because the quota of tasks in the
|
|
239
|
+
* <code>PROVISIONING</code> per cluster has been reached. For information
|
|
240
|
+
* about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
|
|
241
|
+
* service quotas</a>.</p>
|
|
239
242
|
* </li>
|
|
240
243
|
* </ul>
|
|
241
244
|
*
|
|
@@ -243,7 +246,8 @@ declare const StopTaskCommand_base: {
|
|
|
243
246
|
* <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>
|
|
244
247
|
*
|
|
245
248
|
* @throws {@link InvalidParameterException} (client fault)
|
|
246
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
249
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
250
|
+
* request.</p>
|
|
247
251
|
*
|
|
248
252
|
* @throws {@link ServerException} (server fault)
|
|
249
253
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -64,21 +64,23 @@ declare const SubmitAttachmentStateChangesCommand_base: {
|
|
|
64
64
|
* <p>You don't have authorization to perform the requested action.</p>
|
|
65
65
|
*
|
|
66
66
|
* @throws {@link ClientException} (client fault)
|
|
67
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
68
|
-
* resource on behalf of a user that doesn't have permissions to use the
|
|
69
|
-
* be specifying an identifier that isn't valid.</p>
|
|
67
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
68
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
69
|
+
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
70
70
|
* <p>The following list includes additional causes for the error:</p>
|
|
71
71
|
* <ul>
|
|
72
72
|
* <li>
|
|
73
|
-
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
74
|
-
* a capacity error because the quota of tasks in the
|
|
75
|
-
*
|
|
76
|
-
*
|
|
73
|
+
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
74
|
+
* scaling and there is a capacity error because the quota of tasks in the
|
|
75
|
+
* <code>PROVISIONING</code> per cluster has been reached. For information
|
|
76
|
+
* about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
|
|
77
|
+
* service quotas</a>.</p>
|
|
77
78
|
* </li>
|
|
78
79
|
* </ul>
|
|
79
80
|
*
|
|
80
81
|
* @throws {@link InvalidParameterException} (client fault)
|
|
81
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
82
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
83
|
+
* request.</p>
|
|
82
84
|
*
|
|
83
85
|
* @throws {@link ServerException} (server fault)
|
|
84
86
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -74,16 +74,17 @@ declare const SubmitContainerStateChangeCommand_base: {
|
|
|
74
74
|
* <p>You don't have authorization to perform the requested action.</p>
|
|
75
75
|
*
|
|
76
76
|
* @throws {@link ClientException} (client fault)
|
|
77
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
78
|
-
* resource on behalf of a user that doesn't have permissions to use the
|
|
79
|
-
* be specifying an identifier that isn't valid.</p>
|
|
77
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
78
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
79
|
+
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
80
80
|
* <p>The following list includes additional causes for the error:</p>
|
|
81
81
|
* <ul>
|
|
82
82
|
* <li>
|
|
83
|
-
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
84
|
-
* a capacity error because the quota of tasks in the
|
|
85
|
-
*
|
|
86
|
-
*
|
|
83
|
+
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
84
|
+
* scaling and there is a capacity error because the quota of tasks in the
|
|
85
|
+
* <code>PROVISIONING</code> per cluster has been reached. For information
|
|
86
|
+
* about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
|
|
87
|
+
* service quotas</a>.</p>
|
|
87
88
|
* </li>
|
|
88
89
|
* </ul>
|
|
89
90
|
*
|
|
@@ -98,21 +98,23 @@ declare const SubmitTaskStateChangeCommand_base: {
|
|
|
98
98
|
* <p>You don't have authorization to perform the requested action.</p>
|
|
99
99
|
*
|
|
100
100
|
* @throws {@link ClientException} (client fault)
|
|
101
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
102
|
-
* resource on behalf of a user that doesn't have permissions to use the
|
|
103
|
-
* be specifying an identifier that isn't valid.</p>
|
|
101
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
102
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
103
|
+
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
104
104
|
* <p>The following list includes additional causes for the error:</p>
|
|
105
105
|
* <ul>
|
|
106
106
|
* <li>
|
|
107
|
-
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
108
|
-
* a capacity error because the quota of tasks in the
|
|
109
|
-
*
|
|
110
|
-
*
|
|
107
|
+
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
108
|
+
* scaling and there is a capacity error because the quota of tasks in the
|
|
109
|
+
* <code>PROVISIONING</code> per cluster has been reached. For information
|
|
110
|
+
* about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
|
|
111
|
+
* service quotas</a>.</p>
|
|
111
112
|
* </li>
|
|
112
113
|
* </ul>
|
|
113
114
|
*
|
|
114
115
|
* @throws {@link InvalidParameterException} (client fault)
|
|
115
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
116
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
117
|
+
* request.</p>
|
|
116
118
|
*
|
|
117
119
|
* @throws {@link ServerException} (server fault)
|
|
118
120
|
* <p>These errors are usually caused by a server issue.</p>
|
|
@@ -27,9 +27,10 @@ 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
|
-
*
|
|
30
|
+
* <p>Associates the specified tags to a resource with the specified
|
|
31
|
+
* <code>resourceArn</code>. If existing tags on a resource aren't specified in the
|
|
32
|
+
* request parameters, they aren't changed. When a resource is deleted, the tags that are
|
|
33
|
+
* associated with that resource are deleted as well.</p>
|
|
33
34
|
* @example
|
|
34
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
36
|
* ```javascript
|
|
@@ -58,16 +59,17 @@ declare const TagResourceCommand_base: {
|
|
|
58
59
|
* @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
|
|
59
60
|
*
|
|
60
61
|
* @throws {@link ClientException} (client fault)
|
|
61
|
-
* <p>These errors are usually caused by a client action. This client action might be using
|
|
62
|
-
* resource on behalf of a user that doesn't have permissions to use the
|
|
63
|
-
* be specifying an identifier that isn't valid.</p>
|
|
62
|
+
* <p>These errors are usually caused by a client action. This client action might be using
|
|
63
|
+
* an action or resource on behalf of a user that doesn't have permissions to use the
|
|
64
|
+
* action or resource. Or, it might be specifying an identifier that isn't valid.</p>
|
|
64
65
|
* <p>The following list includes additional causes for the error:</p>
|
|
65
66
|
* <ul>
|
|
66
67
|
* <li>
|
|
67
|
-
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
68
|
-
* a capacity error because the quota of tasks in the
|
|
69
|
-
*
|
|
70
|
-
*
|
|
68
|
+
* <p>The <code>RunTask</code> could not be processed because you use managed
|
|
69
|
+
* scaling and there is a capacity error because the quota of tasks in the
|
|
70
|
+
* <code>PROVISIONING</code> per cluster has been reached. For information
|
|
71
|
+
* about the service quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
|
|
72
|
+
* service quotas</a>.</p>
|
|
71
73
|
* </li>
|
|
72
74
|
* </ul>
|
|
73
75
|
*
|
|
@@ -75,7 +77,8 @@ declare const TagResourceCommand_base: {
|
|
|
75
77
|
* <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>
|
|
76
78
|
*
|
|
77
79
|
* @throws {@link InvalidParameterException} (client fault)
|
|
78
|
-
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
80
|
+
* <p>The specified parameter isn't valid. Review the available parameters for the API
|
|
81
|
+
* request.</p>
|
|
79
82
|
*
|
|
80
83
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
81
84
|
* <p>The specified resource wasn't found.</p>
|