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