Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster. You can host your cluster on a serverless infrastructure that is managed by Amazon ECS by launching your services or tasks using the Fargate launch type. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage by using the EC2 launch type. For more information about launch types, see Amazon ECS Launch Types.
Amazon ECS lets you launch and stop container-based applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.
You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon ECS eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.
License: Apache 2.0 License
Resources
Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below desiredCount, Amazon ECS spawns another copy of the task in the specified cluster. To update an existing service, see UpdateService.
In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind a load balancer. The load balancer distributes traffic across the tasks that are associated with the service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment is triggered by changing properties, such as the task definition or the desired count of a service, with an UpdateService operation.
If a service is using the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.
If a service is using the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.
If a service is using the CODE_DEPLOY deployment controller and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are only used to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values are not used, although they are currently visible when describing your service.
Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%.
When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic:
-
Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).
-
By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy) with the
placementStrategyparameter):-
Sort the valid container instances, giving priority to instances that have the fewest number of running tasks for this service in their respective Availability Zone. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.
-
Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
-
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
CreateServiceRequest
|
object |
Properties
propagateTags
|
PropagateTags |
Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource API action. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
enableECSManagedTags
|
Boolean |
Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
tags
|
Tags |
The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
deploymentController
|
DeploymentController |
The deployment controller to use for the service. |
||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
schedulingStrategy
|
SchedulingStrategy |
The scheduling strategy to use for the service. For more information, see Services. There are two service scheduler strategies available:
|
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
healthCheckGracePeriodSeconds
|
BoxedInteger |
The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 7,200 seconds. During that time, the ECS service scheduler ignores health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
networkConfiguration
|
NetworkConfiguration |
The network configuration for the service. This parameter is required for task definitions that use the |
||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
placementStrategy
|
PlacementStrategies |
The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
placementConstraints
|
PlacementConstraints |
An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime). |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
deploymentConfiguration
|
DeploymentConfiguration |
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks. |
||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
role
|
String |
The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the If your specified role has a path other than |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
platformVersion
|
String |
The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
launchType
|
LaunchType |
The launch type on which to run your service. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
clientToken
|
String |
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
desiredCount
|
BoxedInteger |
The number of instantiations of the specified task definition to place and keep running on your cluster. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
serviceRegistries
|
ServiceRegistries |
The details of the service discovery registries to assign to this service. For more information, see Service Discovery. Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
loadBalancers
|
LoadBalancers |
A load balancer object representing the load balancer to use with your service. If the service is using the If the service is using the After you create a service using the For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here. For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here. Services with tasks that use the |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
taskDefinition
|
String |
The |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
serviceName
|
String |
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
cluster
|
String |
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
Examples
{
"desiredCount": 10,
"loadBalancers": [
{
"containerName": "simple-app",
"containerPort": 80,
"loadBalancerName": "EC2Contai-EcsElast-15DCDAURT3ZO2"
}
],
"role": "ecsServiceRole",
"serviceName": "ecs-simple-service-elb",
"taskDefinition": "console-sample-app-static"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
CreateServiceResponse
|
object |
Properties
service
|
Service |
The full description of your service following the create call. If a service is using the If the service is using the |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"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"
}
}Body
| Name | Data Type | Description |
|---|---|---|
ServerException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClientException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClusterNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
UnsupportedFeatureException
|
Body
| Name | Data Type | Description |
|---|---|---|
PlatformUnknownException
|
Body
| Name | Data Type | Description |
|---|---|---|
PlatformTaskDefinitionIncompatibilityException
|
Body
| Name | Data Type | Description |
|---|---|---|
AccessDeniedException
|
Modifies the ARN and resource ID format of a resource for a specified IAM user, IAM role, or the root user for an account. You can specify whether the new ARN and resource ID format are disabled for new resources that are created.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteAccountSettingRequest
|
object |
Properties
principalArn
|
String |
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it modifies the ARN and resource ID format for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings for themselves. If this field is omitted, the setting are changed only for the authenticated user. |
||||
|
||||||
name
|
SettingName |
The resource name for which to disable the new format. If |
||||
|
||||||
Examples
{
"name": "containerInstanceLongArnFormat",
"principalArn": "arn:aws:iam::<aws_account_id>:user\/principalName"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteAccountSettingResponse
|
object |
Properties
setting
|
Setting |
The account setting for the specified principal ARN. |
||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
Examples
{
"setting": {
"name": "containerInstanceLongArnFormat",
"value": "enabled",
"principalArn": "arn:aws:iam::<aws_account_id>:user\/principalName"
}
}Body
| Name | Data Type | Description |
|---|---|---|
ServerException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClientException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterException
|
Deletes one or more custom attributes from an Amazon ECS resource.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteAttributesRequest
|
object |
Properties
attributes
|
Attributes |
The attributes to delete from your resource. You can specify up to 10 attributes per request. For custom attributes, specify the attribute name and target ID, but do not specify the value. If you specify the target ID using the short form, you must also specify the target type. |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
cluster
|
String |
The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete attributes. If you do not specify a cluster, the default cluster is assumed. |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteAttributesResponse
|
object |
Properties
attributes
|
Attributes |
A list of attribute objects that were successfully deleted from your resource. |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ClusterNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
TargetNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterException
|
Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteClusterRequest
|
object |
Properties
cluster
|
String |
The short name or full Amazon Resource Name (ARN) of the cluster to delete. |
||||
|
||||||
Examples
{
"cluster": "my_cluster"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteClusterResponse
|
object |
Properties
cluster
|
Cluster |
The full description of the deleted cluster. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"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"
}
}Body
| Name | Data Type | Description |
|---|---|---|
ServerException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClientException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClusterNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClusterContainsContainerInstancesException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClusterContainsServicesException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClusterContainsTasksException
|
Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService.
When you delete a service, if there are still running tasks that require cleanup, the service status moves from ACTIVE to DRAINING, and the service is no longer visible in the console or in the ListServices API operation. After the tasks have stopped, then the service status moves from DRAINING to INACTIVE. Services in the DRAINING or INACTIVE status can still be viewed with the DescribeServices API operation. However, in the future, INACTIVE services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices calls on those services return a ServiceNotFoundException error.
If you attempt to create a new service with the same name as an existing service in either ACTIVE or DRAINING status, you receive an error.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeleteServiceRequest
|
object |
Properties
force
|
BoxedBoolean |
If |
||||
|
||||||
service
|
String |
The name of the service to delete. |
||||
|
||||||
cluster
|
String |
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed. |
||||
|
||||||
Examples
{
"service": "my-http-service"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeleteServiceResponse
|
object |
Properties
service
|
Service |
The full description of the deleted service. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ServerException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClientException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClusterNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
ServiceNotFoundException
|
Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.
If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration. That prevents any orphaned tasks from consuming resources.
Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.
If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated).
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeregisterContainerInstanceRequest
|
object |
Properties
force
|
BoxedBoolean |
Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group. |
||||
|
||||||
containerInstance
|
String |
The container instance ID or full ARN of the container instance to deregister. The ARN contains the |
||||
|
||||||
cluster
|
String |
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed. |
||||
|
||||||
Examples
{
"cluster": "default",
"containerInstance": "container_instance_UUID",
"force": true
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeregisterContainerInstanceResponse
|
object |
Properties
containerInstance
|
ContainerInstance |
The container instance that was deregistered. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ServerException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClientException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClusterNotFoundException
|
Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE. Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service's desired count.
You cannot use an INACTIVE task definition to run new tasks or create new services, and you cannot update an existing service to reference an INACTIVE task definition. However, there may be up to a 10-minute window following deregistration where these restrictions have not yet taken effect.
At this time, INACTIVE task definitions remain discoverable in your account indefinitely. However, this behavior is subject to change in the future, so you should not rely on INACTIVE task definitions persisting beyond the lifecycle of any associated tasks and services.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DeregisterTaskDefinitionRequest
|
object |
Properties
taskDefinition
|
String |
The |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
DeregisterTaskDefinitionResponse
|
object |
Properties
taskDefinition
|
TaskDefinition |
The full description of the deregistered task. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ServerException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClientException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterException
|
Describes one or more of your clusters.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeClustersRequest
|
object |
Properties
include
|
ClusterFieldList |
Additional information about your clusters to be separated by launch type, including:
|
|||||||||||
|
|||||||||||||
clusters
|
StringList |
A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed. |
|||||||||||
|
|||||||||||||
Examples
{
"clusters": [
"default"
]
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeClustersResponse
|
object |
Properties
failures
|
Failures |
Any failures associated with the call. |
||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
clusters
|
Clusters |
The list of clusters. |
||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||
Examples
{
"clusters": [
{
"clusterArn": "arn:aws:ecs:us-east-1:aws_account_id:cluster\/default",
"clusterName": "default",
"status": "ACTIVE"
}
],
"failures": []
}Body
| Name | Data Type | Description |
|---|---|---|
ServerException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClientException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterException
|
Describes Amazon Elastic Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeContainerInstancesRequest
|
object |
Properties
include
|
ContainerInstanceFieldList |
Specifies whether you want to see the resource tags for the container instance. If |
|||||||||||
|
|||||||||||||
containerInstances
|
StringList |
A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries. |
|||||||||||
|
|||||||||||||
cluster
|
String |
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed. |
|||||||||||
|
|||||||||||||
Examples
{
"cluster": "default",
"containerInstances": [
"f2756532-8f13-4d53-87c9-aed50dc94cd7"
]
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeContainerInstancesResponse
|
object |
Properties
failures
|
Failures |
Any failures associated with the call. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
containerInstances
|
ContainerInstances |
The list of container instances. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"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": []
}Body
| Name | Data Type | Description |
|---|---|---|
ServerException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClientException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClusterNotFoundException
|
Describes the specified services running in your cluster.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeServicesRequest
|
object |
Properties
include
|
ServiceFieldList |
Specifies whether you want to see the resource tags for the service. If |
|||||||||||
|
|||||||||||||
services
|
StringList |
A list of services to describe. You may specify up to 10 services to describe in a single operation. |
|||||||||||
|
|||||||||||||
cluster
|
String |
The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed. |
|||||||||||
|
|||||||||||||
Examples
{
"services": [
"ecs-simple-service"
]
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeServicesResponse
|
object |
Properties
failures
|
Failures |
Any failures associated with the call. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
services
|
Services |
The list of services described. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"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"
}
]
}Body
| Name | Data Type | Description |
|---|---|---|
ServerException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClientException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClusterNotFoundException
|
Describes a task definition. You can specify a family and revision to find information about a specific task definition, or you can simply specify the family to find the latest ACTIVE revision in that family.
You can only describe INACTIVE task definitions while an active task or service references them.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeTaskDefinitionRequest
|
object |
Properties
include
|
TaskDefinitionFieldList |
Specifies whether to see the resource tags for the task definition. If |
|||||||||||
|
|||||||||||||
taskDefinition
|
String |
The |
|||||||||||
|
|||||||||||||
Examples
{
"taskDefinition": "hello_world:8"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeTaskDefinitionResponse
|
object |
Properties
tags
|
Tags |
The metadata that is applied to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
taskDefinition
|
TaskDefinition |
The full task definition description. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"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": []
}
}Body
| Name | Data Type | Description |
|---|---|---|
ServerException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClientException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterException
|
Describes a specified task or tasks.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DescribeTasksRequest
|
object |
Properties
include
|
TaskFieldList |
Specifies whether you want to see the resource tags for the task. If |
|||||||||||
|
|||||||||||||
tasks
|
StringList |
A list of up to 100 task IDs or full ARN entries. |
|||||||||||
|
|||||||||||||
cluster
|
String |
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to describe. If you do not specify a cluster, the default cluster is assumed. |
|||||||||||
|
|||||||||||||
Examples
{
"tasks": [
"c5cba4eb-5dad-405e-96db-71ef8eefe6a8"
]
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
DescribeTasksResponse
|
object |
Properties
failures
|
Failures |
Any failures associated with the call. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tasks
|
Tasks |
The list of tasks. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"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"
}
]
}Body
| Name | Data Type | Description |
|---|---|---|
ServerException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClientException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClusterNotFoundException
|
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Returns an endpoint for the Amazon ECS agent to poll for updates.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
DiscoverPollEndpointRequest
|
object |
Properties
cluster
|
String |
The short name or full Amazon Resource Name (ARN) of the cluster to which the container instance belongs. |
||||
|
||||||
containerInstance
|
String |
The container instance ID or full ARN of the container instance. The ARN contains the |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ServerException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClientException
|
Lists the account settings for an Amazon ECS resource for a specified principal.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListAccountSettingsRequest
|
object |
Properties
maxResults
|
Integer |
The maximum number of account setting results returned by |
||||
|
||||||
nextToken
|
String |
The This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. |
||||
|
||||||
effectiveSettings
|
Boolean |
Specifies whether to return the effective settings. If |
||||
|
||||||
principalArn
|
String |
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user. |
||||
|
||||||
value
|
String |
The value of the account settings with which to filter results. You must also specify an account setting name to use this parameter. |
||||
|
||||||
name
|
SettingName |
The resource name you want to list the account settings for. |
||||
|
||||||
Examples
{
"effectiveSettings": true,
"principalArn": "arn:aws:iam::<aws_account_id>:user\/principalName"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListAccountSettingsResponse
|
object |
Properties
nextToken
|
String |
The |
||||||||||||||||||||
|
||||||||||||||||||||||
settings
|
Settings |
The account settings for the resource. |
||||||||||||||||||||
|
||||||||||||||||||||||
Examples
{
"settings": [
{
"name": "containerInstanceLongArnFormat",
"value": "disabled",
"principalArn": "arn:aws:iam::<aws_account_id>:user\/principalName"
},
{
"name": "serviceLongArnFormat",
"value": "enabled",
"principalArn": "arn:aws:iam::<aws_account_id>:user\/principalName"
},
{
"name": "taskLongArnFormat",
"value": "disabled",
"principalArn": "arn:aws:iam::<aws_account_id>:user\/principalName"
}
]
}Body
| Name | Data Type | Description |
|---|---|---|
ServerException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClientException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterException
|
Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, ListAttributes returns a list of attribute objects, one for each attribute on each resource. You can filter the list of results to a single attribute name to only return results that have that name. You can also filter the results by attribute name and value, for example, to see which container instances in a cluster are running a Linux AMI (ecs.os-type=linux).
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListAttributesRequest
|
object |
Properties
maxResults
|
BoxedInteger |
The maximum number of cluster results returned by |
||||
|
||||||
nextToken
|
String |
The This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. |
||||
|
||||||
attributeValue
|
String |
The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter. |
||||
|
||||||
attributeName
|
String |
The name of the attribute with which to filter the results. |
||||
|
||||||
targetType
|
TargetType |
The type of the target with which to list attributes. |
||||
|
||||||
cluster
|
String |
The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListAttributesResponse
|
object |
Properties
nextToken
|
String |
The |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
attributes
|
Attributes |
A list of attribute objects that meet the criteria of the request. |
|||||||||||||||||||||||
|
|||||||||||||||||||||||||
Body
| Name | Data Type | Description |
|---|---|---|
ClusterNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterException
|
Returns a list of existing clusters.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string | |
nextToken
|
string |
Pagination token |
maxResults
|
string |
Pagination limit |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListClustersRequest
|
object |
Properties
maxResults
|
BoxedInteger |
The maximum number of cluster results returned by |
||||
|
||||||
nextToken
|
String |
The This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListClustersResponse
|
object |
Properties
nextToken
|
String |
The |
|||||||||||
|
|||||||||||||
clusterArns
|
StringList |
The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account. |
|||||||||||
|
|||||||||||||
Examples
{
"clusterArns": [
"arn:aws:ecs:us-east-1:<aws_account_id>:cluster\/test",
"arn:aws:ecs:us-east-1:<aws_account_id>:cluster\/default"
]
}Body
| Name | Data Type | Description |
|---|---|---|
ServerException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClientException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterException
|
Returns a list of container instances in a specified cluster. You can filter the results of a ListContainerInstances operation with cluster query language statements inside the filter parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string | |
nextToken
|
string |
Pagination token |
maxResults
|
string |
Pagination limit |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListContainerInstancesRequest
|
object |
Properties
status
|
ContainerInstanceStatus |
Filters the container instances by status. For example, if you specify the |
||||
|
||||||
maxResults
|
BoxedInteger |
The maximum number of container instance results returned by |
||||
|
||||||
nextToken
|
String |
The This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. |
||||
|
||||||
filter
|
String |
You can filter the results of a |
||||
|
||||||
cluster
|
String |
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed. |
||||
|
||||||
Examples
{
"cluster": "default"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListContainerInstancesResponse
|
object |
Properties
nextToken
|
String |
The |
|||||||||||
|
|||||||||||||
containerInstanceArns
|
StringList |
The list of container instances with full ARN entries for each container instance associated with the specified cluster. |
|||||||||||
|
|||||||||||||
Examples
{
"containerInstanceArns": [
"arn:aws:ecs:us-east-1:<aws_account_id>:container-instance\/f6bbb147-5370-4ace-8c73-c7181ded911f",
"arn:aws:ecs:us-east-1:<aws_account_id>:container-instance\/ffe3d344-77e2-476c-a4d0-bf560ad50acb"
]
}Body
| Name | Data Type | Description |
|---|---|---|
ServerException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClientException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClusterNotFoundException
|
Lists the services that are running in a specified cluster.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string | |
nextToken
|
string |
Pagination token |
maxResults
|
string |
Pagination limit |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListServicesRequest
|
object |
Properties
schedulingStrategy
|
SchedulingStrategy |
The scheduling strategy for services to list. |
||||
|
||||||
launchType
|
LaunchType |
The launch type for the services to list. |
||||
|
||||||
maxResults
|
BoxedInteger |
The maximum number of service results returned by |
||||
|
||||||
nextToken
|
String |
The This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. |
||||
|
||||||
cluster
|
String |
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the services to list. If you do not specify a cluster, the default cluster is assumed. |
||||
|
||||||
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListServicesResponse
|
object |
Properties
nextToken
|
String |
The |
|||||||||||
|
|||||||||||||
serviceArns
|
StringList |
The list of full ARN entries for each service associated with the specified cluster. |
|||||||||||
|
|||||||||||||
Examples
{
"serviceArns": [
"arn:aws:ecs:us-east-1:012345678910:service\/my-http-service"
]
}Body
| Name | Data Type | Description |
|---|---|---|
ServerException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClientException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClusterNotFoundException
|
List the tags for an Amazon ECS resource.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListTagsForResourceRequest
|
object |
Properties
resourceArn
|
String |
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances. |
||||
|
||||||
Examples
{
"resourceArn": "arn:aws:ecs:region:aws_account_id:cluster\/dev"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListTagsForResourceResponse
|
object |
Properties
tags
|
Tags |
The tags for the resource. |
|||||||||||||||||
|
|||||||||||||||||||
Examples
{
"tags": [
{
"key": "team",
"value": "dev"
}
]
}Body
| Name | Data Type | Description |
|---|---|---|
ServerException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClientException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClusterNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterException
|
Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any ACTIVE task definition revisions).
You can filter out task definition families that do not contain any ACTIVE task definition revisions by setting the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string | |
nextToken
|
string |
Pagination token |
maxResults
|
string |
Pagination limit |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListTaskDefinitionFamiliesRequest
|
object |
Properties
maxResults
|
BoxedInteger |
The maximum number of task definition family results returned by |
||||
|
||||||
nextToken
|
String |
The This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. |
||||
|
||||||
status
|
TaskDefinitionFamilyStatus |
The task definition family status with which to filter the |
||||
|
||||||
familyPrefix
|
String |
The |
||||
|
||||||
Examples
{
"familyPrefix": "hpcc"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListTaskDefinitionFamiliesResponse
|
object |
Properties
nextToken
|
String |
The |
|||||||||||
|
|||||||||||||
families
|
StringList |
The list of task definition family names that match the |
|||||||||||
|
|||||||||||||
Examples
{
"families": [
"hpcc",
"hpcc-c4-8xlarge"
]
}Body
| Name | Data Type | Description |
|---|---|---|
ServerException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClientException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterException
|
Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status with the status parameter.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string | |
nextToken
|
string |
Pagination token |
maxResults
|
string |
Pagination limit |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListTaskDefinitionsRequest
|
object |
Properties
maxResults
|
BoxedInteger |
The maximum number of task definition results returned by |
||||
|
||||||
nextToken
|
String |
The This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. |
||||
|
||||||
sort
|
SortOrder |
The order in which to sort the results. Valid values are |
||||
|
||||||
status
|
TaskDefinitionStatus |
The task definition status with which to filter the |
||||
|
||||||
familyPrefix
|
String |
The full family name with which to filter the |
||||
|
||||||
Examples
{
"familyPrefix": "wordpress"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListTaskDefinitionsResponse
|
object |
Properties
nextToken
|
String |
The |
|||||||||||
|
|||||||||||||
taskDefinitionArns
|
StringList |
The list of task definition Amazon Resource Name (ARN) entries for the |
|||||||||||
|
|||||||||||||
Examples
{
"taskDefinitionArns": [
"arn:aws:ecs:us-east-1:<aws_account_id>:task-definition\/wordpress:3",
"arn:aws:ecs:us-east-1:<aws_account_id>:task-definition\/wordpress:4",
"arn:aws:ecs:us-east-1:<aws_account_id>:task-definition\/wordpress:5",
"arn:aws:ecs:us-east-1:<aws_account_id>:task-definition\/wordpress:6"
]
}Body
| Name | Data Type | Description |
|---|---|---|
ServerException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClientException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterException
|
Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the family, containerInstance, and desiredStatus parameters.
Recently stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string | |
nextToken
|
string |
Pagination token |
maxResults
|
string |
Pagination limit |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
ListTasksRequest
|
object |
Properties
launchType
|
LaunchType |
The launch type for services to list. |
||||
|
||||||
desiredStatus
|
DesiredStatus |
The task desired status with which to filter the Although you can filter results based on a desired status of |
||||
|
||||||
serviceName
|
String |
The name of the service with which to filter the |
||||
|
||||||
startedBy
|
String |
The |
||||
|
||||||
maxResults
|
BoxedInteger |
The maximum number of task results returned by |
||||
|
||||||
nextToken
|
String |
The This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes. |
||||
|
||||||
family
|
String |
The name of the family with which to filter the |
||||
|
||||||
containerInstance
|
String |
The container instance ID or full ARN of the container instance with which to filter the |
||||
|
||||||
cluster
|
String |
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list. If you do not specify a cluster, the default cluster is assumed. |
||||
|
||||||
Examples
{
"cluster": "default",
"containerInstance": "f6bbb147-5370-4ace-8c73-c7181ded911f"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
ListTasksResponse
|
object |
Properties
nextToken
|
String |
The |
|||||||||||
|
|||||||||||||
taskArns
|
StringList |
The list of task ARN entries for the |
|||||||||||
|
|||||||||||||
Examples
{
"taskArns": [
"arn:aws:ecs:us-east-1:012345678910:task\/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84"
]
}Body
| Name | Data Type | Description |
|---|---|---|
ServerException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClientException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClusterNotFoundException
|
Body
| Name | Data Type | Description |
|---|---|---|
ServiceNotFoundException
|
Modifies the ARN and resource ID format of a resource type for all IAM users on an account for which no individual account setting has been set. Enabling this setting is required to use new Amazon ECS features such as resource tagging.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders
|
string | |
X-Amz-Signature
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Date
|
string | |
X-Amz-Content-Sha256
|
string |
Body
| Name | Data Type | Description |
|---|---|---|
PutAccountSettingDefaultRequest
|
object |
Properties
value
|
String |
The account setting value for the specified principal ARN. Accepted values are |
||||
|
||||||
name
|
SettingName |
The resource type to enable the new format for. If |
||||
|
||||||
Examples
{
"name": "serviceLongArnFormat",
"value": "enabled"
}Responses
Body
| Name | Data Type | Description |
|---|---|---|
PutAccountSettingDefaultResponse
|
object |
Properties
setting
|
Setting | |||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||
Examples
{
"setting": {
"name": "serviceLongArnFormat",
"value": "enabled",
"principalArn": "arn:aws:iam::<aws_account_id>:root"
}
}Body
| Name | Data Type | Description |
|---|---|---|
ServerException
|
Body
| Name | Data Type | Description |
|---|---|---|
ClientException
|
Body
| Name | Data Type | Description |
|---|---|---|
InvalidParameterException
|
Modifies the ARN and resource ID format of a resource type for a specified IAM user, IAM role, or the root user for an account. If the account setting for the root user is changed, it sets the default setting for all of the IAM users and roles for which no individual account setting has been set. The opt-in and opt-out account setting can be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource will be defined by the opt-in status of the IAM user or role that created the resource. Enabling this setting is required to use new Amazon ECS features such as resource tagging. For more information, see Amazon Resource Names (ARNs) and IDs in the Amazon Elastic Container Service Developer Guide.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Version
|
string | |
Action
|
string |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-SignedHeaders |