{ "version": "1.0", "examples": { "CreateCapacityProvider": [ { "input": { "name": "MyCapacityProvider", "autoScalingGroupProvider": { "autoScalingGroupArn": "arn:aws:autoscaling:us-east-1:123456789012:autoScalingGroup:57ffcb94-11f0-4d6d-bf60-3bac5EXAMPLE:autoScalingGroupName/MyASG", "managedScaling": { "status": "ENABLED", "targetCapacity": 100 }, "managedTerminationProtection": "ENABLED" } }, "output": { "capacityProvider": { "name": "MyCapacityProvider", "autoScalingGroupProvider": { "autoScalingGroupArn": "arn:aws:autoscaling:us-east-1:132456789012:autoScalingGroup:57ffcb94-11f0-4d6d-bf60-3bac5EXAMPLE:autoScalingGroupName/MyASG", "managedScaling": { "instanceWarmupPeriod": 300, "maximumScalingStepSize": 10000, "minimumScalingStepSize": 1, "status": "ENABLED", "targetCapacity": 100 }, "managedTerminationProtection": "ENABLED" }, "capacityProviderArn": "arn:aws:ecs:us-east-1:123456789012:capacity-provider/MyCapacityProvider", "status": "ACTIVE", "tags": [] } }, "comments": { "input": {}, "output": {} }, "description": "This example creates a capacity provider that uses the specified Auto Scaling group MyASG and has managed scaling and manager termination protection enabled. ", "id": "to-create-a-capacity-provider--1733861347945", "title": "To create a capacity provider " } ], "CreateCluster": [ { "input": { "clusterName": "my_cluster" }, "output": { "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" } }, "comments": { "input": {}, "output": {} }, "description": "This example creates a cluster in your default region.", "id": "to-create-a-new-cluster-1472514079365", "title": "To create a new cluster" } ], "CreateService": [ { "input": { "desiredCount": 10, "serviceName": "ecs-simple-service", "taskDefinition": "hello_world" }, "output": { "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/default/ecs-simple-service", "serviceName": "ecs-simple-service", "status": "ACTIVE", "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/default/hello_world:6" } }, "comments": { "input": {}, "output": {} }, "description": "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.", "id": "to-create-a-new-service-1472512584282", "title": "To create a new service" }, { "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" }, "output": { "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/default/ecs-simple-service-elb", "serviceName": "ecs-simple-service-elb", "status": "ACTIVE", "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/default/console-sample-app-static:6" } }, "comments": { "input": {}, "output": {} }, "description": "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.", "id": "to-create-a-new-service-behind-a-load-balancer-1472512484823", "title": "To create a new service behind a load balancer" } ], "CreateTaskSet": [ { "input": { "cluster": "MyCluster", "networkConfiguration": { "awsvpcConfiguration": { "securityGroups": [ "sg-12344321" ], "subnets": [ "subnet-12344321" ] } }, "service": "MyService", "taskDefinition": "MyTaskDefinition:2" }, "output": { "taskSet": { "computedDesiredCount": 0, "createdAt": 1557128360.711, "id": "ecs-svc/1234567890123456789", "launchType": "EC2", "loadBalancers": [], "networkConfiguration": { "awsvpcConfiguration": { "assignPublicIp": "DISABLED", "securityGroups": [ "sg-12344321" ], "subnets": [ "subnet-12344321" ] } }, "pendingCount": 0, "runningCount": 0, "scale": { "value": 0, "unit": "PERCENT" }, "serviceRegistries": [], "stabilityStatus": "STABILIZING", "stabilityStatusAt": 1557128360.711, "status": "ACTIVE", "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/MyTaskDefinition:2", "taskSetArn": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789", "updatedAt": 1557128360.711 } }, "comments": { "input": {}, "output": {} }, "description": "This example creates a task set in a service that uses the EXTERNAL deployment controller.", "id": "to-create-a-task-set-1733864092815", "title": "To create a task set" } ], "DeleteAccountSetting": [ { "input": { "name": "serviceLongArnFormat" }, "output": { "setting": { "name": "serviceLongArnFormat", "value": "enabled", "principalArn": "arn:aws:iam:::user/principalName" } }, "comments": { "input": {}, "output": {} }, "description": "This example deletes the account setting for your user for the specified resource type.", "id": "to-delete-the-account-setting-for-your-user-account-1549524548115", "title": "To delete your account setting" }, { "input": { "name": "containerInstanceLongArnFormat", "principalArn": "arn:aws:iam:::user/principalName" }, "output": { "setting": { "name": "containerInstanceLongArnFormat", "value": "enabled", "principalArn": "arn:aws:iam:::user/principalName" } }, "comments": { "input": {}, "output": {} }, "description": "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.", "id": "to-delete-the-account-setting-for-a-specific-iam-user-or-iam-role-1549524612917", "title": "To delete the account settings for a specific IAM user or IAM role" } ], "DeleteAttributes": [ { "input": { "attributes": [ { "name": "stack", "targetId": "aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34" } ] }, "output": { "attributes": [ { "name": "stack", "value": "production", "targetId": "aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34" } ] }, "comments": { "input": {}, "output": {} }, "description": "This example deletes an attribute named stack from a container instance. ", "id": "to-delete-a-custom-attribute-from-an-amazon-ecs-instance-1733867267541", "title": "To delete a custom attribute from an Amazon ECS instance" } ], "DeleteCapacityProvider": [ { "input": { "capacityProvider": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/ExampleCapacityProvider" }, "output": { "capacityProvider": { "name": "ExampleCapacityProvider", "autoScalingGroupProvider": { "autoScalingGroupArn": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:a1b2c3d4-5678-90ab-cdef-EXAMPLE11111:autoScalingGroupName/MyAutoScalingGroup", "managedScaling": { "maximumScalingStepSize": 10000, "minimumScalingStepSize": 1, "status": "ENABLED", "targetCapacity": 100 }, "managedTerminationProtection": "DISABLED" }, "capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/ExampleCapacityProvider", "status": "ACTIVE", "tags": [], "updateStatus": "DELETE_IN_PROGRESS" } }, "comments": { "input": {}, "output": {} }, "description": "This example deletes a specified capacity provider. ", "id": "to-delete-a-specified-capacity-provider-1733868702678", "title": "To delete a specified capacity provider" } ], "DeleteCluster": [ { "input": { "cluster": "my_cluster" }, "output": { "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" } }, "comments": { "input": {}, "output": {} }, "description": "This example deletes an empty cluster in your default region.", "id": "to-delete-an-empty-cluster-1472512705352", "title": "To delete an empty cluster" } ], "DeleteService": [ { "input": { "service": "my-http-service" }, "output": {}, "comments": { "input": {}, "output": {} }, "description": "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.", "id": "e8183e38-f86e-4390-b811-f74f30a6007d", "title": "To delete a service" } ], "DeleteTaskDefinitions": [ { "input": { "taskDefinitions": [ "Example-task-definition:1" ] }, "output": { "failures": [], "taskDefinitions": [ { "containerDefinitions": [ { "name": "wave", "command": [ "apt-get update; apt-get install stress; while true; do stress --cpu $(( RANDOM % 4 )) -t $(( RANDOM % 10 )); done" ], "cpu": 50, "entryPoint": [ "bash", "-c" ], "environment": [], "essential": true, "image": "public.ecr.aws/docker/library/ubuntu:latest", "memory": 100, "mountPoints": [], "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": [] } ] }, "comments": { "input": {}, "output": {} }, "description": "This example deletes a specified deregistered task definition. ", "id": "to-delete-a-task-definition-that-has-been-deregistered-1733940790186", "title": "To delete a task definition that has been deregistered" } ], "DeleteTaskSet": [ { "input": { "cluster": "MyCluster", "force": true, "service": "MyService", "taskSet": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789" }, "output": { "taskSet": { "computedDesiredCount": 0, "createdAt": 1557130260.276, "id": "ecs-svc/1234567890123456789", "launchType": "EC2", "loadBalancers": [], "networkConfiguration": { "awsvpcConfiguration": { "assignPublicIp": "DISABLED", "securityGroups": [ "sg-12345678" ], "subnets": [ "subnet-12345678" ] } }, "pendingCount": 0, "runningCount": 0, "scale": { "value": 0, "unit": "PERCENT" }, "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 } }, "comments": { "input": {}, "output": {} }, "description": "This example deletes a task set and uses the force flag to force deletion if it hasn't scaled to zero.", "id": "to-delete-a-task-set-within-a-service-that-uses-the-external-deployment-controller-type-1733949897807", "title": "To delete a task set within a service that uses the EXTERNAL deployment controller type" } ], "DeregisterContainerInstance": [ { "input": { "cluster": "default", "containerInstance": "container_instance_UUID", "force": true }, "output": {}, "comments": { "input": {}, "output": {} }, "description": "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.", "id": "bf624927-cf64-4f4b-8b7e-c024a4e682f6", "title": "To deregister a container instance from a cluster" } ], "DeregisterTaskDefinition": [ { "input": { "taskDefinition": "fargate-task:1" }, "output": { "taskDefinition": { "containerDefinitions": [ { "name": "nginx", "cpu": 256, "essential": true, "image": "public.ecr.aws/docker/library/nginx:latest", "memory": 128, "portMappings": [ { "containerPort": 80, "hostPort": 80, "protocol": "tcp" } ] } ], "family": "fargate-task", "status": "INACTIVE", "taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/fargate-task:1", "volumes": [] } }, "comments": { "input": {}, "output": {} }, "description": "This example deregisters the first revision of the fargate-task task definition", "id": "to-deregister-a-revision-of-a-task-definition-1733950214421", "title": "To deregister a revision of a task definition" } ], "DescribeCapacityProviders": [ { "input": {}, "output": { "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 }, "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": [] } ] }, "comments": { "input": {}, "output": {} }, "description": "This example retrieves details about all capacity providers. ", "id": "to-describe-all-capacity-providers-1733951199913", "title": "To describe all capacity providers" }, { "input": { "capacityProviders": [ "MyCapacityProvider" ], "include": [ "TAGS" ] }, "output": { "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 }, "managedTerminationProtection": "ENABLED" }, "capacityProviderArn": "arn:aws:ecs:us-west-2:123456789012:capacity-provider/MyCapacityProvider", "status": "ACTIVE", "tags": [ { "key": "environment", "value": "production" } ] } ] }, "comments": { "input": {}, "output": {} }, "description": "This example retrieves details about the capacity provider MyCapacityProvider", "id": "to-describe-a-specific-capacity-provider-1733951378688", "title": "To describe a specific capacity provider" } ], "DescribeClusters": [ { "input": { "clusters": [ "default" ] }, "output": { "clusters": [ { "clusterArn": "arn:aws:ecs:us-east-1:aws_account_id:cluster/default", "clusterName": "default", "status": "ACTIVE" } ], "failures": [] }, "comments": { "input": {}, "output": {} }, "description": "This example provides a description of the specified cluster in your default region.", "id": "ba88d100-9672-4231-80da-a4bd210bf728", "title": "To describe a cluster" } ], "DescribeContainerInstances": [ { "input": { "cluster": "default", "containerInstances": [ "f2756532-8f13-4d53-87c9-aed50dc94cd7" ] }, "output": { "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": [ { "name": "CPU", "type": "INTEGER", "doubleValue": 0.0, "integerValue": 2048, "longValue": 0 }, { "name": "MEMORY", "type": "INTEGER", "doubleValue": 0.0, "integerValue": 3768, "longValue": 0 }, { "name": "PORTS", "type": "STRINGSET", "doubleValue": 0.0, "integerValue": 0, "longValue": 0, "stringSetValue": [ "2376", "22", "51678", "2375" ] } ], "remainingResources": [ { "name": "CPU", "type": "INTEGER", "doubleValue": 0.0, "integerValue": 1948, "longValue": 0 }, { "name": "MEMORY", "type": "INTEGER", "doubleValue": 0.0, "integerValue": 3668, "longValue": 0 }, { "name": "PORTS", "type": "STRINGSET", "doubleValue": 0.0, "integerValue": 0, "longValue": 0, "stringSetValue": [ "2376", "22", "80", "51678", "2375" ] } ], "runningTasksCount": 1, "status": "ACTIVE" } ], "failures": [] }, "comments": { "input": {}, "output": {} }, "description": "This example provides a description of the specified container instance in your default region, using the container instance UUID as an identifier.", "id": "c8f439de-eb27-4269-8ca7-2c0a7ba75ab0", "title": "To describe container instance" } ], "DescribeServiceDeployments": [ { "input": { "serviceDeploymentArns": [ "arn:aws:ecs:us-west-2:123456789012:service-deployment/example/sd-example/NCWGC2ZR-taawPAYrIaU5" ] }, "output": { "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" } ] }, "comments": { "input": {}, "output": {} }, "description": "This example describes a service deployment for the service sd-example in the example cluster. ", "id": "to-describe-a-service-deployment--1733954961143", "title": "To describe a service deployment " } ], "DescribeServiceRevisions": [ { "input": { "serviceRevisionArns": [ "arn:aws:ecs:us-west-2:123456789012:service-revision/testc/sd1/4980306466373577095" ] }, "output": { "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" } ] }, "comments": { "input": {}, "output": {} }, "description": "This example describes a service revision with the specified ARN", "id": "to-describe-a-service-revision--1734033215738", "title": "To describe a service revision " } ], "DescribeServices": [ { "input": { "services": [ "ecs-simple-service" ] }, "output": { "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/default/ecs-simple-service", "serviceName": "ecs-simple-service", "status": "ACTIVE", "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/default/hello_world:6" } ] }, "comments": { "input": {}, "output": { "services[0].events[0].message": "In this example, there is a service event that shows unavailable cluster resources." } }, "description": "This example provides descriptive information about the service named ``ecs-simple-service``.", "id": "to-describe-a-service-1472513256350", "title": "To describe a service" } ], "DescribeTaskDefinition": [ { "input": { "taskDefinition": "hello_world:8" }, "output": { "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::task-definition/hello_world:8", "volumes": [] } }, "comments": { "input": {}, "output": {} }, "description": "This example provides a description of the specified task definition.", "id": "4c21eeb1-f1da-4a08-8c44-297fc8d0ea88", "title": "To describe a task definition" } ], "DescribeTaskSets": [ { "input": { "cluster": "MyCluster", "service": "MyService", "taskSets": [ "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789" ] }, "output": { "failures": [], "taskSets": [ { "computedDesiredCount": 0, "createdAt": 1557207715.195, "id": "ecs-svc/1234567890123456789", "launchType": "EC2", "loadBalancers": [], "networkConfiguration": { "awsvpcConfiguration": { "assignPublicIp": "DISABLED", "securityGroups": [ "sg-1234431" ], "subnets": [ "subnet-12344321" ] } }, "pendingCount": 0, "runningCount": 0, "scale": { "value": 0, "unit": "PERCENT" }, "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 } ] }, "comments": { "input": {}, "output": {} }, "description": "This example describes a task set in service MyService that uses an EXTERNAL deployment controller. ", "id": "to-describe-a-task-set--1734035629507", "title": "To describe a task set " } ], "DescribeTasks": [ { "input": { "tasks": [ "c5cba4eb-5dad-405e-96db-71ef8eefe6a8" ] }, "output": { "failures": [], "tasks": [ { "clusterArn": "arn:aws:ecs:::cluster/default", "containerInstanceArn": "arn:aws:ecs:::container-instance/default/18f9eda5-27d7-4c19-b133-45adc516e8fb", "containers": [ { "name": "ecs-demo", "containerArn": "arn:aws:ecs:::container/7c01765b-c588-45b3-8290-4ba38bd6c5a6", "lastStatus": "RUNNING", "networkBindings": [ { "bindIP": "0.0.0.0", "containerPort": 80, "hostPort": 80 } ], "taskArn": "arn:aws:ecs:::task/default/c5cba4eb-5dad-405e-96db-71ef8eefe6a8" } ], "desiredStatus": "RUNNING", "lastStatus": "RUNNING", "overrides": { "containerOverrides": [ { "name": "ecs-demo" } ] }, "startedBy": "ecs-svc/9223370608528463088", "taskArn": "arn:aws:ecs:::task/default/c5cba4eb-5dad-405e-96db-71ef8eefe6a8", "taskDefinitionArn": "arn:aws:ecs:::task-definition/amazon-ecs-sample:1" } ] }, "comments": { "input": {}, "output": {} }, "description": "This example provides a description of the specified task, using the task UUID as an identifier.", "id": "a90b0cde-f965-4946-b55e-cfd8cc54e827", "title": "To describe a task" } ], "ExecuteCommand": [ { "input": { "cluster": "MyCluster", "command": "/bin/sh", "container": "MyContainer", "interactive": true, "task": "arn:aws:ecs:us-east-1:123456789012:task/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE" }, "output": { "clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/MyCluster", "containerArn": "arn:aws:ecs:us-east-1:123456789012:container/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE/43ba4b77-37f7-4a41-b923-69d4abEXAMPLE", "containerName": "MyContainer", "interactive": true, "session": { "sessionId": "ecs-execute-command-794nnsxobsg4p2hiur6gxu9a9e", "streamUrl": "wss://ssmmessages.us-east-1.amazonaws.com/v1/data-channel/ecs-execute-command-794nnsxobsg4p2hiur6gxu9a9e?role=publish_subscribe&cell-number=AAEAAfiZG4oybxqsYj3Zhm15s4J0W1k7d9nxVRenNO8Kl5nzAAAAAGdbWGl479/y/4IrTWPadUic3eBrMu3vmB7aPvI+s12lbpDc142y1KZy", "tokenValue": "AAEAAcVb7ww10N9aNUI5Cl7K7DbHjbD2Ed4Mw6uaGYIc+UFNAAAAAGdbWGmMDaPbGfDkzrVIhyKEsc4CPT2hcToPU6yzlddPm7rRZvYQtpaAgsvQdjbCAd9OB6ohtDYfqZI9gzMqLKegXq0E+KbDcGPnQVODFNHmQxnR1BvC6vNcHqh6HAJuKnQD7RSYx/J5bfYNHj4hCYHuN0HNcueSDOOTRB/MBt5DBDY7Djv2uzs9FD0N1kcsGljZkZWLuPTVKHHyrU3zh0awfrFFC3RXvgaUCBnloIIvZeq2CjTesxn9JJS+3N4I0DVxfkHdWWBbBY/5+wH82JVTJpqN3yOAt74u/W7TvYBd7Xu2lQbvtpuAnEszl++bFG2ZoV3dfnmBkSnfD/qV1FJcEskbxUHKgmqe0Paouv4zwrQKNfWYfcv9xkWskqcExh07IeaxZz1tp/WegZ5D76sD6xYeuH+35TMNXMoY7oudLgxIXsA7b39ElM7orGi4Jy3W2tLyuNIvDoI2JI6ww4tYdEjYZnld9rhKwV9rDHk1Z8wjHMs++3BIkHrFQRsv7BFUWlZ9lyqO9GWlXeBe7dQtOeFNahBuJUE9z/xLHJn1x13VkdROKqUVHTJrT4sXAnI5roWiGPoQPVY7aHVYJnwjSxrPRWJBsgyHiVN3dAWTmeVMjp0VbOiJaLlpBI+AUWs8OeVRzuJSZ+1alETpK7Ukag7ma9K4lxq/N7IxYo2ub0cG/bvX42zQqdJAW+9St9sQ1QMaMvkSq1tdbLoOuY0QjN7JrkuKLFQA5bhs+o1YwItzIp7bNrzQ9Z9IN51qoGL5HDXQzi1kNFfYtAryhwt6BgtQU9Z0k+RpE+V5G+V68E0MMUvb313f0nRBYj1u5VKonWb708wADPbUU+s7nvbWuD5oLp1Z6A4iqI9Om0R4RrFASj/7fVY7r3raNXcIYA=" }, "taskArn": "arn:aws:ecs:us-east-1:123456789012:task/MyCluster/d789e94343414c25b9f6bd59eEXAMPLE" }, "comments": { "input": {}, "output": {} }, "description": "This example runs an interactive /bin/sh command on a container MyContainer. ", "id": "to-run-a-command-remotely-on-a-container-in-a-task-1734037663312", "title": "To run a command remotely on a container in a task" } ], "GetTaskProtection": [ { "input": { "cluster": "test-task-protection", "tasks": [ "b8b1cf532d0e46ba8d44a40d1de16772" ] }, "output": { "failures": [], "protectedTasks": [ { "expirationDate": "2022-11-02T06:56:32.553Z", "protectionEnabled": true, "taskArn": "arn:aws:ecs:us-west-2:012345678910:task/default/b8b1cf532d0e46ba8d44a40d1de16772" } ] }, "comments": { "input": {}, "output": {} }, "description": "In this example, we get the protection status for a single task.", "id": "get-the-protection-status-for-a-single-task-2022-11-02T06:56:32.553Z", "title": "To get the protection status of a task" } ], "ListAccountSettings": [ { "input": { "effectiveSettings": true }, "output": { "settings": [ { "name": "containerInstanceLongArnFormat", "value": "disabled", "principalArn": "arn:aws:iam:::user/principalName" }, { "name": "serviceLongArnFormat", "value": "enabled", "principalArn": "arn:aws:iam:::user/principalName" }, { "name": "taskLongArnFormat", "value": "disabled", "principalArn": "arn:aws:iam:::user/principalName" } ] }, "comments": { "input": {}, "output": {} }, "description": "This example displays the effective account settings for your account.", "id": "to-view-your-account-settings-1549524118170", "title": "To view your effective account settings" }, { "input": { "effectiveSettings": true, "principalArn": "arn:aws:iam:::user/principalName" }, "output": { "settings": [ { "name": "containerInstanceLongArnFormat", "value": "disabled", "principalArn": "arn:aws:iam:::user/principalName" }, { "name": "serviceLongArnFormat", "value": "enabled", "principalArn": "arn:aws:iam:::user/principalName" }, { "name": "taskLongArnFormat", "value": "disabled", "principalArn": "arn:aws:iam:::user/principalName" } ] }, "comments": { "input": {}, "output": {} }, "description": "This example displays the effective account settings for the specified user or role.", "id": "to-view-the-account-settings-for-a-specific-iam-user-or-iam-role-1549524237932", "title": "To view the effective account settings for a specific IAM user or IAM role" } ], "ListAttributes": [ { "input": { "attributeName": "stack", "attributeValue": "production", "cluster": "MyCluster", "targetType": "container-instance" }, "output": { "attributes": [ { "name": "stack", "value": "production", "targetId": "arn:aws:ecs:us-west-2:123456789012:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34" } ] }, "comments": { "input": {}, "output": {} }, "description": "This example lists attributes for a container instance with the attribute \"stack\" equal to the value \"production\".", "id": "to-list-container-instances-that-have-a-specific-attribute-1734368946577", "title": "To list container instances that have a specific attribute" } ], "ListClusters": [ { "input": {}, "output": { "clusterArns": [ "arn:aws:ecs:us-east-1::cluster/test", "arn:aws:ecs:us-east-1::cluster/default" ] }, "comments": { "input": {}, "output": {} }, "description": "This example lists all of your available clusters in your default region.", "id": "e337d059-134f-4125-ba8e-4f499139facf", "title": "To list your available clusters" } ], "ListContainerInstances": [ { "input": { "cluster": "default" }, "output": { "containerInstanceArns": [ "arn:aws:ecs:us-east-1::container-instance/default/f6bbb147-5370-4ace-8c73-c7181ded911f", "arn:aws:ecs:us-east-1::container-instance/default/ffe3d344-77e2-476c-a4d0-bf560ad50acb" ] }, "comments": { "input": {}, "output": {} }, "description": "This example lists all of your available container instances in the specified cluster in your default region.", "id": "62a82a94-713c-4e18-8420-1d2b2ba9d484", "title": "To list your available container instances in a cluster" } ], "ListServiceDeployments": [ { "input": { "cluster": "example", "service": "sd-example", "status": [ "SUCCESSFUL" ] }, "output": { "serviceDeployments": [ { "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/example", "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": "SUCCESSFUL", "targetServiceRevisionArn": "arn:aws:ecs:us-west-2:123456789012:service-revision/example/sd-example/4980306466373577095" } ] }, "comments": { "input": {}, "output": {} }, "description": "This example lists all successful service deployments for the service \"sd-example\" in the cluster \"example\".", "id": "to-list-service-deployments-that-meet-the-specified-criteria-1734370445427", "title": "To list service deployments that meet the specified criteria" } ], "ListServices": [ { "input": {}, "output": { "serviceArns": [ "arn:aws:ecs:us-east-1:012345678910:service/default/my-http-service" ] }, "comments": { "input": {}, "output": {} }, "description": "This example lists the services running in the default cluster for an account.", "id": "1d9a8037-4e0e-4234-a528-609656809a3a", "title": "To list the services in a cluster" } ], "ListTagsForResource": [ { "input": { "resourceArn": "arn:aws:ecs:region:aws_account_id:cluster/dev" }, "output": { "tags": [ { "key": "team", "value": "dev" } ] }, "comments": { "input": {}, "output": {} }, "description": "This example lists the tags for the 'dev' cluster.", "id": "to-list-the-tags-for-a-cluster-1540582700259", "title": "To list the tags for a cluster." } ], "ListTaskDefinitionFamilies": [ { "input": {}, "output": { "families": [ "node-js-app", "web-timer", "hpcc", "hpcc-c4-8xlarge" ] }, "comments": { "input": {}, "output": {} }, "description": "This example lists all of your registered task definition families.", "id": "b5c89769-1d94-4ca2-a79e-8069103c7f75", "title": "To list your registered task definition families" }, { "input": { "familyPrefix": "hpcc" }, "output": { "families": [ "hpcc", "hpcc-c4-8xlarge" ] }, "comments": { "input": {}, "output": {} }, "description": "This example lists the task definition revisions that start with \"hpcc\".", "id": "8a4cf9a6-42c1-4fe3-852d-99ac8968e11b", "title": "To filter your registered task definition families" } ], "ListTaskDefinitions": [ { "input": {}, "output": { "taskDefinitionArns": [ "arn:aws:ecs:us-east-1::task-definition/sleep300:2", "arn:aws:ecs:us-east-1::task-definition/sleep360:1", "arn:aws:ecs:us-east-1::task-definition/wordpress:3", "arn:aws:ecs:us-east-1::task-definition/wordpress:4", "arn:aws:ecs:us-east-1::task-definition/wordpress:5", "arn:aws:ecs:us-east-1::task-definition/wordpress:6" ] }, "comments": { "input": {}, "output": {} }, "description": "This example lists all of your registered task definitions.", "id": "b381ebaf-7eba-4d60-b99b-7f6ae49d3d60", "title": "To list your registered task definitions" }, { "input": { "familyPrefix": "wordpress" }, "output": { "taskDefinitionArns": [ "arn:aws:ecs:us-east-1::task-definition/wordpress:3", "arn:aws:ecs:us-east-1::task-definition/wordpress:4", "arn:aws:ecs:us-east-1::task-definition/wordpress:5", "arn:aws:ecs:us-east-1::task-definition/wordpress:6" ] }, "comments": { "input": {}, "output": {} }, "description": "This example lists the task definition revisions of a specified family.", "id": "734e7afd-753a-4bc2-85d0-badddce10910", "title": "To list the registered task definitions in a family" } ], "ListTasks": [ { "input": { "cluster": "default" }, "output": { "taskArns": [ "arn:aws:ecs:us-east-1:012345678910:task/default/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84", "arn:aws:ecs:us-east-1:012345678910:task/default/6b809ef6-c67e-4467-921f-ee261c15a0a1" ] }, "comments": { "input": {}, "output": {} }, "description": "This example lists all of the tasks in a cluster.", "id": "9a6ec707-1a77-45d0-b2eb-516b5dd9e924", "title": "To list the tasks in a cluster" }, { "input": { "cluster": "default", "containerInstance": "f6bbb147-5370-4ace-8c73-c7181ded911f" }, "output": { "taskArns": [ "arn:aws:ecs:us-east-1:012345678910:task/default/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84" ] }, "comments": { "input": {}, "output": {} }, "description": "This example lists the tasks of a specified container instance. Specifying a ``containerInstance`` value limits the results to tasks that belong to that container instance.", "id": "024bf3b7-9cbb-44e3-848f-9d074e1fecce", "title": "To list the tasks on a particular container instance" } ], "PutAccountSetting": [ { "input": { "name": "serviceLongArnFormat", "value": "enabled" }, "output": { "setting": { "name": "serviceLongArnFormat", "value": "enabled", "principalArn": "arn:aws:iam:::user/principalName" } }, "comments": { "input": {}, "output": {} }, "description": "This example modifies your account settings to opt in to the new ARN and resource ID format for Amazon ECS services. If you’re using this command as the root user, then changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves.", "id": "to-modify-the-account-settings-for-your-iam-user-account-1549523130939", "title": "To modify your account settings" }, { "input": { "name": "containerInstanceLongArnFormat", "value": "enabled", "principalArn": "arn:aws:iam:::user/principalName" }, "output": { "setting": { "name": "containerInstanceLongArnFormat", "value": "enabled", "principalArn": "arn:aws:iam:::user/principalName" } }, "comments": { "input": {}, "output": {} }, "description": "This example modifies the account setting for a specific IAM user or IAM role to opt in to the new ARN and resource ID format for Amazon ECS container instances. If you’re using this command as the root user, then changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves.", "id": "to-modify-the-account-settings-for-a-specific-iam-user-or-iam-role-1549523518390", "title": "To modify the account settings for a specific IAM user or IAM role" } ], "PutAccountSettingDefault": [ { "input": { "name": "serviceLongArnFormat", "value": "enabled" }, "output": { "setting": { "name": "serviceLongArnFormat", "value": "enabled", "principalArn": "arn:aws:iam:::root" } }, "comments": { "input": {}, "output": {} }, "description": "This example modifies the default account setting for the specified resource for all IAM users or roles on an account. These changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves.", "id": "to-modify-the-default-account-settings-for-all-iam-users-or-roles-on-your-account-1549523794603", "title": "To modify the default account settings for all IAM users or roles on an account" } ], "PutAttributes": [ { "input": { "attributes": [ { "name": "stack", "value": "production", "targetId": "arn:aws:ecs:us-west-2:123456789012:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34" } ], "cluster": "MyCluster" }, "output": { "attributes": [ { "name": "stack", "value": "production", "targetId": "arn:aws:ecs:us-west-2:123456789012:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34" } ] }, "comments": { "input": {}, "output": {} }, "description": "This example adds an attribute \"stack\" with the value \"production\" to a container instance.", "id": "to-create-or-update-an-attribute-on-a-resource-1734382423405", "title": "To create or update an attribute on a resource" } ], "PutClusterCapacityProviders": [ { "input": { "capacityProviders": [ "MyCapacityProvider1", "MyCapacityProvider2" ], "cluster": "MyCluster", "defaultCapacityProviderStrategy": [ { "capacityProvider": "MyCapacityProvider1", "weight": 1 }, { "capacityProvider": "MyCapacityProvider2", "weight": 1 } ] }, "output": { "cluster": { "activeServicesCount": 0, "attachments": [ { "type": "as_policy", "details": [ { "name": "capacityProviderName", "value": "MyCapacityProvider1" }, { "name": "scalingPolicyName", "value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } ], "id": "0fb0c8f4-6edd-4de1-9b09-17e470ee1918", "status": "ACTIVE" }, { "type": "as_policy", "details": [ { "name": "capacityProviderName", "value": "MyCapacityProvider2" }, { "name": "scalingPolicyName", "value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" } ], "id": "ae592060-2382-4663-9476-b015c685593c", "status": "ACTIVE" } ], "attachmentsStatus": "UPDATE_IN_PROGRESS", "capacityProviders": [ "MyCapacityProvider1", "MyCapacityProvider2" ], "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", "clusterName": "MyCluster", "defaultCapacityProviderStrategy": [ { "base": 0, "capacityProvider": "MyCapacityProvider1", "weight": 1 }, { "base": 0, "capacityProvider": "MyCapacityProvider2", "weight": 1 } ], "pendingTasksCount": 0, "registeredContainerInstancesCount": 0, "runningTasksCount": 0, "settings": [ { "name": "containerInsights", "value": "enabled" } ], "statistics": [], "status": "ACTIVE", "tags": [] } }, "comments": { "input": {}, "output": {} }, "description": "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. ", "id": "to-add-an-existing-capacity-provider-to-a-cluster-1734385195698", "title": "To add an existing capacity provider to a cluuster" }, { "input": { "capacityProviders": [ "MyCapacityProvider1" ], "cluster": "MyCluster", "defaultCapacityProviderStrategy": [ { "base": 0, "capacityProvider": "MyCapacityProvider1", "weight": 1 } ] }, "output": { "cluster": { "activeServicesCount": 0, "attachments": [ { "type": "as_policy", "details": [ { "name": "capacityProviderName", "value": "MyCapacityProvider1" }, { "name": "scalingPolicyName", "value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } ], "id": "0fb0c8f4-6edd-4de1-9b09-17e470ee1918", "status": "ACTIVE" }, { "type": "as_policy", "details": [ { "name": "capacityProviderName", "value": "MyCapacityProvider2" }, { "name": "scalingPolicyName", "value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" } ], "id": "ae592060-2382-4663-9476-b015c685593c", "status": "DELETING" } ], "attachmentsStatus": "UPDATE_IN_PROGRESS", "capacityProviders": [ "MyCapacityProvider1" ], "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", "clusterName": "MyCluster", "defaultCapacityProviderStrategy": [ { "base": 0, "capacityProvider": "MyCapacityProvider1", "weight": 1 } ], "pendingTasksCount": 0, "registeredContainerInstancesCount": 0, "runningTasksCount": 0, "settings": [ { "name": "containerInsights", "value": "enabled" } ], "statistics": [], "status": "ACTIVE", "tags": [] } }, "comments": { "input": {}, "output": {} }, "description": "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. ", "id": "to-remove-a-capacity-provider-from-a-cluster-1734386641517", "title": "To remove a capacity provider from a cluster" }, { "input": { "capacityProviders": [], "cluster": "MyCluster", "defaultCapacityProviderStrategy": [] }, "output": { "cluster": { "activeServicesCount": 0, "attachments": [ { "type": "as_policy", "details": [ { "name": "capacityProviderName", "value": "MyCapacityProvider1" }, { "name": "scalingPolicyName", "value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" } ], "id": "0fb0c8f4-6edd-4de1-9b09-17e470ee1918", "status": "DELETING" }, { "type": "as_policy", "details": [ { "name": "capacityProviderName", "value": "MyCapacityProvider2" }, { "name": "scalingPolicyName", "value": "ECSManagedAutoScalingPolicy-a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" } ], "id": "ae592060-2382-4663-9476-b015c685593c", "status": "DELETING" } ], "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" } ], "statistics": [], "status": "ACTIVE", "tags": [] } }, "comments": { "input": {}, "output": {} }, "description": "This example removes all capacity providers associated with a cluster. ", "id": "to-remove-all-capacity-providers-from-a-cluster-1734387170874", "title": "To remove all capacity providers from a cluster" } ], "RegisterTaskDefinition": [ { "input": { "containerDefinitions": [ { "name": "sleep", "command": [ "sleep", "360" ], "cpu": 10, "essential": true, "image": "public.ecr.aws/docker/library/busybox:latest", "memory": 10 } ], "family": "sleep360", "taskRoleArn": "", "volumes": [] }, "output": { "taskDefinition": { "containerDefinitions": [ { "name": "sleep", "command": [ "sleep", "360" ], "cpu": 10, "environment": [], "essential": true, "image": "public.ecr.aws/docker/library/busybox:latest", "memory": 10, "mountPoints": [], "portMappings": [], "volumesFrom": [] } ], "family": "sleep360", "revision": 1, "taskDefinitionArn": "arn:aws:ecs:us-east-1::task-definition/sleep360:19", "volumes": [] } }, "comments": { "input": {}, "output": {} }, "description": "This example registers a task definition to the specified family.", "id": "to-register-a-task-definition-1470764550877", "title": "To register a task definition" } ], "RunTask": [ { "input": { "cluster": "default", "taskDefinition": "sleep360:1" }, "output": { "tasks": [ { "containerInstanceArn": "arn:aws:ecs:us-east-1::container-instance/default/ffe3d344-77e2-476c-a4d0-bf560ad50acb", "containers": [ { "name": "sleep", "containerArn": "arn:aws:ecs:us-east-1::container/default/58591c8e-be29-4ddf-95aa-ee459d4c59fd", "lastStatus": "PENDING", "taskArn": "arn:aws:ecs:us-east-1::task/default/a9f21ea7-c9f5-44b1-b8e6-b31f50ed33c0" } ], "desiredStatus": "RUNNING", "lastStatus": "PENDING", "overrides": { "containerOverrides": [ { "name": "sleep" } ] }, "taskArn": "arn:aws:ecs:us-east-1::task/default/a9f21ea7-c9f5-44b1-b8e6-b31f50ed33c0", "taskDefinitionArn": "arn:aws:ecs:us-east-1::task-definition/sleep360:1" } ] }, "comments": { "input": {}, "output": {} }, "description": "This example runs the specified task definition on your default cluster.", "id": "6f238c83-a133-42cd-ab3d-abeca0560445", "title": "To run a task on your default cluster" } ], "StartTask": [ { "input": { "cluster": "MyCluster", "containerInstances": [ "4c543eed-f83f-47da-b1d8-3d23f1da4c64" ], "taskDefinition": "hello-world" }, "output": { "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": [ { "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" }, { "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" } ], "createdAt": 1479765460.842, "desiredStatus": "RUNNING", "lastStatus": "PENDING", "overrides": { "containerOverrides": [ { "name": "wordpress" }, { "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" } ] }, "comments": { "input": {}, "output": {} }, "description": "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.", "id": "to-start-a-new-task-1734455482966", "title": "To start a new task" } ], "StopServiceDeployment": [ { "input": { "serviceDeploymentArn": "arn:aws:ecs:us-east-1:123456789012:service-deployment/MyCluster/MyService/r9i43YFjvgF_xlg7m2eJ1r", "stopType": "ROLLBACK" }, "output": { "serviceDeploymentArn": "arn:aws:ecs:us-east-1:123456789012:service-deployment/MyCluster/MyService/r9i43YFjvgF_xlg7m2eJ1r" }, "comments": { "input": {}, "output": {} }, "description": "This example stops the service deployment using the ROLLBACK option.", "id": "to-stop-service-deployment-1734638754369", "title": "To stop a service deployment" } ], "StopTask": [ { "input": { "cluster": "MyCluster", "reason": "testing stop task.", "task": "1dc5c17a-422b-4dc4-b493-371970c6c4d6" }, "output": { "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": [ { "name": "simple-app", "containerArn": "arn:aws:ecs:us-east-1:012345678910:container/4df26bb4-f057-467b-a079-961675296e64", "lastStatus": "RUNNING", "networkBindings": [ { "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" }, { "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" } ], "createdAt": 1476822811.295, "desiredStatus": "STOPPED", "lastStatus": "RUNNING", "overrides": { "containerOverrides": [ { "name": "simple-app" }, { "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" } }, "comments": { "input": {}, "output": {} }, "description": "This example stops a task with ID \"1dc5c17a-422b-4dc4-b493-371970c6c4d6\" in cluster \"MyCluster\".", "id": "to-stop-a-task-1734457210346", "title": "To stop a task" } ], "TagResource": [ { "input": { "resourceArn": "arn:aws:ecs:region:aws_account_id:cluster/dev", "tags": [ { "key": "team", "value": "dev" } ] }, "output": {}, "comments": { "input": {}, "output": {} }, "description": "This example tags the 'dev' cluster with key 'team' and value 'dev'.", "id": "to-tag-a-cluster-1540581863751", "title": "To tag a cluster." } ], "UntagResource": [ { "input": { "resourceArn": "arn:aws:ecs:region:aws_account_id:cluster/dev", "tagKeys": [ "team" ] }, "output": {}, "comments": { "input": {}, "output": {} }, "description": "This example deletes the 'team' tag from the 'dev' cluster.", "id": "to-untag-a-cluster-1540582546056", "title": "To untag a cluster." } ], "UpdateCapacityProvider": [ { "input": { "name": "MyCapacityProvider", "autoScalingGroupProvider": { "managedScaling": { "instanceWarmupPeriod": 150, "status": "ENABLED", "targetCapacity": 90 } } }, "output": { "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 }, "managedTerminationProtection": "ENABLED" }, "capacityProviderArn": "arn:aws:ecs:us-east-1:123456789012:capacity-provider/MyCapacityProvider", "status": "ACTIVE", "tags": [], "updateStatus": "UPDATE_COMPLETE" } }, "comments": { "input": {}, "output": {} }, "description": "This example updates the targetCapacity and instanceWarmupPeriod parameters for the capacity provider MyCapacityProvider to 90 and 150 respectively.", "id": "to-update-a-capacity-providers-parameters-1734557290198", "title": "To update a capacity provider's parameters" } ], "UpdateCluster": [ { "input": { "cluster": "ECS-project-update-cluster", "settings": [ { "name": "containerInsights", "value": "enhanced" } ] }, "output": { "cluster": { "activeServicesCount": 0, "attachments": [ { "type": "as_policy", "details": [ { "name": "capacityProviderName", "value": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt" }, { "name": "scalingPolicyName", "value": "ECSManagedAutoScalingPolicy-152363a6-8c65-484c-b721-42c3e070ae93" } ], "id": "069d002b-7634-42e4-b1d4-544f4c8f6380", "status": "CREATED" }, { "type": "managed_draining", "details": [ { "name": "capacityProviderName", "value": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt" }, { "name": "autoScalingLifecycleHookName", "value": "ecs-managed-draining-termination-hook" } ], "id": "08b5b6ca-45e9-4209-a65d-e962a27c490a", "status": "CREATED" }, { "type": "sc", "details": [], "id": "45d0b36f-8cff-46b6-9380-1288744802ab", "status": "ATTACHED" } ], "attachmentsStatus": "UPDATE_COMPLETE", "capacityProviders": [ "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt" ], "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/ECS-project-update-cluster", "clusterName": "ECS-project-update-cluster", "defaultCapacityProviderStrategy": [ { "base": 0, "capacityProvider": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt", "weight": 1 } ], "pendingTasksCount": 0, "registeredContainerInstancesCount": 0, "runningTasksCount": 0, "serviceConnectDefaults": { "namespace": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-igwrsylmy3kwvcdx" }, "settings": [ { "name": "containerInsights", "value": "enhanced" } ], "statistics": [], "status": "ACTIVE", "tags": [] } }, "comments": { "input": {}, "output": {} }, "description": "This example turns on enhanced containerInsights in an existing cluster. ", "id": "to-update-a-clusters-observability-settings-1734626018966", "title": "To update a cluster's observability settings." }, { "input": { "cluster": "ECS-project-update-cluster", "serviceConnectDefaults": { "namespace": "test" } }, "output": { "cluster": { "activeServicesCount": 0, "attachments": [ { "type": "as_policy", "details": [ { "name": "capacityProviderName", "value": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt" }, { "name": "scalingPolicyName", "value": "ECSManagedAutoScalingPolicy-152363a6-8c65-484c-b721-42c3e070ae93" } ], "id": "069d002b-7634-42e4-b1d4-544f4c8f6380", "status": "CREATED" }, { "type": "managed_draining", "details": [ { "name": "capacityProviderName", "value": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt" }, { "name": "autoScalingLifecycleHookName", "value": "ecs-managed-draining-termination-hook" } ], "id": "08b5b6ca-45e9-4209-a65d-e962a27c490a", "status": "CREATED" }, { "type": "sc", "details": [], "id": "45d0b36f-8cff-46b6-9380-1288744802ab", "status": "DELETED" }, { "type": "sc", "details": [], "id": "3e6890c3-609c-4832-91de-d6ca891b3ef1", "status": "ATTACHED" }, { "type": "sc", "details": [], "id": "961b8ec1-c2f1-4070-8495-e669b7668e90", "status": "DELETED" } ], "attachmentsStatus": "UPDATE_COMPLETE", "capacityProviders": [ "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt" ], "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/ECS-project-update-cluster", "clusterName": "ECS-project-update-cluster", "defaultCapacityProviderStrategy": [ { "base": 0, "capacityProvider": "Infra-ECS-Cluster-ECS-project-update-cluster-d6bb6d5b-EC2CapacityProvider-3fIpdkLywwFt", "weight": 1 } ], "pendingTasksCount": 0, "registeredContainerInstancesCount": 0, "runningTasksCount": 0, "serviceConnectDefaults": { "namespace": "arn:aws:servicediscovery:us-west-2:123456789012:namespace/ns-dtjmxqpfi46ht7dr" }, "settings": [ { "name": "containerInsights", "value": "enhanced" } ], "statistics": [], "status": "ACTIVE", "tags": [] } }, "comments": { "input": {}, "output": {} }, "description": "This example sets a default Service Connect namespace. ", "id": "to-update-a-clusters-service-connect-defaults-1734626891648", "title": "To update a cluster's Service Connect defaults." } ], "UpdateClusterSettings": [ { "input": { "cluster": "default", "settings": [ { "name": "containerInsights", "value": "enabled" } ] }, "output": { "cluster": { "activeServicesCount": 0, "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", "clusterName": "default", "pendingTasksCount": 0, "registeredContainerInstancesCount": 0, "runningTasksCount": 0, "settings": [ { "name": "containerInsights", "value": "enabled" } ], "statistics": [], "status": "ACTIVE", "tags": [] } }, "comments": { "input": {}, "output": {} }, "description": "This example enables CloudWatch Container Insights for the default cluster.", "id": "to-update-a-clusters-settings-1734628004887", "title": "To update a cluster's settings" } ], "UpdateContainerAgent": [ { "input": { "cluster": "MyCluster", "containerInstance": "53ac7152-dcd1-4102-81f5-208962864132" }, "output": { "containerInstance": { "agentConnected": true, "agentUpdateStatus": "PENDING", "versionInfo": { "agentHash": "4023248", "agentVersion": "1.0.0", "dockerVersion": "DockerVersion: 1.5.0" } } }, "comments": { "input": {}, "output": {} }, "description": "This example updates the container agent version on the specified container instance in cluster MyCluster.", "id": "to-update-the-container-agent-version-on-a-container-instance-1734628653210", "title": "To update the container agent version on a container instance" } ], "UpdateContainerInstancesState": [ { "input": { "cluster": "default", "containerInstances": [ "1c3be8ed-df30-47b4-8f1e-6e68ebd01f34" ], "status": "DRAINING" }, "output": { "containerInstances": [ { "version": 30, "agentConnected": true, "attributes": [ { "name": "ecs.availability-zone", "value": "us-west-2b" }, { "name": "com.amazonaws.ecs.capability.logging-driver.syslog" }, { "name": "ecs.instance-type", "value": "c4.xlarge" }, { "name": "ecs.ami-id", "value": "ami-a2ca61c2" }, { "name": "com.amazonaws.ecs.capability.task-iam-role-network-host" }, { "name": "com.amazonaws.ecs.capability.logging-driver.awslogs" }, { "name": "com.amazonaws.ecs.capability.logging-driver.json-file" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.17" }, { "name": "com.amazonaws.ecs.capability.privileged-container" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.18" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.19" }, { "name": "com.amazonaws.ecs.capability.ecr-auth" }, { "name": "ecs.os-type", "value": "linux" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.20" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.21" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.22" }, { "name": "com.amazonaws.ecs.capability.task-iam-role" }, { "name": "com.amazonaws.ecs.capability.docker-remote-api.1.23" } ], "containerInstanceArn": "arn:aws:ecs:us-west-2:012345678910:container-instance/default/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34", "ec2InstanceId": "i-05d99c76955727ec6", "pendingTasksCount": 0, "registeredResources": [ { "name": "CPU", "type": "INTEGER", "doubleValue": 0, "integerValue": 4096, "longValue": 0 }, { "name": "MEMORY", "type": "INTEGER", "doubleValue": 0, "integerValue": 7482, "longValue": 0 }, { "name": "PORTS", "type": "STRINGSET", "doubleValue": 0, "integerValue": 0, "longValue": 0, "stringSetValue": [ "22", "2376", "2375", "51678", "51679" ] }, { "name": "PORTS_UDP", "type": "STRINGSET", "doubleValue": 0, "integerValue": 0, "longValue": 0, "stringSetValue": [] } ], "remainingResources": [ { "name": "CPU", "type": "INTEGER", "doubleValue": 0, "integerValue": 4096, "longValue": 0 }, { "name": "MEMORY", "type": "INTEGER", "doubleValue": 0, "integerValue": 7482, "longValue": 0 }, { "name": "PORTS", "type": "STRINGSET", "doubleValue": 0, "integerValue": 0, "longValue": 0, "stringSetValue": [ "22", "2376", "2375", "51678", "51679" ] }, { "name": "PORTS_UDP", "type": "STRINGSET", "doubleValue": 0, "integerValue": 0, "longValue": 0, "stringSetValue": [] } ], "runningTasksCount": 0, "status": "DRAINING", "versionInfo": { "agentHash": "efe53c6", "agentVersion": "1.13.1", "dockerVersion": "DockerVersion: 1.11.2" } } ], "failures": [] }, "comments": { "input": {}, "output": {} }, "description": "This example updates the state of the specified container instance in the default cluster to DRAINING. ", "id": "to-update-the-state-of-a-container-instance-1734630991280", "title": "To update the state of a container instance" } ], "UpdateService": [ { "input": { "service": "my-http-service", "taskDefinition": "amazon-ecs-sample" }, "output": {}, "comments": { "input": {}, "output": {} }, "description": "This example updates the my-http-service service to use the amazon-ecs-sample task definition.", "id": "cc9e8900-0cc2-44d2-8491-64d1d3d37887", "title": "To change the task definition used in a service" }, { "input": { "desiredCount": 10, "service": "my-http-service" }, "output": {}, "comments": { "input": {}, "output": {} }, "description": "This example updates the desired count of the my-http-service service to 10.", "id": "9581d6c5-02e3-4140-8cc1-5a4301586633", "title": "To change the number of tasks in a service" } ], "UpdateServicePrimaryTaskSet": [ { "input": { "cluster": "MyCluster", "primaryTaskSet": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789", "service": "MyService" }, "output": { "taskSet": { "computedDesiredCount": 1, "createdAt": 1557128360.711, "id": "ecs-svc/1234567890123456789", "launchType": "EC2", "loadBalancers": [], "networkConfiguration": { "awsvpcConfiguration": { "assignPublicIp": "DISABLED", "securityGroups": [ "sg-12344312" ], "subnets": [ "subnet-12344321" ] } }, "pendingCount": 0, "runningCount": 0, "scale": { "value": 50, "unit": "PERCENT" }, "serviceRegistries": [], "stabilityStatus": "STABILIZING", "stabilityStatusAt": 1557129279.914, "status": "PRIMARY", "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": 1557129412.653 } }, "comments": { "input": {}, "output": {} }, "description": "This example updates the primary task set for a service MyService that uses the EXTERNAL deployment controller type. ", "id": "to-update-the-primary-task-set-for-a-service-1734637150370", "title": "To update the primary task set for a service" } ], "UpdateTaskProtection": [ { "input": { "cluster": "test-task-protection", "expiresInMinutes": 60, "protectionEnabled": true, "tasks": [ "b8b1cf532d0e46ba8d44a40d1de16772" ] }, "output": { "failures": [], "protectedTasks": [ { "expirationDate": "2022-11-02T06:56:32.553Z", "protectionEnabled": true, "taskArn": "arn:aws:ecs:us-west-2:012345678910:task/default/b8b1cf532d0e46ba8d44a40d1de16772" } ] }, "comments": { "input": {}, "output": {} }, "description": "This example enables scale-in protection for a task for 60 minutes.", "id": "enable-the-protection-status-for-a-single-task-for-60-minutes-2022-11-02T06:56:32.553Z", "title": "To set task scale-in protection for a task for 60 minutes" }, { "input": { "cluster": "test-task-protection", "protectionEnabled": true, "tasks": [ "b8b1cf532d0e46ba8d44a40d1de16772" ] }, "output": { "failures": [], "protectedTasks": [ { "expirationDate": "2022-11-02T06:56:32.553Z", "protectionEnabled": true, "taskArn": "arn:aws:ecs:us-west-2:012345678910:task/default/b8b1cf532d0e46ba8d44a40d1de16772" } ] }, "comments": { "input": {}, "output": {} }, "description": "This example enables task scale-in protection for a task, without specifying the expiresInMinutes parameter, for the default protection period of 120 minutes.", "id": "enable-the-protection-status-for-a-single-task-with-default-expiresinminutes-2022-11-02T06:56:32.553Z", "title": "To set task scale-in protection for the default time period in minutes" }, { "input": { "cluster": "test-task-protection", "protectionEnabled": false, "tasks": [ "b8b1cf532d0e46ba8d44a40d1de16772" ] }, "output": { "failures": [], "protectedTasks": [ { "protectionEnabled": false, "taskArn": "arn:aws:ecs:us-west-2:012345678910:task/default/b8b1cf532d0e46ba8d44a40d1de16772" } ] }, "comments": { "input": {}, "output": {} }, "description": "This example removes scale-in protection for a task.", "id": "disable-scale-in-protection-on-a-single-task", "title": "To remove task scale-in protection" } ], "UpdateTaskSet": [ { "input": { "cluster": "MyCluster", "scale": { "value": 50, "unit": "PERCENT" }, "service": "MyService", "taskSet": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789" }, "output": { "taskSet": { "computedDesiredCount": 0, "createdAt": 1557128360.711, "id": "ecs-svc/1234567890123456789", "launchType": "EC2", "loadBalancers": [], "networkConfiguration": { "awsvpcConfiguration": { "assignPublicIp": "DISABLED", "securityGroups": [ "sg-12344321" ], "subnets": [ "subnet-12344321" ] } }, "pendingCount": 0, "runningCount": 0, "scale": { "value": 50, "unit": "PERCENT" }, "serviceRegistries": [], "stabilityStatus": "STABILIZING", "stabilityStatusAt": 1557129279.914, "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": 1557129279.914 } }, "comments": { "input": {}, "output": {} }, "description": "This example updates the task set to adjust the scale.", "id": "to-update-a-task-set-1734638754368", "title": "To update a task set" } ] } }