@aws-sdk/client-ecs 3.489.0 → 3.495.0

package/dist-types/commands/DescribeTaskDefinitionCommand.d.ts

@@ -257,6 +257,7 @@ declare const DescribeTaskDefinitionCommand_base: {
  * //             domain: "STRING_VALUE", // required
  * //           },
  * //         },
+ * //         configuredAtLaunch: true || false,
  * //       },
  * //     ],
  * //     status: "ACTIVE" || "INACTIVE" || "DELETE_IN_PROGRESS",

package/dist-types/commands/ExecuteCommandCommand.d.ts

@@ -27,12 +27,13 @@ declare const ExecuteCommandCommand_base: {
 /**
  * @public
  * <p>Runs a command remotely on a container within a task.</p>
- *          <p>If you use a condition key in your IAM policy to refine the conditions for the policy
- * 			statement, for example limit the actions to a specific cluster, you receive an
+ *          <p>If you use a condition key in your IAM policy to refine the conditions for the
+ * 			policy statement, for example limit the actions to a specific cluster, you receive an
  * 				<code>AccessDeniedException</code> when there is a mismatch between the condition
  * 			key value and the corresponding parameter value.</p>
- *          <p>For information about required permissions and considerations, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html">Using Amazon ECS Exec for
- * 			debugging</a> in the <i>Amazon ECS Developer Guide</i>. </p>
+ *          <p>For information about required permissions and considerations, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html">Using Amazon ECS
+ * 				Exec for debugging</a> in the <i>Amazon ECS Developer Guide</i>.
+ * 		</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -98,8 +99,8 @@ declare const ExecuteCommandCommand_base: {
  *                <p>The SSM agent is not installed or is not running</p>
  *             </li>
  *             <li>
- *                <p> There is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for Systems
- * 					Manager Session Manager</p>
+ *                <p> There is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for
+ * 					Systems Manager Session Manager</p>
  *             </li>
  *          </ul>
  *          <p>For information about how to troubleshoot the issues, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html">Troubleshooting issues with ECS

package/dist-types/commands/ListTasksCommand.d.ts

@@ -27,8 +27,8 @@ declare const ListTasksCommand_base: {
 /**
  * @public
  * <p>Returns a list of tasks. You can filter the results by cluster, task definition
- * 			family, container instance, launch type, what IAM principal started the task, or by the
- * 			desired status of the task.</p>
+ * 			family, container instance, launch type, what IAM principal started the task, or by
+ * 			the desired status of the task.</p>
  *          <p>Recently stopped tasks might appear in the returned results. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

package/dist-types/commands/PutAccountSettingCommand.d.ts

@@ -27,25 +27,25 @@ declare const PutAccountSettingCommand_base: {
 /**
  * @public
  * <p>Modifies an account setting. Account settings are set on a per-Region basis.</p>
- *          <p>If you change the root user account setting, the default settings are reset for  users
- * 			and roles that do not have specified individual account settings. For more information,
- * 			see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html">Account
+ *          <p>If you change the root user account setting, the default settings are reset for users and
+ * 			roles that do not have specified individual account settings. For more information, see
+ * 				<a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html">Account
  * 				Settings</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
- *          <p>When  you specify <code>serviceLongArnFormat</code>, <code>taskLongArnFormat</code>, or
+ *          <p>When you specify <code>serviceLongArnFormat</code>, <code>taskLongArnFormat</code>, or
  * 				<code>containerInstanceLongArnFormat</code>, the Amazon Resource Name (ARN) and
  * 			resource ID format of the resource type for a specified user, role, or the root user for an
  * 			account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS
  * 			resource separately. The ARN and resource ID format of a resource is defined by the
  * 			opt-in status of the user or role that created the resource. You must turn on this
  * 			setting to use Amazon ECS features such as resource tagging.</p>
- *          <p>When you specify <code>awsvpcTrunking</code>, the elastic network interface (ENI) limit for
- * 			any new container instances that support the feature is changed. If
+ *          <p>When you specify <code>awsvpcTrunking</code>, the elastic network interface (ENI)
+ * 			limit for any new container instances that support the feature is changed. If
  * 				<code>awsvpcTrunking</code> is turned on, any new container instances that support
  * 			the feature are launched have the increased ENI limits available to them. For more
  * 			information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-eni.html">Elastic Network
  * 				Interface Trunking</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
- *          <p>When you specify <code>containerInsights</code>, the default setting indicating whether
- * 			Amazon Web Services CloudWatch Container Insights is turned on for your clusters is changed. If
+ *          <p>When you specify <code>containerInsights</code>, the default setting indicating
+ * 			whether Amazon Web Services CloudWatch Container Insights is turned on for your clusters is changed. If
  * 				<code>containerInsights</code> is turned on, any new clusters that are created will
  * 			have Container Insights turned on unless you disable it during cluster creation. For
  * 			more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html">CloudWatch
@@ -57,12 +57,13 @@ declare const PutAccountSettingCommand_base: {
  * 			you must grant explicit permissions to use the <code>ecs:TagResource</code> action. For
  * 			more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/supported-iam-actions-tagging.html">Grant
  * 				permission to tag resources on creation</a> in the <i>Amazon ECS Developer
- * 					Guide</i>.</p>
+ * 				Guide</i>.</p>
  *          <p>When Amazon Web Services determines that a security or infrastructure update is needed for an Amazon ECS
  * 			task hosted on Fargate, the tasks need to be stopped and new tasks launched to replace
  * 			them. Use <code>fargateTaskRetirementWaitPeriod</code> to configure the wait time to
- * 			retire a Fargate task. For information about the Fargate tasks maintenance, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-maintenance.html">Amazon Web Services Fargate task maintenance</a> in the <i>Amazon ECS Developer
- * 					Guide</i>.</p>
+ * 			retire a Fargate task. For information about the Fargate tasks maintenance, see
+ * 				<a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-maintenance.html">Amazon Web Services Fargate task
+ * 				maintenance</a> in the <i>Amazon ECS Developer Guide</i>.</p>
  *          <p>The <code>guardDutyActivate</code> parameter is read-only in Amazon ECS and indicates whether
  * 			Amazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your
  * 			Amazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-guard-duty-integration.html">Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring</a>.</p>

package/dist-types/commands/PutAccountSettingDefaultCommand.d.ts

@@ -26,9 +26,8 @@ declare const PutAccountSettingDefaultCommand_base: {
 };
 /**
  * @public
- * <p>Modifies an account setting for all users on an account for whom no individual
- * 			account setting has been specified. Account settings are set on a per-Region
- * 			basis.</p>
+ * <p>Modifies an account setting for all users on an account for whom no individual account
+ * 			setting has been specified. Account settings are set on a per-Region basis.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/RegisterTaskDefinitionCommand.d.ts

@@ -31,10 +31,10 @@ declare const RegisterTaskDefinitionCommand_base: {
  * 			containers with the <code>volumes</code> parameter. For more information about task
  * 			definition parameters and defaults, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html">Amazon ECS Task
  * 				Definitions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
- *          <p>You can specify a role for your task with the <code>taskRoleArn</code> parameter.
- * 			When you specify a role for a task, its containers can then use the latest versions
- * 			of the CLI or SDKs to make API requests to the Amazon Web Services services that are specified in
- * 			the 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
+ *          <p>You can specify a role for your task with the <code>taskRoleArn</code> parameter. When
+ * 			you specify a role for a task, its containers can then use the latest versions of the
+ * 			CLI or SDKs to make API requests to the Amazon Web Services services that are specified in the
+ * 			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
  * 				Roles for Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>
  *          <p>You can specify a Docker networking mode for the containers in your task definition
  * 			with the <code>networkMode</code> parameter. The available network modes correspond to
@@ -256,6 +256,7 @@ declare const RegisterTaskDefinitionCommand_base: {
  *           domain: "STRING_VALUE", // required
  *         },
  *       },
+ *       configuredAtLaunch: true || false,
  *     },
  *   ],
  *   placementConstraints: [ // TaskDefinitionPlacementConstraints
@@ -512,6 +513,7 @@ declare const RegisterTaskDefinitionCommand_base: {
  * //             domain: "STRING_VALUE", // required
  * //           },
  * //         },
+ * //         configuredAtLaunch: true || false,
  * //       },
  * //     ],
  * //     status: "ACTIVE" || "INACTIVE" || "DELETE_IN_PROGRESS",

package/dist-types/commands/RunTaskCommand.d.ts

@@ -35,6 +35,8 @@ declare const RunTaskCommand_base: {
  *          <note>
  *             <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>
  *          </note>
+ *          <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or
+ * 			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>
  *          <p>The Amazon ECS API follows an eventual consistency model. This is because of the
  * 			distributed nature of the system supporting the API. This means that the result of an
  * 			API command you run that affects your Amazon ECS resources might not be immediately visible
@@ -156,6 +158,37 @@ declare const RunTaskCommand_base: {
  *   ],
  *   taskDefinition: "STRING_VALUE", // required
  *   clientToken: "STRING_VALUE",
+ *   volumeConfigurations: [ // TaskVolumeConfigurations
+ *     { // TaskVolumeConfiguration
+ *       name: "STRING_VALUE", // required
+ *       managedEBSVolume: { // TaskManagedEBSVolumeConfiguration
+ *         encrypted: true || false,
+ *         kmsKeyId: "STRING_VALUE",
+ *         volumeType: "STRING_VALUE",
+ *         sizeInGiB: Number("int"),
+ *         snapshotId: "STRING_VALUE",
+ *         iops: Number("int"),
+ *         throughput: Number("int"),
+ *         tagSpecifications: [ // EBSTagSpecifications
+ *           { // EBSTagSpecification
+ *             resourceType: "volume", // required
+ *             tags: [
+ *               {
+ *                 key: "STRING_VALUE",
+ *                 value: "STRING_VALUE",
+ *               },
+ *             ],
+ *             propagateTags: "TASK_DEFINITION" || "SERVICE" || "NONE",
+ *           },
+ *         ],
+ *         roleArn: "STRING_VALUE", // required
+ *         terminationPolicy: { // TaskManagedEBSVolumeTerminationPolicy
+ *           deleteOnTermination: true || false, // required
+ *         },
+ *         filesystemType: "ext3" || "ext4" || "xfs",
+ *       },
+ *     },
+ *   ],
  * };
  * const command = new RunTaskCommand(input);
  * const response = await client.send(command);
@@ -358,12 +391,11 @@ declare const RunTaskCommand_base: {
  *          <p>To fix this issue:</p>
  *          <ul>
  *             <li>
- *                <p>Run <code>RunTask</code> with a unique
- * 				<code>clientToken</code>.</p>
+ *                <p>Run <code>RunTask</code> with a unique <code>clientToken</code>.</p>
  *             </li>
  *             <li>
- *                <p>Run <code>RunTask</code> with the <code>clientToken</code> and the original set of
- * 					parameters</p>
+ *                <p>Run <code>RunTask</code> with the <code>clientToken</code> and the original
+ * 					set of parameters</p>
  *             </li>
  *          </ul>
  *

package/dist-types/commands/StartTaskCommand.d.ts

@@ -33,6 +33,8 @@ declare const StartTaskCommand_base: {
  *          </note>
  *          <p>Alternatively, you can use <a>RunTask</a> to place tasks for you. For more
  * 			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>
+ *          <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or
+ * 			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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -110,6 +112,37 @@ declare const StartTaskCommand_base: {
  *     },
  *   ],
  *   taskDefinition: "STRING_VALUE", // required
+ *   volumeConfigurations: [ // TaskVolumeConfigurations
+ *     { // TaskVolumeConfiguration
+ *       name: "STRING_VALUE", // required
+ *       managedEBSVolume: { // TaskManagedEBSVolumeConfiguration
+ *         encrypted: true || false,
+ *         kmsKeyId: "STRING_VALUE",
+ *         volumeType: "STRING_VALUE",
+ *         sizeInGiB: Number("int"),
+ *         snapshotId: "STRING_VALUE",
+ *         iops: Number("int"),
+ *         throughput: Number("int"),
+ *         tagSpecifications: [ // EBSTagSpecifications
+ *           { // EBSTagSpecification
+ *             resourceType: "volume", // required
+ *             tags: [
+ *               {
+ *                 key: "STRING_VALUE",
+ *                 value: "STRING_VALUE",
+ *               },
+ *             ],
+ *             propagateTags: "TASK_DEFINITION" || "SERVICE" || "NONE",
+ *           },
+ *         ],
+ *         roleArn: "STRING_VALUE", // required
+ *         terminationPolicy: { // TaskManagedEBSVolumeTerminationPolicy
+ *           deleteOnTermination: true || false, // required
+ *         },
+ *         filesystemType: "ext3" || "ext4" || "xfs",
+ *       },
+ *     },
+ *   ],
  * };
  * const command = new StartTaskCommand(input);
  * const response = await client.send(command);
@@ -304,6 +337,9 @@ declare const StartTaskCommand_base: {
  * @throws {@link ServerException} (server fault)
  *  <p>These errors are usually caused by a server issue.</p>
  *
+ * @throws {@link UnsupportedFeatureException} (client fault)
+ *  <p>The specified task isn't supported in this Region.</p>
+ *
  * @throws {@link ECSServiceException}
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *

package/dist-types/commands/UpdateServiceCommand.d.ts

@@ -32,6 +32,13 @@ declare const UpdateServiceCommand_base: {
  * 			registries, enable ECS managed tags option, propagate tags option, task placement
  * 			constraints and strategies, and task definition. When you update any of these
  * 			parameters, Amazon ECS starts new tasks with the new configuration. </p>
+ *          <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or
+ * 			running a task, or when creating or 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>. You can update
+ * 			your volume configurations and trigger a new deployment.
+ * 				<code>volumeConfigurations</code> is only supported for REPLICA service and not
+ * 			DAEMON service. If you leave <code>volumeConfigurations</code>
+ *             <code>null</code>, it doesn't trigger a new deployment. For more infomation on volumes,
+ * 			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>
  *          <p>For services using the blue/green (<code>CODE_DEPLOY</code>) deployment controller,
  * 			only the desired count, deployment configuration, health check grace period, task
  * 			placement constraints and strategies, enable ECS managed tags option, and propagate tags
@@ -46,7 +53,9 @@ declare const UpdateServiceCommand_base: {
  *          <p>You can add to or subtract from the number of instantiations of a task definition in a
  * 			service by specifying the cluster that the service is running in and a new
  * 				<code>desiredCount</code> parameter.</p>
- *          <p>If you have updated the Docker image of your application, you can create a new task
+ *          <p>You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or
+ * 			running a task, or when creating or 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>
+ *          <p>If you have updated the container image of your application, you can create a new task
  * 			definition with that image and deploy it to your service. The service scheduler uses the
  * 			minimum healthy percent and maximum percent parameters (in the service's deployment
  * 			configuration) to determine the deployment strategy.</p>
@@ -145,8 +154,8 @@ declare const UpdateServiceCommand_base: {
  *                   </p>
  *                </li>
  *             </ul>
- *             <p>For more information about the role see the <code>CreateService</code> request parameter
- * 				<a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role">
+ *             <p>For more information about the role see the <code>CreateService</code> request
+ * 				parameter <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html#ECS-CreateService-request-role">
  *                   <code>role</code>
  *                </a>. </p>
  *          </note>
@@ -257,6 +266,34 @@ declare const UpdateServiceCommand_base: {
  *       ],
  *     },
  *   },
+ *   volumeConfigurations: [ // ServiceVolumeConfigurations
+ *     { // ServiceVolumeConfiguration
+ *       name: "STRING_VALUE", // required
+ *       managedEBSVolume: { // ServiceManagedEBSVolumeConfiguration
+ *         encrypted: true || false,
+ *         kmsKeyId: "STRING_VALUE",
+ *         volumeType: "STRING_VALUE",
+ *         sizeInGiB: Number("int"),
+ *         snapshotId: "STRING_VALUE",
+ *         iops: Number("int"),
+ *         throughput: Number("int"),
+ *         tagSpecifications: [ // EBSTagSpecifications
+ *           { // EBSTagSpecification
+ *             resourceType: "volume", // required
+ *             tags: [ // Tags
+ *               { // Tag
+ *                 key: "STRING_VALUE",
+ *                 value: "STRING_VALUE",
+ *               },
+ *             ],
+ *             propagateTags: "TASK_DEFINITION" || "SERVICE" || "NONE",
+ *           },
+ *         ],
+ *         roleArn: "STRING_VALUE", // required
+ *         filesystemType: "ext3" || "ext4" || "xfs",
+ *       },
+ *     },
+ *   ],
  * };
  * const command = new UpdateServiceCommand(input);
  * const response = await client.send(command);
@@ -446,6 +483,34 @@ declare const UpdateServiceCommand_base: {
  * //             discoveryArn: "STRING_VALUE",
  * //           },
  * //         ],
+ * //         volumeConfigurations: [ // ServiceVolumeConfigurations
+ * //           { // ServiceVolumeConfiguration
+ * //             name: "STRING_VALUE", // required
+ * //             managedEBSVolume: { // ServiceManagedEBSVolumeConfiguration
+ * //               encrypted: true || false,
+ * //               kmsKeyId: "STRING_VALUE",
+ * //               volumeType: "STRING_VALUE",
+ * //               sizeInGiB: Number("int"),
+ * //               snapshotId: "STRING_VALUE",
+ * //               iops: Number("int"),
+ * //               throughput: Number("int"),
+ * //               tagSpecifications: [ // EBSTagSpecifications
+ * //                 { // EBSTagSpecification
+ * //                   resourceType: "volume", // required
+ * //                   tags: [
+ * //                     {
+ * //                       key: "STRING_VALUE",
+ * //                       value: "STRING_VALUE",
+ * //                     },
+ * //                   ],
+ * //                   propagateTags: "TASK_DEFINITION" || "SERVICE" || "NONE",
+ * //                 },
+ * //               ],
+ * //               roleArn: "STRING_VALUE", // required
+ * //               filesystemType: "ext3" || "ext4" || "xfs",
+ * //             },
+ * //           },
+ * //         ],
  * //       },
  * //     ],
  * //     roleArn: "STRING_VALUE",
@@ -481,12 +546,7 @@ declare const UpdateServiceCommand_base: {
  * //     deploymentController: { // DeploymentController
  * //       type: "ECS" || "CODE_DEPLOY" || "EXTERNAL", // required
  * //     },
- * //     tags: [
- * //       {
- * //         key: "STRING_VALUE",
- * //         value: "STRING_VALUE",
- * //       },
- * //     ],
+ * //     tags: "<Tags>",
  * //     createdBy: "STRING_VALUE",
  * //     enableECSManagedTags: true || false,
  * //     propagateTags: "TASK_DEFINITION" || "SERVICE" || "NONE",
@@ -538,6 +598,9 @@ declare const UpdateServiceCommand_base: {
  *  <p>The specified service wasn't found. You can view your available services with <a>ListServices</a>. Amazon ECS services are cluster specific and Region
  * 			specific.</p>
  *
+ * @throws {@link UnsupportedFeatureException} (client fault)
+ *  <p>The specified task isn't supported in this Region.</p>
+ *
  * @throws {@link ECSServiceException}
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *