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.
service : AWS.Config.Region -> AWS.Service.Service
Configuration for this service.
createCluster : CreateClusterRequest -> AWS.Http.Request AWS.Http.AWSAppError CreateClusterResponse
Creates a new Amazon ECS cluster. By default, your account receives a default
cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster
action.
When you call the CreateCluster
API operation, Amazon ECS attempts to create the service-linked role for your account so that required resources in other AWS services can be managed on your behalf. However, if the IAM user that makes the call does not have permissions to create the service-linked role, it is not created. For more information, see Using Service-Linked Roles for Amazon ECS
in the Amazon Elastic Container Service Developer Guide.
createService : CreateServiceRequest -> AWS.Http.Request AWS.Http.AWSAppError CreateServiceResponse
Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the 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.
Tasks for services that do not use a load balancer are considered healthy if they're in the RUNNING
state. Tasks for services that do use a load balancer are considered healthy if they're in the RUNNING
state and the container instance that they're hosted on is reported as healthy by the load balancer.
There are two service scheduler strategies available:
REPLICA
- The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service Scheduler Concepts
in the Amazon Elastic Container Service Developer Guide. DAEMON
- The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service Scheduler Concepts
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. The default value for a replica service for minimumHealthyPercent
is 100%. The default value for a daemon service for minimumHealthyPercent
is 0%.
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 might 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're in the RUNNING
state. Tasks for services that do use a load balancer are considered healthy if they're in the RUNNING
state and they're 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 either the CODE_DEPLOY
or EXTERNAL
deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only 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 aren't used, although they're currently visible when describing your service.
When creating a service that uses the EXTERNAL
deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet
operation. For more information, see Amazon ECS Deployment Types
in the Amazon Elastic Container Service Developer Guide.
When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic:
placementStrategy
parameter): 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.createTaskSet : CreateTaskSetRequest -> AWS.Http.Request AWS.Http.AWSAppError CreateTaskSetResponse
Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL
deployment controller type. For more information, see Amazon ECS Deployment Types
in the Amazon Elastic Container Service Developer Guide.
deleteAccountSetting : DeleteAccountSettingRequest -> AWS.Http.Request AWS.Http.AWSAppError DeleteAccountSettingResponse
Disables an account setting for a specified IAM user, IAM role, or the root user for an account.
deleteAttributes : DeleteAttributesRequest -> AWS.Http.Request AWS.Http.AWSAppError DeleteAttributesResponse
Deletes one or more custom attributes from an Amazon ECS resource.
deleteCluster : DeleteClusterRequest -> AWS.Http.Request AWS.Http.AWSAppError DeleteClusterResponse
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
.
deleteService : DeleteServiceRequest -> AWS.Http.Request AWS.Http.AWSAppError DeleteServiceResponse
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.
deleteTaskSet : DeleteTaskSetRequest -> AWS.Http.Request AWS.Http.AWSAppError DeleteTaskSetResponse
Deletes a specified task set within a service. This is used when a service uses the EXTERNAL
deployment controller type. For more information, see Amazon ECS Deployment Types
in the Amazon Elastic Container Service Developer Guide.
deregisterContainerInstance : DeregisterContainerInstanceRequest -> AWS.Http.Request AWS.Http.AWSAppError DeregisterContainerInstanceResponse
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).
deregisterTaskDefinition : DeregisterTaskDefinitionRequest -> AWS.Http.Request AWS.Http.AWSAppError DeregisterTaskDefinitionResponse
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.
describeClusters : DescribeClustersRequest -> AWS.Http.Request AWS.Http.AWSAppError DescribeClustersResponse
Describes one or more of your clusters.
describeContainerInstances : DescribeContainerInstancesRequest -> AWS.Http.Request AWS.Http.AWSAppError DescribeContainerInstancesResponse
Describes Amazon Elastic Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
describeServices : DescribeServicesRequest -> AWS.Http.Request AWS.Http.AWSAppError DescribeServicesResponse
Describes the specified services running in your cluster.
describeTaskDefinition : DescribeTaskDefinitionRequest -> AWS.Http.Request AWS.Http.AWSAppError DescribeTaskDefinitionResponse
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.
describeTaskSets : DescribeTaskSetsRequest -> AWS.Http.Request AWS.Http.AWSAppError DescribeTaskSetsResponse
Describes the task sets in the specified cluster and service. This is used when a service uses the EXTERNAL
deployment controller type. For more information, see Amazon ECS Deployment Types
in the Amazon Elastic Container Service Developer Guide.
describeTasks : DescribeTasksRequest -> AWS.Http.Request AWS.Http.AWSAppError DescribeTasksResponse
Describes a specified task or tasks.
discoverPollEndpoint : DiscoverPollEndpointRequest -> AWS.Http.Request AWS.Http.AWSAppError DiscoverPollEndpointResponse
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.
listAccountSettings : ListAccountSettingsRequest -> AWS.Http.Request AWS.Http.AWSAppError ListAccountSettingsResponse
Lists the account settings for a specified principal.
listAttributes : ListAttributesRequest -> AWS.Http.Request AWS.Http.AWSAppError ListAttributesResponse
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
).
listClusters : ListClustersRequest -> AWS.Http.Request AWS.Http.AWSAppError ListClustersResponse
Returns a list of existing clusters.
listContainerInstances : ListContainerInstancesRequest -> AWS.Http.Request AWS.Http.AWSAppError ListContainerInstancesResponse
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.
listServices : ListServicesRequest -> AWS.Http.Request AWS.Http.AWSAppError ListServicesResponse
Lists the services that are running in a specified cluster.
listTagsForResource : ListTagsForResourceRequest -> AWS.Http.Request AWS.Http.AWSAppError ListTagsForResourceResponse
List the tags for an Amazon ECS resource.
listTaskDefinitionFamilies : ListTaskDefinitionFamiliesRequest -> AWS.Http.Request AWS.Http.AWSAppError ListTaskDefinitionFamiliesResponse
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.
listTaskDefinitions : ListTaskDefinitionsRequest -> AWS.Http.Request AWS.Http.AWSAppError ListTaskDefinitionsResponse
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.
listTasks : ListTasksRequest -> AWS.Http.Request AWS.Http.AWSAppError ListTasksResponse
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.
putAccountSetting : PutAccountSettingRequest -> AWS.Http.Request AWS.Http.AWSAppError PutAccountSettingResponse
Modifies an account setting. If you change the account setting for the root user, the default settings for all of the IAM users and roles for which no individual account setting has been specified are reset. For more information, see Account Settings
in the Amazon Elastic Container Service Developer Guide.
When serviceLongArnFormat
, taskLongArnFormat
, or containerInstanceLongArnFormat
are specified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified IAM user, IAM role, or the root user for an account is affected. The opt-in and opt-out account setting must 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. You must enable this setting to use Amazon ECS features such as resource tagging.
When awsvpcTrunking
is specified, the elastic network interface (ENI) limit for any new container instances that support the feature is changed. If awsvpcTrunking
is enabled, any new container instances that support the feature are launched have the increased ENI limits available to them. For more information, see Elastic Network Interface Trunking
in the Amazon Elastic Container Service Developer Guide.
When containerInsights
is specified, the default setting indicating whether CloudWatch Container Insights is enabled for your clusters is changed. If containerInsights
is enabled, any new clusters that are created will have Container Insights enabled unless you disable it during cluster creation. For more information, see CloudWatch Container Insights
in the Amazon Elastic Container Service Developer Guide.
putAccountSettingDefault : PutAccountSettingDefaultRequest -> AWS.Http.Request AWS.Http.AWSAppError PutAccountSettingDefaultResponse
Modifies an account setting for all IAM users on an account for whom no individual account setting has been specified.
putAttributes : PutAttributesRequest -> AWS.Http.Request AWS.Http.AWSAppError PutAttributesResponse
Create or update an attribute on an Amazon ECS resource. If the attribute does not exist, it is created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes
. For more information, see Attributes
in the Amazon Elastic Container Service Developer Guide.
registerContainerInstance : RegisterContainerInstanceRequest -> AWS.Http.Request AWS.Http.AWSAppError RegisterContainerInstanceResponse
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.
registerTaskDefinition : RegisterTaskDefinitionRequest -> AWS.Http.Request AWS.Http.AWSAppError RegisterTaskDefinitionResponse
Registers a new task definition from the supplied family
and containerDefinitions
. Optionally, you can add data volumes to your containers with the volumes
parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions
in the Amazon Elastic Container Service Developer Guide.
You can specify an IAM role for your task with the taskRoleArn
parameter. When you specify an IAM role for a task, its containers can then use the latest versions of the AWS CLI or SDKs to make API requests to the AWS services that are specified in the IAM policy associated with the role. For more information, see IAM Roles for Tasks
in the Amazon Elastic Container Service Developer Guide.
You can specify a Docker networking mode for the containers in your task definition with the networkMode
parameter. The available network modes correspond to those described in Network settings
in the Docker run reference. If you specify the awsvpc
network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration
when you create a service or run a task with the task definition. For more information, see Task Networking
in the Amazon Elastic Container Service Developer Guide.
runTask : RunTaskRequest -> AWS.Http.Request AWS.Http.AWSAppError RunTaskResponse
Starts a new task using the specified task definition.
You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks
in the Amazon Elastic Container Service Developer Guide.
Alternatively, you can use StartTask
to use your own scheduler or place tasks manually on specific container instances.
The Amazon ECS API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.
To manage eventual consistency, you can do the following:
startTask : StartTaskRequest -> AWS.Http.Request AWS.Http.AWSAppError StartTaskResponse
Starts a new task from the specified task definition on the specified container instance or instances.
Alternatively, you can use RunTask
to place tasks for you. For more information, see Scheduling Tasks
in the Amazon Elastic Container Service Developer Guide.
stopTask : StopTaskRequest -> AWS.Http.Request AWS.Http.AWSAppError StopTaskResponse
Stops a running task. Any tags associated with the task will be deleted.
When StopTask
is called on a task, the equivalent of docker stop
is issued to the containers running in the task. This results in a SIGTERM
value and a default 30-second timeout, after which the SIGKILL
value is sent and the containers are forcibly stopped. If the container handles the SIGTERM
value gracefully and exits within 30 seconds from receiving it, no SIGKILL
value is sent.
The default 30-second timeout can be configured on the Amazon ECS container agent with the ECS_CONTAINER_STOP_TIMEOUT
variable. For more information, see Amazon ECS Container Agent Configuration
in the Amazon Elastic Container Service Developer Guide.
submitAttachmentStateChanges : SubmitAttachmentStateChangesRequest -> AWS.Http.Request AWS.Http.AWSAppError SubmitAttachmentStateChangesResponse
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Sent to acknowledge that an attachment changed states.
submitContainerStateChange : SubmitContainerStateChangeRequest -> AWS.Http.Request AWS.Http.AWSAppError SubmitContainerStateChangeResponse
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a container changed states.
submitTaskStateChange : SubmitTaskStateChangeRequest -> AWS.Http.Request AWS.Http.AWSAppError SubmitTaskStateChangeResponse
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a task changed states.
tagResource : TagResourceRequest -> AWS.Http.Request AWS.Http.AWSAppError ()
Associates the specified tags to a resource with the specified resourceArn
. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.
untagResource : UntagResourceRequest -> AWS.Http.Request AWS.Http.AWSAppError ()
Deletes specified tags from a resource.
updateContainerAgent : UpdateContainerAgentRequest -> AWS.Http.Request AWS.Http.AWSAppError UpdateContainerAgentResponse
Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.
UpdateContainerAgent
requires the Amazon ECS-optimized AMI or Amazon Linux with the ecs-init
service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually Updating the Amazon ECS Container Agent
in the Amazon Elastic Container Service Developer Guide.
updateContainerInstancesState : UpdateContainerInstancesStateRequest -> AWS.Http.Request AWS.Http.AWSAppError UpdateContainerInstancesStateResponse
Modifies the status of an Amazon ECS container instance.
Once a container instance has reached an ACTIVE
state, you can change the status of a container instance to DRAINING
to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size.
A container instance cannot be changed to DRAINING
until it has reached an ACTIVE
status. If the instance is in any other status, an error will be received.
When you set a container instance to DRAINING
, Amazon ECS prevents new tasks from being scheduled for placement on the container instance and replacement service tasks are started on other container instances in the cluster if the resources are available. Service tasks on the container instance that are in the PENDING
state are stopped immediately.
Service tasks on the container instance that are in the RUNNING
state are stopped and replaced according to the service's deployment configuration parameters, minimumHealthyPercent
and maximumPercent
. You can change the deployment configuration of your service using UpdateService
.
minimumHealthyPercent
is below 100%, the scheduler can ignore desiredCount
temporarily during task replacement. For example, desiredCount
is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler can't remove existing tasks until the replacement tasks are considered healthy. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING
state. Tasks for services that 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 maximumPercent
parameter represents an upper limit on the number of running tasks during task replacement, which enables you to define the replacement batch size. For example, if desiredCount
is four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained, provided that the cluster resources required to do this are available. If the maximum is 100%, then replacement tasks can't start until the draining tasks have stopped.Any PENDING
or RUNNING
tasks that do not belong to a service are not affected. You must wait for them to finish or stop them manually.
A container instance has completed draining when it has no more RUNNING
tasks. You can verify this using ListTasks
.
When a container instance has been drained, you can set a container instance to ACTIVE
status and once it has reached that status the Amazon ECS scheduler can begin scheduling tasks on the instance again.
updateService : UpdateServiceRequest -> AWS.Http.Request AWS.Http.AWSAppError UpdateServiceResponse
Modifies the parameters of a service.
For services using the rolling update (ECS
) deployment controller, the desired count, deployment configuration, network configuration, or task definition used can be updated.
For services using the blue/green (CODE_DEPLOY
) deployment controller, only the desired count, deployment configuration, and health check grace period can be updated using this API. If the network configuration, platform version, or task definition need to be updated, a new AWS CodeDeploy deployment should be created. For more information, see CreateDeployment
in the AWS CodeDeploy API Reference.
For services using an external deployment controller, you can update only the desired count and health check grace period using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be updated, you should create a new task set. For more information, see CreateTaskSet
.
You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount
parameter.
If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy.
If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, my_image:latest
), you do not need to create a new revision of your task definition. You can update the service using the forceNewDeployment
option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.
You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, minimumHealthyPercent
and maximumPercent
, to determine the deployment strategy.
minimumHealthyPercent
is below 100%, the scheduler can ignore desiredCount
temporarily during a deployment. For example, if desiredCount
is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks 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 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 maximumPercent
parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if desiredCount
is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).When UpdateService
stops a task during a deployment, the equivalent of docker stop
is issued to the containers running in the task. This results in a SIGTERM
and a 30-second timeout, after which SIGKILL
is sent and the containers are forcibly stopped. If the container handles the SIGTERM
gracefully and exits within 30 seconds from receiving it, no SIGKILL
is sent.
When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic:
When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:
updateServicePrimaryTaskSet : UpdateServicePrimaryTaskSetRequest -> AWS.Http.Request AWS.Http.AWSAppError UpdateServicePrimaryTaskSetResponse
Modifies which task set in a service is the primary task set. Any parameters that are updated on the primary task set in a service will transition to the service. This is used when a service uses the EXTERNAL
deployment controller type. For more information, see Amazon ECS Deployment Types
in the Amazon Elastic Container Service Developer Guide.
updateTaskSet : UpdateTaskSetRequest -> AWS.Http.Request AWS.Http.AWSAppError UpdateTaskSetResponse
Modifies a task set. This is used when a service uses the EXTERNAL
deployment controller type. For more information, see Amazon ECS Deployment Types
in the Amazon Elastic Container Service Developer Guide.
The AgentUpdateStatus data model.
The AssignPublicIp data model.
{ details : Maybe AttachmentDetails
, id : Maybe String
, status : Maybe String
, type_ : Maybe String
}
The Attachment data model.
List KeyValuePair
The AttachmentDetails data model.
{ attachmentArn : String
, status : String
}
The AttachmentStateChange data model.
List AttachmentStateChange
The AttachmentStateChanges data model.
List Attachment
The Attachments data model.
{ name : String
, targetId : Maybe String
, targetType : Maybe TargetType
, value : Maybe String
}
The Attribute data model.
List Attribute
The Attributes data model.
{ assignPublicIp : Maybe AssignPublicIp
, securityGroups : Maybe StringList
, subnets : StringList
}
The AwsVpcConfiguration data model.
{ activeServicesCount : Maybe Basics.Int
, clusterArn : Maybe String
, clusterName : Maybe String
, pendingTasksCount : Maybe Basics.Int
, registeredContainerInstancesCount : Maybe Basics.Int
, runningTasksCount : Maybe Basics.Int
, settings : Maybe ClusterSettings
, statistics : Maybe Statistics
, status : Maybe String
, tags : Maybe Tags
}
The Cluster data model.
The ClusterField data model.
List ClusterField
The ClusterFieldList data model.
{ name : Maybe ClusterSettingName
, value : Maybe String
}
The ClusterSetting data model.
The ClusterSettingName data model.
List ClusterSetting
The ClusterSettings data model.
List Cluster
The Clusters data model.
The Compatibility data model.
List Compatibility
The CompatibilityList data model.
The Connectivity data model.
{ containerArn : Maybe String
, cpu : Maybe String
, exitCode : Maybe Basics.Int
, gpuIds : Maybe GpuIds
, healthStatus : Maybe HealthStatus
, lastStatus : Maybe String
, memory : Maybe String
, memoryReservation : Maybe String
, name : Maybe String
, networkBindings : Maybe NetworkBindings
, networkInterfaces : Maybe NetworkInterfaces
, reason : Maybe String
, taskArn : Maybe String
}
The Container data model.
The ContainerCondition data model.
{ command : Maybe StringList
, cpu : Maybe Basics.Int
, dependsOn : Maybe ContainerDependencies
, disableNetworking : Maybe Basics.Bool
, dnsSearchDomains : Maybe StringList
, dnsServers : Maybe StringList
, dockerLabels : Maybe DockerLabelsMap
, dockerSecurityOptions : Maybe StringList
, entryPoint : Maybe StringList
, environment : Maybe EnvironmentVariables
, essential : Maybe Basics.Bool
, extraHosts : Maybe HostEntryList
, healthCheck : Maybe HealthCheck
, hostname : Maybe String
, image : Maybe String
, interactive : Maybe Basics.Bool
, links : Maybe StringList
, linuxParameters : Maybe LinuxParameters
, logConfiguration : Maybe LogConfiguration
, memory : Maybe Basics.Int
, memoryReservation : Maybe Basics.Int
, mountPoints : Maybe MountPointList
, name : Maybe String
, portMappings : Maybe PortMappingList
, privileged : Maybe Basics.Bool
, pseudoTerminal : Maybe Basics.Bool
, readonlyRootFilesystem : Maybe Basics.Bool
, repositoryCredentials : Maybe RepositoryCredentials
, resourceRequirements : Maybe ResourceRequirements
, secrets : Maybe SecretList
, startTimeout : Maybe Basics.Int
, stopTimeout : Maybe Basics.Int
, systemControls : Maybe SystemControls
, ulimits : Maybe UlimitList
, user : Maybe String
, volumesFrom : Maybe VolumeFromList
, workingDirectory : Maybe String
}
The ContainerDefinition data model.
List ContainerDefinition
The ContainerDefinitions data model.
List ContainerDependency
The ContainerDependencies data model.
{ condition : ContainerCondition
, containerName : String
}
The ContainerDependency data model.
{ agentConnected : Maybe Basics.Bool
, agentUpdateStatus : Maybe AgentUpdateStatus
, attachments : Maybe Attachments
, attributes : Maybe Attributes
, containerInstanceArn : Maybe String
, ec2InstanceId : Maybe String
, pendingTasksCount : Maybe Basics.Int
, registeredAt : Maybe String
, registeredResources : Maybe Resources
, remainingResources : Maybe Resources
, runningTasksCount : Maybe Basics.Int
, status : Maybe String
, statusReason : Maybe String
, tags : Maybe Tags
, version : Maybe Basics.Int
, versionInfo : Maybe VersionInfo
}
The ContainerInstance data model.
The ContainerInstanceField data model.
List ContainerInstanceField
The ContainerInstanceFieldList data model.
The ContainerInstanceStatus data model.
List ContainerInstance
The ContainerInstances data model.
{ command : Maybe StringList
, cpu : Maybe Basics.Int
, environment : Maybe EnvironmentVariables
, memory : Maybe Basics.Int
, memoryReservation : Maybe Basics.Int
, name : Maybe String
, resourceRequirements : Maybe ResourceRequirements
}
The ContainerOverride data model.
List ContainerOverride
The ContainerOverrides data model.
{ containerName : Maybe String
, exitCode : Maybe Basics.Int
, networkBindings : Maybe NetworkBindings
, reason : Maybe String
, status : Maybe String
}
The ContainerStateChange data model.
List ContainerStateChange
The ContainerStateChanges data model.
List Container
The Containers data model.
{ clusterName : Maybe String
, settings : Maybe ClusterSettings
, tags : Maybe Tags
}
The CreateClusterRequest data model.
{ cluster : Maybe Cluster }
The CreateClusterResponse data model.
{ clientToken : Maybe String
, cluster : Maybe String
, deploymentConfiguration : Maybe DeploymentConfiguration
, deploymentController : Maybe DeploymentController
, desiredCount : Maybe Basics.Int
, enableEcsmanagedTags : Maybe Basics.Bool
, healthCheckGracePeriodSeconds : Maybe Basics.Int
, launchType : Maybe LaunchType
, loadBalancers : Maybe LoadBalancers
, networkConfiguration : Maybe NetworkConfiguration
, placementConstraints : Maybe PlacementConstraints
, placementStrategy : Maybe PlacementStrategies
, platformVersion : Maybe String
, propagateTags : Maybe PropagateTags
, role : Maybe String
, schedulingStrategy : Maybe SchedulingStrategy
, serviceName : String
, serviceRegistries : Maybe ServiceRegistries
, tags : Maybe Tags
, taskDefinition : Maybe String
}
The CreateServiceRequest data model.
{ service : Maybe Service }
The CreateServiceResponse data model.
{ clientToken : Maybe String
, cluster : String
, externalId : Maybe String
, launchType : Maybe LaunchType
, loadBalancers : Maybe LoadBalancers
, networkConfiguration : Maybe NetworkConfiguration
, platformVersion : Maybe String
, scale : Maybe Scale
, service : String
, serviceRegistries : Maybe ServiceRegistries
, taskDefinition : String
}
The CreateTaskSetRequest data model.
{ taskSet : Maybe TaskSet }
The CreateTaskSetResponse data model.
{ name : SettingName
, principalArn : Maybe String
}
The DeleteAccountSettingRequest data model.
{ setting : Maybe Setting }
The DeleteAccountSettingResponse data model.
{ attributes : Attributes
, cluster : Maybe String
}
The DeleteAttributesRequest data model.
{ attributes : Maybe Attributes }
The DeleteAttributesResponse data model.
{ cluster : String }
The DeleteClusterRequest data model.
{ cluster : Maybe Cluster }
The DeleteClusterResponse data model.
{ cluster : Maybe String
, force : Maybe Basics.Bool
, service : String
}
The DeleteServiceRequest data model.
{ service : Maybe Service }
The DeleteServiceResponse data model.
{ cluster : String
, force : Maybe Basics.Bool
, service : String
, taskSet : String
}
The DeleteTaskSetRequest data model.
{ taskSet : Maybe TaskSet }
The DeleteTaskSetResponse data model.
{ createdAt : Maybe String
, desiredCount : Maybe Basics.Int
, id : Maybe String
, launchType : Maybe LaunchType
, networkConfiguration : Maybe NetworkConfiguration
, pendingCount : Maybe Basics.Int
, platformVersion : Maybe String
, runningCount : Maybe Basics.Int
, status : Maybe String
, taskDefinition : Maybe String
, updatedAt : Maybe String
}
The Deployment data model.
{ maximumPercent : Maybe Basics.Int
, minimumHealthyPercent : Maybe Basics.Int
}
The DeploymentConfiguration data model.
{ type_ : DeploymentControllerType }
The DeploymentController data model.
The DeploymentControllerType data model.
List Deployment
The Deployments data model.
{ cluster : Maybe String
, containerInstance : String
, force : Maybe Basics.Bool
}
The DeregisterContainerInstanceRequest data model.
{ containerInstance : Maybe ContainerInstance }
The DeregisterContainerInstanceResponse data model.
{ taskDefinition : String }
The DeregisterTaskDefinitionRequest data model.
{ taskDefinition : Maybe TaskDefinition }
The DeregisterTaskDefinitionResponse data model.
{ clusters : Maybe StringList
, include : Maybe ClusterFieldList
}
The DescribeClustersRequest data model.
{ clusters : Maybe Clusters
, failures : Maybe Failures
}
The DescribeClustersResponse data model.
{ cluster : Maybe String
, containerInstances : StringList
, include : Maybe ContainerInstanceFieldList
}
The DescribeContainerInstancesRequest data model.
{ containerInstances : Maybe ContainerInstances
, failures : Maybe Failures
}
The DescribeContainerInstancesResponse data model.
{ cluster : Maybe String
, include : Maybe ServiceFieldList
, services : StringList
}
The DescribeServicesRequest data model.
{ failures : Maybe Failures
, services : Maybe Services
}
The DescribeServicesResponse data model.
{ include : Maybe TaskDefinitionFieldList
, taskDefinition : String
}
The DescribeTaskDefinitionRequest data model.
{ tags : Maybe Tags
, taskDefinition : Maybe TaskDefinition
}
The DescribeTaskDefinitionResponse data model.
{ cluster : String
, service : String
, taskSets : Maybe StringList
}
The DescribeTaskSetsRequest data model.
{ failures : Maybe Failures
, taskSets : Maybe TaskSets
}
The DescribeTaskSetsResponse data model.
{ cluster : Maybe String
, include : Maybe TaskFieldList
, tasks : StringList
}
The DescribeTasksRequest data model.
{ failures : Maybe Failures
, tasks : Maybe Tasks
}
The DescribeTasksResponse data model.
The DesiredStatus data model.
{ containerPath : Maybe String
, hostPath : String
, permissions : Maybe DeviceCgroupPermissions
}
The Device data model.
The DeviceCgroupPermission data model.
List DeviceCgroupPermission
The DeviceCgroupPermissions data model.
List Device
The DevicesList data model.
{ cluster : Maybe String
, containerInstance : Maybe String
}
The DiscoverPollEndpointRequest data model.
{ endpoint : Maybe String
, telemetryEndpoint : Maybe String
}
The DiscoverPollEndpointResponse data model.
Dict String String
The DockerLabelsMap data model.
{ autoprovision : Maybe Basics.Bool
, driver : Maybe String
, driverOpts : Maybe StringMap
, labels : Maybe StringMap
, scope : Maybe Scope
}
The DockerVolumeConfiguration data model.
List KeyValuePair
The EnvironmentVariables data model.
{ arn : Maybe String
, reason : Maybe String
}
The Failure data model.
List Failure
The Failures data model.
List String
The GpuIds data model.
{ command : StringList
, interval : Maybe Basics.Int
, retries : Maybe Basics.Int
, startPeriod : Maybe Basics.Int
, timeout : Maybe Basics.Int
}
The HealthCheck data model.
The HealthStatus data model.
{ hostname : String
, ipAddress : String
}
The HostEntry data model.
List HostEntry
The HostEntryList data model.
{ sourcePath : Maybe String }
The HostVolumeProperties data model.
The IpcMode data model.
{ add : Maybe StringList
, drop : Maybe StringList
}
The KernelCapabilities data model.
{ name : Maybe String
, value : Maybe String
}
The KeyValuePair data model.
The LaunchType data model.
{ capabilities : Maybe KernelCapabilities
, devices : Maybe DevicesList
, initProcessEnabled : Maybe Basics.Bool
, sharedMemorySize : Maybe Basics.Int
, tmpfs : Maybe TmpfsList
}
The LinuxParameters data model.
{ effectiveSettings : Maybe Basics.Bool
, maxResults : Maybe Basics.Int
, name : Maybe SettingName
, nextToken : Maybe String
, principalArn : Maybe String
, value : Maybe String
}
The ListAccountSettingsRequest data model.
{ nextToken : Maybe String
, settings : Maybe Settings
}
The ListAccountSettingsResponse data model.
{ attributeName : Maybe String
, attributeValue : Maybe String
, cluster : Maybe String
, maxResults : Maybe Basics.Int
, nextToken : Maybe String
, targetType : TargetType
}
The ListAttributesRequest data model.
{ attributes : Maybe Attributes
, nextToken : Maybe String
}
The ListAttributesResponse data model.
{ maxResults : Maybe Basics.Int
, nextToken : Maybe String
}
The ListClustersRequest data model.
{ clusterArns : Maybe StringList
, nextToken : Maybe String
}
The ListClustersResponse data model.
{ cluster : Maybe String
, filter : Maybe String
, maxResults : Maybe Basics.Int
, nextToken : Maybe String
, status : Maybe ContainerInstanceStatus
}
The ListContainerInstancesRequest data model.
{ containerInstanceArns : Maybe StringList
, nextToken : Maybe String
}
The ListContainerInstancesResponse data model.
{ cluster : Maybe String
, launchType : Maybe LaunchType
, maxResults : Maybe Basics.Int
, nextToken : Maybe String
, schedulingStrategy : Maybe SchedulingStrategy
}
The ListServicesRequest data model.
{ nextToken : Maybe String
, serviceArns : Maybe StringList
}
The ListServicesResponse data model.
{ resourceArn : String }
The ListTagsForResourceRequest data model.
{ tags : Maybe Tags }
The ListTagsForResourceResponse data model.
{ familyPrefix : Maybe String
, maxResults : Maybe Basics.Int
, nextToken : Maybe String
, status : Maybe TaskDefinitionFamilyStatus
}
The ListTaskDefinitionFamiliesRequest data model.
{ families : Maybe StringList
, nextToken : Maybe String
}
The ListTaskDefinitionFamiliesResponse data model.
{ familyPrefix : Maybe String
, maxResults : Maybe Basics.Int
, nextToken : Maybe String
, sort : Maybe SortOrder
, status : Maybe TaskDefinitionStatus
}
The ListTaskDefinitionsRequest data model.
{ nextToken : Maybe String
, taskDefinitionArns : Maybe StringList
}
The ListTaskDefinitionsResponse data model.
{ cluster : Maybe String
, containerInstance : Maybe String
, desiredStatus : Maybe DesiredStatus
, family : Maybe String
, launchType : Maybe LaunchType
, maxResults : Maybe Basics.Int
, nextToken : Maybe String
, serviceName : Maybe String
, startedBy : Maybe String
}
The ListTasksRequest data model.
{ nextToken : Maybe String
, taskArns : Maybe StringList
}
The ListTasksResponse data model.
{ containerName : Maybe String
, containerPort : Maybe Basics.Int
, loadBalancerName : Maybe String
, targetGroupArn : Maybe String
}
The LoadBalancer data model.
List LoadBalancer
The LoadBalancers data model.
{ logDriver : LogDriver
, options : Maybe LogConfigurationOptionsMap
, secretOptions : Maybe SecretList
}
The LogConfiguration data model.
Dict String String
The LogConfigurationOptionsMap data model.
The LogDriver data model.
{ containerPath : Maybe String
, readOnly : Maybe Basics.Bool
, sourceVolume : Maybe String
}
The MountPoint data model.
List MountPoint
The MountPointList data model.
{ bindIp : Maybe String
, containerPort : Maybe Basics.Int
, hostPort : Maybe Basics.Int
, protocol : Maybe TransportProtocol
}
The NetworkBinding data model.
List NetworkBinding
The NetworkBindings data model.
{ awsvpcConfiguration : Maybe AwsVpcConfiguration }
The NetworkConfiguration data model.
{ attachmentId : Maybe String
, ipv6Address : Maybe String
, privateIpv4Address : Maybe String
}
The NetworkInterface data model.
List NetworkInterface
The NetworkInterfaces data model.
The NetworkMode data model.
The PidMode data model.
{ expression : Maybe String
, type_ : Maybe PlacementConstraintType
}
The PlacementConstraint data model.
The PlacementConstraintType data model.
List PlacementConstraint
The PlacementConstraints data model.
List PlacementStrategy
The PlacementStrategies data model.
{ field : Maybe String
, type_ : Maybe PlacementStrategyType
}
The PlacementStrategy data model.
The PlacementStrategyType data model.
{ id : String
, type_ : PlatformDeviceType
}
The PlatformDevice data model.
The PlatformDeviceType data model.
List PlatformDevice
The PlatformDevices data model.
{ containerPort : Maybe Basics.Int
, hostPort : Maybe Basics.Int
, protocol : Maybe TransportProtocol
}
The PortMapping data model.
List PortMapping
The PortMappingList data model.
The PropagateTags data model.
{ containerName : String
, properties : Maybe ProxyConfigurationProperties
, type_ : Maybe ProxyConfigurationType
}
The ProxyConfiguration data model.
List KeyValuePair
The ProxyConfigurationProperties data model.
The ProxyConfigurationType data model.
{ name : SettingName
, value : String
}
The PutAccountSettingDefaultRequest data model.
{ setting : Maybe Setting }
The PutAccountSettingDefaultResponse data model.
{ name : SettingName
, principalArn : Maybe String
, value : String
}
The PutAccountSettingRequest data model.
{ setting : Maybe Setting }
The PutAccountSettingResponse data model.
{ attributes : Attributes
, cluster : Maybe String
}
The PutAttributesRequest data model.
{ attributes : Maybe Attributes }
The PutAttributesResponse data model.
{ attributes : Maybe Attributes
, cluster : Maybe String
, containerInstanceArn : Maybe String
, instanceIdentityDocument : Maybe String
, instanceIdentityDocumentSignature : Maybe String
, platformDevices : Maybe PlatformDevices
, tags : Maybe Tags
, totalResources : Maybe Resources
, versionInfo : Maybe VersionInfo
}
The RegisterContainerInstanceRequest data model.
{ containerInstance : Maybe ContainerInstance }
The RegisterContainerInstanceResponse data model.
{ containerDefinitions : ContainerDefinitions
, cpu : Maybe String
, executionRoleArn : Maybe String
, family : String
, ipcMode : Maybe IpcMode
, memory : Maybe String
, networkMode : Maybe NetworkMode
, pidMode : Maybe PidMode
, placementConstraints : Maybe TaskDefinitionPlacementConstraints
, proxyConfiguration : Maybe ProxyConfiguration
, requiresCompatibilities : Maybe CompatibilityList
, tags : Maybe Tags
, taskRoleArn : Maybe String
, volumes : Maybe VolumeList
}
The RegisterTaskDefinitionRequest data model.
{ tags : Maybe Tags
, taskDefinition : Maybe TaskDefinition
}
The RegisterTaskDefinitionResponse data model.
{ credentialsParameter : String }
The RepositoryCredentials data model.
List Attribute
The RequiresAttributes data model.
{ doubleValue : Maybe Basics.Float
, integerValue : Maybe Basics.Int
, longValue : Maybe Basics.Int
, name : Maybe String
, stringSetValue : Maybe StringList
, type_ : Maybe String
}
The Resource data model.
{ type_ : ResourceType
, value : String
}
The ResourceRequirement data model.
List ResourceRequirement
The ResourceRequirements data model.
The ResourceType data model.
List Resource
The Resources data model.
{ cluster : Maybe String
, count : Maybe Basics.Int
, enableEcsmanagedTags : Maybe Basics.Bool
, group : Maybe String
, launchType : Maybe LaunchType
, networkConfiguration : Maybe NetworkConfiguration
, overrides : Maybe TaskOverride
, placementConstraints : Maybe PlacementConstraints
, placementStrategy : Maybe PlacementStrategies
, platformVersion : Maybe String
, propagateTags : Maybe PropagateTags
, startedBy : Maybe String
, tags : Maybe Tags
, taskDefinition : String
}
The RunTaskRequest data model.
{ failures : Maybe Failures
, tasks : Maybe Tasks
}
The RunTaskResponse data model.
{ unit : Maybe ScaleUnit
, value : Maybe Basics.Float
}
The Scale data model.
The ScaleUnit data model.
The SchedulingStrategy data model.
The Scope data model.
{ name : String
, valueFrom : String
}
The Secret data model.
List Secret
The SecretList data model.
{ clusterArn : Maybe String
, createdAt : Maybe String
, createdBy : Maybe String
, deploymentConfiguration : Maybe DeploymentConfiguration
, deploymentController : Maybe DeploymentController
, deployments : Maybe Deployments
, desiredCount : Maybe Basics.Int
, enableEcsmanagedTags : Maybe Basics.Bool
, events : Maybe ServiceEvents
, healthCheckGracePeriodSeconds : Maybe Basics.Int
, launchType : Maybe LaunchType
, loadBalancers : Maybe LoadBalancers
, networkConfiguration : Maybe NetworkConfiguration
, pendingCount : Maybe Basics.Int
, placementConstraints : Maybe PlacementConstraints
, placementStrategy : Maybe PlacementStrategies
, platformVersion : Maybe String
, propagateTags : Maybe PropagateTags
, roleArn : Maybe String
, runningCount : Maybe Basics.Int
, schedulingStrategy : Maybe SchedulingStrategy
, serviceArn : Maybe String
, serviceName : Maybe String
, serviceRegistries : Maybe ServiceRegistries
, status : Maybe String
, tags : Maybe Tags
, taskDefinition : Maybe String
, taskSets : Maybe TaskSets
}
The Service data model.
{ createdAt : Maybe String
, id : Maybe String
, message : Maybe String
}
The ServiceEvent data model.
List ServiceEvent
The ServiceEvents data model.
The ServiceField data model.
List ServiceField
The ServiceFieldList data model.
List ServiceRegistry
The ServiceRegistries data model.
{ containerName : Maybe String
, containerPort : Maybe Basics.Int
, port_ : Maybe Basics.Int
, registryArn : Maybe String
}
The ServiceRegistry data model.
List Service
The Services data model.
{ name : Maybe SettingName
, principalArn : Maybe String
, value : Maybe String
}
The Setting data model.
The SettingName data model.
List Setting
The Settings data model.
The SortOrder data model.
The StabilityStatus data model.
{ cluster : Maybe String
, containerInstances : StringList
, enableEcsmanagedTags : Maybe Basics.Bool
, group : Maybe String
, networkConfiguration : Maybe NetworkConfiguration
, overrides : Maybe TaskOverride
, propagateTags : Maybe PropagateTags
, startedBy : Maybe String
, tags : Maybe Tags
, taskDefinition : String
}
The StartTaskRequest data model.
{ failures : Maybe Failures
, tasks : Maybe Tasks
}
The StartTaskResponse data model.
List KeyValuePair
The Statistics data model.
{ cluster : Maybe String
, reason : Maybe String
, task : String
}
The StopTaskRequest data model.
{ task : Maybe Task }
The StopTaskResponse data model.
List String
The StringList data model.
Dict String String
The StringMap data model.
{ attachments : AttachmentStateChanges
, cluster : Maybe String
}
The SubmitAttachmentStateChangesRequest data model.
{ acknowledgment : Maybe String }
The SubmitAttachmentStateChangesResponse data model.
{ cluster : Maybe String
, containerName : Maybe String
, exitCode : Maybe Basics.Int
, networkBindings : Maybe NetworkBindings
, reason : Maybe String
, status : Maybe String
, task : Maybe String
}
The SubmitContainerStateChangeRequest data model.
{ acknowledgment : Maybe String }
The SubmitContainerStateChangeResponse data model.
{ attachments : Maybe AttachmentStateChanges
, cluster : Maybe String
, containers : Maybe ContainerStateChanges
, executionStoppedAt : Maybe String
, pullStartedAt : Maybe String
, pullStoppedAt : Maybe String
, reason : Maybe String
, status : Maybe String
, task : Maybe String
}
The SubmitTaskStateChangeRequest data model.
{ acknowledgment : Maybe String }
The SubmitTaskStateChangeResponse data model.
{ namespace : Maybe String
, value : Maybe String
}
The SystemControl data model.
List SystemControl
The SystemControls data model.
{ key : Maybe String
, value : Maybe String
}
The Tag data model.
List String
The TagKeys data model.
{ resourceArn : String
, tags : Tags
}
The TagResourceRequest data model.
{}
The TagResourceResponse data model.
List Tag
The Tags data model.
The TargetType data model.
{ attachments : Maybe Attachments
, clusterArn : Maybe String
, connectivity : Maybe Connectivity
, connectivityAt : Maybe String
, containerInstanceArn : Maybe String
, containers : Maybe Containers
, cpu : Maybe String
, createdAt : Maybe String
, desiredStatus : Maybe String
, executionStoppedAt : Maybe String
, group : Maybe String
, healthStatus : Maybe HealthStatus
, lastStatus : Maybe String
, launchType : Maybe LaunchType
, memory : Maybe String
, overrides : Maybe TaskOverride
, platformVersion : Maybe String
, pullStartedAt : Maybe String
, pullStoppedAt : Maybe String
, startedAt : Maybe String
, startedBy : Maybe String
, stopCode : Maybe TaskStopCode
, stoppedAt : Maybe String
, stoppedReason : Maybe String
, stoppingAt : Maybe String
, tags : Maybe Tags
, taskArn : Maybe String
, taskDefinitionArn : Maybe String
, version : Maybe Basics.Int
}
The Task data model.
{ compatibilities : Maybe CompatibilityList
, containerDefinitions : Maybe ContainerDefinitions
, cpu : Maybe String
, executionRoleArn : Maybe String
, family : Maybe String
, ipcMode : Maybe IpcMode
, memory : Maybe String
, networkMode : Maybe NetworkMode
, pidMode : Maybe PidMode
, placementConstraints : Maybe TaskDefinitionPlacementConstraints
, proxyConfiguration : Maybe ProxyConfiguration
, requiresAttributes : Maybe RequiresAttributes
, requiresCompatibilities : Maybe CompatibilityList
, revision : Maybe Basics.Int
, status : Maybe TaskDefinitionStatus
, taskDefinitionArn : Maybe String
, taskRoleArn : Maybe String
, volumes : Maybe VolumeList
}
The TaskDefinition data model.
The TaskDefinitionFamilyStatus data model.
The TaskDefinitionField data model.
List TaskDefinitionField
The TaskDefinitionFieldList data model.
{ expression : Maybe String
, type_ : Maybe TaskDefinitionPlacementConstraintType
}
The TaskDefinitionPlacementConstraint data model.
The TaskDefinitionPlacementConstraintType data model.
List TaskDefinitionPlacementConstraint
The TaskDefinitionPlacementConstraints data model.
The TaskDefinitionStatus data model.
The TaskField data model.
List TaskField
The TaskFieldList data model.
{ containerOverrides : Maybe ContainerOverrides
, executionRoleArn : Maybe String
, taskRoleArn : Maybe String
}
The TaskOverride data model.
{ clusterArn : Maybe String
, computedDesiredCount : Maybe Basics.Int
, createdAt : Maybe String
, externalId : Maybe String
, id : Maybe String
, launchType : Maybe LaunchType
, loadBalancers : Maybe LoadBalancers
, networkConfiguration : Maybe NetworkConfiguration
, pendingCount : Maybe Basics.Int
, platformVersion : Maybe String
, runningCount : Maybe Basics.Int
, scale : Maybe Scale
, serviceArn : Maybe String
, serviceRegistries : Maybe ServiceRegistries
, stabilityStatus : Maybe StabilityStatus
, stabilityStatusAt : Maybe String
, startedBy : Maybe String
, status : Maybe String
, taskDefinition : Maybe String
, taskSetArn : Maybe String
, updatedAt : Maybe String
}
The TaskSet data model.
List TaskSet
The TaskSets data model.
The TaskStopCode data model.
List Task
The Tasks data model.
{ containerPath : String
, mountOptions : Maybe StringList
, size : Basics.Int
}
The Tmpfs data model.
List Tmpfs
The TmpfsList data model.
The TransportProtocol data model.
{ hardLimit : Basics.Int
, name : UlimitName
, softLimit : Basics.Int
}
The Ulimit data model.
List Ulimit
The UlimitList data model.
The UlimitName data model.
{ resourceArn : String
, tagKeys : TagKeys
}
The UntagResourceRequest data model.
{}
The UntagResourceResponse data model.
{ cluster : Maybe String
, containerInstance : String
}
The UpdateContainerAgentRequest data model.
{ containerInstance : Maybe ContainerInstance }
The UpdateContainerAgentResponse data model.
{ cluster : Maybe String
, containerInstances : StringList
, status : ContainerInstanceStatus
}
The UpdateContainerInstancesStateRequest data model.
{ containerInstances : Maybe ContainerInstances
, failures : Maybe Failures
}
The UpdateContainerInstancesStateResponse data model.
{ cluster : String
, primaryTaskSet : String
, service : String
}
The UpdateServicePrimaryTaskSetRequest data model.
{ taskSet : Maybe TaskSet }
The UpdateServicePrimaryTaskSetResponse data model.
{ cluster : Maybe String
, deploymentConfiguration : Maybe DeploymentConfiguration
, desiredCount : Maybe Basics.Int
, forceNewDeployment : Maybe Basics.Bool
, healthCheckGracePeriodSeconds : Maybe Basics.Int
, networkConfiguration : Maybe NetworkConfiguration
, platformVersion : Maybe String
, service : String
, taskDefinition : Maybe String
}
The UpdateServiceRequest data model.
{ service : Maybe Service }
The UpdateServiceResponse data model.
{ cluster : String
, scale : Scale
, service : String
, taskSet : String
}
The UpdateTaskSetRequest data model.
{ taskSet : Maybe TaskSet }
The UpdateTaskSetResponse data model.
{ agentHash : Maybe String
, agentVersion : Maybe String
, dockerVersion : Maybe String
}
The VersionInfo data model.
{ dockerVolumeConfiguration : Maybe DockerVolumeConfiguration
, host : Maybe HostVolumeProperties
, name : Maybe String
}
The Volume data model.
{ readOnly : Maybe Basics.Bool
, sourceContainer : Maybe String
}
The VolumeFrom data model.
List VolumeFrom
The VolumeFromList data model.
List Volume
The VolumeList data model.
agentUpdateStatus : Enum AgentUpdateStatus
The AgentUpdateStatus data model.
assignPublicIp : Enum AssignPublicIp
The AssignPublicIp data model.
clusterField : Enum ClusterField
The ClusterField data model.
clusterSettingName : Enum ClusterSettingName
The ClusterSettingName data model.
compatibility : Enum Compatibility
The Compatibility data model.
connectivity : Enum Connectivity
The Connectivity data model.
containerCondition : Enum ContainerCondition
The ContainerCondition data model.
containerInstanceField : Enum ContainerInstanceField
The ContainerInstanceField data model.
containerInstanceStatus : Enum ContainerInstanceStatus
The ContainerInstanceStatus data model.
deploymentControllerType : Enum DeploymentControllerType
The DeploymentControllerType data model.
desiredStatus : Enum DesiredStatus
The DesiredStatus data model.
deviceCgroupPermission : Enum DeviceCgroupPermission
The DeviceCgroupPermission data model.
healthStatus : Enum HealthStatus
The HealthStatus data model.
ipcMode : Enum IpcMode
The IpcMode data model.
launchType : Enum LaunchType
The LaunchType data model.
logDriver : Enum LogDriver
The LogDriver data model.
networkMode : Enum NetworkMode
The NetworkMode data model.
pidMode : Enum PidMode
The PidMode data model.
placementConstraintType : Enum PlacementConstraintType
The PlacementConstraintType data model.
placementStrategyType : Enum PlacementStrategyType
The PlacementStrategyType data model.
platformDeviceType : Enum PlatformDeviceType
The PlatformDeviceType data model.
propagateTags : Enum PropagateTags
The PropagateTags data model.
proxyConfigurationType : Enum ProxyConfigurationType
The ProxyConfigurationType data model.
resourceType : Enum ResourceType
The ResourceType data model.
scaleUnit : Enum ScaleUnit
The ScaleUnit data model.
schedulingStrategy : Enum SchedulingStrategy
The SchedulingStrategy data model.
scope : Enum Scope
The Scope data model.
serviceField : Enum ServiceField
The ServiceField data model.
settingName : Enum SettingName
The SettingName data model.
sortOrder : Enum SortOrder
The SortOrder data model.
stabilityStatus : Enum StabilityStatus
The StabilityStatus data model.
targetType : Enum TargetType
The TargetType data model.
taskDefinitionFamilyStatus : Enum TaskDefinitionFamilyStatus
The TaskDefinitionFamilyStatus data model.
taskDefinitionField : Enum TaskDefinitionField
The TaskDefinitionField data model.
taskDefinitionPlacementConstraintType : Enum TaskDefinitionPlacementConstraintType
The TaskDefinitionPlacementConstraintType data model.
taskDefinitionStatus : Enum TaskDefinitionStatus
The TaskDefinitionStatus data model.
taskField : Enum TaskField
The TaskField data model.
taskStopCode : Enum TaskStopCode
The TaskStopCode data model.
transportProtocol : Enum TransportProtocol
The TransportProtocol data model.
ulimitName : Enum UlimitName
The UlimitName data model.