@aws-sdk/client-ecs 3.774.0 → 3.777.0

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. */

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

@@ -163,48 +163,8 @@ declare const DescribeServiceDeploymentsCommand_base: {
  * @throws {@link ECSServiceException}
  * <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
- * ```
  *
+ * @public
  */
 export declare class DescribeServiceDeploymentsCommand extends DescribeServiceDeploymentsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -234,48 +234,8 @@ declare const DescribeServiceRevisionsCommand_base: {
  * @throws {@link ECSServiceException}
  * <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
- * ```
  *
+ * @public
  */
 export declare class DescribeServiceRevisionsCommand extends DescribeServiceRevisionsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -373,62 +373,62 @@ declare const DescribeServicesCommand_base: {
  * @throws {@link ECSServiceException}
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
- * @public
+ *
  * @example To describe a service
  * ```javascript
  * // This example provides descriptive information about the service named ``ecs-simple-service``.
  * const input = {
- *   "services": [
+ *   services: [
  *     "ecs-simple-service"
  *   ]
  * };
  * const command = new DescribeServicesCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "failures": [],
- *   "services": [
+ *   failures:   [],
+ *   services: [
  *     {
- *       "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/default",
- *       "createdAt": "2016-08-29T16:25:52.130Z",
- *       "deploymentConfiguration": {
- *         "maximumPercent": 200,
- *         "minimumHealthyPercent": 100
+ *       clusterArn: "arn:aws:ecs:us-east-1:012345678910:cluster/default",
+ *       createdAt: "2016-08-29T16:25:52.130Z",
+ *       deploymentConfiguration: {
+ *         maximumPercent: 200,
+ *         minimumHealthyPercent: 100
  *       },
- *       "deployments": [
+ *       deployments: [
  *         {
- *           "createdAt": "2016-08-29T16:25:52.130Z",
- *           "desiredCount": 1,
- *           "id": "ecs-svc/9223370564341623665",
- *           "pendingCount": 0,
- *           "runningCount": 0,
- *           "status": "PRIMARY",
- *           "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6",
- *           "updatedAt": "2016-08-29T16:25:52.130Z"
+ *           createdAt: "2016-08-29T16:25:52.130Z",
+ *           desiredCount: 1,
+ *           id: "ecs-svc/9223370564341623665",
+ *           pendingCount: 0,
+ *           runningCount: 0,
+ *           status: "PRIMARY",
+ *           taskDefinition: "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6",
+ *           updatedAt: "2016-08-29T16:25:52.130Z"
  *         }
  *       ],
- *       "desiredCount": 1,
- *       "events": [
+ *       desiredCount: 1,
+ *       events: [
  *         {
- *           "createdAt": "2016-08-29T16:25:58.520Z",
- *           "id": "38c285e5-d335-4b68-8b15-e46dedc8e88d",
- *           "message": "(service ecs-simple-service) was unable to place a task because no container instance met all of its requirements. The closest matching (container-instance 3f4de1c5-ffdd-4954-af7e-75b4be0c8841) is already using a port required by your task. For more information, see the Troubleshooting section of the Amazon ECS Developer Guide."
+ *           createdAt: "2016-08-29T16:25:58.520Z",
+ *           id: "38c285e5-d335-4b68-8b15-e46dedc8e88d",
+ *           message: "(service ecs-simple-service) was unable to place a task because no container instance met all of its requirements. The closest matching (container-instance 3f4de1c5-ffdd-4954-af7e-75b4be0c8841) is already using a port required by your task. For more information, see the Troubleshooting section of the Amazon ECS Developer Guide."
  *         }
  *       ],
- *       "loadBalancers": [],
- *       "pendingCount": 0,
- *       "runningCount": 0,
- *       "serviceArn": "arn:aws:ecs:us-east-1:012345678910:service/default/ecs-simple-service",
- *       "serviceName": "ecs-simple-service",
- *       "status": "ACTIVE",
- *       "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/default/hello_world:6"
+ *       loadBalancers:       [],
+ *       pendingCount: 0,
+ *       runningCount: 0,
+ *       serviceArn: "arn:aws:ecs:us-east-1:012345678910:service/default/ecs-simple-service",
+ *       serviceName: "ecs-simple-service",
+ *       status: "ACTIVE",
+ *       taskDefinition: "arn:aws:ecs:us-east-1:012345678910:task-definition/default/hello_world:6"
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-describe-a-service-1472513256350
  * ```
  *
+ * @public
  */
 export declare class DescribeServicesCommand extends DescribeServicesCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -364,65 +364,65 @@ declare const DescribeTaskDefinitionCommand_base: {
  * @throws {@link ECSServiceException}
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
- * @public
+ *
  * @example To describe a task definition
  * ```javascript
  * // This example provides a description of the specified task definition.
  * const input = {
- *   "taskDefinition": "hello_world:8"
+ *   taskDefinition: "hello_world:8"
  * };
  * const command = new DescribeTaskDefinitionCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "taskDefinition": {
- *     "containerDefinitions": [
+ *   taskDefinition: {
+ *     containerDefinitions: [
  *       {
- *         "name": "wordpress",
- *         "cpu": 10,
- *         "environment": [],
- *         "essential": true,
- *         "image": "wordpress",
- *         "links": [
+ *         cpu: 10,
+ *         environment:         [],
+ *         essential: true,
+ *         image: "wordpress",
+ *         links: [
  *           "mysql"
  *         ],
- *         "memory": 500,
- *         "mountPoints": [],
- *         "portMappings": [
+ *         memory: 500,
+ *         mountPoints:         [],
+ *         name: "wordpress",
+ *         portMappings: [
  *           {
- *             "containerPort": 80,
- *             "hostPort": 80
+ *             containerPort: 80,
+ *             hostPort: 80
  *           }
  *         ],
- *         "volumesFrom": []
+ *         volumesFrom:         []
  *       },
  *       {
- *         "name": "mysql",
- *         "cpu": 10,
- *         "environment": [
+ *         cpu: 10,
+ *         environment: [
  *           {
- *             "name": "MYSQL_ROOT_PASSWORD",
- *             "value": "password"
+ *             name: "MYSQL_ROOT_PASSWORD",
+ *             value: "password"
  *           }
  *         ],
- *         "essential": true,
- *         "image": "mysql",
- *         "memory": 500,
- *         "mountPoints": [],
- *         "portMappings": [],
- *         "volumesFrom": []
+ *         essential: true,
+ *         image: "mysql",
+ *         memory: 500,
+ *         mountPoints:         [],
+ *         name: "mysql",
+ *         portMappings:         [],
+ *         volumesFrom:         []
  *       }
  *     ],
- *     "family": "hello_world",
- *     "revision": 8,
- *     "taskDefinitionArn": "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/hello_world:8",
- *     "volumes": []
+ *     family: "hello_world",
+ *     revision: 8,
+ *     taskDefinitionArn: "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/hello_world:8",
+ *     volumes:     []
  *   }
  * }
  * *\/
- * // example id: 4c21eeb1-f1da-4a08-8c44-297fc8d0ea88
  * ```
  *
+ * @public
  */
 export declare class DescribeTaskDefinitionCommand extends DescribeTaskDefinitionCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -179,60 +179,60 @@ declare const DescribeTaskSetsCommand_base: {
  * @throws {@link ECSServiceException}
  * <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": [
+ *   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 ==
+ * /* response is
  * {
- *   "failures": [],
- *   "taskSets": [
+ *   failures:   [],
+ *   taskSets: [
  *     {
- *       "computedDesiredCount": 0,
- *       "createdAt": 1557207715.195,
- *       "id": "ecs-svc/1234567890123456789",
- *       "launchType": "EC2",
- *       "loadBalancers": [],
- *       "networkConfiguration": {
- *         "awsvpcConfiguration": {
- *           "assignPublicIp": "DISABLED",
- *           "securityGroups": [
+ *       computedDesiredCount: 0,
+ *       createdAt: 1.557207715195E9,
+ *       id: "ecs-svc/1234567890123456789",
+ *       launchType: "EC2",
+ *       loadBalancers:       [],
+ *       networkConfiguration: {
+ *         awsvpcConfiguration: {
+ *           assignPublicIp: "DISABLED",
+ *           securityGroups: [
  *             "sg-1234431"
  *           ],
- *           "subnets": [
+ *           subnets: [
  *             "subnet-12344321"
  *           ]
  *         }
  *       },
- *       "pendingCount": 0,
- *       "runningCount": 0,
- *       "scale": {
- *         "value": 0,
- *         "unit": "PERCENT"
+ *       pendingCount: 0,
+ *       runningCount: 0,
+ *       scale: {
+ *         unit: "PERCENT",
+ *         value: 0
  *       },
- *       "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
+ *       serviceRegistries:       [],
+ *       stabilityStatus: "STEADY_STATE",
+ *       stabilityStatusAt: 1.557207740014E9,
+ *       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: 1.557207740014E9
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-describe-a-task-set--1734035629507
  * ```
  *
+ * @public
  */
 export declare class DescribeTaskSetsCommand extends DescribeTaskSetsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -258,58 +258,58 @@ declare const DescribeTasksCommand_base: {
  * @throws {@link ECSServiceException}
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
- * @public
+ *
  * @example To describe a task
  * ```javascript
  * // This example provides a description of the specified task, using the task UUID as an identifier.
  * const input = {
- *   "tasks": [
+ *   tasks: [
  *     "c5cba4eb-5dad-405e-96db-71ef8eefe6a8"
  *   ]
  * };
  * const command = new DescribeTasksCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "failures": [],
- *   "tasks": [
+ *   failures:   [],
+ *   tasks: [
  *     {
- *       "clusterArn": "arn:aws:ecs:<region>:<aws_account_id>:cluster/default",
- *       "containerInstanceArn": "arn:aws:ecs:<region>:<aws_account_id>:container-instance/default/18f9eda5-27d7-4c19-b133-45adc516e8fb",
- *       "containers": [
+ *       clusterArn: "arn:aws:ecs:<region>:<aws_account_id>:cluster/default",
+ *       containerInstanceArn: "arn:aws:ecs:<region>:<aws_account_id>:container-instance/default/18f9eda5-27d7-4c19-b133-45adc516e8fb",
+ *       containers: [
  *         {
- *           "name": "ecs-demo",
- *           "containerArn": "arn:aws:ecs:<region>:<aws_account_id>:container/7c01765b-c588-45b3-8290-4ba38bd6c5a6",
- *           "lastStatus": "RUNNING",
- *           "networkBindings": [
+ *           containerArn: "arn:aws:ecs:<region>:<aws_account_id>:container/7c01765b-c588-45b3-8290-4ba38bd6c5a6",
+ *           lastStatus: "RUNNING",
+ *           name: "ecs-demo",
+ *           networkBindings: [
  *             {
- *               "bindIP": "0.0.0.0",
- *               "containerPort": 80,
- *               "hostPort": 80
+ *               bindIP: "0.0.0.0",
+ *               containerPort: 80,
+ *               hostPort: 80
  *             }
  *           ],
- *           "taskArn": "arn:aws:ecs:<region>:<aws_account_id>:task/default/c5cba4eb-5dad-405e-96db-71ef8eefe6a8"
+ *           taskArn: "arn:aws:ecs:<region>:<aws_account_id>:task/default/c5cba4eb-5dad-405e-96db-71ef8eefe6a8"
  *         }
  *       ],
- *       "desiredStatus": "RUNNING",
- *       "lastStatus": "RUNNING",
- *       "overrides": {
- *         "containerOverrides": [
+ *       desiredStatus: "RUNNING",
+ *       lastStatus: "RUNNING",
+ *       overrides: {
+ *         containerOverrides: [
  *           {
- *             "name": "ecs-demo"
+ *             name: "ecs-demo"
  *           }
  *         ]
  *       },
- *       "startedBy": "ecs-svc/9223370608528463088",
- *       "taskArn": "arn:aws:ecs:<region>:<aws_account_id>:task/default/c5cba4eb-5dad-405e-96db-71ef8eefe6a8",
- *       "taskDefinitionArn": "arn:aws:ecs:<region>:<aws_account_id>:task-definition/amazon-ecs-sample:1"
+ *       startedBy: "ecs-svc/9223370608528463088",
+ *       taskArn: "arn:aws:ecs:<region>:<aws_account_id>:task/default/c5cba4eb-5dad-405e-96db-71ef8eefe6a8",
+ *       taskDefinitionArn: "arn:aws:ecs:<region>:<aws_account_id>:task-definition/amazon-ecs-sample:1"
  *     }
  *   ]
  * }
  * *\/
- * // example id: a90b0cde-f965-4946-b55e-cfd8cc54e827
  * ```
  *
+ * @public
  */
 export declare class DescribeTasksCommand extends DescribeTasksCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -78,6 +78,7 @@ declare const DiscoverPollEndpointCommand_base: {
  * @throws {@link ECSServiceException}
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
+ *
  * @public
  */
 export declare class DiscoverPollEndpointCommand extends DiscoverPollEndpointCommand_base {