@aws-sdk/client-ecs 3.721.0 → 3.723.0

package/dist-es/ECSClient.js

@@ -14,6 +14,7 @@ import { getRuntimeConfig as __getRuntimeConfig } from "./runtimeConfig";
 import { resolveRuntimeExtensions } from "./runtimeExtensions";
 export { __Client };
 export class ECSClient extends __Client {
+    config;
     constructor(...[configuration]) {
         const _config_0 = __getRuntimeConfig(configuration || {});
         const _config_1 = resolveClientEndpointParameters(_config_0);

package/dist-es/models/models_0.js

@@ -1,14 +1,14 @@
 import { SENSITIVE_STRING } from "@smithy/smithy-client";
 import { ECSServiceException as __BaseException } from "./ECSServiceException";
 export class AccessDeniedException extends __BaseException {
+    name = "AccessDeniedException";
+    $fault = "client";
     constructor(opts) {
         super({
             name: "AccessDeniedException",
             $fault: "client",
             ...opts,
         });
-        this.name = "AccessDeniedException";
-        this.$fault = "client";
         Object.setPrototypeOf(this, AccessDeniedException.prototype);
     }
 }
@@ -21,14 +21,14 @@ export const AgentUpdateStatus = {
     UPDATING: "UPDATING",
 };
 export class ClientException extends __BaseException {
+    name = "ClientException";
+    $fault = "client";
     constructor(opts) {
         super({
             name: "ClientException",
             $fault: "client",
             ...opts,
         });
-        this.name = "ClientException";
-        this.$fault = "client";
         Object.setPrototypeOf(this, ClientException.prototype);
     }
 }
@@ -57,50 +57,50 @@ export const CapacityProviderUpdateStatus = {
     UPDATE_IN_PROGRESS: "UPDATE_IN_PROGRESS",
 };
 export class InvalidParameterException extends __BaseException {
+    name = "InvalidParameterException";
+    $fault = "client";
     constructor(opts) {
         super({
             name: "InvalidParameterException",
             $fault: "client",
             ...opts,
         });
-        this.name = "InvalidParameterException";
-        this.$fault = "client";
         Object.setPrototypeOf(this, InvalidParameterException.prototype);
     }
 }
 export class LimitExceededException extends __BaseException {
+    name = "LimitExceededException";
+    $fault = "client";
     constructor(opts) {
         super({
             name: "LimitExceededException",
             $fault: "client",
             ...opts,
         });
-        this.name = "LimitExceededException";
-        this.$fault = "client";
         Object.setPrototypeOf(this, LimitExceededException.prototype);
     }
 }
 export class ServerException extends __BaseException {
+    name = "ServerException";
+    $fault = "server";
     constructor(opts) {
         super({
             name: "ServerException",
             $fault: "server",
             ...opts,
         });
-        this.name = "ServerException";
-        this.$fault = "server";
         Object.setPrototypeOf(this, ServerException.prototype);
     }
 }
 export class UpdateInProgressException extends __BaseException {
+    name = "UpdateInProgressException";
+    $fault = "client";
     constructor(opts) {
         super({
             name: "UpdateInProgressException",
             $fault: "client",
             ...opts,
         });
-        this.name = "UpdateInProgressException";
-        this.$fault = "client";
         Object.setPrototypeOf(this, UpdateInProgressException.prototype);
     }
 }
@@ -113,26 +113,26 @@ export const ClusterSettingName = {
     CONTAINER_INSIGHTS: "containerInsights",
 };
 export class NamespaceNotFoundException extends __BaseException {
+    name = "NamespaceNotFoundException";
+    $fault = "client";
     constructor(opts) {
         super({
             name: "NamespaceNotFoundException",
             $fault: "client",
             ...opts,
         });
-        this.name = "NamespaceNotFoundException";
-        this.$fault = "client";
         Object.setPrototypeOf(this, NamespaceNotFoundException.prototype);
     }
 }
 export class ClusterNotFoundException extends __BaseException {
+    name = "ClusterNotFoundException";
+    $fault = "client";
     constructor(opts) {
         super({
             name: "ClusterNotFoundException",
             $fault: "client",
             ...opts,
         });
-        this.name = "ClusterNotFoundException";
-        this.$fault = "client";
         Object.setPrototypeOf(this, ClusterNotFoundException.prototype);
     }
 }
@@ -204,62 +204,62 @@ export const StabilityStatus = {
     STEADY_STATE: "STEADY_STATE",
 };
 export class PlatformTaskDefinitionIncompatibilityException extends __BaseException {
+    name = "PlatformTaskDefinitionIncompatibilityException";
+    $fault = "client";
     constructor(opts) {
         super({
             name: "PlatformTaskDefinitionIncompatibilityException",
             $fault: "client",
             ...opts,
         });
-        this.name = "PlatformTaskDefinitionIncompatibilityException";
-        this.$fault = "client";
         Object.setPrototypeOf(this, PlatformTaskDefinitionIncompatibilityException.prototype);
     }
 }
 export class PlatformUnknownException extends __BaseException {
+    name = "PlatformUnknownException";
+    $fault = "client";
     constructor(opts) {
         super({
             name: "PlatformUnknownException",
             $fault: "client",
             ...opts,
         });
-        this.name = "PlatformUnknownException";
-        this.$fault = "client";
         Object.setPrototypeOf(this, PlatformUnknownException.prototype);
     }
 }
 export class UnsupportedFeatureException extends __BaseException {
+    name = "UnsupportedFeatureException";
+    $fault = "client";
     constructor(opts) {
         super({
             name: "UnsupportedFeatureException",
             $fault: "client",
             ...opts,
         });
-        this.name = "UnsupportedFeatureException";
-        this.$fault = "client";
         Object.setPrototypeOf(this, UnsupportedFeatureException.prototype);
     }
 }
 export class ServiceNotActiveException extends __BaseException {
+    name = "ServiceNotActiveException";
+    $fault = "client";
     constructor(opts) {
         super({
             name: "ServiceNotActiveException",
             $fault: "client",
             ...opts,
         });
-        this.name = "ServiceNotActiveException";
-        this.$fault = "client";
         Object.setPrototypeOf(this, ServiceNotActiveException.prototype);
     }
 }
 export class ServiceNotFoundException extends __BaseException {
+    name = "ServiceNotFoundException";
+    $fault = "client";
     constructor(opts) {
         super({
             name: "ServiceNotFoundException",
             $fault: "client",
             ...opts,
         });
-        this.name = "ServiceNotFoundException";
-        this.$fault = "client";
         Object.setPrototypeOf(this, ServiceNotFoundException.prototype);
     }
 }
@@ -282,50 +282,50 @@ export const TargetType = {
     CONTAINER_INSTANCE: "container-instance",
 };
 export class TargetNotFoundException extends __BaseException {
+    name = "TargetNotFoundException";
+    $fault = "client";
     constructor(opts) {
         super({
             name: "TargetNotFoundException",
             $fault: "client",
             ...opts,
         });
-        this.name = "TargetNotFoundException";
-        this.$fault = "client";
         Object.setPrototypeOf(this, TargetNotFoundException.prototype);
     }
 }
 export class ClusterContainsContainerInstancesException extends __BaseException {
+    name = "ClusterContainsContainerInstancesException";
+    $fault = "client";
     constructor(opts) {
         super({
             name: "ClusterContainsContainerInstancesException",
             $fault: "client",
             ...opts,
         });
-        this.name = "ClusterContainsContainerInstancesException";
-        this.$fault = "client";
         Object.setPrototypeOf(this, ClusterContainsContainerInstancesException.prototype);
     }
 }
 export class ClusterContainsServicesException extends __BaseException {
+    name = "ClusterContainsServicesException";
+    $fault = "client";
     constructor(opts) {
         super({
             name: "ClusterContainsServicesException",
             $fault: "client",
             ...opts,
         });
-        this.name = "ClusterContainsServicesException";
-        this.$fault = "client";
         Object.setPrototypeOf(this, ClusterContainsServicesException.prototype);
     }
 }
 export class ClusterContainsTasksException extends __BaseException {
+    name = "ClusterContainsTasksException";
+    $fault = "client";
     constructor(opts) {
         super({
             name: "ClusterContainsTasksException",
             $fault: "client",
             ...opts,
         });
-        this.name = "ClusterContainsTasksException";
-        this.$fault = "client";
         Object.setPrototypeOf(this, ClusterContainsTasksException.prototype);
     }
 }
@@ -439,14 +439,14 @@ export const EFSTransitEncryption = {
     ENABLED: "ENABLED",
 };
 export class TaskSetNotFoundException extends __BaseException {
+    name = "TaskSetNotFoundException";
+    $fault = "client";
     constructor(opts) {
         super({
             name: "TaskSetNotFoundException",
             $fault: "client",
             ...opts,
         });
-        this.name = "TaskSetNotFoundException";
-        this.$fault = "client";
         Object.setPrototypeOf(this, TaskSetNotFoundException.prototype);
     }
 }
@@ -522,26 +522,26 @@ export const TaskSetField = {
     TAGS: "TAGS",
 };
 export class TargetNotConnectedException extends __BaseException {
+    name = "TargetNotConnectedException";
+    $fault = "client";
     constructor(opts) {
         super({
             name: "TargetNotConnectedException",
             $fault: "client",
             ...opts,
         });
-        this.name = "TargetNotConnectedException";
-        this.$fault = "client";
         Object.setPrototypeOf(this, TargetNotConnectedException.prototype);
     }
 }
 export class ResourceNotFoundException extends __BaseException {
+    name = "ResourceNotFoundException";
+    $fault = "client";
     constructor(opts) {
         super({
             name: "ResourceNotFoundException",
             $fault: "client",
             ...opts,
         });
-        this.name = "ResourceNotFoundException";
-        this.$fault = "client";
         Object.setPrototypeOf(this, ResourceNotFoundException.prototype);
     }
 }
@@ -567,26 +567,26 @@ export const DesiredStatus = {
     STOPPED: "STOPPED",
 };
 export class AttributeLimitExceededException extends __BaseException {
+    name = "AttributeLimitExceededException";
+    $fault = "client";
     constructor(opts) {
         super({
             name: "AttributeLimitExceededException",
             $fault: "client",
             ...opts,
         });
-        this.name = "AttributeLimitExceededException";
-        this.$fault = "client";
         Object.setPrototypeOf(this, AttributeLimitExceededException.prototype);
     }
 }
 export class ResourceInUseException extends __BaseException {
+    name = "ResourceInUseException";
+    $fault = "client";
     constructor(opts) {
         super({
             name: "ResourceInUseException",
             $fault: "client",
             ...opts,
         });
-        this.name = "ResourceInUseException";
-        this.$fault = "client";
         Object.setPrototypeOf(this, ResourceInUseException.prototype);
     }
 }
@@ -594,26 +594,27 @@ export const PlatformDeviceType = {
     GPU: "GPU",
 };
 export class BlockedException extends __BaseException {
+    name = "BlockedException";
+    $fault = "client";
     constructor(opts) {
         super({
             name: "BlockedException",
             $fault: "client",
             ...opts,
         });
-        this.name = "BlockedException";
-        this.$fault = "client";
         Object.setPrototypeOf(this, BlockedException.prototype);
     }
 }
 export class ConflictException extends __BaseException {
+    name = "ConflictException";
+    $fault = "client";
+    resourceIds;
     constructor(opts) {
         super({
             name: "ConflictException",
             $fault: "client",
             ...opts,
         });
-        this.name = "ConflictException";
-        this.$fault = "client";
         Object.setPrototypeOf(this, ConflictException.prototype);
         this.resourceIds = opts.resourceIds;
     }

package/dist-es/models/models_1.js

@@ -1,25 +1,25 @@
 import { ECSServiceException as __BaseException } from "./ECSServiceException";
 export class MissingVersionException extends __BaseException {
+    name = "MissingVersionException";
+    $fault = "client";
     constructor(opts) {
         super({
             name: "MissingVersionException",
             $fault: "client",
             ...opts,
         });
-        this.name = "MissingVersionException";
-        this.$fault = "client";
         Object.setPrototypeOf(this, MissingVersionException.prototype);
     }
 }
 export class NoUpdateAvailableException extends __BaseException {
+    name = "NoUpdateAvailableException";
+    $fault = "client";
     constructor(opts) {
         super({
             name: "NoUpdateAvailableException",
             $fault: "client",
             ...opts,
         });
-        this.name = "NoUpdateAvailableException";
-        this.$fault = "client";
         Object.setPrototypeOf(this, NoUpdateAvailableException.prototype);
     }
 }

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

@@ -135,6 +135,46 @@ declare const CreateCapacityProviderCommand_base: {
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
  * @public
+ * @example To create a capacity provider
+ * ```javascript
+ * // This example creates a capacity provider that uses the specified Auto Scaling group MyASG and has managed scaling and manager termination protection enabled.
+ * const input = {
+ *   "name": "MyCapacityProvider",
+ *   "autoScalingGroupProvider": {
+ *     "autoScalingGroupArn": "arn:aws:autoscaling:us-east-1:123456789012:autoScalingGroup:57ffcb94-11f0-4d6d-bf60-3bac5EXAMPLE:autoScalingGroupName/MyASG",
+ *     "managedScaling": {
+ *       "status": "ENABLED",
+ *       "targetCapacity": 100
+ *     },
+ *     "managedTerminationProtection": "ENABLED"
+ *   }
+ * };
+ * const command = new CreateCapacityProviderCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "capacityProvider": {
+ *     "name": "MyCapacityProvider",
+ *     "autoScalingGroupProvider": {
+ *       "autoScalingGroupArn": "arn:aws:autoscaling:us-east-1:132456789012:autoScalingGroup:57ffcb94-11f0-4d6d-bf60-3bac5EXAMPLE:autoScalingGroupName/MyASG",
+ *       "managedScaling": {
+ *         "instanceWarmupPeriod": 300,
+ *         "maximumScalingStepSize": 10000,
+ *         "minimumScalingStepSize": 1,
+ *         "status": "ENABLED",
+ *         "targetCapacity": 100
+ *       },
+ *       "managedTerminationProtection": "ENABLED"
+ *     },
+ *     "capacityProviderArn": "arn:aws:ecs:us-east-1:123456789012:capacity-provider/MyCapacityProvider",
+ *     "status": "ACTIVE",
+ *     "tags": []
+ *   }
+ * }
+ * *\/
+ * // example id: to-create-a-capacity-provider--1733861347945
+ * ```
+ *
  */
 export declare class CreateCapacityProviderCommand extends CreateCapacityProviderCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -228,6 +228,64 @@ declare const CreateTaskSetCommand_base: {
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
  * @public
+ * @example To create a task set
+ * ```javascript
+ * // This example creates a task set in a service that uses the EXTERNAL deployment controller.
+ * const input = {
+ *   "cluster": "MyCluster",
+ *   "networkConfiguration": {
+ *     "awsvpcConfiguration": {
+ *       "securityGroups": [
+ *         "sg-12344321"
+ *       ],
+ *       "subnets": [
+ *         "subnet-12344321"
+ *       ]
+ *     }
+ *   },
+ *   "service": "MyService",
+ *   "taskDefinition": "MyTaskDefinition:2"
+ * };
+ * const command = new CreateTaskSetCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "taskSet": {
+ *     "computedDesiredCount": 0,
+ *     "createdAt": 1557128360.711,
+ *     "id": "ecs-svc/1234567890123456789",
+ *     "launchType": "EC2",
+ *     "loadBalancers": [],
+ *     "networkConfiguration": {
+ *       "awsvpcConfiguration": {
+ *         "assignPublicIp": "DISABLED",
+ *         "securityGroups": [
+ *           "sg-12344321"
+ *         ],
+ *         "subnets": [
+ *           "subnet-12344321"
+ *         ]
+ *       }
+ *     },
+ *     "pendingCount": 0,
+ *     "runningCount": 0,
+ *     "scale": {
+ *       "value": 0,
+ *       "unit": "PERCENT"
+ *     },
+ *     "serviceRegistries": [],
+ *     "stabilityStatus": "STABILIZING",
+ *     "stabilityStatusAt": 1557128360.711,
+ *     "status": "ACTIVE",
+ *     "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/MyTaskDefinition:2",
+ *     "taskSetArn": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789",
+ *     "updatedAt": 1557128360.711
+ *   }
+ * }
+ * *\/
+ * // example id: to-create-a-task-set-1733864092815
+ * ```
+ *
  */
 export declare class CreateTaskSetCommand extends CreateTaskSetCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -82,6 +82,33 @@ declare const DeleteAttributesCommand_base: {
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
  * @public
+ * @example To delete a custom attribute from an Amazon ECS instance
+ * ```javascript
+ * // This example deletes an attribute named stack from a container instance.
+ * const input = {
+ *   "attributes": [
+ *     {
+ *       "name": "stack",
+ *       "targetId": "aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34"
+ *     }
+ *   ]
+ * };
+ * const command = new DeleteAttributesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "attributes": [
+ *     {
+ *       "name": "stack",
+ *       "value": "production",
+ *       "targetId": "aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-delete-a-custom-attribute-from-an-amazon-ecs-instance-1733867267541
+ * ```
+ *
  */
 export declare class DeleteAttributesCommand extends DeleteAttributesCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -114,6 +114,38 @@ declare const DeleteCapacityProviderCommand_base: {
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
  * @public
+ * @example To delete a specified capacity provider
+ * ```javascript
+ * // This example deletes a specified capacity provider.
+ * const input = {
+ *   "capacityProvider": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/ExampleCapacityProvider"
+ * };
+ * const command = new DeleteCapacityProviderCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "capacityProvider": {
+ *     "name": "ExampleCapacityProvider",
+ *     "autoScalingGroupProvider": {
+ *       "autoScalingGroupArn": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:autoScalingGroupName/MyAutoScalingGroup",
+ *       "managedScaling": {
+ *         "maximumScalingStepSize": 10000,
+ *         "minimumScalingStepSize": 1,
+ *         "status": "ENABLED",
+ *         "targetCapacity": 100
+ *       },
+ *       "managedTerminationProtection": "DISABLED"
+ *     },
+ *     "capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/ExampleCapacityProvider",
+ *     "status": "ACTIVE",
+ *     "tags": [],
+ *     "updateStatus": "DELETE_IN_PROGRESS"
+ *   }
+ * }
+ * *\/
+ * // example id: to-delete-a-specified-capacity-provider-1733868702678
+ * ```
+ *
  */
 export declare class DeleteCapacityProviderCommand extends DeleteCapacityProviderCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -381,6 +381,53 @@ declare const DeleteTaskDefinitionsCommand_base: {
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
  * @public
+ * @example To delete a task definition that has been deregistered
+ * ```javascript
+ * // This example deletes a specified deregistered task definition.
+ * const input = {
+ *   "taskDefinitions": [
+ *     "Example-task-definition:1"
+ *   ]
+ * };
+ * const command = new DeleteTaskDefinitionsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "failures": [],
+ *   "taskDefinitions": [
+ *     {
+ *       "containerDefinitions": [
+ *         {
+ *           "name": "wave",
+ *           "command": [
+ *             "apt-get update; apt-get install stress; while true; do stress --cpu $(( RANDOM % 4 )) -t $(( RANDOM % 10 )); done"
+ *           ],
+ *           "cpu": 50,
+ *           "entryPoint": [
+ *             "bash",
+ *             "-c"
+ *           ],
+ *           "environment": [],
+ *           "essential": true,
+ *           "image": "ubuntu",
+ *           "memory": 100,
+ *           "mountPoints": [],
+ *           "portMappings": [],
+ *           "volumesFrom": []
+ *         }
+ *       ],
+ *       "family": "cpu-wave",
+ *       "revision": 1,
+ *       "status": "DELETE_IN_PROGRESS",
+ *       "taskDefinitionArn": "arn:aws:ecs:us-east-1:012345678910:task-definition/Example-task-definition:1",
+ *       "volumes": []
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-delete-a-task-definition-that-has-been-deregistered-1733940790186
+ * ```
+ *
  */
 export declare class DeleteTaskDefinitionsCommand extends DeleteTaskDefinitionsCommand_base {
     /** @internal type navigation helper, not in runtime. */