public class AbstractAmazonECSAsync extends AbstractAmazonECS implements AmazonECSAsync
AmazonECSAsync
. Convenient method forms
pass through to the corresponding overload that takes a request object and an
AsyncHandler
, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
createCluster, createCluster, createService, deleteCluster, deleteService, deregisterContainerInstance, deregisterTaskDefinition, describeClusters, describeClusters, describeContainerInstances, describeServices, describeTaskDefinition, describeTasks, discoverPollEndpoint, discoverPollEndpoint, getCachedResponseMetadata, listClusters, listClusters, listContainerInstances, listContainerInstances, listServices, listServices, listTaskDefinitionFamilies, listTaskDefinitionFamilies, listTaskDefinitions, listTaskDefinitions, listTasks, listTasks, registerContainerInstance, registerTaskDefinition, runTask, setEndpoint, setRegion, shutdown, startTask, stopTask, submitContainerStateChange, submitContainerStateChange, submitTaskStateChange, updateContainerAgent, updateService
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createCluster, createCluster, createService, deleteCluster, deleteService, deregisterContainerInstance, deregisterTaskDefinition, describeClusters, describeClusters, describeContainerInstances, describeServices, describeTaskDefinition, describeTasks, discoverPollEndpoint, discoverPollEndpoint, getCachedResponseMetadata, listClusters, listClusters, listContainerInstances, listContainerInstances, listServices, listServices, listTaskDefinitionFamilies, listTaskDefinitionFamilies, listTaskDefinitions, listTaskDefinitions, listTasks, listTasks, registerContainerInstance, registerTaskDefinition, runTask, setEndpoint, setRegion, shutdown, startTask, stopTask, submitContainerStateChange, submitContainerStateChange, submitTaskStateChange, updateContainerAgent, updateService
public Future<CreateClusterResult> createClusterAsync(CreateClusterRequest request)
AmazonECSAsync
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.
createClusterAsync
in interface AmazonECSAsync
public Future<CreateClusterResult> createClusterAsync(CreateClusterRequest request, AsyncHandler<CreateClusterRequest,CreateClusterResult> asyncHandler)
AmazonECSAsync
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.
createClusterAsync
in interface AmazonECSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateClusterResult> createClusterAsync()
createClusterAsync
in interface AmazonECSAsync
createClusterAsync(CreateClusterRequest)
public Future<CreateClusterResult> createClusterAsync(AsyncHandler<CreateClusterRequest,CreateClusterResult> asyncHandler)
createClusterAsync
in interface AmazonECSAsync
createClusterAsync(CreateClusterRequest,
com.amazonaws.handlers.AsyncHandler)
public Future<CreateServiceResult> createServiceAsync(CreateServiceRequest request)
AmazonECSAsync
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.
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.
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.
createServiceAsync
in interface AmazonECSAsync
public Future<CreateServiceResult> createServiceAsync(CreateServiceRequest request, AsyncHandler<CreateServiceRequest,CreateServiceResult> asyncHandler)
AmazonECSAsync
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.
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.
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.
createServiceAsync
in interface AmazonECSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteClusterResult> deleteClusterAsync(DeleteClusterRequest request)
AmazonECSAsync
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.
deleteClusterAsync
in interface AmazonECSAsync
public Future<DeleteClusterResult> deleteClusterAsync(DeleteClusterRequest request, AsyncHandler<DeleteClusterRequest,DeleteClusterResult> asyncHandler)
AmazonECSAsync
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.
deleteClusterAsync
in interface AmazonECSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteServiceResult> deleteServiceAsync(DeleteServiceRequest request)
AmazonECSAsync
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.
deleteServiceAsync
in interface AmazonECSAsync
public Future<DeleteServiceResult> deleteServiceAsync(DeleteServiceRequest request, AsyncHandler<DeleteServiceRequest,DeleteServiceResult> asyncHandler)
AmazonECSAsync
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.
deleteServiceAsync
in interface AmazonECSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeregisterContainerInstanceResult> deregisterContainerInstanceAsync(DeregisterContainerInstanceRequest request)
AmazonECSAsync
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.
If you terminate a running container instance with a connected Amazon ECS container agent, the agent automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated).
deregisterContainerInstanceAsync
in interface AmazonECSAsync
public Future<DeregisterContainerInstanceResult> deregisterContainerInstanceAsync(DeregisterContainerInstanceRequest request, AsyncHandler<DeregisterContainerInstanceRequest,DeregisterContainerInstanceResult> asyncHandler)
AmazonECSAsync
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.
If you terminate a running container instance with a connected Amazon ECS container agent, the agent automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated).
deregisterContainerInstanceAsync
in interface AmazonECSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeregisterTaskDefinitionResult> deregisterTaskDefinitionAsync(DeregisterTaskDefinitionRequest request)
AmazonECSAsync
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).
deregisterTaskDefinitionAsync
in interface AmazonECSAsync
public Future<DeregisterTaskDefinitionResult> deregisterTaskDefinitionAsync(DeregisterTaskDefinitionRequest request, AsyncHandler<DeregisterTaskDefinitionRequest,DeregisterTaskDefinitionResult> asyncHandler)
AmazonECSAsync
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).
deregisterTaskDefinitionAsync
in interface AmazonECSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeClustersResult> describeClustersAsync(DescribeClustersRequest request)
AmazonECSAsync
Describes one or more of your clusters.
describeClustersAsync
in interface AmazonECSAsync
public Future<DescribeClustersResult> describeClustersAsync(DescribeClustersRequest request, AsyncHandler<DescribeClustersRequest,DescribeClustersResult> asyncHandler)
AmazonECSAsync
Describes one or more of your clusters.
describeClustersAsync
in interface AmazonECSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeClustersResult> describeClustersAsync()
describeClustersAsync
in interface AmazonECSAsync
describeClustersAsync(DescribeClustersRequest)
public Future<DescribeClustersResult> describeClustersAsync(AsyncHandler<DescribeClustersRequest,DescribeClustersResult> asyncHandler)
describeClustersAsync
in interface AmazonECSAsync
describeClustersAsync(DescribeClustersRequest,
com.amazonaws.handlers.AsyncHandler)
public Future<DescribeContainerInstancesResult> describeContainerInstancesAsync(DescribeContainerInstancesRequest request)
AmazonECSAsync
Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
describeContainerInstancesAsync
in interface AmazonECSAsync
public Future<DescribeContainerInstancesResult> describeContainerInstancesAsync(DescribeContainerInstancesRequest request, AsyncHandler<DescribeContainerInstancesRequest,DescribeContainerInstancesResult> asyncHandler)
AmazonECSAsync
Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
describeContainerInstancesAsync
in interface AmazonECSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeServicesResult> describeServicesAsync(DescribeServicesRequest request)
AmazonECSAsync
Describes the specified services running in your cluster.
describeServicesAsync
in interface AmazonECSAsync
public Future<DescribeServicesResult> describeServicesAsync(DescribeServicesRequest request, AsyncHandler<DescribeServicesRequest,DescribeServicesResult> asyncHandler)
AmazonECSAsync
Describes the specified services running in your cluster.
describeServicesAsync
in interface AmazonECSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeTaskDefinitionResult> describeTaskDefinitionAsync(DescribeTaskDefinitionRequest request)
AmazonECSAsync
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.
describeTaskDefinitionAsync
in interface AmazonECSAsync
public Future<DescribeTaskDefinitionResult> describeTaskDefinitionAsync(DescribeTaskDefinitionRequest request, AsyncHandler<DescribeTaskDefinitionRequest,DescribeTaskDefinitionResult> asyncHandler)
AmazonECSAsync
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.
describeTaskDefinitionAsync
in interface AmazonECSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeTasksResult> describeTasksAsync(DescribeTasksRequest request)
AmazonECSAsync
Describes a specified task or tasks.
describeTasksAsync
in interface AmazonECSAsync
public Future<DescribeTasksResult> describeTasksAsync(DescribeTasksRequest request, AsyncHandler<DescribeTasksRequest,DescribeTasksResult> asyncHandler)
AmazonECSAsync
Describes a specified task or tasks.
describeTasksAsync
in interface AmazonECSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DiscoverPollEndpointResult> discoverPollEndpointAsync(DiscoverPollEndpointRequest request)
AmazonECSAsync
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Returns an endpoint for the Amazon EC2 Container Service agent to poll for updates.
discoverPollEndpointAsync
in interface AmazonECSAsync
public Future<DiscoverPollEndpointResult> discoverPollEndpointAsync(DiscoverPollEndpointRequest request, AsyncHandler<DiscoverPollEndpointRequest,DiscoverPollEndpointResult> asyncHandler)
AmazonECSAsync
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Returns an endpoint for the Amazon EC2 Container Service agent to poll for updates.
discoverPollEndpointAsync
in interface AmazonECSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DiscoverPollEndpointResult> discoverPollEndpointAsync()
discoverPollEndpointAsync
in interface AmazonECSAsync
discoverPollEndpointAsync(DiscoverPollEndpointRequest)
public Future<DiscoverPollEndpointResult> discoverPollEndpointAsync(AsyncHandler<DiscoverPollEndpointRequest,DiscoverPollEndpointResult> asyncHandler)
discoverPollEndpointAsync
in interface AmazonECSAsync
discoverPollEndpointAsync(DiscoverPollEndpointRequest,
com.amazonaws.handlers.AsyncHandler)
public Future<ListClustersResult> listClustersAsync(ListClustersRequest request)
AmazonECSAsync
Returns a list of existing clusters.
listClustersAsync
in interface AmazonECSAsync
public Future<ListClustersResult> listClustersAsync(ListClustersRequest request, AsyncHandler<ListClustersRequest,ListClustersResult> asyncHandler)
AmazonECSAsync
Returns a list of existing clusters.
listClustersAsync
in interface AmazonECSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListClustersResult> listClustersAsync()
listClustersAsync
in interface AmazonECSAsync
listClustersAsync(ListClustersRequest)
public Future<ListClustersResult> listClustersAsync(AsyncHandler<ListClustersRequest,ListClustersResult> asyncHandler)
listClustersAsync
in interface AmazonECSAsync
listClustersAsync(ListClustersRequest,
com.amazonaws.handlers.AsyncHandler)
public Future<ListContainerInstancesResult> listContainerInstancesAsync(ListContainerInstancesRequest request)
AmazonECSAsync
Returns a list of container instances in a specified cluster.
listContainerInstancesAsync
in interface AmazonECSAsync
public Future<ListContainerInstancesResult> listContainerInstancesAsync(ListContainerInstancesRequest request, AsyncHandler<ListContainerInstancesRequest,ListContainerInstancesResult> asyncHandler)
AmazonECSAsync
Returns a list of container instances in a specified cluster.
listContainerInstancesAsync
in interface AmazonECSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListContainerInstancesResult> listContainerInstancesAsync()
listContainerInstancesAsync
in interface AmazonECSAsync
listContainerInstancesAsync(ListContainerInstancesRequest)
public Future<ListContainerInstancesResult> listContainerInstancesAsync(AsyncHandler<ListContainerInstancesRequest,ListContainerInstancesResult> asyncHandler)
listContainerInstancesAsync
in interface AmazonECSAsync
listContainerInstancesAsync(ListContainerInstancesRequest,
com.amazonaws.handlers.AsyncHandler)
public Future<ListServicesResult> listServicesAsync(ListServicesRequest request)
AmazonECSAsync
Lists the services that are running in a specified cluster.
listServicesAsync
in interface AmazonECSAsync
public Future<ListServicesResult> listServicesAsync(ListServicesRequest request, AsyncHandler<ListServicesRequest,ListServicesResult> asyncHandler)
AmazonECSAsync
Lists the services that are running in a specified cluster.
listServicesAsync
in interface AmazonECSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListServicesResult> listServicesAsync()
listServicesAsync
in interface AmazonECSAsync
listServicesAsync(ListServicesRequest)
public Future<ListServicesResult> listServicesAsync(AsyncHandler<ListServicesRequest,ListServicesResult> asyncHandler)
listServicesAsync
in interface AmazonECSAsync
listServicesAsync(ListServicesRequest,
com.amazonaws.handlers.AsyncHandler)
public Future<ListTaskDefinitionFamiliesResult> listTaskDefinitionFamiliesAsync(ListTaskDefinitionFamiliesRequest request)
AmazonECSAsync
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.
listTaskDefinitionFamiliesAsync
in interface AmazonECSAsync
public Future<ListTaskDefinitionFamiliesResult> listTaskDefinitionFamiliesAsync(ListTaskDefinitionFamiliesRequest request, AsyncHandler<ListTaskDefinitionFamiliesRequest,ListTaskDefinitionFamiliesResult> asyncHandler)
AmazonECSAsync
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.
listTaskDefinitionFamiliesAsync
in interface AmazonECSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTaskDefinitionFamiliesResult> listTaskDefinitionFamiliesAsync()
listTaskDefinitionFamiliesAsync
in interface AmazonECSAsync
listTaskDefinitionFamiliesAsync(ListTaskDefinitionFamiliesRequest)
public Future<ListTaskDefinitionFamiliesResult> listTaskDefinitionFamiliesAsync(AsyncHandler<ListTaskDefinitionFamiliesRequest,ListTaskDefinitionFamiliesResult> asyncHandler)
listTaskDefinitionFamiliesAsync
in interface AmazonECSAsync
listTaskDefinitionFamiliesAsync(ListTaskDefinitionFamiliesRequest,
com.amazonaws.handlers.AsyncHandler)
public Future<ListTaskDefinitionsResult> listTaskDefinitionsAsync(ListTaskDefinitionsRequest request)
AmazonECSAsync
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.
listTaskDefinitionsAsync
in interface AmazonECSAsync
public Future<ListTaskDefinitionsResult> listTaskDefinitionsAsync(ListTaskDefinitionsRequest request, AsyncHandler<ListTaskDefinitionsRequest,ListTaskDefinitionsResult> asyncHandler)
AmazonECSAsync
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.
listTaskDefinitionsAsync
in interface AmazonECSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTaskDefinitionsResult> listTaskDefinitionsAsync()
listTaskDefinitionsAsync
in interface AmazonECSAsync
listTaskDefinitionsAsync(ListTaskDefinitionsRequest)
public Future<ListTaskDefinitionsResult> listTaskDefinitionsAsync(AsyncHandler<ListTaskDefinitionsRequest,ListTaskDefinitionsResult> asyncHandler)
listTaskDefinitionsAsync
in interface AmazonECSAsync
listTaskDefinitionsAsync(ListTaskDefinitionsRequest,
com.amazonaws.handlers.AsyncHandler)
public Future<ListTasksResult> listTasksAsync(ListTasksRequest request)
AmazonECSAsync
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.
listTasksAsync
in interface AmazonECSAsync
public Future<ListTasksResult> listTasksAsync(ListTasksRequest request, AsyncHandler<ListTasksRequest,ListTasksResult> asyncHandler)
AmazonECSAsync
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.
listTasksAsync
in interface AmazonECSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTasksResult> listTasksAsync()
listTasksAsync
in interface AmazonECSAsync
listTasksAsync(ListTasksRequest)
public Future<ListTasksResult> listTasksAsync(AsyncHandler<ListTasksRequest,ListTasksResult> asyncHandler)
listTasksAsync
in interface AmazonECSAsync
listTasksAsync(ListTasksRequest,
com.amazonaws.handlers.AsyncHandler)
public Future<RegisterContainerInstanceResult> registerContainerInstanceAsync(RegisterContainerInstanceRequest request)
AmazonECSAsync
This action is only used by the Amazon EC2 Container Service 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.
registerContainerInstanceAsync
in interface AmazonECSAsync
public Future<RegisterContainerInstanceResult> registerContainerInstanceAsync(RegisterContainerInstanceRequest request, AsyncHandler<RegisterContainerInstanceRequest,RegisterContainerInstanceResult> asyncHandler)
AmazonECSAsync
This action is only used by the Amazon EC2 Container Service 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.
registerContainerInstanceAsync
in interface AmazonECSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RegisterTaskDefinitionResult> registerTaskDefinitionAsync(RegisterTaskDefinitionRequest request)
AmazonECSAsync
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.
registerTaskDefinitionAsync
in interface AmazonECSAsync
public Future<RegisterTaskDefinitionResult> registerTaskDefinitionAsync(RegisterTaskDefinitionRequest request, AsyncHandler<RegisterTaskDefinitionRequest,RegisterTaskDefinitionResult> asyncHandler)
AmazonECSAsync
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.
registerTaskDefinitionAsync
in interface AmazonECSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RunTaskResult> runTaskAsync(RunTaskRequest request)
AmazonECSAsync
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.
runTaskAsync
in interface AmazonECSAsync
public Future<RunTaskResult> runTaskAsync(RunTaskRequest request, AsyncHandler<RunTaskRequest,RunTaskResult> asyncHandler)
AmazonECSAsync
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.
runTaskAsync
in interface AmazonECSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartTaskResult> startTaskAsync(StartTaskRequest request)
AmazonECSAsync
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.
startTaskAsync
in interface AmazonECSAsync
public Future<StartTaskResult> startTaskAsync(StartTaskRequest request, AsyncHandler<StartTaskRequest,StartTaskResult> asyncHandler)
AmazonECSAsync
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.
startTaskAsync
in interface AmazonECSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StopTaskResult> stopTaskAsync(StopTaskRequest request)
AmazonECSAsync
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.
stopTaskAsync
in interface AmazonECSAsync
public Future<StopTaskResult> stopTaskAsync(StopTaskRequest request, AsyncHandler<StopTaskRequest,StopTaskResult> asyncHandler)
AmazonECSAsync
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.
stopTaskAsync
in interface AmazonECSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SubmitContainerStateChangeResult> submitContainerStateChangeAsync(SubmitContainerStateChangeRequest request)
AmazonECSAsync
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a container changed states.
submitContainerStateChangeAsync
in interface AmazonECSAsync
public Future<SubmitContainerStateChangeResult> submitContainerStateChangeAsync(SubmitContainerStateChangeRequest request, AsyncHandler<SubmitContainerStateChangeRequest,SubmitContainerStateChangeResult> asyncHandler)
AmazonECSAsync
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a container changed states.
submitContainerStateChangeAsync
in interface AmazonECSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<SubmitContainerStateChangeResult> submitContainerStateChangeAsync()
submitContainerStateChangeAsync
in interface AmazonECSAsync
submitContainerStateChangeAsync(SubmitContainerStateChangeRequest)
public Future<SubmitContainerStateChangeResult> submitContainerStateChangeAsync(AsyncHandler<SubmitContainerStateChangeRequest,SubmitContainerStateChangeResult> asyncHandler)
submitContainerStateChangeAsync
in interface AmazonECSAsync
submitContainerStateChangeAsync(SubmitContainerStateChangeRequest,
com.amazonaws.handlers.AsyncHandler)
public Future<SubmitTaskStateChangeResult> submitTaskStateChangeAsync(SubmitTaskStateChangeRequest request)
AmazonECSAsync
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a task changed states.
submitTaskStateChangeAsync
in interface AmazonECSAsync
public Future<SubmitTaskStateChangeResult> submitTaskStateChangeAsync(SubmitTaskStateChangeRequest request, AsyncHandler<SubmitTaskStateChangeRequest,SubmitTaskStateChangeResult> asyncHandler)
AmazonECSAsync
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a task changed states.
submitTaskStateChangeAsync
in interface AmazonECSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateContainerAgentResult> updateContainerAgentAsync(UpdateContainerAgentRequest request)
AmazonECSAsync
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.
updateContainerAgentAsync
in interface AmazonECSAsync
public Future<UpdateContainerAgentResult> updateContainerAgentAsync(UpdateContainerAgentRequest request, AsyncHandler<UpdateContainerAgentRequest,UpdateContainerAgentResult> asyncHandler)
AmazonECSAsync
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.
updateContainerAgentAsync
in interface AmazonECSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateServiceResult> updateServiceAsync(UpdateServiceRequest request)
AmazonECSAsync
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.
updateServiceAsync
in interface AmazonECSAsync
public Future<UpdateServiceResult> updateServiceAsync(UpdateServiceRequest request, AsyncHandler<UpdateServiceRequest,UpdateServiceResult> asyncHandler)
AmazonECSAsync
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.
updateServiceAsync
in interface AmazonECSAsync
asyncHandler
- Asynchronous callback handler for events in the lifecycle of the
request. Users can provide an implementation of the callback
methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.