@aws-sdk/client-ecs 3.306.0 → 3.307.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.
@@ -109,6 +109,9 @@ export declare class ECS extends ECSClient {
109
109
  * the number of tasks running in a service drops below the <code>desiredCount</code>,
110
110
  * Amazon ECS runs another copy of the task in the specified cluster. To update an existing
111
111
  * service, see the <a>UpdateService</a> action.</p>
112
+ * <note>
113
+ * <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>
114
+ * </note>
112
115
  * <p>In addition to maintaining the desired count of tasks in your service, you can
113
116
  * optionally run your service behind one or more load balancers. The load balancers
114
117
  * distribute traffic across the tasks that are associated with the service. For more
@@ -641,6 +644,9 @@ export declare class ECS extends ECSClient {
641
644
  * <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>
642
645
  * <p>Alternatively, you can use <a>StartTask</a> to use your own scheduler or
643
646
  * place tasks manually on specific container instances.</p>
647
+ * <note>
648
+ * <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>
649
+ * </note>
644
650
  * <p>The Amazon ECS API follows an eventual consistency model. This is because of the
645
651
  * distributed nature of the system supporting the API. This means that the result of an
646
652
  * API command you run that affects your Amazon ECS resources might not be immediately visible
@@ -671,6 +677,9 @@ export declare class ECS extends ECSClient {
671
677
  * @public
672
678
  * <p>Starts a new task from the specified task definition on the specified container
673
679
  * instance or instances.</p>
680
+ * <note>
681
+ * <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>
682
+ * </note>
674
683
  * <p>Alternatively, you can use <a>RunTask</a> to place tasks for you. For more
675
684
  * 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>
676
685
  */
@@ -23,6 +23,9 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
23
23
  * the number of tasks running in a service drops below the <code>desiredCount</code>,
24
24
  * Amazon ECS runs another copy of the task in the specified cluster. To update an existing
25
25
  * service, see the <a>UpdateService</a> action.</p>
26
+ * <note>
27
+ * <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>
28
+ * </note>
26
29
  * <p>In addition to maintaining the desired count of tasks in your service, you can
27
30
  * optionally run your service behind one or more load balancers. The load balancers
28
31
  * distribute traffic across the tasks that are associated with the service. For more
@@ -25,6 +25,9 @@ export interface RunTaskCommandOutput extends RunTaskResponse, __MetadataBearer
25
25
  * <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>
26
26
  * <p>Alternatively, you can use <a>StartTask</a> to use your own scheduler or
27
27
  * place tasks manually on specific container instances.</p>
28
+ * <note>
29
+ * <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>
30
+ * </note>
28
31
  * <p>The Amazon ECS API follows an eventual consistency model. This is because of the
29
32
  * distributed nature of the system supporting the API. This means that the result of an
30
33
  * API command you run that affects your Amazon ECS resources might not be immediately visible
@@ -21,6 +21,9 @@ export interface StartTaskCommandOutput extends StartTaskResponse, __MetadataBea
21
21
  * @public
22
22
  * <p>Starts a new task from the specified task definition on the specified container
23
23
  * instance or instances.</p>
24
+ * <note>
25
+ * <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>
26
+ * </note>
24
27
  * <p>Alternatively, you can use <a>RunTask</a> to place tasks for you. For more
25
28
  * 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>
26
29
  * @example
@@ -70,9 +70,12 @@ export interface ManagedScaling {
70
70
  */
71
71
  status?: ManagedScalingStatus | string;
72
72
  /**
73
- * <p>The target capacity value for the capacity provider. The specified value must be
74
- * greater than <code>0</code> and less than or equal to <code>100</code>. A value of
75
- * <code>100</code> results in the Amazon EC2 instances in your Auto Scaling group being
73
+ * <p>The target capacity utilization as a percentage for the capacity provider. The
74
+ * specified value must be greater than <code>0</code> and less than or equal to
75
+ * <code>100</code>. For example, if you want the capacity provider to maintain 10%
76
+ * spare capacity, then that means the utilization is 90%, so use a
77
+ * <code>targetCapacity</code> of <code>90</code>. The default value of
78
+ * <code>100</code> percent results in the Amazon EC2 instances in your Auto Scaling group being
76
79
  * completely used.</p>
77
80
  */
78
81
  targetCapacity?: number;
@@ -1246,8 +1249,6 @@ export type LaunchType = (typeof LaunchType)[keyof typeof LaunchType];
1246
1249
  /**
1247
1250
  * @public
1248
1251
  * <p>The load balancer configuration to use with a service or task set.</p>
1249
- * <p>For specific notes and restrictions regarding the use of load balancers with services
1250
- * and task sets, see the CreateService and CreateTaskSet actions.</p>
1251
1252
  * <p>When you add, update, or remove a load balancer configuration, Amazon ECS starts a new
1252
1253
  * deployment with the updated Elastic Load Balancing configuration. This causes tasks to register to and
1253
1254
  * deregister from load balancers.</p>
@@ -1632,7 +1633,7 @@ export interface ServiceConnectService {
1632
1633
  * <p>The <code>discoveryName</code> is the name of the new Cloud Map service that Amazon ECS creates
1633
1634
  * for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters,
1634
1635
  * numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.</p>
1635
- * <p>If this parameter isn't specified, the default value of <code>discoveryName.namespace</code> is used. If the <code>discoveryName</code> isn't specified, the port mapping name from the task definition is used in <code>portName.namespace</code>.</p>
1636
+ * <p>If the <code>discoveryName</code> isn't specified, the port mapping name from the task definition is used in <code>portName.namespace</code>.</p>
1636
1637
  */
1637
1638
  discoveryName?: string;
1638
1639
  /**
@@ -2048,7 +2049,7 @@ export interface CreateServiceRequest {
2048
2049
  /**
2049
2050
  * <p>Specifies whether to propagate the tags from the task definition to the task. If no
2050
2051
  * value is specified, the tags aren't propagated. Tags can only be propagated to the task
2051
- * during task creation. To add tags to a task after task creation, use the <a>TagResource</a> API action.</p>
2052
+ * 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>
2052
2053
  */
2053
2054
  propagateTags?: PropagateTags | string;
2054
2055
  /**
@@ -2098,7 +2099,7 @@ export interface ServiceConnectServiceResource {
2098
2099
  * <p>The <code>discoveryName</code> is the name of the new Cloud Map service that Amazon ECS creates
2099
2100
  * for this Amazon ECS service. This must be unique within the Cloud Map namespace. The name can contain up to 64 characters. The name can include lowercase letters,
2100
2101
  * numbers, underscores (_), and hyphens (-). The name can't start with a hyphen.</p>
2101
- * <p>If this parameter isn't specified, the default value of <code>discoveryName.namespace</code> is used. If the <code>discoveryName</code> isn't specified, the port mapping name from the task definition is used in <code>portName.namespace</code>.</p>
2102
+ * <p>If the <code>discoveryName</code> isn't specified, the port mapping name from the task definition is used in <code>portName.namespace</code>.</p>
2102
2103
  */
2103
2104
  discoveryName?: string;
2104
2105
  /**
@@ -2498,7 +2499,7 @@ export interface TaskSet {
2498
2499
  }
2499
2500
  /**
2500
2501
  * @public
2501
- * <p>Details on a service within a cluster</p>
2502
+ * <p>Details on a service within a cluster.</p>
2502
2503
  */
2503
2504
  export interface Service {
2504
2505
  /**
@@ -3428,7 +3429,7 @@ export interface FirelensConfiguration {
3428
3429
  * <p>An object representing a container health check. Health check parameters that are
3429
3430
  * specified in a container definition override any Docker health checks that exist in the
3430
3431
  * container image (such as those specified in a parent image or from the image's
3431
- * Dockerfile).</p>
3432
+ * Dockerfile). This configuration maps to the <code>HEALTHCHECK</code> parameter of <a href="https://docs.docker.com/engine/reference/run/">docker run</a>.</p>
3432
3433
  * <note>
3433
3434
  * <p>The Amazon ECS container agent only monitors and reports on the health checks specified
3434
3435
  * in the task definition. Amazon ECS does not monitor Docker health checks that are
@@ -3457,8 +3458,8 @@ export interface FirelensConfiguration {
3457
3458
  * </li>
3458
3459
  * </ul>
3459
3460
  * <p>The following describes the possible <code>healthStatus</code> values for a task. The
3460
- * container health check status of nonessential containers only affects the health status
3461
- * of a task if no essential containers have health checks defined.</p>
3461
+ * container health check status of
3462
+ * non-essential containers don't have an effect on the health status of a task.</p>
3462
3463
  * <ul>
3463
3464
  * <li>
3464
3465
  * <p>
@@ -3473,22 +3474,15 @@ export interface FirelensConfiguration {
3473
3474
  * <li>
3474
3475
  * <p>
3475
3476
  * <code>UNKNOWN</code>-The essential containers within the task are still
3476
- * having their health checks evaluated or there are only nonessential containers
3477
- * with health checks defined.</p>
3477
+ * having their health checks evaluated, there are only nonessential containers
3478
+ * with health checks defined, or there are no container health checks
3479
+ * defined.</p>
3478
3480
  * </li>
3479
3481
  * </ul>
3480
3482
  * <p>If a task is run manually, and not as part of a service, the task will continue its
3481
3483
  * lifecycle regardless of its health status. For tasks that are part of a service, if the
3482
3484
  * task reports as unhealthy then the task will be stopped and the service scheduler will
3483
3485
  * replace it.</p>
3484
- * <important>
3485
- * <p>For tasks that are a part of a service and the service uses the <code>ECS</code>
3486
- * rolling deployment type, the deployment is paused while the new tasks have the
3487
- * <code>UNKNOWN</code> task health check status. For example, tasks that define
3488
- * health checks for nonessential containers when no essential containers have health
3489
- * checks will have the <code>UNKNOWN</code> health check status indefinitely which
3490
- * prevents the deployment from completing.</p>
3491
- * </important>
3492
3486
  * <p>The following are notes about container health check support:</p>
3493
3487
  * <ul>
3494
3488
  * <li>
@@ -3664,7 +3658,7 @@ export interface Tmpfs {
3664
3658
  }
3665
3659
  /**
3666
3660
  * @public
3667
- * <p>Linux-specific options that are applied to the container, such as Linux <a>KernelCapabilities</a>.</p>
3661
+ * <p>The Linux-specific options that are applied to the container, such as Linux <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html">KernelCapabilities</a>.</p>
3668
3662
  */
3669
3663
  export interface LinuxParameters {
3670
3664
  /**
@@ -3746,7 +3740,7 @@ export interface LinuxParameters {
3746
3740
  }
3747
3741
  /**
3748
3742
  * @public
3749
- * <p>Details for a volume mount point that's used in a container definition.</p>
3743
+ * <p>The details for a volume mount point that's used in a container definition.</p>
3750
3744
  */
3751
3745
  export interface MountPoint {
3752
3746
  /**
@@ -3855,7 +3849,7 @@ export interface PortMapping {
3855
3849
  * Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in
3856
3850
  * a running task is also reserved while the task is running. That is, after a task stops,
3857
3851
  * the host port is released. The current reserved ports are displayed in the
3858
- * <code>remainingResources</code> of <a>DescribeContainerInstances</a>
3852
+ * <code>remainingResources</code> of <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeContainerInstances.html">DescribeContainerInstances</a>
3859
3853
  * output. A container instance can have up to 100 reserved ports at a time. This number
3860
3854
  * includes the default reserved ports. Automatically assigned ports aren't included in the
3861
3855
  * 100 reserved ports quota.</p>
@@ -3985,9 +3979,9 @@ export declare const ResourceType: {
3985
3979
  export type ResourceType = (typeof ResourceType)[keyof typeof ResourceType];
3986
3980
  /**
3987
3981
  * @public
3988
- * <p>The type and amount of a resource to assign to a container. The supported resource
3989
- * types are GPUs and Elastic Inference accelerators. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html">Working with
3990
- * GPUs on Amazon ECS</a> or <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html">Working with
3982
+ * <p>The type and amount of a resource to assign to a container. The supported resource types are
3983
+ * GPUs and Elastic Inference accelerators. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html">Working with
3984
+ * GPUs on Amazon ECS</a> or <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/url-ecs-dev;ecs-inference.html">Working with
3991
3985
  * Amazon Elastic Inference on Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>
3992
3986
  * </p>
3993
3987
  */
@@ -3999,7 +3993,7 @@ export interface ResourceRequirement {
3999
3993
  * of GPUs that's reserved for all containers in a task can't exceed the number of
4000
3994
  * available GPUs on the container instance that the task is launched on.</p>
4001
3995
  * <p>If the <code>InferenceAccelerator</code> type is used, the <code>value</code> matches
4002
- * the <code>deviceName</code> for an <a>InferenceAccelerator</a> specified in a
3996
+ * the <code>deviceName</code> for an <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_InferenceAccelerator.html">InferenceAccelerator</a> specified in a
4003
3997
  * task definition.</p>
4004
3998
  */
4005
3999
  value: string | undefined;
@@ -4783,7 +4777,7 @@ export interface EphemeralStorage {
4783
4777
  export interface InferenceAccelerator {
4784
4778
  /**
4785
4779
  * <p>The Elastic Inference accelerator device name. The <code>deviceName</code> must also
4786
- * be referenced in a container definition as a <a>ResourceRequirement</a>.</p>
4780
+ * be referenced in a container definition as a <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ResourceRequirement.html">ResourceRequirement</a>.</p>
4787
4781
  */
4788
4782
  deviceName: string | undefined;
4789
4783
  /**
@@ -5397,8 +5391,8 @@ export interface TaskDefinition {
5397
5391
  */
5398
5392
  runtimePlatform?: RuntimePlatform;
5399
5393
  /**
5400
- * <p>The task launch types the task definition was validated against. To determine which
5401
- * task launch types the task definition is validated for, see the <a>TaskDefinition$compatibilities</a> parameter.</p>
5394
+ * <p>The task launch types the task definition was validated against. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html">Amazon ECS launch types</a>
5395
+ * in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
5402
5396
  */
5403
5397
  requiresCompatibilities?: (Compatibility | string)[];
5404
5398
  /**
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-ecs",
3
3
  "description": "AWS SDK for JavaScript Ecs Client for Node.js, Browser and React Native",
4
- "version": "3.306.0",
4
+ "version": "3.307.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",