CreateService
Runs and maintains your desired number of tasks from a specified task definition. If
the number of tasks running in a service drops below the desiredCount
,
Amazon ECS runs another copy of the task in the specified cluster. To update an existing
service, use UpdateService.
Note
On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.
Note
Amazon Elastic Inference (EI) is no longer available to customers.
In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute 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 attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or
updating a service. volumeConfigurations
is only supported for REPLICA
service and not DAEMON service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.
Tasks for services that don't use a load balancer are considered healthy if they're in
the RUNNING
state. Tasks for services that use a load balancer are
considered healthy if they're in the RUNNING
state and are reported as
healthy by the load balancer.
There are two service scheduler strategies available:
-
REPLICA
- The replica scheduling strategy places and maintains your 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. The service scheduler also evaluates the task placement constraints for running tasks. It also stops tasks that don't meet the placement constraints. 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 initiated by changing properties. For example, the deployment might be initiated by
the task definition or by your desired count of a service. You can use UpdateService. 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 uses 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. Specifically, it represents it as a
percentage of your desired number of tasks (rounded up to the nearest integer). This
happens when any of your container instances are in the DRAINING
state if
the service contains tasks using the EC2 launch type. Using this
parameter, you can deploy without using additional cluster capacity. For example, if you
set your service to have 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. If they're in the RUNNING
state, tasks for services
that don't use a load balancer are considered healthy . If they're in the
RUNNING
state and reported as healthy by the load balancer, tasks for
services that do use a load balancer are considered healthy . The
default value for minimum healthy percent is 100%.
If a service uses 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. Specifically, it represents it as a
percentage of the desired number of tasks (rounded down to the nearest integer). This
happens when any of your container instances are in the DRAINING
state if
the service contains tasks using the EC2 launch type. Using this
parameter, you can 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 uses 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.
This is 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. This is the case even if 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. 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. For information about task placement and task placement strategies, see Amazon ECS task placement in the Amazon Elastic Container Service Developer Guide
Request Syntax
{
"availabilityZoneRebalancing": "string
",
"capacityProviderStrategy": [
{
"base": number
,
"capacityProvider": "string
",
"weight": number
}
],
"clientToken": "string
",
"cluster": "string
",
"deploymentConfiguration": {
"alarms": {
"alarmNames": [ "string
" ],
"enable": boolean
,
"rollback": boolean
},
"deploymentCircuitBreaker": {
"enable": boolean
,
"rollback": boolean
},
"maximumPercent": number
,
"minimumHealthyPercent": number
},
"deploymentController": {
"type": "string
"
},
"desiredCount": number
,
"enableECSManagedTags": boolean
,
"enableExecuteCommand": boolean
,
"healthCheckGracePeriodSeconds": number
,
"launchType": "string
",
"loadBalancers": [
{
"containerName": "string
",
"containerPort": number
,
"loadBalancerName": "string
",
"targetGroupArn": "string
"
}
],
"networkConfiguration": {
"awsvpcConfiguration": {
"assignPublicIp": "string
",
"securityGroups": [ "string
" ],
"subnets": [ "string
" ]
}
},
"placementConstraints": [
{
"expression": "string
",
"type": "string
"
}
],
"placementStrategy": [
{
"field": "string
",
"type": "string
"
}
],
"platformVersion": "string
",
"propagateTags": "string
",
"role": "string
",
"schedulingStrategy": "string
",
"serviceConnectConfiguration": {
"enabled": boolean
,
"logConfiguration": {
"logDriver": "string
",
"options": {
"string
" : "string
"
},
"secretOptions": [
{
"name": "string
",
"valueFrom": "string
"
}
]
},
"namespace": "string
",
"services": [
{
"clientAliases": [
{
"dnsName": "string
",
"port": number
}
],
"discoveryName": "string
",
"ingressPortOverride": number
,
"portName": "string
",
"timeout": {
"idleTimeoutSeconds": number
,
"perRequestTimeoutSeconds": number
},
"tls": {
"issuerCertificateAuthority": {
"awsPcaAuthorityArn": "string
"
},
"kmsKey": "string
",
"roleArn": "string
"
}
}
]
},
"serviceName": "string
",
"serviceRegistries": [
{
"containerName": "string
",
"containerPort": number
,
"port": number
,
"registryArn": "string
"
}
],
"tags": [
{
"key": "string
",
"value": "string
"
}
],
"taskDefinition": "string
",
"volumeConfigurations": [
{
"managedEBSVolume": {
"encrypted": boolean
,
"filesystemType": "string
",
"iops": number
,
"kmsKeyId": "string
",
"roleArn": "string
",
"sizeInGiB": number
,
"snapshotId": "string
",
"tagSpecifications": [
{
"propagateTags": "string
",
"resourceType": "string
",
"tags": [
{
"key": "string
",
"value": "string
"
}
]
}
],
"throughput": number
,
"volumeType": "string
"
},
"name": "string
"
}
],
"vpcLatticeConfigurations": [
{
"portName": "string
",
"roleArn": "string
",
"targetGroupArn": "string
"
}
]
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- availabilityZoneRebalancing
-
Indicates whether to use Availability Zone rebalancing for the service.
For more information, see Balancing an Amazon ECS service across Availability Zones in the Amazon Elastic Container Service Developer Guide.
Type: String
Valid Values:
ENABLED | DISABLED
Required: No
- capacityProviderStrategy
-
The capacity provider strategy to use for the service.
If a
capacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
orlaunchType
is specified, thedefaultCapacityProviderStrategy
for the cluster is used.A capacity provider strategy can contain a maximum of 20 capacity providers.
Type: Array of CapacityProviderStrategyItem objects
Required: No
- clientToken
-
An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.
Type: String
Required: No
- cluster
-
The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.
Type: String
Required: No
- deploymentConfiguration
-
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
Type: DeploymentConfiguration object
Required: No
- deploymentController
-
The deployment controller to use for the service. If no deployment controller is specified, the default value of
ECS
is used.Type: DeploymentController object
Required: No
- desiredCount
-
The number of instantiations of the specified task definition to place and keep running in your service.
This is required if
schedulingStrategy
isREPLICA
or isn't specified. IfschedulingStrategy
isDAEMON
then this isn't required.Type: Integer
Required: No
- enableECSManagedTags
-
Specifies whether to turn on 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.
When you use Amazon ECS managed tags, you need to set the
propagateTags
request parameter.Type: Boolean
Required: No
- enableExecuteCommand
-
Determines whether the execute command functionality is turned on for the service. If
true
, this enables execute command functionality on all containers in the service tasks.Type: Boolean
Required: No
- healthCheckGracePeriodSeconds
-
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing, VPC Lattice, and container health checks after a task has first started. If you don't specify a health check grace period value, the default value of
0
is used. If you don't use any of the health checks, thenhealthCheckGracePeriodSeconds
is unused.If your service's tasks take a while to start and respond to health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
Type: Integer
Required: No
- launchType
-
The infrastructure that you run your service on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.
The
FARGATE
launch type runs your tasks on Amazon Fargate On-Demand infrastructure.Note
Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Amazon Fargate capacity providers in the Amazon ECS Developer Guide.
The
EC2
launch type runs your tasks on Amazon EC2 instances registered to your cluster.The
EXTERNAL
launch type runs your tasks on your on-premises server or virtual machine (VM) capacity registered to your cluster.A service can use either a launch type or a capacity provider strategy. If a
launchType
is specified, thecapacityProviderStrategy
parameter must be omitted.Type: String
Valid Values:
EC2 | FARGATE | EXTERNAL
Required: No
- loadBalancers
-
A load balancer object representing the load balancers to use with your service. For more information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.
If the service uses the rolling update (
ECS
) deployment controller and using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach to the service. The service-linked role is required for services that use multiple target groups. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.If the service uses the
CODE_DEPLOY
deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an Amazon CodeDeploy deployment group, you specify two target groups (referred to as atargetGroupPair
). During a deployment, Amazon CodeDeploy determines which task set in your service has the statusPRIMARY
, and it associates one target group with it. Then, it also associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that you can use to perform validation tests with Lambda functions before routing production traffic to it.If you use the
CODE_DEPLOY
deployment controller, these values can be changed when updating the service.For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name, and the container port to access from the load balancer. The container name must be as it appears in a container definition. The load balancer name parameter must be omitted. 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 that's specified here.
For Classic Load Balancers, this object must contain the load balancer name, the container name , and the container port to access from the load balancer. The container name must be as it appears in a container definition. The target group ARN parameter must be omitted. When a task from this service is placed on a container instance, the container instance is registered with the load balancer that's specified here.
Services with tasks that use the
awsvpc
network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers aren't supported. Also, when you create any target groups for these services, you must chooseip
as the target type, notinstance
. This is because tasks that use theawsvpc
network mode are associated with an elastic network interface, not an Amazon EC2 instance.Type: Array of LoadBalancer objects
Required: No
- networkConfiguration
-
The network configuration for the service. This parameter is required for task definitions that use the
awsvpc
network mode to receive their own elastic network interface, and it isn't supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.Type: NetworkConfiguration object
Required: No
- placementConstraints
-
An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.
Type: Array of PlacementConstraint objects
Required: No
- placementStrategy
-
The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.
Type: Array of PlacementStrategy objects
Required: No
- platformVersion
-
The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the
LATEST
platform version is used. For more information, see Amazon Fargate platform versions in the Amazon Elastic Container Service Developer Guide.Type: String
Required: No
- propagateTags
-
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
You must set this to a value other than
NONE
when you use Cost Explorer. For more information, see Amazon ECS usage reports in the Amazon Elastic Container Service Developer Guide.The default is
NONE
.Type: String
Valid Values:
TASK_DEFINITION | SERVICE | NONE
Required: No
- role
-
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 doesn't use the
awsvpc
network mode. If you specify therole
parameter, you must also specify a load balancer object with theloadBalancers
parameter.Important
If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the
awsvpc
network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.If your specified role has a path other than
/
, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the namebar
has a path of/foo/
then you would specify/foo/bar
as the role name. For more information, see Friendly names and paths in the IAM User Guide.Type: String
Required: No
- schedulingStrategy
-
The scheduling strategy to use for the service. For more information, see Services.
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. This scheduler strategy is required if the service uses theCODE_DEPLOY
orEXTERNAL
deployment controller types. -
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. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.Note
Tasks using the Fargate launch type or the
CODE_DEPLOY
orEXTERNAL
deployment controller types don't support theDAEMON
scheduling strategy.
Type: String
Valid Values:
REPLICA | DAEMON
Required: No
-
- serviceConnectConfiguration
-
The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
Type: ServiceConnectConfiguration object
Required: No
- serviceName
-
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens 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.
Type: String
Required: Yes
- serviceRegistries
-
The details of the service discovery registry to associate with this service. For more information, see Service discovery.
Note
Each service may be associated with one service registry. Multiple service registries for each service isn't supported.
Type: Array of ServiceRegistry objects
Required: No
-
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.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
-
- taskDefinition
-
The
family
andrevision
(family:revision
) or full ARN of the task definition to run in your service. If arevision
isn't specified, the latestACTIVE
revision is used.A task definition must be specified if the service uses either the
ECS
orCODE_DEPLOY
deployment controllers.For more information about deployment types, see Amazon ECS deployment types.
Type: String
Required: No
- volumeConfigurations
-
The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.
Type: Array of ServiceVolumeConfiguration objects
Required: No
- vpcLatticeConfigurations
-
The VPC Lattice configuration for the service being created.
Type: Array of VpcLatticeConfiguration objects
Required: No
Response Syntax
{
"service": {
"availabilityZoneRebalancing": "string",
"capacityProviderStrategy": [
{
"base": number,
"capacityProvider": "string",
"weight": number
}
],
"clusterArn": "string",
"createdAt": number,
"createdBy": "string",
"deploymentConfiguration": {
"alarms": {
"alarmNames": [ "string" ],
"enable": boolean,
"rollback": boolean
},
"deploymentCircuitBreaker": {
"enable": boolean,
"rollback": boolean
},
"maximumPercent": number,
"minimumHealthyPercent": number
},
"deploymentController": {
"type": "string"
},
"deployments": [
{
"capacityProviderStrategy": [
{
"base": number,
"capacityProvider": "string",
"weight": number
}
],
"createdAt": number,
"desiredCount": number,
"failedTasks": number,
"fargateEphemeralStorage": {
"kmsKeyId": "string"
},
"id": "string",
"launchType": "string",
"networkConfiguration": {
"awsvpcConfiguration": {
"assignPublicIp": "string",
"securityGroups": [ "string" ],
"subnets": [ "string" ]
}
},
"pendingCount": number,
"platformFamily": "string",
"platformVersion": "string",
"rolloutState": "string",
"rolloutStateReason": "string",
"runningCount": number,
"serviceConnectConfiguration": {
"enabled": boolean,
"logConfiguration": {
"logDriver": "string",
"options": {
"string" : "string"
},
"secretOptions": [
{
"name": "string",
"valueFrom": "string"
}
]
},
"namespace": "string",
"services": [
{
"clientAliases": [
{
"dnsName": "string",
"port": number
}
],
"discoveryName": "string",
"ingressPortOverride": number,
"portName": "string",
"timeout": {
"idleTimeoutSeconds": number,
"perRequestTimeoutSeconds": number
},
"tls": {
"issuerCertificateAuthority": {
"awsPcaAuthorityArn": "string"
},
"kmsKey": "string",
"roleArn": "string"
}
}
]
},
"serviceConnectResources": [
{
"discoveryArn": "string",
"discoveryName": "string"
}
],
"status": "string",
"taskDefinition": "string",
"updatedAt": number,
"volumeConfigurations": [
{
"managedEBSVolume": {
"encrypted": boolean,
"filesystemType": "string",
"iops": number,
"kmsKeyId": "string",
"roleArn": "string",
"sizeInGiB": number,
"snapshotId": "string",
"tagSpecifications": [
{
"propagateTags": "string",
"resourceType": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
],
"throughput": number,
"volumeType": "string"
},
"name": "string"
}
],
"vpcLatticeConfigurations": [
{
"portName": "string",
"roleArn": "string",
"targetGroupArn": "string"
}
]
}
],
"desiredCount": number,
"enableECSManagedTags": boolean,
"enableExecuteCommand": boolean,
"events": [
{
"createdAt": number,
"id": "string",
"message": "string"
}
],
"healthCheckGracePeriodSeconds": number,
"launchType": "string",
"loadBalancers": [
{
"containerName": "string",
"containerPort": number,
"loadBalancerName": "string",
"targetGroupArn": "string"
}
],
"networkConfiguration": {
"awsvpcConfiguration": {
"assignPublicIp": "string",
"securityGroups": [ "string" ],
"subnets": [ "string" ]
}
},
"pendingCount": number,
"placementConstraints": [
{
"expression": "string",
"type": "string"
}
],
"placementStrategy": [
{
"field": "string",
"type": "string"
}
],
"platformFamily": "string",
"platformVersion": "string",
"propagateTags": "string",
"roleArn": "string",
"runningCount": number,
"schedulingStrategy": "string",
"serviceArn": "string",
"serviceName": "string",
"serviceRegistries": [
{
"containerName": "string",
"containerPort": number,
"port": number,
"registryArn": "string"
}
],
"status": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"taskDefinition": "string",
"taskSets": [
{
"capacityProviderStrategy": [
{
"base": number,
"capacityProvider": "string",
"weight": number
}
],
"clusterArn": "string",
"computedDesiredCount": number,
"createdAt": number,
"externalId": "string",
"fargateEphemeralStorage": {
"kmsKeyId": "string"
},
"id": "string",
"launchType": "string",
"loadBalancers": [
{
"containerName": "string",
"containerPort": number,
"loadBalancerName": "string",
"targetGroupArn": "string"
}
],
"networkConfiguration": {
"awsvpcConfiguration": {
"assignPublicIp": "string",
"securityGroups": [ "string" ],
"subnets": [ "string" ]
}
},
"pendingCount": number,
"platformFamily": "string",
"platformVersion": "string",
"runningCount": number,
"scale": {
"unit": "string",
"value": number
},
"serviceArn": "string",
"serviceRegistries": [
{
"containerName": "string",
"containerPort": number,
"port": number,
"registryArn": "string"
}
],
"stabilityStatus": "string",
"stabilityStatusAt": number,
"startedBy": "string",
"status": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"taskDefinition": "string",
"taskSetArn": "string",
"updatedAt": number
}
]
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- service
-
The full description of your service following the create call.
A service will return either a
capacityProviderStrategy
orlaunchType
parameter, but not both, depending where one was specified when it was created.If a service is using the
ECS
deployment controller, thedeploymentController
andtaskSets
parameters will not be returned.if the service uses the
CODE_DEPLOY
deployment controller, thedeploymentController
,taskSets
anddeployments
parameters will be returned, however thedeployments
parameter will be an empty list.Type: Service object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have authorization to perform the requested action.
HTTP Status Code: 400
- ClientException
-
These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.
The following list includes additional causes for the error:
-
The
RunTask
could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in thePROVISIONING
per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.
HTTP Status Code: 400
-
- ClusterNotFoundException
-
The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
HTTP Status Code: 400
- InvalidParameterException
-
The specified parameter isn't valid. Review the available parameters for the API request.
HTTP Status Code: 400
- NamespaceNotFoundException
-
The specified namespace wasn't found.
HTTP Status Code: 400
- PlatformTaskDefinitionIncompatibilityException
-
The specified platform version doesn't satisfy the required capabilities of the task definition.
HTTP Status Code: 400
- PlatformUnknownException
-
The specified platform version doesn't exist.
HTTP Status Code: 400
- ServerException
-
These errors are usually caused by a server issue.
HTTP Status Code: 500
- UnsupportedFeatureException
-
The specified task isn't supported in this Region.
HTTP Status Code: 400
Examples
In the following example or examples, the Authorization header contents
(AUTHPARAMS
) must be replaced with an Amazon Signature Version 4
signature. For more information, see Signature
Version 4 Signing Process in the
Amazon General
Reference.
You only need to learn how to sign HTTP requests if you intend to
create them manually. When you use the Amazon Command Line Interface
Example 1
This example API request creates a service in your default Region called
ecs-simple-service
. The service uses the ecs-demo
task definition and it maintains 10 instantiations of that task. It uses both
the FARGATE
and FARGATE_SPOT
capacity
providers.
Sample Request
POST / HTTP/1.1
Host: ecs.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 87
X-Amz-Target: AmazonEC2ContainerServiceV20141113.CreateService
X-Amz-Date: 20150429T170125Z
Content-Type: application/x-amz-json-1.1
Authorization: AUTHPARAMS
{
"serviceName": "ecs-simple-service",
"taskDefinition": "ecs-demo",
"desiredCount": 10,
"capacityProviderStrategy": [
{
"base": number,
"capacityProvider": "FARGATE",
"weight": 1
}
],
"capacityProviderStrategy": [
{
"base": number,
"capacityProvider": "FARGATE_SPOT",
"weight": 1
}
]
}
Sample Response
HTTP/1.1 200 OK
Server: Server
Date: Wed, 29 Apr 2015 17:01:27 GMT
Content-Type: application/x-amz-json-1.1
Content-Length: 636
Connection: keep-alive
x-amzn-RequestId: 123a4b56-7c89-01d2-3ef4-example5678f
{
"service": {
"clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/default",
"deploymentConfiguration": {
"maximumPercent": 200,
"minimumHealthyPercent": 100
},
"deployments": [
{
"createdAt": 1430326887.362,
"desiredCount": 10,
"id": "ecs-svc/9223370606527888445",
"pendingCount": 0,
"runningCount": 0,
"status": "PRIMARY",
"taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/ecs-demo:1",
"updatedAt": 1430326887.362
}
],
"capacityProviderStrategy": [
{
"capacityProvider": "FARGATE",
"weight": 1,
"base": 0
},
{
"capacityProvider": "FARGATE_SPOT",
"weight": 1,
"base": 0
}
],
"desiredCount": 10,
"events": [],
"loadBalancers": [],
"pendingCount": 0,
"runningCount": 0,
"serviceArn": "arn:aws:ecs:us-east-1:012345678910:service/default/ecs-simple-service",
"serviceName": "ecs-simple-service",
"status": "ACTIVE",
"taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/ecs-demo:1"
}
}
Example 2
This example API request creates a service with multiple load balancer target groups.
Sample Request
POST / HTTP/1.1
Host: ecs.us-east-1.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonEC2ContainerServiceV20141113.CreateService
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.16.190 Python/3.6.1 Darwin/16.7.0 botocore/1.12.180
X-Amz-Date: 20190723T001203Z
Authorization: AUTHPARAMS
Content-Length: 453
{
"serviceName":"ecs-multiplealb-service",
"taskDefinition":"ecs-multiplealb-demo",
"loadBalancers":[
{
"targetGroupArn":"arn:aws:elasticloadbalancing:us-east-1:012345678910:targetgroup/tg1/18ce32cc074018ed",
"containerName":"simple-app",
"containerPort":80
},
{
"targetGroupArn":"arn:aws:elasticloadbalancing:us-east-1:012345678910:targetgroup/tg2/737bead11d516e2a",
"containerName":"simple-app",
"containerPort":8080
}
],
"desiredCount":10
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: 123a4b56-7c89-01d2-3ef4-example5678f
Content-Type: application/x-amz-json-1.1
Content-Length: 1440
Date: Tue, 23 Jul 2019 00:12:03 GMT
Connection: keep-alive
{
"service": {
"serviceArn": "arn:aws:ecs:us-east-1:012345678910:service/default/ecs-multiplealb-service",
"serviceName": "ecs-multiplealb-service",
"clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/default",
"loadBalancers": [
{
"targetGroupArn": "arn:aws:elasticloadbalancing:us-east-1:012345678910:targetgroup/tg1/18ce32cc074018ed",
"containerName": "simple-app",
"containerPort": 80
},
{
"targetGroupArn": "arn:aws:elasticloadbalancing:us-east-1:012345678910:targetgroup/tg2/737bead11d516e2a",
"containerName": "simple-app",
"containerPort": 8080
}
],
"serviceRegistries": [],
"status": "ACTIVE",
"desiredCount": 10,
"runningCount": 0,
"pendingCount": 0,
"launchType": "EC2",
"taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/ecs-multiplealb-demo",
"deploymentConfiguration": {
"maximumPercent": 200,
"minimumHealthyPercent": 100
},
"deployments": [
{
"id": "ecs-svc/9223370473014051517",
"status": "PRIMARY",
"taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/ecs-multiplealb-demo",
"desiredCount": 10,
"pendingCount": 0,
"runningCount": 0,
"createdAt": 1563840724.29,
"updatedAt": 1563840724.29,
"launchType": "EC2"
}
],
"roleArn": "arn:aws:iam::012345678910:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS",
"events": [],
"createdAt": 1563840724.29,
"placementConstraints": [],
"placementStrategy": [],
"healthCheckGracePeriodSeconds": 0,
"schedulingStrategy": "REPLICA",
"enableECSManagedTags": false,
"propagateTags": "NONE"
}
}
Example 3
This example API request creates a service with a strategy that distributes tasks evenly across Availability Zones and then bin packs tasks based on memory within each Availability Zone.
Sample Request
POST / HTTP/1.1
Host: ecs.us-east-1.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: AmazonEC2ContainerServiceV20141113.CreateService
Content-Type: application/x-amz-json-1.1
User-Agent: aws-cli/1.16.190 Python/3.6.1 Darwin/16.7.0 botocore/1.12.180
X-Amz-Date: 20190723T001203Z
Authorization: AUTHPARAMS
Content-Length: 453
{
"serviceName":"example-placement1",
"taskDefinition":"windows-simple-iis",
"placementStrategy": [
{
"field": "attribute:ecs.availability-zone",
"type": "spread"
},
{
"field": "memory",
"type": "binpack"
}
]
"desiredCount":3
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: 123a4b56-7c89-01d2-3ef4-example5678f
Content-Type: application/x-amz-json-1.1
Content-Length: 1440
Date: Tue, 23 Jul 2019 00:12:03 GMT
Connection: keep-alive
{
"service": {
"serviceArn": "arn:aws:ecs:us-east-1:123456789012:service/windows-ec2/default/example-placement1",
"serviceName": "example-placement1",
"clusterArn": "arn:aws:ecs:us-east-1:123456789012:cluster/windows-ec2",
"loadBalancers": [],
"serviceRegistries": [],
"status": "ACTIVE",
"desiredCount": 3,
"runningCount": 0,
"pendingCount": 0,
"launchType": "EC2",
"taskDefinition": "arn:aws:ecs:us-east-1:123456789012:task-definition/windows-simple-iis:2",
"deploymentConfiguration": {
"deploymentCircuitBreaker": {
"enable": false,
"rollback": false
},
"maximumPercent": 200,
"minimumHealthyPercent": 100
},
"deployments": [
{
"id": "ecs-svc/409552086333EXAMPLE",
"status": "PRIMARY",
"taskDefinition": "arn:aws:ecs:us-east-1:123456789012:task-definition/windows-simple-iis:2",
"desiredCount": 3,
"pendingCount": 0,
"runningCount": 0,
"failedTasks": 0,
"createdAt": "2022-07-21T15:06:08.787000-04:00",
"updatedAt": "2022-07-21T15:06:08.787000-04:00",
"launchType": "EC2",
"rolloutState": "IN_PROGRESS",
"rolloutStateReason": "ECS deployment ecs-svc/409552086333EXAMPLE in progress."
}
],
"events": [],
"createdAt": "2022-07-21T15:06:08.787000-04:00",
"placementConstraints": [],
"placementStrategy": [
{
"type": "spread",
"field": "attribute:ecs.availability-zone"
},
{
"type": "binpack",
"field": "MEMORY"
}
],
"schedulingStrategy": "REPLICA",
"createdBy": "arn:aws:iam::123456789012:user/johndoe",
"enableECSManagedTags": false,
"propagateTags": "NONE",
"enableExecuteCommand": false
}
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: