AWS SDK Version 2 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.

.NET Framework 3.5
 

Classes

NameDescription
Class Attribute The attributes applicable to a container instance when it is registered.
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 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.
Class CreateClusterResponse Configuration for accessing Amazon CreateCluster service
Class CreateClusterResult
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 instantiation of the task in the specified cluster. To update an existing service, see UpdateService.

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

If the minimumHealthyPercent is below 100%, the scheduler can ignore the desiredCount temporarily during a deployment. For example, if your service has a desiredCount of four tasks, a minimumHealthyPercent 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 do use a load balancer are considered healthy if they are in the RUNNING state and the container instance it is 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 running tasks during a deployment, which enables you to define the deployment batch size. For example, if your service has a desiredCount of four tasks, a maximumPercent value of 200% starts 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 attempts to balance them across the Availability Zones 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).

  • 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 Configuration for accessing Amazon CreateService service
Class CreateServiceResult
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 Configuration for accessing Amazon DeleteCluster service
Class DeleteClusterResult
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 will return a ServiceNotFoundException error.

Class DeleteServiceResponse Configuration for accessing Amazon DeleteService service
Class DeleteServiceResult
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 to avoid 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.

When you terminate a container instance, it is automatically deregistered from your cluster.

Class DeregisterContainerInstanceResponse Configuration for accessing Amazon DeregisterContainerInstance service
Class DeregisterContainerInstanceResult
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).

Class DeregisterTaskDefinitionResponse Configuration for accessing Amazon DeregisterTaskDefinition service
Class DeregisterTaskDefinitionResult
Class DescribeClustersRequest Container for the parameters to the DescribeClusters operation. Describes one or more of your clusters.
Class DescribeClustersResponse Configuration for accessing Amazon DescribeClusters service
Class DescribeClustersResult
Class DescribeContainerInstancesRequest Container for the parameters to the DescribeContainerInstances operation. Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
Class DescribeContainerInstancesResponse Configuration for accessing Amazon DescribeContainerInstances service
Class DescribeContainerInstancesResult
Class DescribeServicesRequest Container for the parameters to the DescribeServices operation. Describes the specified services running in your cluster.
Class DescribeServicesResponse Configuration for accessing Amazon DescribeServices service
Class DescribeServicesResult
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 Configuration for accessing Amazon DescribeTaskDefinition service
Class DescribeTaskDefinitionResult
Class DescribeTasksRequest Container for the parameters to the DescribeTasks operation. Describes a specified task or tasks.
Class DescribeTasksResponse Configuration for accessing Amazon DescribeTasks service
Class DescribeTasksResult
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 KeyValuePair A key and value pair object.
Class ListClustersRequest Container for the parameters to the ListClusters operation. Returns a list of existing clusters.
Class ListClustersResponse Configuration for accessing Amazon ListClusters service
Class ListClustersResult
Class ListContainerInstancesRequest Container for the parameters to the ListContainerInstances operation. Returns a list of container instances in a specified cluster.
Class ListContainerInstancesResponse Configuration for accessing Amazon ListContainerInstances service
Class ListContainerInstancesResult
Class ListServicesRequest Container for the parameters to the ListServices operation. Lists the services that are running in a specified cluster.
Class ListServicesResponse Configuration for accessing Amazon ListServices service
Class ListServicesResult
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 definitions). You can filter the results with the familyPrefix parameter.
Class ListTaskDefinitionFamiliesResponse Configuration for accessing Amazon ListTaskDefinitionFamilies service
Class ListTaskDefinitionFamiliesResult
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 Configuration for accessing Amazon ListTaskDefinitions service
Class ListTaskDefinitionsResult
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.
Class ListTasksResponse Configuration for accessing Amazon ListTasks service
Class ListTasksResult
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 NoUpdateAvailableException 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. 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 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 EC2 Container Service Developer Guide.
Class RegisterTaskDefinitionResponse Configuration for accessing Amazon RegisterTaskDefinition service
Class RegisterTaskDefinitionResult
Class Resource Describes the resources available for a container instance.
Class RunTaskRequest Container for the parameters to the RunTask operation. Start a task using random placement and the default Amazon ECS scheduler. To use your own scheduler or place a task on a specific container instance, use StartTask instead.

The count parameter is limited to 10 tasks per call.

Class RunTaskResponse Configuration for accessing Amazon RunTask service
Class RunTaskResult
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. To use the default Amazon ECS scheduler to place your task, use RunTask instead.

The list of container instances to start tasks on is limited to 10.

Class StartTaskResponse Configuration for accessing Amazon StartTask service
Class StartTaskResult
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 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.

Class StopTaskResponse Configuration for accessing Amazon StopTask service
Class StopTaskResult
Class Task Details on a task in a cluster.
Class TaskDefinition Details of a task definition.
Class TaskOverride The overrides associated with a task.
Class Ulimit The ulimit settings to pass to the container.
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 EC2 Container Service Developer Guide.

Class UpdateContainerAgentResponse Configuration for accessing Amazon UpdateContainerAgent service
Class UpdateContainerAgentResult
Class UpdateInProgressException ECS exception
Class UpdateServiceRequest Container for the parameters to the UpdateService operation. Modifies the desired count, deployment 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 the minimumHealthyPercent is below 100%, the scheduler can ignore the desiredCount temporarily during a deployment. For example, if your service has a desiredCount of four tasks, a minimumHealthyPercent 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 do use a load balancer are considered healthy if they are in the RUNNING state and the container instance it is 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 your service has a desiredCount of four tasks, a maximumPercent value 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 attempts to balance them across the Availability Zones 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).

  • 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 UpdateServiceResponse Configuration for accessing Amazon UpdateService service
Class UpdateServiceResult
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.