@aws-sdk/client-ecs 3.36.0 → 3.39.0

package/dist-types/models/models_0.d.ts

@@ -435,8 +435,8 @@ export interface ExecuteCommandLogConfiguration {
      */
     s3BucketName?: string;
     /**
-     * <p>Whether or not to enable encryption on the CloudWatch logs. If not specified,
-     * 			encryption will be disabled.</p>
+     * <p>Whether or not to use encryption on the S3 logs. If not specified,
+     * 			encryption is not used.</p>
      */
     s3EncryptionEnabled?: boolean;
     /**
@@ -1600,7 +1600,7 @@ export interface CreateServiceRequest {
      * <p>Specifies whether to propagate the tags from the task definition or the service to the
      * 			tasks in the service. If no value is specified, the tags are not propagated. Tags can
      * 			only be propagated to the tasks within the service during service creation. To add tags
-     * 			to a task after service creation, use the <a>TagResource</a> API
+     * 			to a task after service creation or task creation, use the <a>TagResource</a> API
      * 			action.</p>
      */
     propagateTags?: PropagateTags | string;
@@ -1706,6 +1706,11 @@ export interface Deployment {
      * 				Versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
      */
     platformVersion?: string;
+    /**
+     * <p>The operating system  that your tasks in the service, or tasks are running on. A platform family is specified only for tasks using the Fargate launch type. </p>
+     * 		       <p> All tasks that run as part of this service must use the same <code>platformFamily</code> value as the service, for example, <code> LINUX.</code>.</p>
+     */
+    platformFamily?: string;
     /**
      * <p>The VPC subnet and security group configuration for tasks that receive their own
      *             elastic network interface by using the <code>awsvpc</code> networking mode.</p>
@@ -1893,6 +1898,11 @@ export interface TaskSet {
      * 				versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
      */
     platformVersion?: string;
+    /**
+     * <p>The operating system  that your tasks in the set are running on. A platform family is specified only for tasks using the Fargate launch type. </p>
+     * 		       <p> All tasks in the set must have the same value.</p>
+     */
+    platformFamily?: string;
     /**
      * <p>The network configuration for the task set.</p>
      */
@@ -2050,6 +2060,11 @@ export interface Service {
      * 				Versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
      */
     platformVersion?: string;
+    /**
+     * <p>The operating system  that your tasks in the service are running on. A platform family is specified only for tasks using the Fargate launch type. </p>
+     * 		       <p> All tasks that run as part of this service must use the same <code>platformFamily</code> value as the service, for example, <code>LINUX</code>.</p>
+     */
+    platformFamily?: string;
     /**
      * <p>The task definition to use for tasks in the service. This value is specified when the
      * 			service is created with <a>CreateService</a>, and it can be modified with
@@ -3081,8 +3096,17 @@ export declare enum ContainerCondition {
  * 				<code>20190301</code> or later, then they contain the required versions of the
  * 			container agent and <code>ecs-init</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html">Amazon ECS-optimized Linux AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
  * 		       <note>
- * 			         <p>For tasks using the Fargate launch type, this parameter requires
- * 				that the task or service uses platform version 1.3.0 or later.</p>
+ * 			         <p>For tasks using the Fargate launch type, the task or service requires the followiwng platforms:</p>
+ * 			         <ul>
+ *                <li>
+ * 					             <p>Linux platform
+ * 						version <code>1.3.0</code> or later.</p>
+ * 				           </li>
+ *                <li>
+ * 					             <p>Windows platform
+ * 						version <code>1.0.0</code> or later.</p>
+ * 				           </li>
+ *             </ul>
  * 		       </note>
  */
 export interface ContainerDependency {
@@ -3148,8 +3172,17 @@ export declare enum EnvironmentFileType {
  * 			same variable, they are processed from the top down. It is recommended to use unique
  * 			variable names. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html">Specifying environment
  * 				variables</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
- * 		       <p>This field is only valid for containers in Fargate tasks that use
- * 			platform version <code>1.4.0</code> or later.</p>
+ * 		       <p>This parameter is only supported for tasks hosted on Fargate using the following platform versions:</p>
+ * 		       <ul>
+ *             <li>
+ * 				           <p>Linux platform
+ * 					version <code>1.4.0</code> or later.</p>
+ * 			         </li>
+ *             <li>
+ * 				           <p>Windows platform
+ * 					version <code>1.0.0</code> or later.</p>
+ * 			         </li>
+ *          </ul>
  */
 export interface EnvironmentFile {
     /**
@@ -3810,7 +3843,7 @@ export declare enum ResourceType {
 /**
  * <p>The type and amount of a resource to assign to a container. The supported resource
  * 			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
- * 				GPUs on Amazon ECS</a> or <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-eia.html">Working with Amazon Elastic Inference on Amazon ECS</a> in the
+ * 				GPUs on Amazon ECS</a> or <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html">Working with Amazon Elastic Inference on Amazon ECS</a> in the
  * 				<i>Amazon Elastic Container Service Developer Guide</i>
  *          </p>
  */
@@ -4251,8 +4284,17 @@ export interface ContainerDefinition {
      * 				<code>ecs-init</code> package. If your container instances are launched from version
      * 				<code>20190301</code> or later, then they contain the required versions of the
      * 			container agent and <code>ecs-init</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html">Amazon ECS-optimized Linux AMI</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
-     * 		       <p>For tasks using the Fargate launch type, the task or service requires
-     * 			platform version <code>1.3.0</code> or later.</p>
+     * 		       <p>For tasks using the Fargate launch type, the task or service requires the followiwng platforms:</p>
+     * 		       <ul>
+     *             <li>
+     * 				           <p>Linux platform
+     * 					version <code>1.3.0</code> or later.</p>
+     * 			         </li>
+     *             <li>
+     * 				           <p>Windows platform
+     * 					version <code>1.0.0</code> or later.</p>
+     * 			         </li>
+     *          </ul>
      */
     dependsOn?: ContainerDependency[];
     /**
@@ -4267,8 +4309,17 @@ export interface ContainerDefinition {
      * 			         <p>When the <code>ECS_CONTAINER_START_TIMEOUT</code> container agent configuration
      * 				variable is used, it is enforced indendently from this start timeout value.</p>
      * 		       </note>
-     * 		       <p>For tasks using the Fargate launch type, this parameter requires that
-     * 			the task or service uses platform version 1.3.0 or later.</p>
+     * 		       <p>For tasks using the Fargate launch type, the task or service requires the followiwng platforms:</p>
+     * 		       <ul>
+     *             <li>
+     * 				           <p>Linux platform
+     * 					version <code>1.3.0</code> or later.</p>
+     * 			         </li>
+     *             <li>
+     * 				           <p>Windows platform
+     * 					version <code>1.0.0</code> or later.</p>
+     * 			         </li>
+     *          </ul>
      * 		       <p>For tasks using the EC2 launch type, your container instances require at
      * 			least version <code>1.26.0</code> of the container agent to enable a container start
      * 			timeout value. However, we recommend using the latest container agent version. For
@@ -4284,8 +4335,18 @@ export interface ContainerDefinition {
     /**
      * <p>Time duration (in seconds) to wait before the container is forcefully killed if it
      * 			doesn't exit normally on its own.</p>
-     * 		       <p>For tasks using the Fargate launch type, the task or service requires
-     * 			platform version 1.3.0 or later. The max stop timeout value is 120 seconds and if the
+     * 		       <p>For tasks using the Fargate launch type, the task or service requires the followiwng platforms:</p>
+     * 		       <ul>
+     *             <li>
+     * 				           <p>Linux platform
+     * 					version <code>1.3.0</code> or later.</p>
+     * 			         </li>
+     *             <li>
+     * 				           <p>Windows platform
+     * 					version <code>1.0.0</code> or later.</p>
+     * 			         </li>
+     *          </ul>
+     * 		       <p>The max stop timeout value is 120 seconds and if the
      * 			parameter is not specified, the default value of 30 seconds is used.</p>
      * 		       <p>For tasks using the EC2 launch type, if the <code>stopTimeout</code>
      * 			parameter is not specified, the value set for the Amazon ECS container agent configuration
@@ -4574,8 +4635,17 @@ export declare namespace ContainerDefinition {
  * 			tasks hosted on Fargate. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html">Fargate task
  * 				storage</a> in the <i>Amazon ECS User Guide for Fargate</i>.</p>
  * 		       <note>
- * 			         <p>This parameter is only supported for tasks hosted on Fargate using platform
- * 				version <code>1.4.0</code> or later.</p>
+ * 			         <p>This parameter is only supported for tasks hosted on Fargate using the following platform versions:</p>
+ * 			         <ul>
+ *                <li>
+ * 					             <p>Linux platform
+ * 						version <code>1.4.0</code> or later.</p>
+ * 				           </li>
+ *                <li>
+ * 					             <p>Windows platform
+ * 						version <code>1.0.0</code> or later.</p>
+ * 				           </li>
+ *             </ul>
  * 		       </note>
  */
 export interface EphemeralStorage {
@@ -4593,7 +4663,7 @@ export declare namespace EphemeralStorage {
     const filterSensitiveLog: (obj: EphemeralStorage) => any;
 }
 /**
- * <p>Details on a Elastic Inference accelerator. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-eia.html">Working with
+ * <p>Details on a Elastic Inference accelerator. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html">Working with
  * 				Amazon Elastic Inference on Amazon ECS</a> in the
  * 				<i>Amazon Elastic Container Service Developer Guide</i>.</p>
  */
@@ -4737,6 +4807,39 @@ export declare namespace ProxyConfiguration {
      */
     const filterSensitiveLog: (obj: ProxyConfiguration) => any;
 }
+export declare enum CPUArchitecture {
+    ARM64 = "ARM64",
+    X86_64 = "X86_64"
+}
+export declare enum OSFamily {
+    LINUX = "LINUX",
+    WINDOWS_SERVER_2004_CORE = "WINDOWS_SERVER_2004_CORE",
+    WINDOWS_SERVER_2016_FULL = "WINDOWS_SERVER_2016_FULL",
+    WINDOWS_SERVER_2019_CORE = "WINDOWS_SERVER_2019_CORE",
+    WINDOWS_SERVER_2019_FULL = "WINDOWS_SERVER_2019_FULL",
+    WINDOWS_SERVER_2022_CORE = "WINDOWS_SERVER_2022_CORE",
+    WINDOWS_SERVER_2022_FULL = "WINDOWS_SERVER_2022_FULL",
+    WINDOWS_SERVER_20H2_CORE = "WINDOWS_SERVER_20H2_CORE"
+}
+/**
+ * <p>Information about the platform for the Amazon ECS service or task.</p>
+ */
+export interface RuntimePlatform {
+    /**
+     * <p>The CPU architecture.</p>
+     */
+    cpuArchitecture?: CPUArchitecture | string;
+    /**
+     * <p>The operating system.</p>
+     */
+    operatingSystemFamily?: OSFamily | string;
+}
+export declare namespace RuntimePlatform {
+    /**
+     * @internal
+     */
+    const filterSensitiveLog: (obj: RuntimePlatform) => any;
+}
 export declare enum TaskDefinitionStatus {
     ACTIVE = "ACTIVE",
     INACTIVE = "INACTIVE"
@@ -5141,6 +5244,11 @@ export interface TaskDefinition {
      * 			in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
      */
     compatibilities?: (Compatibility | string)[];
+    /**
+     * <p>The operating system  that your task definitions are running on. A platform family is specified only for tasks using the Fargate launch type. </p>
+     * 		       <p>When you specify a task in a service, this value must match the <code>runtimePlatform</code> value of the service.</p>
+     */
+    runtimePlatform?: RuntimePlatform;
     /**
      * <p>The task launch types the task definition was validated against. To determine which
      * 			task launch types the task definition is validated for, see the <a>TaskDefinition$compatibilities</a> parameter.</p>
@@ -5877,7 +5985,7 @@ export declare namespace ContainerOverride {
 /**
  * <p>Details on an Elastic Inference accelerator task override. This parameter is used to
  * 			override the Elastic Inference accelerator specified in the task definition. For more
- * 			information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-eia.html">Working with Amazon Elastic Inference on Amazon ECS</a> in the
+ * 			information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html">Working with Amazon Elastic Inference on Amazon ECS</a> in the
  * 				<i>Amazon Elastic Container Service Developer Guide</i>.</p>
  */
 export interface InferenceAcceleratorOverride {
@@ -5914,7 +6022,9 @@ export interface TaskOverride {
      */
     inferenceAcceleratorOverrides?: InferenceAcceleratorOverride[];
     /**
-     * <p>The Amazon Resource Name (ARN) of the task execution IAM role override for the task.</p>
+     * <p>The Amazon Resource Name (ARN) of the task execution IAM role override for the task. For more information,
+     * 			see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html">Amazon ECS task
+     * 				execution IAM role</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
      */
     executionRoleArn?: string;
     /**
@@ -5922,15 +6032,26 @@ export interface TaskOverride {
      */
     memory?: string;
     /**
-     * <p>The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers
-     * 			in this task are granted the permissions that are specified in this role.</p>
+     * <p>The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in
+     * 			this task are granted the permissions that are specified in this role. For more
+     * 			information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html">IAM Role for Tasks</a>
+     * 			in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
      */
     taskRoleArn?: string;
     /**
      * <p>The ephemeral storage setting override for the task.</p>
      * 		       <note>
-     * 			         <p>This parameter is only supported for tasks hosted on Fargate using platform
-     * 				version <code>1.4.0</code> or later.</p>
+     * 			         <p>This parameter is only supported for tasks hosted on Fargate using the following platform versions:</p>
+     * 			         <ul>
+     *                <li>
+     * 					             <p>Linux platform
+     * 						version <code>1.4.0</code> or later.</p>
+     * 				           </li>
+     *                <li>
+     * 					             <p>Windows platform
+     * 						version <code>1.0.0</code> or later.</p>
+     * 				           </li>
+     *             </ul>
      * 		       </note>
      */
     ephemeralStorage?: EphemeralStorage;
@@ -6114,6 +6235,11 @@ export interface Task {
      * 				Versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
      */
     platformVersion?: string;
+    /**
+     * <p>The operating system  that your tasks are running on. A platform family is specified only for tasks using the Fargate launch type. </p>
+     * 		       <p> All tasks that run as part of this service must use the same <code>platformFamily</code> value as the service, for example, <code>LINUX.</code>.</p>
+     */
+    platformFamily?: string;
     /**
      * <p>The Unix timestamp for when the container image pull began.</p>
      */
@@ -7624,11 +7750,25 @@ export interface RegisterTaskDefinitionRequest {
      * 			tasks hosted on Fargate. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html">Fargate task
      * 				storage</a> in the <i>Amazon ECS User Guide for Fargate</i>.</p>
      * 		       <note>
-     * 			         <p>This parameter is only supported for tasks hosted on Fargate using platform
-     * 				version <code>1.4.0</code> or later.</p>
+     * 			         <p>This parameter is only supported for tasks hosted on Fargate using the following platform versions:</p>
+     * 			         <ul>
+     *                <li>
+     * 					             <p>Linux platform
+     * 						version <code>1.4.0</code> or later.</p>
+     * 				           </li>
+     *                <li>
+     * 					             <p>Windows platform
+     * 						version <code>1.0.0</code> or later.</p>
+     * 				           </li>
+     *             </ul>
      * 		       </note>
      */
     ephemeralStorage?: EphemeralStorage;
+    /**
+     * <p>The operating system  that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type. </p>
+     * 		       <p>When you specify a task definition in a service, this value must match the <code>runtimePlatform</code> value of the service.</p>
+     */
+    runtimePlatform?: RuntimePlatform;
 }
 export declare namespace RegisterTaskDefinitionRequest {
     /**
@@ -7828,6 +7968,11 @@ export interface RunTaskRequest {
      * <p>The <code>family</code> and <code>revision</code> (<code>family:revision</code>) or
      * 			full ARN of the task definition to run. If a <code>revision</code> is not specified,
      * 			the latest <code>ACTIVE</code> revision is used.</p>
+     * 		       <p>The full ARN value must match the value that you specified ias the <code>Resource</code>
+     * 			of the IAM principal's permissions policy. For example, if the <code>Resource</code> is
+     * 			arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*, the
+     * 				<code>taskDefinition</code> ARN value must be
+     * 				<code>arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName</code>.</p>
      */
     taskDefinition: string | undefined;
 }

package/dist-types/pagination/index.d.ts

@@ -0,0 +1,9 @@
+export * from "./Interfaces";
+export * from "./ListAccountSettingsPaginator";
+export * from "./ListAttributesPaginator";
+export * from "./ListClustersPaginator";
+export * from "./ListContainerInstancesPaginator";
+export * from "./ListServicesPaginator";
+export * from "./ListTaskDefinitionFamiliesPaginator";
+export * from "./ListTaskDefinitionsPaginator";
+export * from "./ListTasksPaginator";