@aws-sdk/client-ecs 3.775.0 → 3.777.0

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

@@ -384,18 +384,21 @@ declare const DeleteServiceCommand_base: {
  * @throws {@link ECSServiceException}
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
- * @public
+ *
  * @example To delete a service
  * ```javascript
  * // This example deletes the my-http-service service. The service must have a desired count and running count of 0 before you can delete it.
  * const input = {
- *   "service": "my-http-service"
+ *   service: "my-http-service"
  * };
  * const command = new DeleteServiceCommand(input);
- * await client.send(command);
- * // example id: e8183e38-f86e-4390-b811-f74f30a6007d
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeleteServiceCommand extends DeleteServiceCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -381,54 +381,54 @@ declare const DeleteTaskDefinitionsCommand_base: {
  * @throws {@link ECSServiceException}
  * <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": [
+ *   taskDefinitions: [
  *     "Example-task-definition:1"
  *   ]
  * };
  * const command = new DeleteTaskDefinitionsCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "failures": [],
- *   "taskDefinitions": [
+ *   failures:   [],
+ *   taskDefinitions: [
  *     {
- *       "containerDefinitions": [
+ *       containerDefinitions: [
  *         {
- *           "name": "wave",
- *           "command": [
+ *           command: [
  *             "apt-get update; apt-get install stress; while true; do stress --cpu $(( RANDOM % 4 )) -t $(( RANDOM % 10 )); done"
  *           ],
- *           "cpu": 50,
- *           "entryPoint": [
+ *           cpu: 50,
+ *           entryPoint: [
  *             "bash",
  *             "-c"
  *           ],
- *           "environment": [],
- *           "essential": true,
- *           "image": "ubuntu",
- *           "memory": 100,
- *           "mountPoints": [],
- *           "portMappings": [],
- *           "volumesFrom": []
+ *           environment:           [],
+ *           essential: true,
+ *           image: "ubuntu",
+ *           memory: 100,
+ *           mountPoints:           [],
+ *           name: "wave",
+ *           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": []
+ *       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
  * ```
  *
+ * @public
  */
 export declare class DeleteTaskDefinitionsCommand extends DeleteTaskDefinitionsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -168,56 +168,56 @@ declare const DeleteTaskSetCommand_base: {
  * @throws {@link ECSServiceException}
  * <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"
+ *   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 ==
+ * /* response is
  * {
- *   "taskSet": {
- *     "computedDesiredCount": 0,
- *     "createdAt": 1557130260.276,
- *     "id": "ecs-svc/1234567890123456789",
- *     "launchType": "EC2",
- *     "loadBalancers": [],
- *     "networkConfiguration": {
- *       "awsvpcConfiguration": {
- *         "assignPublicIp": "DISABLED",
- *         "securityGroups": [
+ *   taskSet: {
+ *     computedDesiredCount: 0,
+ *     createdAt: 1.557130260276E9,
+ *     id: "ecs-svc/1234567890123456789",
+ *     launchType: "EC2",
+ *     loadBalancers:     [],
+ *     networkConfiguration: {
+ *       awsvpcConfiguration: {
+ *         assignPublicIp: "DISABLED",
+ *         securityGroups: [
  *           "sg-12345678"
  *         ],
- *         "subnets": [
+ *         subnets: [
  *           "subnet-12345678"
  *         ]
  *       }
  *     },
- *     "pendingCount": 0,
- *     "runningCount": 0,
- *     "scale": {
- *       "value": 0,
- *       "unit": "PERCENT"
+ *     pendingCount: 0,
+ *     runningCount: 0,
+ *     scale: {
+ *       unit: "PERCENT",
+ *       value: 0
  *     },
- *     "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
+ *     serviceRegistries:     [],
+ *     stabilityStatus: "STABILIZING",
+ *     stabilityStatusAt: 1.557130290707E9,
+ *     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: 1.557130290707E9
  *   }
  * }
  * *\/
- * // example id: to-delete-a-task-set-within-a-service-that-uses-the-external-deployment-controller-type-1733949897807
  * ```
  *
+ * @public
  */
 export declare class DeleteTaskSetCommand extends DeleteTaskSetCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -174,20 +174,23 @@ declare const DeregisterContainerInstanceCommand_base: {
  * @throws {@link ECSServiceException}
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
- * @public
+ *
  * @example To deregister a container instance from a cluster
  * ```javascript
  * // This example deregisters a container instance from the specified cluster in your default region. If there are still tasks running on the container instance, you must either stop those tasks before deregistering, or use the force option.
  * const input = {
- *   "cluster": "default",
- *   "containerInstance": "container_instance_UUID",
- *   "force": true
+ *   cluster: "default",
+ *   containerInstance: "container_instance_UUID",
+ *   force: true
  * };
  * const command = new DeregisterContainerInstanceCommand(input);
- * await client.send(command);
- * // example id: bf624927-cf64-4f4b-8b7e-c024a4e682f6
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DeregisterContainerInstanceCommand extends DeregisterContainerInstanceCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -365,46 +365,46 @@ declare const DeregisterTaskDefinitionCommand_base: {
  * @throws {@link ECSServiceException}
  * <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"
+ *   taskDefinition: "curler:1"
  * };
  * const command = new DeregisterTaskDefinitionCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "taskDefinition": {
- *     "containerDefinitions": [
+ *   taskDefinition: {
+ *     containerDefinitions: [
  *       {
- *         "name": "curler",
- *         "command": [
+ *         command: [
  *           "curl -v http://example.com/"
  *         ],
- *         "cpu": 100,
- *         "entryPoint": [],
- *         "environment": [],
- *         "essential": true,
- *         "image": "curl:latest",
- *         "memory": 256,
- *         "mountPoints": [],
- *         "portMappings": [],
- *         "volumesFrom": []
+ *         cpu: 100,
+ *         entryPoint:         [],
+ *         environment:         [],
+ *         essential: true,
+ *         image: "curl:latest",
+ *         memory: 256,
+ *         mountPoints:         [],
+ *         name: "curler",
+ *         portMappings:         [],
+ *         volumesFrom:         []
  *       }
  *     ],
- *     "family": "curler",
- *     "revision": 1,
- *     "status": "INACTIVE",
- *     "taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/curler:1",
- *     "volumes": []
+ *     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
  * ```
  *
+ * @public
  */
 export declare class DeregisterTaskDefinitionCommand extends DeregisterTaskDefinitionCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -118,93 +118,92 @@ declare const DescribeCapacityProvidersCommand_base: {
  * @throws {@link ECSServiceException}
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
- * @public
- * @example To describe all capacity providers
+ *
+ * @example To describe a specific capacity provider
  * ```javascript
- * // This example retrieves details about all capacity providers.
- * const input = {};
+ * // 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 ==
+ * /* response is
  * {
- *   "capacityProviders": [
+ *   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
+ *       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"
+ *         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": []
+ *       capacityProviderArn: "arn:aws:ecs:us-west-2:123456789012:capacity-provider/MyCapacityProvider",
+ *       name: "MyCapacityProvider",
+ *       status: "ACTIVE",
+ *       tags: [
+ *         {
+ *           key: "environment",
+ *           value: "production"
+ *         }
+ *       ]
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-describe-all-capacity-providers-1733951199913
  * ```
  *
- * @example To describe a specific capacity provider
+ * @example To describe all capacity providers
  * ```javascript
- * // This example retrieves details about the capacity provider MyCapacityProvider
- * const input = {
- *   "capacityProviders": [
- *     "MyCapacityProvider"
- *   ],
- *   "include": [
- *     "TAGS"
- *   ]
- * };
+ * // This example retrieves details about all capacity providers.
+ * const input = { /* empty *\/ };
  * const command = new DescribeCapacityProvidersCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "capacityProviders": [
+ *   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
+ *       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"
+ *         managedTerminationProtection: "ENABLED"
  *       },
- *       "capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/MyCapacityProvider",
- *       "status": "ACTIVE",
- *       "tags": [
- *         {
- *           "key": "environment",
- *           "value": "production"
- *         }
- *       ]
+ *       capacityProviderArn: "arn:aws:ecs:us-west-2:123456789012:capacity-provider/MyCapacityProvider",
+ *       name: "MyCapacityProvider",
+ *       status: "ACTIVE",
+ *       tags:       []
+ *     },
+ *     {
+ *       capacityProviderArn: "arn:aws:ecs:us-west-2:123456789012:capacity-provider/FARGATE",
+ *       name: "FARGATE",
+ *       status: "ACTIVE",
+ *       tags:       []
+ *     },
+ *     {
+ *       capacityProviderArn: "arn:aws:ecs:us-west-2:123456789012:capacity-provider/FARGATE_SPOT",
+ *       name: "FARGATE_SPOT",
+ *       status: "ACTIVE",
+ *       tags:       []
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-describe-a-specific-capacity-provider-1733951378688
  * ```
  *
+ * @public
  */
 export declare class DescribeCapacityProvidersCommand extends DescribeCapacityProvidersCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -162,32 +162,32 @@ declare const DescribeClustersCommand_base: {
  * @throws {@link ECSServiceException}
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
- * @public
+ *
  * @example To describe a cluster
  * ```javascript
  * // This example provides a description of the specified cluster in your default region.
  * const input = {
- *   "clusters": [
+ *   clusters: [
  *     "default"
  *   ]
  * };
  * const command = new DescribeClustersCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "clusters": [
+ *   clusters: [
  *     {
- *       "clusterArn": "arn:aws:ecs:us-east-1:aws_account_id:cluster/default",
- *       "clusterName": "default",
- *       "status": "ACTIVE"
+ *       clusterArn: "arn:aws:ecs:us-east-1:aws_account_id:cluster/default",
+ *       clusterName: "default",
+ *       status: "ACTIVE"
  *     }
  *   ],
- *   "failures": []
+ *   failures:   []
  * }
  * *\/
- * // example id: ba88d100-9672-4231-80da-a4bd210bf728
  * ```
  *
+ * @public
  */
 export declare class DescribeClustersCommand extends DescribeClustersCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -175,95 +175,95 @@ declare const DescribeContainerInstancesCommand_base: {
  * @throws {@link ECSServiceException}
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
- * @public
+ *
  * @example To describe container instance
  * ```javascript
  * // This example provides a description of the specified container instance in your default region, using the container instance UUID as an identifier.
  * const input = {
- *   "cluster": "default",
- *   "containerInstances": [
+ *   cluster: "default",
+ *   containerInstances: [
  *     "f2756532-8f13-4d53-87c9-aed50dc94cd7"
  *   ]
  * };
  * const command = new DescribeContainerInstancesCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "containerInstances": [
+ *   containerInstances: [
  *     {
- *       "agentConnected": true,
- *       "containerInstanceArn": "arn:aws:ecs:us-east-1:012345678910:container-instance/default/f2756532-8f13-4d53-87c9-aed50dc94cd7",
- *       "ec2InstanceId": "i-807f3249",
- *       "pendingTasksCount": 0,
- *       "registeredResources": [
+ *       agentConnected: true,
+ *       containerInstanceArn: "arn:aws:ecs:us-east-1:012345678910:container-instance/default/f2756532-8f13-4d53-87c9-aed50dc94cd7",
+ *       ec2InstanceId: "i-807f3249",
+ *       pendingTasksCount: 0,
+ *       registeredResources: [
  *         {
- *           "name": "CPU",
- *           "type": "INTEGER",
- *           "doubleValue": 0,
- *           "integerValue": 2048,
- *           "longValue": 0
+ *           doubleValue: 0.0,
+ *           integerValue: 2048,
+ *           longValue: 0,
+ *           name: "CPU",
+ *           type: "INTEGER"
  *         },
  *         {
- *           "name": "MEMORY",
- *           "type": "INTEGER",
- *           "doubleValue": 0,
- *           "integerValue": 3768,
- *           "longValue": 0
+ *           doubleValue: 0.0,
+ *           integerValue: 3768,
+ *           longValue: 0,
+ *           name: "MEMORY",
+ *           type: "INTEGER"
  *         },
  *         {
- *           "name": "PORTS",
- *           "type": "STRINGSET",
- *           "doubleValue": 0,
- *           "integerValue": 0,
- *           "longValue": 0,
- *           "stringSetValue": [
+ *           doubleValue: 0.0,
+ *           integerValue: 0,
+ *           longValue: 0,
+ *           name: "PORTS",
+ *           stringSetValue: [
  *             "2376",
  *             "22",
  *             "51678",
  *             "2375"
- *           ]
+ *           ],
+ *           type: "STRINGSET"
  *         }
  *       ],
- *       "remainingResources": [
+ *       remainingResources: [
  *         {
- *           "name": "CPU",
- *           "type": "INTEGER",
- *           "doubleValue": 0,
- *           "integerValue": 1948,
- *           "longValue": 0
+ *           doubleValue: 0.0,
+ *           integerValue: 1948,
+ *           longValue: 0,
+ *           name: "CPU",
+ *           type: "INTEGER"
  *         },
  *         {
- *           "name": "MEMORY",
- *           "type": "INTEGER",
- *           "doubleValue": 0,
- *           "integerValue": 3668,
- *           "longValue": 0
+ *           doubleValue: 0.0,
+ *           integerValue: 3668,
+ *           longValue: 0,
+ *           name: "MEMORY",
+ *           type: "INTEGER"
  *         },
  *         {
- *           "name": "PORTS",
- *           "type": "STRINGSET",
- *           "doubleValue": 0,
- *           "integerValue": 0,
- *           "longValue": 0,
- *           "stringSetValue": [
+ *           doubleValue: 0.0,
+ *           integerValue: 0,
+ *           longValue: 0,
+ *           name: "PORTS",
+ *           stringSetValue: [
  *             "2376",
  *             "22",
  *             "80",
  *             "51678",
  *             "2375"
- *           ]
+ *           ],
+ *           type: "STRINGSET"
  *         }
  *       ],
- *       "runningTasksCount": 1,
- *       "status": "ACTIVE"
+ *       runningTasksCount: 1,
+ *       status: "ACTIVE"
  *     }
  *   ],
- *   "failures": []
+ *   failures:   []
  * }
  * *\/
- * // example id: c8f439de-eb27-4269-8ca7-2c0a7ba75ab0
  * ```
  *
+ * @public
  */
 export declare class DescribeContainerInstancesCommand extends DescribeContainerInstancesCommand_base {
     /** @internal type navigation helper, not in runtime. */