Skip to content

Commit 0d0eeef

Browse files
author
awstools
committed
docs(client-ecs): Documentation only update for Amazon ECS.
1 parent 8c6a065 commit 0d0eeef

File tree

7 files changed

+55
-45
lines changed

7 files changed

+55
-45
lines changed

clients/client-ecs/src/commands/CreateServiceCommand.ts

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
3232
* Amazon ECS runs another copy of the task in the specified cluster. To update an existing
3333
* service, see the <a>UpdateService</a> action.</p>
3434
* <note>
35-
* <p>Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. </p>
35+
* <p>The following change began on March 21, 2024. When the task definition revision is not specified, Amazon ECS resolves the task definition revision before it authorizes the task definition.</p>
3636
* </note>
3737
* <p>In addition to maintaining the desired count of tasks in your service, you can
3838
* optionally run your service behind one or more load balancers. The load balancers
@@ -107,9 +107,11 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
107107
* <p>When creating a service that uses the <code>EXTERNAL</code> deployment controller, you
108108
* can specify only parameters that aren't controlled at the task set level. The only
109109
* 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>
110-
* <p>When the service scheduler launches new tasks, it determines task placement. For
111-
* information about task placement and task placement strategies, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html">Amazon ECS
112-
* task placement</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
110+
* <p>When the service scheduler launches new tasks, it determines task placement. For information
111+
* about task placement and task placement strategies, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement.html">Amazon ECS
112+
* task placement</a> in the <i>Amazon Elastic Container Service Developer Guide</i>
113+
* </p>
114+
* <p>Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. </p>
113115
* @example
114116
* Use a bare-bones client and the command you need to make an API call.
115117
* ```javascript

clients/client-ecs/src/commands/CreateTaskSetCommand.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,11 @@ export interface CreateTaskSetCommandOutput extends CreateTaskSetResponse, __Met
3131
* uses the <code>EXTERNAL</code> deployment controller type. For more information, see
3232
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html">Amazon ECS deployment
3333
* types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
34+
* <note>
35+
* <p>The following change began on March 21, 2024. When the task definition revision is not specified, Amazon ECS resolves the task definition revision before it authorizes the task definition.</p>
36+
* </note>
3437
* <p>For information about the maximum number of task sets and otther quotas, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-quotas.html">Amazon ECS
35-
* service quotas</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
38+
* service quotas</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
3639
* @example
3740
* Use a bare-bones client and the command you need to make an API call.
3841
* ```javascript

clients/client-ecs/src/commands/RunTaskCommand.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,15 @@ export interface RunTaskCommandOutput extends RunTaskResponse, __MetadataBearer
2828

2929
/**
3030
* <p>Starts a new task using the specified task definition.</p>
31+
* <note>
32+
* <p>The following change began on March 21, 2024. When the task definition revision is not specified, Amazon ECS resolves the task definition revision before it authorizes the task definition.</p>
33+
* </note>
3134
* <p>You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places
3235
* tasks using placement constraints and placement strategies. For more information, see
3336
* <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>
3437
* <p>Alternatively, you can use <a>StartTask</a> to use your own scheduler or
3538
* place tasks manually on specific container instances.</p>
36-
* <note>
37-
* <p>Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. </p>
38-
* </note>
39+
* <p>Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. </p>
3940
* <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or
4041
* updating a service. For more infomation, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volume-types">Amazon EBS volumes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
4142
* <p>The Amazon ECS API follows an eventual consistency model. This is because of the

clients/client-ecs/src/commands/StartTaskCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,9 @@ export interface StartTaskCommandOutput extends StartTaskResponse, __MetadataBea
3030
* <p>Starts a new task from the specified task definition on the specified container
3131
* instance or instances.</p>
3232
* <note>
33-
* <p>Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. </p>
33+
* <p>The following change began on March 21, 2024. When the task definition revision is not specified, Amazon ECS resolves the task definition revision before it authorizes the task definition.</p>
3434
* </note>
35+
* <p>Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service. </p>
3536
* <p>Alternatively, you can use <a>RunTask</a> to place tasks for you. For more
3637
* 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>
3738
* <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or

clients/client-ecs/src/commands/UpdateServiceCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ export interface UpdateServiceCommandOutput extends UpdateServiceResponse, __Met
2828

2929
/**
3030
* <p>Modifies the parameters of a service.</p>
31+
* <note>
32+
* <p>The following change began on March 21, 2024. When the task definition revision is not specified, Amazon ECS resolves the task definition revision before it authorizes the task definition.</p>
33+
* </note>
3134
* <p>For services using the rolling update (<code>ECS</code>) you can update the desired
3235
* count, deployment configuration, network configuration, load balancers, service
3336
* registries, enable ECS managed tags option, propagate tags option, task placement

clients/client-ecs/src/models/models_0.ts

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -970,10 +970,10 @@ export interface Attachment {
970970
* <p>For Service Connect services, this includes <code>portName</code>,
971971
* <code>clientAliases</code>, <code>discoveryName</code>, and
972972
* <code>ingressPortOverride</code>.</p>
973-
* <p>For elastic block storage, this includes <code>roleArn</code>, <code>encrypted</code>,
974-
* <code>filesystemType</code>, <code>iops</code>, <code>kmsKeyId</code>,
975-
* <code>sizeInGiB</code>, <code>snapshotId</code>, <code>tagSpecifications</code>,
976-
* <code>throughput</code>, and <code>volumeType</code>.</p>
973+
* <p>For Elastic Block Storage, this includes <code>roleArn</code>,
974+
* <code>deleteOnTermination</code>, <code>volumeName</code>, <code>volumeId</code>,
975+
* and <code>statusReason</code> (only when the attachment fails to create or
976+
* attach).</p>
977977
* @public
978978
*/
979979
details?: KeyValuePair[];
@@ -2608,7 +2608,7 @@ export interface CreateServiceRequest {
26082608
* <note>
26092609
* <p>Fargate Spot infrastructure is available for use but a capacity provider
26102610
* strategy must be used. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-capacity-providers.html">Fargate capacity providers</a> in the
2611-
* <i>Amazon ECS User Guide for Fargate</i>.</p>
2611+
* <i>Amazon ECS Developer Guide</i>.</p>
26122612
* </note>
26132613
* <p>The <code>EC2</code> launch type runs your tasks on Amazon EC2 instances registered to your
26142614
* cluster.</p>
@@ -2636,8 +2636,7 @@ export interface CreateServiceRequest {
26362636
* <p>The platform version that your tasks in the service are running on. A platform version
26372637
* is specified only for tasks using the Fargate launch type. If one isn't
26382638
* specified, the <code>LATEST</code> platform version is used. For more information, see
2639-
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html">Fargate platform
2640-
* versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
2639+
* <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html">Fargate platform versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
26412640
* @public
26422641
*/
26432642
platformVersion?: string;
@@ -2708,13 +2707,11 @@ export interface CreateServiceRequest {
27082707
* <p>If you do not use an Elastic Load Balancing, we recommend that you use the <code>startPeriod</code> in
27092708
* the task definition health check parameters. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html">Health
27102709
* check</a>.</p>
2711-
* <p>If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you
2712-
* can specify a health check grace period of up to
2713-
* 2,147,483,647
2714-
* seconds (about 69 years). During that time, the Amazon ECS service
2715-
* scheduler ignores health check status. This grace period can prevent the service
2716-
* scheduler from marking tasks as unhealthy and stopping them before they have time to
2717-
* come up.</p>
2710+
* <p>If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can
2711+
* specify a health check grace period of up to 2,147,483,647 seconds (about 69 years).
2712+
* During that time, the Amazon ECS service scheduler ignores health check status. This grace
2713+
* period can prevent the service scheduler from marking tasks as unhealthy and stopping
2714+
* them before they have time to come up.</p>
27182715
* @public
27192716
*/
27202717
healthCheckGracePeriodSeconds?: number;
@@ -2812,6 +2809,7 @@ export interface CreateServiceRequest {
28122809
* <p>Specifies whether to propagate the tags from the task definition to the task. If no
28132810
* value is specified, the tags aren't propagated. Tags can only be propagated to the task
28142811
* during task creation. To add tags to a task after task creation, use the <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html">TagResource</a> API action.</p>
2812+
* <p>You must set this to a value other than <code>NONE</code> when you use Cost Explorer. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/usage-reports.html">Amazon ECS usage reports</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
28152813
* <p>The default is <code>NONE</code>.</p>
28162814
* @public
28172815
*/
@@ -4477,8 +4475,8 @@ export type EnvironmentFileType = (typeof EnvironmentFileType)[keyof typeof Envi
44774475
* parameter in a container definition, they take precedence over the variables contained
44784476
* within an environment file. If multiple environment files are specified that contain the
44794477
* same variable, they're processed from the top down. We recommend that you use unique
4480-
* variable names. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html">Specifying environment
4481-
* variables</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
4478+
* variable names. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/use-environment-file.html">Use a file to pass environment variables to a container</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
4479+
* <p>Environment variable files are objects in Amazon S3 and all Amazon S3 security considerations apply. </p>
44824480
* <p>You must use the following platforms for the Fargate launch type:</p>
44834481
* <ul>
44844482
* <li>
@@ -4511,7 +4509,8 @@ export interface EnvironmentFile {
45114509
value: string | undefined;
45124510

45134511
/**
4514-
* <p>The file type to use. The only supported value is <code>s3</code>.</p>
4512+
* <p>The file type to use. Environment files are objects in Amazon S3. The only supported value is
4513+
* <code>s3</code>.</p>
45154514
* @public
45164515
*/
45174516
type: EnvironmentFileType | undefined;
@@ -4598,6 +4597,8 @@ export interface FirelensConfiguration {
45984597
* DescribeTasks API operation or when viewing the task details in the console.</p>
45994598
* <p>The health check is designed to make sure that your containers survive agent restarts,
46004599
* upgrades, or temporary unavailability.</p>
4600+
* <p>Amazon ECS performs health checks on containers with the default that launched the
4601+
* container instance or the task.</p>
46014602
* <p>The following describes the possible <code>healthStatus</code> values for a
46024603
* container:</p>
46034604
* <ul>
@@ -4782,8 +4783,7 @@ export interface HealthCheck {
47824783
}
47834784

47844785
/**
4785-
* <p>The Linux capabilities for the container that are added to or dropped from the default
4786-
* configuration provided by Docker. For more information about the default capabilities
4786+
* <p>The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more information about the default capabilities
47874787
* and the non-default available capabilities, see <a href="https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities">Runtime privilege and Linux capabilities</a> in the <i>Docker run
47884788
* reference</i>. For more detailed information about these Linux capabilities,
47894789
* see the <a href="http://man7.org/linux/man-pages/man7/capabilities.7.html">capabilities(7)</a> Linux manual page.</p>
@@ -6241,8 +6241,8 @@ export interface ContainerDefinition {
62416241
*/
62426242
export interface EphemeralStorage {
62436243
/**
6244-
* <p>The total amount, in GiB, of ephemeral storage to set for the task. The minimum
6245-
* supported value is <code>21</code> GiB and the maximum supported value is
6244+
* <p>The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported
6245+
* value is <code>20</code> GiB and the maximum supported value is
62466246
* <code>200</code> GiB.</p>
62476247
* @public
62486248
*/

0 commit comments

Comments
 (0)