@aws-sdk/client-ecs 3.288.0 → 3.289.0

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

@@ -39,6 +39,30 @@ export interface CreateClusterCommandOutput extends CreateClusterResponse, __Met
  * @see {@link CreateClusterCommandOutput} for command's `response` shape.
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
  *
+ * @example To create a new cluster
+ * ```javascript
+ * // This example creates a cluster in your default region.
+ * const input = {
+ *   "clusterName": "my_cluster"
+ * };
+ * const command = new CreateClusterCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "cluster": {
+ *     "activeServicesCount": 0,
+ *     "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/my_cluster",
+ *     "clusterName": "my_cluster",
+ *     "pendingTasksCount": 0,
+ *     "registeredContainerInstancesCount": 0,
+ *     "runningTasksCount": 0,
+ *     "status": "ACTIVE"
+ *   }
+ * }
+ * *\/
+ * // example id: to-create-a-new-cluster-1472514079365
+ * ```
+ *
  */
 export declare class CreateClusterCommand extends $Command<CreateClusterCommandInput, CreateClusterCommandOutput, ECSClientResolvedConfig> {
     readonly input: CreateClusterCommandInput;

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

@@ -105,6 +105,123 @@ export interface CreateServiceCommandOutput extends CreateServiceResponse, __Met
  * @see {@link CreateServiceCommandOutput} for command's `response` shape.
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
  *
+ * @example To create a new service
+ * ```javascript
+ * // This example creates a service in your default region called ``ecs-simple-service``. The service uses the ``hello_world`` task definition and it maintains 10 copies of that task.
+ * const input = {
+ *   "desiredCount": 10,
+ *   "serviceName": "ecs-simple-service",
+ *   "taskDefinition": "hello_world"
+ * };
+ * const command = new CreateServiceCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "service": {
+ *     "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/default",
+ *     "createdAt": "2016-08-29T16:13:47.298Z",
+ *     "deploymentConfiguration": {
+ *       "maximumPercent": 200,
+ *       "minimumHealthyPercent": 100
+ *     },
+ *     "deployments": [
+ *       {
+ *         "createdAt": "2016-08-29T16:13:47.298Z",
+ *         "desiredCount": 10,
+ *         "id": "ecs-svc/9223370564342348388",
+ *         "pendingCount": 0,
+ *         "runningCount": 0,
+ *         "status": "PRIMARY",
+ *         "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6",
+ *         "updatedAt": "2016-08-29T16:13:47.298Z"
+ *       },
+ *       {
+ *         "createdAt": "2016-08-29T15:52:44.481Z",
+ *         "desiredCount": 0,
+ *         "id": "ecs-svc/9223370564343611322",
+ *         "pendingCount": 0,
+ *         "runningCount": 0,
+ *         "status": "ACTIVE",
+ *         "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6",
+ *         "updatedAt": "2016-08-29T16:11:38.941Z"
+ *       }
+ *     ],
+ *     "desiredCount": 10,
+ *     "events": [],
+ *     "loadBalancers": [],
+ *     "pendingCount": 0,
+ *     "runningCount": 0,
+ *     "serviceArn": "arn:aws:ecs:us-east-1:012345678910:service/ecs-simple-service",
+ *     "serviceName": "ecs-simple-service",
+ *     "status": "ACTIVE",
+ *     "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6"
+ *   }
+ * }
+ * *\/
+ * // example id: to-create-a-new-service-1472512584282
+ * ```
+ *
+ * @example To create a new service behind a load balancer
+ * ```javascript
+ * // This example creates a service in your default region called ``ecs-simple-service-elb``. The service uses the ``ecs-demo`` task definition and it maintains 10 copies of that task. You must reference an existing load balancer in the same region by its name.
+ * const input = {
+ *   "desiredCount": 10,
+ *   "loadBalancers": [
+ *     {
+ *       "containerName": "simple-app",
+ *       "containerPort": 80,
+ *       "loadBalancerName": "EC2Contai-EcsElast-15DCDAURT3ZO2"
+ *     }
+ *   ],
+ *   "role": "ecsServiceRole",
+ *   "serviceName": "ecs-simple-service-elb",
+ *   "taskDefinition": "console-sample-app-static"
+ * };
+ * const command = new CreateServiceCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "service": {
+ *     "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/default",
+ *     "createdAt": "2016-08-29T16:02:54.884Z",
+ *     "deploymentConfiguration": {
+ *       "maximumPercent": 200,
+ *       "minimumHealthyPercent": 100
+ *     },
+ *     "deployments": [
+ *       {
+ *         "createdAt": "2016-08-29T16:02:54.884Z",
+ *         "desiredCount": 10,
+ *         "id": "ecs-svc/9223370564343000923",
+ *         "pendingCount": 0,
+ *         "runningCount": 0,
+ *         "status": "PRIMARY",
+ *         "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/console-sample-app-static:6",
+ *         "updatedAt": "2016-08-29T16:02:54.884Z"
+ *       }
+ *     ],
+ *     "desiredCount": 10,
+ *     "events": [],
+ *     "loadBalancers": [
+ *       {
+ *         "containerName": "simple-app",
+ *         "containerPort": 80,
+ *         "loadBalancerName": "EC2Contai-EcsElast-15DCDAURT3ZO2"
+ *       }
+ *     ],
+ *     "pendingCount": 0,
+ *     "roleArn": "arn:aws:iam::012345678910:role/ecsServiceRole",
+ *     "runningCount": 0,
+ *     "serviceArn": "arn:aws:ecs:us-east-1:012345678910:service/ecs-simple-service-elb",
+ *     "serviceName": "ecs-simple-service-elb",
+ *     "status": "ACTIVE",
+ *     "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/console-sample-app-static:6"
+ *   }
+ * }
+ * *\/
+ * // example id: to-create-a-new-service-behind-a-load-balancer-1472512484823
+ * ```
+ *
  */
 export declare class CreateServiceCommand extends $Command<CreateServiceCommandInput, CreateServiceCommandOutput, ECSClientResolvedConfig> {
     readonly input: CreateServiceCommandInput;

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

@@ -30,6 +30,47 @@ export interface DeleteAccountSettingCommandOutput extends DeleteAccountSettingR
  * @see {@link DeleteAccountSettingCommandOutput} for command's `response` shape.
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
  *
+ * @example To delete your account setting
+ * ```javascript
+ * // This example deletes the account setting for your user for the specified resource type.
+ * const input = {
+ *   "name": "serviceLongArnFormat"
+ * };
+ * const command = new DeleteAccountSettingCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "setting": {
+ *     "name": "serviceLongArnFormat",
+ *     "value": "enabled",
+ *     "principalArn": "arn:aws:iam::<aws_account_id>:user/principalName"
+ *   }
+ * }
+ * *\/
+ * // example id: to-delete-the-account-setting-for-your-user-account-1549524548115
+ * ```
+ *
+ * @example To delete the account settings for a specific IAM user or IAM role
+ * ```javascript
+ * // This example deletes the account setting for a specific IAM user or IAM role for the specified resource type. Only the root user can view or modify the account settings for another user.
+ * const input = {
+ *   "name": "containerInstanceLongArnFormat",
+ *   "principalArn": "arn:aws:iam::<aws_account_id>:user/principalName"
+ * };
+ * const command = new DeleteAccountSettingCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "setting": {
+ *     "name": "containerInstanceLongArnFormat",
+ *     "value": "enabled",
+ *     "principalArn": "arn:aws:iam::<aws_account_id>:user/principalName"
+ *   }
+ * }
+ * *\/
+ * // example id: to-delete-the-account-setting-for-a-specific-iam-user-or-iam-role-1549524612917
+ * ```
+ *
  */
 export declare class DeleteAccountSettingCommand extends $Command<DeleteAccountSettingCommandInput, DeleteAccountSettingCommandOutput, ECSClientResolvedConfig> {
     readonly input: DeleteAccountSettingCommandInput;

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

@@ -34,6 +34,30 @@ export interface DeleteClusterCommandOutput extends DeleteClusterResponse, __Met
  * @see {@link DeleteClusterCommandOutput} for command's `response` shape.
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
  *
+ * @example To delete an empty cluster
+ * ```javascript
+ * // This example deletes an empty cluster in your default region.
+ * const input = {
+ *   "cluster": "my_cluster"
+ * };
+ * const command = new DeleteClusterCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "cluster": {
+ *     "activeServicesCount": 0,
+ *     "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/my_cluster",
+ *     "clusterName": "my_cluster",
+ *     "pendingTasksCount": 0,
+ *     "registeredContainerInstancesCount": 0,
+ *     "runningTasksCount": 0,
+ *     "status": "INACTIVE"
+ *   }
+ * }
+ * *\/
+ * // example id: to-delete-an-empty-cluster-1472512705352
+ * ```
+ *
  */
 export declare class DeleteClusterCommand extends $Command<DeleteClusterCommandInput, DeleteClusterCommandOutput, ECSClientResolvedConfig> {
     readonly input: DeleteClusterCommandInput;

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

@@ -49,6 +49,17 @@ export interface DeleteServiceCommandOutput extends DeleteServiceResponse, __Met
  * @see {@link DeleteServiceCommandOutput} for command's `response` shape.
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
  *
+ * @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"
+ * };
+ * const command = new DeleteServiceCommand(input);
+ * await client.send(command);
+ * // example id: e8183e38-f86e-4390-b811-f74f30a6007d
+ * ```
+ *
  */
 export declare class DeleteServiceCommand extends $Command<DeleteServiceCommandInput, DeleteServiceCommandOutput, ECSClientResolvedConfig> {
     readonly input: DeleteServiceCommandInput;

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

@@ -42,6 +42,19 @@ export interface DeregisterContainerInstanceCommandOutput extends DeregisterCont
  * @see {@link DeregisterContainerInstanceCommandOutput} for command's `response` shape.
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
  *
+ * @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
+ * };
+ * const command = new DeregisterContainerInstanceCommand(input);
+ * await client.send(command);
+ * // example id: bf624927-cf64-4f4b-8b7e-c024a4e682f6
+ * ```
+ *
  */
 export declare class DeregisterContainerInstanceCommand extends $Command<DeregisterContainerInstanceCommandInput, DeregisterContainerInstanceCommandOutput, ECSClientResolvedConfig> {
     readonly input: DeregisterContainerInstanceCommandInput;

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

@@ -29,6 +29,31 @@ export interface DescribeClustersCommandOutput extends DescribeClustersResponse,
  * @see {@link DescribeClustersCommandOutput} for command's `response` shape.
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
  *
+ * @example To describe a cluster
+ * ```javascript
+ * // This example provides a description of the specified cluster in your default region.
+ * const input = {
+ *   "clusters": [
+ *     "default"
+ *   ]
+ * };
+ * const command = new DescribeClustersCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "clusters": [
+ *     {
+ *       "clusterArn": "arn:aws:ecs:us-east-1:aws_account_id:cluster/default",
+ *       "clusterName": "default",
+ *       "status": "ACTIVE"
+ *     }
+ *   ],
+ *   "failures": []
+ * }
+ * *\/
+ * // example id: ba88d100-9672-4231-80da-a4bd210bf728
+ * ```
+ *
  */
 export declare class DescribeClustersCommand extends $Command<DescribeClustersCommandInput, DescribeClustersCommandOutput, ECSClientResolvedConfig> {
     readonly input: DescribeClustersCommandInput;

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

@@ -30,6 +30,94 @@ export interface DescribeContainerInstancesCommandOutput extends DescribeContain
  * @see {@link DescribeContainerInstancesCommandOutput} for command's `response` shape.
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
  *
+ * @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": [
+ *     "f2756532-8f13-4d53-87c9-aed50dc94cd7"
+ *   ]
+ * };
+ * const command = new DescribeContainerInstancesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "containerInstances": [
+ *     {
+ *       "agentConnected": true,
+ *       "containerInstanceArn": "arn:aws:ecs:us-east-1:012345678910:container-instance/f2756532-8f13-4d53-87c9-aed50dc94cd7",
+ *       "ec2InstanceId": "i-807f3249",
+ *       "pendingTasksCount": 0,
+ *       "registeredResources": [
+ *         {
+ *           "name": "CPU",
+ *           "type": "INTEGER",
+ *           "doubleValue": 0,
+ *           "integerValue": 2048,
+ *           "longValue": 0
+ *         },
+ *         {
+ *           "name": "MEMORY",
+ *           "type": "INTEGER",
+ *           "doubleValue": 0,
+ *           "integerValue": 3768,
+ *           "longValue": 0
+ *         },
+ *         {
+ *           "name": "PORTS",
+ *           "type": "STRINGSET",
+ *           "doubleValue": 0,
+ *           "integerValue": 0,
+ *           "longValue": 0,
+ *           "stringSetValue": [
+ *             "2376",
+ *             "22",
+ *             "51678",
+ *             "2375"
+ *           ]
+ *         }
+ *       ],
+ *       "remainingResources": [
+ *         {
+ *           "name": "CPU",
+ *           "type": "INTEGER",
+ *           "doubleValue": 0,
+ *           "integerValue": 1948,
+ *           "longValue": 0
+ *         },
+ *         {
+ *           "name": "MEMORY",
+ *           "type": "INTEGER",
+ *           "doubleValue": 0,
+ *           "integerValue": 3668,
+ *           "longValue": 0
+ *         },
+ *         {
+ *           "name": "PORTS",
+ *           "type": "STRINGSET",
+ *           "doubleValue": 0,
+ *           "integerValue": 0,
+ *           "longValue": 0,
+ *           "stringSetValue": [
+ *             "2376",
+ *             "22",
+ *             "80",
+ *             "51678",
+ *             "2375"
+ *           ]
+ *         }
+ *       ],
+ *       "runningTasksCount": 1,
+ *       "status": "ACTIVE"
+ *     }
+ *   ],
+ *   "failures": []
+ * }
+ * *\/
+ * // example id: c8f439de-eb27-4269-8ca7-2c0a7ba75ab0
+ * ```
+ *
  */
 export declare class DescribeContainerInstancesCommand extends $Command<DescribeContainerInstancesCommandInput, DescribeContainerInstancesCommandOutput, ECSClientResolvedConfig> {
     readonly input: DescribeContainerInstancesCommandInput;

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

@@ -29,6 +29,61 @@ export interface DescribeServicesCommandOutput extends DescribeServicesResponse,
  * @see {@link DescribeServicesCommandOutput} for command's `response` shape.
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
  *
+ * @example To describe a service
+ * ```javascript
+ * // This example provides descriptive information about the service named ``ecs-simple-service``.
+ * const input = {
+ *   "services": [
+ *     "ecs-simple-service"
+ *   ]
+ * };
+ * const command = new DescribeServicesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "failures": [],
+ *   "services": [
+ *     {
+ *       "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/default",
+ *       "createdAt": "2016-08-29T16:25:52.130Z",
+ *       "deploymentConfiguration": {
+ *         "maximumPercent": 200,
+ *         "minimumHealthyPercent": 100
+ *       },
+ *       "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"
+ *         }
+ *       ],
+ *       "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."
+ *         }
+ *       ],
+ *       "loadBalancers": [],
+ *       "pendingCount": 0,
+ *       "runningCount": 0,
+ *       "serviceArn": "arn:aws:ecs:us-east-1:012345678910:service/ecs-simple-service",
+ *       "serviceName": "ecs-simple-service",
+ *       "status": "ACTIVE",
+ *       "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-a-service-1472513256350
+ * ```
+ *
  */
 export declare class DescribeServicesCommand extends $Command<DescribeServicesCommandInput, DescribeServicesCommandOutput, ECSClientResolvedConfig> {
     readonly input: DescribeServicesCommandInput;

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

@@ -36,6 +36,64 @@ export interface DescribeTaskDefinitionCommandOutput extends DescribeTaskDefinit
  * @see {@link DescribeTaskDefinitionCommandOutput} for command's `response` shape.
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
  *
+ * @example To describe a task definition
+ * ```javascript
+ * // This example provides a description of the specified task definition.
+ * const input = {
+ *   "taskDefinition": "hello_world:8"
+ * };
+ * const command = new DescribeTaskDefinitionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "taskDefinition": {
+ *     "containerDefinitions": [
+ *       {
+ *         "name": "wordpress",
+ *         "cpu": 10,
+ *         "environment": [],
+ *         "essential": true,
+ *         "image": "wordpress",
+ *         "links": [
+ *           "mysql"
+ *         ],
+ *         "memory": 500,
+ *         "mountPoints": [],
+ *         "portMappings": [
+ *           {
+ *             "containerPort": 80,
+ *             "hostPort": 80
+ *           }
+ *         ],
+ *         "volumesFrom": []
+ *       },
+ *       {
+ *         "name": "mysql",
+ *         "cpu": 10,
+ *         "environment": [
+ *           {
+ *             "name": "MYSQL_ROOT_PASSWORD",
+ *             "value": "password"
+ *           }
+ *         ],
+ *         "essential": true,
+ *         "image": "mysql",
+ *         "memory": 500,
+ *         "mountPoints": [],
+ *         "portMappings": [],
+ *         "volumesFrom": []
+ *       }
+ *     ],
+ *     "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
+ * ```
+ *
  */
 export declare class DescribeTaskDefinitionCommand extends $Command<DescribeTaskDefinitionCommandInput, DescribeTaskDefinitionCommandOutput, ECSClientResolvedConfig> {
     readonly input: DescribeTaskDefinitionCommandInput;

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

@@ -30,6 +30,57 @@ export interface DescribeTasksCommandOutput extends DescribeTasksResponse, __Met
  * @see {@link DescribeTasksCommandOutput} for command's `response` shape.
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
  *
+ * @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": [
+ *     "c5cba4eb-5dad-405e-96db-71ef8eefe6a8"
+ *   ]
+ * };
+ * const command = new DescribeTasksCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "failures": [],
+ *   "tasks": [
+ *     {
+ *       "clusterArn": "arn:aws:ecs:<region>:<aws_account_id>:cluster/default",
+ *       "containerInstanceArn": "arn:aws:ecs:<region>:<aws_account_id>:container-instance/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": [
+ *             {
+ *               "bindIP": "0.0.0.0",
+ *               "containerPort": 80,
+ *               "hostPort": 80
+ *             }
+ *           ],
+ *           "taskArn": "arn:aws:ecs:<region>:<aws_account_id>:task/c5cba4eb-5dad-405e-96db-71ef8eefe6a8"
+ *         }
+ *       ],
+ *       "desiredStatus": "RUNNING",
+ *       "lastStatus": "RUNNING",
+ *       "overrides": {
+ *         "containerOverrides": [
+ *           {
+ *             "name": "ecs-demo"
+ *           }
+ *         ]
+ *       },
+ *       "startedBy": "ecs-svc/9223370608528463088",
+ *       "taskArn": "arn:aws:ecs:<region>:<aws_account_id>:task/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
+ * ```
+ *
  */
 export declare class DescribeTasksCommand extends $Command<DescribeTasksCommandInput, DescribeTasksCommandOutput, ECSClientResolvedConfig> {
     readonly input: DescribeTasksCommandInput;

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

@@ -29,6 +29,32 @@ export interface GetTaskProtectionCommandOutput extends GetTaskProtectionRespons
  * @see {@link GetTaskProtectionCommandOutput} for command's `response` shape.
  * @see {@link ECSClientResolvedConfig | config} for ECSClient's `config` shape.
  *
+ * @example To get the protection status of a task
+ * ```javascript
+ * // In this example, we get the protection status for a single task.
+ * const input = {
+ *   "cluster": "test-task-protection",
+ *   "tasks": [
+ *     "b8b1cf532d0e46ba8d44a40d1de16772"
+ *   ]
+ * };
+ * const command = new GetTaskProtectionCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "failures": [],
+ *   "protectedTasks": [
+ *     {
+ *       "expirationDate": "2022-11-02T06:56:32.553Z",
+ *       "protectionEnabled": true,
+ *       "taskArn": "arn:aws:ecs:us-west-2:012345678910:task/b8b1cf532d0e46ba8d44a40d1de16772"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: get-the-protection-status-for-a-single-task-2022-11-02T06:56:32.553Z
+ * ```
+ *
  */
 export declare class GetTaskProtectionCommand extends $Command<GetTaskProtectionCommandInput, GetTaskProtectionCommandOutput, ECSClientResolvedConfig> {
     readonly input: GetTaskProtectionCommandInput;