@aws-sdk/client-ecs 3.774.0 → 3.777.0

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

@@ -438,47 +438,47 @@ declare const RunTaskCommand_base: {
  * @throws {@link ECSServiceException}
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
- * @public
+ *
  * @example To run a task on your default cluster
  * ```javascript
  * // This example runs the specified task definition on your default cluster.
  * const input = {
- *   "cluster": "default",
- *   "taskDefinition": "sleep360:1"
+ *   cluster: "default",
+ *   taskDefinition: "sleep360:1"
  * };
  * const command = new RunTaskCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "tasks": [
+ *   tasks: [
  *     {
- *       "containerInstanceArn": "arn:aws:ecs:us-east-1:<aws_account_id>:container-instance/default/ffe3d344-77e2-476c-a4d0-bf560ad50acb",
- *       "containers": [
+ *       containerInstanceArn: "arn:aws:ecs:us-east-1:<aws_account_id>:container-instance/default/ffe3d344-77e2-476c-a4d0-bf560ad50acb",
+ *       containers: [
  *         {
- *           "name": "sleep",
- *           "containerArn": "arn:aws:ecs:us-east-1:<aws_account_id>:container/default/58591c8e-be29-4ddf-95aa-ee459d4c59fd",
- *           "lastStatus": "PENDING",
- *           "taskArn": "arn:aws:ecs:us-east-1:<aws_account_id>:task/default/a9f21ea7-c9f5-44b1-b8e6-b31f50ed33c0"
+ *           containerArn: "arn:aws:ecs:us-east-1:<aws_account_id>:container/default/58591c8e-be29-4ddf-95aa-ee459d4c59fd",
+ *           lastStatus: "PENDING",
+ *           name: "sleep",
+ *           taskArn: "arn:aws:ecs:us-east-1:<aws_account_id>:task/default/a9f21ea7-c9f5-44b1-b8e6-b31f50ed33c0"
  *         }
  *       ],
- *       "desiredStatus": "RUNNING",
- *       "lastStatus": "PENDING",
- *       "overrides": {
- *         "containerOverrides": [
+ *       desiredStatus: "RUNNING",
+ *       lastStatus: "PENDING",
+ *       overrides: {
+ *         containerOverrides: [
  *           {
- *             "name": "sleep"
+ *             name: "sleep"
  *           }
  *         ]
  *       },
- *       "taskArn": "arn:aws:ecs:us-east-1:<aws_account_id>:task/default/a9f21ea7-c9f5-44b1-b8e6-b31f50ed33c0",
- *       "taskDefinitionArn": "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/sleep360:1"
+ *       taskArn: "arn:aws:ecs:us-east-1:<aws_account_id>:task/default/a9f21ea7-c9f5-44b1-b8e6-b31f50ed33c0",
+ *       taskDefinitionArn: "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/sleep360:1"
  *     }
  *   ]
  * }
  * *\/
- * // example id: 6f238c83-a133-42cd-ab3d-abeca0560445
  * ```
  *
+ * @public
  */
 export declare class RunTaskCommand extends RunTaskCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -362,63 +362,63 @@ declare const StartTaskCommand_base: {
  * @throws {@link ECSServiceException}
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
- * @public
+ *
  * @example To start a new task
  * ```javascript
  * // This example starts a new task in the cluster "MyCluster" on the specified container instance using the latest revision of the "hello-world" task definition.
  * const input = {
- *   "cluster": "MyCluster",
- *   "containerInstances": [
+ *   cluster: "MyCluster",
+ *   containerInstances: [
  *     "4c543eed-f83f-47da-b1d8-3d23f1da4c64"
  *   ],
- *   "taskDefinition": "hello-world"
+ *   taskDefinition: "hello-world"
  * };
  * const command = new StartTaskCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "failures": [],
- *   "tasks": [
+ *   failures:   [],
+ *   tasks: [
  *     {
- *       "version": 1,
- *       "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/default",
- *       "containerInstanceArn": "arn:aws:ecs:us-east-1:012345678910:container-instance/default/4c543eed-f83f-47da-b1d8-3d23f1da4c64",
- *       "containers": [
+ *       clusterArn: "arn:aws:ecs:us-east-1:012345678910:cluster/default",
+ *       containerInstanceArn: "arn:aws:ecs:us-east-1:012345678910:container-instance/default/4c543eed-f83f-47da-b1d8-3d23f1da4c64",
+ *       containers: [
  *         {
- *           "name": "wordpress",
- *           "containerArn": "arn:aws:ecs:us-east-1:012345678910:container/e76594d4-27e1-4c74-98b5-46a6435eb769",
- *           "lastStatus": "PENDING",
- *           "taskArn": "arn:aws:ecs:us-east-1:012345678910:task/default/fdf2c302-468c-4e55-b884-5331d816e7fb"
+ *           containerArn: "arn:aws:ecs:us-east-1:012345678910:container/e76594d4-27e1-4c74-98b5-46a6435eb769",
+ *           lastStatus: "PENDING",
+ *           name: "wordpress",
+ *           taskArn: "arn:aws:ecs:us-east-1:012345678910:task/default/fdf2c302-468c-4e55-b884-5331d816e7fb"
  *         },
  *         {
- *           "name": "mysql",
- *           "containerArn": "arn:aws:ecs:us-east-1:012345678910:container/default/b19106ea-4fa8-4f1d-9767-96922c82b070",
- *           "lastStatus": "PENDING",
- *           "taskArn": "arn:aws:ecs:us-east-1:012345678910:task/default/fdf2c302-468c-4e55-b884-5331d816e7fb"
+ *           containerArn: "arn:aws:ecs:us-east-1:012345678910:container/default/b19106ea-4fa8-4f1d-9767-96922c82b070",
+ *           lastStatus: "PENDING",
+ *           name: "mysql",
+ *           taskArn: "arn:aws:ecs:us-east-1:012345678910:task/default/fdf2c302-468c-4e55-b884-5331d816e7fb"
  *         }
  *       ],
- *       "createdAt": 1479765460.842,
- *       "desiredStatus": "RUNNING",
- *       "lastStatus": "PENDING",
- *       "overrides": {
- *         "containerOverrides": [
+ *       createdAt: 1.479765460842E9,
+ *       desiredStatus: "RUNNING",
+ *       lastStatus: "PENDING",
+ *       overrides: {
+ *         containerOverrides: [
  *           {
- *             "name": "wordpress"
+ *             name: "wordpress"
  *           },
  *           {
- *             "name": "mysql"
+ *             name: "mysql"
  *           }
  *         ]
  *       },
- *       "taskArn": "arn:aws:ecs:us-east-1:012345678910:task/default/fdf2c302-468c-4e55-b884-5331d816e7fb",
- *       "taskDefinitionArn": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6"
+ *       taskArn: "arn:aws:ecs:us-east-1:012345678910:task/default/fdf2c302-468c-4e55-b884-5331d816e7fb",
+ *       taskDefinitionArn: "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6",
+ *       version: 1
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-start-a-new-task-1734455482966
  * ```
  *
+ * @public
  */
 export declare class StartTaskCommand extends StartTaskCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -256,70 +256,70 @@ declare const StopTaskCommand_base: {
  * @throws {@link ECSServiceException}
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
- * @public
+ *
  * @example To stop a task
  * ```javascript
  * // This example stops a task with ID "1dc5c17a-422b-4dc4-b493-371970c6c4d6" in cluster "MyCluster".
  * const input = {
- *   "cluster": "MyCluster",
- *   "reason": "testing stop task.",
- *   "task": "1dc5c17a-422b-4dc4-b493-371970c6c4d6"
+ *   cluster: "MyCluster",
+ *   reason: "testing stop task.",
+ *   task: "1dc5c17a-422b-4dc4-b493-371970c6c4d6"
  * };
  * const command = new StopTaskCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "task": {
- *     "version": 0,
- *     "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/MyCluster",
- *     "containerInstanceArn": "arn:aws:ecs:us-east-1:012345678910:container-instance/MyCluster/5991d8da-1d59-49d2-a31f-4230f9e73140",
- *     "containers": [
+ *   task: {
+ *     clusterArn: "arn:aws:ecs:us-east-1:012345678910:cluster/MyCluster",
+ *     containerInstanceArn: "arn:aws:ecs:us-east-1:012345678910:container-instance/MyCluster/5991d8da-1d59-49d2-a31f-4230f9e73140",
+ *     containers: [
  *       {
- *         "name": "simple-app",
- *         "containerArn": "arn:aws:ecs:us-east-1:012345678910:container/4df26bb4-f057-467b-a079-961675296e64",
- *         "lastStatus": "RUNNING",
- *         "networkBindings": [
+ *         containerArn: "arn:aws:ecs:us-east-1:012345678910:container/4df26bb4-f057-467b-a079-961675296e64",
+ *         lastStatus: "RUNNING",
+ *         name: "simple-app",
+ *         networkBindings: [
  *           {
- *             "bindIP": "0.0.0.0",
- *             "containerPort": 80,
- *             "hostPort": 32774,
- *             "protocol": "tcp"
+ *             bindIP: "0.0.0.0",
+ *             containerPort: 80,
+ *             hostPort: 32774,
+ *             protocol: "tcp"
  *           }
  *         ],
- *         "taskArn": "arn:aws:ecs:us-east-1:012345678910:task/MyCluster/1dc5c17a-422b-4dc4-b493-371970c6c4d6"
+ *         taskArn: "arn:aws:ecs:us-east-1:012345678910:task/MyCluster/1dc5c17a-422b-4dc4-b493-371970c6c4d6"
  *       },
  *       {
- *         "name": "busybox",
- *         "containerArn": "arn:aws:ecs:us-east-1:012345678910:container/e09064f7-7361-4c87-8ab9-8d073bbdbcb9",
- *         "lastStatus": "RUNNING",
- *         "networkBindings": [],
- *         "taskArn": "arn:aws:ecs:us-east-1:012345678910:task/MyCluster/1dc5c17a-422b-4dc4-b493-371970c6c4d6"
+ *         containerArn: "arn:aws:ecs:us-east-1:012345678910:container/e09064f7-7361-4c87-8ab9-8d073bbdbcb9",
+ *         lastStatus: "RUNNING",
+ *         name: "busybox",
+ *         networkBindings:         [],
+ *         taskArn: "arn:aws:ecs:us-east-1:012345678910:task/MyCluster/1dc5c17a-422b-4dc4-b493-371970c6c4d6"
  *       }
  *     ],
- *     "createdAt": 1476822811.295,
- *     "desiredStatus": "STOPPED",
- *     "lastStatus": "RUNNING",
- *     "overrides": {
- *       "containerOverrides": [
+ *     createdAt: 1.476822811295E9,
+ *     desiredStatus: "STOPPED",
+ *     lastStatus: "RUNNING",
+ *     overrides: {
+ *       containerOverrides: [
  *         {
- *           "name": "simple-app"
+ *           name: "simple-app"
  *         },
  *         {
- *           "name": "busybox"
+ *           name: "busybox"
  *         }
  *       ]
  *     },
- *     "startedAt": 1476822833.998,
- *     "startedBy": "ecs-svc/9223370560032507596",
- *     "stoppedReason": "testing stop task.",
- *     "taskArn": "arn:aws:ecs:us-east-1:012345678910:task/1dc5c17a-422b-4dc4-b493-371970c6c4d6",
- *     "taskDefinitionArn": "arn:aws:ecs:us-east-1:012345678910:task-definition/console-sample-app-dynamic-ports:1"
+ *     startedAt: 1.476822833998E9,
+ *     startedBy: "ecs-svc/9223370560032507596",
+ *     stoppedReason: "testing stop task.",
+ *     taskArn: "arn:aws:ecs:us-east-1:012345678910:task/1dc5c17a-422b-4dc4-b493-371970c6c4d6",
+ *     taskDefinitionArn: "arn:aws:ecs:us-east-1:012345678910:task-definition/console-sample-app-dynamic-ports:1",
+ *     version: 0
  *   }
  * }
  * *\/
- * // example id: to-stop-a-task-1734457210346
  * ```
  *
+ * @public
  */
 export declare class StopTaskCommand extends StopTaskCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

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

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

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

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

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

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

@@ -90,24 +90,27 @@ declare const TagResourceCommand_base: {
  * @throws {@link ECSServiceException}
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
- * @public
+ *
  * @example To tag a cluster.
  * ```javascript
  * // This example tags the 'dev' cluster with key 'team' and value 'dev'.
  * const input = {
- *   "resourceArn": "arn:aws:ecs:region:aws_account_id:cluster/dev",
- *   "tags": [
+ *   resourceArn: "arn:aws:ecs:region:aws_account_id:cluster/dev",
+ *   tags: [
  *     {
- *       "key": "team",
- *       "value": "dev"
+ *       key: "team",
+ *       value: "dev"
  *     }
  *   ]
  * };
  * const command = new TagResourceCommand(input);
- * await client.send(command);
- * // example id: to-tag-a-cluster-1540581863751
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class TagResourceCommand extends TagResourceCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -84,21 +84,24 @@ declare const UntagResourceCommand_base: {
  * @throws {@link ECSServiceException}
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
- * @public
+ *
  * @example To untag a cluster.
  * ```javascript
  * // This example deletes the 'team' tag from the 'dev' cluster.
  * const input = {
- *   "resourceArn": "arn:aws:ecs:region:aws_account_id:cluster/dev",
- *   "tagKeys": [
+ *   resourceArn: "arn:aws:ecs:region:aws_account_id:cluster/dev",
+ *   tagKeys: [
  *     "team"
  *   ]
  * };
  * const command = new UntagResourceCommand(input);
- * await client.send(command);
- * // example id: to-untag-a-cluster-1540582546056
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class UntagResourceCommand extends UntagResourceCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -112,47 +112,47 @@ declare const UpdateCapacityProviderCommand_base: {
  * @throws {@link ECSServiceException}
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
- * @public
+ *
  * @example To update a capacity provider's parameters
  * ```javascript
  * // This example updates the targetCapacity and instanceWarmupPeriod parameters for the capacity provider MyCapacityProvider to 90 and 150 respectively.
  * const input = {
- *   "name": "MyCapacityProvider",
- *   "autoScalingGroupProvider": {
- *     "managedScaling": {
- *       "instanceWarmupPeriod": 150,
- *       "status": "ENABLED",
- *       "targetCapacity": 90
+ *   autoScalingGroupProvider: {
+ *     managedScaling: {
+ *       instanceWarmupPeriod: 150,
+ *       status: "ENABLED",
+ *       targetCapacity: 90
  *     }
- *   }
+ *   },
+ *   name: "MyCapacityProvider"
  * };
  * const command = new UpdateCapacityProviderCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "capacityProvider": {
- *     "name": "MyCapacityProvider",
- *     "autoScalingGroupProvider": {
- *       "autoScalingGroupArn": "arn:aws:autoscaling:us-east-1:132456789012:autoScalingGroup:57ffcb94-11f0-4d6d-bf60-3bac5EXAMPLE:autoScalingGroupName/MyASG",
- *       "managedScaling": {
- *         "instanceWarmupPeriod": 150,
- *         "maximumScalingStepSize": 10000,
- *         "minimumScalingStepSize": 1,
- *         "status": "ENABLED",
- *         "targetCapacity": 90
+ *   capacityProvider: {
+ *     autoScalingGroupProvider: {
+ *       autoScalingGroupArn: "arn:aws:autoscaling:us-east-1:132456789012:autoScalingGroup:57ffcb94-11f0-4d6d-bf60-3bac5EXAMPLE:autoScalingGroupName/MyASG",
+ *       managedScaling: {
+ *         instanceWarmupPeriod: 150,
+ *         maximumScalingStepSize: 10000,
+ *         minimumScalingStepSize: 1,
+ *         status: "ENABLED",
+ *         targetCapacity: 90
  *       },
- *       "managedTerminationProtection": "ENABLED"
+ *       managedTerminationProtection: "ENABLED"
  *     },
- *     "capacityProviderArn": "arn:aws:ecs:us-east-1:123456789012:capacity-provider/MyCapacityProvider",
- *     "status": "ACTIVE",
- *     "tags": [],
- *     "updateStatus": "UPDATE_COMPLETE"
+ *     capacityProviderArn: "arn:aws:ecs:us-east-1:123456789012:capacity-provider/MyCapacityProvider",
+ *     name: "MyCapacityProvider",
+ *     status: "ACTIVE",
+ *     tags:     [],
+ *     updateStatus: "UPDATE_COMPLETE"
  *   }
  * }
  * *\/
- * // example id: to-update-a-capacity-providers-parameters-1734557290198
  * ```
  *
+ * @public
  */
 export declare class UpdateCapacityProviderCommand extends UpdateCapacityProviderCommand_base {
     /** @internal type navigation helper, not in runtime. */