@aws-sdk/client-ecs 3.229.0 → 3.232.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/dist-cjs/endpoint/ruleset.js +0 -9
- package/dist-cjs/protocols/Aws_json1_1.js +6 -0
- package/dist-es/endpoint/ruleset.js +0 -9
- package/dist-es/protocols/Aws_json1_1.js +6 -0
- package/dist-types/ECS.d.ts +147 -146
- package/dist-types/ECSClient.d.ts +3 -3
- package/dist-types/commands/CreateCapacityProviderCommand.d.ts +1 -1
- package/dist-types/commands/CreateClusterCommand.d.ts +3 -3
- package/dist-types/commands/CreateServiceCommand.d.ts +14 -14
- package/dist-types/commands/DeleteCapacityProviderCommand.d.ts +4 -4
- package/dist-types/commands/DeleteClusterCommand.d.ts +1 -1
- package/dist-types/commands/DeleteServiceCommand.d.ts +6 -6
- package/dist-types/commands/DeregisterContainerInstanceCommand.d.ts +5 -5
- package/dist-types/commands/DeregisterTaskDefinitionCommand.d.ts +4 -4
- package/dist-types/commands/DescribeTaskDefinitionCommand.d.ts +3 -3
- package/dist-types/commands/DescribeTasksCommand.d.ts +1 -1
- package/dist-types/commands/DiscoverPollEndpointCommand.d.ts +1 -1
- package/dist-types/commands/ExecuteCommandCommand.d.ts +3 -1
- package/dist-types/commands/ListTaskDefinitionFamiliesCommand.d.ts +1 -1
- package/dist-types/commands/ListTasksCommand.d.ts +1 -1
- package/dist-types/commands/PutAccountSettingCommand.d.ts +4 -4
- package/dist-types/commands/PutClusterCapacityProvidersCommand.d.ts +2 -2
- package/dist-types/commands/RegisterContainerInstanceCommand.d.ts +1 -1
- package/dist-types/commands/RegisterTaskDefinitionCommand.d.ts +2 -2
- package/dist-types/commands/RunTaskCommand.d.ts +9 -9
- package/dist-types/commands/StartTaskCommand.d.ts +1 -1
- package/dist-types/commands/StopTaskCommand.d.ts +4 -4
- package/dist-types/commands/SubmitAttachmentStateChangesCommand.d.ts +1 -1
- package/dist-types/commands/SubmitContainerStateChangeCommand.d.ts +1 -1
- package/dist-types/commands/SubmitTaskStateChangeCommand.d.ts +1 -1
- package/dist-types/commands/UpdateContainerAgentCommand.d.ts +7 -7
- package/dist-types/commands/UpdateContainerInstancesStateCommand.d.ts +14 -14
- package/dist-types/commands/UpdateServiceCommand.d.ts +40 -41
- package/dist-types/commands/UpdateTaskProtectionCommand.d.ts +9 -9
- package/dist-types/models/models_0.d.ts +1178 -1042
- package/dist-types/ts3.4/models/models_0.d.ts +3 -0
- package/package.json +5 -5
|
@@ -179,15 +179,15 @@ export interface ECSClientResolvedConfig extends ECSClientResolvedConfigType {
|
|
|
179
179
|
}
|
|
180
180
|
/**
|
|
181
181
|
* <fullname>Amazon Elastic Container Service</fullname>
|
|
182
|
-
*
|
|
182
|
+
* <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes
|
|
183
183
|
* it easy to run, stop, and manage Docker containers. You can host your cluster on a
|
|
184
184
|
* serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on
|
|
185
185
|
* Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2)
|
|
186
186
|
* or External (on-premises) instances that you manage.</p>
|
|
187
|
-
*
|
|
187
|
+
* <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API
|
|
188
188
|
* calls. This makes it easy to get the state of your cluster from a centralized service,
|
|
189
189
|
* and gives you access to many familiar Amazon EC2 features.</p>
|
|
190
|
-
*
|
|
190
|
+
* <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on
|
|
191
191
|
* your resource needs, isolation policies, and availability requirements. With Amazon ECS, you
|
|
192
192
|
* don't need to operate your own cluster management and configuration management systems.
|
|
193
193
|
* You also don't need to worry about scaling your management infrastructure.</p>
|
|
@@ -11,7 +11,7 @@ export interface CreateCapacityProviderCommandOutput extends CreateCapacityProvi
|
|
|
11
11
|
* <p>Creates a new capacity provider. Capacity providers are associated with an Amazon ECS
|
|
12
12
|
* cluster and are used in capacity provider strategies to facilitate cluster auto
|
|
13
13
|
* scaling.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on
|
|
15
15
|
* Fargate use the <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers.
|
|
16
16
|
* These providers are available to all accounts in the Amazon Web Services Regions that Fargate
|
|
17
17
|
* supports.</p>
|
|
@@ -11,14 +11,14 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
|
|
|
11
11
|
* <p>Creates a new Amazon ECS cluster. By default, your account receives a <code>default</code>
|
|
12
12
|
* cluster when you launch your first container instance. However, you can create your own
|
|
13
13
|
* cluster with a unique name with the <code>CreateCluster</code> action.</p>
|
|
14
|
-
*
|
|
15
|
-
*
|
|
14
|
+
* <note>
|
|
15
|
+
* <p>When you call the <a>CreateCluster</a> API operation, Amazon ECS attempts to
|
|
16
16
|
* create the Amazon ECS service-linked role for your account. This is so that it can manage
|
|
17
17
|
* required resources in other Amazon Web Services services on your behalf. However, if the IAM user
|
|
18
18
|
* that makes the call doesn't have permissions to create the service-linked role, it
|
|
19
19
|
* isn't created. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Using
|
|
20
20
|
* service-linked roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
21
|
-
*
|
|
21
|
+
* </note>
|
|
22
22
|
* @example
|
|
23
23
|
* Use a bare-bones client and the command you need to make an API call.
|
|
24
24
|
* ```javascript
|
|
@@ -12,26 +12,26 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
|
|
|
12
12
|
* the number of tasks running in a service drops below the <code>desiredCount</code>,
|
|
13
13
|
* Amazon ECS runs another copy of the task in the specified cluster. To update an existing
|
|
14
14
|
* service, see the <a>UpdateService</a> action.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>In addition to maintaining the desired count of tasks in your service, you can
|
|
16
16
|
* optionally run your service behind one or more load balancers. The load balancers
|
|
17
17
|
* distribute traffic across the tasks that are associated with the service. For more
|
|
18
18
|
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html">Service load balancing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
19
|
-
*
|
|
19
|
+
* <p>Tasks for services that don't use a load balancer are considered healthy if they're in
|
|
20
20
|
* the <code>RUNNING</code> state. Tasks for services that use a load balancer are
|
|
21
21
|
* considered healthy if they're in the <code>RUNNING</code> state and are reported as
|
|
22
22
|
* healthy by the load balancer.</p>
|
|
23
|
-
*
|
|
24
|
-
*
|
|
23
|
+
* <p>There are two service scheduler strategies available:</p>
|
|
24
|
+
* <ul>
|
|
25
25
|
* <li>
|
|
26
|
-
*
|
|
26
|
+
* <p>
|
|
27
27
|
* <code>REPLICA</code> - The replica scheduling strategy places and
|
|
28
28
|
* maintains your desired number of tasks across your cluster. By default, the
|
|
29
29
|
* service scheduler spreads tasks across Availability Zones. You can use task
|
|
30
30
|
* placement strategies and constraints to customize task placement decisions. For
|
|
31
31
|
* more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service scheduler concepts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
32
|
-
*
|
|
32
|
+
* </li>
|
|
33
33
|
* <li>
|
|
34
|
-
*
|
|
34
|
+
* <p>
|
|
35
35
|
* <code>DAEMON</code> - The daemon scheduling strategy deploys exactly one
|
|
36
36
|
* task on each active container instance that meets all of the task placement
|
|
37
37
|
* constraints that you specify in your cluster. The service scheduler also
|
|
@@ -39,14 +39,14 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
|
|
|
39
39
|
* that don't meet the placement constraints. When using this strategy, you don't
|
|
40
40
|
* need to specify a desired number of tasks, a task placement strategy, or use
|
|
41
41
|
* Service Auto Scaling policies. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html">Service scheduler concepts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
42
|
-
*
|
|
42
|
+
* </li>
|
|
43
43
|
* </ul>
|
|
44
|
-
*
|
|
44
|
+
* <p>You can optionally specify a deployment configuration for your service. The deployment
|
|
45
45
|
* is initiated by changing properties. For example, the deployment might be initiated by
|
|
46
46
|
* the task definition or by your desired count of a service. This is done with an <a>UpdateService</a> operation. The default value for a replica service for
|
|
47
47
|
* <code>minimumHealthyPercent</code> is 100%. The default value for a daemon service
|
|
48
48
|
* for <code>minimumHealthyPercent</code> is 0%.</p>
|
|
49
|
-
*
|
|
49
|
+
* <p>If a service uses the <code>ECS</code> deployment controller, the minimum healthy
|
|
50
50
|
* percent represents a lower limit on the number of tasks in a service that must remain in
|
|
51
51
|
* the <code>RUNNING</code> state during a deployment. Specifically, it represents it as a
|
|
52
52
|
* percentage of your desired number of tasks (rounded up to the nearest integer). This
|
|
@@ -60,7 +60,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
|
|
|
60
60
|
* <code>RUNNING</code> state and reported as healthy by the load balancer, tasks for
|
|
61
61
|
* services that <i>do</i> use a load balancer are considered healthy . The
|
|
62
62
|
* default value for minimum healthy percent is 100%.</p>
|
|
63
|
-
*
|
|
63
|
+
* <p>If a service uses the <code>ECS</code> deployment controller, the <b>maximum percent</b> parameter represents an upper limit on the
|
|
64
64
|
* number of tasks in a service that are allowed in the <code>RUNNING</code> or
|
|
65
65
|
* <code>PENDING</code> state during a deployment. Specifically, it represents it as a
|
|
66
66
|
* percentage of the desired number of tasks (rounded down to the nearest integer). This
|
|
@@ -71,7 +71,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
|
|
|
71
71
|
* start four new tasks before stopping the four older tasks (provided that the cluster
|
|
72
72
|
* resources required to do this are available). The default value for maximum percent is
|
|
73
73
|
* 200%.</p>
|
|
74
|
-
*
|
|
74
|
+
* <p>If a service uses either the <code>CODE_DEPLOY</code> or <code>EXTERNAL</code>
|
|
75
75
|
* deployment controller types and tasks that use the EC2 launch type, the
|
|
76
76
|
* <b>minimum healthy percent</b> and <b>maximum percent</b> values are used only to define the lower and upper limit
|
|
77
77
|
* on the number of the tasks in the service that remain in the <code>RUNNING</code> state.
|
|
@@ -79,10 +79,10 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
|
|
|
79
79
|
* tasks in the service use the Fargate launch type, the minimum healthy
|
|
80
80
|
* percent and maximum percent values aren't used. This is the case even if they're
|
|
81
81
|
* currently visible when describing your service.</p>
|
|
82
|
-
*
|
|
82
|
+
* <p>When creating a service that uses the <code>EXTERNAL</code> deployment controller, you
|
|
83
83
|
* can specify only parameters that aren't controlled at the task set level. The only
|
|
84
84
|
* required parameter is the service name. You control your services using the <a>CreateTaskSet</a> operation. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS deployment types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
85
|
-
*
|
|
85
|
+
* <p>When the service scheduler launches new tasks, it determines task placement. For
|
|
86
86
|
* information about task placement and task placement strategies, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html">Amazon ECS
|
|
87
87
|
* task placement</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
88
88
|
* @example
|
|
@@ -9,13 +9,13 @@ export interface DeleteCapacityProviderCommandOutput extends DeleteCapacityProvi
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deletes the specified capacity provider.</p>
|
|
12
|
-
*
|
|
13
|
-
*
|
|
12
|
+
* <note>
|
|
13
|
+
* <p>The <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers are
|
|
14
14
|
* reserved and can't be deleted. You can disassociate them from a cluster using either
|
|
15
15
|
* the <a>PutClusterCapacityProviders</a> API or by deleting the
|
|
16
16
|
* cluster.</p>
|
|
17
|
-
*
|
|
18
|
-
*
|
|
17
|
+
* </note>
|
|
18
|
+
* <p>Prior to a capacity provider being deleted, the capacity provider must be removed from
|
|
19
19
|
* the capacity provider strategy from all services. The <a>UpdateService</a>
|
|
20
20
|
* API can be used to remove a capacity provider from a service's capacity provider
|
|
21
21
|
* strategy. When updating a service, the <code>forceNewDeployment</code> option can be
|
|
@@ -12,7 +12,7 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met
|
|
|
12
12
|
* state. Clusters with an <code>INACTIVE</code> status might remain discoverable in your
|
|
13
13
|
* account for a period of time. However, this behavior is subject to change in the future.
|
|
14
14
|
* We don't recommend that you rely on <code>INACTIVE</code> clusters persisting.</p>
|
|
15
|
-
*
|
|
15
|
+
* <p>You must deregister all container instances from this cluster before you may delete
|
|
16
16
|
* it. You can list the container instances in a cluster with <a>ListContainerInstances</a> and deregister them with <a>DeregisterContainerInstance</a>.</p>
|
|
17
17
|
* @example
|
|
18
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -12,8 +12,8 @@ export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __Met
|
|
|
12
12
|
* running tasks in it and the desired task count is zero. If the service is actively
|
|
13
13
|
* maintaining tasks, you can't delete it, and you must update the service to a desired
|
|
14
14
|
* task count of zero. For more information, see <a>UpdateService</a>.</p>
|
|
15
|
-
*
|
|
16
|
-
*
|
|
15
|
+
* <note>
|
|
16
|
+
* <p>When you delete a service, if there are still running tasks that require cleanup,
|
|
17
17
|
* the service status moves from <code>ACTIVE</code> to <code>DRAINING</code>, and the
|
|
18
18
|
* service is no longer visible in the console or in the <a>ListServices</a>
|
|
19
19
|
* API operation. After all tasks have transitioned to either <code>STOPPING</code> or
|
|
@@ -23,12 +23,12 @@ export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __Met
|
|
|
23
23
|
* <code>INACTIVE</code> services may be cleaned up and purged from Amazon ECS record
|
|
24
24
|
* keeping, and <a>DescribeServices</a> calls on those services return a
|
|
25
25
|
* <code>ServiceNotFoundException</code> error.</p>
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
26
|
+
* </note>
|
|
27
|
+
* <important>
|
|
28
|
+
* <p>If you attempt to create a new service with the same name as an existing service
|
|
29
29
|
* in either <code>ACTIVE</code> or <code>DRAINING</code> status, you receive an
|
|
30
30
|
* error.</p>
|
|
31
|
-
*
|
|
31
|
+
* </important>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -10,18 +10,18 @@ export interface DeregisterContainerInstanceCommandOutput extends DeregisterCont
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Deregisters an Amazon ECS container instance from the specified cluster. This instance is
|
|
12
12
|
* no longer available to run tasks.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>If you intend to use the container instance for some other purpose after
|
|
14
14
|
* deregistration, we recommend that you stop all of the tasks running on the container
|
|
15
15
|
* instance before deregistration. That prevents any orphaned tasks from consuming
|
|
16
16
|
* resources.</p>
|
|
17
|
-
*
|
|
17
|
+
* <p>Deregistering a container instance removes the instance from a cluster, but it doesn't
|
|
18
18
|
* terminate the EC2 instance. If you are finished using the instance, be sure to terminate
|
|
19
19
|
* it in the Amazon EC2 console to stop billing.</p>
|
|
20
|
-
*
|
|
21
|
-
*
|
|
20
|
+
* <note>
|
|
21
|
+
* <p>If you terminate a running container instance, Amazon ECS automatically deregisters the
|
|
22
22
|
* instance from your cluster (stopped container instances or instances with
|
|
23
23
|
* disconnected agents aren't automatically deregistered when terminated).</p>
|
|
24
|
-
*
|
|
24
|
+
* </note>
|
|
25
25
|
* @example
|
|
26
26
|
* Use a bare-bones client and the command you need to make an API call.
|
|
27
27
|
* ```javascript
|
|
@@ -13,16 +13,16 @@ export interface DeregisterTaskDefinitionCommandOutput extends DeregisterTaskDef
|
|
|
13
13
|
* reference an <code>INACTIVE</code> task definition continue to run without disruption.
|
|
14
14
|
* Existing services that reference an <code>INACTIVE</code> task definition can still
|
|
15
15
|
* scale up or down by modifying the service's desired count.</p>
|
|
16
|
-
*
|
|
16
|
+
* <p>You can't use an <code>INACTIVE</code> task definition to run new tasks or create new
|
|
17
17
|
* services, and you can't update an existing service to reference an <code>INACTIVE</code>
|
|
18
18
|
* task definition. However, there may be up to a 10-minute window following deregistration
|
|
19
19
|
* where these restrictions have not yet taken effect.</p>
|
|
20
|
-
*
|
|
21
|
-
*
|
|
20
|
+
* <note>
|
|
21
|
+
* <p>At this time, <code>INACTIVE</code> task definitions remain discoverable in your
|
|
22
22
|
* account indefinitely. However, this behavior is subject to change in the future. We
|
|
23
23
|
* don't recommend that you rely on <code>INACTIVE</code> task definitions persisting
|
|
24
24
|
* beyond the lifecycle of any associated tasks and services.</p>
|
|
25
|
-
*
|
|
25
|
+
* </note>
|
|
26
26
|
* @example
|
|
27
27
|
* Use a bare-bones client and the command you need to make an API call.
|
|
28
28
|
* ```javascript
|
|
@@ -12,10 +12,10 @@ export interface DescribeTaskDefinitionCommandOutput extends DescribeTaskDefinit
|
|
|
12
12
|
* <code>revision</code> to find information about a specific task definition, or you
|
|
13
13
|
* can simply specify the family to find the latest <code>ACTIVE</code> revision in that
|
|
14
14
|
* family.</p>
|
|
15
|
-
*
|
|
16
|
-
*
|
|
15
|
+
* <note>
|
|
16
|
+
* <p>You can only describe <code>INACTIVE</code> task definitions while an active task
|
|
17
17
|
* or service references them.</p>
|
|
18
|
-
*
|
|
18
|
+
* </note>
|
|
19
19
|
* @example
|
|
20
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
21
21
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface DescribeTasksCommandOutput extends DescribeTasksResponse, __Met
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Describes a specified task or tasks.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Currently, stopped tasks appear in the returned results for at least one hour.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -11,7 +11,7 @@ export interface DiscoverPollEndpointCommandOutput extends DiscoverPollEndpointR
|
|
|
11
11
|
* <note>
|
|
12
12
|
* <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p>
|
|
13
13
|
* </note>
|
|
14
|
-
*
|
|
14
|
+
* <p>Returns an endpoint for the Amazon ECS agent to poll for updates.</p>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
17
|
* ```javascript
|
|
@@ -9,10 +9,12 @@ export interface ExecuteCommandCommandOutput extends ExecuteCommandResponse, __M
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Runs a command remotely on a container within a task.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>If you use a condition key in your IAM policy to refine the conditions for the policy
|
|
13
13
|
* statement, for example limit the actions to a specific cluster, you receive an
|
|
14
14
|
* <code>AccessDeniedException</code> when there is a mismatch between the condition
|
|
15
15
|
* key value and the corresponding parameter value.</p>
|
|
16
|
+
* <p>For information about required permissions and considerations, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.htm">Using Amazon ECS Exec for
|
|
17
|
+
* debugging</a> in the <i>Amazon ECS Developer Guide</i>. </p>
|
|
16
18
|
* @example
|
|
17
19
|
* Use a bare-bones client and the command you need to make an API call.
|
|
18
20
|
* ```javascript
|
|
@@ -11,7 +11,7 @@ export interface ListTaskDefinitionFamiliesCommandOutput extends ListTaskDefinit
|
|
|
11
11
|
* <p>Returns a list of task definition families that are registered to your account. This
|
|
12
12
|
* list includes task definition families that no longer have any <code>ACTIVE</code> task
|
|
13
13
|
* definition revisions.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>You can filter out task definition families that don't contain any <code>ACTIVE</code>
|
|
15
15
|
* task definition revisions by setting the <code>status</code> parameter to
|
|
16
16
|
* <code>ACTIVE</code>. You can also filter the results with the
|
|
17
17
|
* <code>familyPrefix</code> parameter.</p>
|
|
@@ -11,7 +11,7 @@ export interface ListTasksCommandOutput extends ListTasksResponse, __MetadataBea
|
|
|
11
11
|
* <p>Returns a list of tasks. You can filter the results by cluster, task definition
|
|
12
12
|
* family, container instance, launch type, what IAM principal started the task, or by the
|
|
13
13
|
* desired status of the task.</p>
|
|
14
|
-
*
|
|
14
|
+
* <p>Recently stopped tasks might appear in the returned results. Currently, stopped tasks
|
|
15
15
|
* appear in the returned results for at least one hour.</p>
|
|
16
16
|
* @example
|
|
17
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,24 +9,24 @@ export interface PutAccountSettingCommandOutput extends PutAccountSettingRespons
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Modifies an account setting. Account settings are set on a per-Region basis.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>If you change the account setting for the root user, the default settings for all of
|
|
13
13
|
* the IAM users and roles that no individual account setting was specified are reset for.
|
|
14
14
|
* For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html">Account
|
|
15
15
|
* Settings</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
16
|
-
*
|
|
16
|
+
* <p>When <code>serviceLongArnFormat</code>, <code>taskLongArnFormat</code>, or
|
|
17
17
|
* <code>containerInstanceLongArnFormat</code> are specified, the Amazon Resource Name
|
|
18
18
|
* (ARN) and resource ID format of the resource type for a specified IAM user, IAM role, or
|
|
19
19
|
* the root user for an account is affected. The opt-in and opt-out account setting must be
|
|
20
20
|
* set for each Amazon ECS resource separately. The ARN and resource ID format of a resource
|
|
21
21
|
* is defined by the opt-in status of the IAM user or role that created the resource. You
|
|
22
22
|
* must turn on this setting to use Amazon ECS features such as resource tagging.</p>
|
|
23
|
-
*
|
|
23
|
+
* <p>When <code>awsvpcTrunking</code> is specified, the elastic network interface (ENI)
|
|
24
24
|
* limit for any new container instances that support the feature is changed. If
|
|
25
25
|
* <code>awsvpcTrunking</code> is enabled, any new container instances that support the
|
|
26
26
|
* feature are launched have the increased ENI limits available to them. For more
|
|
27
27
|
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-eni.html">Elastic Network
|
|
28
28
|
* Interface Trunking</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
29
|
-
*
|
|
29
|
+
* <p>When <code>containerInsights</code> is specified, the default setting indicating
|
|
30
30
|
* whether CloudWatch Container Insights is enabled for your clusters is changed. If
|
|
31
31
|
* <code>containerInsights</code> is enabled, any new clusters that are created will
|
|
32
32
|
* have Container Insights enabled unless you disable it during cluster creation. For more
|
|
@@ -10,14 +10,14 @@ export interface PutClusterCapacityProvidersCommandOutput extends PutClusterCapa
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Modifies the available capacity providers and the default capacity provider strategy
|
|
12
12
|
* for a cluster.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>You must specify both the available capacity providers and a default capacity provider
|
|
14
14
|
* strategy for the cluster. If the specified cluster has existing capacity providers
|
|
15
15
|
* associated with it, you must specify all existing capacity providers in addition to any
|
|
16
16
|
* new ones you want to add. Any existing capacity providers that are associated with a
|
|
17
17
|
* cluster that are omitted from a <a>PutClusterCapacityProviders</a> API call
|
|
18
18
|
* will be disassociated with the cluster. You can only disassociate an existing capacity
|
|
19
19
|
* provider from a cluster if it's not being used by any existing tasks.</p>
|
|
20
|
-
*
|
|
20
|
+
* <p>When creating a service or running a task on a cluster, if no capacity provider or
|
|
21
21
|
* launch type is specified, then the cluster's default capacity provider strategy is used.
|
|
22
22
|
* We recommend that you define a default capacity provider strategy for your cluster.
|
|
23
23
|
* However, you must specify an empty array (<code>[]</code>) to bypass defining a default
|
|
@@ -11,7 +11,7 @@ export interface RegisterContainerInstanceCommandOutput extends RegisterContaine
|
|
|
11
11
|
* <note>
|
|
12
12
|
* <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p>
|
|
13
13
|
* </note>
|
|
14
|
-
*
|
|
14
|
+
* <p>Registers an EC2 instance into the specified cluster. This instance becomes available
|
|
15
15
|
* to place containers on.</p>
|
|
16
16
|
* @example
|
|
17
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -13,12 +13,12 @@ export interface RegisterTaskDefinitionCommandOutput extends RegisterTaskDefinit
|
|
|
13
13
|
* containers with the <code>volumes</code> parameter. For more information about task
|
|
14
14
|
* definition parameters and defaults, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html">Amazon ECS Task
|
|
15
15
|
* Definitions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
16
|
-
*
|
|
16
|
+
* <p>You can specify an IAM role for your task with the <code>taskRoleArn</code> parameter.
|
|
17
17
|
* When you specify an IAM role for a task, its containers can then use the latest versions
|
|
18
18
|
* of the CLI or SDKs to make API requests to the Amazon Web Services services that are specified in
|
|
19
19
|
* the IAM 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
|
|
20
20
|
* Roles for Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
21
|
-
*
|
|
21
|
+
* <p>You can specify a Docker networking mode for the containers in your task definition
|
|
22
22
|
* with the <code>networkMode</code> parameter. The available network modes correspond to
|
|
23
23
|
* those described in <a href="https://docs.docker.com/engine/reference/run/#/network-settings">Network
|
|
24
24
|
* settings</a> in the Docker run reference. If you specify the <code>awsvpc</code>
|
|
@@ -9,32 +9,32 @@ export interface RunTaskCommandOutput extends RunTaskResponse, __MetadataBearer
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Starts a new task using the specified task definition.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places
|
|
13
13
|
* tasks using placement constraints and placement strategies. For more information, see
|
|
14
14
|
* <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>
|
|
15
|
-
*
|
|
15
|
+
* <p>Alternatively, you can use <a>StartTask</a> to use your own scheduler or
|
|
16
16
|
* place tasks manually on specific container instances.</p>
|
|
17
|
-
*
|
|
17
|
+
* <p>The Amazon ECS API follows an eventual consistency model. This is because of the
|
|
18
18
|
* distributed nature of the system supporting the API. This means that the result of an
|
|
19
19
|
* API command you run that affects your Amazon ECS resources might not be immediately visible
|
|
20
20
|
* to all subsequent commands you run. Keep this in mind when you carry out an API command
|
|
21
21
|
* that immediately follows a previous API command.</p>
|
|
22
|
-
*
|
|
23
|
-
*
|
|
22
|
+
* <p>To manage eventual consistency, you can do the following:</p>
|
|
23
|
+
* <ul>
|
|
24
24
|
* <li>
|
|
25
|
-
*
|
|
25
|
+
* <p>Confirm the state of the resource before you run a command to modify it. Run
|
|
26
26
|
* the DescribeTasks command using an exponential backoff algorithm to ensure that
|
|
27
27
|
* you allow enough time for the previous command to propagate through the system.
|
|
28
28
|
* To do this, run the DescribeTasks command repeatedly, starting with a couple of
|
|
29
29
|
* seconds of wait time and increasing gradually up to five minutes of wait
|
|
30
30
|
* time.</p>
|
|
31
|
-
*
|
|
31
|
+
* </li>
|
|
32
32
|
* <li>
|
|
33
|
-
*
|
|
33
|
+
* <p>Add wait time between subsequent commands, even if the DescribeTasks command
|
|
34
34
|
* returns an accurate response. Apply an exponential backoff algorithm starting
|
|
35
35
|
* with a couple of seconds of wait time, and increase gradually up to about five
|
|
36
36
|
* minutes of wait time.</p>
|
|
37
|
-
*
|
|
37
|
+
* </li>
|
|
38
38
|
* </ul>
|
|
39
39
|
* @example
|
|
40
40
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,7 +10,7 @@ export interface StartTaskCommandOutput extends StartTaskResponse, __MetadataBea
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Starts a new task from the specified task definition on the specified container
|
|
12
12
|
* instance or instances.</p>
|
|
13
|
-
*
|
|
13
|
+
* <p>Alternatively, you can use <a>RunTask</a> to place tasks for you. For more
|
|
14
14
|
* 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>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,18 +9,18 @@ export interface StopTaskCommandOutput extends StopTaskResponse, __MetadataBeare
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Stops a running task. Any tags associated with the task will be deleted.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>When <a>StopTask</a> is called on a task, the equivalent of <code>docker
|
|
13
13
|
* stop</code> is issued to the containers running in the task. This results in a
|
|
14
14
|
* <code>SIGTERM</code> value and a default 30-second timeout, after which the
|
|
15
15
|
* <code>SIGKILL</code> value is sent and the containers are forcibly stopped. If the
|
|
16
16
|
* container handles the <code>SIGTERM</code> value gracefully and exits within 30 seconds
|
|
17
17
|
* from receiving it, no <code>SIGKILL</code> value is sent.</p>
|
|
18
|
-
*
|
|
19
|
-
*
|
|
18
|
+
* <note>
|
|
19
|
+
* <p>The default 30-second timeout can be configured on the Amazon ECS container agent with
|
|
20
20
|
* the <code>ECS_CONTAINER_STOP_TIMEOUT</code> variable. For more information, see
|
|
21
21
|
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html">Amazon ECS Container Agent Configuration</a> in the
|
|
22
22
|
* <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
23
|
-
*
|
|
23
|
+
* </note>
|
|
24
24
|
* @example
|
|
25
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
26
26
|
* ```javascript
|
|
@@ -11,7 +11,7 @@ export interface SubmitAttachmentStateChangesCommandOutput extends SubmitAttachm
|
|
|
11
11
|
* <note>
|
|
12
12
|
* <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p>
|
|
13
13
|
* </note>
|
|
14
|
-
*
|
|
14
|
+
* <p>Sent to acknowledge that an attachment changed states.</p>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
17
|
* ```javascript
|
|
@@ -11,7 +11,7 @@ export interface SubmitContainerStateChangeCommandOutput extends SubmitContainer
|
|
|
11
11
|
* <note>
|
|
12
12
|
* <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p>
|
|
13
13
|
* </note>
|
|
14
|
-
*
|
|
14
|
+
* <p>Sent to acknowledge that a container changed states.</p>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
17
|
* ```javascript
|
|
@@ -11,7 +11,7 @@ export interface SubmitTaskStateChangeCommandOutput extends SubmitTaskStateChang
|
|
|
11
11
|
* <note>
|
|
12
12
|
* <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p>
|
|
13
13
|
* </note>
|
|
14
|
-
*
|
|
14
|
+
* <p>Sent to acknowledge that a task changed states.</p>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
17
|
* ```javascript
|
|
@@ -12,19 +12,19 @@ export interface UpdateContainerAgentCommandOutput extends UpdateContainerAgentR
|
|
|
12
12
|
* Amazon ECS container agent doesn't interrupt running tasks or services on the container
|
|
13
13
|
* instance. The process for updating the agent differs depending on whether your container
|
|
14
14
|
* instance was launched with the Amazon ECS-optimized AMI or another operating system.</p>
|
|
15
|
-
*
|
|
16
|
-
*
|
|
15
|
+
* <note>
|
|
16
|
+
* <p>The <code>UpdateContainerAgent</code> API isn't supported for container instances
|
|
17
17
|
* using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent,
|
|
18
18
|
* you can update the <code>ecs-init</code> package. This updates the agent. For more
|
|
19
19
|
* information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/agent-update-ecs-ami.html">Updating the
|
|
20
20
|
* Amazon ECS container agent</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
21
|
+
* </note>
|
|
22
|
+
* <note>
|
|
23
|
+
* <p>Agent updates with the <code>UpdateContainerAgent</code> API operation do not
|
|
24
24
|
* apply to Windows container instances. We recommend that you launch new container
|
|
25
25
|
* instances to update the agent version in your Windows clusters.</p>
|
|
26
|
-
*
|
|
27
|
-
*
|
|
26
|
+
* </note>
|
|
27
|
+
* <p>The <code>UpdateContainerAgent</code> API requires an Amazon ECS-optimized AMI or Amazon
|
|
28
28
|
* Linux AMI with the <code>ecs-init</code> service installed and running. For help
|
|
29
29
|
* 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>
|
|
30
30
|
* @example
|
|
@@ -9,27 +9,27 @@ export interface UpdateContainerInstancesStateCommandOutput extends UpdateContai
|
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
11
|
* <p>Modifies the status of an Amazon ECS container instance.</p>
|
|
12
|
-
*
|
|
12
|
+
* <p>Once a container instance has reached an <code>ACTIVE</code> state, you can change the
|
|
13
13
|
* status of a container instance to <code>DRAINING</code> to manually remove an instance
|
|
14
14
|
* from a cluster, for example to perform system updates, update the Docker daemon, or
|
|
15
15
|
* scale down the cluster size.</p>
|
|
16
|
-
*
|
|
17
|
-
*
|
|
16
|
+
* <important>
|
|
17
|
+
* <p>A container instance can't be changed to <code>DRAINING</code> until it has
|
|
18
18
|
* reached an <code>ACTIVE</code> status. If the instance is in any other status, an
|
|
19
19
|
* error will be received.</p>
|
|
20
|
-
*
|
|
21
|
-
*
|
|
20
|
+
* </important>
|
|
21
|
+
* <p>When you set a container instance to <code>DRAINING</code>, Amazon ECS prevents new tasks
|
|
22
22
|
* from being scheduled for placement on the container instance and replacement service
|
|
23
23
|
* tasks are started on other container instances in the cluster if the resources are
|
|
24
24
|
* available. Service tasks on the container instance that are in the <code>PENDING</code>
|
|
25
25
|
* state are stopped immediately.</p>
|
|
26
|
-
*
|
|
26
|
+
* <p>Service tasks on the container instance that are in the <code>RUNNING</code> state are
|
|
27
27
|
* stopped and replaced according to the service's deployment configuration parameters,
|
|
28
28
|
* <code>minimumHealthyPercent</code> and <code>maximumPercent</code>. You can change
|
|
29
29
|
* the deployment configuration of your service using <a>UpdateService</a>.</p>
|
|
30
|
-
*
|
|
30
|
+
* <ul>
|
|
31
31
|
* <li>
|
|
32
|
-
*
|
|
32
|
+
* <p>If <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore
|
|
33
33
|
* <code>desiredCount</code> temporarily during task replacement. For example,
|
|
34
34
|
* <code>desiredCount</code> is four tasks, a minimum of 50% allows the
|
|
35
35
|
* scheduler to stop two existing tasks before starting two new tasks. If the
|
|
@@ -39,22 +39,22 @@ export interface UpdateContainerInstancesStateCommandOutput extends UpdateContai
|
|
|
39
39
|
* state. Tasks for services that use a load balancer are considered healthy if
|
|
40
40
|
* they're in the <code>RUNNING</code> state and are reported as healthy by the
|
|
41
41
|
* load balancer.</p>
|
|
42
|
-
*
|
|
42
|
+
* </li>
|
|
43
43
|
* <li>
|
|
44
|
-
*
|
|
44
|
+
* <p>The <code>maximumPercent</code> parameter represents an upper limit on the
|
|
45
45
|
* number of running tasks during task replacement. You can use this to define the
|
|
46
46
|
* replacement batch size. For example, if <code>desiredCount</code> is four tasks,
|
|
47
47
|
* a maximum of 200% starts four new tasks before stopping the four tasks to be
|
|
48
48
|
* drained, provided that the cluster resources required to do this are available.
|
|
49
49
|
* If the maximum is 100%, then replacement tasks can't start until the draining
|
|
50
50
|
* tasks have stopped.</p>
|
|
51
|
-
*
|
|
51
|
+
* </li>
|
|
52
52
|
* </ul>
|
|
53
|
-
*
|
|
53
|
+
* <p>Any <code>PENDING</code> or <code>RUNNING</code> tasks that do not belong to a service
|
|
54
54
|
* aren't affected. You must wait for them to finish or stop them manually.</p>
|
|
55
|
-
*
|
|
55
|
+
* <p>A container instance has completed draining when it has no more <code>RUNNING</code>
|
|
56
56
|
* tasks. You can verify this using <a>ListTasks</a>.</p>
|
|
57
|
-
*
|
|
57
|
+
* <p>When a container instance has been drained, you can set a container instance to
|
|
58
58
|
* <code>ACTIVE</code> status and once it has reached that status the Amazon ECS scheduler
|
|
59
59
|
* can begin scheduling tasks on the instance again.</p>
|
|
60
60
|
* @example
|