@aws-sdk/client-ecs 3.722.0 → 3.726.0

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

@@ -168,6 +168,55 @@ declare const DeleteTaskSetCommand_base: {
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
  * @public
+ * @example To delete a task set within a service that uses the EXTERNAL deployment controller type
+ * ```javascript
+ * // This example deletes a task set and uses the force flag to force deletion if it hasn't scaled to zero.
+ * const input = {
+ *   "cluster": "MyCluster",
+ *   "force": true,
+ *   "service": "MyService",
+ *   "taskSet": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789"
+ * };
+ * const command = new DeleteTaskSetCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "taskSet": {
+ *     "computedDesiredCount": 0,
+ *     "createdAt": 1557130260.276,
+ *     "id": "ecs-svc/1234567890123456789",
+ *     "launchType": "EC2",
+ *     "loadBalancers": [],
+ *     "networkConfiguration": {
+ *       "awsvpcConfiguration": {
+ *         "assignPublicIp": "DISABLED",
+ *         "securityGroups": [
+ *           "sg-12345678"
+ *         ],
+ *         "subnets": [
+ *           "subnet-12345678"
+ *         ]
+ *       }
+ *     },
+ *     "pendingCount": 0,
+ *     "runningCount": 0,
+ *     "scale": {
+ *       "value": 0,
+ *       "unit": "PERCENT"
+ *     },
+ *     "serviceRegistries": [],
+ *     "stabilityStatus": "STABILIZING",
+ *     "stabilityStatusAt": 1557130290.707,
+ *     "status": "DRAINING",
+ *     "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:2",
+ *     "taskSetArn": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789",
+ *     "updatedAt": 1557130290.707
+ *   }
+ * }
+ * *\/
+ * // example id: to-delete-a-task-set-within-a-service-that-uses-the-external-deployment-controller-type-1733949897807
+ * ```
+ *
  */
 export declare class DeleteTaskSetCommand extends DeleteTaskSetCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -365,6 +365,45 @@ declare const DeregisterTaskDefinitionCommand_base: {
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
  * @public
+ * @example To deregister a revision of a task definition
+ * ```javascript
+ * // This example deregisters the first revision of the curler task definition
+ * const input = {
+ *   "taskDefinition": "curler:1"
+ * };
+ * const command = new DeregisterTaskDefinitionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "taskDefinition": {
+ *     "containerDefinitions": [
+ *       {
+ *         "name": "curler",
+ *         "command": [
+ *           "curl -v http://example.com/"
+ *         ],
+ *         "cpu": 100,
+ *         "entryPoint": [],
+ *         "environment": [],
+ *         "essential": true,
+ *         "image": "curl:latest",
+ *         "memory": 256,
+ *         "mountPoints": [],
+ *         "portMappings": [],
+ *         "volumesFrom": []
+ *       }
+ *     ],
+ *     "family": "curler",
+ *     "revision": 1,
+ *     "status": "INACTIVE",
+ *     "taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/curler:1",
+ *     "volumes": []
+ *   }
+ * }
+ * *\/
+ * // example id: to-deregister-a-revision-of-a-task-definition-1733950214421
+ * ```
+ *
  */
 export declare class DeregisterTaskDefinitionCommand extends DeregisterTaskDefinitionCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -118,6 +118,92 @@ declare const DescribeCapacityProvidersCommand_base: {
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
  * @public
+ * @example To describe all capacity providers
+ * ```javascript
+ * // This example retrieves details about all capacity providers.
+ * const input = {};
+ * const command = new DescribeCapacityProvidersCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "capacityProviders": [
+ *     {
+ *       "name": "MyCapacityProvider",
+ *       "autoScalingGroupProvider": {
+ *         "autoScalingGroupArn": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:autoScalingGroupName/MyAutoScalingGroup",
+ *         "managedScaling": {
+ *           "maximumScalingStepSize": 1000,
+ *           "minimumScalingStepSize": 1,
+ *           "status": "ENABLED",
+ *           "targetCapacity": 100
+ *         },
+ *         "managedTerminationProtection": "ENABLED"
+ *       },
+ *       "capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/MyCapacityProvider",
+ *       "status": "ACTIVE",
+ *       "tags": []
+ *     },
+ *     {
+ *       "name": "FARGATE",
+ *       "capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/FARGATE",
+ *       "status": "ACTIVE",
+ *       "tags": []
+ *     },
+ *     {
+ *       "name": "FARGATE_SPOT",
+ *       "capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/FARGATE_SPOT",
+ *       "status": "ACTIVE",
+ *       "tags": []
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-all-capacity-providers-1733951199913
+ * ```
+ *
+ * @example To describe a specific capacity provider
+ * ```javascript
+ * // This example retrieves details about the capacity provider MyCapacityProvider
+ * const input = {
+ *   "capacityProviders": [
+ *     "MyCapacityProvider"
+ *   ],
+ *   "include": [
+ *     "TAGS"
+ *   ]
+ * };
+ * const command = new DescribeCapacityProvidersCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "capacityProviders": [
+ *     {
+ *       "name": "MyCapacityProvider",
+ *       "autoScalingGroupProvider": {
+ *         "autoScalingGroupArn": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:autoScalingGroupName/MyAutoScalingGroup",
+ *         "managedScaling": {
+ *           "maximumScalingStepSize": 1000,
+ *           "minimumScalingStepSize": 1,
+ *           "status": "ENABLED",
+ *           "targetCapacity": 100
+ *         },
+ *         "managedTerminationProtection": "ENABLED"
+ *       },
+ *       "capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/MyCapacityProvider",
+ *       "status": "ACTIVE",
+ *       "tags": [
+ *         {
+ *           "key": "environment",
+ *           "value": "production"
+ *         }
+ *       ]
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-a-specific-capacity-provider-1733951378688
+ * ```
+ *
  */
 export declare class DescribeCapacityProvidersCommand extends DescribeCapacityProvidersCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -163,6 +163,47 @@ declare const DescribeServiceDeploymentsCommand_base: {
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
  * @public
+ * @example To describe a service deployment
+ * ```javascript
+ * // This example describes a service deployment for the service sd-example in the example cluster.
+ * const input = {
+ *   "serviceDeploymentArns": [
+ *     "arn:aws:ecs:us-west-2:123456789012:service-deployment/example/sd-example/NCWGC2ZR-taawPAYrIaU5"
+ *   ]
+ * };
+ * const command = new DescribeServiceDeploymentsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "failures": [],
+ *   "serviceDeployments": [
+ *     {
+ *       "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/example",
+ *       "deploymentConfiguration": {
+ *         "deploymentCircuitBreaker": {
+ *           "enable": false,
+ *           "rollback": false
+ *         },
+ *         "maximumPercent": 200,
+ *         "minimumHealthyPercent": 100
+ *       },
+ *       "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/example/sd-example",
+ *       "serviceDeploymentArn": "arn:aws:ecs:us-west-2:123456789012:service-deployment/example/sd-example/NCWGC2ZR-taawPAYrIaU5",
+ *       "status": "PENDING",
+ *       "targetServiceRevision": {
+ *         "arn": "arn:aws:ecs:us-west-2:123456789012:service-revision/example/sd-example/4980306466373577095",
+ *         "pendingTaskCount": 0,
+ *         "requestedTaskCount": 0,
+ *         "runningTaskCount": 0
+ *       },
+ *       "updatedAt": "2024-09-10T16:49:35.572000+00:00"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-a-service-deployment--1733954961143
+ * ```
+ *
  */
 export declare class DescribeServiceDeploymentsCommand extends DescribeServiceDeploymentsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -234,6 +234,47 @@ declare const DescribeServiceRevisionsCommand_base: {
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
  * @public
+ * @example To describe a service revision
+ * ```javascript
+ * // This example describes a service revision with the specified ARN
+ * const input = {
+ *   "serviceRevisionArns": [
+ *     "arn:aws:ecs:us-west-2:123456789012:service-revision/testc/sd1/4980306466373577095"
+ *   ]
+ * };
+ * const command = new DescribeServiceRevisionsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "failures": [],
+ *   "serviceRevisions": [
+ *     {
+ *       "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/example",
+ *       "createdAt": "2024-09-10T16:49:26.388000+00:00",
+ *       "launchType": "FARGATE",
+ *       "networkConfiguration": {
+ *         "awsvpcConfiguration": {
+ *           "assignPublicIp": "ENABLED",
+ *           "securityGroups": [
+ *             "sg-09605d60a6bc1b296"
+ *           ],
+ *           "subnets": [
+ *             "subnet-0a4040e73895f04e1"
+ *           ]
+ *         }
+ *       },
+ *       "platformFamily": "DockerLinux",
+ *       "platformVersion": "1.4.0",
+ *       "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/example/sd-example",
+ *       "serviceRevisionArn": "arn:aws:ecs:us-west-2:123456789012:service-revision/example/sd-example/4980306466373577095",
+ *       "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/large-ngingx:1"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-a-service-revision--1734033215738
+ * ```
+ *
  */
 export declare class DescribeServiceRevisionsCommand extends DescribeServiceRevisionsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -179,6 +179,59 @@ declare const DescribeTaskSetsCommand_base: {
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
  * @public
+ * @example To describe a task set
+ * ```javascript
+ * // This example describes a task set in service MyService that uses an EXTERNAL deployment controller.
+ * const input = {
+ *   "cluster": "MyCluster",
+ *   "service": "MyService",
+ *   "taskSets": [
+ *     "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789"
+ *   ]
+ * };
+ * const command = new DescribeTaskSetsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "failures": [],
+ *   "taskSets": [
+ *     {
+ *       "computedDesiredCount": 0,
+ *       "createdAt": 1557207715.195,
+ *       "id": "ecs-svc/1234567890123456789",
+ *       "launchType": "EC2",
+ *       "loadBalancers": [],
+ *       "networkConfiguration": {
+ *         "awsvpcConfiguration": {
+ *           "assignPublicIp": "DISABLED",
+ *           "securityGroups": [
+ *             "sg-1234431"
+ *           ],
+ *           "subnets": [
+ *             "subnet-12344321"
+ *           ]
+ *         }
+ *       },
+ *       "pendingCount": 0,
+ *       "runningCount": 0,
+ *       "scale": {
+ *         "value": 0,
+ *         "unit": "PERCENT"
+ *       },
+ *       "serviceRegistries": [],
+ *       "stabilityStatus": "STEADY_STATE",
+ *       "stabilityStatusAt": 1557207740.014,
+ *       "status": "ACTIVE",
+ *       "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:2",
+ *       "taskSetArn": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789",
+ *       "updatedAt": 1557207740.014
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-a-task-set--1734035629507
+ * ```
+ *
  */
 export declare class DescribeTaskSetsCommand extends DescribeTaskSetsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -121,6 +121,35 @@ declare const ExecuteCommandCommand_base: {
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
  * @public
+ * @example To run a command remotely on a container in a task
+ * ```javascript
+ * // This example runs an interactive /bin/sh command on a container MyContainer.
+ * const input = {
+ *   "cluster": "MyCluster",
+ *   "command": "/bin/sh",
+ *   "container": "MyContainer",
+ *   "interactive": true,
+ *   "task": "arn:aws:ecs:us-east-1:123456789012:task/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE"
+ * };
+ * const command = new ExecuteCommandCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/MyCluster",
+ *   "containerArn": "arn:aws:ecs:us-east-1:123456789012:container/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE/43ba4b77-37f7-4a41-b923-69d4abEXAMPLE",
+ *   "containerName": "MyContainer",
+ *   "interactive": true,
+ *   "session": {
+ *     "sessionId": "ecs-execute-command-794nnsxobsg4p2hiur6gxu9a9e",
+ *     "streamUrl": "wss://ssmmessages.us-east-1.amazonaws.com/v1/data-channel/ecs-execute-command-794nnsxobsg4p2hiur6gxu9a9e?role=publish_subscribe&cell-number=AAEAAfiZG4oybxqsYj3Zhm15s4J0W1k7d9nxVRenNO8Kl5nzAAAAAGdbWGl479/y/4IrTWPadUic3eBrMu3vmB7aPvI+s12lbpDc142y1KZy",
+ *     "tokenValue": "AAEAAcVb7ww10N9aNUI5Cl7K7DbHjbD2Ed4Mw6uaGYIc+UFNAAAAAGdbWGmMDaPbGfDkzrVIhyKEsc4CPT2hcToPU6yzlddPm7rRZvYQtpaAgsvQdjbCAd9OB6ohtDYfqZI9gzMqLKegXq0E+KbDcGPnQVODFNHmQxnR1BvC6vNcHqh6HAJuKnQD7RSYx/J5bfYNHj4hCYHuN0HNcueSDOOTRB/MBt5DBDY7Djv2uzs9FD0N1kcsGljZkZWLuPTVKHHyrU3zh0awfrFFC3RXvgaUCBnloIIvZeq2CjTesxn9JJS+3N4I0DVxfkHdWWBbBY/5+wH82JVTJpqN3yOAt74u/W7TvYBd7Xu2lQbvtpuAnEszl++bFG2ZoV3dfnmBkSnfD/qV1FJcEskbxUHKgmqe0Paouv4zwrQKNfWYfcv9xkWskqcExh07IeaxZz1tp/WegZ5D76sD6xYeuH+35TMNXMoY7oudLgxIXsA7b39ElM7orGi4Jy3W2tLyuNIvDoI2JI6ww4tYdEjYZnld9rhKwV9rDHk1Z8wjHMs++3BIkHrFQRsv7BFUWlZ9lyqO9GWlXeBe7dQtOeFNahBuJUE9z/xLHJn1x13VkdROKqUVHTJrT4sXAnI5roWiGPoQPVY7aHVYJnwjSxrPRWJBsgyHiVN3dAWTmeVMjp0VbOiJaLlpBI+AUWs8OeVRzuJSZ+1alETpK7Ukag7ma9K4lxq/N7IxYo2ub0cG/bvX42zQqdJAW+9St9sQ1QMaMvkSq1tdbLoOuY0QjN7JrkuKLFQA5bhs+o1YwItzIp7bNrzQ9Z9IN51qoGL5HDXQzi1kNFfYtAryhwt6BgtQU9Z0k+RpE+V5G+V68E0MMUvb313f0nRBYj1u5VKonWb708wADPbUU+s7nvbWuD5oLp1Z6A4iqI9Om0R4RrFASj/7fVY7r3raNXcIYA="
+ *   },
+ *   "taskArn": "arn:aws:ecs:us-east-1:123456789012:task/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE"
+ * }
+ * *\/
+ * // example id: to-run-a-command-remotely-on-a-container-in-a-task-1734037663312
+ * ```
+ *
  */
 export declare class ExecuteCommandCommand extends ExecuteCommandCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -81,6 +81,31 @@ declare const ListAttributesCommand_base: {
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
  * @public
+ * @example To list container instances that have a specific attribute
+ * ```javascript
+ * // This example lists attributes for a container instance with the attribute "stack" equal to the value "production".
+ * const input = {
+ *   "attributeName": "stack",
+ *   "attributeValue": "production",
+ *   "cluster": "MyCluster",
+ *   "targetType": "container-instance"
+ * };
+ * const command = new ListAttributesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "attributes": [
+ *     {
+ *       "name": "stack",
+ *       "value": "production",
+ *       "targetId": "arn:aws:ecs:us-west-2:123456789012:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-container-instances-that-have-a-specific-attribute-1734368946577
+ * ```
+ *
  */
 export declare class ListAttributesCommand extends ListAttributesCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -115,6 +115,34 @@ declare const ListServiceDeploymentsCommand_base: {
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
  * @public
+ * @example To list service deployments that meet the specified criteria
+ * ```javascript
+ * // This example lists all successful service deployments for the service "sd-example" in the cluster "example".
+ * const input = {
+ *   "cluster": "example",
+ *   "service": "sd-example",
+ *   "status": [
+ *     "SUCCESSFUL"
+ *   ]
+ * };
+ * const command = new ListServiceDeploymentsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "serviceDeployments": [
+ *     {
+ *       "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/example",
+ *       "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/example/sd-example",
+ *       "serviceDeploymentArn": "arn:aws:ecs:us-west-2:123456789012:service-deployment/example/sd-example/NCWGC2ZR-taawPAYrIaU5",
+ *       "status": "SUCCESSFUL",
+ *       "targetServiceRevisionArn": "arn:aws:ecs:us-west-2:123456789012:service-revision/example/sd-example/4980306466373577095"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-service-deployments-that-meet-the-specified-criteria-1734370445427
+ * ```
+ *
  */
 export declare class ListServiceDeploymentsCommand extends ListServiceDeploymentsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -89,6 +89,35 @@ declare const PutAttributesCommand_base: {
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
  * @public
+ * @example To create or update an attribute on a resource
+ * ```javascript
+ * // This example adds an attribute "stack" with the value "production" to a container instance.
+ * const input = {
+ *   "attributes": [
+ *     {
+ *       "name": "stack",
+ *       "value": "production",
+ *       "targetId": "arn:aws:ecs:us-west-2:123456789012:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34"
+ *     }
+ *   ],
+ *   "cluster": "MyCluster"
+ * };
+ * const command = new PutAttributesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "attributes": [
+ *     {
+ *       "name": "stack",
+ *       "value": "production",
+ *       "targetId": "arn:aws:ecs:us-west-2:123456789012:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-create-or-update-an-attribute-on-a-resource-1734382423405
+ * ```
+ *
  */
 export declare class PutAttributesCommand extends PutAttributesCommand_base {
     /** @internal type navigation helper, not in runtime. */