Class: Aws::ECS::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ECS::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-ecs/client.rb
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#create_cluster(params = {}) ⇒ Types::CreateClusterResponse
Creates a new Amazon ECS cluster.
-
#create_service(params = {}) ⇒ Types::CreateServiceResponse
Runs and maintains a desired number of tasks from a specified task definition.
-
#delete_attributes(params = {}) ⇒ Types::DeleteAttributesResponse
Deletes one or more custom attributes from an Amazon ECS resource.
-
#delete_cluster(params = {}) ⇒ Types::DeleteClusterResponse
Deletes the specified cluster.
-
#delete_service(params = {}) ⇒ Types::DeleteServiceResponse
Deletes a specified service within a cluster.
-
#deregister_container_instance(params = {}) ⇒ Types::DeregisterContainerInstanceResponse
Deregisters an Amazon ECS container instance from the specified cluster.
-
#deregister_task_definition(params = {}) ⇒ Types::DeregisterTaskDefinitionResponse
Deregisters the specified task definition by family and revision.
-
#describe_clusters(params = {}) ⇒ Types::DescribeClustersResponse
Describes one or more of your clusters.
-
#describe_container_instances(params = {}) ⇒ Types::DescribeContainerInstancesResponse
Describes Amazon EC2 Container Service container instances.
-
#describe_services(params = {}) ⇒ Types::DescribeServicesResponse
Describes the specified services running in your cluster.
-
#describe_task_definition(params = {}) ⇒ Types::DescribeTaskDefinitionResponse
Describes a task definition.
-
#describe_tasks(params = {}) ⇒ Types::DescribeTasksResponse
Describes a specified task or tasks.
-
#discover_poll_endpoint(params = {}) ⇒ Types::DiscoverPollEndpointResponse
<note markdown=“1”> This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
-
#list_attributes(params = {}) ⇒ Types::ListAttributesResponse
Lists the attributes for Amazon ECS resources within a specified target type and cluster.
-
#list_clusters(params = {}) ⇒ Types::ListClustersResponse
Returns a list of existing clusters.
-
#list_container_instances(params = {}) ⇒ Types::ListContainerInstancesResponse
Returns a list of container instances in a specified cluster.
-
#list_services(params = {}) ⇒ Types::ListServicesResponse
Lists the services that are running in a specified cluster.
-
#list_task_definition_families(params = {}) ⇒ Types::ListTaskDefinitionFamiliesResponse
Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any ‘ACTIVE` task definition revisions).
-
#list_task_definitions(params = {}) ⇒ Types::ListTaskDefinitionsResponse
Returns a list of task definitions that are registered to your account.
-
#list_tasks(params = {}) ⇒ Types::ListTasksResponse
Returns a list of tasks for a specified cluster.
-
#put_attributes(params = {}) ⇒ Types::PutAttributesResponse
Create or update an attribute on an Amazon ECS resource.
-
#register_container_instance(params = {}) ⇒ Types::RegisterContainerInstanceResponse
<note markdown=“1”> This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
-
#register_task_definition(params = {}) ⇒ Types::RegisterTaskDefinitionResponse
Registers a new task definition from the supplied ‘family` and `containerDefinitions`.
-
#run_task(params = {}) ⇒ Types::RunTaskResponse
Starts a new task using the specified task definition.
-
#start_task(params = {}) ⇒ Types::StartTaskResponse
Starts a new task from the specified task definition on the specified container instance or instances.
-
#stop_task(params = {}) ⇒ Types::StopTaskResponse
Stops a running task.
-
#submit_container_state_change(params = {}) ⇒ Types::SubmitContainerStateChangeResponse
<note markdown=“1”> This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
-
#submit_task_state_change(params = {}) ⇒ Types::SubmitTaskStateChangeResponse
<note markdown=“1”> This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
-
#update_container_agent(params = {}) ⇒ Types::UpdateContainerAgentResponse
Updates the Amazon ECS container agent on a specified container instance.
-
#update_container_instances_state(params = {}) ⇒ Types::UpdateContainerInstancesStateResponse
Modifies the status of an Amazon ECS container instance.
-
#update_service(params = {}) ⇒ Types::UpdateServiceResponse
Modifies the desired count, deployment configuration, or task definition used in a service.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(*args) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(*args) ⇒ Client
Returns a new instance of Client.
152 153 154 |
# File 'lib/aws-sdk-ecs/client.rb', line 152 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
3990 3991 3992 |
# File 'lib/aws-sdk-ecs/client.rb', line 3990 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
3993 3994 3995 |
# File 'lib/aws-sdk-ecs/client.rb', line 3993 def errors_module Errors end |
Instance Method Details
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 |
# File 'lib/aws-sdk-ecs/client.rb', line 3849 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-ecs' context[:gem_version] = '1.0.0' Seahorse::Client::Request.new(handlers, context) end |
#create_cluster(params = {}) ⇒ Types::CreateClusterResponse
Creates a new Amazon ECS cluster. By default, your account receives a ‘default` cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the `CreateCluster` action.
215 216 217 218 |
# File 'lib/aws-sdk-ecs/client.rb', line 215 def create_cluster(params = {}, = {}) req = build_request(:create_cluster, params) req.send_request() end |
#create_service(params = {}) ⇒ Types::CreateServiceResponse
Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below ‘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 EC2 Container Service Developer Guide*.
You can optionally specify a deployment configuration for your service. During a deployment (which is triggered by changing the task definition or the desired count of a service with an UpdateService operation), the service scheduler uses the ‘minimumHealthyPercent` and `maximumPercent` parameters to determine the deployment strategy.
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.
-
[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html
564 565 566 567 |
# File 'lib/aws-sdk-ecs/client.rb', line 564 def create_service(params = {}, = {}) req = build_request(:create_service, params) req.send_request() end |
#delete_attributes(params = {}) ⇒ Types::DeleteAttributesResponse
Deletes one or more custom attributes from an Amazon ECS resource.
612 613 614 615 |
# File 'lib/aws-sdk-ecs/client.rb', line 612 def delete_attributes(params = {}, = {}) req = build_request(:delete_attributes, params) req.send_request() end |
#delete_cluster(params = {}) ⇒ Types::DeleteClusterResponse
Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
672 673 674 675 |
# File 'lib/aws-sdk-ecs/client.rb', line 672 def delete_cluster(params = {}, = {}) req = build_request(:delete_cluster, params) req.send_request() end |
#delete_service(params = {}) ⇒ Types::DeleteServiceResponse
Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService.
<note markdown=“1”> 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.
</note>
771 772 773 774 |
# File 'lib/aws-sdk-ecs/client.rb', line 771 def delete_service(params = {}, = {}) req = build_request(:delete_service, params) req.send_request() end |
#deregister_container_instance(params = {}) ⇒ Types::DeregisterContainerInstanceResponse
Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.
If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration 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.
<note markdown=“1”> 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).
</note>
892 893 894 895 |
# File 'lib/aws-sdk-ecs/client.rb', line 892 def deregister_container_instance(params = {}, = {}) req = build_request(:deregister_container_instance, params) req.send_request() end |
#deregister_task_definition(params = {}) ⇒ Types::DeregisterTaskDefinitionResponse
Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as ‘INACTIVE`. Existing tasks and services that reference an `INACTIVE` task definition continue to run without disruption. Existing services that reference an `INACTIVE` task definition can still scale up or down by modifying the service’s desired count.
You cannot use an ‘INACTIVE` task definition to run new tasks or create new services, and you cannot update an existing service to reference an `INACTIVE` task definition (although there may be up to a 10 minute window following deregistration where these restrictions have not yet taken effect).
<note markdown=“1”> 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 life cycle of any associated tasks and services.
</note>
1007 1008 1009 1010 |
# File 'lib/aws-sdk-ecs/client.rb', line 1007 def deregister_task_definition(params = {}, = {}) req = build_request(:deregister_task_definition, params) req.send_request() end |
#describe_clusters(params = {}) ⇒ Types::DescribeClustersResponse
Describes one or more of your clusters.
1072 1073 1074 1075 |
# File 'lib/aws-sdk-ecs/client.rb', line 1072 def describe_clusters(params = {}, = {}) req = build_request(:describe_clusters, params) req.send_request() end |
#describe_container_instances(params = {}) ⇒ Types::DescribeContainerInstancesResponse
Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
1233 1234 1235 1236 |
# File 'lib/aws-sdk-ecs/client.rb', line 1233 def describe_container_instances(params = {}, = {}) req = build_request(:describe_container_instances, params) req.send_request() end |
#describe_services(params = {}) ⇒ Types::DescribeServicesResponse
Describes the specified services running in your cluster.
1363 1364 1365 1366 |
# File 'lib/aws-sdk-ecs/client.rb', line 1363 def describe_services(params = {}, = {}) req = build_request(:describe_services, params) req.send_request() end |
#describe_task_definition(params = {}) ⇒ Types::DescribeTaskDefinitionResponse
Describes a task definition. You can specify a ‘family` and `revision` to find information about a specific task definition, or you can simply specify the family to find the latest `ACTIVE` revision in that family.
<note markdown=“1”> You can only describe ‘INACTIVE` task definitions while an active task or service references them.
</note>
1531 1532 1533 1534 |
# File 'lib/aws-sdk-ecs/client.rb', line 1531 def describe_task_definition(params = {}, = {}) req = build_request(:describe_task_definition, params) req.send_request() end |
#describe_tasks(params = {}) ⇒ Types::DescribeTasksResponse
Describes a specified task or tasks.
1656 1657 1658 1659 |
# File 'lib/aws-sdk-ecs/client.rb', line 1656 def describe_tasks(params = {}, = {}) req = build_request(:describe_tasks, params) req.send_request() end |
#discover_poll_endpoint(params = {}) ⇒ Types::DiscoverPollEndpointResponse
<note markdown=“1”> This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
</note>
Returns an endpoint for the Amazon EC2 Container Service agent to poll for updates.
1703 1704 1705 1706 |
# File 'lib/aws-sdk-ecs/client.rb', line 1703 def discover_poll_endpoint(params = {}, = {}) req = build_request(:discover_poll_endpoint, params) req.send_request() end |
#list_attributes(params = {}) ⇒ Types::ListAttributesResponse
Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, ‘ListAttributes` returns a list of attribute objects, one for each attribute on each resource. You can filter the list of results to a single attribute name to only return results that have that name. You can also filter the results by attribute name and value, for example, to see which container instances in a cluster are running a Linux AMI (`ecs.os-type=linux`).
1784 1785 1786 1787 |
# File 'lib/aws-sdk-ecs/client.rb', line 1784 def list_attributes(params = {}, = {}) req = build_request(:list_attributes, params) req.send_request() end |
#list_clusters(params = {}) ⇒ Types::ListClustersResponse
Returns a list of existing clusters.
1852 1853 1854 1855 |
# File 'lib/aws-sdk-ecs/client.rb', line 1852 def list_clusters(params = {}, = {}) req = build_request(:list_clusters, params) req.send_request() end |
#list_container_instances(params = {}) ⇒ Types::ListContainerInstancesResponse
Returns a list of container instances in a specified cluster. You can filter the results of a ‘ListContainerInstances` operation with cluster query language statements inside the `filter` parameter. For more information, see [Cluster Query Language] in the *Amazon EC2 Container Service Developer Guide*.
[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html
1955 1956 1957 1958 |
# File 'lib/aws-sdk-ecs/client.rb', line 1955 def list_container_instances(params = {}, = {}) req = build_request(:list_container_instances, params) req.send_request() end |
#list_services(params = {}) ⇒ Types::ListServicesResponse
Lists the services that are running in a specified cluster.
2028 2029 2030 2031 |
# File 'lib/aws-sdk-ecs/client.rb', line 2028 def list_services(params = {}, = {}) req = build_request(:list_services, params) req.send_request() end |
#list_task_definition_families(params = {}) ⇒ Types::ListTaskDefinitionFamiliesResponse
Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any ‘ACTIVE` task definition revisions).
You can filter out task definition families that do not contain any ‘ACTIVE` task definition revisions by setting the `status` parameter to `ACTIVE`. You can also filter the results with the `familyPrefix` parameter.
2141 2142 2143 2144 |
# File 'lib/aws-sdk-ecs/client.rb', line 2141 def list_task_definition_families(params = {}, = {}) req = build_request(:list_task_definition_families, params) req.send_request() end |
#list_task_definitions(params = {}) ⇒ Types::ListTaskDefinitionsResponse
Returns a list of task definitions that are registered to your account. You can filter the results by family name with the ‘familyPrefix` parameter or by status with the `status` parameter.
2260 2261 2262 2263 |
# File 'lib/aws-sdk-ecs/client.rb', line 2260 def list_task_definitions(params = {}, = {}) req = build_request(:list_task_definitions, params) req.send_request() end |
#list_tasks(params = {}) ⇒ Types::ListTasksResponse
Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the ‘family`, `containerInstance`, and `desiredStatus` parameters.
Recently-stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour.
2399 2400 2401 2402 |
# File 'lib/aws-sdk-ecs/client.rb', line 2399 def list_tasks(params = {}, = {}) req = build_request(:list_tasks, params) req.send_request() end |
#put_attributes(params = {}) ⇒ Types::PutAttributesResponse
Create or update an attribute on an Amazon ECS resource. If the attribute does not exist, it is created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see [Attributes] in the *Amazon EC2 Container Service Developer Guide*.
[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes
2454 2455 2456 2457 |
# File 'lib/aws-sdk-ecs/client.rb', line 2454 def put_attributes(params = {}, = {}) req = build_request(:put_attributes, params) req.send_request() end |
#register_container_instance(params = {}) ⇒ Types::RegisterContainerInstanceResponse
<note markdown=“1”> This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
</note>
Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.
2575 2576 2577 2578 |
# File 'lib/aws-sdk-ecs/client.rb', line 2575 def register_container_instance(params = {}, = {}) req = build_request(:register_container_instance, params) req.send_request() end |
#register_task_definition(params = {}) ⇒ Types::RegisterTaskDefinitionResponse
Registers a new task definition from the supplied ‘family` and `containerDefinitions`. Optionally, you can add data volumes to your containers with the `volumes` parameter. For more information about task definition parameters and defaults, see [Amazon ECS Task Definitions] in the *Amazon EC2 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 EC2 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.
[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html [2]: docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html [3]: docs.docker.com/engine/reference/run/#/network-settings
2884 2885 2886 2887 |
# File 'lib/aws-sdk-ecs/client.rb', line 2884 def register_task_definition(params = {}, = {}) req = build_request(:register_task_definition, params) req.send_request() end |
#run_task(params = {}) ⇒ Types::RunTaskResponse
Starts a new task using the specified task definition.
You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see [Scheduling Tasks] in the *Amazon EC2 Container Service Developer Guide*.
Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.
[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html
3088 3089 3090 3091 |
# File 'lib/aws-sdk-ecs/client.rb', line 3088 def run_task(params = {}, = {}) req = build_request(:run_task, params) req.send_request() end |
#start_task(params = {}) ⇒ Types::StartTaskResponse
Starts a new task from the specified task definition on the specified container instance or instances.
Alternatively, you can use RunTask to place tasks for you. For more information, see [Scheduling Tasks] in the *Amazon EC2 Container Service Developer Guide*.
[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html
3231 3232 3233 3234 |
# File 'lib/aws-sdk-ecs/client.rb', line 3231 def start_task(params = {}, = {}) req = build_request(:start_task, params) req.send_request() end |
#stop_task(params = {}) ⇒ Types::StopTaskResponse
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.
<note markdown=“1”> 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 EC2 Container Service Developer Guide*.
</note>
[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html
3327 3328 3329 3330 |
# File 'lib/aws-sdk-ecs/client.rb', line 3327 def stop_task(params = {}, = {}) req = build_request(:stop_task, params) req.send_request() end |
#submit_container_state_change(params = {}) ⇒ Types::SubmitContainerStateChangeResponse
<note markdown=“1”> This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
</note>
Sent to acknowledge that a container changed states.
3393 3394 3395 3396 |
# File 'lib/aws-sdk-ecs/client.rb', line 3393 def submit_container_state_change(params = {}, = {}) req = build_request(:submit_container_state_change, params) req.send_request() end |
#submit_task_state_change(params = {}) ⇒ Types::SubmitTaskStateChangeResponse
<note markdown=“1”> This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
</note>
Sent to acknowledge that a task changed states.
3440 3441 3442 3443 |
# File 'lib/aws-sdk-ecs/client.rb', line 3440 def submit_task_state_change(params = {}, = {}) req = build_request(:submit_task_state_change, params) req.send_request() end |
#update_container_agent(params = {}) ⇒ Types::UpdateContainerAgentResponse
Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.
‘UpdateContainerAgent` requires the Amazon ECS-optimized AMI or Amazon Linux with the `ecs-init` service installed and running. For help updating the Amazon ECS container agent on other operating systems, see [Manually Updating the Amazon ECS Container Agent] in the *Amazon EC2 Container Service Developer Guide*.
[1]: docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent
3523 3524 3525 3526 |
# File 'lib/aws-sdk-ecs/client.rb', line 3523 def update_container_agent(params = {}, = {}) req = build_request(:update_container_agent, params) req.send_request() end |
#update_container_instances_state(params = {}) ⇒ Types::UpdateContainerInstancesStateResponse
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 the service’s deployment configuration parameters, ‘minimumHealthyPercent` and `maximumPercent`. Note that 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.
3648 3649 3650 3651 |
# File 'lib/aws-sdk-ecs/client.rb', line 3648 def update_container_instances_state(params = {}, = {}) req = build_request(:update_container_instances_state, params) req.send_request() end |
#update_service(params = {}) ⇒ Types::UpdateServiceResponse
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 ‘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.
3840 3841 3842 3843 |
# File 'lib/aws-sdk-ecs/client.rb', line 3840 def update_service(params = {}, = {}) req = build_request(:update_service, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
## Basic Usage
A waiter will call an API operation until:
-
It is successful
-
It enters a terminal state
-
It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.waiter_until(waiter_name, params)
## Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
## Callbacks
You can be notified before each polling attempt and before each delay. If you throw ‘:success` or `:failure` from these callbacks, it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
## Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
## Valid Waiters
The following table lists the valid waiter names, the operations they call, and the default ‘:delay` and `:max_attempts` values.
| waiter_name | params | :delay | :max_attempts | | —————– | ——————– | ——– | ————- | | services_inactive | #describe_services | 15 | 40 | | services_stable | #describe_services | 15 | 40 | | tasks_running | #describe_tasks | 6 | 100 | | tasks_stopped | #describe_tasks | 6 | 100 |
3953 3954 3955 3956 3957 |
# File 'lib/aws-sdk-ecs/client.rb', line 3953 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
3961 3962 3963 |
# File 'lib/aws-sdk-ecs/client.rb', line 3961 def waiter_names waiters.keys end |