@aws-sdk/client-ecs 3.775.0 → 3.778.0

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

@@ -89,36 +89,36 @@ declare const PutAttributesCommand_base: {
  * @throws {@link ECSServiceException}
  * <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": [
+ *   attributes: [
  *     {
- *       "name": "stack",
- *       "value": "production",
- *       "targetId": "arn:aws:ecs:us-west-2:123456789012:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34"
+ *       name: "stack",
+ *       targetId: "arn:aws:ecs:us-west-2:123456789012:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34",
+ *       value: "production"
  *     }
  *   ],
- *   "cluster": "MyCluster"
+ *   cluster: "MyCluster"
  * };
  * const command = new PutAttributesCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "attributes": [
+ *   attributes: [
  *     {
- *       "name": "stack",
- *       "value": "production",
- *       "targetId": "arn:aws:ecs:us-west-2:123456789012:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34"
+ *       name: "stack",
+ *       targetId: "arn:aws:ecs:us-west-2:123456789012:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34",
+ *       value: "production"
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-create-or-update-an-attribute-on-a-resource-1734382423405
  * ```
  *
+ * @public
  */
 export declare class PutAttributesCommand extends PutAttributesCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -183,256 +183,254 @@ declare const PutClusterCapacityProvidersCommand_base: {
  * @throws {@link ECSServiceException}
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
- * @public
+ *
  * @example To add an existing capacity provider to a cluuster
  * ```javascript
  * // This example adds an existing capacity provider "MyCapacityProvider2" to a cluster that already has the capacity provider "MyCapacityProvider1" associated with it. Both "MyCapacityProvider2" and "MyCapacityProvider1" need to be specified.
  * const input = {
- *   "capacityProviders": [
+ *   capacityProviders: [
  *     "MyCapacityProvider1",
  *     "MyCapacityProvider2"
  *   ],
- *   "cluster": "MyCluster",
- *   "defaultCapacityProviderStrategy": [
+ *   cluster: "MyCluster",
+ *   defaultCapacityProviderStrategy: [
  *     {
- *       "capacityProvider": "MyCapacityProvider1",
- *       "weight": 1
+ *       capacityProvider: "MyCapacityProvider1",
+ *       weight: 1
  *     },
  *     {
- *       "capacityProvider": "MyCapacityProvider2",
- *       "weight": 1
+ *       capacityProvider: "MyCapacityProvider2",
+ *       weight: 1
  *     }
  *   ]
  * };
  * const command = new PutClusterCapacityProvidersCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "cluster": {
- *     "activeServicesCount": 0,
- *     "attachments": [
+ *   cluster: {
+ *     activeServicesCount: 0,
+ *     attachments: [
  *       {
- *         "type": "as_policy",
- *         "details": [
+ *         details: [
  *           {
- *             "name": "capacityProviderName",
- *             "value": "MyCapacityProvider1"
+ *             name: "capacityProviderName",
+ *             value: "MyCapacityProvider1"
  *           },
  *           {
- *             "name": "scalingPolicyName",
- *             "value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
+ *             name: "scalingPolicyName",
+ *             value: "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
  *           }
  *         ],
- *         "id": "0fb0c8f4-6edd-4de1-9b09-17e470ee1918",
- *         "status": "ACTIVE"
+ *         id: "0fb0c8f4-6edd-4de1-9b09-17e470ee1918",
+ *         status: "ACTIVE",
+ *         type: "as_policy"
  *       },
  *       {
- *         "type": "as_policy",
- *         "details": [
+ *         details: [
  *           {
- *             "name": "capacityProviderName",
- *             "value": "MyCapacityProvider2"
+ *             name: "capacityProviderName",
+ *             value: "MyCapacityProvider2"
  *           },
  *           {
- *             "name": "scalingPolicyName",
- *             "value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
+ *             name: "scalingPolicyName",
+ *             value: "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
  *           }
  *         ],
- *         "id": "ae592060-2382-4663-9476-b015c685593c",
- *         "status": "ACTIVE"
+ *         id: "ae592060-2382-4663-9476-b015c685593c",
+ *         status: "ACTIVE",
+ *         type: "as_policy"
  *       }
  *     ],
- *     "attachmentsStatus": "UPDATE_IN_PROGRESS",
- *     "capacityProviders": [
+ *     attachmentsStatus: "UPDATE_IN_PROGRESS",
+ *     capacityProviders: [
  *       "MyCapacityProvider1",
  *       "MyCapacityProvider2"
  *     ],
- *     "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
- *     "clusterName": "MyCluster",
- *     "defaultCapacityProviderStrategy": [
+ *     clusterArn: "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
+ *     clusterName: "MyCluster",
+ *     defaultCapacityProviderStrategy: [
  *       {
- *         "base": 0,
- *         "capacityProvider": "MyCapacityProvider1",
- *         "weight": 1
+ *         base: 0,
+ *         capacityProvider: "MyCapacityProvider1",
+ *         weight: 1
  *       },
  *       {
- *         "base": 0,
- *         "capacityProvider": "MyCapacityProvider2",
- *         "weight": 1
+ *         base: 0,
+ *         capacityProvider: "MyCapacityProvider2",
+ *         weight: 1
  *       }
  *     ],
- *     "pendingTasksCount": 0,
- *     "registeredContainerInstancesCount": 0,
- *     "runningTasksCount": 0,
- *     "settings": [
+ *     pendingTasksCount: 0,
+ *     registeredContainerInstancesCount: 0,
+ *     runningTasksCount: 0,
+ *     settings: [
  *       {
- *         "name": "containerInsights",
- *         "value": "enabled"
+ *         name: "containerInsights",
+ *         value: "enabled"
  *       }
  *     ],
- *     "statistics": [],
- *     "status": "ACTIVE",
- *     "tags": []
+ *     statistics:     [],
+ *     status: "ACTIVE",
+ *     tags:     []
  *   }
  * }
  * *\/
- * // example id: to-add-an-existing-capacity-provider-to-a-cluster-1734385195698
  * ```
  *
  * @example To remove a capacity provider from a cluster
  * ```javascript
  * // This example removes a capacity provider "MyCapacityProvider2" from a cluster that has both "MyCapacityProvider2" and "MyCapacityProvider1" associated with it. Only "MyCapacityProvider1" needs to be specified in this scenario.
  * const input = {
- *   "capacityProviders": [
+ *   capacityProviders: [
  *     "MyCapacityProvider1"
  *   ],
- *   "cluster": "MyCluster",
- *   "defaultCapacityProviderStrategy": [
+ *   cluster: "MyCluster",
+ *   defaultCapacityProviderStrategy: [
  *     {
- *       "base": 0,
- *       "capacityProvider": "MyCapacityProvider1",
- *       "weight": 1
+ *       base: 0,
+ *       capacityProvider: "MyCapacityProvider1",
+ *       weight: 1
  *     }
  *   ]
  * };
  * const command = new PutClusterCapacityProvidersCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "cluster": {
- *     "activeServicesCount": 0,
- *     "attachments": [
+ *   cluster: {
+ *     activeServicesCount: 0,
+ *     attachments: [
  *       {
- *         "type": "as_policy",
- *         "details": [
+ *         details: [
  *           {
- *             "name": "capacityProviderName",
- *             "value": "MyCapacityProvider1"
+ *             name: "capacityProviderName",
+ *             value: "MyCapacityProvider1"
  *           },
  *           {
- *             "name": "scalingPolicyName",
- *             "value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
+ *             name: "scalingPolicyName",
+ *             value: "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
  *           }
  *         ],
- *         "id": "0fb0c8f4-6edd-4de1-9b09-17e470ee1918",
- *         "status": "ACTIVE"
+ *         id: "0fb0c8f4-6edd-4de1-9b09-17e470ee1918",
+ *         status: "ACTIVE",
+ *         type: "as_policy"
  *       },
  *       {
- *         "type": "as_policy",
- *         "details": [
+ *         details: [
  *           {
- *             "name": "capacityProviderName",
- *             "value": "MyCapacityProvider2"
+ *             name: "capacityProviderName",
+ *             value: "MyCapacityProvider2"
  *           },
  *           {
- *             "name": "scalingPolicyName",
- *             "value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
+ *             name: "scalingPolicyName",
+ *             value: "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
  *           }
  *         ],
- *         "id": "ae592060-2382-4663-9476-b015c685593c",
- *         "status": "DELETING"
+ *         id: "ae592060-2382-4663-9476-b015c685593c",
+ *         status: "DELETING",
+ *         type: "as_policy"
  *       }
  *     ],
- *     "attachmentsStatus": "UPDATE_IN_PROGRESS",
- *     "capacityProviders": [
+ *     attachmentsStatus: "UPDATE_IN_PROGRESS",
+ *     capacityProviders: [
  *       "MyCapacityProvider1"
  *     ],
- *     "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
- *     "clusterName": "MyCluster",
- *     "defaultCapacityProviderStrategy": [
+ *     clusterArn: "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
+ *     clusterName: "MyCluster",
+ *     defaultCapacityProviderStrategy: [
  *       {
- *         "base": 0,
- *         "capacityProvider": "MyCapacityProvider1",
- *         "weight": 1
+ *         base: 0,
+ *         capacityProvider: "MyCapacityProvider1",
+ *         weight: 1
  *       }
  *     ],
- *     "pendingTasksCount": 0,
- *     "registeredContainerInstancesCount": 0,
- *     "runningTasksCount": 0,
- *     "settings": [
+ *     pendingTasksCount: 0,
+ *     registeredContainerInstancesCount: 0,
+ *     runningTasksCount: 0,
+ *     settings: [
  *       {
- *         "name": "containerInsights",
- *         "value": "enabled"
+ *         name: "containerInsights",
+ *         value: "enabled"
  *       }
  *     ],
- *     "statistics": [],
- *     "status": "ACTIVE",
- *     "tags": []
+ *     statistics:     [],
+ *     status: "ACTIVE",
+ *     tags:     []
  *   }
  * }
  * *\/
- * // example id: to-remove-a-capacity-provider-from-a-cluster-1734386641517
  * ```
  *
  * @example To remove all capacity providers from a cluster
  * ```javascript
  * // This example removes all capacity providers associated with a cluster.
  * const input = {
- *   "capacityProviders": [],
- *   "cluster": "MyCluster",
- *   "defaultCapacityProviderStrategy": []
+ *   capacityProviders:   [],
+ *   cluster: "MyCluster",
+ *   defaultCapacityProviderStrategy:   []
  * };
  * const command = new PutClusterCapacityProvidersCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "cluster": {
- *     "activeServicesCount": 0,
- *     "attachments": [
+ *   cluster: {
+ *     activeServicesCount: 0,
+ *     attachments: [
  *       {
- *         "type": "as_policy",
- *         "details": [
+ *         details: [
  *           {
- *             "name": "capacityProviderName",
- *             "value": "MyCapacityProvider1"
+ *             name: "capacityProviderName",
+ *             value: "MyCapacityProvider1"
  *           },
  *           {
- *             "name": "scalingPolicyName",
- *             "value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
+ *             name: "scalingPolicyName",
+ *             value: "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
  *           }
  *         ],
- *         "id": "0fb0c8f4-6edd-4de1-9b09-17e470ee1918",
- *         "status": "DELETING"
+ *         id: "0fb0c8f4-6edd-4de1-9b09-17e470ee1918",
+ *         status: "DELETING",
+ *         type: "as_policy"
  *       },
  *       {
- *         "type": "as_policy",
- *         "details": [
+ *         details: [
  *           {
- *             "name": "capacityProviderName",
- *             "value": "MyCapacityProvider2"
+ *             name: "capacityProviderName",
+ *             value: "MyCapacityProvider2"
  *           },
  *           {
- *             "name": "scalingPolicyName",
- *             "value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
+ *             name: "scalingPolicyName",
+ *             value: "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
  *           }
  *         ],
- *         "id": "ae592060-2382-4663-9476-b015c685593c",
- *         "status": "DELETING"
+ *         id: "ae592060-2382-4663-9476-b015c685593c",
+ *         status: "DELETING",
+ *         type: "as_policy"
  *       }
  *     ],
- *     "attachmentsStatus": "UPDATE_IN_PROGRESS",
- *     "capacityProviders": [],
- *     "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
- *     "clusterName": "MyCluster",
- *     "defaultCapacityProviderStrategy": [],
- *     "pendingTasksCount": 0,
- *     "registeredContainerInstancesCount": 0,
- *     "runningTasksCount": 0,
- *     "settings": [
+ *     attachmentsStatus: "UPDATE_IN_PROGRESS",
+ *     capacityProviders:     [],
+ *     clusterArn: "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster",
+ *     clusterName: "MyCluster",
+ *     defaultCapacityProviderStrategy:     [],
+ *     pendingTasksCount: 0,
+ *     registeredContainerInstancesCount: 0,
+ *     runningTasksCount: 0,
+ *     settings: [
  *       {
- *         "name": "containerInsights",
- *         "value": "enabled"
+ *         name: "containerInsights",
+ *         value: "enabled"
  *       }
  *     ],
- *     "statistics": [],
- *     "status": "ACTIVE",
- *     "tags": []
+ *     statistics:     [],
+ *     status: "ACTIVE",
+ *     tags:     []
  *   }
  * }
  * *\/
- * // example id: to-remove-all-capacity-providers-from-a-cluster-1734387170874
  * ```
  *
+ * @public
  */
 export declare class PutClusterCapacityProvidersCommand extends PutClusterCapacityProvidersCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

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

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

@@ -627,60 +627,60 @@ declare const RegisterTaskDefinitionCommand_base: {
  * @throws {@link ECSServiceException}
  * <p>Base exception class for all service exceptions from ECS service.</p>
  *
- * @public
+ *
  * @example To register a task definition
  * ```javascript
  * // This example registers a task definition to the specified family.
  * const input = {
- *   "containerDefinitions": [
+ *   containerDefinitions: [
  *     {
- *       "name": "sleep",
- *       "command": [
+ *       command: [
  *         "sleep",
  *         "360"
  *       ],
- *       "cpu": 10,
- *       "essential": true,
- *       "image": "busybox",
- *       "memory": 10
+ *       cpu: 10,
+ *       essential: true,
+ *       image: "busybox",
+ *       memory: 10,
+ *       name: "sleep"
  *     }
  *   ],
- *   "family": "sleep360",
- *   "taskRoleArn": "",
- *   "volumes": []
+ *   family: "sleep360",
+ *   taskRoleArn: "",
+ *   volumes:   []
  * };
  * const command = new RegisterTaskDefinitionCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "taskDefinition": {
- *     "containerDefinitions": [
+ *   taskDefinition: {
+ *     containerDefinitions: [
  *       {
- *         "name": "sleep",
- *         "command": [
+ *         command: [
  *           "sleep",
  *           "360"
  *         ],
- *         "cpu": 10,
- *         "environment": [],
- *         "essential": true,
- *         "image": "busybox",
- *         "memory": 10,
- *         "mountPoints": [],
- *         "portMappings": [],
- *         "volumesFrom": []
+ *         cpu: 10,
+ *         environment:         [],
+ *         essential: true,
+ *         image: "busybox",
+ *         memory: 10,
+ *         mountPoints:         [],
+ *         name: "sleep",
+ *         portMappings:         [],
+ *         volumesFrom:         []
  *       }
  *     ],
- *     "family": "sleep360",
- *     "revision": 1,
- *     "taskDefinitionArn": "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/sleep360:19",
- *     "volumes": []
+ *     family: "sleep360",
+ *     revision: 1,
+ *     taskDefinitionArn: "arn:aws:ecs:us-east-1:<aws_account_id>:task-definition/sleep360:19",
+ *     volumes:     []
  *   }
  * }
  * *\/
- * // example id: to-register-a-task-definition-1470764550877
  * ```
  *
+ * @public
  */
 export declare class RegisterTaskDefinitionCommand extends RegisterTaskDefinitionCommand_base {
     /** @internal type navigation helper, not in runtime. */

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