Amazon EC2 Container Service 2014-11-13
- Client: Aws\Ecs\EcsClient
- Service ID: ecs
- Version: 2014-11-13
This page describes the parameters and results for the operations of the Amazon EC2 Container Service (2014-11-13), and shows how to use the Aws\Ecs\EcsClient object to call the described operations. This documentation is specific to the 2014-11-13 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- CreateCapacityProvider ( array $params = [] )
Creates a new capacity provider.
- CreateCluster ( array $params = [] )
Creates a new Amazon ECS cluster.
- CreateService ( array $params = [] )
Runs and maintains a desired number of tasks from a specified task definition.
- CreateTaskSet ( array $params = [] )
Create a task set in the specified cluster and service.
- DeleteAccountSetting ( array $params = [] )
Disables an account setting for a specified IAM user, IAM role, or the root user for an account.
- DeleteAttributes ( array $params = [] )
Deletes one or more custom attributes from an Amazon ECS resource.
- DeleteCapacityProvider ( array $params = [] )
Deletes the specified capacity provider.
- DeleteCluster ( array $params = [] )
Deletes the specified cluster.
- DeleteService ( array $params = [] )
Deletes a specified service within a cluster.
- DeleteTaskSet ( array $params = [] )
Deletes a specified task set within a service.
- DeregisterContainerInstance ( array $params = [] )
Deregisters an Amazon ECS container instance from the specified cluster.
- DeregisterTaskDefinition ( array $params = [] )
Deregisters the specified task definition by family and revision.
- DescribeCapacityProviders ( array $params = [] )
Describes one or more of your capacity providers.
- DescribeClusters ( array $params = [] )
Describes one or more of your clusters.
- DescribeContainerInstances ( array $params = [] )
Describes Amazon Elastic Container Service container instances.
- DescribeServices ( array $params = [] )
Describes the specified services running in your cluster.
- DescribeTaskDefinition ( array $params = [] )
Describes a task definition.
- DescribeTaskSets ( array $params = [] )
Describes the task sets in the specified cluster and service.
- DescribeTasks ( array $params = [] )
Describes a specified task or tasks.
- DiscoverPollEndpoint ( array $params = [] )
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
- ExecuteCommand ( array $params = [] )
Runs a command remotely on a container within a task.
- ListAccountSettings ( array $params = [] )
Lists the account settings for a specified principal.
- ListAttributes ( array $params = [] )
Lists the attributes for Amazon ECS resources within a specified target type and cluster.
- ListClusters ( array $params = [] )
Returns a list of existing clusters.
- ListContainerInstances ( array $params = [] )
Returns a list of container instances in a specified cluster.
- ListServices ( array $params = [] )
Lists the services that are running in a specified cluster.
- ListTagsForResource ( array $params = [] )
List the tags for an Amazon ECS resource.
- ListTaskDefinitionFamilies ( array $params = [] )
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).
- ListTaskDefinitions ( array $params = [] )
Returns a list of task definitions that are registered to your account.
- ListTasks ( array $params = [] )
Returns a list of tasks for a specified cluster.
- PutAccountSetting ( array $params = [] )
Modifies an account setting.
- PutAccountSettingDefault ( array $params = [] )
Modifies an account setting for all IAM users on an account for whom no individual account setting has been specified.
- PutAttributes ( array $params = [] )
Create or update an attribute on an Amazon ECS resource.
- PutClusterCapacityProviders ( array $params = [] )
Modifies the available capacity providers and the default capacity provider strategy for a cluster.
- RegisterContainerInstance ( array $params = [] )
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
- RegisterTaskDefinition ( array $params = [] )
Registers a new task definition from the supplied family and containerDefinitions.
- RunTask ( array $params = [] )
Starts a new task using the specified task definition.
- StartTask ( array $params = [] )
Starts a new task from the specified task definition on the specified container instance or instances.
- StopTask ( array $params = [] )
Stops a running task.
- SubmitAttachmentStateChanges ( array $params = [] )
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
- SubmitContainerStateChange ( array $params = [] )
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
- SubmitTaskStateChange ( array $params = [] )
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
- TagResource ( array $params = [] )
Associates the specified tags to a resource with the specified resourceArn.
- UntagResource ( array $params = [] )
Deletes specified tags from a resource.
- UpdateCapacityProvider ( array $params = [] )
Modifies the parameters for a capacity provider.
- UpdateCluster ( array $params = [] )
Updates the cluster.
- UpdateClusterSettings ( array $params = [] )
Modifies the settings to use for a cluster.
- UpdateContainerAgent ( array $params = [] )
Updates the Amazon ECS container agent on a specified container instance.
- UpdateContainerInstancesState ( array $params = [] )
Modifies the status of an Amazon ECS container instance.
- UpdateService ( array $params = [] )
Updating the task placement strategies and constraints on an Amazon ECS service remains in preview and is a Beta Service as defined by and subject to the Beta Service Participation Service Terms located at https://aws.
- UpdateServicePrimaryTaskSet ( array $params = [] )
Modifies which task set in a service is the primary task set.
- UpdateTaskSet ( array $params = [] )
Modifies a task set.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Waiters
Waiters allow you to poll a resource until it enters into a desired state. A waiter has a name used to describe what it does, and is associated with an API operation. When creating a waiter, you can provide the API operation parameters associated with the corresponding operation. Waiters can be accessed using the getWaiter($waiterName, $operationParameters) method of a client object. This client supports the following waiters:
Waiter name | API Operation | Delay | Max Attempts |
---|---|---|---|
TasksRunning | DescribeTasks | 6 | 100 |
TasksStopped | DescribeTasks | 6 | 100 |
ServicesStable | DescribeServices | 15 | 40 |
ServicesInactive | DescribeServices | 15 | 40 |
Operations
CreateCapacityProvider
$result = $client->createCapacityProvider
([/* ... */]); $promise = $client->createCapacityProviderAsync
([/* ... */]);
Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used in capacity provider strategies to facilitate cluster auto scaling.
Only capacity providers using an Auto Scaling group can be created. Amazon ECS tasks on AWS Fargate use the FARGATE
and FARGATE_SPOT
capacity providers which are already created and available to all accounts in Regions supported by AWS Fargate.
Parameter Syntax
$result = $client->createCapacityProvider([ 'autoScalingGroupProvider' => [ // REQUIRED 'autoScalingGroupArn' => '<string>', // REQUIRED 'managedScaling' => [ 'instanceWarmupPeriod' => <integer>, 'maximumScalingStepSize' => <integer>, 'minimumScalingStepSize' => <integer>, 'status' => 'ENABLED|DISABLED', 'targetCapacity' => <integer>, ], 'managedTerminationProtection' => 'ENABLED|DISABLED', ], 'name' => '<string>', // REQUIRED 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- autoScalingGroupProvider
-
- Required: Yes
- Type: AutoScalingGroupProvider structure
The details of the Auto Scaling group for the capacity provider.
- name
-
- Required: Yes
- Type: string
The name of the capacity provider. Up to 255 characters are allowed, including letters (upper and lowercase), numbers, underscores, and hyphens. The name cannot be prefixed with "
aws
", "ecs
", or "fargate
". - tags
-
- Type: Array of Tag structures
The metadata that you apply to the capacity provider to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
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 AWS 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.
Result Syntax
[ 'capacityProvider' => [ 'autoScalingGroupProvider' => [ 'autoScalingGroupArn' => '<string>', 'managedScaling' => [ 'instanceWarmupPeriod' => <integer>, 'maximumScalingStepSize' => <integer>, 'minimumScalingStepSize' => <integer>, 'status' => 'ENABLED|DISABLED', 'targetCapacity' => <integer>, ], 'managedTerminationProtection' => 'ENABLED|DISABLED', ], 'capacityProviderArn' => '<string>', 'name' => '<string>', 'status' => 'ACTIVE|INACTIVE', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'updateStatus' => 'DELETE_IN_PROGRESS|DELETE_COMPLETE|DELETE_FAILED|UPDATE_IN_PROGRESS|UPDATE_COMPLETE|UPDATE_FAILED', 'updateStatusReason' => '<string>', ], ]
Result Details
Members
- capacityProvider
-
- Type: CapacityProvider structure
The full description of the new capacity provider.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
The limit for the resource has been exceeded.
-
There is already a current Amazon ECS container agent update in progress on the specified container instance. If the container agent becomes disconnected while it is in a transitional stage, such as
PENDING
orSTAGING
, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.
CreateCluster
$result = $client->createCluster
([/* ... */]); $promise = $client->createClusterAsync
([/* ... */]);
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 Amazon ECS 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.
Parameter Syntax
$result = $client->createCluster([ 'capacityProviders' => ['<string>', ...], 'clusterName' => '<string>', 'configuration' => [ 'executeCommandConfiguration' => [ 'kmsKeyId' => '<string>', 'logConfiguration' => [ 'cloudWatchEncryptionEnabled' => true || false, 'cloudWatchLogGroupName' => '<string>', 's3BucketName' => '<string>', 's3EncryptionEnabled' => true || false, 's3KeyPrefix' => '<string>', ], 'logging' => 'NONE|DEFAULT|OVERRIDE', ], ], 'defaultCapacityProviderStrategy' => [ [ 'base' => <integer>, 'capacityProvider' => '<string>', // REQUIRED 'weight' => <integer>, ], // ... ], 'settings' => [ [ 'name' => 'containerInsights', 'value' => '<string>', ], // ... ], 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- capacityProviders
-
- Type: Array of strings
The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the CreateService or RunTask actions.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the
FARGATE
orFARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
- clusterName
-
- Type: string
The name of your cluster. If you do not specify a name for your cluster, you create a cluster named
default
. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. - configuration
-
- Type: ClusterConfiguration structure
The execute command configuration for the cluster.
- defaultCapacityProviderStrategy
-
- Type: Array of CapacityProviderStrategyItem structures
The capacity provider strategy to set as the default for the cluster. When a default capacity provider strategy is set for a cluster, when calling the RunTask or CreateService APIs wtih no capacity provider strategy or launch type specified, the default capacity provider strategy for the cluster is used.
If a default capacity provider strategy is not defined for a cluster during creation, it can be defined later with the PutClusterCapacityProviders API operation.
- settings
-
- Type: Array of ClusterSetting structures
The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the
containerInsights
value set with PutAccountSetting or PutAccountSettingDefault. - tags
-
- Type: Array of Tag structures
The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
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 AWS 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.
Result Syntax
[ 'cluster' => [ 'activeServicesCount' => <integer>, 'attachments' => [ [ 'details' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'id' => '<string>', 'status' => '<string>', 'type' => '<string>', ], // ... ], 'attachmentsStatus' => '<string>', 'capacityProviders' => ['<string>', ...], 'clusterArn' => '<string>', 'clusterName' => '<string>', 'configuration' => [ 'executeCommandConfiguration' => [ 'kmsKeyId' => '<string>', 'logConfiguration' => [ 'cloudWatchEncryptionEnabled' => true || false, 'cloudWatchLogGroupName' => '<string>', 's3BucketName' => '<string>', 's3EncryptionEnabled' => true || false, 's3KeyPrefix' => '<string>', ], 'logging' => 'NONE|DEFAULT|OVERRIDE', ], ], 'defaultCapacityProviderStrategy' => [ [ 'base' => <integer>, 'capacityProvider' => '<string>', 'weight' => <integer>, ], // ... ], 'pendingTasksCount' => <integer>, 'registeredContainerInstancesCount' => <integer>, 'runningTasksCount' => <integer>, 'settings' => [ [ 'name' => 'containerInsights', 'value' => '<string>', ], // ... ], 'statistics' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'status' => '<string>', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], ], ]
Result Details
Members
- cluster
-
- Type: Cluster structure
The full description of your new cluster.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
Examples
Example 1: To create a new cluster
This example creates a cluster in your default region.
$result = $client->createCluster([ 'clusterName' => 'my_cluster', ]);
Result syntax:
[ 'cluster' => [ 'activeServicesCount' => 0, 'clusterArn' => 'arn:aws:ecs:us-east-1:012345678910:cluster/my_cluster', 'clusterName' => 'my_cluster', 'pendingTasksCount' => 0, 'registeredContainerInstancesCount' => 0, 'runningTasksCount' => 0, 'status' => 'ACTIVE', ], ]
CreateService
$result = $client->createService
([/* ... */]); $promise = $client->createServiceAsync
([/* ... */]);
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 runs another copy of the task in the specified cluster. To update an existing service, see the UpdateService action.
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.
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. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that do not 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 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:
-
Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).
-
By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy) with the
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.
-
Parameter Syntax
$result = $client->createService([ 'capacityProviderStrategy' => [ [ 'base' => <integer>, 'capacityProvider' => '<string>', // REQUIRED 'weight' => <integer>, ], // ... ], 'clientToken' => '<string>', 'cluster' => '<string>', 'deploymentConfiguration' => [ 'deploymentCircuitBreaker' => [ 'enable' => true || false, // REQUIRED 'rollback' => true || false, // REQUIRED ], 'maximumPercent' => <integer>, 'minimumHealthyPercent' => <integer>, ], 'deploymentController' => [ 'type' => 'ECS|CODE_DEPLOY|EXTERNAL', // REQUIRED ], 'desiredCount' => <integer>, 'enableECSManagedTags' => true || false, 'enableExecuteCommand' => true || false, 'healthCheckGracePeriodSeconds' => <integer>, 'launchType' => 'EC2|FARGATE', 'loadBalancers' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'loadBalancerName' => '<string>', 'targetGroupArn' => '<string>', ], // ... ], 'networkConfiguration' => [ 'awsvpcConfiguration' => [ 'assignPublicIp' => 'ENABLED|DISABLED', 'securityGroups' => ['<string>', ...], 'subnets' => ['<string>', ...], // REQUIRED ], ], 'placementConstraints' => [ [ 'expression' => '<string>', 'type' => 'distinctInstance|memberOf', ], // ... ], 'placementStrategy' => [ [ 'field' => '<string>', 'type' => 'random|spread|binpack', ], // ... ], 'platformVersion' => '<string>', 'propagateTags' => 'TASK_DEFINITION|SERVICE', 'role' => '<string>', 'schedulingStrategy' => 'REPLICA|DAEMON', 'serviceName' => '<string>', // REQUIRED 'serviceRegistries' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'port' => <integer>, 'registryArn' => '<string>', ], // ... ], 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'taskDefinition' => '<string>', ]);
Parameter Details
Members
- capacityProviderStrategy
-
- Type: Array of CapacityProviderStrategyItem structures
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. - clientToken
-
- Type: string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
- cluster
-
- Type: string
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed.
- deploymentConfiguration
-
- Type: DeploymentConfiguration structure
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
- deploymentController
-
- Type: DeploymentController structure
The deployment controller to use for the service.
- desiredCount
-
- Type: int
The number of instantiations of the specified task definition to place and keep running on your cluster.
This is required if
schedulingStrategy
isREPLICA
or is not specified. IfschedulingStrategy
isDAEMON
then this is not required. - enableECSManagedTags
-
- Type: boolean
Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
- enableExecuteCommand
-
- Type: boolean
Whether or not the execute command functionality is enabled for the service. If
true
, this enables execute command functionality on all containers in the service tasks. - healthCheckGracePeriodSeconds
-
- Type: int
The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of
0
is used.If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. 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.
- launchType
-
- Type: string
The launch type on which to run your service. The accepted values are
FARGATE
andEC2
. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.When a value of
FARGATE
is specified, your tasks are launched on AWS Fargate On-Demand infrastructure. To use Fargate Spot, you must use a capacity provider strategy with theFARGATE_SPOT
capacity provider.When a value of
EC2
is specified, your tasks are launched on Amazon EC2 instances registered to your cluster.If a
launchType
is specified, thecapacityProviderStrategy
parameter must be omitted. - loadBalancers
-
- Type: Array of LoadBalancer structures
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 is using 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 make use of 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 is using the
CODE_DEPLOY
deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as atargetGroupPair
). During a deployment, AWS CodeDeploy determines which task set in your service has the statusPRIMARY
and associates one target group with it, and then 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 allows you perform validation tests with Lambda functions before routing production traffic to it.After you create a service using the
ECS
deployment controller, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable. If you are using theCODE_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 (as it appears in a container definition), and the container port to access from the load balancer. 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 specified here.
For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. 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 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 are not supported. Also, when you create any target groups for these services, you must chooseip
as the target type, notinstance
, because tasks that use theawsvpc
network mode are associated with an elastic network interface, not an Amazon EC2 instance. - networkConfiguration
-
- Type: NetworkConfiguration structure
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 is not supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide. - placementConstraints
-
- Type: Array of PlacementConstraint structures
An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
- placementStrategy
-
- Type: Array of PlacementStrategy structures
The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service.
- platformVersion
-
- Type: string
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 by default. For more information, see AWS Fargate platform versions in the Amazon Elastic Container Service Developer Guide. - propagateTags
-
- Type: string
Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource API action.
- role
-
- Type: string
The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the
awsvpc
network mode. If you specify therole
parameter, you must also specify a load balancer object with theloadBalancers
parameter.If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the
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 should not 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. - schedulingStrategy
-
- Type: string
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 is using 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 do not 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.Tasks using the Fargate launch type or the
CODE_DEPLOY
orEXTERNAL
deployment controller types don't support theDAEMON
scheduling strategy.
- serviceName
-
- Required: Yes
- Type: string
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, 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.
- serviceRegistries
-
- Type: Array of ServiceRegistry structures
The details of the service discovery registries to assign to this service. For more information, see Service discovery.
Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate platform versions.
- tags
-
- Type: Array of Tag structures
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 AWS 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.
- taskDefinition
-
- Type: string
The
family
andrevision
(family:revision
) or full ARN of the task definition to run in your service. If arevision
is not specified, the latestACTIVE
revision is used.A task definition must be specified if the service is using either the
ECS
orCODE_DEPLOY
deployment controllers.
Result Syntax
[ 'service' => [ 'capacityProviderStrategy' => [ [ 'base' => <integer>, 'capacityProvider' => '<string>', 'weight' => <integer>, ], // ... ], 'clusterArn' => '<string>', 'createdAt' => <DateTime>, 'createdBy' => '<string>', 'deploymentConfiguration' => [ 'deploymentCircuitBreaker' => [ 'enable' => true || false, 'rollback' => true || false, ], 'maximumPercent' => <integer>, 'minimumHealthyPercent' => <integer>, ], 'deploymentController' => [ 'type' => 'ECS|CODE_DEPLOY|EXTERNAL', ], 'deployments' => [ [ 'capacityProviderStrategy' => [ [ 'base' => <integer>, 'capacityProvider' => '<string>', 'weight' => <integer>, ], // ... ], 'createdAt' => <DateTime>, 'desiredCount' => <integer>, 'failedTasks' => <integer>, 'id' => '<string>', 'launchType' => 'EC2|FARGATE', 'networkConfiguration' => [ 'awsvpcConfiguration' => [ 'assignPublicIp' => 'ENABLED|DISABLED', 'securityGroups' => ['<string>', ...], 'subnets' => ['<string>', ...], ], ], 'pendingCount' => <integer>, 'platformVersion' => '<string>', 'rolloutState' => 'COMPLETED|FAILED|IN_PROGRESS', 'rolloutStateReason' => '<string>', 'runningCount' => <integer>, 'status' => '<string>', 'taskDefinition' => '<string>', 'updatedAt' => <DateTime>, ], // ... ], 'desiredCount' => <integer>, 'enableECSManagedTags' => true || false, 'enableExecuteCommand' => true || false, 'events' => [ [ 'createdAt' => <DateTime>, 'id' => '<string>', 'message' => '<string>', ], // ... ], 'healthCheckGracePeriodSeconds' => <integer>, 'launchType' => 'EC2|FARGATE', 'loadBalancers' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'loadBalancerName' => '<string>', 'targetGroupArn' => '<string>', ], // ... ], 'networkConfiguration' => [ 'awsvpcConfiguration' => [ 'assignPublicIp' => 'ENABLED|DISABLED', 'securityGroups' => ['<string>', ...], 'subnets' => ['<string>', ...], ], ], 'pendingCount' => <integer>, 'placementConstraints' => [ [ 'expression' => '<string>', 'type' => 'distinctInstance|memberOf', ], // ... ], 'placementStrategy' => [ [ 'field' => '<string>', 'type' => 'random|spread|binpack', ], // ... ], 'platformVersion' => '<string>', 'propagateTags' => 'TASK_DEFINITION|SERVICE', 'roleArn' => '<string>', 'runningCount' => <integer>, 'schedulingStrategy' => 'REPLICA|DAEMON', 'serviceArn' => '<string>', 'serviceName' => '<string>', 'serviceRegistries' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'port' => <integer>, 'registryArn' => '<string>', ], // ... ], 'status' => '<string>', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'taskDefinition' => '<string>', 'taskSets' => [ [ 'capacityProviderStrategy' => [ [ 'base' => <integer>, 'capacityProvider' => '<string>', 'weight' => <integer>, ], // ... ], 'clusterArn' => '<string>', 'computedDesiredCount' => <integer>, 'createdAt' => <DateTime>, 'externalId' => '<string>', 'id' => '<string>', 'launchType' => 'EC2|FARGATE', 'loadBalancers' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'loadBalancerName' => '<string>', 'targetGroupArn' => '<string>', ], // ... ], 'networkConfiguration' => [ 'awsvpcConfiguration' => [ 'assignPublicIp' => 'ENABLED|DISABLED', 'securityGroups' => ['<string>', ...], 'subnets' => ['<string>', ...], ], ], 'pendingCount' => <integer>, 'platformVersion' => '<string>', 'runningCount' => <integer>, 'scale' => [ 'unit' => 'PERCENT', 'value' => <float>, ], 'serviceArn' => '<string>', 'serviceRegistries' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'port' => <integer>, 'registryArn' => '<string>', ], // ... ], 'stabilityStatus' => 'STEADY_STATE|STABILIZING', 'stabilityStatusAt' => <DateTime>, 'startedBy' => '<string>', 'status' => '<string>', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'taskDefinition' => '<string>', 'taskSetArn' => '<string>', 'updatedAt' => <DateTime>, ], // ... ], ], ]
Result Details
Members
- service
-
- Type: Service structure
The full description of your service following the create call.
If a service is using the
ECS
deployment controller, thedeploymentController
andtaskSets
parameters will not be returned.If the service is using the
CODE_DEPLOY
deployment controller, thedeploymentController
,taskSets
anddeployments
parameters will be returned, however thedeployments
parameter will be an empty list.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
-
The specified task is not supported in this Region.
-
The specified platform version does not exist.
-
PlatformTaskDefinitionIncompatibilityException:
The specified platform version does not satisfy the task definition's required capabilities.
-
You do not have authorization to perform the requested action.
Examples
Example 1: To create a new service
This example creates a service in your default region called ``ecs-simple-service``. The service uses the ``hello_world`` task definition and it maintains 10 copies of that task.
$result = $client->createService([ 'desiredCount' => 10, 'serviceName' => 'ecs-simple-service', 'taskDefinition' => 'hello_world', ]);
Result syntax:
[ 'service' => [ 'clusterArn' => 'arn:aws:ecs:us-east-1:012345678910:cluster/default', 'createdAt' =>, 'deploymentConfiguration' => [ 'maximumPercent' => 200, 'minimumHealthyPercent' => 100, ], 'deployments' => [ [ 'createdAt' => , 'desiredCount' => 10, 'id' => 'ecs-svc/9223370564342348388', 'pendingCount' => 0, 'runningCount' => 0, 'status' => 'PRIMARY', 'taskDefinition' => 'arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6', 'updatedAt' => , ], [ 'createdAt' => , 'desiredCount' => 0, 'id' => 'ecs-svc/9223370564343611322', 'pendingCount' => 0, 'runningCount' => 0, 'status' => 'ACTIVE', 'taskDefinition' => 'arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6', 'updatedAt' => , ], ], 'desiredCount' => 10, 'events' => [ ], 'loadBalancers' => [ ], 'pendingCount' => 0, 'runningCount' => 0, 'serviceArn' => 'arn:aws:ecs:us-east-1:012345678910:service/ecs-simple-service', 'serviceName' => 'ecs-simple-service', 'status' => 'ACTIVE', 'taskDefinition' => 'arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6', ], ]
Example 2: To create a new service behind a load balancer
This example creates a service in your default region called ``ecs-simple-service-elb``. The service uses the ``ecs-demo`` task definition and it maintains 10 copies of that task. You must reference an existing load balancer in the same region by its name.
$result = $client->createService([ 'desiredCount' => 10, 'loadBalancers' => [ [ 'containerName' => 'simple-app', 'containerPort' => 80, 'loadBalancerName' => 'EC2Contai-EcsElast-15DCDAURT3ZO2', ], ], 'role' => 'ecsServiceRole', 'serviceName' => 'ecs-simple-service-elb', 'taskDefinition' => 'console-sample-app-static', ]);
Result syntax:
[ 'service' => [ 'clusterArn' => 'arn:aws:ecs:us-east-1:012345678910:cluster/default', 'createdAt' =>, 'deploymentConfiguration' => [ 'maximumPercent' => 200, 'minimumHealthyPercent' => 100, ], 'deployments' => [ [ 'createdAt' => , 'desiredCount' => 10, 'id' => 'ecs-svc/9223370564343000923', 'pendingCount' => 0, 'runningCount' => 0, 'status' => 'PRIMARY', 'taskDefinition' => 'arn:aws:ecs:us-east-1:012345678910:task-definition/console-sample-app-static:6', 'updatedAt' => , ], ], 'desiredCount' => 10, 'events' => [ ], 'loadBalancers' => [ [ 'containerName' => 'simple-app', 'containerPort' => 80, 'loadBalancerName' => 'EC2Contai-EcsElast-15DCDAURT3ZO2', ], ], 'pendingCount' => 0, 'roleArn' => 'arn:aws:iam::012345678910:role/ecsServiceRole', 'runningCount' => 0, 'serviceArn' => 'arn:aws:ecs:us-east-1:012345678910:service/ecs-simple-service-elb', 'serviceName' => 'ecs-simple-service-elb', 'status' => 'ACTIVE', 'taskDefinition' => 'arn:aws:ecs:us-east-1:012345678910:task-definition/console-sample-app-static:6', ], ]
CreateTaskSet
$result = $client->createTaskSet
([/* ... */]); $promise = $client->createTaskSetAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->createTaskSet([ 'capacityProviderStrategy' => [ [ 'base' => <integer>, 'capacityProvider' => '<string>', // REQUIRED 'weight' => <integer>, ], // ... ], 'clientToken' => '<string>', 'cluster' => '<string>', // REQUIRED 'externalId' => '<string>', 'launchType' => 'EC2|FARGATE', 'loadBalancers' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'loadBalancerName' => '<string>', 'targetGroupArn' => '<string>', ], // ... ], 'networkConfiguration' => [ 'awsvpcConfiguration' => [ 'assignPublicIp' => 'ENABLED|DISABLED', 'securityGroups' => ['<string>', ...], 'subnets' => ['<string>', ...], // REQUIRED ], ], 'platformVersion' => '<string>', 'scale' => [ 'unit' => 'PERCENT', 'value' => <float>, ], 'service' => '<string>', // REQUIRED 'serviceRegistries' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'port' => <integer>, 'registryArn' => '<string>', ], // ... ], 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'taskDefinition' => '<string>', // REQUIRED ]);
Parameter Details
Members
- capacityProviderStrategy
-
- Type: Array of CapacityProviderStrategyItem structures
The capacity provider strategy to use for the task set.
A capacity provider strategy consists of one or more capacity providers along with the
base
andweight
to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with anACTIVE
orUPDATING
status can be used.If a
capacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
orlaunchType
is specified, thedefaultCapacityProviderStrategy
for the cluster is used.If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the
FARGATE
orFARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
- clientToken
-
- Type: string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.
- cluster
-
- Required: Yes
- Type: string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
- externalId
-
- Type: string
An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the
ECS_TASK_SET_EXTERNAL_ID
AWS Cloud Map attribute set to the provided value. - launchType
-
- Type: string
The launch type that new tasks in the task set will use. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
If a
launchType
is specified, thecapacityProviderStrategy
parameter must be omitted. - loadBalancers
-
- Type: Array of LoadBalancer structures
A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.
- networkConfiguration
-
- Type: NetworkConfiguration structure
An object representing the network configuration for a task or service.
- platformVersion
-
- Type: string
The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the
LATEST
platform version is used by default. - scale
-
- Type: Scale structure
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
- service
-
- Required: Yes
- Type: string
The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
- serviceRegistries
-
- Type: Array of ServiceRegistry structures
The details of the service discovery registries to assign to this task set. For more information, see Service Discovery.
- tags
-
- Type: Array of Tag structures
The metadata that you apply to the task set 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 AWS 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.
- taskDefinition
-
- Required: Yes
- Type: string
The task definition for the tasks in the task set to use.
Result Syntax
[ 'taskSet' => [ 'capacityProviderStrategy' => [ [ 'base' => <integer>, 'capacityProvider' => '<string>', 'weight' => <integer>, ], // ... ], 'clusterArn' => '<string>', 'computedDesiredCount' => <integer>, 'createdAt' => <DateTime>, 'externalId' => '<string>', 'id' => '<string>', 'launchType' => 'EC2|FARGATE', 'loadBalancers' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'loadBalancerName' => '<string>', 'targetGroupArn' => '<string>', ], // ... ], 'networkConfiguration' => [ 'awsvpcConfiguration' => [ 'assignPublicIp' => 'ENABLED|DISABLED', 'securityGroups' => ['<string>', ...], 'subnets' => ['<string>', ...], ], ], 'pendingCount' => <integer>, 'platformVersion' => '<string>', 'runningCount' => <integer>, 'scale' => [ 'unit' => 'PERCENT', 'value' => <float>, ], 'serviceArn' => '<string>', 'serviceRegistries' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'port' => <integer>, 'registryArn' => '<string>', ], // ... ], 'stabilityStatus' => 'STEADY_STATE|STABILIZING', 'stabilityStatusAt' => <DateTime>, 'startedBy' => '<string>', 'status' => '<string>', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'taskDefinition' => '<string>', 'taskSetArn' => '<string>', 'updatedAt' => <DateTime>, ], ]
Result Details
Members
- taskSet
-
- Type: TaskSet structure
Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an
EXTERNAL
deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
-
The specified task is not supported in this Region.
-
The specified platform version does not exist.
-
PlatformTaskDefinitionIncompatibilityException:
The specified platform version does not satisfy the task definition's required capabilities.
-
You do not have authorization to perform the requested action.
-
The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific.
-
The specified service is not active. You can't update a service that is inactive. If you have previously deleted a service, you can re-create it with CreateService.
DeleteAccountSetting
$result = $client->deleteAccountSetting
([/* ... */]); $promise = $client->deleteAccountSettingAsync
([/* ... */]);
Disables an account setting for a specified IAM user, IAM role, or the root user for an account.
Parameter Syntax
$result = $client->deleteAccountSetting([ 'name' => 'serviceLongArnFormat|taskLongArnFormat|containerInstanceLongArnFormat|awsvpcTrunking|containerInsights', // REQUIRED 'principalArn' => '<string>', ]);
Parameter Details
Members
- name
-
- Required: Yes
- Type: string
The resource name for which to disable the account setting. If
serviceLongArnFormat
is specified, the ARN for your Amazon ECS services is affected. IftaskLongArnFormat
is specified, the ARN and resource ID for your Amazon ECS tasks is affected. IfcontainerInstanceLongArnFormat
is specified, the ARN and resource ID for your Amazon ECS container instances is affected. IfawsvpcTrunking
is specified, the ENI limit for your Amazon ECS container instances is affected. - principalArn
-
- Type: string
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it disables the account setting for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.
Result Syntax
[ 'setting' => [ 'name' => 'serviceLongArnFormat|taskLongArnFormat|containerInstanceLongArnFormat|awsvpcTrunking|containerInsights', 'principalArn' => '<string>', 'value' => '<string>', ], ]
Result Details
Members
- setting
-
- Type: Setting structure
The account setting for the specified principal ARN.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
Examples
Example 1: To delete your account setting
This example deletes the account setting for your user for the specified resource type.
$result = $client->deleteAccountSetting([ 'name' => 'serviceLongArnFormat', ]);
Result syntax:
[ 'setting' => [ 'name' => 'serviceLongArnFormat', 'value' => 'enabled', 'principalArn' => 'arn:aws:iam:::user/principalName', ], ]
Example 2: To delete the account settings for a specific IAM user or IAM role
This example deletes the account setting for a specific IAM user or IAM role for the specified resource type. Only the root user can view or modify the account settings for another user.
$result = $client->deleteAccountSetting([ 'name' => 'containerInstanceLongArnFormat', 'principalArn' => 'arn:aws:iam:::user/principalName', ]);
Result syntax:
[ 'setting' => [ 'name' => 'containerInstanceLongArnFormat', 'value' => 'enabled', 'principalArn' => 'arn:aws:iam:::user/principalName', ], ]
DeleteAttributes
$result = $client->deleteAttributes
([/* ... */]); $promise = $client->deleteAttributesAsync
([/* ... */]);
Deletes one or more custom attributes from an Amazon ECS resource.
Parameter Syntax
$result = $client->deleteAttributes([ 'attributes' => [ // REQUIRED [ 'name' => '<string>', // REQUIRED 'targetId' => '<string>', 'targetType' => 'container-instance', 'value' => '<string>', ], // ... ], 'cluster' => '<string>', ]);
Parameter Details
Members
- attributes
-
- Required: Yes
- Type: Array of Attribute structures
The attributes to delete from your resource. You can specify up to 10 attributes per request. For custom attributes, specify the attribute name and target ID, but do not specify the value. If you specify the target ID using the short form, you must also specify the target type.
- cluster
-
- Type: string
The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete attributes. If you do not specify a cluster, the default cluster is assumed.
Result Syntax
[ 'attributes' => [ [ 'name' => '<string>', 'targetId' => '<string>', 'targetType' => 'container-instance', 'value' => '<string>', ], // ... ], ]
Result Details
Members
- attributes
-
- Type: Array of Attribute structures
A list of attribute objects that were successfully deleted from your resource.
Errors
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
-
The specified target could not be found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and Region-specific.
-
The specified parameter is invalid. Review the available parameters for the API request.
DeleteCapacityProvider
$result = $client->deleteCapacityProvider
([/* ... */]); $promise = $client->deleteCapacityProviderAsync
([/* ... */]);
Deletes the specified capacity provider.
The FARGATE
and FARGATE_SPOT
capacity providers are reserved and cannot be deleted. You can disassociate them from a cluster using either the PutClusterCapacityProviders API or by deleting the cluster.
Prior to a capacity provider being deleted, the capacity provider must be removed from the capacity provider strategy from all services. The UpdateService API can be used to remove a capacity provider from a service's capacity provider strategy. When updating a service, the forceNewDeployment
option can be used to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity provider are transitioned to use the capacity from the remaining capacity providers. Only capacity providers that are not associated with a cluster can be deleted. To remove a capacity provider from a cluster, you can either use PutClusterCapacityProviders or delete the cluster.
Parameter Syntax
$result = $client->deleteCapacityProvider([ 'capacityProvider' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'capacityProvider' => [ 'autoScalingGroupProvider' => [ 'autoScalingGroupArn' => '<string>', 'managedScaling' => [ 'instanceWarmupPeriod' => <integer>, 'maximumScalingStepSize' => <integer>, 'minimumScalingStepSize' => <integer>, 'status' => 'ENABLED|DISABLED', 'targetCapacity' => <integer>, ], 'managedTerminationProtection' => 'ENABLED|DISABLED', ], 'capacityProviderArn' => '<string>', 'name' => '<string>', 'status' => 'ACTIVE|INACTIVE', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'updateStatus' => 'DELETE_IN_PROGRESS|DELETE_COMPLETE|DELETE_FAILED|UPDATE_IN_PROGRESS|UPDATE_COMPLETE|UPDATE_FAILED', 'updateStatusReason' => '<string>', ], ]
Result Details
Members
- capacityProvider
-
- Type: CapacityProvider structure
The details of a capacity provider.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
DeleteCluster
$result = $client->deleteCluster
([/* ... */]); $promise = $client->deleteClusterAsync
([/* ... */]);
Deletes the specified cluster. The cluster will transition to the INACTIVE
state. Clusters with an INACTIVE
status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future, so you should not rely on INACTIVE
clusters persisting.
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.
Parameter Syntax
$result = $client->deleteCluster([ 'cluster' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'cluster' => [ 'activeServicesCount' => <integer>, 'attachments' => [ [ 'details' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'id' => '<string>', 'status' => '<string>', 'type' => '<string>', ], // ... ], 'attachmentsStatus' => '<string>', 'capacityProviders' => ['<string>', ...], 'clusterArn' => '<string>', 'clusterName' => '<string>', 'configuration' => [ 'executeCommandConfiguration' => [ 'kmsKeyId' => '<string>', 'logConfiguration' => [ 'cloudWatchEncryptionEnabled' => true || false, 'cloudWatchLogGroupName' => '<string>', 's3BucketName' => '<string>', 's3EncryptionEnabled' => true || false, 's3KeyPrefix' => '<string>', ], 'logging' => 'NONE|DEFAULT|OVERRIDE', ], ], 'defaultCapacityProviderStrategy' => [ [ 'base' => <integer>, 'capacityProvider' => '<string>', 'weight' => <integer>, ], // ... ], 'pendingTasksCount' => <integer>, 'registeredContainerInstancesCount' => <integer>, 'runningTasksCount' => <integer>, 'settings' => [ [ 'name' => 'containerInsights', 'value' => '<string>', ], // ... ], 'statistics' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'status' => '<string>', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], ], ]
Result Details
Members
- cluster
-
- Type: Cluster structure
The full description of the deleted cluster.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
-
ClusterContainsContainerInstancesException:
You cannot delete a cluster that has registered container instances. First, deregister the container instances before you can delete the cluster. For more information, see DeregisterContainerInstance.
-
ClusterContainsServicesException:
You cannot delete a cluster that contains services. First, update the service to reduce its desired task count to 0 and then delete the service. For more information, see UpdateService and DeleteService.
-
ClusterContainsTasksException:
You cannot delete a cluster that has active tasks.
-
There is already a current Amazon ECS container agent update in progress on the specified container instance. If the container agent becomes disconnected while it is in a transitional stage, such as
PENDING
orSTAGING
, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.
Examples
Example 1: To delete an empty cluster
This example deletes an empty cluster in your default region.
$result = $client->deleteCluster([ 'cluster' => 'my_cluster', ]);
Result syntax:
[ 'cluster' => [ 'activeServicesCount' => 0, 'clusterArn' => 'arn:aws:ecs:us-east-1:012345678910:cluster/my_cluster', 'clusterName' => 'my_cluster', 'pendingTasksCount' => 0, 'registeredContainerInstancesCount' => 0, 'runningTasksCount' => 0, 'status' => 'INACTIVE', ], ]
DeleteService
$result = $client->deleteService
([/* ... */]); $promise = $client->deleteServiceAsync
([/* ... */]);
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 all tasks have transitioned to either STOPPING
or STOPPED
status, 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.
Parameter Syntax
$result = $client->deleteService([ 'cluster' => '<string>', 'force' => true || false, 'service' => '<string>', // REQUIRED ]);
Parameter Details
Members
- cluster
-
- Type: string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed.
- force
-
- Type: boolean
If
true
, allows you to delete a service even if it has not been scaled down to zero tasks. It is only necessary to use this if the service is using theREPLICA
scheduling strategy. - service
-
- Required: Yes
- Type: string
The name of the service to delete.
Result Syntax
[ 'service' => [ 'capacityProviderStrategy' => [ [ 'base' => <integer>, 'capacityProvider' => '<string>', 'weight' => <integer>, ], // ... ], 'clusterArn' => '<string>', 'createdAt' => <DateTime>, 'createdBy' => '<string>', 'deploymentConfiguration' => [ 'deploymentCircuitBreaker' => [ 'enable' => true || false, 'rollback' => true || false, ], 'maximumPercent' => <integer>, 'minimumHealthyPercent' => <integer>, ], 'deploymentController' => [ 'type' => 'ECS|CODE_DEPLOY|EXTERNAL', ], 'deployments' => [ [ 'capacityProviderStrategy' => [ [ 'base' => <integer>, 'capacityProvider' => '<string>', 'weight' => <integer>, ], // ... ], 'createdAt' => <DateTime>, 'desiredCount' => <integer>, 'failedTasks' => <integer>, 'id' => '<string>', 'launchType' => 'EC2|FARGATE', 'networkConfiguration' => [ 'awsvpcConfiguration' => [ 'assignPublicIp' => 'ENABLED|DISABLED', 'securityGroups' => ['<string>', ...], 'subnets' => ['<string>', ...], ], ], 'pendingCount' => <integer>, 'platformVersion' => '<string>', 'rolloutState' => 'COMPLETED|FAILED|IN_PROGRESS', 'rolloutStateReason' => '<string>', 'runningCount' => <integer>, 'status' => '<string>', 'taskDefinition' => '<string>', 'updatedAt' => <DateTime>, ], // ... ], 'desiredCount' => <integer>, 'enableECSManagedTags' => true || false, 'enableExecuteCommand' => true || false, 'events' => [ [ 'createdAt' => <DateTime>, 'id' => '<string>', 'message' => '<string>', ], // ... ], 'healthCheckGracePeriodSeconds' => <integer>, 'launchType' => 'EC2|FARGATE', 'loadBalancers' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'loadBalancerName' => '<string>', 'targetGroupArn' => '<string>', ], // ... ], 'networkConfiguration' => [ 'awsvpcConfiguration' => [ 'assignPublicIp' => 'ENABLED|DISABLED', 'securityGroups' => ['<string>', ...], 'subnets' => ['<string>', ...], ], ], 'pendingCount' => <integer>, 'placementConstraints' => [ [ 'expression' => '<string>', 'type' => 'distinctInstance|memberOf', ], // ... ], 'placementStrategy' => [ [ 'field' => '<string>', 'type' => 'random|spread|binpack', ], // ... ], 'platformVersion' => '<string>', 'propagateTags' => 'TASK_DEFINITION|SERVICE', 'roleArn' => '<string>', 'runningCount' => <integer>, 'schedulingStrategy' => 'REPLICA|DAEMON', 'serviceArn' => '<string>', 'serviceName' => '<string>', 'serviceRegistries' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'port' => <integer>, 'registryArn' => '<string>', ], // ... ], 'status' => '<string>', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'taskDefinition' => '<string>', 'taskSets' => [ [ 'capacityProviderStrategy' => [ [ 'base' => <integer>, 'capacityProvider' => '<string>', 'weight' => <integer>, ], // ... ], 'clusterArn' => '<string>', 'computedDesiredCount' => <integer>, 'createdAt' => <DateTime>, 'externalId' => '<string>', 'id' => '<string>', 'launchType' => 'EC2|FARGATE', 'loadBalancers' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'loadBalancerName' => '<string>', 'targetGroupArn' => '<string>', ], // ... ], 'networkConfiguration' => [ 'awsvpcConfiguration' => [ 'assignPublicIp' => 'ENABLED|DISABLED', 'securityGroups' => ['<string>', ...], 'subnets' => ['<string>', ...], ], ], 'pendingCount' => <integer>, 'platformVersion' => '<string>', 'runningCount' => <integer>, 'scale' => [ 'unit' => 'PERCENT', 'value' => <float>, ], 'serviceArn' => '<string>', 'serviceRegistries' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'port' => <integer>, 'registryArn' => '<string>', ], // ... ], 'stabilityStatus' => 'STEADY_STATE|STABILIZING', 'stabilityStatusAt' => <DateTime>, 'startedBy' => '<string>', 'status' => '<string>', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'taskDefinition' => '<string>', 'taskSetArn' => '<string>', 'updatedAt' => <DateTime>, ], // ... ], ], ]
Result Details
Members
- service
-
- Type: Service structure
The full description of the deleted service.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
-
The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific.
Examples
Example 1: To delete a service
This example deletes the my-http-service service. The service must have a desired count and running count of 0 before you can delete it.
$result = $client->deleteService([ 'service' => 'my-http-service', ]);
Result syntax:
[ ]
DeleteTaskSet
$result = $client->deleteTaskSet
([/* ... */]); $promise = $client->deleteTaskSetAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->deleteTaskSet([ 'cluster' => '<string>', // REQUIRED 'force' => true || false, 'service' => '<string>', // REQUIRED 'taskSet' => '<string>', // REQUIRED ]);
Parameter Details
Members
- cluster
-
- Required: Yes
- Type: string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in to delete.
- force
-
- Type: boolean
If
true
, this allows you to delete a task set even if it hasn't been scaled down to zero. - service
-
- Required: Yes
- Type: string
The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to delete.
- taskSet
-
- Required: Yes
- Type: string
The task set ID or full Amazon Resource Name (ARN) of the task set to delete.
Result Syntax
[ 'taskSet' => [ 'capacityProviderStrategy' => [ [ 'base' => <integer>, 'capacityProvider' => '<string>', 'weight' => <integer>, ], // ... ], 'clusterArn' => '<string>', 'computedDesiredCount' => <integer>, 'createdAt' => <DateTime>, 'externalId' => '<string>', 'id' => '<string>', 'launchType' => 'EC2|FARGATE', 'loadBalancers' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'loadBalancerName' => '<string>', 'targetGroupArn' => '<string>', ], // ... ], 'networkConfiguration' => [ 'awsvpcConfiguration' => [ 'assignPublicIp' => 'ENABLED|DISABLED', 'securityGroups' => ['<string>', ...], 'subnets' => ['<string>', ...], ], ], 'pendingCount' => <integer>, 'platformVersion' => '<string>', 'runningCount' => <integer>, 'scale' => [ 'unit' => 'PERCENT', 'value' => <float>, ], 'serviceArn' => '<string>', 'serviceRegistries' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'port' => <integer>, 'registryArn' => '<string>', ], // ... ], 'stabilityStatus' => 'STEADY_STATE|STABILIZING', 'stabilityStatusAt' => <DateTime>, 'startedBy' => '<string>', 'status' => '<string>', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'taskDefinition' => '<string>', 'taskSetArn' => '<string>', 'updatedAt' => <DateTime>, ], ]
Result Details
Members
- taskSet
-
- Type: TaskSet structure
Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an
EXTERNAL
deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
-
The specified task is not supported in this Region.
-
You do not have authorization to perform the requested action.
-
The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific.
-
The specified service is not active. You can't update a service that is inactive. If you have previously deleted a service, you can re-create it with CreateService.
-
The specified task set could not be found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region.
DeregisterContainerInstance
$result = $client->deregisterContainerInstance
([/* ... */]); $promise = $client->deregisterContainerInstanceAsync
([/* ... */]);
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).
Parameter Syntax
$result = $client->deregisterContainerInstance([ 'cluster' => '<string>', 'containerInstance' => '<string>', // REQUIRED 'force' => true || false, ]);
Parameter Details
Members
- cluster
-
- Type: string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.
- containerInstance
-
- Required: Yes
- Type: string
The container instance ID or full ARN of the container instance to deregister. The ARN contains the
arn:aws:ecs
namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, thecontainer-instance
namespace, and then the container instance ID. For example,arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
. - force
-
- Type: boolean
Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the
force
option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group.
Result Syntax
[ 'containerInstance' => [ 'agentConnected' => true || false, 'agentUpdateStatus' => 'PENDING|STAGING|STAGED|UPDATING|UPDATED|FAILED', 'attachments' => [ [ 'details' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'id' => '<string>', 'status' => '<string>', 'type' => '<string>', ], // ... ], 'attributes' => [ [ 'name' => '<string>', 'targetId' => '<string>', 'targetType' => 'container-instance', 'value' => '<string>', ], // ... ], 'capacityProviderName' => '<string>', 'containerInstanceArn' => '<string>', 'ec2InstanceId' => '<string>', 'pendingTasksCount' => <integer>, 'registeredAt' => <DateTime>, 'registeredResources' => [ [ 'doubleValue' => <float>, 'integerValue' => <integer>, 'longValue' => <integer>, 'name' => '<string>', 'stringSetValue' => ['<string>', ...], 'type' => '<string>', ], // ... ], 'remainingResources' => [ [ 'doubleValue' => <float>, 'integerValue' => <integer>, 'longValue' => <integer>, 'name' => '<string>', 'stringSetValue' => ['<string>', ...], 'type' => '<string>', ], // ... ], 'runningTasksCount' => <integer>, 'status' => '<string>', 'statusReason' => '<string>', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'version' => <integer>, 'versionInfo' => [ 'agentHash' => '<string>', 'agentVersion' => '<string>', 'dockerVersion' => '<string>', ], ], ]
Result Details
Members
- containerInstance
-
- Type: ContainerInstance structure
The container instance that was deregistered.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
Examples
Example 1: To deregister a container instance from a cluster
This example deregisters a container instance from the specified cluster in your default region. If there are still tasks running on the container instance, you must either stop those tasks before deregistering, or use the force option.
$result = $client->deregisterContainerInstance([ 'cluster' => 'default', 'containerInstance' => 'container_instance_UUID', 'force' => 1, ]);
Result syntax:
[ ]
DeregisterTaskDefinition
$result = $client->deregisterTaskDefinition
([/* ... */]); $promise = $client->deregisterTaskDefinitionAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->deregisterTaskDefinition([ 'taskDefinition' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'taskDefinition' => [ 'compatibilities' => ['<string>', ...], 'containerDefinitions' => [ [ 'command' => ['<string>', ...], 'cpu' => <integer>, 'dependsOn' => [ [ 'condition' => 'START|COMPLETE|SUCCESS|HEALTHY', 'containerName' => '<string>', ], // ... ], 'disableNetworking' => true || false, 'dnsSearchDomains' => ['<string>', ...], 'dnsServers' => ['<string>', ...], 'dockerLabels' => ['<string>', ...], 'dockerSecurityOptions' => ['<string>', ...], 'entryPoint' => ['<string>', ...], 'environment' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'environmentFiles' => [ [ 'type' => 's3', 'value' => '<string>', ], // ... ], 'essential' => true || false, 'extraHosts' => [ [ 'hostname' => '<string>', 'ipAddress' => '<string>', ], // ... ], 'firelensConfiguration' => [ 'options' => ['<string>', ...], 'type' => 'fluentd|fluentbit', ], 'healthCheck' => [ 'command' => ['<string>', ...], 'interval' => <integer>, 'retries' => <integer>, 'startPeriod' => <integer>, 'timeout' => <integer>, ], 'hostname' => '<string>', 'image' => '<string>', 'interactive' => true || false, 'links' => ['<string>', ...], 'linuxParameters' => [ 'capabilities' => [ 'add' => ['<string>', ...], 'drop' => ['<string>', ...], ], 'devices' => [ [ 'containerPath' => '<string>', 'hostPath' => '<string>', 'permissions' => ['<string>', ...], ], // ... ], 'initProcessEnabled' => true || false, 'maxSwap' => <integer>, 'sharedMemorySize' => <integer>, 'swappiness' => <integer>, 'tmpfs' => [ [ 'containerPath' => '<string>', 'mountOptions' => ['<string>', ...], 'size' => <integer>, ], // ... ], ], 'logConfiguration' => [ 'logDriver' => 'json-file|syslog|journald|gelf|fluentd|awslogs|splunk|awsfirelens', 'options' => ['<string>', ...], 'secretOptions' => [ [ 'name' => '<string>', 'valueFrom' => '<string>', ], // ... ], ], 'memory' => <integer>, 'memoryReservation' => <integer>, 'mountPoints' => [ [ 'containerPath' => '<string>', 'readOnly' => true || false, 'sourceVolume' => '<string>', ], // ... ], 'name' => '<string>', 'portMappings' => [ [ 'containerPort' => <integer>, 'hostPort' => <integer>, 'protocol' => 'tcp|udp', ], // ... ], 'privileged' => true || false, 'pseudoTerminal' => true || false, 'readonlyRootFilesystem' => true || false, 'repositoryCredentials' => [ 'credentialsParameter' => '<string>', ], 'resourceRequirements' => [ [ 'type' => 'GPU|InferenceAccelerator', 'value' => '<string>', ], // ... ], 'secrets' => [ [ 'name' => '<string>', 'valueFrom' => '<string>', ], // ... ], 'startTimeout' => <integer>, 'stopTimeout' => <integer>, 'systemControls' => [ [ 'namespace' => '<string>', 'value' => '<string>', ], // ... ], 'ulimits' => [ [ 'hardLimit' => <integer>, 'name' => 'core|cpu|data|fsize|locks|memlock|msgqueue|nice|nofile|nproc|rss|rtprio|rttime|sigpending|stack', 'softLimit' => <integer>, ], // ... ], 'user' => '<string>', 'volumesFrom' => [ [ 'readOnly' => true || false, 'sourceContainer' => '<string>', ], // ... ], 'workingDirectory' => '<string>', ], // ... ], 'cpu' => '<string>', 'deregisteredAt' => <DateTime>, 'executionRoleArn' => '<string>', 'family' => '<string>', 'inferenceAccelerators' => [ [ 'deviceName' => '<string>', 'deviceType' => '<string>', ], // ... ], 'ipcMode' => 'host|task|none', 'memory' => '<string>', 'networkMode' => 'bridge|host|awsvpc|none', 'pidMode' => 'host|task', 'placementConstraints' => [ [ 'expression' => '<string>', 'type' => 'memberOf', ], // ... ], 'proxyConfiguration' => [ 'containerName' => '<string>', 'properties' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'type' => 'APPMESH', ], 'registeredAt' => <DateTime>, 'registeredBy' => '<string>', 'requiresAttributes' => [ [ 'name' => '<string>', 'targetId' => '<string>', 'targetType' => 'container-instance', 'value' => '<string>', ], // ... ], 'requiresCompatibilities' => ['<string>', ...], 'revision' => <integer>, 'status' => 'ACTIVE|INACTIVE', 'taskDefinitionArn' => '<string>', 'taskRoleArn' => '<string>', 'volumes' => [ [ 'dockerVolumeConfiguration' => [ 'autoprovision' => true || false, 'driver' => '<string>', 'driverOpts' => ['<string>', ...], 'labels' => ['<string>', ...], 'scope' => 'task|shared', ], 'efsVolumeConfiguration' => [ 'authorizationConfig' => [ 'accessPointId' => '<string>', 'iam' => 'ENABLED|DISABLED', ], 'fileSystemId' => '<string>', 'rootDirectory' => '<string>', 'transitEncryption' => 'ENABLED|DISABLED', 'transitEncryptionPort' => <integer>, ], 'fsxWindowsFileServerVolumeConfiguration' => [ 'authorizationConfig' => [ 'credentialsParameter' => '<string>', 'domain' => '<string>', ], 'fileSystemId' => '<string>', 'rootDirectory' => '<string>', ], 'host' => [ 'sourcePath' => '<string>', ], 'name' => '<string>', ], // ... ], ], ]
Result Details
Members
- taskDefinition
-
- Type: TaskDefinition structure
The full description of the deregistered task.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
DescribeCapacityProviders
$result = $client->describeCapacityProviders
([/* ... */]); $promise = $client->describeCapacityProvidersAsync
([/* ... */]);
Describes one or more of your capacity providers.
Parameter Syntax
$result = $client->describeCapacityProviders([ 'capacityProviders' => ['<string>', ...], 'include' => ['<string>', ...], 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- capacityProviders
-
- Type: Array of strings
The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to
100
capacity providers can be described in an action. - include
-
- Type: Array of strings
Specifies whether or not you want to see the resource tags for the capacity provider. If
TAGS
is specified, the tags are included in the response. If this field is omitted, tags are not included in the response. - maxResults
-
- Type: int
The maximum number of account setting results returned by
DescribeCapacityProviders
in paginated output. When this parameter is used,DescribeCapacityProviders
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeCapacityProviders
request with the returnednextToken
value. This value can be between 1 and 10. If this parameter is not used, thenDescribeCapacityProviders
returns up to 10 results and anextToken
value if applicable. - nextToken
-
- Type: string
The
nextToken
value returned from a previous paginatedDescribeCapacityProviders
request wheremaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned thenextToken
value.This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
Result Syntax
[ 'capacityProviders' => [ [ 'autoScalingGroupProvider' => [ 'autoScalingGroupArn' => '<string>', 'managedScaling' => [ 'instanceWarmupPeriod' => <integer>, 'maximumScalingStepSize' => <integer>, 'minimumScalingStepSize' => <integer>, 'status' => 'ENABLED|DISABLED', 'targetCapacity' => <integer>, ], 'managedTerminationProtection' => 'ENABLED|DISABLED', ], 'capacityProviderArn' => '<string>', 'name' => '<string>', 'status' => 'ACTIVE|INACTIVE', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'updateStatus' => 'DELETE_IN_PROGRESS|DELETE_COMPLETE|DELETE_FAILED|UPDATE_IN_PROGRESS|UPDATE_COMPLETE|UPDATE_FAILED', 'updateStatusReason' => '<string>', ], // ... ], 'failures' => [ [ 'arn' => '<string>', 'detail' => '<string>', 'reason' => '<string>', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- capacityProviders
-
- Type: Array of CapacityProvider structures
The list of capacity providers.
- failures
-
- Type: Array of Failure structures
Any failures associated with the call.
- nextToken
-
- Type: string
The
nextToken
value to include in a futureDescribeCapacityProviders
request. When the results of aDescribeCapacityProviders
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
DescribeClusters
$result = $client->describeClusters
([/* ... */]); $promise = $client->describeClustersAsync
([/* ... */]);
Describes one or more of your clusters.
Parameter Syntax
$result = $client->describeClusters([ 'clusters' => ['<string>', ...], 'include' => ['<string>', ...], ]);
Parameter Details
Members
- clusters
-
- Type: Array of strings
A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.
- include
-
- Type: Array of strings
Whether to include additional information about your clusters in the response. If this field is omitted, the attachments, statistics, and tags are not included.
If
ATTACHMENTS
is specified, the attachments for the container instances or tasks within the cluster are included.If
SETTINGS
is specified, the settings for the cluster are included.If
STATISTICS
is specified, the following additional information, separated by launch type, is included:-
runningEC2TasksCount
-
runningFargateTasksCount
-
pendingEC2TasksCount
-
pendingFargateTasksCount
-
activeEC2ServiceCount
-
activeFargateServiceCount
-
drainingEC2ServiceCount
-
drainingFargateServiceCount
If
TAGS
is specified, the metadata tags associated with the cluster are included.
Result Syntax
[ 'clusters' => [ [ 'activeServicesCount' => <integer>, 'attachments' => [ [ 'details' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'id' => '<string>', 'status' => '<string>', 'type' => '<string>', ], // ... ], 'attachmentsStatus' => '<string>', 'capacityProviders' => ['<string>', ...], 'clusterArn' => '<string>', 'clusterName' => '<string>', 'configuration' => [ 'executeCommandConfiguration' => [ 'kmsKeyId' => '<string>', 'logConfiguration' => [ 'cloudWatchEncryptionEnabled' => true || false, 'cloudWatchLogGroupName' => '<string>', 's3BucketName' => '<string>', 's3EncryptionEnabled' => true || false, 's3KeyPrefix' => '<string>', ], 'logging' => 'NONE|DEFAULT|OVERRIDE', ], ], 'defaultCapacityProviderStrategy' => [ [ 'base' => <integer>, 'capacityProvider' => '<string>', 'weight' => <integer>, ], // ... ], 'pendingTasksCount' => <integer>, 'registeredContainerInstancesCount' => <integer>, 'runningTasksCount' => <integer>, 'settings' => [ [ 'name' => 'containerInsights', 'value' => '<string>', ], // ... ], 'statistics' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'status' => '<string>', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], ], // ... ], 'failures' => [ [ 'arn' => '<string>', 'detail' => '<string>', 'reason' => '<string>', ], // ... ], ]
Result Details
Members
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
Examples
Example 1: To describe a cluster
This example provides a description of the specified cluster in your default region.
$result = $client->describeClusters([ 'clusters' => [ 'default', ], ]);
Result syntax:
[ 'clusters' => [ [ 'clusterArn' => 'arn:aws:ecs:us-east-1:aws_account_id:cluster/default', 'clusterName' => 'default', 'status' => 'ACTIVE', ], ], 'failures' => [ ], ]
DescribeContainerInstances
$result = $client->describeContainerInstances
([/* ... */]); $promise = $client->describeContainerInstancesAsync
([/* ... */]);
Describes Amazon Elastic Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
Parameter Syntax
$result = $client->describeContainerInstances([ 'cluster' => '<string>', 'containerInstances' => ['<string>', ...], // REQUIRED 'include' => ['<string>', ...], ]);
Parameter Details
Members
- cluster
-
- Type: string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance or container instances you are describing were launched in any cluster other than the default cluster.
- containerInstances
-
- Required: Yes
- Type: Array of strings
A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.
- include
-
- Type: Array of strings
Specifies whether you want to see the resource tags for the container instance. If
TAGS
is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
Result Syntax
[ 'containerInstances' => [ [ 'agentConnected' => true || false, 'agentUpdateStatus' => 'PENDING|STAGING|STAGED|UPDATING|UPDATED|FAILED', 'attachments' => [ [ 'details' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'id' => '<string>', 'status' => '<string>', 'type' => '<string>', ], // ... ], 'attributes' => [ [ 'name' => '<string>', 'targetId' => '<string>', 'targetType' => 'container-instance', 'value' => '<string>', ], // ... ], 'capacityProviderName' => '<string>', 'containerInstanceArn' => '<string>', 'ec2InstanceId' => '<string>', 'pendingTasksCount' => <integer>, 'registeredAt' => <DateTime>, 'registeredResources' => [ [ 'doubleValue' => <float>, 'integerValue' => <integer>, 'longValue' => <integer>, 'name' => '<string>', 'stringSetValue' => ['<string>', ...], 'type' => '<string>', ], // ... ], 'remainingResources' => [ [ 'doubleValue' => <float>, 'integerValue' => <integer>, 'longValue' => <integer>, 'name' => '<string>', 'stringSetValue' => ['<string>', ...], 'type' => '<string>', ], // ... ], 'runningTasksCount' => <integer>, 'status' => '<string>', 'statusReason' => '<string>', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'version' => <integer>, 'versionInfo' => [ 'agentHash' => '<string>', 'agentVersion' => '<string>', 'dockerVersion' => '<string>', ], ], // ... ], 'failures' => [ [ 'arn' => '<string>', 'detail' => '<string>', 'reason' => '<string>', ], // ... ], ]
Result Details
Members
- containerInstances
-
- Type: Array of ContainerInstance structures
The list of container instances.
- failures
-
- Type: Array of Failure structures
Any failures associated with the call.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
Examples
Example 1: To describe container instance
This example provides a description of the specified container instance in your default region, using the container instance UUID as an identifier.
$result = $client->describeContainerInstances([ 'cluster' => 'default', 'containerInstances' => [ 'f2756532-8f13-4d53-87c9-aed50dc94cd7', ], ]);
Result syntax:
[ 'containerInstances' => [ [ 'agentConnected' => 1, 'containerInstanceArn' => 'arn:aws:ecs:us-east-1:012345678910:container-instance/f2756532-8f13-4d53-87c9-aed50dc94cd7', 'ec2InstanceId' => 'i-807f3249', 'pendingTasksCount' => 0, 'registeredResources' => [ [ 'name' => 'CPU', 'type' => 'INTEGER', 'doubleValue' => 0, 'integerValue' => 2048, 'longValue' => 0, ], [ 'name' => 'MEMORY', 'type' => 'INTEGER', 'doubleValue' => 0, 'integerValue' => 3768, 'longValue' => 0, ], [ 'name' => 'PORTS', 'type' => 'STRINGSET', 'doubleValue' => 0, 'integerValue' => 0, 'longValue' => 0, 'stringSetValue' => [ '2376', '22', '51678', '2375', ], ], ], 'remainingResources' => [ [ 'name' => 'CPU', 'type' => 'INTEGER', 'doubleValue' => 0, 'integerValue' => 1948, 'longValue' => 0, ], [ 'name' => 'MEMORY', 'type' => 'INTEGER', 'doubleValue' => 0, 'integerValue' => 3668, 'longValue' => 0, ], [ 'name' => 'PORTS', 'type' => 'STRINGSET', 'doubleValue' => 0, 'integerValue' => 0, 'longValue' => 0, 'stringSetValue' => [ '2376', '22', '80', '51678', '2375', ], ], ], 'runningTasksCount' => 1, 'status' => 'ACTIVE', ], ], 'failures' => [ ], ]
DescribeServices
$result = $client->describeServices
([/* ... */]); $promise = $client->describeServicesAsync
([/* ... */]);
Describes the specified services running in your cluster.
Parameter Syntax
$result = $client->describeServices([ 'cluster' => '<string>', 'include' => ['<string>', ...], 'services' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- cluster
-
- Type: string
The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are describing were launched in any cluster other than the default cluster.
- include
-
- Type: Array of strings
Specifies whether you want to see the resource tags for the service. If
TAGS
is specified, the tags are included in the response. If this field is omitted, tags are not included in the response. - services
-
- Required: Yes
- Type: Array of strings
A list of services to describe. You may specify up to 10 services to describe in a single operation.
Result Syntax
[ 'failures' => [ [ 'arn' => '<string>', 'detail' => '<string>', 'reason' => '<string>', ], // ... ], 'services' => [ [ 'capacityProviderStrategy' => [ [ 'base' => <integer>, 'capacityProvider' => '<string>', 'weight' => <integer>, ], // ... ], 'clusterArn' => '<string>', 'createdAt' => <DateTime>, 'createdBy' => '<string>', 'deploymentConfiguration' => [ 'deploymentCircuitBreaker' => [ 'enable' => true || false, 'rollback' => true || false, ], 'maximumPercent' => <integer>, 'minimumHealthyPercent' => <integer>, ], 'deploymentController' => [ 'type' => 'ECS|CODE_DEPLOY|EXTERNAL', ], 'deployments' => [ [ 'capacityProviderStrategy' => [ [ 'base' => <integer>, 'capacityProvider' => '<string>', 'weight' => <integer>, ], // ... ], 'createdAt' => <DateTime>, 'desiredCount' => <integer>, 'failedTasks' => <integer>, 'id' => '<string>', 'launchType' => 'EC2|FARGATE', 'networkConfiguration' => [ 'awsvpcConfiguration' => [ 'assignPublicIp' => 'ENABLED|DISABLED', 'securityGroups' => ['<string>', ...], 'subnets' => ['<string>', ...], ], ], 'pendingCount' => <integer>, 'platformVersion' => '<string>', 'rolloutState' => 'COMPLETED|FAILED|IN_PROGRESS', 'rolloutStateReason' => '<string>', 'runningCount' => <integer>, 'status' => '<string>', 'taskDefinition' => '<string>', 'updatedAt' => <DateTime>, ], // ... ], 'desiredCount' => <integer>, 'enableECSManagedTags' => true || false, 'enableExecuteCommand' => true || false, 'events' => [ [ 'createdAt' => <DateTime>, 'id' => '<string>', 'message' => '<string>', ], // ... ], 'healthCheckGracePeriodSeconds' => <integer>, 'launchType' => 'EC2|FARGATE', 'loadBalancers' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'loadBalancerName' => '<string>', 'targetGroupArn' => '<string>', ], // ... ], 'networkConfiguration' => [ 'awsvpcConfiguration' => [ 'assignPublicIp' => 'ENABLED|DISABLED', 'securityGroups' => ['<string>', ...], 'subnets' => ['<string>', ...], ], ], 'pendingCount' => <integer>, 'placementConstraints' => [ [ 'expression' => '<string>', 'type' => 'distinctInstance|memberOf', ], // ... ], 'placementStrategy' => [ [ 'field' => '<string>', 'type' => 'random|spread|binpack', ], // ... ], 'platformVersion' => '<string>', 'propagateTags' => 'TASK_DEFINITION|SERVICE', 'roleArn' => '<string>', 'runningCount' => <integer>, 'schedulingStrategy' => 'REPLICA|DAEMON', 'serviceArn' => '<string>', 'serviceName' => '<string>', 'serviceRegistries' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'port' => <integer>, 'registryArn' => '<string>', ], // ... ], 'status' => '<string>', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'taskDefinition' => '<string>', 'taskSets' => [ [ 'capacityProviderStrategy' => [ [ 'base' => <integer>, 'capacityProvider' => '<string>', 'weight' => <integer>, ], // ... ], 'clusterArn' => '<string>', 'computedDesiredCount' => <integer>, 'createdAt' => <DateTime>, 'externalId' => '<string>', 'id' => '<string>', 'launchType' => 'EC2|FARGATE', 'loadBalancers' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'loadBalancerName' => '<string>', 'targetGroupArn' => '<string>', ], // ... ], 'networkConfiguration' => [ 'awsvpcConfiguration' => [ 'assignPublicIp' => 'ENABLED|DISABLED', 'securityGroups' => ['<string>', ...], 'subnets' => ['<string>', ...], ], ], 'pendingCount' => <integer>, 'platformVersion' => '<string>', 'runningCount' => <integer>, 'scale' => [ 'unit' => 'PERCENT', 'value' => <float>, ], 'serviceArn' => '<string>', 'serviceRegistries' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'port' => <integer>, 'registryArn' => '<string>', ], // ... ], 'stabilityStatus' => 'STEADY_STATE|STABILIZING', 'stabilityStatusAt' => <DateTime>, 'startedBy' => '<string>', 'status' => '<string>', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'taskDefinition' => '<string>', 'taskSetArn' => '<string>', 'updatedAt' => <DateTime>, ], // ... ], ], // ... ], ]
Result Details
Members
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
Examples
Example 1: To describe a service
This example provides descriptive information about the service named ``ecs-simple-service``.
$result = $client->describeServices([ 'services' => [ 'ecs-simple-service', ], ]);
Result syntax:
[ 'failures' => [ ], 'services' => [ [ 'clusterArn' => 'arn:aws:ecs:us-east-1:012345678910:cluster/default', 'createdAt' =>, 'deploymentConfiguration' => [ 'maximumPercent' => 200, 'minimumHealthyPercent' => 100, ], 'deployments' => [ [ 'createdAt' => , 'desiredCount' => 1, 'id' => 'ecs-svc/9223370564341623665', 'pendingCount' => 0, 'runningCount' => 0, 'status' => 'PRIMARY', 'taskDefinition' => 'arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6', 'updatedAt' => , ], ], 'desiredCount' => 1, 'events' => [ [ 'createdAt' => , 'id' => '38c285e5-d335-4b68-8b15-e46dedc8e88d', 'message' => '(service ecs-simple-service) was unable to place a task because no container instance met all of its requirements. The closest matching (container-instance 3f4de1c5-ffdd-4954-af7e-75b4be0c8841) is already using a port required by your task. For more information, see the Troubleshooting section of the Amazon ECS Developer Guide.', ], ], 'loadBalancers' => [ ], 'pendingCount' => 0, 'runningCount' => 0, 'serviceArn' => 'arn:aws:ecs:us-east-1:012345678910:service/ecs-simple-service', 'serviceName' => 'ecs-simple-service', 'status' => 'ACTIVE', 'taskDefinition' => 'arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6', ], ], ]
DescribeTaskDefinition
$result = $client->describeTaskDefinition
([/* ... */]); $promise = $client->describeTaskDefinitionAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->describeTaskDefinition([ 'include' => ['<string>', ...], 'taskDefinition' => '<string>', // REQUIRED ]);
Parameter Details
Members
- include
-
- Type: Array of strings
Specifies whether to see the resource tags for the task definition. If
TAGS
is specified, the tags are included in the response. If this field is omitted, tags are not included in the response. - taskDefinition
-
- Required: Yes
- Type: string
The
family
for the latestACTIVE
revision,family
andrevision
(family:revision
) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition to describe.
Result Syntax
[ 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'taskDefinition' => [ 'compatibilities' => ['<string>', ...], 'containerDefinitions' => [ [ 'command' => ['<string>', ...], 'cpu' => <integer>, 'dependsOn' => [ [ 'condition' => 'START|COMPLETE|SUCCESS|HEALTHY', 'containerName' => '<string>', ], // ... ], 'disableNetworking' => true || false, 'dnsSearchDomains' => ['<string>', ...], 'dnsServers' => ['<string>', ...], 'dockerLabels' => ['<string>', ...], 'dockerSecurityOptions' => ['<string>', ...], 'entryPoint' => ['<string>', ...], 'environment' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'environmentFiles' => [ [ 'type' => 's3', 'value' => '<string>', ], // ... ], 'essential' => true || false, 'extraHosts' => [ [ 'hostname' => '<string>', 'ipAddress' => '<string>', ], // ... ], 'firelensConfiguration' => [ 'options' => ['<string>', ...], 'type' => 'fluentd|fluentbit', ], 'healthCheck' => [ 'command' => ['<string>', ...], 'interval' => <integer>, 'retries' => <integer>, 'startPeriod' => <integer>, 'timeout' => <integer>, ], 'hostname' => '<string>', 'image' => '<string>', 'interactive' => true || false, 'links' => ['<string>', ...], 'linuxParameters' => [ 'capabilities' => [ 'add' => ['<string>', ...], 'drop' => ['<string>', ...], ], 'devices' => [ [ 'containerPath' => '<string>', 'hostPath' => '<string>', 'permissions' => ['<string>', ...], ], // ... ], 'initProcessEnabled' => true || false, 'maxSwap' => <integer>, 'sharedMemorySize' => <integer>, 'swappiness' => <integer>, 'tmpfs' => [ [ 'containerPath' => '<string>', 'mountOptions' => ['<string>', ...], 'size' => <integer>, ], // ... ], ], 'logConfiguration' => [ 'logDriver' => 'json-file|syslog|journald|gelf|fluentd|awslogs|splunk|awsfirelens', 'options' => ['<string>', ...], 'secretOptions' => [ [ 'name' => '<string>', 'valueFrom' => '<string>', ], // ... ], ], 'memory' => <integer>, 'memoryReservation' => <integer>, 'mountPoints' => [ [ 'containerPath' => '<string>', 'readOnly' => true || false, 'sourceVolume' => '<string>', ], // ... ], 'name' => '<string>', 'portMappings' => [ [ 'containerPort' => <integer>, 'hostPort' => <integer>, 'protocol' => 'tcp|udp', ], // ... ], 'privileged' => true || false, 'pseudoTerminal' => true || false, 'readonlyRootFilesystem' => true || false, 'repositoryCredentials' => [ 'credentialsParameter' => '<string>', ], 'resourceRequirements' => [ [ 'type' => 'GPU|InferenceAccelerator', 'value' => '<string>', ], // ... ], 'secrets' => [ [ 'name' => '<string>', 'valueFrom' => '<string>', ], // ... ], 'startTimeout' => <integer>, 'stopTimeout' => <integer>, 'systemControls' => [ [ 'namespace' => '<string>', 'value' => '<string>', ], // ... ], 'ulimits' => [ [ 'hardLimit' => <integer>, 'name' => 'core|cpu|data|fsize|locks|memlock|msgqueue|nice|nofile|nproc|rss|rtprio|rttime|sigpending|stack', 'softLimit' => <integer>, ], // ... ], 'user' => '<string>', 'volumesFrom' => [ [ 'readOnly' => true || false, 'sourceContainer' => '<string>', ], // ... ], 'workingDirectory' => '<string>', ], // ... ], 'cpu' => '<string>', 'deregisteredAt' => <DateTime>, 'executionRoleArn' => '<string>', 'family' => '<string>', 'inferenceAccelerators' => [ [ 'deviceName' => '<string>', 'deviceType' => '<string>', ], // ... ], 'ipcMode' => 'host|task|none', 'memory' => '<string>', 'networkMode' => 'bridge|host|awsvpc|none', 'pidMode' => 'host|task', 'placementConstraints' => [ [ 'expression' => '<string>', 'type' => 'memberOf', ], // ... ], 'proxyConfiguration' => [ 'containerName' => '<string>', 'properties' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'type' => 'APPMESH', ], 'registeredAt' => <DateTime>, 'registeredBy' => '<string>', 'requiresAttributes' => [ [ 'name' => '<string>', 'targetId' => '<string>', 'targetType' => 'container-instance', 'value' => '<string>', ], // ... ], 'requiresCompatibilities' => ['<string>', ...], 'revision' => <integer>, 'status' => 'ACTIVE|INACTIVE', 'taskDefinitionArn' => '<string>', 'taskRoleArn' => '<string>', 'volumes' => [ [ 'dockerVolumeConfiguration' => [ 'autoprovision' => true || false, 'driver' => '<string>', 'driverOpts' => ['<string>', ...], 'labels' => ['<string>', ...], 'scope' => 'task|shared', ], 'efsVolumeConfiguration' => [ 'authorizationConfig' => [ 'accessPointId' => '<string>', 'iam' => 'ENABLED|DISABLED', ], 'fileSystemId' => '<string>', 'rootDirectory' => '<string>', 'transitEncryption' => 'ENABLED|DISABLED', 'transitEncryptionPort' => <integer>, ], 'fsxWindowsFileServerVolumeConfiguration' => [ 'authorizationConfig' => [ 'credentialsParameter' => '<string>', 'domain' => '<string>', ], 'fileSystemId' => '<string>', 'rootDirectory' => '<string>', ], 'host' => [ 'sourcePath' => '<string>', ], 'name' => '<string>', ], // ... ], ], ]
Result Details
Members
- tags
-
- Type: Array of Tag structures
The metadata that is applied to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
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 AWS 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.
- taskDefinition
-
- Type: TaskDefinition structure
The full task definition description.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
Examples
Example 1: To describe a task definition
This example provides a description of the specified task definition.
$result = $client->describeTaskDefinition([ 'taskDefinition' => 'hello_world:8', ]);
Result syntax:
[ 'taskDefinition' => [ 'containerDefinitions' => [ [ 'name' => 'wordpress', 'cpu' => 10, 'environment' => [ ], 'essential' => 1, 'image' => 'wordpress', 'links' => [ 'mysql', ], 'memory' => 500, 'mountPoints' => [ ], 'portMappings' => [ [ 'containerPort' => 80, 'hostPort' => 80, ], ], 'volumesFrom' => [ ], ], [ 'name' => 'mysql', 'cpu' => 10, 'environment' => [ [ 'name' => 'MYSQL_ROOT_PASSWORD', 'value' => 'password', ], ], 'essential' => 1, 'image' => 'mysql', 'memory' => 500, 'mountPoints' => [ ], 'portMappings' => [ ], 'volumesFrom' => [ ], ], ], 'family' => 'hello_world', 'revision' => 8, 'taskDefinitionArn' => 'arn:aws:ecs:us-east-1::task-definition/hello_world:8', 'volumes' => [ ], ], ]
DescribeTaskSets
$result = $client->describeTaskSets
([/* ... */]); $promise = $client->describeTaskSetsAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->describeTaskSets([ 'cluster' => '<string>', // REQUIRED 'include' => ['<string>', ...], 'service' => '<string>', // REQUIRED 'taskSets' => ['<string>', ...], ]);
Parameter Details
Members
- cluster
-
- Required: Yes
- Type: string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.
- include
-
- Type: Array of strings
Specifies whether to see the resource tags for the task set. If
TAGS
is specified, the tags are included in the response. If this field is omitted, tags are not included in the response. - service
-
- Required: Yes
- Type: string
The short name or full Amazon Resource Name (ARN) of the service that the task sets exist in.
- taskSets
-
- Type: Array of strings
The ID or full Amazon Resource Name (ARN) of task sets to describe.
Result Syntax
[ 'failures' => [ [ 'arn' => '<string>', 'detail' => '<string>', 'reason' => '<string>', ], // ... ], 'taskSets' => [ [ 'capacityProviderStrategy' => [ [ 'base' => <integer>, 'capacityProvider' => '<string>', 'weight' => <integer>, ], // ... ], 'clusterArn' => '<string>', 'computedDesiredCount' => <integer>, 'createdAt' => <DateTime>, 'externalId' => '<string>', 'id' => '<string>', 'launchType' => 'EC2|FARGATE', 'loadBalancers' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'loadBalancerName' => '<string>', 'targetGroupArn' => '<string>', ], // ... ], 'networkConfiguration' => [ 'awsvpcConfiguration' => [ 'assignPublicIp' => 'ENABLED|DISABLED', 'securityGroups' => ['<string>', ...], 'subnets' => ['<string>', ...], ], ], 'pendingCount' => <integer>, 'platformVersion' => '<string>', 'runningCount' => <integer>, 'scale' => [ 'unit' => 'PERCENT', 'value' => <float>, ], 'serviceArn' => '<string>', 'serviceRegistries' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'port' => <integer>, 'registryArn' => '<string>', ], // ... ], 'stabilityStatus' => 'STEADY_STATE|STABILIZING', 'stabilityStatusAt' => <DateTime>, 'startedBy' => '<string>', 'status' => '<string>', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'taskDefinition' => '<string>', 'taskSetArn' => '<string>', 'updatedAt' => <DateTime>, ], // ... ], ]
Result Details
Members
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
-
The specified task is not supported in this Region.
-
You do not have authorization to perform the requested action.
-
The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific.
-
The specified service is not active. You can't update a service that is inactive. If you have previously deleted a service, you can re-create it with CreateService.
DescribeTasks
$result = $client->describeTasks
([/* ... */]); $promise = $client->describeTasksAsync
([/* ... */]);
Describes a specified task or tasks.
Parameter Syntax
$result = $client->describeTasks([ 'cluster' => '<string>', 'include' => ['<string>', ...], 'tasks' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- cluster
-
- Type: string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were launched in any cluster other than the default cluster.
- include
-
- Type: Array of strings
Specifies whether you want to see the resource tags for the task. If
TAGS
is specified, the tags are included in the response. If this field is omitted, tags are not included in the response. - tasks
-
- Required: Yes
- Type: Array of strings
A list of up to 100 task IDs or full ARN entries.
Result Syntax
[ 'failures' => [ [ 'arn' => '<string>', 'detail' => '<string>', 'reason' => '<string>', ], // ... ], 'tasks' => [ [ 'attachments' => [ [ 'details' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'id' => '<string>', 'status' => '<string>', 'type' => '<string>', ], // ... ], 'attributes' => [ [ 'name' => '<string>', 'targetId' => '<string>', 'targetType' => 'container-instance', 'value' => '<string>', ], // ... ], 'availabilityZone' => '<string>', 'capacityProviderName' => '<string>', 'clusterArn' => '<string>', 'connectivity' => 'CONNECTED|DISCONNECTED', 'connectivityAt' => <DateTime>, 'containerInstanceArn' => '<string>', 'containers' => [ [ 'containerArn' => '<string>', 'cpu' => '<string>', 'exitCode' => <integer>, 'gpuIds' => ['<string>', ...], 'healthStatus' => 'HEALTHY|UNHEALTHY|UNKNOWN', 'image' => '<string>', 'imageDigest' => '<string>', 'lastStatus' => '<string>', 'managedAgents' => [ [ 'lastStartedAt' => <DateTime>, 'lastStatus' => '<string>', 'name' => 'ExecuteCommandAgent', 'reason' => '<string>', ], // ... ], 'memory' => '<string>', 'memoryReservation' => '<string>', 'name' => '<string>', 'networkBindings' => [ [ 'bindIP' => '<string>', 'containerPort' => <integer>, 'hostPort' => <integer>, 'protocol' => 'tcp|udp', ], // ... ], 'networkInterfaces' => [ [ 'attachmentId' => '<string>', 'ipv6Address' => '<string>', 'privateIpv4Address' => '<string>', ], // ... ], 'reason' => '<string>', 'runtimeId' => '<string>', 'taskArn' => '<string>', ], // ... ], 'cpu' => '<string>', 'createdAt' => <DateTime>, 'desiredStatus' => '<string>', 'enableExecuteCommand' => true || false, 'executionStoppedAt' => <DateTime>, 'group' => '<string>', 'healthStatus' => 'HEALTHY|UNHEALTHY|UNKNOWN', 'inferenceAccelerators' => [ [ 'deviceName' => '<string>', 'deviceType' => '<string>', ], // ... ], 'lastStatus' => '<string>', 'launchType' => 'EC2|FARGATE', 'memory' => '<string>', 'overrides' => [ 'containerOverrides' => [ [ 'command' => ['<string>', ...], 'cpu' => <integer>, 'environment' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'environmentFiles' => [ [ 'type' => 's3', 'value' => '<string>', ], // ... ], 'memory' => <integer>, 'memoryReservation' => <integer>, 'name' => '<string>', 'resourceRequirements' => [ [ 'type' => 'GPU|InferenceAccelerator', 'value' => '<string>', ], // ... ], ], // ... ], 'cpu' => '<string>', 'executionRoleArn' => '<string>', 'inferenceAcceleratorOverrides' => [ [ 'deviceName' => '<string>', 'deviceType' => '<string>', ], // ... ], 'memory' => '<string>', 'taskRoleArn' => '<string>', ], 'platformVersion' => '<string>', 'pullStartedAt' => <DateTime>, 'pullStoppedAt' => <DateTime>, 'startedAt' => <DateTime>, 'startedBy' => '<string>', 'stopCode' => 'TaskFailedToStart|EssentialContainerExited|UserInitiated', 'stoppedAt' => <DateTime>, 'stoppedReason' => '<string>', 'stoppingAt' => <DateTime>, 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'taskArn' => '<string>', 'taskDefinitionArn' => '<string>', 'version' => <integer>, ], // ... ], ]
Result Details
Members
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
Examples
Example 1: To describe a task
This example provides a description of the specified task, using the task UUID as an identifier.
$result = $client->describeTasks([ 'tasks' => [ 'c5cba4eb-5dad-405e-96db-71ef8eefe6a8', ], ]);
Result syntax:
[ 'failures' => [ ], 'tasks' => [ [ 'clusterArn' => 'arn:aws:ecs:: :cluster/default', 'containerInstanceArn' => 'arn:aws:ecs: : :container-instance/18f9eda5-27d7-4c19-b133-45adc516e8fb', 'containers' => [ [ 'name' => 'ecs-demo', 'containerArn' => 'arn:aws:ecs: : :container/7c01765b-c588-45b3-8290-4ba38bd6c5a6', 'lastStatus' => 'RUNNING', 'networkBindings' => [ [ 'bindIP' => '0.0.0.0', 'containerPort' => 80, 'hostPort' => 80, ], ], 'taskArn' => 'arn:aws:ecs: : :task/c5cba4eb-5dad-405e-96db-71ef8eefe6a8', ], ], 'desiredStatus' => 'RUNNING', 'lastStatus' => 'RUNNING', 'overrides' => [ 'containerOverrides' => [ [ 'name' => 'ecs-demo', ], ], ], 'startedBy' => 'ecs-svc/9223370608528463088', 'taskArn' => 'arn:aws:ecs: : :task/c5cba4eb-5dad-405e-96db-71ef8eefe6a8', 'taskDefinitionArn' => 'arn:aws:ecs: : :task-definition/amazon-ecs-sample:1', ], ], ]
DiscoverPollEndpoint
$result = $client->discoverPollEndpoint
([/* ... */]); $promise = $client->discoverPollEndpointAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->discoverPollEndpoint([ 'cluster' => '<string>', 'containerInstance' => '<string>', ]);
Parameter Details
Members
- cluster
-
- Type: string
The short name or full Amazon Resource Name (ARN) of the cluster to which the container instance belongs.
- containerInstance
-
- Type: string
The container instance ID or full ARN of the container instance. The ARN contains the
arn:aws:ecs
namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, thecontainer-instance
namespace, and then the container instance ID. For example,arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
.
Result Syntax
[ 'endpoint' => '<string>', 'telemetryEndpoint' => '<string>', ]
Result Details
Members
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
ExecuteCommand
$result = $client->executeCommand
([/* ... */]); $promise = $client->executeCommandAsync
([/* ... */]);
Runs a command remotely on a container within a task.
Parameter Syntax
$result = $client->executeCommand([ 'cluster' => '<string>', 'command' => '<string>', // REQUIRED 'container' => '<string>', 'interactive' => true || false, // REQUIRED 'task' => '<string>', // REQUIRED ]);
Parameter Details
Members
- cluster
-
- Type: string
The Amazon Resource Name (ARN) or short name of the cluster the task is running in. If you do not specify a cluster, the default cluster is assumed.
- command
-
- Required: Yes
- Type: string
The command to run on the container.
- container
-
- Type: string
The name of the container to execute the command on. A container name only needs to be specified for tasks containing multiple containers.
- interactive
-
- Required: Yes
- Type: boolean
Use this flag to run your command in interactive mode.
- task
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) or ID of the task the container is part of.
Result Syntax
[ 'clusterArn' => '<string>', 'containerArn' => '<string>', 'containerName' => '<string>', 'interactive' => true || false, 'session' => [ 'sessionId' => '<string>', 'streamUrl' => '<string>', 'tokenValue' => '<string>', ], 'taskArn' => '<string>', ]
Result Details
Members
- clusterArn
-
- Type: string
The Amazon Resource Name (ARN) of the cluster.
- containerArn
-
- Type: string
The Amazon Resource Name (ARN) of the container.
- containerName
-
- Type: string
The name of the container.
- interactive
-
- Type: boolean
Whether or not the execute command session is running in interactive mode.
- session
-
- Type: Session structure
The details of the SSM session that was created for this instance of execute-command.
- taskArn
-
- Type: string
The Amazon Resource Name (ARN) of the task.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
You do not have authorization to perform the requested action.
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
-
The target container is not properly configured with the execute command agent or the container is no longer active or running.
ListAccountSettings
$result = $client->listAccountSettings
([/* ... */]); $promise = $client->listAccountSettingsAsync
([/* ... */]);
Lists the account settings for a specified principal.
Parameter Syntax
$result = $client->listAccountSettings([ 'effectiveSettings' => true || false, 'maxResults' => <integer>, 'name' => 'serviceLongArnFormat|taskLongArnFormat|containerInstanceLongArnFormat|awsvpcTrunking|containerInsights', 'nextToken' => '<string>', 'principalArn' => '<string>', 'value' => '<string>', ]);
Parameter Details
Members
- effectiveSettings
-
- Type: boolean
Specifies whether to return the effective settings. If
true
, the account settings for the root user or the default setting for theprincipalArn
are returned. Iffalse
, the account settings for theprincipalArn
are returned if they are set. Otherwise, no account settings are returned. - maxResults
-
- Type: int
The maximum number of account setting results returned by
ListAccountSettings
in paginated output. When this parameter is used,ListAccountSettings
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListAccountSettings
request with the returnednextToken
value. This value can be between 1 and 10. If this parameter is not used, thenListAccountSettings
returns up to 10 results and anextToken
value if applicable. - name
-
- Type: string
The name of the account setting you want to list the settings for.
- nextToken
-
- Type: string
The
nextToken
value returned from aListAccountSettings
request indicating that more results are available to fulfill the request and further calls will be needed. IfmaxResults
was provided, it is possible the number of results to be fewer thanmaxResults
.This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
- principalArn
-
- Type: string
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.
- value
-
- Type: string
The value of the account settings with which to filter results. You must also specify an account setting name to use this parameter.
Result Syntax
[ 'nextToken' => '<string>', 'settings' => [ [ 'name' => 'serviceLongArnFormat|taskLongArnFormat|containerInstanceLongArnFormat|awsvpcTrunking|containerInsights', 'principalArn' => '<string>', 'value' => '<string>', ], // ... ], ]
Result Details
Members
- nextToken
-
- Type: string
The
nextToken
value to include in a futureListAccountSettings
request. When the results of aListAccountSettings
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return. - settings
-
- Type: Array of Setting structures
The account settings for the resource.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
Examples
Example 1: To view your effective account settings
This example displays the effective account settings for your account.
$result = $client->listAccountSettings([ 'effectiveSettings' => 1, ]);
Result syntax:
[ 'settings' => [ [ 'name' => 'containerInstanceLongArnFormat', 'value' => 'disabled', 'principalArn' => 'arn:aws:iam:::user/principalName', ], [ 'name' => 'serviceLongArnFormat', 'value' => 'enabled', 'principalArn' => 'arn:aws:iam:: :user/principalName', ], [ 'name' => 'taskLongArnFormat', 'value' => 'disabled', 'principalArn' => 'arn:aws:iam:: :user/principalName', ], ], ]
Example 2: To view the effective account settings for a specific IAM user or IAM role
This example displays the effective account settings for the specified user or role.
$result = $client->listAccountSettings([ 'effectiveSettings' => 1, 'principalArn' => 'arn:aws:iam:::user/principalName', ]);
Result syntax:
[ 'settings' => [ [ 'name' => 'containerInstanceLongArnFormat', 'value' => 'disabled', 'principalArn' => 'arn:aws:iam:::user/principalName', ], [ 'name' => 'serviceLongArnFormat', 'value' => 'enabled', 'principalArn' => 'arn:aws:iam:: :user/principalName', ], [ 'name' => 'taskLongArnFormat', 'value' => 'disabled', 'principalArn' => 'arn:aws:iam:: :user/principalName', ], ], ]
ListAttributes
$result = $client->listAttributes
([/* ... */]); $promise = $client->listAttributesAsync
([/* ... */]);
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
).
Parameter Syntax
$result = $client->listAttributes([ 'attributeName' => '<string>', 'attributeValue' => '<string>', 'cluster' => '<string>', 'maxResults' => <integer>, 'nextToken' => '<string>', 'targetType' => 'container-instance', // REQUIRED ]);
Parameter Details
Members
- attributeName
-
- Type: string
The name of the attribute with which to filter the results.
- attributeValue
-
- Type: string
The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter.
- cluster
-
- Type: string
The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.
- maxResults
-
- Type: int
The maximum number of cluster results returned by
ListAttributes
in paginated output. When this parameter is used,ListAttributes
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListAttributes
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListAttributes
returns up to 100 results and anextToken
value if applicable. - nextToken
-
- Type: string
The
nextToken
value returned from aListAttributes
request indicating that more results are available to fulfill the request and further calls will be needed. IfmaxResults
was provided, it is possible the number of results to be fewer thanmaxResults
.This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
- targetType
-
- Required: Yes
- Type: string
The type of the target with which to list attributes.
Result Syntax
[ 'attributes' => [ [ 'name' => '<string>', 'targetId' => '<string>', 'targetType' => 'container-instance', 'value' => '<string>', ], // ... ], 'nextToken' => '<string>', ]
Result Details
Members
- attributes
-
- Type: Array of Attribute structures
A list of attribute objects that meet the criteria of the request.
- nextToken
-
- Type: string
The
nextToken
value to include in a futureListAttributes
request. When the results of aListAttributes
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return.
Errors
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
-
The specified parameter is invalid. Review the available parameters for the API request.
ListClusters
$result = $client->listClusters
([/* ... */]); $promise = $client->listClustersAsync
([/* ... */]);
Returns a list of existing clusters.
Parameter Syntax
$result = $client->listClusters([ 'maxResults' => <integer>, 'nextToken' => '<string>', ]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of cluster results returned by
ListClusters
in paginated output. When this parameter is used,ListClusters
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListClusters
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListClusters
returns up to 100 results and anextToken
value if applicable. - nextToken
-
- Type: string
The
nextToken
value returned from aListClusters
request indicating that more results are available to fulfill the request and further calls will be needed. IfmaxResults
was provided, it is possible the number of results to be fewer thanmaxResults
.This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
Result Syntax
[ 'clusterArns' => ['<string>', ...], 'nextToken' => '<string>', ]
Result Details
Members
- clusterArns
-
- Type: Array of strings
The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.
- nextToken
-
- Type: string
The
nextToken
value to include in a futureListClusters
request. When the results of aListClusters
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
Examples
Example 1: To list your available clusters
This example lists all of your available clusters in your default region.
$result = $client->listClusters([ ]);
Result syntax:
[ 'clusterArns' => [ 'arn:aws:ecs:us-east-1::cluster/test', 'arn:aws:ecs:us-east-1: :cluster/default', ], ]
ListContainerInstances
$result = $client->listContainerInstances
([/* ... */]); $promise = $client->listContainerInstancesAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->listContainerInstances([ 'cluster' => '<string>', 'filter' => '<string>', 'maxResults' => <integer>, 'nextToken' => '<string>', 'status' => 'ACTIVE|DRAINING|REGISTERING|DEREGISTERING|REGISTRATION_FAILED', ]);
Parameter Details
Members
- cluster
-
- Type: string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.
- filter
-
- Type: string
You can filter the results of a
ListContainerInstances
operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide. - maxResults
-
- Type: int
The maximum number of container instance results returned by
ListContainerInstances
in paginated output. When this parameter is used,ListContainerInstances
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListContainerInstances
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListContainerInstances
returns up to 100 results and anextToken
value if applicable. - nextToken
-
- Type: string
The
nextToken
value returned from aListContainerInstances
request indicating that more results are available to fulfill the request and further calls will be needed. IfmaxResults
was provided, it is possible the number of results to be fewer thanmaxResults
.This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
- status
-
- Type: string
Filters the container instances by status. For example, if you specify the
DRAINING
status, the results include only container instances that have been set toDRAINING
using UpdateContainerInstancesState. If you do not specify this parameter, the default is to include container instances set to all states other thanINACTIVE
.
Result Syntax
[ 'containerInstanceArns' => ['<string>', ...], 'nextToken' => '<string>', ]
Result Details
Members
- containerInstanceArns
-
- Type: Array of strings
The list of container instances with full ARN entries for each container instance associated with the specified cluster.
- nextToken
-
- Type: string
The
nextToken
value to include in a futureListContainerInstances
request. When the results of aListContainerInstances
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
Examples
Example 1: To list your available container instances in a cluster
This example lists all of your available container instances in the specified cluster in your default region.
$result = $client->listContainerInstances([ 'cluster' => 'default', ]);
Result syntax:
[ 'containerInstanceArns' => [ 'arn:aws:ecs:us-east-1::container-instance/f6bbb147-5370-4ace-8c73-c7181ded911f', 'arn:aws:ecs:us-east-1: :container-instance/ffe3d344-77e2-476c-a4d0-bf560ad50acb', ], ]
ListServices
$result = $client->listServices
([/* ... */]); $promise = $client->listServicesAsync
([/* ... */]);
Lists the services that are running in a specified cluster.
Parameter Syntax
$result = $client->listServices([ 'cluster' => '<string>', 'launchType' => 'EC2|FARGATE', 'maxResults' => <integer>, 'nextToken' => '<string>', 'schedulingStrategy' => 'REPLICA|DAEMON', ]);
Parameter Details
Members
- cluster
-
- Type: string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the services to list. If you do not specify a cluster, the default cluster is assumed.
- launchType
-
- Type: string
The launch type for the services to list.
- maxResults
-
- Type: int
The maximum number of service results returned by
ListServices
in paginated output. When this parameter is used,ListServices
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListServices
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListServices
returns up to 10 results and anextToken
value if applicable. - nextToken
-
- Type: string
The
nextToken
value returned from aListServices
request indicating that more results are available to fulfill the request and further calls will be needed. IfmaxResults
was provided, it is possible the number of results to be fewer thanmaxResults
.This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
- schedulingStrategy
-
- Type: string
The scheduling strategy for services to list.
Result Syntax
[ 'nextToken' => '<string>', 'serviceArns' => ['<string>', ...], ]
Result Details
Members
- nextToken
-
- Type: string
The
nextToken
value to include in a futureListServices
request. When the results of aListServices
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return. - serviceArns
-
- Type: Array of strings
The list of full ARN entries for each service associated with the specified cluster.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
Examples
Example 1: To list the services in a cluster
This example lists the services running in the default cluster for an account.
$result = $client->listServices([ ]);
Result syntax:
[ 'serviceArns' => [ 'arn:aws:ecs:us-east-1:012345678910:service/my-http-service', ], ]
ListTagsForResource
$result = $client->listTagsForResource
([/* ... */]); $promise = $client->listTagsForResourceAsync
([/* ... */]);
List the tags for an Amazon ECS resource.
Parameter Syntax
$result = $client->listTagsForResource([ 'resourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
Result Syntax
[ 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], ]
Result Details
Members
- tags
-
- Type: Array of Tag structures
The tags for the resource.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
-
The specified parameter is invalid. Review the available parameters for the API request.
Examples
Example 1: To list the tags for a cluster.
This example lists the tags for the 'dev' cluster.
$result = $client->listTagsForResource([ 'resourceArn' => 'arn:aws:ecs:region:aws_account_id:cluster/dev', ]);
Result syntax:
[ 'tags' => [ [ 'key' => 'team', 'value' => 'dev', ], ], ]
ListTaskDefinitionFamilies
$result = $client->listTaskDefinitionFamilies
([/* ... */]); $promise = $client->listTaskDefinitionFamiliesAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->listTaskDefinitionFamilies([ 'familyPrefix' => '<string>', 'maxResults' => <integer>, 'nextToken' => '<string>', 'status' => 'ACTIVE|INACTIVE|ALL', ]);
Parameter Details
Members
- familyPrefix
-
- Type: string
The
familyPrefix
is a string that is used to filter the results ofListTaskDefinitionFamilies
. If you specify afamilyPrefix
, only task definition family names that begin with thefamilyPrefix
string are returned. - maxResults
-
- Type: int
The maximum number of task definition family results returned by
ListTaskDefinitionFamilies
in paginated output. When this parameter is used,ListTaskDefinitions
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListTaskDefinitionFamilies
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListTaskDefinitionFamilies
returns up to 100 results and anextToken
value if applicable. - nextToken
-
- Type: string
The
nextToken
value returned from aListTaskDefinitionFamilies
request indicating that more results are available to fulfill the request and further calls will be needed. IfmaxResults
was provided, it is possible the number of results to be fewer thanmaxResults
.This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
- status
-
- Type: string
The task definition family status with which to filter the
ListTaskDefinitionFamilies
results. By default, bothACTIVE
andINACTIVE
task definition families are listed. If this parameter is set toACTIVE
, only task definition families that have anACTIVE
task definition revision are returned. If this parameter is set toINACTIVE
, only task definition families that do not have anyACTIVE
task definition revisions are returned. If you paginate the resulting output, be sure to keep thestatus
value constant in each subsequent request.
Result Syntax
[ 'families' => ['<string>', ...], 'nextToken' => '<string>', ]
Result Details
Members
- families
-
- Type: Array of strings
The list of task definition family names that match the
ListTaskDefinitionFamilies
request. - nextToken
-
- Type: string
The
nextToken
value to include in a futureListTaskDefinitionFamilies
request. When the results of aListTaskDefinitionFamilies
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
Examples
Example 1: To list your registered task definition families
This example lists all of your registered task definition families.
$result = $client->listTaskDefinitionFamilies([ ]);
Result syntax:
[ 'families' => [ 'node-js-app', 'web-timer', 'hpcc', 'hpcc-c4-8xlarge', ], ]
Example 2: To filter your registered task definition families
This example lists the task definition revisions that start with "hpcc".
$result = $client->listTaskDefinitionFamilies([ 'familyPrefix' => 'hpcc', ]);
Result syntax:
[ 'families' => [ 'hpcc', 'hpcc-c4-8xlarge', ], ]
ListTaskDefinitions
$result = $client->listTaskDefinitions
([/* ... */]); $promise = $client->listTaskDefinitionsAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->listTaskDefinitions([ 'familyPrefix' => '<string>', 'maxResults' => <integer>, 'nextToken' => '<string>', 'sort' => 'ASC|DESC', 'status' => 'ACTIVE|INACTIVE', ]);
Parameter Details
Members
- familyPrefix
-
- Type: string
The full family name with which to filter the
ListTaskDefinitions
results. Specifying afamilyPrefix
limits the listed task definitions to task definition revisions that belong to that family. - maxResults
-
- Type: int
The maximum number of task definition results returned by
ListTaskDefinitions
in paginated output. When this parameter is used,ListTaskDefinitions
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListTaskDefinitions
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListTaskDefinitions
returns up to 100 results and anextToken
value if applicable. - nextToken
-
- Type: string
The
nextToken
value returned from aListTaskDefinitions
request indicating that more results are available to fulfill the request and further calls will be needed. IfmaxResults
was provided, it is possible the number of results to be fewer thanmaxResults
.This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
- sort
-
- Type: string
The order in which to sort the results. Valid values are
ASC
andDESC
. By default (ASC
), task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter toDESC
reverses the sort order on family name and revision so that the newest task definitions in a family are listed first. - status
-
- Type: string
The task definition status with which to filter the
ListTaskDefinitions
results. By default, onlyACTIVE
task definitions are listed. By setting this parameter toINACTIVE
, you can view task definitions that areINACTIVE
as long as an active task or service still references them. If you paginate the resulting output, be sure to keep thestatus
value constant in each subsequent request.
Result Syntax
[ 'nextToken' => '<string>', 'taskDefinitionArns' => ['<string>', ...], ]
Result Details
Members
- nextToken
-
- Type: string
The
nextToken
value to include in a futureListTaskDefinitions
request. When the results of aListTaskDefinitions
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return. - taskDefinitionArns
-
- Type: Array of strings
The list of task definition Amazon Resource Name (ARN) entries for the
ListTaskDefinitions
request.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
Examples
Example 1: To list your registered task definitions
This example lists all of your registered task definitions.
$result = $client->listTaskDefinitions([ ]);
Result syntax:
[ 'taskDefinitionArns' => [ 'arn:aws:ecs:us-east-1::task-definition/sleep300:2', 'arn:aws:ecs:us-east-1: :task-definition/sleep360:1', 'arn:aws:ecs:us-east-1: :task-definition/wordpress:3', 'arn:aws:ecs:us-east-1: :task-definition/wordpress:4', 'arn:aws:ecs:us-east-1: :task-definition/wordpress:5', 'arn:aws:ecs:us-east-1: :task-definition/wordpress:6', ], ]
Example 2: To list the registered task definitions in a family
This example lists the task definition revisions of a specified family.
$result = $client->listTaskDefinitions([ 'familyPrefix' => 'wordpress', ]);
Result syntax:
[ 'taskDefinitionArns' => [ 'arn:aws:ecs:us-east-1::task-definition/wordpress:3', 'arn:aws:ecs:us-east-1: :task-definition/wordpress:4', 'arn:aws:ecs:us-east-1: :task-definition/wordpress:5', 'arn:aws:ecs:us-east-1: :task-definition/wordpress:6', ], ]
ListTasks
$result = $client->listTasks
([/* ... */]); $promise = $client->listTasksAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->listTasks([ 'cluster' => '<string>', 'containerInstance' => '<string>', 'desiredStatus' => 'RUNNING|PENDING|STOPPED', 'family' => '<string>', 'launchType' => 'EC2|FARGATE', 'maxResults' => <integer>, 'nextToken' => '<string>', 'serviceName' => '<string>', 'startedBy' => '<string>', ]);
Parameter Details
Members
- cluster
-
- Type: string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list. If you do not specify a cluster, the default cluster is assumed.
- containerInstance
-
- Type: string
The container instance ID or full ARN of the container instance with which to filter the
ListTasks
results. Specifying acontainerInstance
limits the results to tasks that belong to that container instance. - desiredStatus
-
- Type: string
The task desired status with which to filter the
ListTasks
results. Specifying adesiredStatus
ofSTOPPED
limits the results to tasks that Amazon ECS has set the desired status toSTOPPED
. This can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter isRUNNING
, which shows tasks that Amazon ECS has set the desired status toRUNNING
.Although you can filter results based on a desired status of
PENDING
, this does not return any results. Amazon ECS never sets the desired status of a task to that value (only a task'slastStatus
may have a value ofPENDING
). - family
-
- Type: string
The name of the family with which to filter the
ListTasks
results. Specifying afamily
limits the results to tasks that belong to that family. - launchType
-
- Type: string
The launch type for services to list.
- maxResults
-
- Type: int
The maximum number of task results returned by
ListTasks
in paginated output. When this parameter is used,ListTasks
only returnsmaxResults
results in a single page along with anextToken
response element. The remaining results of the initial request can be seen by sending anotherListTasks
request with the returnednextToken
value. This value can be between 1 and 100. If this parameter is not used, thenListTasks
returns up to 100 results and anextToken
value if applicable. - nextToken
-
- Type: string
The
nextToken
value returned from aListTasks
request indicating that more results are available to fulfill the request and further calls will be needed. IfmaxResults
was provided, it is possible the number of results to be fewer thanmaxResults
.This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
- serviceName
-
- Type: string
The name of the service with which to filter the
ListTasks
results. Specifying aserviceName
limits the results to tasks that belong to that service. - startedBy
-
- Type: string
The
startedBy
value with which to filter the task results. Specifying astartedBy
value limits the results to tasks that were started with that value.
Result Syntax
[ 'nextToken' => '<string>', 'taskArns' => ['<string>', ...], ]
Result Details
Members
- nextToken
-
- Type: string
The
nextToken
value to include in a futureListTasks
request. When the results of aListTasks
request exceedmaxResults
, this value can be used to retrieve the next page of results. This value isnull
when there are no more results to return. - taskArns
-
- Type: Array of strings
The list of task ARN entries for the
ListTasks
request.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
-
The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific.
Examples
Example 1: To list the tasks in a cluster
This example lists all of the tasks in a cluster.
$result = $client->listTasks([ 'cluster' => 'default', ]);
Result syntax:
[ 'taskArns' => [ 'arn:aws:ecs:us-east-1:012345678910:task/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84', 'arn:aws:ecs:us-east-1:012345678910:task/6b809ef6-c67e-4467-921f-ee261c15a0a1', ], ]
Example 2: To list the tasks on a particular container instance
This example lists the tasks of a specified container instance. Specifying a ``containerInstance`` value limits the results to tasks that belong to that container instance.
$result = $client->listTasks([ 'cluster' => 'default', 'containerInstance' => 'f6bbb147-5370-4ace-8c73-c7181ded911f', ]);
Result syntax:
[ 'taskArns' => [ 'arn:aws:ecs:us-east-1:012345678910:task/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84', ], ]
PutAccountSetting
$result = $client->putAccountSetting
([/* ... */]); $promise = $client->putAccountSettingAsync
([/* ... */]);
Modifies an account setting. Account settings are set on a per-Region basis.
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.
Parameter Syntax
$result = $client->putAccountSetting([ 'name' => 'serviceLongArnFormat|taskLongArnFormat|containerInstanceLongArnFormat|awsvpcTrunking|containerInsights', // REQUIRED 'principalArn' => '<string>', 'value' => '<string>', // REQUIRED ]);
Parameter Details
Members
- name
-
- Required: Yes
- Type: string
The Amazon ECS resource name for which to modify the account setting. If
serviceLongArnFormat
is specified, the ARN for your Amazon ECS services is affected. IftaskLongArnFormat
is specified, the ARN and resource ID for your Amazon ECS tasks is affected. IfcontainerInstanceLongArnFormat
is specified, the ARN and resource ID for your Amazon ECS container instances is affected. IfawsvpcTrunking
is specified, the elastic network interface (ENI) limit for your Amazon ECS container instances is affected. IfcontainerInsights
is specified, the default setting for CloudWatch Container Insights for your clusters is affected. - principalArn
-
- Type: string
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it modifies the account setting for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.
- value
-
- Required: Yes
- Type: string
The account setting value for the specified principal ARN. Accepted values are
enabled
anddisabled
.
Result Syntax
[ 'setting' => [ 'name' => 'serviceLongArnFormat|taskLongArnFormat|containerInstanceLongArnFormat|awsvpcTrunking|containerInsights', 'principalArn' => '<string>', 'value' => '<string>', ], ]
Result Details
Members
- setting
-
- Type: Setting structure
The current account setting for a resource.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
Examples
Example 1: To modify your account settings
This example modifies your account settings to opt in to the new ARN and resource ID format for Amazon ECS services. If you’re using this command as the root user, then changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves.
$result = $client->putAccountSetting([ 'name' => 'serviceLongArnFormat', 'value' => 'enabled', ]);
Result syntax:
[ 'setting' => [ 'name' => 'serviceLongArnFormat', 'value' => 'enabled', 'principalArn' => 'arn:aws:iam:::user/principalName', ], ]
Example 2: To modify the account settings for a specific IAM user or IAM role
This example modifies the account setting for a specific IAM user or IAM role to opt in to the new ARN and resource ID format for Amazon ECS container instances. If you’re using this command as the root user, then changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves.
$result = $client->putAccountSetting([ 'name' => 'containerInstanceLongArnFormat', 'value' => 'enabled', 'principalArn' => 'arn:aws:iam:::user/principalName', ]);
Result syntax:
[ 'setting' => [ 'name' => 'containerInstanceLongArnFormat', 'value' => 'enabled', 'principalArn' => 'arn:aws:iam:::user/principalName', ], ]
PutAccountSettingDefault
$result = $client->putAccountSettingDefault
([/* ... */]); $promise = $client->putAccountSettingDefaultAsync
([/* ... */]);
Modifies an account setting for all IAM users on an account for whom no individual account setting has been specified. Account settings are set on a per-Region basis.
Parameter Syntax
$result = $client->putAccountSettingDefault([ 'name' => 'serviceLongArnFormat|taskLongArnFormat|containerInstanceLongArnFormat|awsvpcTrunking|containerInsights', // REQUIRED 'value' => '<string>', // REQUIRED ]);
Parameter Details
Members
- name
-
- Required: Yes
- Type: string
The resource name for which to modify the account setting. If
serviceLongArnFormat
is specified, the ARN for your Amazon ECS services is affected. IftaskLongArnFormat
is specified, the ARN and resource ID for your Amazon ECS tasks is affected. IfcontainerInstanceLongArnFormat
is specified, the ARN and resource ID for your Amazon ECS container instances is affected. IfawsvpcTrunking
is specified, the ENI limit for your Amazon ECS container instances is affected. IfcontainerInsights
is specified, the default setting for CloudWatch Container Insights for your clusters is affected. - value
-
- Required: Yes
- Type: string
The account setting value for the specified principal ARN. Accepted values are
enabled
anddisabled
.
Result Syntax
[ 'setting' => [ 'name' => 'serviceLongArnFormat|taskLongArnFormat|containerInstanceLongArnFormat|awsvpcTrunking|containerInsights', 'principalArn' => '<string>', 'value' => '<string>', ], ]
Result Details
Members
- setting
-
- Type: Setting structure
The current account setting for a resource.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
Examples
Example 1: To modify the default account settings for all IAM users or roles on an account
This example modifies the default account setting for the specified resource for all IAM users or roles on an account. These changes apply to the entire AWS account, unless an IAM user or role explicitly overrides these settings for themselves.
$result = $client->putAccountSettingDefault([ 'name' => 'serviceLongArnFormat', 'value' => 'enabled', ]);
Result syntax:
[ 'setting' => [ 'name' => 'serviceLongArnFormat', 'value' => 'enabled', 'principalArn' => 'arn:aws:iam:::root', ], ]
PutAttributes
$result = $client->putAttributes
([/* ... */]); $promise = $client->putAttributesAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->putAttributes([ 'attributes' => [ // REQUIRED [ 'name' => '<string>', // REQUIRED 'targetId' => '<string>', 'targetType' => 'container-instance', 'value' => '<string>', ], // ... ], 'cluster' => '<string>', ]);
Parameter Details
Members
- attributes
-
- Required: Yes
- Type: Array of Attribute structures
The attributes to apply to your resource. You can specify up to 10 custom attributes per resource. You can specify up to 10 attributes in a single call.
- cluster
-
- Type: string
The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply attributes. If you do not specify a cluster, the default cluster is assumed.
Result Syntax
[ 'attributes' => [ [ 'name' => '<string>', 'targetId' => '<string>', 'targetType' => 'container-instance', 'value' => '<string>', ], // ... ], ]
Result Details
Members
- attributes
-
- Type: Array of Attribute structures
The attributes applied to your resource.
Errors
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
-
The specified target could not be found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and Region-specific.
-
AttributeLimitExceededException:
You can apply up to 10 custom attributes per resource. You can view the attributes of a resource with ListAttributes. You can remove existing attributes on a resource with DeleteAttributes.
-
The specified parameter is invalid. Review the available parameters for the API request.
PutClusterCapacityProviders
$result = $client->putClusterCapacityProviders
([/* ... */]); $promise = $client->putClusterCapacityProvidersAsync
([/* ... */]);
Modifies the available capacity providers and the default capacity provider strategy for a cluster.
You must specify both the available capacity providers and a default capacity provider strategy for the cluster. If the specified cluster has existing capacity providers associated with it, you must specify all existing capacity providers in addition to any new ones you want to add. Any existing capacity providers associated with a cluster that are omitted from a PutClusterCapacityProviders API call will be disassociated with the cluster. You can only disassociate an existing capacity provider from a cluster if it's not being used by any existing tasks.
When creating a service or running a task on a cluster, if no capacity provider or launch type is specified, then the cluster's default capacity provider strategy is used. It is recommended to define a default capacity provider strategy for your cluster, however you may specify an empty array ([]
) to bypass defining a default strategy.
Parameter Syntax
$result = $client->putClusterCapacityProviders([ 'capacityProviders' => ['<string>', ...], // REQUIRED 'cluster' => '<string>', // REQUIRED 'defaultCapacityProviderStrategy' => [ // REQUIRED [ 'base' => <integer>, 'capacityProvider' => '<string>', // REQUIRED 'weight' => <integer>, ], // ... ], ]);
Parameter Details
Members
- capacityProviders
-
- Required: Yes
- Type: Array of strings
The name of one or more capacity providers to associate with the cluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the
FARGATE
orFARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used. - cluster
-
- Required: Yes
- Type: string
The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you do not specify a cluster, the default cluster is assumed.
- defaultCapacityProviderStrategy
-
- Required: Yes
- Type: Array of CapacityProviderStrategyItem structures
The capacity provider strategy to use by default for the cluster.
When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.
A capacity provider strategy consists of one or more capacity providers along with the
base
andweight
to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with anACTIVE
orUPDATING
status can be used.If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the
FARGATE
orFARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
Result Syntax
[ 'cluster' => [ 'activeServicesCount' => <integer>, 'attachments' => [ [ 'details' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'id' => '<string>', 'status' => '<string>', 'type' => '<string>', ], // ... ], 'attachmentsStatus' => '<string>', 'capacityProviders' => ['<string>', ...], 'clusterArn' => '<string>', 'clusterName' => '<string>', 'configuration' => [ 'executeCommandConfiguration' => [ 'kmsKeyId' => '<string>', 'logConfiguration' => [ 'cloudWatchEncryptionEnabled' => true || false, 'cloudWatchLogGroupName' => '<string>', 's3BucketName' => '<string>', 's3EncryptionEnabled' => true || false, 's3KeyPrefix' => '<string>', ], 'logging' => 'NONE|DEFAULT|OVERRIDE', ], ], 'defaultCapacityProviderStrategy' => [ [ 'base' => <integer>, 'capacityProvider' => '<string>', 'weight' => <integer>, ], // ... ], 'pendingTasksCount' => <integer>, 'registeredContainerInstancesCount' => <integer>, 'runningTasksCount' => <integer>, 'settings' => [ [ 'name' => 'containerInsights', 'value' => '<string>', ], // ... ], 'statistics' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'status' => '<string>', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], ], ]
Result Details
Members
- cluster
-
- Type: Cluster structure
A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
-
The specified resource is in-use and cannot be removed.
-
There is already a current Amazon ECS container agent update in progress on the specified container instance. If the container agent becomes disconnected while it is in a transitional stage, such as
PENDING
orSTAGING
, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.
RegisterContainerInstance
$result = $client->registerContainerInstance
([/* ... */]); $promise = $client->registerContainerInstanceAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->registerContainerInstance([ 'attributes' => [ [ 'name' => '<string>', // REQUIRED 'targetId' => '<string>', 'targetType' => 'container-instance', 'value' => '<string>', ], // ... ], 'cluster' => '<string>', 'containerInstanceArn' => '<string>', 'instanceIdentityDocument' => '<string>', 'instanceIdentityDocumentSignature' => '<string>', 'platformDevices' => [ [ 'id' => '<string>', // REQUIRED 'type' => 'GPU', // REQUIRED ], // ... ], 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'totalResources' => [ [ 'doubleValue' => <float>, 'integerValue' => <integer>, 'longValue' => <integer>, 'name' => '<string>', 'stringSetValue' => ['<string>', ...], 'type' => '<string>', ], // ... ], 'versionInfo' => [ 'agentHash' => '<string>', 'agentVersion' => '<string>', 'dockerVersion' => '<string>', ], ]);
Parameter Details
Members
- attributes
-
- Type: Array of Attribute structures
The container instance attributes that this container instance supports.
- cluster
-
- Type: string
The short name or full Amazon Resource Name (ARN) of the cluster with which to register your container instance. If you do not specify a cluster, the default cluster is assumed.
- containerInstanceArn
-
- Type: string
The ARN of the container instance (if it was previously registered).
- instanceIdentityDocument
-
- Type: string
The instance identity document for the EC2 instance to register. This document can be found by running the following command from the instance:
curl http://169.254.169.254/latest/dynamic/instance-identity/document/
- instanceIdentityDocumentSignature
-
- Type: string
The instance identity document signature for the EC2 instance to register. This signature can be found by running the following command from the instance:
curl http://169.254.169.254/latest/dynamic/instance-identity/signature/
- platformDevices
-
- Type: Array of PlatformDevice structures
The devices that are available on the container instance. The only supported device type is a GPU.
- tags
-
- Type: Array of Tag structures
The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
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 AWS 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.
- totalResources
-
- Type: Array of Resource structures
The resources available on the instance.
- versionInfo
-
- Type: VersionInfo structure
The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
Result Syntax
[ 'containerInstance' => [ 'agentConnected' => true || false, 'agentUpdateStatus' => 'PENDING|STAGING|STAGED|UPDATING|UPDATED|FAILED', 'attachments' => [ [ 'details' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'id' => '<string>', 'status' => '<string>', 'type' => '<string>', ], // ... ], 'attributes' => [ [ 'name' => '<string>', 'targetId' => '<string>', 'targetType' => 'container-instance', 'value' => '<string>', ], // ... ], 'capacityProviderName' => '<string>', 'containerInstanceArn' => '<string>', 'ec2InstanceId' => '<string>', 'pendingTasksCount' => <integer>, 'registeredAt' => <DateTime>, 'registeredResources' => [ [ 'doubleValue' => <float>, 'integerValue' => <integer>, 'longValue' => <integer>, 'name' => '<string>', 'stringSetValue' => ['<string>', ...], 'type' => '<string>', ], // ... ], 'remainingResources' => [ [ 'doubleValue' => <float>, 'integerValue' => <integer>, 'longValue' => <integer>, 'name' => '<string>', 'stringSetValue' => ['<string>', ...], 'type' => '<string>', ], // ... ], 'runningTasksCount' => <integer>, 'status' => '<string>', 'statusReason' => '<string>', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'version' => <integer>, 'versionInfo' => [ 'agentHash' => '<string>', 'agentVersion' => '<string>', 'dockerVersion' => '<string>', ], ], ]
Result Details
Members
- containerInstance
-
- Type: ContainerInstance structure
The container instance that was registered.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
RegisterTaskDefinition
$result = $client->registerTaskDefinition
([/* ... */]); $promise = $client->registerTaskDefinitionAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->registerTaskDefinition([ 'containerDefinitions' => [ // REQUIRED [ 'command' => ['<string>', ...], 'cpu' => <integer>, 'dependsOn' => [ [ 'condition' => 'START|COMPLETE|SUCCESS|HEALTHY', // REQUIRED 'containerName' => '<string>', // REQUIRED ], // ... ], 'disableNetworking' => true || false, 'dnsSearchDomains' => ['<string>', ...], 'dnsServers' => ['<string>', ...], 'dockerLabels' => ['<string>', ...], 'dockerSecurityOptions' => ['<string>', ...], 'entryPoint' => ['<string>', ...], 'environment' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'environmentFiles' => [ [ 'type' => 's3', // REQUIRED 'value' => '<string>', // REQUIRED ], // ... ], 'essential' => true || false, 'extraHosts' => [ [ 'hostname' => '<string>', // REQUIRED 'ipAddress' => '<string>', // REQUIRED ], // ... ], 'firelensConfiguration' => [ 'options' => ['<string>', ...], 'type' => 'fluentd|fluentbit', // REQUIRED ], 'healthCheck' => [ 'command' => ['<string>', ...], // REQUIRED 'interval' => <integer>, 'retries' => <integer>, 'startPeriod' => <integer>, 'timeout' => <integer>, ], 'hostname' => '<string>', 'image' => '<string>', 'interactive' => true || false, 'links' => ['<string>', ...], 'linuxParameters' => [ 'capabilities' => [ 'add' => ['<string>', ...], 'drop' => ['<string>', ...], ], 'devices' => [ [ 'containerPath' => '<string>', 'hostPath' => '<string>', // REQUIRED 'permissions' => ['<string>', ...], ], // ... ], 'initProcessEnabled' => true || false, 'maxSwap' => <integer>, 'sharedMemorySize' => <integer>, 'swappiness' => <integer>, 'tmpfs' => [ [ 'containerPath' => '<string>', // REQUIRED 'mountOptions' => ['<string>', ...], 'size' => <integer>, // REQUIRED ], // ... ], ], 'logConfiguration' => [ 'logDriver' => 'json-file|syslog|journald|gelf|fluentd|awslogs|splunk|awsfirelens', // REQUIRED 'options' => ['<string>', ...], 'secretOptions' => [ [ 'name' => '<string>', // REQUIRED 'valueFrom' => '<string>', // REQUIRED ], // ... ], ], 'memory' => <integer>, 'memoryReservation' => <integer>, 'mountPoints' => [ [ 'containerPath' => '<string>', 'readOnly' => true || false, 'sourceVolume' => '<string>', ], // ... ], 'name' => '<string>', 'portMappings' => [ [ 'containerPort' => <integer>, 'hostPort' => <integer>, 'protocol' => 'tcp|udp', ], // ... ], 'privileged' => true || false, 'pseudoTerminal' => true || false, 'readonlyRootFilesystem' => true || false, 'repositoryCredentials' => [ 'credentialsParameter' => '<string>', // REQUIRED ], 'resourceRequirements' => [ [ 'type' => 'GPU|InferenceAccelerator', // REQUIRED 'value' => '<string>', // REQUIRED ], // ... ], 'secrets' => [ [ 'name' => '<string>', // REQUIRED 'valueFrom' => '<string>', // REQUIRED ], // ... ], 'startTimeout' => <integer>, 'stopTimeout' => <integer>, 'systemControls' => [ [ 'namespace' => '<string>', 'value' => '<string>', ], // ... ], 'ulimits' => [ [ 'hardLimit' => <integer>, // REQUIRED 'name' => 'core|cpu|data|fsize|locks|memlock|msgqueue|nice|nofile|nproc|rss|rtprio|rttime|sigpending|stack', // REQUIRED 'softLimit' => <integer>, // REQUIRED ], // ... ], 'user' => '<string>', 'volumesFrom' => [ [ 'readOnly' => true || false, 'sourceContainer' => '<string>', ], // ... ], 'workingDirectory' => '<string>', ], // ... ], 'cpu' => '<string>', 'executionRoleArn' => '<string>', 'family' => '<string>', // REQUIRED 'inferenceAccelerators' => [ [ 'deviceName' => '<string>', // REQUIRED 'deviceType' => '<string>', // REQUIRED ], // ... ], 'ipcMode' => 'host|task|none', 'memory' => '<string>', 'networkMode' => 'bridge|host|awsvpc|none', 'pidMode' => 'host|task', 'placementConstraints' => [ [ 'expression' => '<string>', 'type' => 'memberOf', ], // ... ], 'proxyConfiguration' => [ 'containerName' => '<string>', // REQUIRED 'properties' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'type' => 'APPMESH', ], 'requiresCompatibilities' => ['<string>', ...], 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'taskRoleArn' => '<string>', 'volumes' => [ [ 'dockerVolumeConfiguration' => [ 'autoprovision' => true || false, 'driver' => '<string>', 'driverOpts' => ['<string>', ...], 'labels' => ['<string>', ...], 'scope' => 'task|shared', ], 'efsVolumeConfiguration' => [ 'authorizationConfig' => [ 'accessPointId' => '<string>', 'iam' => 'ENABLED|DISABLED', ], 'fileSystemId' => '<string>', // REQUIRED 'rootDirectory' => '<string>', 'transitEncryption' => 'ENABLED|DISABLED', 'transitEncryptionPort' => <integer>, ], 'fsxWindowsFileServerVolumeConfiguration' => [ 'authorizationConfig' => [ // REQUIRED 'credentialsParameter' => '<string>', // REQUIRED 'domain' => '<string>', // REQUIRED ], 'fileSystemId' => '<string>', // REQUIRED 'rootDirectory' => '<string>', // REQUIRED ], 'host' => [ 'sourcePath' => '<string>', ], 'name' => '<string>', ], // ... ], ]);
Parameter Details
Members
- containerDefinitions
-
- Required: Yes
- Type: Array of ContainerDefinition structures
A list of container definitions in JSON format that describe the different containers that make up your task.
- cpu
-
- Type: string
The number of CPU units used by the task. It can be expressed as an integer using CPU units, for example
1024
, or as a string using vCPUs, for example1 vCPU
or1 vcpu
, in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered.Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
If you are using the EC2 launch type, this field is optional. Supported values are between
128
CPU units (0.125
vCPUs) and10240
CPU units (10
vCPUs).If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the
memory
parameter:-
256 (.25 vCPU) - Available
memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) -
512 (.5 vCPU) - Available
memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) -
1024 (1 vCPU) - Available
memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) -
2048 (2 vCPU) - Available
memory
values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) -
4096 (4 vCPU) - Available
memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
- executionRoleArn
-
- Type: string
The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide.
- family
-
- Required: Yes
- Type: string
You must specify a
family
for a task definition, which allows you to track multiple versions of the same task definition. Thefamily
is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. - inferenceAccelerators
-
- Type: Array of InferenceAccelerator structures
The Elastic Inference accelerators to use for the containers in the task.
- ipcMode
-
- Type: string
The IPC resource namespace to use for the containers in the task. The valid values are
host
,task
, ornone
. Ifhost
is specified, then all containers within the tasks that specified thehost
IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. Iftask
is specified, all containers within the specified task share the same IPC resources. Ifnone
is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.If the
host
IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.If you are setting namespaced kernel parameters using
systemControls
for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.-
For tasks that use the
host
IPC mode, IPC namespace relatedsystemControls
are not supported. -
For tasks that use the
task
IPC mode, IPC namespace relatedsystemControls
will apply to all containers within a task.
This parameter is not supported for Windows containers or tasks run on AWS Fargate.
- memory
-
- Type: string
The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB, for example
1024
, or as a string using GB, for example1GB
or1 GB
, in a task definition. String values are converted to an integer indicating the MiB when the task definition is registered.Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.
If using the EC2 launch type, this field is optional.
If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the
cpu
parameter:-
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available
cpu
values: 256 (.25 vCPU) -
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available
cpu
values: 512 (.5 vCPU) -
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available
cpu
values: 1024 (1 vCPU) -
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available
cpu
values: 2048 (2 vCPU) -
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available
cpu
values: 4096 (4 vCPU)
- networkMode
-
- Type: string
The Docker networking mode to use for the containers in the task. The valid values are
none
,bridge
,awsvpc
, andhost
. If no network mode is specified, the default isbridge
.For Amazon ECS tasks on Fargate, the
awsvpc
network mode is required. For Amazon ECS tasks on Amazon EC2 instances, any network mode can be used. If the network mode is set tonone
, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. Thehost
andawsvpc
network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by thebridge
mode.With the
host
andawsvpc
network modes, exposed container ports are mapped directly to the corresponding host port (for thehost
network mode) or the attached elastic network interface port (for theawsvpc
network mode), so you cannot take advantage of dynamic host port mappings.When using the
host
network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.If the network mode is
awsvpc
, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value 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.Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the
ecs-init
package, or AWS Fargate infrastructure support theawsvpc
network mode.If the network mode is
host
, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the
<default>
network mode object.For more information, see Network settings in the Docker run reference.
- pidMode
-
- Type: string
The process namespace to use for the containers in the task. The valid values are
host
ortask
. Ifhost
is specified, then all containers within the tasks that specified thehost
PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. Iftask
is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference.If the
host
PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.This parameter is not supported for Windows containers or tasks run on AWS Fargate.
- placementConstraints
-
- Type: Array of TaskDefinitionPlacementConstraint structures
An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
- proxyConfiguration
-
- Type: ProxyConfiguration structure
The configuration details for the App Mesh proxy.
For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the
ecs-init
package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version20190301
or later, then they contain the required versions of the container agent andecs-init
. For more information, see Amazon ECS-optimized Linux AMI - requiresCompatibilities
-
- Type: Array of strings
The task launch type that Amazon ECS should validate the task definition against. A client exception is returned if the task definition doesn't validate against the compatibilities specified. If no value is specified, the parameter is omitted from the response.
- tags
-
- Type: Array of Tag structures
The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
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 AWS 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.
- taskRoleArn
-
- Type: string
The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
- volumes
-
- Type: Array of Volume structures
A list of volume definitions in JSON format that containers in your task may use.
Result Syntax
[ 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'taskDefinition' => [ 'compatibilities' => ['<string>', ...], 'containerDefinitions' => [ [ 'command' => ['<string>', ...], 'cpu' => <integer>, 'dependsOn' => [ [ 'condition' => 'START|COMPLETE|SUCCESS|HEALTHY', 'containerName' => '<string>', ], // ... ], 'disableNetworking' => true || false, 'dnsSearchDomains' => ['<string>', ...], 'dnsServers' => ['<string>', ...], 'dockerLabels' => ['<string>', ...], 'dockerSecurityOptions' => ['<string>', ...], 'entryPoint' => ['<string>', ...], 'environment' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'environmentFiles' => [ [ 'type' => 's3', 'value' => '<string>', ], // ... ], 'essential' => true || false, 'extraHosts' => [ [ 'hostname' => '<string>', 'ipAddress' => '<string>', ], // ... ], 'firelensConfiguration' => [ 'options' => ['<string>', ...], 'type' => 'fluentd|fluentbit', ], 'healthCheck' => [ 'command' => ['<string>', ...], 'interval' => <integer>, 'retries' => <integer>, 'startPeriod' => <integer>, 'timeout' => <integer>, ], 'hostname' => '<string>', 'image' => '<string>', 'interactive' => true || false, 'links' => ['<string>', ...], 'linuxParameters' => [ 'capabilities' => [ 'add' => ['<string>', ...], 'drop' => ['<string>', ...], ], 'devices' => [ [ 'containerPath' => '<string>', 'hostPath' => '<string>', 'permissions' => ['<string>', ...], ], // ... ], 'initProcessEnabled' => true || false, 'maxSwap' => <integer>, 'sharedMemorySize' => <integer>, 'swappiness' => <integer>, 'tmpfs' => [ [ 'containerPath' => '<string>', 'mountOptions' => ['<string>', ...], 'size' => <integer>, ], // ... ], ], 'logConfiguration' => [ 'logDriver' => 'json-file|syslog|journald|gelf|fluentd|awslogs|splunk|awsfirelens', 'options' => ['<string>', ...], 'secretOptions' => [ [ 'name' => '<string>', 'valueFrom' => '<string>', ], // ... ], ], 'memory' => <integer>, 'memoryReservation' => <integer>, 'mountPoints' => [ [ 'containerPath' => '<string>', 'readOnly' => true || false, 'sourceVolume' => '<string>', ], // ... ], 'name' => '<string>', 'portMappings' => [ [ 'containerPort' => <integer>, 'hostPort' => <integer>, 'protocol' => 'tcp|udp', ], // ... ], 'privileged' => true || false, 'pseudoTerminal' => true || false, 'readonlyRootFilesystem' => true || false, 'repositoryCredentials' => [ 'credentialsParameter' => '<string>', ], 'resourceRequirements' => [ [ 'type' => 'GPU|InferenceAccelerator', 'value' => '<string>', ], // ... ], 'secrets' => [ [ 'name' => '<string>', 'valueFrom' => '<string>', ], // ... ], 'startTimeout' => <integer>, 'stopTimeout' => <integer>, 'systemControls' => [ [ 'namespace' => '<string>', 'value' => '<string>', ], // ... ], 'ulimits' => [ [ 'hardLimit' => <integer>, 'name' => 'core|cpu|data|fsize|locks|memlock|msgqueue|nice|nofile|nproc|rss|rtprio|rttime|sigpending|stack', 'softLimit' => <integer>, ], // ... ], 'user' => '<string>', 'volumesFrom' => [ [ 'readOnly' => true || false, 'sourceContainer' => '<string>', ], // ... ], 'workingDirectory' => '<string>', ], // ... ], 'cpu' => '<string>', 'deregisteredAt' => <DateTime>, 'executionRoleArn' => '<string>', 'family' => '<string>', 'inferenceAccelerators' => [ [ 'deviceName' => '<string>', 'deviceType' => '<string>', ], // ... ], 'ipcMode' => 'host|task|none', 'memory' => '<string>', 'networkMode' => 'bridge|host|awsvpc|none', 'pidMode' => 'host|task', 'placementConstraints' => [ [ 'expression' => '<string>', 'type' => 'memberOf', ], // ... ], 'proxyConfiguration' => [ 'containerName' => '<string>', 'properties' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'type' => 'APPMESH', ], 'registeredAt' => <DateTime>, 'registeredBy' => '<string>', 'requiresAttributes' => [ [ 'name' => '<string>', 'targetId' => '<string>', 'targetType' => 'container-instance', 'value' => '<string>', ], // ... ], 'requiresCompatibilities' => ['<string>', ...], 'revision' => <integer>, 'status' => 'ACTIVE|INACTIVE', 'taskDefinitionArn' => '<string>', 'taskRoleArn' => '<string>', 'volumes' => [ [ 'dockerVolumeConfiguration' => [ 'autoprovision' => true || false, 'driver' => '<string>', 'driverOpts' => ['<string>', ...], 'labels' => ['<string>', ...], 'scope' => 'task|shared', ], 'efsVolumeConfiguration' => [ 'authorizationConfig' => [ 'accessPointId' => '<string>', 'iam' => 'ENABLED|DISABLED', ], 'fileSystemId' => '<string>', 'rootDirectory' => '<string>', 'transitEncryption' => 'ENABLED|DISABLED', 'transitEncryptionPort' => <integer>, ], 'fsxWindowsFileServerVolumeConfiguration' => [ 'authorizationConfig' => [ 'credentialsParameter' => '<string>', 'domain' => '<string>', ], 'fileSystemId' => '<string>', 'rootDirectory' => '<string>', ], 'host' => [ 'sourcePath' => '<string>', ], 'name' => '<string>', ], // ... ], ], ]
Result Details
Members
- tags
-
- Type: Array of Tag structures
The list of tags associated with the task definition.
- taskDefinition
-
- Type: TaskDefinition structure
The full description of the registered task definition.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
Examples
Example 1: To register a task definition
This example registers a task definition to the specified family.
$result = $client->registerTaskDefinition([ 'containerDefinitions' => [ [ 'name' => 'sleep', 'command' => [ 'sleep', '360', ], 'cpu' => 10, 'essential' => 1, 'image' => 'busybox', 'memory' => 10, ], ], 'family' => 'sleep360', 'taskRoleArn' => '', 'volumes' => [ ], ]);
Result syntax:
[ 'taskDefinition' => [ 'containerDefinitions' => [ [ 'name' => 'sleep', 'command' => [ 'sleep', '360', ], 'cpu' => 10, 'environment' => [ ], 'essential' => 1, 'image' => 'busybox', 'memory' => 10, 'mountPoints' => [ ], 'portMappings' => [ ], 'volumesFrom' => [ ], ], ], 'family' => 'sleep360', 'revision' => 1, 'taskDefinitionArn' => 'arn:aws:ecs:us-east-1::task-definition/sleep360:19', 'volumes' => [ ], ], ]
RunTask
$result = $client->runTask
([/* ... */]); $promise = $client->runTaskAsync
([/* ... */]);
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:
-
Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.
-
Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.
Parameter Syntax
$result = $client->runTask([ 'capacityProviderStrategy' => [ [ 'base' => <integer>, 'capacityProvider' => '<string>', // REQUIRED 'weight' => <integer>, ], // ... ], 'cluster' => '<string>', 'count' => <integer>, 'enableECSManagedTags' => true || false, 'enableExecuteCommand' => true || false, 'group' => '<string>', 'launchType' => 'EC2|FARGATE', 'networkConfiguration' => [ 'awsvpcConfiguration' => [ 'assignPublicIp' => 'ENABLED|DISABLED', 'securityGroups' => ['<string>', ...], 'subnets' => ['<string>', ...], // REQUIRED ], ], 'overrides' => [ 'containerOverrides' => [ [ 'command' => ['<string>', ...], 'cpu' => <integer>, 'environment' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'environmentFiles' => [ [ 'type' => 's3', // REQUIRED 'value' => '<string>', // REQUIRED ], // ... ], 'memory' => <integer>, 'memoryReservation' => <integer>, 'name' => '<string>', 'resourceRequirements' => [ [ 'type' => 'GPU|InferenceAccelerator', // REQUIRED 'value' => '<string>', // REQUIRED ], // ... ], ], // ... ], 'cpu' => '<string>', 'executionRoleArn' => '<string>', 'inferenceAcceleratorOverrides' => [ [ 'deviceName' => '<string>', 'deviceType' => '<string>', ], // ... ], 'memory' => '<string>', 'taskRoleArn' => '<string>', ], 'placementConstraints' => [ [ 'expression' => '<string>', 'type' => 'distinctInstance|memberOf', ], // ... ], 'placementStrategy' => [ [ 'field' => '<string>', 'type' => 'random|spread|binpack', ], // ... ], 'platformVersion' => '<string>', 'propagateTags' => 'TASK_DEFINITION|SERVICE', 'referenceId' => '<string>', 'startedBy' => '<string>', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'taskDefinition' => '<string>', // REQUIRED ]);
Parameter Details
Members
- capacityProviderStrategy
-
- Type: Array of CapacityProviderStrategyItem structures
The capacity provider strategy to use for the task.
If a
capacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
orlaunchType
is specified, thedefaultCapacityProviderStrategy
for the cluster is used. - cluster
-
- Type: string
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed.
- count
-
- Type: int
The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.
- enableECSManagedTags
-
- Type: boolean
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
- enableExecuteCommand
-
- Type: boolean
Whether or not to enable the execute command functionality for the containers in this task. If
true
, this enables execute command functionality on all containers in the task. - group
-
- Type: string
The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).
- launchType
-
- Type: string
The launch type on which to run your task. The accepted values are
FARGATE
andEC2
. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.When a value of
FARGATE
is specified, your tasks are launched on AWS Fargate On-Demand infrastructure. To use Fargate Spot, you must use a capacity provider strategy with theFARGATE_SPOT
capacity provider.When a value of
EC2
is specified, your tasks are launched on Amazon EC2 instances registered to your cluster.If a
launchType
is specified, thecapacityProviderStrategy
parameter must be omitted. - networkConfiguration
-
- Type: NetworkConfiguration structure
The network configuration for the task. This parameter is required for task definitions that use the
awsvpc
network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide. - overrides
-
- Type: TaskOverride structure
A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a
command
override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with anenvironment
override.A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
- placementConstraints
-
- Type: Array of PlacementConstraint structures
An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
- placementStrategy
-
- Type: Array of PlacementStrategy structures
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
- platformVersion
-
- Type: string
The platform version the task should run. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the
LATEST
platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide. - propagateTags
-
- Type: string
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not 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.
An error will be received if you specify the
SERVICE
option when running a task. - referenceId
-
- Type: string
The reference ID to use for the task.
- startedBy
-
- Type: string
An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the
startedBy
parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with thestartedBy
value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.If a task is started by an Amazon ECS service, then the
startedBy
parameter contains the deployment ID of the service that starts it. - tags
-
- Type: Array of Tag structures
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
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 AWS 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.
- taskDefinition
-
- Required: Yes
- Type: string
The
family
andrevision
(family:revision
) or full ARN of the task definition to run. If arevision
is not specified, the latestACTIVE
revision is used.
Result Syntax
[ 'failures' => [ [ 'arn' => '<string>', 'detail' => '<string>', 'reason' => '<string>', ], // ... ], 'tasks' => [ [ 'attachments' => [ [ 'details' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'id' => '<string>', 'status' => '<string>', 'type' => '<string>', ], // ... ], 'attributes' => [ [ 'name' => '<string>', 'targetId' => '<string>', 'targetType' => 'container-instance', 'value' => '<string>', ], // ... ], 'availabilityZone' => '<string>', 'capacityProviderName' => '<string>', 'clusterArn' => '<string>', 'connectivity' => 'CONNECTED|DISCONNECTED', 'connectivityAt' => <DateTime>, 'containerInstanceArn' => '<string>', 'containers' => [ [ 'containerArn' => '<string>', 'cpu' => '<string>', 'exitCode' => <integer>, 'gpuIds' => ['<string>', ...], 'healthStatus' => 'HEALTHY|UNHEALTHY|UNKNOWN', 'image' => '<string>', 'imageDigest' => '<string>', 'lastStatus' => '<string>', 'managedAgents' => [ [ 'lastStartedAt' => <DateTime>, 'lastStatus' => '<string>', 'name' => 'ExecuteCommandAgent', 'reason' => '<string>', ], // ... ], 'memory' => '<string>', 'memoryReservation' => '<string>', 'name' => '<string>', 'networkBindings' => [ [ 'bindIP' => '<string>', 'containerPort' => <integer>, 'hostPort' => <integer>, 'protocol' => 'tcp|udp', ], // ... ], 'networkInterfaces' => [ [ 'attachmentId' => '<string>', 'ipv6Address' => '<string>', 'privateIpv4Address' => '<string>', ], // ... ], 'reason' => '<string>', 'runtimeId' => '<string>', 'taskArn' => '<string>', ], // ... ], 'cpu' => '<string>', 'createdAt' => <DateTime>, 'desiredStatus' => '<string>', 'enableExecuteCommand' => true || false, 'executionStoppedAt' => <DateTime>, 'group' => '<string>', 'healthStatus' => 'HEALTHY|UNHEALTHY|UNKNOWN', 'inferenceAccelerators' => [ [ 'deviceName' => '<string>', 'deviceType' => '<string>', ], // ... ], 'lastStatus' => '<string>', 'launchType' => 'EC2|FARGATE', 'memory' => '<string>', 'overrides' => [ 'containerOverrides' => [ [ 'command' => ['<string>', ...], 'cpu' => <integer>, 'environment' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'environmentFiles' => [ [ 'type' => 's3', 'value' => '<string>', ], // ... ], 'memory' => <integer>, 'memoryReservation' => <integer>, 'name' => '<string>', 'resourceRequirements' => [ [ 'type' => 'GPU|InferenceAccelerator', 'value' => '<string>', ], // ... ], ], // ... ], 'cpu' => '<string>', 'executionRoleArn' => '<string>', 'inferenceAcceleratorOverrides' => [ [ 'deviceName' => '<string>', 'deviceType' => '<string>', ], // ... ], 'memory' => '<string>', 'taskRoleArn' => '<string>', ], 'platformVersion' => '<string>', 'pullStartedAt' => <DateTime>, 'pullStoppedAt' => <DateTime>, 'startedAt' => <DateTime>, 'startedBy' => '<string>', 'stopCode' => 'TaskFailedToStart|EssentialContainerExited|UserInitiated', 'stoppedAt' => <DateTime>, 'stoppedReason' => '<string>', 'stoppingAt' => <DateTime>, 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'taskArn' => '<string>', 'taskDefinitionArn' => '<string>', 'version' => <integer>, ], // ... ], ]
Result Details
Members
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
-
The specified task is not supported in this Region.
-
The specified platform version does not exist.
-
PlatformTaskDefinitionIncompatibilityException:
The specified platform version does not satisfy the task definition's required capabilities.
-
You do not have authorization to perform the requested action.
-
Your AWS account has been blocked. For more information, contact AWS Support.
Examples
Example 1: To run a task on your default cluster
This example runs the specified task definition on your default cluster.
$result = $client->runTask([ 'cluster' => 'default', 'taskDefinition' => 'sleep360:1', ]);
Result syntax:
[ 'tasks' => [ [ 'containerInstanceArn' => 'arn:aws:ecs:us-east-1::container-instance/ffe3d344-77e2-476c-a4d0-bf560ad50acb', 'containers' => [ [ 'name' => 'sleep', 'containerArn' => 'arn:aws:ecs:us-east-1: :container/58591c8e-be29-4ddf-95aa-ee459d4c59fd', 'lastStatus' => 'PENDING', 'taskArn' => 'arn:aws:ecs:us-east-1: :task/a9f21ea7-c9f5-44b1-b8e6-b31f50ed33c0', ], ], 'desiredStatus' => 'RUNNING', 'lastStatus' => 'PENDING', 'overrides' => [ 'containerOverrides' => [ [ 'name' => 'sleep', ], ], ], 'taskArn' => 'arn:aws:ecs:us-east-1: :task/a9f21ea7-c9f5-44b1-b8e6-b31f50ed33c0', 'taskDefinitionArn' => 'arn:aws:ecs:us-east-1: :task-definition/sleep360:1', ], ], ]
StartTask
$result = $client->startTask
([/* ... */]); $promise = $client->startTaskAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->startTask([ 'cluster' => '<string>', 'containerInstances' => ['<string>', ...], // REQUIRED 'enableECSManagedTags' => true || false, 'enableExecuteCommand' => true || false, 'group' => '<string>', 'networkConfiguration' => [ 'awsvpcConfiguration' => [ 'assignPublicIp' => 'ENABLED|DISABLED', 'securityGroups' => ['<string>', ...], 'subnets' => ['<string>', ...], // REQUIRED ], ], 'overrides' => [ 'containerOverrides' => [ [ 'command' => ['<string>', ...], 'cpu' => <integer>, 'environment' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'environmentFiles' => [ [ 'type' => 's3', // REQUIRED 'value' => '<string>', // REQUIRED ], // ... ], 'memory' => <integer>, 'memoryReservation' => <integer>, 'name' => '<string>', 'resourceRequirements' => [ [ 'type' => 'GPU|InferenceAccelerator', // REQUIRED 'value' => '<string>', // REQUIRED ], // ... ], ], // ... ], 'cpu' => '<string>', 'executionRoleArn' => '<string>', 'inferenceAcceleratorOverrides' => [ [ 'deviceName' => '<string>', 'deviceType' => '<string>', ], // ... ], 'memory' => '<string>', 'taskRoleArn' => '<string>', ], 'propagateTags' => 'TASK_DEFINITION|SERVICE', 'referenceId' => '<string>', 'startedBy' => '<string>', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'taskDefinition' => '<string>', // REQUIRED ]);
Parameter Details
Members
- cluster
-
- Type: string
The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed.
- containerInstances
-
- Required: Yes
- Type: Array of strings
The container instance IDs or full ARN entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.
- enableECSManagedTags
-
- Type: boolean
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
- enableExecuteCommand
-
- Type: boolean
Whether or not the execute command functionality is enabled for the task. If
true
, this enables execute command functionality on all containers in the task. - group
-
- Type: string
The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).
- networkConfiguration
-
- Type: NetworkConfiguration structure
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the
awsvpc
networking mode. - overrides
-
- Type: TaskOverride structure
A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a
command
override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with anenvironment
override.A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.
- propagateTags
-
- Type: string
Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.
- referenceId
-
- Type: string
The reference ID to use for the task.
- startedBy
-
- Type: string
An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the
startedBy
parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with thestartedBy
value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.If a task is started by an Amazon ECS service, then the
startedBy
parameter contains the deployment ID of the service that starts it. - tags
-
- Type: Array of Tag structures
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
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 AWS 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.
- taskDefinition
-
- Required: Yes
- Type: string
The
family
andrevision
(family:revision
) or full ARN of the task definition to start. If arevision
is not specified, the latestACTIVE
revision is used.
Result Syntax
[ 'failures' => [ [ 'arn' => '<string>', 'detail' => '<string>', 'reason' => '<string>', ], // ... ], 'tasks' => [ [ 'attachments' => [ [ 'details' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'id' => '<string>', 'status' => '<string>', 'type' => '<string>', ], // ... ], 'attributes' => [ [ 'name' => '<string>', 'targetId' => '<string>', 'targetType' => 'container-instance', 'value' => '<string>', ], // ... ], 'availabilityZone' => '<string>', 'capacityProviderName' => '<string>', 'clusterArn' => '<string>', 'connectivity' => 'CONNECTED|DISCONNECTED', 'connectivityAt' => <DateTime>, 'containerInstanceArn' => '<string>', 'containers' => [ [ 'containerArn' => '<string>', 'cpu' => '<string>', 'exitCode' => <integer>, 'gpuIds' => ['<string>', ...], 'healthStatus' => 'HEALTHY|UNHEALTHY|UNKNOWN', 'image' => '<string>', 'imageDigest' => '<string>', 'lastStatus' => '<string>', 'managedAgents' => [ [ 'lastStartedAt' => <DateTime>, 'lastStatus' => '<string>', 'name' => 'ExecuteCommandAgent', 'reason' => '<string>', ], // ... ], 'memory' => '<string>', 'memoryReservation' => '<string>', 'name' => '<string>', 'networkBindings' => [ [ 'bindIP' => '<string>', 'containerPort' => <integer>, 'hostPort' => <integer>, 'protocol' => 'tcp|udp', ], // ... ], 'networkInterfaces' => [ [ 'attachmentId' => '<string>', 'ipv6Address' => '<string>', 'privateIpv4Address' => '<string>', ], // ... ], 'reason' => '<string>', 'runtimeId' => '<string>', 'taskArn' => '<string>', ], // ... ], 'cpu' => '<string>', 'createdAt' => <DateTime>, 'desiredStatus' => '<string>', 'enableExecuteCommand' => true || false, 'executionStoppedAt' => <DateTime>, 'group' => '<string>', 'healthStatus' => 'HEALTHY|UNHEALTHY|UNKNOWN', 'inferenceAccelerators' => [ [ 'deviceName' => '<string>', 'deviceType' => '<string>', ], // ... ], 'lastStatus' => '<string>', 'launchType' => 'EC2|FARGATE', 'memory' => '<string>', 'overrides' => [ 'containerOverrides' => [ [ 'command' => ['<string>', ...], 'cpu' => <integer>, 'environment' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'environmentFiles' => [ [ 'type' => 's3', 'value' => '<string>', ], // ... ], 'memory' => <integer>, 'memoryReservation' => <integer>, 'name' => '<string>', 'resourceRequirements' => [ [ 'type' => 'GPU|InferenceAccelerator', 'value' => '<string>', ], // ... ], ], // ... ], 'cpu' => '<string>', 'executionRoleArn' => '<string>', 'inferenceAcceleratorOverrides' => [ [ 'deviceName' => '<string>', 'deviceType' => '<string>', ], // ... ], 'memory' => '<string>', 'taskRoleArn' => '<string>', ], 'platformVersion' => '<string>', 'pullStartedAt' => <DateTime>, 'pullStoppedAt' => <DateTime>, 'startedAt' => <DateTime>, 'startedBy' => '<string>', 'stopCode' => 'TaskFailedToStart|EssentialContainerExited|UserInitiated', 'stoppedAt' => <DateTime>, 'stoppedReason' => '<string>', 'stoppingAt' => <DateTime>, 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'taskArn' => '<string>', 'taskDefinitionArn' => '<string>', 'version' => <integer>, ], // ... ], ]
Result Details
Members
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
StopTask
$result = $client->stopTask
([/* ... */]); $promise = $client->stopTaskAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->stopTask([ 'cluster' => '<string>', 'reason' => '<string>', 'task' => '<string>', // REQUIRED ]);
Parameter Details
Members
- cluster
-
- Type: string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.
- reason
-
- Type: string
An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.
- task
-
- Required: Yes
- Type: string
The task ID or full Amazon Resource Name (ARN) of the task to stop.
Result Syntax
[ 'task' => [ 'attachments' => [ [ 'details' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'id' => '<string>', 'status' => '<string>', 'type' => '<string>', ], // ... ], 'attributes' => [ [ 'name' => '<string>', 'targetId' => '<string>', 'targetType' => 'container-instance', 'value' => '<string>', ], // ... ], 'availabilityZone' => '<string>', 'capacityProviderName' => '<string>', 'clusterArn' => '<string>', 'connectivity' => 'CONNECTED|DISCONNECTED', 'connectivityAt' => <DateTime>, 'containerInstanceArn' => '<string>', 'containers' => [ [ 'containerArn' => '<string>', 'cpu' => '<string>', 'exitCode' => <integer>, 'gpuIds' => ['<string>', ...], 'healthStatus' => 'HEALTHY|UNHEALTHY|UNKNOWN', 'image' => '<string>', 'imageDigest' => '<string>', 'lastStatus' => '<string>', 'managedAgents' => [ [ 'lastStartedAt' => <DateTime>, 'lastStatus' => '<string>', 'name' => 'ExecuteCommandAgent', 'reason' => '<string>', ], // ... ], 'memory' => '<string>', 'memoryReservation' => '<string>', 'name' => '<string>', 'networkBindings' => [ [ 'bindIP' => '<string>', 'containerPort' => <integer>, 'hostPort' => <integer>, 'protocol' => 'tcp|udp', ], // ... ], 'networkInterfaces' => [ [ 'attachmentId' => '<string>', 'ipv6Address' => '<string>', 'privateIpv4Address' => '<string>', ], // ... ], 'reason' => '<string>', 'runtimeId' => '<string>', 'taskArn' => '<string>', ], // ... ], 'cpu' => '<string>', 'createdAt' => <DateTime>, 'desiredStatus' => '<string>', 'enableExecuteCommand' => true || false, 'executionStoppedAt' => <DateTime>, 'group' => '<string>', 'healthStatus' => 'HEALTHY|UNHEALTHY|UNKNOWN', 'inferenceAccelerators' => [ [ 'deviceName' => '<string>', 'deviceType' => '<string>', ], // ... ], 'lastStatus' => '<string>', 'launchType' => 'EC2|FARGATE', 'memory' => '<string>', 'overrides' => [ 'containerOverrides' => [ [ 'command' => ['<string>', ...], 'cpu' => <integer>, 'environment' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'environmentFiles' => [ [ 'type' => 's3', 'value' => '<string>', ], // ... ], 'memory' => <integer>, 'memoryReservation' => <integer>, 'name' => '<string>', 'resourceRequirements' => [ [ 'type' => 'GPU|InferenceAccelerator', 'value' => '<string>', ], // ... ], ], // ... ], 'cpu' => '<string>', 'executionRoleArn' => '<string>', 'inferenceAcceleratorOverrides' => [ [ 'deviceName' => '<string>', 'deviceType' => '<string>', ], // ... ], 'memory' => '<string>', 'taskRoleArn' => '<string>', ], 'platformVersion' => '<string>', 'pullStartedAt' => <DateTime>, 'pullStoppedAt' => <DateTime>, 'startedAt' => <DateTime>, 'startedBy' => '<string>', 'stopCode' => 'TaskFailedToStart|EssentialContainerExited|UserInitiated', 'stoppedAt' => <DateTime>, 'stoppedReason' => '<string>', 'stoppingAt' => <DateTime>, 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'taskArn' => '<string>', 'taskDefinitionArn' => '<string>', 'version' => <integer>, ], ]
Result Details
Members
- task
-
- Type: Task structure
The task that was stopped.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
SubmitAttachmentStateChanges
$result = $client->submitAttachmentStateChanges
([/* ... */]); $promise = $client->submitAttachmentStateChangesAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->submitAttachmentStateChanges([ 'attachments' => [ // REQUIRED [ 'attachmentArn' => '<string>', // REQUIRED 'status' => '<string>', // REQUIRED ], // ... ], 'cluster' => '<string>', ]);
Parameter Details
Members
- attachments
-
- Required: Yes
- Type: Array of AttachmentStateChange structures
Any attachments associated with the state change request.
- cluster
-
- Type: string
The short name or full ARN of the cluster that hosts the container instance the attachment belongs to.
Result Syntax
[ 'acknowledgment' => '<string>', ]
Result Details
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
You do not have authorization to perform the requested action.
-
The specified parameter is invalid. Review the available parameters for the API request.
SubmitContainerStateChange
$result = $client->submitContainerStateChange
([/* ... */]); $promise = $client->submitContainerStateChangeAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->submitContainerStateChange([ 'cluster' => '<string>', 'containerName' => '<string>', 'exitCode' => <integer>, 'networkBindings' => [ [ 'bindIP' => '<string>', 'containerPort' => <integer>, 'hostPort' => <integer>, 'protocol' => 'tcp|udp', ], // ... ], 'reason' => '<string>', 'runtimeId' => '<string>', 'status' => '<string>', 'task' => '<string>', ]);
Parameter Details
Members
- cluster
-
- Type: string
The short name or full ARN of the cluster that hosts the container.
- containerName
-
- Type: string
The name of the container.
- exitCode
-
- Type: int
The exit code returned for the state change request.
- networkBindings
-
- Type: Array of NetworkBinding structures
The network bindings of the container.
- reason
-
- Type: string
The reason for the state change request.
- runtimeId
-
- Type: string
The ID of the Docker container.
- status
-
- Type: string
The status of the state change request.
- task
-
- Type: string
The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.
Result Syntax
[ 'acknowledgment' => '<string>', ]
Result Details
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
You do not have authorization to perform the requested action.
SubmitTaskStateChange
$result = $client->submitTaskStateChange
([/* ... */]); $promise = $client->submitTaskStateChangeAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->submitTaskStateChange([ 'attachments' => [ [ 'attachmentArn' => '<string>', // REQUIRED 'status' => '<string>', // REQUIRED ], // ... ], 'cluster' => '<string>', 'containers' => [ [ 'containerName' => '<string>', 'exitCode' => <integer>, 'imageDigest' => '<string>', 'networkBindings' => [ [ 'bindIP' => '<string>', 'containerPort' => <integer>, 'hostPort' => <integer>, 'protocol' => 'tcp|udp', ], // ... ], 'reason' => '<string>', 'runtimeId' => '<string>', 'status' => '<string>', ], // ... ], 'executionStoppedAt' => <integer || string || DateTime>, 'managedAgents' => [ [ 'containerName' => '<string>', // REQUIRED 'managedAgentName' => 'ExecuteCommandAgent', // REQUIRED 'reason' => '<string>', 'status' => '<string>', // REQUIRED ], // ... ], 'pullStartedAt' => <integer || string || DateTime>, 'pullStoppedAt' => <integer || string || DateTime>, 'reason' => '<string>', 'status' => '<string>', 'task' => '<string>', ]);
Parameter Details
Members
- attachments
-
- Type: Array of AttachmentStateChange structures
Any attachments associated with the state change request.
- cluster
-
- Type: string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.
- containers
-
- Type: Array of ContainerStateChange structures
Any containers associated with the state change request.
- executionStoppedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp for when the task execution stopped.
- managedAgents
-
- Type: Array of ManagedAgentStateChange structures
The details for the managed agent associated with the task.
- pullStartedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp for when the container image pull began.
- pullStoppedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp for when the container image pull completed.
- reason
-
- Type: string
The reason for the state change request.
- status
-
- Type: string
The status of the state change request.
- task
-
- Type: string
The task ID or full ARN of the task in the state change request.
Result Syntax
[ 'acknowledgment' => '<string>', ]
Result Details
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
You do not have authorization to perform the requested action.
-
The specified parameter is invalid. Review the available parameters for the API request.
TagResource
$result = $client->tagResource
([/* ... */]); $promise = $client->tagResourceAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->tagResource([ 'resourceArn' => '<string>', // REQUIRED 'tags' => [ // REQUIRED [ 'key' => '<string>', 'value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances.
- tags
-
- Required: Yes
- Type: Array of Tag structures
The tags to add to the resource. A tag is an array of key-value pairs.
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 AWS 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.
Result Syntax
[]
Result Details
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
-
The specified resource could not be found.
-
The specified parameter is invalid. Review the available parameters for the API request.
Examples
Example 1: To tag a cluster.
This example tags the 'dev' cluster with key 'team' and value 'dev'.
$result = $client->tagResource([ 'resourceArn' => 'arn:aws:ecs:region:aws_account_id:cluster/dev', 'tags' => [ [ 'key' => 'team', 'value' => 'dev', ], ], ]);
Result syntax:
[ ]
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Deletes specified tags from a resource.
Parameter Syntax
$result = $client->untagResource([ 'resourceArn' => '<string>', // REQUIRED 'tagKeys' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances.
- tagKeys
-
- Required: Yes
- Type: Array of strings
The keys of the tags to be removed.
Result Syntax
[]
Result Details
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
-
The specified resource could not be found.
-
The specified parameter is invalid. Review the available parameters for the API request.
Examples
Example 1: To untag a cluster.
This example deletes the 'team' tag from the 'dev' cluster.
$result = $client->untagResource([ 'resourceArn' => 'arn:aws:ecs:region:aws_account_id:cluster/dev', 'tagKeys' => [ 'team', ], ]);
Result syntax:
[ ]
UpdateCapacityProvider
$result = $client->updateCapacityProvider
([/* ... */]); $promise = $client->updateCapacityProviderAsync
([/* ... */]);
Modifies the parameters for a capacity provider.
Parameter Syntax
$result = $client->updateCapacityProvider([ 'autoScalingGroupProvider' => [ // REQUIRED 'managedScaling' => [ 'instanceWarmupPeriod' => <integer>, 'maximumScalingStepSize' => <integer>, 'minimumScalingStepSize' => <integer>, 'status' => 'ENABLED|DISABLED', 'targetCapacity' => <integer>, ], 'managedTerminationProtection' => 'ENABLED|DISABLED', ], 'name' => '<string>', // REQUIRED ]);
Parameter Details
Members
- autoScalingGroupProvider
-
- Required: Yes
- Type: AutoScalingGroupProviderUpdate structure
An object representing the parameters to update for the Auto Scaling group capacity provider.
- name
-
- Required: Yes
- Type: string
The name of the capacity provider to update.
Result Syntax
[ 'capacityProvider' => [ 'autoScalingGroupProvider' => [ 'autoScalingGroupArn' => '<string>', 'managedScaling' => [ 'instanceWarmupPeriod' => <integer>, 'maximumScalingStepSize' => <integer>, 'minimumScalingStepSize' => <integer>, 'status' => 'ENABLED|DISABLED', 'targetCapacity' => <integer>, ], 'managedTerminationProtection' => 'ENABLED|DISABLED', ], 'capacityProviderArn' => '<string>', 'name' => '<string>', 'status' => 'ACTIVE|INACTIVE', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'updateStatus' => 'DELETE_IN_PROGRESS|DELETE_COMPLETE|DELETE_FAILED|UPDATE_IN_PROGRESS|UPDATE_COMPLETE|UPDATE_FAILED', 'updateStatusReason' => '<string>', ], ]
Result Details
Members
- capacityProvider
-
- Type: CapacityProvider structure
The details of a capacity provider.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
UpdateCluster
$result = $client->updateCluster
([/* ... */]); $promise = $client->updateClusterAsync
([/* ... */]);
Updates the cluster.
Parameter Syntax
$result = $client->updateCluster([ 'cluster' => '<string>', // REQUIRED 'configuration' => [ 'executeCommandConfiguration' => [ 'kmsKeyId' => '<string>', 'logConfiguration' => [ 'cloudWatchEncryptionEnabled' => true || false, 'cloudWatchLogGroupName' => '<string>', 's3BucketName' => '<string>', 's3EncryptionEnabled' => true || false, 's3KeyPrefix' => '<string>', ], 'logging' => 'NONE|DEFAULT|OVERRIDE', ], ], 'settings' => [ [ 'name' => 'containerInsights', 'value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- cluster
-
- Required: Yes
- Type: string
The name of the cluster to modify the settings for.
- configuration
-
- Type: ClusterConfiguration structure
The execute command configuration for the cluster.
- settings
-
- Type: Array of ClusterSetting structures
The cluster settings for your cluster.
Result Syntax
[ 'cluster' => [ 'activeServicesCount' => <integer>, 'attachments' => [ [ 'details' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'id' => '<string>', 'status' => '<string>', 'type' => '<string>', ], // ... ], 'attachmentsStatus' => '<string>', 'capacityProviders' => ['<string>', ...], 'clusterArn' => '<string>', 'clusterName' => '<string>', 'configuration' => [ 'executeCommandConfiguration' => [ 'kmsKeyId' => '<string>', 'logConfiguration' => [ 'cloudWatchEncryptionEnabled' => true || false, 'cloudWatchLogGroupName' => '<string>', 's3BucketName' => '<string>', 's3EncryptionEnabled' => true || false, 's3KeyPrefix' => '<string>', ], 'logging' => 'NONE|DEFAULT|OVERRIDE', ], ], 'defaultCapacityProviderStrategy' => [ [ 'base' => <integer>, 'capacityProvider' => '<string>', 'weight' => <integer>, ], // ... ], 'pendingTasksCount' => <integer>, 'registeredContainerInstancesCount' => <integer>, 'runningTasksCount' => <integer>, 'settings' => [ [ 'name' => 'containerInsights', 'value' => '<string>', ], // ... ], 'statistics' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'status' => '<string>', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], ], ]
Result Details
Members
- cluster
-
- Type: Cluster structure
A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
-
The specified parameter is invalid. Review the available parameters for the API request.
UpdateClusterSettings
$result = $client->updateClusterSettings
([/* ... */]); $promise = $client->updateClusterSettingsAsync
([/* ... */]);
Modifies the settings to use for a cluster.
Parameter Syntax
$result = $client->updateClusterSettings([ 'cluster' => '<string>', // REQUIRED 'settings' => [ // REQUIRED [ 'name' => 'containerInsights', 'value' => '<string>', ], // ... ], ]);
Parameter Details
Members
- cluster
-
- Required: Yes
- Type: string
The name of the cluster to modify the settings for.
- settings
-
- Required: Yes
- Type: Array of ClusterSetting structures
The setting to use by default for a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the
containerInsights
value set with PutAccountSetting or PutAccountSettingDefault.
Result Syntax
[ 'cluster' => [ 'activeServicesCount' => <integer>, 'attachments' => [ [ 'details' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'id' => '<string>', 'status' => '<string>', 'type' => '<string>', ], // ... ], 'attachmentsStatus' => '<string>', 'capacityProviders' => ['<string>', ...], 'clusterArn' => '<string>', 'clusterName' => '<string>', 'configuration' => [ 'executeCommandConfiguration' => [ 'kmsKeyId' => '<string>', 'logConfiguration' => [ 'cloudWatchEncryptionEnabled' => true || false, 'cloudWatchLogGroupName' => '<string>', 's3BucketName' => '<string>', 's3EncryptionEnabled' => true || false, 's3KeyPrefix' => '<string>', ], 'logging' => 'NONE|DEFAULT|OVERRIDE', ], ], 'defaultCapacityProviderStrategy' => [ [ 'base' => <integer>, 'capacityProvider' => '<string>', 'weight' => <integer>, ], // ... ], 'pendingTasksCount' => <integer>, 'registeredContainerInstancesCount' => <integer>, 'runningTasksCount' => <integer>, 'settings' => [ [ 'name' => 'containerInsights', 'value' => '<string>', ], // ... ], 'statistics' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'status' => '<string>', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], ], ]
Result Details
Members
- cluster
-
- Type: Cluster structure
A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
-
The specified parameter is invalid. Review the available parameters for the API request.
UpdateContainerAgent
$result = $client->updateContainerAgent
([/* ... */]); $promise = $client->updateContainerAgentAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->updateContainerAgent([ 'cluster' => '<string>', 'containerInstance' => '<string>', // REQUIRED ]);
Parameter Details
Members
- cluster
-
- Type: string
The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on. If you do not specify a cluster, the default cluster is assumed.
- containerInstance
-
- Required: Yes
- Type: string
The container instance ID or full ARN entries for the container instance on which you would like to update the Amazon ECS container agent.
Result Syntax
[ 'containerInstance' => [ 'agentConnected' => true || false, 'agentUpdateStatus' => 'PENDING|STAGING|STAGED|UPDATING|UPDATED|FAILED', 'attachments' => [ [ 'details' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'id' => '<string>', 'status' => '<string>', 'type' => '<string>', ], // ... ], 'attributes' => [ [ 'name' => '<string>', 'targetId' => '<string>', 'targetType' => 'container-instance', 'value' => '<string>', ], // ... ], 'capacityProviderName' => '<string>', 'containerInstanceArn' => '<string>', 'ec2InstanceId' => '<string>', 'pendingTasksCount' => <integer>, 'registeredAt' => <DateTime>, 'registeredResources' => [ [ 'doubleValue' => <float>, 'integerValue' => <integer>, 'longValue' => <integer>, 'name' => '<string>', 'stringSetValue' => ['<string>', ...], 'type' => '<string>', ], // ... ], 'remainingResources' => [ [ 'doubleValue' => <float>, 'integerValue' => <integer>, 'longValue' => <integer>, 'name' => '<string>', 'stringSetValue' => ['<string>', ...], 'type' => '<string>', ], // ... ], 'runningTasksCount' => <integer>, 'status' => '<string>', 'statusReason' => '<string>', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'version' => <integer>, 'versionInfo' => [ 'agentHash' => '<string>', 'agentVersion' => '<string>', 'dockerVersion' => '<string>', ], ], ]
Result Details
Members
- containerInstance
-
- Type: ContainerInstance structure
The container instance for which the container agent was updated.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
-
There is already a current Amazon ECS container agent update in progress on the specified container instance. If the container agent becomes disconnected while it is in a transitional stage, such as
PENDING
orSTAGING
, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously. -
There is no update available for this Amazon ECS container agent. This could be because the agent is already running the latest version, or it is so old that there is no update path to the current version.
-
Amazon ECS is unable to determine the current version of the Amazon ECS container agent on the container instance and does not have enough information to proceed with an update. This could be because the agent running on the container instance is an older or custom version that does not use our version information.
UpdateContainerInstancesState
$result = $client->updateContainerInstancesState
([/* ... */]); $promise = $client->updateContainerInstancesStateAsync
([/* ... */]);
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.
-
If
minimumHealthyPercent
is below 100%, the scheduler can ignoredesiredCount
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 theRUNNING
state. Tasks for services that use a load balancer are considered healthy if they are in theRUNNING
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, ifdesiredCount
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.
Parameter Syntax
$result = $client->updateContainerInstancesState([ 'cluster' => '<string>', 'containerInstances' => ['<string>', ...], // REQUIRED 'status' => 'ACTIVE|DRAINING|REGISTERING|DEREGISTERING|REGISTRATION_FAILED', // REQUIRED ]);
Parameter Details
Members
- cluster
-
- Type: string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to update. If you do not specify a cluster, the default cluster is assumed.
- containerInstances
-
- Required: Yes
- Type: Array of strings
A list of container instance IDs or full ARN entries.
- status
-
- Required: Yes
- Type: string
The container instance state with which to update the container instance. The only valid values for this action are
ACTIVE
andDRAINING
. A container instance can only be updated toDRAINING
status once it has reached anACTIVE
state. If a container instance is inREGISTERING
,DEREGISTERING
, orREGISTRATION_FAILED
state you can describe the container instance but will be unable to update the container instance state.
Result Syntax
[ 'containerInstances' => [ [ 'agentConnected' => true || false, 'agentUpdateStatus' => 'PENDING|STAGING|STAGED|UPDATING|UPDATED|FAILED', 'attachments' => [ [ 'details' => [ [ 'name' => '<string>', 'value' => '<string>', ], // ... ], 'id' => '<string>', 'status' => '<string>', 'type' => '<string>', ], // ... ], 'attributes' => [ [ 'name' => '<string>', 'targetId' => '<string>', 'targetType' => 'container-instance', 'value' => '<string>', ], // ... ], 'capacityProviderName' => '<string>', 'containerInstanceArn' => '<string>', 'ec2InstanceId' => '<string>', 'pendingTasksCount' => <integer>, 'registeredAt' => <DateTime>, 'registeredResources' => [ [ 'doubleValue' => <float>, 'integerValue' => <integer>, 'longValue' => <integer>, 'name' => '<string>', 'stringSetValue' => ['<string>', ...], 'type' => '<string>', ], // ... ], 'remainingResources' => [ [ 'doubleValue' => <float>, 'integerValue' => <integer>, 'longValue' => <integer>, 'name' => '<string>', 'stringSetValue' => ['<string>', ...], 'type' => '<string>', ], // ... ], 'runningTasksCount' => <integer>, 'status' => '<string>', 'statusReason' => '<string>', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'version' => <integer>, 'versionInfo' => [ 'agentHash' => '<string>', 'agentVersion' => '<string>', 'dockerVersion' => '<string>', ], ], // ... ], 'failures' => [ [ 'arn' => '<string>', 'detail' => '<string>', 'reason' => '<string>', ], // ... ], ]
Result Details
Members
- containerInstances
-
- Type: Array of ContainerInstance structures
The list of container instances.
- failures
-
- Type: Array of Failure structures
Any failures associated with the call.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
UpdateService
$result = $client->updateService
([/* ... */]); $promise = $client->updateServiceAsync
([/* ... */]);
Updating the task placement strategies and constraints on an Amazon ECS service remains in preview and is a Beta Service as defined by and subject to the Beta Service Participation Service Terms located at https://aws.amazon.com/service-terms ("Beta Terms"). These Beta Terms apply to your participation in this preview.
Modifies the parameters of a service.
For services using the rolling update (ECS
) deployment controller, the desired count, deployment configuration, network configuration, task placement constraints and strategies, or task definition used can be updated.
For services using the blue/green (CODE_DEPLOY
) deployment controller, only the desired count, deployment configuration, task placement constraints and strategies, 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, task placement constraints and strategies, 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.
-
If
minimumHealthyPercent
is below 100%, the scheduler can ignoredesiredCount
temporarily during a deployment. For example, ifdesiredCount
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 theRUNNING
state. Tasks for services that use a load balancer are considered healthy if they are in theRUNNING
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, ifdesiredCount
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:
-
Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).
-
By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy):
-
Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. 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.
-
When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:
-
Sort the container instances by the largest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have two, container instances in either zone B or C are considered optimal for termination.
-
Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service.
Parameter Syntax
$result = $client->updateService([ 'capacityProviderStrategy' => [ [ 'base' => <integer>, 'capacityProvider' => '<string>', // REQUIRED 'weight' => <integer>, ], // ... ], 'cluster' => '<string>', 'deploymentConfiguration' => [ 'deploymentCircuitBreaker' => [ 'enable' => true || false, // REQUIRED 'rollback' => true || false, // REQUIRED ], 'maximumPercent' => <integer>, 'minimumHealthyPercent' => <integer>, ], 'desiredCount' => <integer>, 'enableExecuteCommand' => true || false, 'forceNewDeployment' => true || false, 'healthCheckGracePeriodSeconds' => <integer>, 'networkConfiguration' => [ 'awsvpcConfiguration' => [ 'assignPublicIp' => 'ENABLED|DISABLED', 'securityGroups' => ['<string>', ...], 'subnets' => ['<string>', ...], // REQUIRED ], ], 'placementConstraints' => [ [ 'expression' => '<string>', 'type' => 'distinctInstance|memberOf', ], // ... ], 'placementStrategy' => [ [ 'field' => '<string>', 'type' => 'random|spread|binpack', ], // ... ], 'platformVersion' => '<string>', 'service' => '<string>', // REQUIRED 'taskDefinition' => '<string>', ]);
Parameter Details
Members
- capacityProviderStrategy
-
- Type: Array of CapacityProviderStrategyItem structures
The capacity provider strategy to update the service to use.
If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers as opposed to the default capacity provider strategy. However, when a service is using a capacity provider strategy that is not the default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.
A capacity provider strategy consists of one or more capacity providers along with the
base
andweight
to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with anACTIVE
orUPDATING
status can be used.If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the
FARGATE
orFARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
- cluster
-
- Type: string
The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.
- deploymentConfiguration
-
- Type: DeploymentConfiguration structure
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
- desiredCount
-
- Type: int
The number of instantiations of the task to place and keep running in your service.
- enableExecuteCommand
-
- Type: boolean
If
true
, this enables execute command functionality on all task containers.If you do not want to override the value that was set when the service was created, you can set this to
null
when performing this action. - forceNewDeployment
-
- Type: boolean
Whether to force a new deployment of the service. Deployments are not forced by default. You can use this option to trigger a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (
my_image:latest
) or to roll Fargate tasks onto a newer platform version. - healthCheckGracePeriodSeconds
-
- Type: int
The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
- networkConfiguration
-
- Type: NetworkConfiguration structure
An object representing the network configuration for a task or service.
- placementConstraints
-
- Type: Array of PlacementConstraint structures
An array of task placement constraint objects to update the service to use. If no value is specified, the existing placement constraints for the service will remain unchanged. If this value is specified, it will override any existing placement constraints defined for the service. To remove all existing placement constraints, specify an empty array.
You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).
- placementStrategy
-
- Type: Array of PlacementStrategy structures
The task placement strategy objects to update the service to use. If no value is specified, the existing placement strategy for the service will remain unchanged. If this value is specified, it will override the existing placement strategy defined for the service. To remove an existing placement strategy, specify an empty object.
You can specify a maximum of five strategy rules per service.
- platformVersion
-
- Type: string
The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If a platform version is not specified, the
LATEST
platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide. - service
-
- Required: Yes
- Type: string
The name of the service to update.
- taskDefinition
-
- Type: string
The
family
andrevision
(family:revision
) or full ARN of the task definition to run in your service. If arevision
is not specified, the latestACTIVE
revision is used. If you modify the task definition withUpdateService
, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.
Result Syntax
[ 'service' => [ 'capacityProviderStrategy' => [ [ 'base' => <integer>, 'capacityProvider' => '<string>', 'weight' => <integer>, ], // ... ], 'clusterArn' => '<string>', 'createdAt' => <DateTime>, 'createdBy' => '<string>', 'deploymentConfiguration' => [ 'deploymentCircuitBreaker' => [ 'enable' => true || false, 'rollback' => true || false, ], 'maximumPercent' => <integer>, 'minimumHealthyPercent' => <integer>, ], 'deploymentController' => [ 'type' => 'ECS|CODE_DEPLOY|EXTERNAL', ], 'deployments' => [ [ 'capacityProviderStrategy' => [ [ 'base' => <integer>, 'capacityProvider' => '<string>', 'weight' => <integer>, ], // ... ], 'createdAt' => <DateTime>, 'desiredCount' => <integer>, 'failedTasks' => <integer>, 'id' => '<string>', 'launchType' => 'EC2|FARGATE', 'networkConfiguration' => [ 'awsvpcConfiguration' => [ 'assignPublicIp' => 'ENABLED|DISABLED', 'securityGroups' => ['<string>', ...], 'subnets' => ['<string>', ...], ], ], 'pendingCount' => <integer>, 'platformVersion' => '<string>', 'rolloutState' => 'COMPLETED|FAILED|IN_PROGRESS', 'rolloutStateReason' => '<string>', 'runningCount' => <integer>, 'status' => '<string>', 'taskDefinition' => '<string>', 'updatedAt' => <DateTime>, ], // ... ], 'desiredCount' => <integer>, 'enableECSManagedTags' => true || false, 'enableExecuteCommand' => true || false, 'events' => [ [ 'createdAt' => <DateTime>, 'id' => '<string>', 'message' => '<string>', ], // ... ], 'healthCheckGracePeriodSeconds' => <integer>, 'launchType' => 'EC2|FARGATE', 'loadBalancers' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'loadBalancerName' => '<string>', 'targetGroupArn' => '<string>', ], // ... ], 'networkConfiguration' => [ 'awsvpcConfiguration' => [ 'assignPublicIp' => 'ENABLED|DISABLED', 'securityGroups' => ['<string>', ...], 'subnets' => ['<string>', ...], ], ], 'pendingCount' => <integer>, 'placementConstraints' => [ [ 'expression' => '<string>', 'type' => 'distinctInstance|memberOf', ], // ... ], 'placementStrategy' => [ [ 'field' => '<string>', 'type' => 'random|spread|binpack', ], // ... ], 'platformVersion' => '<string>', 'propagateTags' => 'TASK_DEFINITION|SERVICE', 'roleArn' => '<string>', 'runningCount' => <integer>, 'schedulingStrategy' => 'REPLICA|DAEMON', 'serviceArn' => '<string>', 'serviceName' => '<string>', 'serviceRegistries' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'port' => <integer>, 'registryArn' => '<string>', ], // ... ], 'status' => '<string>', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'taskDefinition' => '<string>', 'taskSets' => [ [ 'capacityProviderStrategy' => [ [ 'base' => <integer>, 'capacityProvider' => '<string>', 'weight' => <integer>, ], // ... ], 'clusterArn' => '<string>', 'computedDesiredCount' => <integer>, 'createdAt' => <DateTime>, 'externalId' => '<string>', 'id' => '<string>', 'launchType' => 'EC2|FARGATE', 'loadBalancers' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'loadBalancerName' => '<string>', 'targetGroupArn' => '<string>', ], // ... ], 'networkConfiguration' => [ 'awsvpcConfiguration' => [ 'assignPublicIp' => 'ENABLED|DISABLED', 'securityGroups' => ['<string>', ...], 'subnets' => ['<string>', ...], ], ], 'pendingCount' => <integer>, 'platformVersion' => '<string>', 'runningCount' => <integer>, 'scale' => [ 'unit' => 'PERCENT', 'value' => <float>, ], 'serviceArn' => '<string>', 'serviceRegistries' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'port' => <integer>, 'registryArn' => '<string>', ], // ... ], 'stabilityStatus' => 'STEADY_STATE|STABILIZING', 'stabilityStatusAt' => <DateTime>, 'startedBy' => '<string>', 'status' => '<string>', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'taskDefinition' => '<string>', 'taskSetArn' => '<string>', 'updatedAt' => <DateTime>, ], // ... ], ], ]
Result Details
Members
- service
-
- Type: Service structure
The full description of your service following the update call.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
-
The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific.
-
The specified service is not active. You can't update a service that is inactive. If you have previously deleted a service, you can re-create it with CreateService.
-
The specified platform version does not exist.
-
PlatformTaskDefinitionIncompatibilityException:
The specified platform version does not satisfy the task definition's required capabilities.
-
You do not have authorization to perform the requested action.
Examples
Example 1: To change the task definition used in a service
This example updates the my-http-service service to use the amazon-ecs-sample task definition.
$result = $client->updateService([ 'service' => 'my-http-service', 'taskDefinition' => 'amazon-ecs-sample', ]);
Result syntax:
[ ]
Example 2: To change the number of tasks in a service
This example updates the desired count of the my-http-service service to 10.
$result = $client->updateService([ 'desiredCount' => 10, 'service' => 'my-http-service', ]);
Result syntax:
[ ]
UpdateServicePrimaryTaskSet
$result = $client->updateServicePrimaryTaskSet
([/* ... */]); $promise = $client->updateServicePrimaryTaskSetAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->updateServicePrimaryTaskSet([ 'cluster' => '<string>', // REQUIRED 'primaryTaskSet' => '<string>', // REQUIRED 'service' => '<string>', // REQUIRED ]);
Parameter Details
Members
- cluster
-
- Required: Yes
- Type: string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in.
- primaryTaskSet
-
- Required: Yes
- Type: string
The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the deployment.
- service
-
- Required: Yes
- Type: string
The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.
Result Syntax
[ 'taskSet' => [ 'capacityProviderStrategy' => [ [ 'base' => <integer>, 'capacityProvider' => '<string>', 'weight' => <integer>, ], // ... ], 'clusterArn' => '<string>', 'computedDesiredCount' => <integer>, 'createdAt' => <DateTime>, 'externalId' => '<string>', 'id' => '<string>', 'launchType' => 'EC2|FARGATE', 'loadBalancers' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'loadBalancerName' => '<string>', 'targetGroupArn' => '<string>', ], // ... ], 'networkConfiguration' => [ 'awsvpcConfiguration' => [ 'assignPublicIp' => 'ENABLED|DISABLED', 'securityGroups' => ['<string>', ...], 'subnets' => ['<string>', ...], ], ], 'pendingCount' => <integer>, 'platformVersion' => '<string>', 'runningCount' => <integer>, 'scale' => [ 'unit' => 'PERCENT', 'value' => <float>, ], 'serviceArn' => '<string>', 'serviceRegistries' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'port' => <integer>, 'registryArn' => '<string>', ], // ... ], 'stabilityStatus' => 'STEADY_STATE|STABILIZING', 'stabilityStatusAt' => <DateTime>, 'startedBy' => '<string>', 'status' => '<string>', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'taskDefinition' => '<string>', 'taskSetArn' => '<string>', 'updatedAt' => <DateTime>, ], ]
Result Details
Members
- taskSet
-
- Type: TaskSet structure
Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an
EXTERNAL
deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
-
The specified task is not supported in this Region.
-
The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific.
-
The specified service is not active. You can't update a service that is inactive. If you have previously deleted a service, you can re-create it with CreateService.
-
The specified task set could not be found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region.
-
You do not have authorization to perform the requested action.
UpdateTaskSet
$result = $client->updateTaskSet
([/* ... */]); $promise = $client->updateTaskSetAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->updateTaskSet([ 'cluster' => '<string>', // REQUIRED 'scale' => [ // REQUIRED 'unit' => 'PERCENT', 'value' => <float>, ], 'service' => '<string>', // REQUIRED 'taskSet' => '<string>', // REQUIRED ]);
Parameter Details
Members
- cluster
-
- Required: Yes
- Type: string
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in.
- scale
-
- Required: Yes
- Type: Scale structure
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
- service
-
- Required: Yes
- Type: string
The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.
- taskSet
-
- Required: Yes
- Type: string
The short name or full Amazon Resource Name (ARN) of the task set to update.
Result Syntax
[ 'taskSet' => [ 'capacityProviderStrategy' => [ [ 'base' => <integer>, 'capacityProvider' => '<string>', 'weight' => <integer>, ], // ... ], 'clusterArn' => '<string>', 'computedDesiredCount' => <integer>, 'createdAt' => <DateTime>, 'externalId' => '<string>', 'id' => '<string>', 'launchType' => 'EC2|FARGATE', 'loadBalancers' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'loadBalancerName' => '<string>', 'targetGroupArn' => '<string>', ], // ... ], 'networkConfiguration' => [ 'awsvpcConfiguration' => [ 'assignPublicIp' => 'ENABLED|DISABLED', 'securityGroups' => ['<string>', ...], 'subnets' => ['<string>', ...], ], ], 'pendingCount' => <integer>, 'platformVersion' => '<string>', 'runningCount' => <integer>, 'scale' => [ 'unit' => 'PERCENT', 'value' => <float>, ], 'serviceArn' => '<string>', 'serviceRegistries' => [ [ 'containerName' => '<string>', 'containerPort' => <integer>, 'port' => <integer>, 'registryArn' => '<string>', ], // ... ], 'stabilityStatus' => 'STEADY_STATE|STABILIZING', 'stabilityStatusAt' => <DateTime>, 'startedBy' => '<string>', 'status' => '<string>', 'tags' => [ [ 'key' => '<string>', 'value' => '<string>', ], // ... ], 'taskDefinition' => '<string>', 'taskSetArn' => '<string>', 'updatedAt' => <DateTime>, ], ]
Result Details
Members
- taskSet
-
- Type: TaskSet structure
Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an
EXTERNAL
deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.
Errors
-
These errors are usually caused by a server issue.
-
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
-
The specified parameter is invalid. Review the available parameters for the API request.
-
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
-
The specified task is not supported in this Region.
-
You do not have authorization to perform the requested action.
-
The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific.
-
The specified service is not active. You can't update a service that is inactive. If you have previously deleted a service, you can re-create it with CreateService.
-
The specified task set could not be found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region.
Shapes
AccessDeniedException
Description
You do not have authorization to perform the requested action.
Members
Attachment
Description
An object representing a container instance or task attachment.
Members
- details
-
- Type: Array of KeyValuePair structures
Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.
- id
-
- Type: string
The unique identifier for the attachment.
- status
-
- Type: string
The status of the attachment. Valid values are
PRECREATED
,CREATED
,ATTACHING
,ATTACHED
,DETACHING
,DETACHED
, andDELETED
. - type
-
- Type: string
The type of the attachment, such as
ElasticNetworkInterface
.
AttachmentStateChange
Description
An object representing a change in state for a task attachment.
Members
Attribute
Description
An attribute is a name-value pair associated with an Amazon ECS object. Attributes enable you to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
Members
- name
-
- Required: Yes
- Type: string
The name of the attribute. The
name
must contain between 1 and 128 characters and name may contain letters (uppercase and lowercase), numbers, hyphens, underscores, forward slashes, back slashes, or periods. - targetId
-
- Type: string
The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).
- targetType
-
- Type: string
The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN.
- value
-
- Type: string
The value of the attribute. The
value
must contain between 1 and 128 characters and may contain letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, back slashes, colons, or spaces. The value cannot contain any leading or trailing whitespace.
AttributeLimitExceededException
Description
You can apply up to 10 custom attributes per resource. You can view the attributes of a resource with ListAttributes. You can remove existing attributes on a resource with DeleteAttributes.
Members
AutoScalingGroupProvider
Description
The details of the Auto Scaling group for the capacity provider.
Members
- autoScalingGroupArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) that identifies the Auto Scaling group.
- managedScaling
-
- Type: ManagedScaling structure
The managed scaling settings for the Auto Scaling group capacity provider.
- managedTerminationProtection
-
- Type: string
The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection.
When using managed termination protection, managed scaling must also be used otherwise managed termination protection will not work.
When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled as well. For more information, see Instance Protection in the AWS Auto Scaling User Guide.
When managed termination protection is disabled, your Amazon EC2 instances are not protected from termination when the Auto Scaling group scales in.
AutoScalingGroupProviderUpdate
Description
The details of the Auto Scaling group capacity provider to update.
Members
- managedScaling
-
- Type: ManagedScaling structure
The managed scaling settings for the Auto Scaling group capacity provider.
When managed scaling is enabled, Amazon ECS manages the scale-in and scale-out actions of the Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS-managed CloudWatch metric with the specified
targetCapacity
value as the target value for the metric. For more information, see Using Managed Scaling in the Amazon Elastic Container Service Developer Guide.If managed scaling is disabled, the user must manage the scaling of the Auto Scaling group.
- managedTerminationProtection
-
- Type: string
The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection.
When using managed termination protection, managed scaling must also be used otherwise managed termination protection will not work.
When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled as well. For more information, see Instance Protection in the AWS Auto Scaling User Guide.
When managed termination protection is disabled, your Amazon EC2 instances are not protected from termination when the Auto Scaling group scales in.
AwsVpcConfiguration
Description
An object representing the networking details for a task or service.
Members
- assignPublicIp
-
- Type: string
Whether the task's elastic network interface receives a public IP address. The default value is
DISABLED
. - securityGroups
-
- Type: Array of strings
The IDs of the security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per
AwsVpcConfiguration
.All specified security groups must be from the same VPC.
- subnets
-
- Required: Yes
- Type: Array of strings
The IDs of the subnets associated with the task or service. There is a limit of 16 subnets that can be specified per
AwsVpcConfiguration
.All specified subnets must be from the same VPC.
BlockedException
CapacityProvider
Description
The details of a capacity provider.
Members
- autoScalingGroupProvider
-
- Type: AutoScalingGroupProvider structure
The Auto Scaling group settings for the capacity provider.
- capacityProviderArn
-
- Type: string
The Amazon Resource Name (ARN) that identifies the capacity provider.
- name
-
- Type: string
The name of the capacity provider.
- status
-
- Type: string
The current status of the capacity provider. Only capacity providers in an
ACTIVE
state can be used in a cluster. When a capacity provider is successfully deleted, it will have anINACTIVE
status. - tags
-
- Type: Array of Tag structures
The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value, both of which you define.
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 AWS 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.
- updateStatus
-
- Type: string
The update status of the capacity provider. The following are the possible states that will be returned.
- DELETE_IN_PROGRESS
-
The capacity provider is in the process of being deleted.
- DELETE_COMPLETE
-
The capacity provider has been successfully deleted and will have an
INACTIVE
status. - DELETE_FAILED
-
The capacity provider was unable to be deleted. The update status reason will provide further details about why the delete failed.
- updateStatusReason
-
- Type: string
The update status reason. This provides further details about the update status for the capacity provider.
CapacityProviderStrategyItem
Description
The details of a capacity provider strategy. A capacity provider strategy can be set when using the RunTask or CreateCluster APIs or as the default capacity provider strategy for a cluster with the CreateCluster API.
Only capacity providers that are already associated with a cluster and have an ACTIVE
or UPDATING
status can be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE
or FARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used in a capacity provider strategy.
Members
- base
-
- Type: int
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of
0
is used. - capacityProvider
-
- Required: Yes
- Type: string
The short name of the capacity provider.
- weight
-
- Type: int
The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The
weight
value is taken into consideration after thebase
value, if defined, is satisfied.If no
weight
value is specified, the default value of0
is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of0
will not be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of0
, anyRunTask
orCreateService
actions using the capacity provider strategy will fail.An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of
1
, then when thebase
is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of1
for capacityProviderA and a weight of4
for capacityProviderB, then for every one task that is run using capacityProviderA, four tasks would use capacityProviderB.
ClientException
Description
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
Members
Cluster
Description
A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.
Members
- activeServicesCount
-
- Type: int
The number of services that are running on the cluster in an
ACTIVE
state. You can view these services with ListServices. - attachments
-
- Type: Array of Attachment structures
The resources attached to a cluster. When using a capacity provider with a cluster, the Auto Scaling plan that is created will be returned as a cluster attachment.
- attachmentsStatus
-
- Type: string
The status of the capacity providers associated with the cluster. The following are the states that will be returned:
- UPDATE_IN_PROGRESS
-
The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is provisioning or deprovisioning.
- UPDATE_COMPLETE
-
The capacity providers have successfully updated.
- UPDATE_FAILED
-
The capacity provider updates failed.
- capacityProviders
-
- Type: Array of strings
The capacity providers associated with the cluster.
- clusterArn
-
- Type: string
The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the
arn:aws:ecs
namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, thecluster
namespace, and then the cluster name. For example,arn:aws:ecs:region:012345678910:cluster/test
. - clusterName
-
- Type: string
A user-generated string that you use to identify your cluster.
- configuration
-
- Type: ClusterConfiguration structure
The execute command configuration for the cluster.
- defaultCapacityProviderStrategy
-
- Type: Array of CapacityProviderStrategyItem structures
The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.
- pendingTasksCount
-
- Type: int
The number of tasks in the cluster that are in the
PENDING
state. - registeredContainerInstancesCount
-
- Type: int
The number of container instances registered into the cluster. This includes container instances in both
ACTIVE
andDRAINING
status. - runningTasksCount
-
- Type: int
The number of tasks in the cluster that are in the
RUNNING
state. - settings
-
- Type: Array of ClusterSetting structures
The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.
- statistics
-
- Type: Array of KeyValuePair structures
Additional information about your clusters that are separated by launch type, including:
-
runningEC2TasksCount
-
RunningFargateTasksCount
-
pendingEC2TasksCount
-
pendingFargateTasksCount
-
activeEC2ServiceCount
-
activeFargateServiceCount
-
drainingEC2ServiceCount
-
drainingFargateServiceCount
- status
-
- Type: string
The status of the cluster. The following are the possible states that will be returned.
- ACTIVE
-
The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.
- PROVISIONING
-
The cluster has capacity providers associated with it and the resources needed for the capacity provider are being created.
- DEPROVISIONING
-
The cluster has capacity providers associated with it and the resources needed for the capacity provider are being deleted.
- FAILED
-
The cluster has capacity providers associated with it and the resources needed for the capacity provider have failed to create.
- INACTIVE
-
The cluster has been deleted. Clusters with an
INACTIVE
status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future, so you should not rely onINACTIVE
clusters persisting.
- tags
-
- Type: Array of Tag structures
The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
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 AWS 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.
ClusterConfiguration
Description
The execute command configuration for the cluster.
Members
- executeCommandConfiguration
-
- Type: ExecuteCommandConfiguration structure
The details of the execute command configuration.
ClusterContainsContainerInstancesException
Description
You cannot delete a cluster that has registered container instances. First, deregister the container instances before you can delete the cluster. For more information, see DeregisterContainerInstance.
Members
ClusterContainsServicesException
Description
You cannot delete a cluster that contains services. First, update the service to reduce its desired task count to 0 and then delete the service. For more information, see UpdateService and DeleteService.
Members
ClusterContainsTasksException
Description
You cannot delete a cluster that has active tasks.
Members
ClusterNotFoundException
Description
The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.
Members
ClusterSetting
Description
The settings to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster.
Members
- name
-
- Type: string
The name of the cluster setting. The only supported value is
containerInsights
. - value
-
- Type: string
The value to set for the cluster setting. The supported values are
enabled
anddisabled
. Ifenabled
is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be disabled unless thecontainerInsights
account setting is enabled. If a cluster value is specified, it will override thecontainerInsights
value set with PutAccountSetting or PutAccountSettingDefault.
Container
Description
A Docker container that is part of a task.
Members
- containerArn
-
- Type: string
The Amazon Resource Name (ARN) of the container.
- cpu
-
- Type: string
The number of CPU units set for the container. The value will be
0
if no value was specified in the container definition when the task definition was registered. - exitCode
-
- Type: int
The exit code returned from the container.
- gpuIds
-
- Type: Array of strings
The IDs of each GPU assigned to the container.
- healthStatus
-
- Type: string
The health status of the container. If health checks are not configured for this container in its task definition, then it reports the health status as
UNKNOWN
. - image
-
- Type: string
The image used for the container.
- imageDigest
-
- Type: string
The container image manifest digest.
The
imageDigest
is only returned if the container is using an image hosted in Amazon ECR, otherwise it is omitted. - lastStatus
-
- Type: string
The last known status of the container.
- managedAgents
-
- Type: Array of ManagedAgent structures
The details of any Amazon ECS managed agents associated with the container.
- memory
-
- Type: string
The hard limit (in MiB) of memory set for the container.
- memoryReservation
-
- Type: string
The soft limit (in MiB) of memory set for the container.
- name
-
- Type: string
The name of the container.
- networkBindings
-
- Type: Array of NetworkBinding structures
The network bindings associated with the container.
- networkInterfaces
-
- Type: Array of NetworkInterface structures
The network interfaces associated with the container.
- reason
-
- Type: string
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
- runtimeId
-
- Type: string
The ID of the Docker container.
- taskArn
-
- Type: string
The ARN of the task.
ContainerDefinition
Description
Container definitions are used in task definitions to describe the different containers that are launched as part of a task.
Members
- command
-
- Type: Array of strings
The command that is passed to the container. This parameter maps to
Cmd
in the Create a container section of the Docker Remote API and theCOMMAND
parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument should be a separated string in the array. - cpu
-
- Type: int
The number of
cpu
units reserved for the container. This parameter maps toCpuShares
in the Create a container section of the Docker Remote API and the--cpu-shares
option to docker run.This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level
cpu
value.You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.
Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.
On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:
-
Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.
-
Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.
On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition. A null or zero CPU value is passed to Docker as
0
, which Windows interprets as 1% of one CPU. - dependsOn
-
- Type: Array of ContainerDependency structures
The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.
For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the
ecs-init
package. If your container instances are launched from version20190301
or later, then they contain the required versions of the container agent andecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.For tasks using the Fargate launch type, the task or service requires platform version
1.3.0
or later. - disableNetworking
-
- Type: boolean
When this parameter is true, networking is disabled within the container. This parameter maps to
NetworkDisabled
in the Create a container section of the Docker Remote API.This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.
- dnsSearchDomains
-
- Type: Array of strings
A list of DNS search domains that are presented to the container. This parameter maps to
DnsSearch
in the Create a container section of the Docker Remote API and the--dns-search
option to docker run.This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.
- dnsServers
-
- Type: Array of strings
A list of DNS servers that are presented to the container. This parameter maps to
Dns
in the Create a container section of the Docker Remote API and the--dns
option to docker run.This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.
- dockerLabels
-
- Type: Associative array of custom strings keys (String) to strings
A key/value map of labels to add to the container. This parameter maps to
Labels
in the Create a container section of the Docker Remote API and the--label
option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'
- dockerSecurityOptions
-
- Type: Array of strings
A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.
With Windows containers, this parameter can be used to reference a credential spec file when configuring a container for Active Directory authentication. For more information, see Using gMSAs for Windows Containers in the Amazon Elastic Container Service Developer Guide.
This parameter maps to
SecurityOpt
in the Create a container section of the Docker Remote API and the--security-opt
option to docker run.The Amazon ECS container agent running on a container instance must register with the
ECS_SELINUX_CAPABLE=true
orECS_APPARMOR_CAPABLE=true
environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.For more information about valid values, see Docker Run Security Configuration.
Valid values: "no-new-privileges" | "apparmor:PROFILE" | "label:value" | "credentialspec:CredentialSpecFilePath"
- entryPoint
-
- Type: Array of strings
Early versions of the Amazon ECS container agent do not properly handle
entryPoint
parameters. If you have problems usingentryPoint
, update your container agent or enter your commands and arguments ascommand
array items instead.The entry point that is passed to the container. This parameter maps to
Entrypoint
in the Create a container section of the Docker Remote API and the--entrypoint
option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint. - environment
-
- Type: Array of KeyValuePair structures
The environment variables to pass to a container. This parameter maps to
Env
in the Create a container section of the Docker Remote API and the--env
option to docker run.We do not recommend using plaintext environment variables for sensitive information, such as credential data.
- environmentFiles
-
- Type: Array of EnvironmentFile structures
A list of files containing the environment variables to pass to a container. This parameter maps to the
--env-file
option to docker run.You can specify up to ten environment files. The file must have a
.env
file extension. Each line in an environment file should contain an environment variable inVARIABLE=VALUE
format. Lines beginning with#
are treated as comments and are ignored. For more information on the environment variable file syntax, see Declare default environment variables in file.If there are environment variables specified using the
environment
parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they are processed from the top down. It is recommended to use unique variable names. For more information, see Specifying Environment Variables in the Amazon Elastic Container Service Developer Guide. - essential
-
- Type: boolean
If the
essential
parameter of a container is marked astrue
, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If theessential
parameter of a container is marked asfalse
, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.
- extraHosts
-
- Type: Array of HostEntry structures
A list of hostnames and IP address mappings to append to the
/etc/hosts
file on the container. This parameter maps toExtraHosts
in the Create a container section of the Docker Remote API and the--add-host
option to docker run.This parameter is not supported for Windows containers or tasks that use the
awsvpc
network mode. - firelensConfiguration
-
- Type: FirelensConfiguration structure
The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.
- healthCheck
-
- Type: HealthCheck structure
The container health check command and associated configuration parameters for the container. This parameter maps to
HealthCheck
in the Create a container section of the Docker Remote API and theHEALTHCHECK
parameter of docker run. - hostname
-
- Type: string
The hostname to use for your container. This parameter maps to
Hostname
in the Create a container section of the Docker Remote API and the--hostname
option to docker run.The
hostname
parameter is not supported if you are using theawsvpc
network mode. - image
-
- Type: string
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either
repository-url/image:tag
orrepository-url/image@digest
. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps toImage
in the Create a container section of the Docker Remote API and theIMAGE
parameter of docker run.-
When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks.
-
Images in Amazon ECR repositories can be specified by either using the full
registry/repository:tag
orregistry/repository@digest
. For example,012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest
or012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE
. -
Images in official repositories on Docker Hub use a single name (for example,
ubuntu
ormongo
). -
Images in other repositories on Docker Hub are qualified with an organization name (for example,
amazon/amazon-ecs-agent
). -
Images in other online repositories are qualified further by a domain name (for example,
quay.io/assemblyline/ubuntu
).
- interactive
-
- Type: boolean
When this parameter is
true
, this allows you to deploy containerized applications that requirestdin
or atty
to be allocated. This parameter maps toOpenStdin
in the Create a container section of the Docker Remote API and the--interactive
option to docker run. - links
-
- Type: Array of strings
The
links
parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition isbridge
. Thename:internalName
construct is analogous toname:alias
in Docker links. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps toLinks
in the Create a container section of the Docker Remote API and the--link
option to docker run.This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.
Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
- linuxParameters
-
- Type: LinuxParameters structure
Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities.
This parameter is not supported for Windows containers.
- logConfiguration
-
- Type: LogConfiguration structure
The log configuration specification for the container.
This parameter maps to
LogConfig
in the Create a container section of the Docker Remote API and the--log-driver
option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}'
The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the
ECS_AVAILABLE_LOGGING_DRIVERS
environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide. - memory
-
- Type: int
The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task
memory
value, if one is specified. This parameter maps toMemory
in the Create a container section of the Docker Remote API and the--memory
option to docker run.If using the Fargate launch type, this parameter is optional.
If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level
memory
andmemoryReservation
value,memory
must be greater thanmemoryReservation
. If you specifymemoryReservation
, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value ofmemory
is used.The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
- memoryReservation
-
- Type: int
The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the
memory
parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps toMemoryReservation
in the Create a container section of the Docker Remote API and the--memory-reservation
option to docker run.If a task-level memory value is not specified, you must specify a non-zero integer for one or both of
memory
ormemoryReservation
in a container definition. If you specify both,memory
must be greater thanmemoryReservation
. If you specifymemoryReservation
, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value ofmemory
is used.For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a
memoryReservation
of 128 MiB, and amemory
hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
- mountPoints
-
- Type: Array of MountPoint structures
The mount points for data volumes in your container.
This parameter maps to
Volumes
in the Create a container section of the Docker Remote API and the--volume
option to docker run.Windows containers can mount whole directories on the same drive as
$env:ProgramData
. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. - name
-
- Type: string
The name of a container. If you are linking multiple containers together in a task definition, the
name
of one container can be entered in thelinks
of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. This parameter maps toname
in the Create a container section of the Docker Remote API and the--name
option to docker run. - portMappings
-
- Type: Array of PortMapping structures
The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.
For task definitions that use the
awsvpc
network mode, you should only specify thecontainerPort
. ThehostPort
can be left blank or it must be the same value as thecontainerPort
.Port mappings on Windows use the
NetNAT
gateway address rather thanlocalhost
. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself.This parameter maps to
PortBindings
in the Create a container section of the Docker Remote API and the--publish
option to docker run. If the network mode of a task definition is set tonone
, then you can't specify port mappings. If the network mode of a task definition is set tohost
, then host ports must either be undefined or they must match the container port in the port mapping.After a task reaches the
RUNNING
status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in thenetworkBindings
section DescribeTasks responses. - privileged
-
- Type: boolean
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the
root
user). This parameter maps toPrivileged
in the Create a container section of the Docker Remote API and the--privileged
option to docker run.This parameter is not supported for Windows containers or tasks run on AWS Fargate.
- pseudoTerminal
-
- Type: boolean
When this parameter is
true
, a TTY is allocated. This parameter maps toTty
in the Create a container section of the Docker Remote API and the--tty
option to docker run. - readonlyRootFilesystem
-
- Type: boolean
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to
ReadonlyRootfs
in the Create a container section of the Docker Remote API and the--read-only
option to docker run.This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.
- repositoryCredentials
-
- Type: RepositoryCredentials structure
The private repository authentication credentials to use.
- resourceRequirements
-
- Type: Array of ResourceRequirement structures
The type and amount of a resource to assign to a container. The only supported resource is a GPU.
- secrets
-
- Type: Array of Secret structures
The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
- startTimeout
-
- Type: int
Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a
COMPLETE
,SUCCESS
, orHEALTHY
status. If astartTimeout
value is specified for containerB and it does not reach the desired status within that time then containerA will give up and not start. This results in the task transitioning to aSTOPPED
state.When the
ECS_CONTAINER_START_TIMEOUT
container agent configuration variable is used, it is enforced indendently from this start timeout value.For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later.
For tasks using the EC2 launch type, your container instances require at least version
1.26.0
of the container agent to enable a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version1.26.0-1
of theecs-init
package. If your container instances are launched from version20190301
or later, then they contain the required versions of the container agent andecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide. - stopTimeout
-
- Type: int
Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.
For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used.
For tasks using the EC2 launch type, if the
stopTimeout
parameter is not specified, the value set for the Amazon ECS container agent configuration variableECS_CONTAINER_STOP_TIMEOUT
is used by default. If neither thestopTimeout
parameter or theECS_CONTAINER_STOP_TIMEOUT
agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to enable a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of theecs-init
package. If your container instances are launched from version20190301
or later, then they contain the required versions of the container agent andecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide. - systemControls
-
- Type: Array of SystemControl structures
A list of namespaced kernel parameters to set in the container. This parameter maps to
Sysctls
in the Create a container section of the Docker Remote API and the--sysctl
option to docker run.It is not recommended that you specify network-related
systemControls
parameters for multiple containers in a single task that also uses either theawsvpc
orhost
network modes. For tasks that use theawsvpc
network mode, the container that is started last determines whichsystemControls
parameters take effect. For tasks that use thehost
network mode, it changes the container instance's namespaced kernel parameters as well as the containers. - ulimits
-
- Type: Array of Ulimit structures
A list of
ulimits
to set in the container. If a ulimit value is specified in a task definition, it will override the default values set by Docker. This parameter maps toUlimits
in the Create a container section of the Docker Remote API and the--ulimit
option to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'
This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.
- user
-
- Type: string
The user to use inside the container. This parameter maps to
User
in the Create a container section of the Docker Remote API and the--user
option to docker run.When running tasks using the
host
network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.You can specify the
user
using the following formats. If specifying a UID or GID, you must specify it as a positive integer.-
user
-
user:group
-
uid
-
uid:gid
-
user:gid
-
uid:group
This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.
- volumesFrom
-
- Type: Array of VolumeFrom structures
Data volumes to mount from another container. This parameter maps to
VolumesFrom
in the Create a container section of the Docker Remote API and the--volumes-from
option to docker run. - workingDirectory
-
- Type: string
The working directory in which to run commands inside the container. This parameter maps to
WorkingDir
in the Create a container section of the Docker Remote API and the--workdir
option to docker run.
ContainerDependency
Description
The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.
Your Amazon ECS container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init
package. If your container instances are launched from version 20190301
or later, then they contain the required versions of the container agent and ecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, this parameter requires that the task or service uses platform version 1.3.0 or later.
Members
- condition
-
- Required: Yes
- Type: string
The dependency condition of the container. The following are the available conditions and their behavior:
-
START
- This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. -
COMPLETE
- This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition cannot be set on an essential container. -
SUCCESS
- This condition is the same asCOMPLETE
, but it also requires that the container exits with azero
status. This condition cannot be set on an essential container. -
HEALTHY
- This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.
- containerName
-
- Required: Yes
- Type: string
The name of a container.
ContainerInstance
Description
An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.
Members
- agentConnected
-
- Type: boolean
This parameter returns
true
if the agent is connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped returnfalse
. Only instances connected to an agent can accept placement requests. - agentUpdateStatus
-
- Type: string
The status of the most recent agent update. If an update has never been requested, this value is
NULL
. - attachments
-
- Type: Array of Attachment structures
The resources attached to a container instance, such as elastic network interfaces.
- attributes
-
- Type: Array of Attribute structures
The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.
- capacityProviderName
-
- Type: string
The capacity provider associated with the container instance.
- containerInstanceArn
-
- Type: string
The Amazon Resource Name (ARN) of the container instance. The ARN contains the
arn:aws:ecs
namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, thecontainer-instance
namespace, and then the container instance ID. For example,arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
. - ec2InstanceId
-
- Type: string
The EC2 instance ID of the container instance.
- pendingTasksCount
-
- Type: int
The number of tasks on the container instance that are in the
PENDING
status. - registeredAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp for when the container instance was registered.
- registeredResources
-
- Type: Array of Resource structures
For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.
- remainingResources
-
- Type: Array of Resource structures
For CPU and memory resource types, this parameter describes the remaining CPU and memory that has not already been allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the
host
orbridge
network mode). Any port that is not specified here is available for new tasks. - runningTasksCount
-
- Type: int
The number of tasks on the container instance that are in the
RUNNING
status. - status
-
- Type: string
The status of the container instance. The valid values are
REGISTERING
,REGISTRATION_FAILED
,ACTIVE
,INACTIVE
,DEREGISTERING
, orDRAINING
.If your account has opted in to the
awsvpcTrunking
account setting, then any newly registered container instance will transition to aREGISTERING
status while the trunk elastic network interface is provisioned for the instance. If the registration fails, the instance will transition to aREGISTRATION_FAILED
status. You can describe the container instance and see the reason for failure in thestatusReason
parameter. Once the container instance is terminated, the instance transitions to aDEREGISTERING
status while the trunk elastic network interface is deprovisioned. The instance then transitions to anINACTIVE
status.The
ACTIVE
status indicates that the container instance can accept tasks. TheDRAINING
indicates that new tasks are not placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container Instance Draining in the Amazon Elastic Container Service Developer Guide. - statusReason
-
- Type: string
The reason that the container instance reached its current status.
- tags
-
- Type: Array of Tag structures
The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
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 AWS 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.
- version
-
- Type: long (int|float)
The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the
detail
object) to verify that the version in your event stream is current. - versionInfo
-
- Type: VersionInfo structure
The version information for the Amazon ECS container agent and Docker daemon running on the container instance.
ContainerOverride
Description
The overrides that should be sent to a container. An empty container override can be passed in. An example of an empty container override would be {"containerOverrides": [ ] }
. If a non-empty container override is specified, the name
parameter must be included.
Members
- command
-
- Type: Array of strings
The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.
- cpu
-
- Type: int
The number of
cpu
units reserved for the container, instead of the default value from the task definition. You must also specify a container name. - environment
-
- Type: Array of KeyValuePair structures
The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.
- environmentFiles
-
- Type: Array of EnvironmentFile structures
A list of files containing the environment variables to pass to a container, instead of the value from the container definition.
- memory
-
- Type: int
The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.
- memoryReservation
-
- Type: int
The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.
- name
-
- Type: string
The name of the container that receives the override. This parameter is required if any override is specified.
- resourceRequirements
-
- Type: Array of ResourceRequirement structures
The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.
ContainerStateChange
Description
An object representing a change in state for a container.
Members
- containerName
-
- Type: string
The name of the container.
- exitCode
-
- Type: int
The exit code for the container, if the state change is a result of the container exiting.
- imageDigest
-
- Type: string
The container image SHA 256 digest.
- networkBindings
-
- Type: Array of NetworkBinding structures
Any network bindings associated with the container.
- reason
-
- Type: string
The reason for the state change.
- runtimeId
-
- Type: string
The ID of the Docker container.
- status
-
- Type: string
The status of the container.
Deployment
Description
The details of an Amazon ECS service deployment. This is used only when a service uses the ECS
deployment controller type.
Members
- capacityProviderStrategy
-
- Type: Array of CapacityProviderStrategyItem structures
The capacity provider strategy that the deployment is using.
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp for when the service deployment was created.
- desiredCount
-
- Type: int
The most recent desired count of tasks that was specified for the service to deploy or maintain.
- failedTasks
-
- Type: int
The number of consecutively failed tasks in the deployment. A task is considered a failure if the service scheduler can't launch the task, the task doesn't transition to a
RUNNING
state, or if it fails any of its defined health checks and is stopped.Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.
- id
-
- Type: string
The ID of the deployment.
- launchType
-
- Type: string
The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
- networkConfiguration
-
- Type: NetworkConfiguration structure
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the
awsvpc
networking mode. - pendingCount
-
- Type: int
The number of tasks in the deployment that are in the
PENDING
status. - platformVersion
-
- Type: string
The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the
LATEST
platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide. - rolloutState
-
- Type: string
The
rolloutState
of a service is only returned for services that use the rolling update (ECS
) deployment type that are not behind a Classic Load Balancer.The rollout state of the deployment. When a service deployment is started, it begins in an
IN_PROGRESS
state. When the service reaches a steady state, the deployment will transition to aCOMPLETED
state. If the service fails to reach a steady state and circuit breaker is enabled, the deployment will transition to aFAILED
state. A deployment inFAILED
state will launch no new tasks. For more information, see DeploymentCircuitBreaker. - rolloutStateReason
-
- Type: string
A description of the rollout state of a deployment.
- runningCount
-
- Type: int
The number of tasks in the deployment that are in the
RUNNING
status. - status
-
- Type: string
The status of the deployment. The following describes each state:
- PRIMARY
-
The most recent deployment of a service.
- ACTIVE
-
A service deployment that still has running tasks, but are in the process of being replaced with a new
PRIMARY
deployment. - INACTIVE
-
A deployment that has been completely replaced.
- taskDefinition
-
- Type: string
The most recent task definition that was specified for the tasks in the service to use.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp for when the service deployment was last updated.
DeploymentCircuitBreaker
Description
The deployment circuit breaker can only be used for services using the rolling update (ECS
) deployment type that are not behind a Classic Load Balancer.
The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If enabled, a service deployment will transition to a failed state and stop launching new tasks. You can also enable Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide.
Members
- enable
-
- Required: Yes
- Type: boolean
Whether to enable the deployment circuit breaker logic for the service.
- rollback
-
- Required: Yes
- Type: boolean
Whether to enable Amazon ECS to roll back the service if a service deployment fails. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
DeploymentConfiguration
Description
Optional deployment parameters that control how many tasks run during a deployment and the ordering of stopping and starting tasks.
Members
- deploymentCircuitBreaker
-
- Type: DeploymentCircuitBreaker structure
The deployment circuit breaker can only be used for services using the rolling update (
ECS
) deployment type.The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If deployment circuit breaker is enabled, a service deployment will transition to a failed state and stop launching new tasks. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
- maximumPercent
-
- Type: int
If a service is using the rolling update (
ECS
) deployment type, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in theRUNNING
orPENDING
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 theDRAINING
state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.If a service is using the blue/green (
CODE_DEPLOY
) orEXTERNAL
deployment types and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in theRUNNING
state while the container instances are in theDRAINING
state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service. - minimumHealthyPercent
-
- Type: int
If a service is using the rolling update (
ECS
) deployment type, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in theRUNNING
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 theDRAINING
state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in theRUNNING
state; tasks for services that do use a load balancer are considered healthy if they are in theRUNNING
state and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.If a service is using the blue/green (
CODE_DEPLOY
) orEXTERNAL
deployment types and tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in theRUNNING
state while the container instances are in theDRAINING
state. If the tasks in the service use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.
DeploymentController
Description
The deployment controller to use for the service. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
Members
- type
-
- Required: Yes
- Type: string
The deployment controller type to use.
There are three deployment controller types available:
- ECS
-
The rolling update (
ECS
) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration. - CODE_DEPLOY
-
The blue/green (
CODE_DEPLOY
) deployment type uses the blue/green deployment model powered by AWS CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it. - EXTERNAL
-
The external (
EXTERNAL
) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.
Device
Description
An object representing a container instance host device.
Members
- containerPath
-
- Type: string
The path inside the container at which to expose the host device.
- hostPath
-
- Required: Yes
- Type: string
The path for the device on the host container instance.
- permissions
-
- Type: Array of strings
The explicit permissions to provide to the container for the device. By default, the container has permissions for
read
,write
, andmknod
for the device.
DockerVolumeConfiguration
Description
This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local
driver. To use bind mounts, specify a host
instead.
Members
- autoprovision
-
- Type: boolean
If this value is
true
, the Docker volume is created if it does not already exist.This field is only used if the
scope
isshared
. - driver
-
- Type: string
The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use
docker plugin ls
to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps toDriver
in the Create a volume section of the Docker Remote API and thexxdriver
option to docker volume create. - driverOpts
-
- Type: Associative array of custom strings keys (String) to strings
A map of Docker driver-specific options passed through. This parameter maps to
DriverOpts
in the Create a volume section of the Docker Remote API and thexxopt
option to docker volume create. - labels
-
- Type: Associative array of custom strings keys (String) to strings
Custom metadata to add to your Docker volume. This parameter maps to
Labels
in the Create a volume section of the Docker Remote API and thexxlabel
option to docker volume create. - scope
-
- Type: string
The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a
task
are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped asshared
persist after the task stops.
EFSAuthorizationConfig
Description
The authorization configuration details for the Amazon EFS file system.
Members
- accessPointId
-
- Type: string
The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the
EFSVolumeConfiguration
must either be omitted or set to/
which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be enabled in theEFSVolumeConfiguration
. For more information, see Working with Amazon EFS Access Points in the Amazon Elastic File System User Guide. - iam
-
- Type: string
Whether or not to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the
EFSVolumeConfiguration
. If this parameter is omitted, the default value ofDISABLED
is used. For more information, see Using Amazon EFS Access Points in the Amazon Elastic Container Service Developer Guide.
EFSVolumeConfiguration
Description
This parameter is specified when you are using an Amazon Elastic File System file system for task storage. For more information, see Amazon EFS Volumes in the Amazon Elastic Container Service Developer Guide.
Members
- authorizationConfig
-
- Type: EFSAuthorizationConfig structure
The authorization configuration details for the Amazon EFS file system.
- fileSystemId
-
- Required: Yes
- Type: string
The Amazon EFS file system ID to use.
- rootDirectory
-
- Type: string
The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying
/
will have the same effect as omitting this parameter.If an EFS access point is specified in the
authorizationConfig
, the root directory parameter must either be omitted or set to/
which will enforce the path set on the EFS access point. - transitEncryption
-
- Type: string
Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of
DISABLED
is used. For more information, see Encrypting Data in Transit in the Amazon Elastic File System User Guide. - transitEncryptionPort
-
- Type: int
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see EFS Mount Helper in the Amazon Elastic File System User Guide.
EnvironmentFile
Description
A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a .env
file extension. Each line in an environment file should contain an environment variable in VARIABLE=VALUE
format. Lines beginning with #
are treated as comments and are ignored. For more information on the environment variable file syntax, see Declare default environment variables in file.
If there are environment variables specified using the environment
parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they are processed from the top down. It is recommended to use unique variable names. For more information, see Specifying environment variables in the Amazon Elastic Container Service Developer Guide.
This field is only valid for containers in Fargate tasks that use platform version 1.4.0
or later.
Members
ExecuteCommandConfiguration
Description
The details of the execute command configuration.
Members
- kmsKeyId
-
- Type: string
Specify an AWS Key Management Service key ID to encrypt the data between the local client and the container.
- logConfiguration
-
- Type: ExecuteCommandLogConfiguration structure
The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When
logging=OVERRIDE
is specified, alogConfiguration
must be provided. - logging
-
- Type: string
The log setting to use for redirecting logs for your execute command results. The following log settings are available.
-
NONE
: The execute command session is not logged. -
DEFAULT
: Theawslogs
configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If noawslogs
log driver is configured in the task definition, the output won't be logged. -
OVERRIDE
: Specify the logging details as a part oflogConfiguration
. If theOVERRIDE
logging option is specified, thelogConfiguration
is required.
ExecuteCommandLogConfiguration
Description
The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket.
Members
- cloudWatchEncryptionEnabled
-
- Type: boolean
Whether or not to enable encryption on the CloudWatch logs. If not specified, encryption will be disabled.
- cloudWatchLogGroupName
-
- Type: string
The name of the CloudWatch log group to send logs to.
The CloudWatch log group must already be created.
- s3BucketName
-
- Type: string
The name of the S3 bucket to send logs to.
The S3 bucket must already be created.
- s3EncryptionEnabled
-
- Type: boolean
Whether or not to enable encryption on the CloudWatch logs. If not specified, encryption will be disabled.
- s3KeyPrefix
-
- Type: string
An optional folder in the S3 bucket to place logs in.
FSxWindowsFileServerAuthorizationConfig
Description
The authorization configuration details for Amazon FSx for Windows File Server file system. See FSxWindowsFileServerVolumeConfiguration in the Amazon Elastic Container Service API Reference.
For more information and the input format, see Amazon FSx for Windows File Server Volumes in the Amazon Elastic Container Service Developer Guide.
Members
- credentialsParameter
-
- Required: Yes
- Type: string
The authorization credential option to use. The authorization credential options can be provided using either the Amazon Resource Name (ARN) of an AWS Secrets Manager secret or AWS Systems Manager Parameter Store parameter. The ARNs refer to the stored credentials.
- domain
-
- Required: Yes
- Type: string
A fully qualified domain name hosted by an AWS Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2.
FSxWindowsFileServerVolumeConfiguration
Description
This parameter is specified when you are using Amazon FSx for Windows File Server file system for task storage.
For more information and the input format, see Amazon FSx for Windows File Server Volumes in the Amazon Elastic Container Service Developer Guide.
Members
- authorizationConfig
-
- Required: Yes
- Type: FSxWindowsFileServerAuthorizationConfig structure
The authorization configuration details for the Amazon FSx for Windows File Server file system.
- fileSystemId
-
- Required: Yes
- Type: string
The Amazon FSx for Windows File Server file system ID to use.
- rootDirectory
-
- Required: Yes
- Type: string
The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host.
Failure
Description
A failed resource. For a list of common causes, see API failure reasons in the Amazon Elastic Container Service Developer Guide.
Members
FirelensConfiguration
Description
The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.
Members
- options
-
- Type: Associative array of custom strings keys (String) to strings
The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is
"options":{"enable-ecs-log-metadata":"true|false","config-file-type:"s3|file","config-file-value":"arn:aws:s3:::mybucket/fluent.conf|filepath"}
. For more information, see Creating a Task Definition that Uses a FireLens Configuration in the Amazon Elastic Container Service Developer Guide.Tasks hosted on AWS Fargate only support the
file
configuration file type. - type
-
- Required: Yes
- Type: string
The log router to use. The valid values are
fluentd
orfluentbit
.
HealthCheck
Description
An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile).
You can view the health status of both individual containers and a task with the DescribeTasks API operation or when viewing the task details in the console.
The following describes the possible healthStatus
values for a container:
-
HEALTHY
-The container health check has passed successfully. -
UNHEALTHY
-The container health check has failed. -
UNKNOWN
-The container health check is being evaluated or there is no container health check defined.
The following describes the possible healthStatus
values for a task. The container health check status of nonessential containers do not have an effect on the health status of a task.
-
HEALTHY
-All essential containers within the task have passed their health checks. -
UNHEALTHY
-One or more essential containers have failed their health check. -
UNKNOWN
-The essential containers within the task are still having their health checks evaluated or there are no container health checks defined.
If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it.
The following are notes about container health check support:
-
Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS Container Agent.
-
Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see AWS Fargate Platform Versions.
-
Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer.
Members
- command
-
- Required: Yes
- Type: Array of strings
A string array representing the command that the container runs to determine if it is healthy. The string array must start with
CMD
to execute the command arguments directly, orCMD-SHELL
to run the command with the container's default shell. For example:[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]
An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see
HealthCheck
in the Create a container section of the Docker Remote API. - interval
-
- Type: int
The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
- retries
-
- Type: int
The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
- startPeriod
-
- Type: int
The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You may specify between 0 and 300 seconds. The
startPeriod
is disabled by default.If a health check succeeds within the
startPeriod
, then the container is considered healthy and any subsequent failures count toward the maximum number of retries. - timeout
-
- Type: int
The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.
HostEntry
Description
Hostnames and IP address entries that are added to the /etc/hosts
file of a container via the extraHosts
parameter of its ContainerDefinition.
Members
HostVolumeProperties
Description
Details on a container instance bind mount host volume.
Members
- sourcePath
-
- Type: string
When the
host
parameter is used, specify asourcePath
to declare the path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If thehost
parameter contains asourcePath
file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If thesourcePath
value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.If you are using the Fargate launch type, the
sourcePath
parameter is not supported.
InferenceAccelerator
Description
Details on a Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
Members
- deviceName
-
- Required: Yes
- Type: string
The Elastic Inference accelerator device name. The
deviceName
must also be referenced in a container definition as a ResourceRequirement. - deviceType
-
- Required: Yes
- Type: string
The Elastic Inference accelerator type to use.
InferenceAcceleratorOverride
Description
Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
Members
InvalidParameterException
Description
The specified parameter is invalid. Review the available parameters for the API request.
Members
KernelCapabilities
Description
The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For more information on the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information on these Linux capabilities, see the capabilities(7) Linux manual page.
Members
- add
-
- Type: Array of strings
The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to
CapAdd
in the Create a container section of the Docker Remote API and the--cap-add
option to docker run.Tasks launched on AWS Fargate only support adding the
SYS_PTRACE
kernel capability.Valid values:
"ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
- drop
-
- Type: Array of strings
The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to
CapDrop
in the Create a container section of the Docker Remote API and the--cap-drop
option to docker run.Valid values:
"ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
KeyValuePair
Description
A key-value pair object.
Members
LimitExceededException
Description
The limit for the resource has been exceeded.
Members
LinuxParameters
Description
Linux-specific options that are applied to the container, such as Linux KernelCapabilities.
Members
- capabilities
-
- Type: KernelCapabilities structure
The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
For tasks that use the Fargate launch type,
capabilities
is supported for all platform versions but theadd
parameter is only supported if using platform version 1.4.0 or later. - devices
-
- Type: Array of Device structures
Any host devices to expose to the container. This parameter maps to
Devices
in the Create a container section of the Docker Remote API and the--device
option to docker run.If you are using tasks that use the Fargate launch type, the
devices
parameter is not supported. - initProcessEnabled
-
- Type: boolean
Run an
init
process inside the container that forwards signals and reaps processes. This parameter maps to the--init
option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:sudo docker version --format '{{.Server.APIVersion}}'
- maxSwap
-
- Type: int
The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the
--memory-swap
option to docker run where the value would be the sum of the container memory plus themaxSwap
value.If a
maxSwap
value of0
is specified, the container will not use swap. Accepted values are0
or any positive integer. If themaxSwap
parameter is omitted, the container will use the swap configuration for the container instance it is running on. AmaxSwap
value must be set for theswappiness
parameter to be used.If you are using tasks that use the Fargate launch type, the
maxSwap
parameter is not supported. - sharedMemorySize
-
- Type: int
The value for the size (in MiB) of the
/dev/shm
volume. This parameter maps to the--shm-size
option to docker run.If you are using tasks that use the Fargate launch type, the
sharedMemorySize
parameter is not supported. - swappiness
-
- Type: int
This allows you to tune a container's memory swappiness behavior. A
swappiness
value of0
will cause swapping to not happen unless absolutely necessary. Aswappiness
value of100
will cause pages to be swapped very aggressively. Accepted values are whole numbers between0
and100
. If theswappiness
parameter is not specified, a default value of60
is used. If a value is not specified formaxSwap
then this parameter is ignored. This parameter maps to the--memory-swappiness
option to docker run.If you are using tasks that use the Fargate launch type, the
swappiness
parameter is not supported. - tmpfs
-
- Type: Array of Tmpfs structures
The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the
--tmpfs
option to docker run.If you are using tasks that use the Fargate launch type, the
tmpfs
parameter is not supported.
LoadBalancer
Description
The load balancer configuration to use with a service or task set.
For specific notes and restrictions regarding the use of load balancers with services and task sets, see the CreateService and CreateTaskSet actions.
Members
- containerName
-
- Type: string
The name of the container (as it appears in a container definition) to associate with the load balancer.
- containerPort
-
- Type: int
The port on the container to associate with the load balancer. This port must correspond to a
containerPort
in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on thehostPort
of the port mapping. - loadBalancerName
-
- Type: string
The name of the load balancer to associate with the Amazon ECS service or task set.
A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted.
- targetGroupArn
-
- Type: string
The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.
A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer the target group ARN should be omitted.
For services using the
ECS
deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide.For services using the
CODE_DEPLOY
deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.If your service's task definition uses the
awsvpc
network mode (which is required for the Fargate launch type), you must chooseip
as the target type, notinstance
, when creating your target groups because tasks that use theawsvpc
network mode are associated with an elastic network interface, not an Amazon EC2 instance.
LogConfiguration
Description
The log configuration for the container. This parameter maps to LogConfig
in the Create a container section of the Docker Remote API and the --log-driver
option to docker run
.
By default, containers use the same logging driver that the Docker daemon uses; however the container may use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
The following should be noted when specifying a log configuration for your containers:
-
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the valid values below). Additional log drivers may be available in future releases of the Amazon ECS container agent.
-
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.
-
For tasks hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the
ECS_AVAILABLE_LOGGING_DRIVERS
environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide. -
For tasks on AWS Fargate, because you do not have access to the underlying infrastructure your tasks are hosted on, any additional software needed will have to be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.
Members
- logDriver
-
- Required: Yes
- Type: string
The log driver to use for the container.
For tasks on AWS Fargate, the supported log drivers are
awslogs
,splunk
, andawsfirelens
.For tasks hosted on Amazon EC2 instances, the supported log drivers are
awslogs
,fluentd
,gelf
,json-file
,journald
,logentries
,syslog
,splunk
, andawsfirelens
.For more information about using the
awslogs
log driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide.For more information about using the
awsfirelens
log driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide.If you have a custom driver that is not listed, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we do not currently provide support for running modified copies of this software.
- options
-
- Type: Associative array of custom strings keys (String) to strings
The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}'
- secretOptions
-
- Type: Array of Secret structures
The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
ManagedAgent
Description
Details about the managed agent status for the container.
Members
- lastStartedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp for when the managed agent was last started.
- lastStatus
-
- Type: string
The last known status of the managed agent.
- name
-
- Type: string
The name of the managed agent. When the execute command feature is enabled, the managed agent name is
ExecuteCommandAgent
. - reason
-
- Type: string
The reason for why the managed agent is in the state it is in.
ManagedAgentStateChange
Description
An object representing a change in state for a managed agent.
Members
- containerName
-
- Required: Yes
- Type: string
The name of the container associated with the managed agent.
- managedAgentName
-
- Required: Yes
- Type: string
The name of the managed agent.
- reason
-
- Type: string
The reason for the status of the managed agent.
- status
-
- Required: Yes
- Type: string
The status of the managed agent.
ManagedScaling
Description
The managed scaling settings for the Auto Scaling group capacity provider.
When managed scaling is enabled, Amazon ECS manages the scale-in and scale-out actions of the Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS-managed CloudWatch metric with the specified targetCapacity
value as the target value for the metric. For more information, see Using Managed Scaling in the Amazon Elastic Container Service Developer Guide.
If managed scaling is disabled, the user must manage the scaling of the Auto Scaling group.
Members
- instanceWarmupPeriod
-
- Type: int
The period of time, in seconds, after a newly launched Amazon EC2 instance can contribute to CloudWatch metrics for Auto Scaling group. If this parameter is omitted, the default value of
300
seconds is used. - maximumScalingStepSize
-
- Type: int
The maximum number of container instances that Amazon ECS will scale in or scale out at one time. If this parameter is omitted, the default value of
10000
is used. - minimumScalingStepSize
-
- Type: int
The minimum number of container instances that Amazon ECS will scale in or scale out at one time. If this parameter is omitted, the default value of
1
is used. - status
-
- Type: string
Whether or not to enable managed scaling for the capacity provider.
- targetCapacity
-
- Type: int
The target capacity value for the capacity provider. The specified value must be greater than
0
and less than or equal to100
. A value of100
will result in the Amazon EC2 instances in your Auto Scaling group being completely utilized.
MissingVersionException
Description
Amazon ECS is unable to determine the current version of the Amazon ECS container agent on the container instance and does not have enough information to proceed with an update. This could be because the agent running on the container instance is an older or custom version that does not use our version information.
Members
MountPoint
Description
Details on a volume mount point that is used in a container definition.
Members
- containerPath
-
- Type: string
The path on the container to mount the host volume at.
- readOnly
-
- Type: boolean
If this value is
true
, the container has read-only access to the volume. If this value isfalse
, then the container can write to the volume. The default value isfalse
. - sourceVolume
-
- Type: string
The name of the volume to mount. Must be a volume name referenced in the
name
parameter of task definitionvolume
.
NetworkBinding
Description
Details on the network bindings between a container and its host container instance. After a task reaches the RUNNING
status, manual and automatic host and container port assignments are visible in the networkBindings
section of DescribeTasks API responses.
Members
- bindIP
-
- Type: string
The IP address that the container is bound to on the container instance.
- containerPort
-
- Type: int
The port number on the container that is used with the network binding.
- hostPort
-
- Type: int
The port number on the host that is used with the network binding.
- protocol
-
- Type: string
The protocol used for the network binding.
NetworkConfiguration
Description
An object representing the network configuration for a task or service.
Members
- awsvpcConfiguration
-
- Type: AwsVpcConfiguration structure
The VPC subnets and security groups associated with a task.
All specified subnets and security groups must be from the same VPC.
NetworkInterface
Description
An object representing the elastic network interface for tasks that use the awsvpc
network mode.
Members
NoUpdateAvailableException
Description
There is no update available for this Amazon ECS container agent. This could be because the agent is already running the latest version, or it is so old that there is no update path to the current version.
Members
PlacementConstraint
Description
An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.
If you are using the Fargate launch type, task placement constraints are not supported.
Members
- expression
-
- Type: string
A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is
distinctInstance
. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide. - type
-
- Type: string
The type of constraint. Use
distinctInstance
to ensure that each task in a particular group is running on a different container instance. UsememberOf
to restrict the selection to a group of valid candidates.
PlacementStrategy
Description
The task placement strategy for a task or service. For more information, see Task Placement Strategies in the Amazon Elastic Container Service Developer Guide.
Members
- field
-
- Type: string
The field to apply the placement strategy against. For the
spread
placement strategy, valid values areinstanceId
(orhost
, which has the same effect), or any platform or custom attribute that is applied to a container instance, such asattribute:ecs.availability-zone
. For thebinpack
placement strategy, valid values arecpu
andmemory
. For therandom
placement strategy, this field is not used. - type
-
- Type: string
The type of placement strategy. The
random
placement strategy randomly places tasks on available candidates. Thespread
placement strategy spreads placement across available candidates evenly based on thefield
parameter. Thebinpack
strategy places tasks on available candidates that have the least available amount of the resource that is specified with thefield
parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
PlatformDevice
Description
The devices that are available on the container instance. The only supported device type is a GPU.
Members
- id
-
- Required: Yes
- Type: string
The ID for the GPU(s) on the container instance. The available GPU IDs can also be obtained on the container instance in the
/var/lib/ecs/gpu/nvidia_gpu_info.json
file. - type
-
- Required: Yes
- Type: string
The type of device that is available on the container instance. The only supported value is
GPU
.
PlatformTaskDefinitionIncompatibilityException
Description
The specified platform version does not satisfy the task definition's required capabilities.
Members
PlatformUnknownException
Description
The specified platform version does not exist.
Members
PortMapping
Description
Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.
If you are using containers in a task with the awsvpc
or host
network mode, exposed ports should be specified using containerPort
. The hostPort
can be left blank or it must be the same value as the containerPort
.
After a task reaches the RUNNING
status, manual and automatic host and container port assignments are visible in the networkBindings
section of DescribeTasks API responses.
Members
- containerPort
-
- Type: int
The port number on the container that is bound to the user-specified or automatically assigned host port.
If you are using containers in a task with the
awsvpc
orhost
network mode, exposed ports should be specified usingcontainerPort
.If you are using containers in a task with the
bridge
network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, seehostPort
. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance. - hostPort
-
- Type: int
The port number on the container instance to reserve for your container.
If you are using containers in a task with the
awsvpc
orhost
network mode, thehostPort
can either be left blank or set to the same value as thecontainerPort
.If you are using containers in a task with the
bridge
network mode, you can specify a non-reserved host port for your container port mapping, or you can omit thehostPort
(or set it to0
) while specifying acontainerPort
and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under
/proc/sys/net/ipv4/ip_local_port_range
. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.
The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released). The current reserved ports are displayed in the
remainingResources
of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time, including the default reserved ports. Automatically assigned ports don't count toward the 100 reserved ports limit. - protocol
-
- Type: string
The protocol used for the port mapping. Valid values are
tcp
andudp
. The default istcp
.
ProxyConfiguration
Description
The configuration details for the App Mesh proxy.
For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init
package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version 20190301
or later, then they contain the required versions of the container agent and ecs-init
. For more information, see Amazon ECS-optimized Linux AMI
Members
- containerName
-
- Required: Yes
- Type: string
The name of the container that will serve as the App Mesh proxy.
- properties
-
- Type: Array of KeyValuePair structures
The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.
-
IgnoredUID
- (Required) The user ID (UID) of the proxy container as defined by theuser
parameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredGID
is specified, this field can be empty. -
IgnoredGID
- (Required) The group ID (GID) of the proxy container as defined by theuser
parameter in a container definition. This is used to ensure the proxy ignores its own traffic. IfIgnoredUID
is specified, this field can be empty. -
AppPorts
- (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to theProxyIngressPort
andProxyEgressPort
. -
ProxyIngressPort
- (Required) Specifies the port that incoming traffic to theAppPorts
is directed to. -
ProxyEgressPort
- (Required) Specifies the port that outgoing traffic from theAppPorts
is directed to. -
EgressIgnoredPorts
- (Required) The egress traffic going to the specified ports is ignored and not redirected to theProxyEgressPort
. It can be an empty list. -
EgressIgnoredIPs
- (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to theProxyEgressPort
. It can be an empty list.
- type
-
- Type: string
The proxy type. The only supported value is
APPMESH
.
RepositoryCredentials
Description
The repository credentials for private registry authentication.
Members
- credentialsParameter
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the secret containing the private repository credentials.
When you are using the Amazon ECS API, AWS CLI, or AWS SDK, if the secret exists in the same Region as the task that you are launching then you can use either the full ARN or the name of the secret. When you are using the AWS Management Console, you must specify the full ARN of the secret.
Resource
Description
Describes the resources available for a container instance.
Members
- doubleValue
-
- Type: double
When the
doubleValue
type is set, the value of the resource must be a double precision floating-point type. - integerValue
-
- Type: int
When the
integerValue
type is set, the value of the resource must be an integer. - longValue
-
- Type: long (int|float)
When the
longValue
type is set, the value of the resource must be an extended precision floating-point type. - name
-
- Type: string
The name of the resource, such as
CPU
,MEMORY
,PORTS
,PORTS_UDP
, or a user-defined resource. - stringSetValue
-
- Type: Array of strings
When the
stringSetValue
type is set, the value of the resource must be a string type. - type
-
- Type: string
The type of the resource, such as
INTEGER
,DOUBLE
,LONG
, orSTRINGSET
.
ResourceInUseException
Description
The specified resource is in-use and cannot be removed.
Members
ResourceNotFoundException
Description
The specified resource could not be found.
Members
ResourceRequirement
Description
The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide
Members
- type
-
- Required: Yes
- Type: string
The type of resource to assign to a container. The supported values are
GPU
orInferenceAccelerator
. - value
-
- Required: Yes
- Type: string
The value for the specified resource type.
If the
GPU
type is used, the value is the number of physicalGPUs
the Amazon ECS container agent will reserve for the container. The number of GPUs reserved for all containers in a task should not exceed the number of available GPUs on the container instance the task is launched on.If the
InferenceAccelerator
type is used, thevalue
should match thedeviceName
for an InferenceAccelerator specified in a task definition.
Scale
Description
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
Members
Secret
Description
An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:
-
To inject sensitive data into your containers as environment variables, use the
secrets
container definition parameter. -
To reference sensitive information in the log configuration of a container, use the
secretOptions
container definition parameter.
For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
Members
- name
-
- Required: Yes
- Type: string
The name of the secret.
- valueFrom
-
- Required: Yes
- Type: string
The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.
If the AWS Systems Manager Parameter Store parameter exists in the same Region as the task you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.
ServerException
Service
Description
Details on a service within a cluster
Members
- capacityProviderStrategy
-
- Type: Array of CapacityProviderStrategyItem structures
The capacity provider strategy associated with the service.
- clusterArn
-
- Type: string
The Amazon Resource Name (ARN) of the cluster that hosts the service.
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp for when the service was created.
- createdBy
-
- Type: string
The principal that created the service.
- deploymentConfiguration
-
- Type: DeploymentConfiguration structure
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
- deploymentController
-
- Type: DeploymentController structure
The deployment controller type the service is using. When using the DescribeServices API, this field is omitted if the service is using the
ECS
deployment controller type. - deployments
-
- Type: Array of Deployment structures
The current state of deployments for the service.
- desiredCount
-
- Type: int
The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
- enableECSManagedTags
-
- Type: boolean
Specifies whether to enable Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
- enableExecuteCommand
-
- Type: boolean
Whether or not the execute command functionality is enabled for the service. If
true
, the execute command functionality is enabled for all containers in tasks as part of the service. - events
-
- Type: Array of ServiceEvent structures
The event stream for your service. A maximum of 100 of the latest events are displayed.
- healthCheckGracePeriodSeconds
-
- Type: int
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
- launchType
-
- Type: string
The launch type on which your service is running. If no value is specified, it will default to
EC2
. Valid values includeEC2
andFARGATE
. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide. - loadBalancers
-
- Type: Array of LoadBalancer structures
A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
- networkConfiguration
-
- Type: NetworkConfiguration structure
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the
awsvpc
networking mode. - pendingCount
-
- Type: int
The number of tasks in the cluster that are in the
PENDING
state. - placementConstraints
-
- Type: Array of PlacementConstraint structures
The placement constraints for the tasks in the service.
- placementStrategy
-
- Type: Array of PlacementStrategy structures
The placement strategy that determines how tasks for the service are placed.
- platformVersion
-
- Type: string
The platform version on which to run your service. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the
LATEST
platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide. - propagateTags
-
- Type: string
Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.
- roleArn
-
- Type: string
The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.
- runningCount
-
- Type: int
The number of tasks in the cluster that are in the
RUNNING
state. - schedulingStrategy
-
- Type: string
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. -
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 do not meet the placement constraints.Fargate tasks do not support the
DAEMON
scheduling strategy.
- serviceArn
-
- Type: string
The ARN that identifies the service. The ARN contains the
arn:aws:ecs
namespace, followed by the Region of the service, the AWS account ID of the service owner, theservice
namespace, and then the service name. For example,arn:aws:ecs:region:012345678910:service/my-service
. - serviceName
-
- Type: string
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, 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.
- serviceRegistries
-
- Type: Array of ServiceRegistry structures
The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
- status
-
- Type: string
The status of the service. The valid values are
ACTIVE
,DRAINING
, orINACTIVE
. - tags
-
- Type: Array of Tag structures
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.
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 AWS 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.
- taskDefinition
-
- Type: string
The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
- taskSets
-
- Type: Array of TaskSet structures
Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an
EXTERNAL
deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.
ServiceEvent
Description
Details on an event associated with a service.
Members
ServiceNotActiveException
Description
The specified service is not active. You can't update a service that is inactive. If you have previously deleted a service, you can re-create it with CreateService.
Members
ServiceNotFoundException
Description
The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific.
Members
ServiceRegistry
Description
Details of the service registry.
Members
- containerName
-
- Type: string
The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the
bridge
orhost
network mode, you must specify acontainerName
andcontainerPort
combination from the task definition. If the task definition that your service task specifies uses theawsvpc
network mode and a type SRV DNS record is used, you must specify either acontainerName
andcontainerPort
combination or aport
value, but not both. - containerPort
-
- Type: int
The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the
bridge
orhost
network mode, you must specify acontainerName
andcontainerPort
combination from the task definition. If the task definition your service task specifies uses theawsvpc
network mode and a type SRV DNS record is used, you must specify either acontainerName
andcontainerPort
combination or aport
value, but not both. - port
-
- Type: int
The port value used if your service discovery service specified an SRV record. This field may be used if both the
awsvpc
network mode and SRV records are used. - registryArn
-
- Type: string
The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see CreateService.
Session
Description
The details of the execute command session.
Members
- sessionId
-
- Type: string
The ID of the execute command session.
- streamUrl
-
- Type: string
A URL back to managed agent on the container that the SSM Session Manager client uses to send commands and receive output from the container.
- tokenValue
-
- Type: string
An encrypted token value containing session and caller information. Used to authenticate the connection to the container.
Setting
Description
The current account setting for a resource.
Members
- name
-
- Type: string
The Amazon ECS resource name.
- principalArn
-
- Type: string
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the authenticated user is assumed.
- value
-
- Type: string
Whether the account setting is enabled or disabled for the specified resource.
SystemControl
Description
A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls
in the Create a container section of the Docker Remote API and the --sysctl
option to docker run.
It is not recommended that you specify network-related systemControls
parameters for multiple containers in a single task that also uses either the awsvpc
or host
network mode for the following reasons:
-
For tasks that use the
awsvpc
network mode, if you setsystemControls
for any container, it applies to all containers in the task. If you set differentsystemControls
for multiple containers in a single task, the container that is started last determines whichsystemControls
take effect. -
For tasks that use the
host
network mode, thesystemControls
parameter applies to the container instance's kernel parameter as well as that of all containers of any tasks running on that container instance.
Members
Tag
Description
The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
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 AWS 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.
Members
TargetNotConnectedException
Description
The target container is not properly configured with the execute command agent or the container is no longer active or running.
Members
TargetNotFoundException
Description
The specified target could not be found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and Region-specific.
Members
Task
Description
Details on a task in a cluster.
Members
- attachments
-
- Type: Array of Attachment structures
The Elastic Network Adapter associated with the task if the task uses the
awsvpc
network mode. - attributes
-
- Type: Array of Attribute structures
The attributes of the task
- availabilityZone
-
- Type: string
The availability zone of the task.
- capacityProviderName
-
- Type: string
The capacity provider associated with the task.
- clusterArn
-
- Type: string
The ARN of the cluster that hosts the task.
- connectivity
-
- Type: string
The connectivity status of a task.
- connectivityAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp for when the task last went into
CONNECTED
status. - containerInstanceArn
-
- Type: string
The ARN of the container instances that host the task.
- containers
-
- Type: Array of Container structures
The containers associated with the task.
- cpu
-
- Type: string
The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units, for example
1024
. It can also be expressed as a string using vCPUs, for example1 vCPU
or1 vcpu
. String values are converted to an integer indicating the CPU units when the task definition is registered.If you are using the EC2 launch type, this field is optional. Supported values are between
128
CPU units (0.125
vCPUs) and10240
CPU units (10
vCPUs).If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the
memory
parameter:-
256 (.25 vCPU) - Available
memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) -
512 (.5 vCPU) - Available
memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) -
1024 (1 vCPU) - Available
memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) -
2048 (2 vCPU) - Available
memory
values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) -
4096 (4 vCPU) - Available
memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp for when the task was created (the task entered the
PENDING
state). - desiredStatus
-
- Type: string
The desired status of the task. For more information, see Task Lifecycle.
- enableExecuteCommand
-
- Type: boolean
Whether or not execute command functionality is enabled for this task. If
true
, this enables execute command functionality on all containers in the task. - executionStoppedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The Unix timestamp for when the task execution stopped.
- group
-
- Type: string
The name of the task group associated with the task.
- healthStatus
-
- Type: string
The health status for the task, which is determined by the health of the essential containers in the task. If all essential containers in the task are reporting as
HEALTHY
, then the task status also reports asHEALTHY
. If any essential containers in the task are reporting asUNHEALTHY
orUNKNOWN
, then the task status also reports asUNHEALTHY
orUNKNOWN
, accordingly.The Amazon ECS container agent does not monitor or report on Docker health checks that are embedded in a container image (such as those specified in a parent image or from the image's Dockerfile) and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.
- inferenceAccelerators
-
- Type: Array of InferenceAccelerator structures
The Elastic Inference accelerator associated with the task.
- lastStatus
-
- Type: string
The last known status of the task. For more information, see Task Lifecycle.