@aws-sdk/client-ecs 3.231.0 → 3.234.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.
Files changed (39) hide show
  1. package/dist-cjs/endpoint/ruleset.js +0 -9
  2. package/dist-cjs/models/models_0.js +8 -4
  3. package/dist-cjs/protocols/Aws_json1_1.js +22 -0
  4. package/dist-es/endpoint/ruleset.js +0 -9
  5. package/dist-es/models/models_0.js +3 -0
  6. package/dist-es/protocols/Aws_json1_1.js +22 -0
  7. package/dist-types/ECS.d.ts +147 -146
  8. package/dist-types/ECSClient.d.ts +3 -3
  9. package/dist-types/commands/CreateCapacityProviderCommand.d.ts +1 -1
  10. package/dist-types/commands/CreateClusterCommand.d.ts +3 -3
  11. package/dist-types/commands/CreateServiceCommand.d.ts +14 -14
  12. package/dist-types/commands/DeleteCapacityProviderCommand.d.ts +4 -4
  13. package/dist-types/commands/DeleteClusterCommand.d.ts +1 -1
  14. package/dist-types/commands/DeleteServiceCommand.d.ts +6 -6
  15. package/dist-types/commands/DeregisterContainerInstanceCommand.d.ts +5 -5
  16. package/dist-types/commands/DeregisterTaskDefinitionCommand.d.ts +4 -4
  17. package/dist-types/commands/DescribeTaskDefinitionCommand.d.ts +3 -3
  18. package/dist-types/commands/DescribeTasksCommand.d.ts +1 -1
  19. package/dist-types/commands/DiscoverPollEndpointCommand.d.ts +1 -1
  20. package/dist-types/commands/ExecuteCommandCommand.d.ts +3 -1
  21. package/dist-types/commands/ListTaskDefinitionFamiliesCommand.d.ts +1 -1
  22. package/dist-types/commands/ListTasksCommand.d.ts +1 -1
  23. package/dist-types/commands/PutAccountSettingCommand.d.ts +4 -4
  24. package/dist-types/commands/PutClusterCapacityProvidersCommand.d.ts +2 -2
  25. package/dist-types/commands/RegisterContainerInstanceCommand.d.ts +1 -1
  26. package/dist-types/commands/RegisterTaskDefinitionCommand.d.ts +2 -2
  27. package/dist-types/commands/RunTaskCommand.d.ts +9 -9
  28. package/dist-types/commands/StartTaskCommand.d.ts +1 -1
  29. package/dist-types/commands/StopTaskCommand.d.ts +4 -4
  30. package/dist-types/commands/SubmitAttachmentStateChangesCommand.d.ts +1 -1
  31. package/dist-types/commands/SubmitContainerStateChangeCommand.d.ts +1 -1
  32. package/dist-types/commands/SubmitTaskStateChangeCommand.d.ts +1 -1
  33. package/dist-types/commands/UpdateContainerAgentCommand.d.ts +7 -7
  34. package/dist-types/commands/UpdateContainerInstancesStateCommand.d.ts +14 -14
  35. package/dist-types/commands/UpdateServiceCommand.d.ts +40 -41
  36. package/dist-types/commands/UpdateTaskProtectionCommand.d.ts +9 -9
  37. package/dist-types/models/models_0.d.ts +1219 -1044
  38. package/dist-types/ts3.4/models/models_0.d.ts +12 -0
  39. package/package.json +7 -7
@@ -9,44 +9,44 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met
9
9
  }
10
10
  /**
11
11
  * <p>Modifies the parameters of a service.</p>
12
- * <p>For services using the rolling update (<code>ECS</code>) you can update the desired
12
+ * <p>For services using the rolling update (<code>ECS</code>) you can update the desired
13
13
  * count, deployment configuration, network configuration, load balancers, service
14
14
  * registries, enable ECS managed tags option, propagate tags option, task placement
15
15
  * constraints and strategies, and task definition. When you update any of these
16
16
  * parameters, Amazon ECS starts new tasks with the new configuration. </p>
17
- * <p>For services using the blue/green (<code>CODE_DEPLOY</code>) deployment controller,
17
+ * <p>For services using the blue/green (<code>CODE_DEPLOY</code>) deployment controller,
18
18
  * only the desired count, deployment configuration, health check grace period, task
19
19
  * placement constraints and strategies, enable ECS managed tags option, and propagate tags
20
20
  * can be updated using this API. If the network configuration, platform version, task
21
21
  * definition, or load balancer need to be updated, create a new CodeDeploy deployment. For more
22
22
  * information, see <a href="https://docs.aws.amazon.com/codedeploy/latest/APIReference/API_CreateDeployment.html">CreateDeployment</a> in the <i>CodeDeploy API Reference</i>.</p>
23
- * <p>For services using an external deployment controller, you can update only the desired
23
+ * <p>For services using an external deployment controller, you can update only the desired
24
24
  * count, task placement constraints and strategies, health check grace period, enable ECS
25
25
  * managed tags option, and propagate tags option, using this API. If the launch type, load
26
26
  * balancer, network configuration, platform version, or task definition need to be
27
27
  * updated, create a new task set For more information, see <a>CreateTaskSet</a>.</p>
28
- * <p>You can add to or subtract from the number of instantiations of a task definition in a
28
+ * <p>You can add to or subtract from the number of instantiations of a task definition in a
29
29
  * service by specifying the cluster that the service is running in and a new
30
30
  * <code>desiredCount</code> parameter.</p>
31
- * <p>If you have updated the Docker image of your application, you can create a new task
31
+ * <p>If you have updated the Docker image of your application, you can create a new task
32
32
  * definition with that image and deploy it to your service. The service scheduler uses the
33
33
  * minimum healthy percent and maximum percent parameters (in the service's deployment
34
34
  * configuration) to determine the deployment strategy.</p>
35
- * <note>
36
- * <p>If your updated Docker image uses the same tag as what is in the existing task
35
+ * <note>
36
+ * <p>If your updated Docker image uses the same tag as what is in the existing task
37
37
  * definition for your service (for example, <code>my_image:latest</code>), you don't
38
38
  * need to create a new revision of your task definition. You can update the service
39
39
  * using the <code>forceNewDeployment</code> option. The new tasks launched by the
40
40
  * deployment pull the current image/tag combination from your repository when they
41
41
  * start.</p>
42
- * </note>
43
- * <p>You can also update the deployment configuration of a service. When a deployment is
42
+ * </note>
43
+ * <p>You can also update the deployment configuration of a service. When a deployment is
44
44
  * triggered by updating the task definition of a service, the service scheduler uses the
45
45
  * deployment configuration parameters, <code>minimumHealthyPercent</code> and
46
46
  * <code>maximumPercent</code>, to determine the deployment strategy.</p>
47
- * <ul>
47
+ * <ul>
48
48
  * <li>
49
- * <p>If <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore
49
+ * <p>If <code>minimumHealthyPercent</code> is below 100%, the scheduler can ignore
50
50
  * <code>desiredCount</code> temporarily during a deployment. For example, if
51
51
  * <code>desiredCount</code> is four tasks, a minimum of 50% allows the
52
52
  * scheduler to stop two existing tasks before starting two new tasks. Tasks for
@@ -54,84 +54,83 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met
54
54
  * <code>RUNNING</code> state. Tasks for services that use a load balancer are
55
55
  * considered healthy if they're in the <code>RUNNING</code> state and are reported
56
56
  * as healthy by the load balancer.</p>
57
- * </li>
57
+ * </li>
58
58
  * <li>
59
- * <p>The <code>maximumPercent</code> parameter represents an upper limit on the
59
+ * <p>The <code>maximumPercent</code> parameter represents an upper limit on the
60
60
  * number of running tasks during a deployment. You can use it to define the
61
61
  * deployment batch size. For example, if <code>desiredCount</code> is four tasks,
62
62
  * a maximum of 200% starts four new tasks before stopping the four older tasks
63
63
  * (provided that the cluster resources required to do this are available).</p>
64
- * </li>
64
+ * </li>
65
65
  * </ul>
66
- * <p>When <a>UpdateService</a> stops a task during a deployment, the equivalent
66
+ * <p>When <a>UpdateService</a> stops a task during a deployment, the equivalent
67
67
  * of <code>docker stop</code> is issued to the containers running in the task. This
68
68
  * results in a <code>SIGTERM</code> and a 30-second timeout. After this,
69
69
  * <code>SIGKILL</code> is sent and the containers are forcibly stopped. If the
70
70
  * container handles the <code>SIGTERM</code> gracefully and exits within 30 seconds from
71
71
  * receiving it, no <code>SIGKILL</code> is sent.</p>
72
- * <p>When the service scheduler launches new tasks, it determines task placement in your
72
+ * <p>When the service scheduler launches new tasks, it determines task placement in your
73
73
  * cluster with the following logic.</p>
74
- * <ul>
74
+ * <ul>
75
75
  * <li>
76
- * <p>Determine which of the container instances in your cluster can support your
76
+ * <p>Determine which of the container instances in your cluster can support your
77
77
  * service's task definition. For example, they have the required CPU, memory,
78
78
  * ports, and container instance attributes.</p>
79
- * </li>
79
+ * </li>
80
80
  * <li>
81
- * <p>By default, the service scheduler attempts to balance tasks across
81
+ * <p>By default, the service scheduler attempts to balance tasks across
82
82
  * Availability Zones in this manner even though you can choose a different
83
83
  * placement strategy.</p>
84
- * <ul>
84
+ * <ul>
85
85
  * <li>
86
- * <p>Sort the valid container instances by the fewest number of running
86
+ * <p>Sort the valid container instances by the fewest number of running
87
87
  * tasks for this service in the same Availability Zone as the instance.
88
88
  * For example, if zone A has one running service task and zones B and C
89
89
  * each have zero, valid container instances in either zone B or C are
90
90
  * considered optimal for placement.</p>
91
- * </li>
91
+ * </li>
92
92
  * <li>
93
- * <p>Place the new service task on a valid container instance in an optimal
93
+ * <p>Place the new service task on a valid container instance in an optimal
94
94
  * Availability Zone (based on the previous steps), favoring container
95
95
  * instances with the fewest number of running tasks for this
96
96
  * service.</p>
97
- * </li>
97
+ * </li>
98
98
  * </ul>
99
- * </li>
99
+ * </li>
100
100
  * </ul>
101
- *
102
- * <p>When the service scheduler stops running tasks, it attempts to maintain balance across
101
+ * <p>When the service scheduler stops running tasks, it attempts to maintain balance across
103
102
  * the Availability Zones in your cluster using the following logic: </p>
104
- * <ul>
103
+ * <ul>
105
104
  * <li>
106
- * <p>Sort the container instances by the largest number of running tasks for this
105
+ * <p>Sort the container instances by the largest number of running tasks for this
107
106
  * service in the same Availability Zone as the instance. For example, if zone A
108
107
  * has one running service task and zones B and C each have two, container
109
108
  * instances in either zone B or C are considered optimal for termination.</p>
110
- * </li>
109
+ * </li>
111
110
  * <li>
112
- * <p>Stop the task on a container instance in an optimal Availability Zone (based
111
+ * <p>Stop the task on a container instance in an optimal Availability Zone (based
113
112
  * on the previous steps), favoring container instances with the largest number of
114
113
  * running tasks for this service.</p>
115
- * </li>
114
+ * </li>
116
115
  * </ul>
117
- * <note>
118
- * <p>You must have a service-linked role when you update any of the following service
116
+ * <note>
117
+ * <p>You must have a service-linked role when you update any of the following service
119
118
  * properties. If you specified a custom IAM role when you created the service, Amazon ECS
120
119
  * automatically replaces the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Service.html#ECS-Type-Service-roleArn">roleARN</a> associated with the service with the ARN of your
121
120
  * service-linked role. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html">Service-linked roles</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
122
- * <ul>
121
+ * <ul>
123
122
  * <li>
124
- * <p>
123
+ * <p>
125
124
  * <code>loadBalancers,</code>
126
125
  * </p>
127
- * </li>
126
+ * </li>
128
127
  * <li>
129
- * <p>
128
+ * <p>
130
129
  * <code>serviceRegistries</code>
131
130
  * </p>
132
- * </li>
131
+ * </li>
133
132
  * </ul>
134
- * </note>
133
+ * </note>
135
134
  * @example
136
135
  * Use a bare-bones client and the command you need to make an API call.
137
136
  * ```javascript
@@ -12,29 +12,29 @@ export interface UpdateTaskProtectionCommandOutput extends UpdateTaskProtectionR
12
12
  * <code>true</code> to protect your task from termination during scale-in events from
13
13
  * <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-auto-scaling.html">Service
14
14
  * Autoscaling</a> or <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">deployments</a>.</p>
15
- * <p>Task-protection, by default, expires after 2 hours at which point Amazon ECS unsets the
15
+ * <p>Task-protection, by default, expires after 2 hours at which point Amazon ECS unsets the
16
16
  * <code>protectionEnabled</code> property making the task eligible for termination by
17
17
  * a subsequent scale-in event.</p>
18
- * <p>You can specify a custom expiration period for task protection from 1 minute to up to
18
+ * <p>You can specify a custom expiration period for task protection from 1 minute to up to
19
19
  * 2,880 minutes (48 hours). To specify the custom expiration period, set the
20
20
  * <code>expiresInMinutes</code> property. The <code>expiresInMinutes</code> property
21
21
  * is always reset when you invoke this operation for a task that already has
22
22
  * <code>protectionEnabled</code> set to <code>true</code>. You can keep extending the
23
23
  * protection expiration period of a task by invoking this operation repeatedly.</p>
24
- * <p>To learn more about Amazon ECS task protection, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-scale-in-protection.html">Task scale-in
24
+ * <p>To learn more about Amazon ECS task protection, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-scale-in-protection.html">Task scale-in
25
25
  * protection</a> in the <i>
26
26
  * <i>Amazon Elastic Container Service Developer Guide</i>
27
27
  * </i>.</p>
28
- * <note>
29
- * <p>This operation is only supported for tasks belonging to an Amazon ECS service. Invoking
28
+ * <note>
29
+ * <p>This operation is only supported for tasks belonging to an Amazon ECS service. Invoking
30
30
  * this operation for a standalone task will result in an <code>TASK_NOT_VALID</code>
31
31
  * failure. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html">API failure
32
32
  * reasons</a>.</p>
33
- * </note>
34
- * <important>
35
- * <p>If you prefer to set task protection from within the container, we recommend using
33
+ * </note>
34
+ * <important>
35
+ * <p>If you prefer to set task protection from within the container, we recommend using
36
36
  * the <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-scale-in-protection-endpoint.html">Task scale-in protection endpoint</a>.</p>
37
- * </important>
37
+ * </important>
38
38
  * @example
39
39
  * Use a bare-bones client and the command you need to make an API call.
40
40
  * ```javascript