AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AccessDeniedException

ECS exception

Class Attachment

An object representing a container instance or task attachment.

Class Attribute

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.

Class AttributeLimitExceededException

ECS exception

Class AwsVpcConfiguration

An object representing the networking details for a task or service.

Class BlockedException

ECS exception

Class ClientException

ECS exception

Class Cluster

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.

Class ClusterContainsContainerInstancesException

ECS exception

Class ClusterContainsServicesException

ECS exception

Class ClusterContainsTasksException

ECS exception

Class ClusterNotFoundException

ECS exception

Class Container

A Docker container that is part of a task.

Class ContainerDefinition

Container definitions are used in task definitions to describe the different containers that are launched as part of a task.

Class ContainerInstance

An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.

Class ContainerOverride

The overrides that should be sent to a container.

Class CreateClusterRequest

Container for the parameters to the CreateCluster operation. Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action.

When you call the CreateCluster API operation, Amazon ECS attempts to create the service-linked role for your account so that required resources in other AWS services can be managed on your behalf. However, if the IAM user that makes the call does not have permissions to create the service-linked role, it is not created. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

Class CreateClusterResponse

This is the response object from the CreateCluster operation.

Class CreateServiceRequest

Container for the parameters to the CreateService operation. Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below desiredCount, Amazon ECS spawns another copy of the task in the specified cluster. To update an existing service, see UpdateService.

In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind a load balancer. The load balancer distributes traffic across the tasks that are associated with the service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.

You can optionally specify a deployment configuration for your service. During a deployment, the service scheduler uses the minimumHealthyPercent and maximumPercent parameters to determine the deployment strategy. The deployment is triggered by changing the task definition or the desired count of a service with an UpdateService operation.

The minimumHealthyPercent represents a lower limit on the number of your service's tasks that must remain in the RUNNING state during a deployment, as a percentage of the desiredCount (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desiredCount of four tasks and a minimumHealthyPercent of 50%, the scheduler can stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer. The default value for minimumHealthyPercent is 50% in the console and 100% for the AWS CLI, the AWS SDKs, and the APIs.

The maximumPercent parameter represents an upper limit on the number of your service's tasks that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desiredCount (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service has a desiredCount of four tasks and a maximumPercent value of 200%, the scheduler can 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 maximumPercent is 200%.

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 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.

Class CreateServiceResponse

This is the response object from the CreateService operation.

Class DeleteAttributesRequest

Container for the parameters to the DeleteAttributes operation. Deletes one or more custom attributes from an Amazon ECS resource.

Class DeleteAttributesResponse

This is the response object from the DeleteAttributes operation.

Class DeleteClusterRequest

Container for the parameters to the DeleteCluster operation. Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.

Class DeleteClusterResponse

This is the response object from the DeleteCluster operation.

Class DeleteServiceRequest

Container for the parameters to the DeleteService operation. 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 ListServices API operations. After the tasks have stopped, then the service status moves from DRAINING to INACTIVE. Services in the DRAINING or INACTIVE status can still be viewed with DescribeServices API operations. However, in the future, INACTIVE services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices API operations on those services return a ServiceNotFoundException error.

Class DeleteServiceResponse

This is the response object from the DeleteService operation.

Class Deployment

The details of an Amazon ECS service deployment.

Class DeploymentConfiguration

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

Class DeregisterContainerInstanceRequest

Container for the parameters to the DeregisterContainerInstance operation. 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).

Class DeregisterContainerInstanceResponse

This is the response object from the DeregisterContainerInstance operation.

Class DeregisterTaskDefinitionRequest

Container for the parameters to the DeregisterTaskDefinition operation. 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 (although 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.

Class DeregisterTaskDefinitionResponse

This is the response object from the DeregisterTaskDefinition operation.

Class DescribeClustersRequest

Container for the parameters to the DescribeClusters operation. Describes one or more of your clusters.

Class DescribeClustersResponse

This is the response object from the DescribeClusters operation.

Class DescribeContainerInstancesRequest

Container for the parameters to the DescribeContainerInstances operation. Describes Amazon Elastic Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.

Class DescribeContainerInstancesResponse

This is the response object from the DescribeContainerInstances operation.

Class DescribeServicesRequest

Container for the parameters to the DescribeServices operation. Describes the specified services running in your cluster.

Class DescribeServicesResponse

This is the response object from the DescribeServices operation.

Class DescribeTaskDefinitionRequest

Container for the parameters to the DescribeTaskDefinition operation. 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.

Class DescribeTaskDefinitionResponse

This is the response object from the DescribeTaskDefinition operation.

Class DescribeTasksRequest

Container for the parameters to the DescribeTasks operation. Describes a specified task or tasks.

Class DescribeTasksResponse

This is the response object from the DescribeTasks operation.

Class Device

An object representing a container instance host device.

Class Failure

A failed resource.

Class HostEntry

Hostnames and IP address entries that are added to the /etc/hosts file of a container via the extraHosts parameter of its ContainerDefinition.

Class HostVolumeProperties

Details on a container instance host volume.

Class InvalidParameterException

ECS exception

Class KernelCapabilities

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.

Class KeyValuePair

A key and value pair object.

Class LinuxParameters

Linux-specific options that are applied to the container, such as Linux KernelCapabilities.

Class ListAttributesRequest

Container for the parameters to the ListAttributes operation. 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).

Class ListAttributesResponse

This is the response object from the ListAttributes operation.

Class ListClustersRequest

Container for the parameters to the ListClusters operation. Returns a list of existing clusters.

Class ListClustersResponse

This is the response object from the ListClusters operation.

Class ListContainerInstancesRequest

Container for the parameters to the ListContainerInstances operation. 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.

Class ListContainerInstancesResponse

This is the response object from the ListContainerInstances operation.

Class ListServicesRequest

Container for the parameters to the ListServices operation. Lists the services that are running in a specified cluster.

Class ListServicesResponse

This is the response object from the ListServices operation.

Class ListTaskDefinitionFamiliesRequest

Container for the parameters to the ListTaskDefinitionFamilies operation. 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.

Class ListTaskDefinitionFamiliesResponse

This is the response object from the ListTaskDefinitionFamilies operation.

Class ListTaskDefinitionsRequest

Container for the parameters to the ListTaskDefinitions operation. 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.

Class ListTaskDefinitionsResponse

This is the response object from the ListTaskDefinitions operation.

Class ListTasksRequest

Container for the parameters to the ListTasks operation. 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.

Class ListTasksResponse

This is the response object from the ListTasks operation.

Class LoadBalancer

Details on a load balancer that is used with a service.

Class LogConfiguration

Log configuration options to send to a custom log driver for the container.

Class MissingVersionException

ECS exception

Class MountPoint

Details on a volume mount point that is used in a container definition.

Class NetworkBinding

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.

Class NetworkConfiguration

An object representing the network configuration for a task or service.

Class NetworkInterface

An object representing the Elastic Network Interface for tasks that use the awsvpc network mode.

Class NoUpdateAvailableException

ECS exception

Class PlacementConstraint

An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.

Class PlacementStrategy

The task placement strategy for a task or service. For more information, see Task Placement Strategies in the Amazon Elastic Container Service Developer Guide.

Class PlatformTaskDefinitionIncompatibilityException

ECS exception

Class PlatformUnknownException

ECS exception

Class PortMapping

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 using containers in a task with the Fargate launch type, 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.

Class PutAttributesRequest

Container for the parameters to the PutAttributes operation. 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.

Class PutAttributesResponse

This is the response object from the PutAttributes operation.

Class RegisterTaskDefinitionRequest

Container for the parameters to the RegisterTaskDefinition operation. 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.

Class RegisterTaskDefinitionResponse

This is the response object from the RegisterTaskDefinition operation.

Class Resource

Describes the resources available for a container instance.

Class RunTaskRequest

Container for the parameters to the RunTask operation. 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.

Class RunTaskResponse

This is the response object from the RunTask operation.

Class ServerException

ECS exception

Class Service

Details on a service within a cluster

Class ServiceEvent

Details on an event associated with a service.

Class ServiceNotActiveException

ECS exception

Class ServiceNotFoundException

ECS exception

Class StartTaskRequest

Container for the parameters to the StartTask operation. 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.

Class StartTaskResponse

This is the response object from the StartTask operation.

Class StopTaskRequest

Container for the parameters to the StopTask operation. Stops a running task.

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 and a default 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.

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.

Class StopTaskResponse

This is the response object from the StopTask operation.

Class TargetNotFoundException

ECS exception

Class Task

Details on a task in a cluster.

Class TaskDefinition

Details of a task definition.

Class TaskDefinitionPlacementConstraint

An object representing a constraint on task placement in the task definition.

If you are using the Fargate launch type, task placement contraints are not supported.

For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.

Class TaskOverride

The overrides associated with a task.

Class Ulimit

The ulimit settings to pass to the container.

Class UnsupportedFeatureException

ECS exception

Class UpdateContainerAgentRequest

Container for the parameters to the UpdateContainerAgent operation. 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.

Class UpdateContainerAgentResponse

This is the response object from the UpdateContainerAgent operation.

Class UpdateContainerInstancesStateRequest

Container for the parameters to the UpdateContainerInstancesState operation. Modifies the status of an Amazon ECS container instance.

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.

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 ignore desiredCount temporarily during task replacement. For example, desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler can't remove existing tasks until the replacement tasks are considered healthy. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer.

  • The maximumPercent parameter represents an upper limit on the number of running tasks during task replacement, which enables you to define the replacement batch size. For example, if desiredCount of 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 you set a container instance to ACTIVE, the Amazon ECS scheduler can begin scheduling tasks on the instance again.

Class UpdateContainerInstancesStateResponse

This is the response object from the UpdateContainerInstancesState operation.

Class UpdateInProgressException

ECS exception

Class UpdateServiceRequest

Container for the parameters to the UpdateService operation. Modifies the desired count, deployment configuration, network configuration, or task definition used in a service.

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.

You can use UpdateService to modify your task definition and deploy a new version of your service.

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 ignore desiredCount temporarily during a deployment. For example, if desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer.

  • The maximumPercent parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if desiredCount is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).

When UpdateService stops a task during a deployment, the equivalent of

docker
            stop
is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.

When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic:

  • 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.

Class UpdateServiceResponse

This is the response object from the UpdateService operation.

Class VersionInfo

The Docker and Amazon ECS container agent version information about a container instance.

Class Volume

A data volume used in a task definition.

Class VolumeFrom

Details on a data volume from another container in the same task definition.