@aws-sdk/client-ecs 3.1008.0 → 3.1010.0

package/README.md

@@ -9,8 +9,9 @@ AWS SDK for JavaScript ECS Client for Node.js, Browser and React Native.
 <fullname>Amazon Elastic Container Service</fullname> <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run, stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.</p> <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes it easy to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.</p> <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your own cluster management and configuration management systems. You also don't need to worry about scaling your management infrastructure. </p>
 
 ## Installing
-To install this package, simply type add or install @aws-sdk/client-ecs
-using your favorite package manager:
+
+To install this package, use the CLI of your favorite package manager:
+
 - `npm install @aws-sdk/client-ecs`
 - `yarn add @aws-sdk/client-ecs`
 - `pnpm add @aws-sdk/client-ecs`
@@ -35,15 +36,15 @@ import { ECSClient, ListTasksCommand } from "@aws-sdk/client-ecs";
 
 ### Usage
 
-To send a request, you:
+To send a request:
 
-- Initiate client with configuration (e.g. credentials, region).
-- Initiate command with input parameters.
-- Call `send` operation on client with command object as input.
-- If you are using a custom http handler, you may call `destroy()` to close open connections.
+- Instantiate a client with configuration (e.g. credentials, region).
+  - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
+  - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
+- Instantiate a command with input parameters.
+- Call the `send` operation on the client, providing the command object as input.
 
 ```js
-// a client can be shared by different commands.
 const client = new ECSClient({ region: "REGION" });
 
 const params = { /** input parameters */ };
@@ -52,7 +53,7 @@ const command = new ListTasksCommand(params);
 
 #### Async/await
 
-We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
+We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
 operator to wait for the promise returned by send operation as follows:
 
 ```js
@@ -67,26 +68,9 @@ try {
 }
 ```
 
-Async-await is clean, concise, intuitive, easy to debug and has better error handling
-as compared to using Promise chains or callbacks.
-
 #### Promises
 
-You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
-to execute send operation.
-
-```js
-client.send(command).then(
-  (data) => {
-    // process data.
-  },
-  (error) => {
-    // error handling.
-  }
-);
-```
-
-Promises can also be called using `.catch()` and `.finally()` as follows:
+You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
 
 ```js
 client
@@ -102,27 +86,21 @@ client
   });
 ```
 
-#### Callbacks
-
-We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
-but they are supported by the send operation.
+#### Aggregated client
 
-```js
-// callbacks.
-client.send(command, (err, data) => {
-  // process err and data.
-});
-```
+The aggregated client class is exported from the same package, but without the "Client" suffix.
 
-#### v2 compatible style
+`ECS` extends `ECSClient` and additionally supports all operations, waiters, and paginators as methods.
+This style may be familiar to you from the AWS SDK for JavaScript v2.
 
-The client can also send requests using v2 compatible style.
-However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
-on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
+If you are bundling the AWS SDK, we recommend using only the bare-bones client (`ECSClient`).
+More details are in the blog post on
+[modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
 
 ```ts
-import * as AWS from "@aws-sdk/client-ecs";
-const client = new AWS.ECS({ region: "REGION" });
+import { ECS } from "@aws-sdk/client-ecs";
+
+const client = new ECS({ region: "REGION" });
 
 // async/await.
 try {
@@ -142,7 +120,7 @@ client
     // error handling.
   });
 
-// callbacks.
+// callbacks (not recommended).
 client.listTasks(params, (err, data) => {
   // process err and data.
 });
@@ -170,12 +148,14 @@ try {
 }
 ```
 
+See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
+
 ## Getting Help
 
 Please use these community resources for getting help.
-We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
+We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
 
-- Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
+- Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
   or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
 - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
   on AWS Developer Blog.

package/dist-cjs/schemas/schemas_0.js

@@ -703,6 +703,7 @@ const _iID = "instanceIdentityDocument";
 const _iIDS = "instanceIdentityDocumentSignature";
 const _iLT = "instanceLaunchTemplate";
 const _iM = "ipcMode";
+const _iMTP = "instanceMetadataTagsPropagation";
 const _iO = "infrastructureOptimization";
 const _iP = "ingressPaths";
 const _iPE = "initProcessEnabled";
@@ -1800,13 +1801,13 @@ exports.InstanceHealthCheckResult$ = [3, n0, _IHCR,
 ];
 exports.InstanceLaunchTemplate$ = [3, n0, _ILT,
     0,
-    [_eIPA, _nC, _sCto, _mo, _cOT, _iR, _fE, _cR],
-    [0, () => exports.ManagedInstancesNetworkConfiguration$, () => exports.ManagedInstancesStorageConfiguration$, 0, 0, [() => exports.InstanceRequirementsRequest$, 0], 2, () => exports.CapacityReservationRequest$], 2
+    [_eIPA, _nC, _sCto, _mo, _cOT, _iMTP, _iR, _fE, _cR],
+    [0, () => exports.ManagedInstancesNetworkConfiguration$, () => exports.ManagedInstancesStorageConfiguration$, 0, 0, 2, [() => exports.InstanceRequirementsRequest$, 0], 2, () => exports.CapacityReservationRequest$], 2
 ];
 exports.InstanceLaunchTemplateUpdate$ = [3, n0, _ILTU,
     0,
-    [_eIPA, _nC, _sCto, _mo, _iR, _cR],
-    [0, () => exports.ManagedInstancesNetworkConfiguration$, () => exports.ManagedInstancesStorageConfiguration$, 0, [() => exports.InstanceRequirementsRequest$, 0], () => exports.CapacityReservationRequest$]
+    [_eIPA, _nC, _sCto, _iMTP, _mo, _iR, _cR],
+    [0, () => exports.ManagedInstancesNetworkConfiguration$, () => exports.ManagedInstancesStorageConfiguration$, 2, 0, [() => exports.InstanceRequirementsRequest$, 0], () => exports.CapacityReservationRequest$]
 ];
 exports.InstanceRequirementsRequest$ = [3, n0, _IRR,
     0,

package/dist-es/schemas/schemas_0.js

@@ -693,6 +693,7 @@ const _iID = "instanceIdentityDocument";
 const _iIDS = "instanceIdentityDocumentSignature";
 const _iLT = "instanceLaunchTemplate";
 const _iM = "ipcMode";
+const _iMTP = "instanceMetadataTagsPropagation";
 const _iO = "infrastructureOptimization";
 const _iP = "ingressPaths";
 const _iPE = "initProcessEnabled";
@@ -1790,13 +1791,13 @@ export var InstanceHealthCheckResult$ = [3, n0, _IHCR,
 ];
 export var InstanceLaunchTemplate$ = [3, n0, _ILT,
     0,
-    [_eIPA, _nC, _sCto, _mo, _cOT, _iR, _fE, _cR],
-    [0, () => ManagedInstancesNetworkConfiguration$, () => ManagedInstancesStorageConfiguration$, 0, 0, [() => InstanceRequirementsRequest$, 0], 2, () => CapacityReservationRequest$], 2
+    [_eIPA, _nC, _sCto, _mo, _cOT, _iMTP, _iR, _fE, _cR],
+    [0, () => ManagedInstancesNetworkConfiguration$, () => ManagedInstancesStorageConfiguration$, 0, 0, 2, [() => InstanceRequirementsRequest$, 0], 2, () => CapacityReservationRequest$], 2
 ];
 export var InstanceLaunchTemplateUpdate$ = [3, n0, _ILTU,
     0,
-    [_eIPA, _nC, _sCto, _mo, _iR, _cR],
-    [0, () => ManagedInstancesNetworkConfiguration$, () => ManagedInstancesStorageConfiguration$, 0, [() => InstanceRequirementsRequest$, 0], () => CapacityReservationRequest$]
+    [_eIPA, _nC, _sCto, _iMTP, _mo, _iR, _cR],
+    [0, () => ManagedInstancesNetworkConfiguration$, () => ManagedInstancesStorageConfiguration$, 2, 0, [() => InstanceRequirementsRequest$, 0], () => CapacityReservationRequest$]
 ];
 export var InstanceRequirementsRequest$ = [3, n0, _IRR,
     0,

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

@@ -68,6 +68,7 @@ declare const CreateCapacityProviderCommand_base: {
  *       },
  *       monitoring: "BASIC" || "DETAILED",
  *       capacityOptionType: "ON_DEMAND" || "SPOT" || "RESERVED",
+ *       instanceMetadataTagsPropagation: true || false,
  *       instanceRequirements: { // InstanceRequirementsRequest
  *         vCpuCount: { // VCpuCountRangeRequest
  *           min: Number("int"), // required
@@ -192,6 +193,7 @@ declare const CreateCapacityProviderCommand_base: {
  * //         },
  * //         monitoring: "BASIC" || "DETAILED",
  * //         capacityOptionType: "ON_DEMAND" || "SPOT" || "RESERVED",
+ * //         instanceMetadataTagsPropagation: true || false,
  * //         instanceRequirements: { // InstanceRequirementsRequest
  * //           vCpuCount: { // VCpuCountRangeRequest
  * //             min: Number("int"), // required

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

@@ -77,6 +77,7 @@ declare const DeleteCapacityProviderCommand_base: {
  * //         },
  * //         monitoring: "BASIC" || "DETAILED",
  * //         capacityOptionType: "ON_DEMAND" || "SPOT" || "RESERVED",
+ * //         instanceMetadataTagsPropagation: true || false,
  * //         instanceRequirements: { // InstanceRequirementsRequest
  * //           vCpuCount: { // VCpuCountRangeRequest
  * //             min: Number("int"), // required

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

@@ -85,6 +85,7 @@ declare const DescribeCapacityProvidersCommand_base: {
  * //           },
  * //           monitoring: "BASIC" || "DETAILED",
  * //           capacityOptionType: "ON_DEMAND" || "SPOT" || "RESERVED",
+ * //           instanceMetadataTagsPropagation: true || false,
  * //           instanceRequirements: { // InstanceRequirementsRequest
  * //             vCpuCount: { // VCpuCountRangeRequest
  * //               min: Number("int"), // required

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

@@ -65,6 +65,7 @@ declare const UpdateCapacityProviderCommand_base: {
  *       storageConfiguration: { // ManagedInstancesStorageConfiguration
  *         storageSizeGiB: Number("int"),
  *       },
+ *       instanceMetadataTagsPropagation: true || false,
  *       monitoring: "BASIC" || "DETAILED",
  *       instanceRequirements: { // InstanceRequirementsRequest
  *         vCpuCount: { // VCpuCountRangeRequest
@@ -183,6 +184,7 @@ declare const UpdateCapacityProviderCommand_base: {
  * //         },
  * //         monitoring: "BASIC" || "DETAILED",
  * //         capacityOptionType: "ON_DEMAND" || "SPOT" || "RESERVED",
+ * //         instanceMetadataTagsPropagation: true || false,
  * //         instanceRequirements: { // InstanceRequirementsRequest
  * //           vCpuCount: { // VCpuCountRangeRequest
  * //             min: Number("int"), // required

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

@@ -437,6 +437,11 @@ export interface InstanceLaunchTemplate {
      * @public
      */
     capacityOptionType?: CapacityOptionType | undefined;
+    /**
+     * <p>Determines whether tags are propagated to the instance metadata service (IMDS) for Amazon EC2 instances launched by the Managed Instances capacity provider. When enabled, all tags associated with the instance are available through the instance metadata service. When disabled, tags are not propagated to IMDS.</p> <p>Disable this setting if your tags contain characters that are not compatible with IMDS, such as <code>/</code>. IMDS requires tag keys to match the pattern <code>[0-9a-zA-Z\-_+=,.@:]\{1,255\}</code>.</p> <p>The default value is <code>true</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS">Work with instance tags in instance metadata</a> in the <i>Amazon EC2 User Guide</i>.</p>
+     * @public
+     */
+    instanceMetadataTagsPropagation?: boolean | undefined;
     /**
      * <p>The instance requirements. You can specify:</p> <ul> <li> <p>The instance types</p> </li> <li> <p>Instance requirements such as vCPU count, memory, network performance, and accelerator specifications</p> </li> </ul> <p>Amazon ECS automatically selects the instances that match the specified criteria.</p>
      * @public
@@ -754,6 +759,11 @@ export interface InstanceLaunchTemplateUpdate {
      * @public
      */
     storageConfiguration?: ManagedInstancesStorageConfiguration | undefined;
+    /**
+     * <p>Determines whether tags are propagated to the instance metadata service (IMDS) for Amazon EC2 instances launched by the Managed Instances capacity provider. When enabled, all tags associated with the instance are available through the instance metadata service. When disabled, tags are not propagated to IMDS.</p> <p>Disable this setting if your tags contain characters that are not compatible with IMDS, such as <code>/</code>. IMDS requires tag keys to match the pattern <code>[0-9a-zA-Z\-_+=,.@:]\{1,255\}</code>.</p> <p>The default value is <code>true</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS">Work with instance tags in instance metadata</a> in the <i>Amazon EC2 User Guide</i>.</p>
+     * @public
+     */
+    instanceMetadataTagsPropagation?: boolean | undefined;
     /**
      * <p>CloudWatch provides two categories of monitoring: basic monitoring and detailed monitoring. By default, your managed instance is configured for basic monitoring. You can optionally enable detailed monitoring to help you more quickly identify and act on operational issues. You can enable or turn off detailed monitoring at launch or when the managed instance is running or stopped. For more information, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/detailed-monitoring-managed-instances.html">Detailed monitoring for Amazon ECS Managed Instances</a> in the Amazon ECS Developer Guide.</p>
      * @public

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

@@ -194,6 +194,7 @@ export interface InstanceLaunchTemplate {
   storageConfiguration?: ManagedInstancesStorageConfiguration | undefined;
   monitoring?: ManagedInstancesMonitoringOptions | undefined;
   capacityOptionType?: CapacityOptionType | undefined;
+  instanceMetadataTagsPropagation?: boolean | undefined;
   instanceRequirements?: InstanceRequirementsRequest | undefined;
   fipsEnabled?: boolean | undefined;
   capacityReservations?: CapacityReservationRequest | undefined;
@@ -271,6 +272,7 @@ export interface InstanceLaunchTemplateUpdate {
   ec2InstanceProfileArn?: string | undefined;
   networkConfiguration?: ManagedInstancesNetworkConfiguration | undefined;
   storageConfiguration?: ManagedInstancesStorageConfiguration | undefined;
+  instanceMetadataTagsPropagation?: boolean | undefined;
   monitoring?: ManagedInstancesMonitoringOptions | undefined;
   instanceRequirements?: InstanceRequirementsRequest | undefined;
   capacityReservations?: CapacityReservationRequest | undefined;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-ecs",
   "description": "AWS SDK for JavaScript Ecs Client for Node.js, Browser and React Native",
-  "version": "3.1008.0",
+  "version": "3.1010.0",
   "scripts": {
     "build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
     "build:cjs": "node ../../scripts/compilation/inline client-ecs",
@@ -23,43 +23,43 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "5.2.0",
     "@aws-crypto/sha256-js": "5.2.0",
-    "@aws-sdk/core": "^3.973.19",
-    "@aws-sdk/credential-provider-node": "^3.972.20",
-    "@aws-sdk/middleware-host-header": "^3.972.7",
-    "@aws-sdk/middleware-logger": "^3.972.7",
-    "@aws-sdk/middleware-recursion-detection": "^3.972.7",
-    "@aws-sdk/middleware-user-agent": "^3.972.20",
-    "@aws-sdk/region-config-resolver": "^3.972.7",
-    "@aws-sdk/types": "^3.973.5",
-    "@aws-sdk/util-endpoints": "^3.996.4",
-    "@aws-sdk/util-user-agent-browser": "^3.972.7",
-    "@aws-sdk/util-user-agent-node": "^3.973.6",
-    "@smithy/config-resolver": "^4.4.10",
-    "@smithy/core": "^3.23.9",
-    "@smithy/fetch-http-handler": "^5.3.13",
-    "@smithy/hash-node": "^4.2.11",
-    "@smithy/invalid-dependency": "^4.2.11",
-    "@smithy/middleware-content-length": "^4.2.11",
-    "@smithy/middleware-endpoint": "^4.4.23",
-    "@smithy/middleware-retry": "^4.4.40",
-    "@smithy/middleware-serde": "^4.2.12",
-    "@smithy/middleware-stack": "^4.2.11",
-    "@smithy/node-config-provider": "^4.3.11",
-    "@smithy/node-http-handler": "^4.4.14",
-    "@smithy/protocol-http": "^5.3.11",
-    "@smithy/smithy-client": "^4.12.3",
-    "@smithy/types": "^4.13.0",
-    "@smithy/url-parser": "^4.2.11",
+    "@aws-sdk/core": "^3.973.20",
+    "@aws-sdk/credential-provider-node": "^3.972.21",
+    "@aws-sdk/middleware-host-header": "^3.972.8",
+    "@aws-sdk/middleware-logger": "^3.972.8",
+    "@aws-sdk/middleware-recursion-detection": "^3.972.8",
+    "@aws-sdk/middleware-user-agent": "^3.972.21",
+    "@aws-sdk/region-config-resolver": "^3.972.8",
+    "@aws-sdk/types": "^3.973.6",
+    "@aws-sdk/util-endpoints": "^3.996.5",
+    "@aws-sdk/util-user-agent-browser": "^3.972.8",
+    "@aws-sdk/util-user-agent-node": "^3.973.7",
+    "@smithy/config-resolver": "^4.4.11",
+    "@smithy/core": "^3.23.11",
+    "@smithy/fetch-http-handler": "^5.3.15",
+    "@smithy/hash-node": "^4.2.12",
+    "@smithy/invalid-dependency": "^4.2.12",
+    "@smithy/middleware-content-length": "^4.2.12",
+    "@smithy/middleware-endpoint": "^4.4.25",
+    "@smithy/middleware-retry": "^4.4.42",
+    "@smithy/middleware-serde": "^4.2.14",
+    "@smithy/middleware-stack": "^4.2.12",
+    "@smithy/node-config-provider": "^4.3.12",
+    "@smithy/node-http-handler": "^4.4.16",
+    "@smithy/protocol-http": "^5.3.12",
+    "@smithy/smithy-client": "^4.12.5",
+    "@smithy/types": "^4.13.1",
+    "@smithy/url-parser": "^4.2.12",
     "@smithy/util-base64": "^4.3.2",
     "@smithy/util-body-length-browser": "^4.2.2",
     "@smithy/util-body-length-node": "^4.2.3",
-    "@smithy/util-defaults-mode-browser": "^4.3.39",
-    "@smithy/util-defaults-mode-node": "^4.2.42",
-    "@smithy/util-endpoints": "^3.3.2",
-    "@smithy/util-middleware": "^4.2.11",
-    "@smithy/util-retry": "^4.2.11",
+    "@smithy/util-defaults-mode-browser": "^4.3.41",
+    "@smithy/util-defaults-mode-node": "^4.2.44",
+    "@smithy/util-endpoints": "^3.3.3",
+    "@smithy/util-middleware": "^4.2.12",
+    "@smithy/util-retry": "^4.2.12",
     "@smithy/util-utf8": "^4.2.2",
-    "@smithy/util-waiter": "^4.2.12",
+    "@smithy/util-waiter": "^4.2.13",
     "tslib": "^2.6.2"
   },
   "devDependencies": {