@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonECSAsyncClient extends AmazonECSClient implements AmazonECSAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run, stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.
Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes it easy to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.
You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. With Amazon ECS, you don't need to operate your own cluster management and configuration management systems. You also don't need to worry about scaling your management infrastructure.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AmazonECSAsyncClient()
Deprecated.
|
AmazonECSAsyncClient(AWSCredentials awsCredentials)
Deprecated.
|
AmazonECSAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AmazonECSAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
|
AmazonECSAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonECSAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonECSAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AmazonECSAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
|
AmazonECSAsyncClient(ClientConfiguration clientConfiguration)
Deprecated.
|
builder, createCapacityProvider, createCluster, createCluster, createService, createTaskSet, deleteAccountSetting, deleteAttributes, deleteCapacityProvider, deleteCluster, deleteService, deleteTaskDefinitions, deleteTaskSet, deregisterContainerInstance, deregisterTaskDefinition, describeCapacityProviders, describeClusters, describeClusters, describeContainerInstances, describeServices, describeTaskDefinition, describeTasks, describeTaskSets, discoverPollEndpoint, discoverPollEndpoint, executeCommand, getCachedResponseMetadata, getTaskProtection, listAccountSettings, listAttributes, listClusters, listClusters, listContainerInstances, listContainerInstances, listServices, listServices, listServicesByNamespace, listTagsForResource, listTaskDefinitionFamilies, listTaskDefinitionFamilies, listTaskDefinitions, listTaskDefinitions, listTasks, listTasks, putAccountSetting, putAccountSettingDefault, putAttributes, putClusterCapacityProviders, registerContainerInstance, registerTaskDefinition, runTask, startTask, stopTask, submitAttachmentStateChanges, submitContainerStateChange, submitContainerStateChange, submitTaskStateChange, tagResource, untagResource, updateCapacityProvider, updateCluster, updateClusterSettings, updateContainerAgent, updateContainerInstancesState, updateService, updateServicePrimaryTaskSet, updateTaskProtection, updateTaskSet, waitersaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcreateCapacityProvider, createCluster, createCluster, createService, createTaskSet, deleteAccountSetting, deleteAttributes, deleteCapacityProvider, deleteCluster, deleteService, deleteTaskDefinitions, deleteTaskSet, deregisterContainerInstance, deregisterTaskDefinition, describeCapacityProviders, describeClusters, describeClusters, describeContainerInstances, describeServices, describeTaskDefinition, describeTasks, describeTaskSets, discoverPollEndpoint, discoverPollEndpoint, executeCommand, getCachedResponseMetadata, getTaskProtection, listAccountSettings, listAttributes, listClusters, listClusters, listContainerInstances, listContainerInstances, listServices, listServices, listServicesByNamespace, listTagsForResource, listTaskDefinitionFamilies, listTaskDefinitionFamilies, listTaskDefinitions, listTaskDefinitions, listTasks, listTasks, putAccountSetting, putAccountSettingDefault, putAttributes, putClusterCapacityProviders, registerContainerInstance, registerTaskDefinition, runTask, setEndpoint, setRegion, startTask, stopTask, submitAttachmentStateChanges, submitContainerStateChange, submitContainerStateChange, submitTaskStateChange, tagResource, untagResource, updateCapacityProvider, updateCluster, updateClusterSettings, updateContainerAgent, updateContainerInstancesState, updateService, updateServicePrimaryTaskSet, updateTaskProtection, updateTaskSet, waiters@Deprecated public AmazonECSAsyncClient()
AmazonECSAsyncClientBuilder.defaultClient()Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
@Deprecated public AmazonECSAsyncClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
clientConfiguration - The client configuration options controlling how this client connects to Amazon ECS (ex: proxy settings,
retry counts, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)@Deprecated public AmazonECSAsyncClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AmazonECSAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.executorService - The executor service by which all asynchronous requests will be executed.@Deprecated public AmazonECSAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).executorService - The executor service by which all asynchronous requests will be executed.@Deprecated public AmazonECSAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AmazonECSAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)@Deprecated public AmazonECSAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.executorService - The executor service by which all asynchronous requests will be executed.@Deprecated public AmazonECSAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).executorService - The executor service by which all asynchronous requests will be executed.public static AmazonECSAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CreateCapacityProviderResult> createCapacityProviderAsync(CreateCapacityProviderRequest request)
AmazonECSAsyncCreates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used in capacity provider strategies to facilitate cluster auto scaling.
Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on Fargate use the
FARGATE and FARGATE_SPOT capacity providers. These providers are available to all
accounts in the Amazon Web Services Regions that Fargate supports.
createCapacityProviderAsync in interface AmazonECSAsyncpublic Future<CreateCapacityProviderResult> createCapacityProviderAsync(CreateCapacityProviderRequest request, AsyncHandler<CreateCapacityProviderRequest,CreateCapacityProviderResult> asyncHandler)
AmazonECSAsyncCreates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used in capacity provider strategies to facilitate cluster auto scaling.
Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on Fargate use the
FARGATE and FARGATE_SPOT capacity providers. These providers are available to all
accounts in the Amazon Web Services Regions that Fargate supports.
createCapacityProviderAsync in interface AmazonECSAsyncasyncHandler - 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(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.
When you call the CreateCluster API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes the call doesn't have permissions to create the service-linked role, it isn't created. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
createClusterAsync in interface AmazonECSAsyncpublic 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.
When you call the CreateCluster API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes the call doesn't have permissions to create the service-linked role, it isn't created. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
createClusterAsync in interface AmazonECSAsyncasyncHandler - 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 AmazonECSAsynccreateClusterAsync(CreateClusterRequest)public Future<CreateClusterResult> createClusterAsync(AsyncHandler<CreateClusterRequest,CreateClusterResult> asyncHandler)
createClusterAsync in interface AmazonECSAsynccreateClusterAsync(CreateClusterRequest, com.amazonaws.handlers.AsyncHandler)public Future<CreateServiceResult> createServiceAsync(CreateServiceRequest request)
AmazonECSAsync
Runs and maintains your desired number of tasks from a specified task definition. If the number of tasks running
in a service drops below the desiredCount, Amazon ECS runs another copy of the task in the specified
cluster. To update an existing service, see the UpdateService action.
In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.
Tasks for services that don't use a load balancer are considered healthy if they're in the RUNNING
state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING
state and are reported as healthy by the load balancer.
There are two service scheduler strategies available:
REPLICA - The replica scheduling strategy places and maintains your desired number of tasks across
your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task
placement strategies and constraints to customize task placement decisions. For more information, see Service scheduler
concepts in the Amazon Elastic Container Service Developer Guide.
DAEMON - The daemon scheduling strategy deploys exactly one task on each active container instance
that meets all of the task placement constraints that you specify in your cluster. The service scheduler also
evaluates the task placement constraints for running tasks. It also stops tasks that don't meet the placement
constraints. When using this strategy, you don't need to specify a desired number of tasks, a task placement
strategy, or use Service Auto Scaling policies. For more information, see Service scheduler
concepts in the Amazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment is initiated by changing
properties. For example, the deployment might be initiated by the task definition or by your desired count of a
service. This is done with an UpdateService operation. The default value for a replica service for
minimumHealthyPercent is 100%. The default value for a daemon service for
minimumHealthyPercent is 0%.
If a service uses the ECS deployment controller, the minimum healthy percent represents a lower
limit on the number of tasks in a service that must remain in the RUNNING state during a deployment.
Specifically, it represents it as a percentage of your desired number of tasks (rounded up to the nearest
integer). This happens when any of your container instances are in the DRAINING state if the service
contains tasks using the EC2 launch type. Using this parameter, you can deploy without using additional cluster
capacity. For example, if you set your service to have desired number of four tasks and a minimum healthy percent
of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. If
they're in the RUNNING state, tasks for services that don't use a load balancer are considered
healthy . If they're in the RUNNING state and reported as healthy by the load balancer, tasks for
services that do use a load balancer are considered healthy . The default value for minimum healthy
percent is 100%.
If a service uses the ECS deployment controller, the maximum percent parameter represents an
upper limit on the number of tasks in a service that are allowed in the RUNNING or
PENDING state during a deployment. Specifically, it represents it as a percentage of the desired
number of tasks (rounded down to the nearest integer). This happens when any of your container instances are in
the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter,
you can define the deployment batch size. For example, if your service has a desired number of four tasks and a
maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks
(provided that the cluster resources required to do this are available). The default value for maximum percent is
200%.
If a service uses either the CODE_DEPLOY or EXTERNAL deployment controller types and
tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used
only to define the lower and upper limit on the number of the tasks in the service that remain in the
RUNNING state. This is while the container instances are in the DRAINING state. If the
tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't
used. This is the case even if they're currently visible when describing your service.
When creating a service that uses the EXTERNAL deployment controller, you can specify only
parameters that aren't controlled at the task set level. The only required parameter is the service name. You
control your services using the CreateTaskSet operation. For more information, see Amazon ECS deployment
types in the Amazon Elastic Container Service Developer Guide.
When the service scheduler launches new tasks, it determines task placement. For information about task placement and task placement strategies, see Amazon ECS task placement in the Amazon Elastic Container Service Developer Guide.
createServiceAsync in interface AmazonECSAsyncpublic Future<CreateServiceResult> createServiceAsync(CreateServiceRequest request, AsyncHandler<CreateServiceRequest,CreateServiceResult> asyncHandler)
AmazonECSAsync
Runs and maintains your desired number of tasks from a specified task definition. If the number of tasks running
in a service drops below the desiredCount, Amazon ECS runs another copy of the task in the specified
cluster. To update an existing service, see the UpdateService action.
In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.
Tasks for services that don't use a load balancer are considered healthy if they're in the RUNNING
state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING
state and are reported as healthy by the load balancer.
There are two service scheduler strategies available:
REPLICA - The replica scheduling strategy places and maintains your desired number of tasks across
your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task
placement strategies and constraints to customize task placement decisions. For more information, see Service scheduler
concepts in the Amazon Elastic Container Service Developer Guide.
DAEMON - The daemon scheduling strategy deploys exactly one task on each active container instance
that meets all of the task placement constraints that you specify in your cluster. The service scheduler also
evaluates the task placement constraints for running tasks. It also stops tasks that don't meet the placement
constraints. When using this strategy, you don't need to specify a desired number of tasks, a task placement
strategy, or use Service Auto Scaling policies. For more information, see Service scheduler
concepts in the Amazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment is initiated by changing
properties. For example, the deployment might be initiated by the task definition or by your desired count of a
service. This is done with an UpdateService operation. The default value for a replica service for
minimumHealthyPercent is 100%. The default value for a daemon service for
minimumHealthyPercent is 0%.
If a service uses the ECS deployment controller, the minimum healthy percent represents a lower
limit on the number of tasks in a service that must remain in the RUNNING state during a deployment.
Specifically, it represents it as a percentage of your desired number of tasks (rounded up to the nearest
integer). This happens when any of your container instances are in the DRAINING state if the service
contains tasks using the EC2 launch type. Using this parameter, you can deploy without using additional cluster
capacity. For example, if you set your service to have desired number of four tasks and a minimum healthy percent
of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. If
they're in the RUNNING state, tasks for services that don't use a load balancer are considered
healthy . If they're in the RUNNING state and reported as healthy by the load balancer, tasks for
services that do use a load balancer are considered healthy . The default value for minimum healthy
percent is 100%.
If a service uses the ECS deployment controller, the maximum percent parameter represents an
upper limit on the number of tasks in a service that are allowed in the RUNNING or
PENDING state during a deployment. Specifically, it represents it as a percentage of the desired
number of tasks (rounded down to the nearest integer). This happens when any of your container instances are in
the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter,
you can define the deployment batch size. For example, if your service has a desired number of four tasks and a
maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks
(provided that the cluster resources required to do this are available). The default value for maximum percent is
200%.
If a service uses either the CODE_DEPLOY or EXTERNAL deployment controller types and
tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used
only to define the lower and upper limit on the number of the tasks in the service that remain in the
RUNNING state. This is while the container instances are in the DRAINING state. If the
tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't
used. This is the case even if they're currently visible when describing your service.
When creating a service that uses the EXTERNAL deployment controller, you can specify only
parameters that aren't controlled at the task set level. The only required parameter is the service name. You
control your services using the CreateTaskSet operation. For more information, see Amazon ECS deployment
types in the Amazon Elastic Container Service Developer Guide.
When the service scheduler launches new tasks, it determines task placement. For information about task placement and task placement strategies, see Amazon ECS task placement in the Amazon Elastic Container Service Developer Guide.
createServiceAsync in interface AmazonECSAsyncasyncHandler - 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<CreateTaskSetResult> createTaskSetAsync(CreateTaskSetRequest request)
AmazonECSAsync
Create a task set in the specified cluster and service. This is used when a service uses the
EXTERNAL deployment controller type. For more information, see Amazon ECS deployment
types in the Amazon Elastic Container Service Developer Guide.
createTaskSetAsync in interface AmazonECSAsyncpublic Future<CreateTaskSetResult> createTaskSetAsync(CreateTaskSetRequest request, AsyncHandler<CreateTaskSetRequest,CreateTaskSetResult> asyncHandler)
AmazonECSAsync
Create a task set in the specified cluster and service. This is used when a service uses the
EXTERNAL deployment controller type. For more information, see Amazon ECS deployment
types in the Amazon Elastic Container Service Developer Guide.
createTaskSetAsync in interface AmazonECSAsyncasyncHandler - 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<DeleteAccountSettingResult> deleteAccountSettingAsync(DeleteAccountSettingRequest request)
AmazonECSAsyncDisables an account setting for a specified user, role, or the root user for an account.
deleteAccountSettingAsync in interface AmazonECSAsyncpublic Future<DeleteAccountSettingResult> deleteAccountSettingAsync(DeleteAccountSettingRequest request, AsyncHandler<DeleteAccountSettingRequest,DeleteAccountSettingResult> asyncHandler)
AmazonECSAsyncDisables an account setting for a specified user, role, or the root user for an account.
deleteAccountSettingAsync in interface AmazonECSAsyncasyncHandler - 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<DeleteAttributesResult> deleteAttributesAsync(DeleteAttributesRequest request)
AmazonECSAsyncDeletes one or more custom attributes from an Amazon ECS resource.
deleteAttributesAsync in interface AmazonECSAsyncpublic Future<DeleteAttributesResult> deleteAttributesAsync(DeleteAttributesRequest request, AsyncHandler<DeleteAttributesRequest,DeleteAttributesResult> asyncHandler)
AmazonECSAsyncDeletes one or more custom attributes from an Amazon ECS resource.
deleteAttributesAsync in interface AmazonECSAsyncasyncHandler - 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<DeleteCapacityProviderResult> deleteCapacityProviderAsync(DeleteCapacityProviderRequest request)
AmazonECSAsyncDeletes the specified capacity provider.
The FARGATE and FARGATE_SPOT capacity providers are reserved and can't be deleted. You
can disassociate them from a cluster using either the PutClusterCapacityProviders API or by deleting the
cluster.
Prior to a capacity provider being deleted, the capacity provider must be removed from the capacity provider
strategy from all services. The UpdateService API can be used to remove a capacity provider from a
service's capacity provider strategy. When updating a service, the forceNewDeployment option can be
used to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity provider are
transitioned to use the capacity from the remaining capacity providers. Only capacity providers that aren't
associated with a cluster can be deleted. To remove a capacity provider from a cluster, you can either use
PutClusterCapacityProviders or delete the cluster.
deleteCapacityProviderAsync in interface AmazonECSAsyncpublic Future<DeleteCapacityProviderResult> deleteCapacityProviderAsync(DeleteCapacityProviderRequest request, AsyncHandler<DeleteCapacityProviderRequest,DeleteCapacityProviderResult> asyncHandler)
AmazonECSAsyncDeletes the specified capacity provider.
The FARGATE and FARGATE_SPOT capacity providers are reserved and can't be deleted. You
can disassociate them from a cluster using either the PutClusterCapacityProviders API or by deleting the
cluster.
Prior to a capacity provider being deleted, the capacity provider must be removed from the capacity provider
strategy from all services. The UpdateService API can be used to remove a capacity provider from a
service's capacity provider strategy. When updating a service, the forceNewDeployment option can be
used to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity provider are
transitioned to use the capacity from the remaining capacity providers. Only capacity providers that aren't
associated with a cluster can be deleted. To remove a capacity provider from a cluster, you can either use
PutClusterCapacityProviders or delete the cluster.
deleteCapacityProviderAsync in interface AmazonECSAsyncasyncHandler - 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. The cluster transitions to the INACTIVE state. Clusters with an
INACTIVE status might remain discoverable in your account for a period of time. However, this
behavior is subject to change in the future. We don't recommend that you rely on INACTIVE clusters
persisting.
You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
deleteClusterAsync in interface AmazonECSAsyncpublic Future<DeleteClusterResult> deleteClusterAsync(DeleteClusterRequest request, AsyncHandler<DeleteClusterRequest,DeleteClusterResult> asyncHandler)
AmazonECSAsync
Deletes the specified cluster. The cluster transitions to the INACTIVE state. Clusters with an
INACTIVE status might remain discoverable in your account for a period of time. However, this
behavior is subject to change in the future. We don't recommend that you rely on INACTIVE clusters
persisting.
You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
deleteClusterAsync in interface AmazonECSAsyncasyncHandler - 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)
AmazonECSAsyncDeletes 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 can't delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService.
When you delete a service, if there are still running tasks that require cleanup, the service status moves from
ACTIVE to DRAINING, and the service is no longer visible in the console or in the
ListServices API operation. After all tasks have transitioned to either STOPPING or
STOPPED status, the service status moves from DRAINING to INACTIVE.
Services in the DRAINING or INACTIVE status can still be viewed with the
DescribeServices API operation. However, in the future, INACTIVE services may be cleaned up
and purged from Amazon ECS record keeping, and DescribeServices calls on those services return a
ServiceNotFoundException error.
If you attempt to create a new service with the same name as an existing service in either ACTIVE or
DRAINING status, you receive an error.
deleteServiceAsync in interface AmazonECSAsyncpublic Future<DeleteServiceResult> deleteServiceAsync(DeleteServiceRequest request, AsyncHandler<DeleteServiceRequest,DeleteServiceResult> asyncHandler)
AmazonECSAsyncDeletes 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 can't delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService.
When you delete a service, if there are still running tasks that require cleanup, the service status moves from
ACTIVE to DRAINING, and the service is no longer visible in the console or in the
ListServices API operation. After all tasks have transitioned to either STOPPING or
STOPPED status, the service status moves from DRAINING to INACTIVE.
Services in the DRAINING or INACTIVE status can still be viewed with the
DescribeServices API operation. However, in the future, INACTIVE services may be cleaned up
and purged from Amazon ECS record keeping, and DescribeServices calls on those services return a
ServiceNotFoundException error.
If you attempt to create a new service with the same name as an existing service in either ACTIVE or
DRAINING status, you receive an error.
deleteServiceAsync in interface AmazonECSAsyncasyncHandler - 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<DeleteTaskDefinitionsResult> deleteTaskDefinitionsAsync(DeleteTaskDefinitionsRequest request)
AmazonECSAsyncDeletes one or more task definitions.
You must deregister a task definition revision before you delete it. For more information, see DeregisterTaskDefinition.
When you delete a task definition revision, it is immediately transitions from the INACTIVE to
DELETE_IN_PROGRESS. Existing tasks and services that reference a DELETE_IN_PROGRESS
task definition revision continue to run without disruption. Existing services that reference a
DELETE_IN_PROGRESS task definition revision can still scale up or down by modifying the service's
desired count.
You can't use a DELETE_IN_PROGRESS task definition revision to run new tasks or create new services.
You also can't update an existing service to reference a DELETE_IN_PROGRESS task definition
revision.
A task definition revision will stay in DELETE_IN_PROGRESS status until all the associated tasks and
services have been terminated.
deleteTaskDefinitionsAsync in interface AmazonECSAsyncpublic Future<DeleteTaskDefinitionsResult> deleteTaskDefinitionsAsync(DeleteTaskDefinitionsRequest request, AsyncHandler<DeleteTaskDefinitionsRequest,DeleteTaskDefinitionsResult> asyncHandler)
AmazonECSAsyncDeletes one or more task definitions.
You must deregister a task definition revision before you delete it. For more information, see DeregisterTaskDefinition.
When you delete a task definition revision, it is immediately transitions from the INACTIVE to
DELETE_IN_PROGRESS. Existing tasks and services that reference a DELETE_IN_PROGRESS
task definition revision continue to run without disruption. Existing services that reference a
DELETE_IN_PROGRESS task definition revision can still scale up or down by modifying the service's
desired count.
You can't use a DELETE_IN_PROGRESS task definition revision to run new tasks or create new services.
You also can't update an existing service to reference a DELETE_IN_PROGRESS task definition
revision.
A task definition revision will stay in DELETE_IN_PROGRESS status until all the associated tasks and
services have been terminated.
deleteTaskDefinitionsAsync in interface AmazonECSAsyncasyncHandler - 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<DeleteTaskSetResult> deleteTaskSetAsync(DeleteTaskSetRequest request)
AmazonECSAsync
Deletes a specified task set within a service. This is used when a service uses the EXTERNAL
deployment controller type. For more information, see Amazon ECS deployment
types in the Amazon Elastic Container Service Developer Guide.
deleteTaskSetAsync in interface AmazonECSAsyncpublic Future<DeleteTaskSetResult> deleteTaskSetAsync(DeleteTaskSetRequest request, AsyncHandler<DeleteTaskSetRequest,DeleteTaskSetResult> asyncHandler)
AmazonECSAsync
Deletes a specified task set within a service. This is used when a service uses the EXTERNAL
deployment controller type. For more information, see Amazon ECS deployment
types in the Amazon Elastic Container Service Developer Guide.
deleteTaskSetAsync in interface AmazonECSAsyncasyncHandler - 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)
AmazonECSAsyncDeregisters 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, we recommend that you stop all of the tasks running on the container instance before deregistration. That prevents any orphaned tasks from consuming resources.
Deregistering a container instance removes the instance from a cluster, but it doesn't terminate the EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.
If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents aren't automatically deregistered when terminated).
deregisterContainerInstanceAsync in interface AmazonECSAsyncpublic Future<DeregisterContainerInstanceResult> deregisterContainerInstanceAsync(DeregisterContainerInstanceRequest request, AsyncHandler<DeregisterContainerInstanceRequest,DeregisterContainerInstanceResult> asyncHandler)
AmazonECSAsyncDeregisters 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, we recommend that you stop all of the tasks running on the container instance before deregistration. That prevents any orphaned tasks from consuming resources.
Deregistering a container instance removes the instance from a cluster, but it doesn't terminate the EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.
If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents aren't automatically deregistered when terminated).
deregisterContainerInstanceAsync in interface AmazonECSAsyncasyncHandler - 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. If you want to delete a task
definition revision, you must first deregister the task definition revision.
You can't use an INACTIVE task definition to run new tasks or create new services, and you can't
update an existing service to reference an INACTIVE task definition. However, there may be up to a
10-minute window following deregistration where these restrictions have not yet taken effect.
At this time, INACTIVE task definitions remain discoverable in your account indefinitely. However,
this behavior is subject to change in the future. We don't recommend that you rely on INACTIVE task
definitions persisting beyond the lifecycle of any associated tasks and services.
You must deregister a task definition revision before you delete it. For more information, see DeleteTaskDefinitions.
deregisterTaskDefinitionAsync in interface AmazonECSAsyncpublic 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. If you want to delete a task
definition revision, you must first deregister the task definition revision.
You can't use an INACTIVE task definition to run new tasks or create new services, and you can't
update an existing service to reference an INACTIVE task definition. However, there may be up to a
10-minute window following deregistration where these restrictions have not yet taken effect.
At this time, INACTIVE task definitions remain discoverable in your account indefinitely. However,
this behavior is subject to change in the future. We don't recommend that you rely on INACTIVE task
definitions persisting beyond the lifecycle of any associated tasks and services.
You must deregister a task definition revision before you delete it. For more information, see DeleteTaskDefinitions.
deregisterTaskDefinitionAsync in interface AmazonECSAsyncasyncHandler - 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<DescribeCapacityProvidersResult> describeCapacityProvidersAsync(DescribeCapacityProvidersRequest request)
AmazonECSAsyncDescribes one or more of your capacity providers.
describeCapacityProvidersAsync in interface AmazonECSAsyncpublic Future<DescribeCapacityProvidersResult> describeCapacityProvidersAsync(DescribeCapacityProvidersRequest request, AsyncHandler<DescribeCapacityProvidersRequest,DescribeCapacityProvidersResult> asyncHandler)
AmazonECSAsyncDescribes one or more of your capacity providers.
describeCapacityProvidersAsync in interface AmazonECSAsyncasyncHandler - 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)
AmazonECSAsyncDescribes one or more of your clusters.
describeClustersAsync in interface AmazonECSAsyncpublic Future<DescribeClustersResult> describeClustersAsync(DescribeClustersRequest request, AsyncHandler<DescribeClustersRequest,DescribeClustersResult> asyncHandler)
AmazonECSAsyncDescribes one or more of your clusters.
describeClustersAsync in interface AmazonECSAsyncasyncHandler - 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 AmazonECSAsyncdescribeClustersAsync(DescribeClustersRequest)public Future<DescribeClustersResult> describeClustersAsync(AsyncHandler<DescribeClustersRequest,DescribeClustersResult> asyncHandler)
describeClustersAsync in interface AmazonECSAsyncdescribeClustersAsync(DescribeClustersRequest, com.amazonaws.handlers.AsyncHandler)public Future<DescribeContainerInstancesResult> describeContainerInstancesAsync(DescribeContainerInstancesRequest request)
AmazonECSAsyncDescribes one or more container instances. Returns metadata about each container instance requested.
describeContainerInstancesAsync in interface AmazonECSAsyncpublic Future<DescribeContainerInstancesResult> describeContainerInstancesAsync(DescribeContainerInstancesRequest request, AsyncHandler<DescribeContainerInstancesRequest,DescribeContainerInstancesResult> asyncHandler)
AmazonECSAsyncDescribes one or more container instances. Returns metadata about each container instance requested.
describeContainerInstancesAsync in interface AmazonECSAsyncasyncHandler - 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)
AmazonECSAsyncDescribes the specified services running in your cluster.
describeServicesAsync in interface AmazonECSAsyncpublic Future<DescribeServicesResult> describeServicesAsync(DescribeServicesRequest request, AsyncHandler<DescribeServicesRequest,DescribeServicesResult> asyncHandler)
AmazonECSAsyncDescribes the specified services running in your cluster.
describeServicesAsync in interface AmazonECSAsyncasyncHandler - 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 AmazonECSAsyncpublic 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 AmazonECSAsyncasyncHandler - 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<DescribeTaskSetsResult> describeTaskSetsAsync(DescribeTaskSetsRequest request)
AmazonECSAsync
Describes the task sets in the specified cluster and service. This is used when a service uses the
EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment
Types in the Amazon Elastic Container Service Developer Guide.
describeTaskSetsAsync in interface AmazonECSAsyncpublic Future<DescribeTaskSetsResult> describeTaskSetsAsync(DescribeTaskSetsRequest request, AsyncHandler<DescribeTaskSetsRequest,DescribeTaskSetsResult> asyncHandler)
AmazonECSAsync
Describes the task sets in the specified cluster and service. This is used when a service uses the
EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment
Types in the Amazon Elastic Container Service Developer Guide.
describeTaskSetsAsync in interface AmazonECSAsyncasyncHandler - 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)
AmazonECSAsyncDescribes a specified task or tasks.
Currently, stopped tasks appear in the returned results for at least one hour.
describeTasksAsync in interface AmazonECSAsyncpublic Future<DescribeTasksResult> describeTasksAsync(DescribeTasksRequest request, AsyncHandler<DescribeTasksRequest,DescribeTasksResult> asyncHandler)
AmazonECSAsyncDescribes a specified task or tasks.
Currently, stopped tasks appear in the returned results for at least one hour.
describeTasksAsync in interface AmazonECSAsyncasyncHandler - 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)
AmazonECSAsyncThis action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Returns an endpoint for the Amazon ECS agent to poll for updates.
discoverPollEndpointAsync in interface AmazonECSAsyncpublic Future<DiscoverPollEndpointResult> discoverPollEndpointAsync(DiscoverPollEndpointRequest request, AsyncHandler<DiscoverPollEndpointRequest,DiscoverPollEndpointResult> asyncHandler)
AmazonECSAsyncThis action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Returns an endpoint for the Amazon ECS agent to poll for updates.
discoverPollEndpointAsync in interface AmazonECSAsyncasyncHandler - 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 AmazonECSAsyncdiscoverPollEndpointAsync(DiscoverPollEndpointRequest)public Future<DiscoverPollEndpointResult> discoverPollEndpointAsync(AsyncHandler<DiscoverPollEndpointRequest,DiscoverPollEndpointResult> asyncHandler)
discoverPollEndpointAsync in interface AmazonECSAsyncdiscoverPollEndpointAsync(DiscoverPollEndpointRequest, com.amazonaws.handlers.AsyncHandler)public Future<ExecuteCommandResult> executeCommandAsync(ExecuteCommandRequest request)
AmazonECSAsyncRuns a command remotely on a container within a task.
If you use a condition key in your IAM policy to refine the conditions for the policy statement, for example
limit the actions to a specific cluster, you receive an AccessDeniedException when there is a
mismatch between the condition key value and the corresponding parameter value.
For information about required permissions and considerations, see Using Amazon ECS Exec for debugging in the Amazon ECS Developer Guide.
executeCommandAsync in interface AmazonECSAsyncpublic Future<ExecuteCommandResult> executeCommandAsync(ExecuteCommandRequest request, AsyncHandler<ExecuteCommandRequest,ExecuteCommandResult> asyncHandler)
AmazonECSAsyncRuns a command remotely on a container within a task.
If you use a condition key in your IAM policy to refine the conditions for the policy statement, for example
limit the actions to a specific cluster, you receive an AccessDeniedException when there is a
mismatch between the condition key value and the corresponding parameter value.
For information about required permissions and considerations, see Using Amazon ECS Exec for debugging in the Amazon ECS Developer Guide.
executeCommandAsync in interface AmazonECSAsyncasyncHandler - 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<GetTaskProtectionResult> getTaskProtectionAsync(GetTaskProtectionRequest request)
AmazonECSAsyncRetrieves the protection status of tasks in an Amazon ECS service.
getTaskProtectionAsync in interface AmazonECSAsyncpublic Future<GetTaskProtectionResult> getTaskProtectionAsync(GetTaskProtectionRequest request, AsyncHandler<GetTaskProtectionRequest,GetTaskProtectionResult> asyncHandler)
AmazonECSAsyncRetrieves the protection status of tasks in an Amazon ECS service.
getTaskProtectionAsync in interface AmazonECSAsyncasyncHandler - 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<ListAccountSettingsResult> listAccountSettingsAsync(ListAccountSettingsRequest request)
AmazonECSAsyncLists the account settings for a specified principal.
listAccountSettingsAsync in interface AmazonECSAsyncpublic Future<ListAccountSettingsResult> listAccountSettingsAsync(ListAccountSettingsRequest request, AsyncHandler<ListAccountSettingsRequest,ListAccountSettingsResult> asyncHandler)
AmazonECSAsyncLists the account settings for a specified principal.
listAccountSettingsAsync in interface AmazonECSAsyncasyncHandler - 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<ListAttributesResult> listAttributesAsync(ListAttributesRequest request)
AmazonECSAsync
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. You can do this, for example, to see
which container instances in a cluster are running a Linux AMI (ecs.os-type=linux).
listAttributesAsync in interface AmazonECSAsyncpublic Future<ListAttributesResult> listAttributesAsync(ListAttributesRequest request, AsyncHandler<ListAttributesRequest,ListAttributesResult> asyncHandler)
AmazonECSAsync
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. You can do this, for example, to see
which container instances in a cluster are running a Linux AMI (ecs.os-type=linux).
listAttributesAsync in interface AmazonECSAsyncasyncHandler - 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(ListClustersRequest request)
AmazonECSAsyncReturns a list of existing clusters.
listClustersAsync in interface AmazonECSAsyncpublic Future<ListClustersResult> listClustersAsync(ListClustersRequest request, AsyncHandler<ListClustersRequest,ListClustersResult> asyncHandler)
AmazonECSAsyncReturns a list of existing clusters.
listClustersAsync in interface AmazonECSAsyncasyncHandler - 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 AmazonECSAsynclistClustersAsync(ListClustersRequest)public Future<ListClustersResult> listClustersAsync(AsyncHandler<ListClustersRequest,ListClustersResult> asyncHandler)
listClustersAsync in interface AmazonECSAsynclistClustersAsync(ListClustersRequest, com.amazonaws.handlers.AsyncHandler)public Future<ListContainerInstancesResult> listContainerInstancesAsync(ListContainerInstancesRequest request)
AmazonECSAsync
Returns a list of container instances in a specified cluster. You can filter the results of a
ListContainerInstances operation with cluster query language statements inside the
filter parameter. For more information, see Cluster Query
Language in the Amazon Elastic Container Service Developer Guide.
listContainerInstancesAsync in interface AmazonECSAsyncpublic Future<ListContainerInstancesResult> listContainerInstancesAsync(ListContainerInstancesRequest request, AsyncHandler<ListContainerInstancesRequest,ListContainerInstancesResult> asyncHandler)
AmazonECSAsync
Returns a list of container instances in a specified cluster. You can filter the results of a
ListContainerInstances operation with cluster query language statements inside the
filter parameter. For more information, see Cluster Query
Language in the Amazon Elastic Container Service Developer Guide.
listContainerInstancesAsync in interface AmazonECSAsyncasyncHandler - 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 AmazonECSAsynclistContainerInstancesAsync(ListContainerInstancesRequest)public Future<ListContainerInstancesResult> listContainerInstancesAsync(AsyncHandler<ListContainerInstancesRequest,ListContainerInstancesResult> asyncHandler)
listContainerInstancesAsync in interface AmazonECSAsynclistContainerInstancesAsync(ListContainerInstancesRequest, com.amazonaws.handlers.AsyncHandler)public Future<ListServicesResult> listServicesAsync(ListServicesRequest request)
AmazonECSAsyncReturns a list of services. You can filter the results by cluster, launch type, and scheduling strategy.
listServicesAsync in interface AmazonECSAsyncpublic Future<ListServicesResult> listServicesAsync(ListServicesRequest request, AsyncHandler<ListServicesRequest,ListServicesResult> asyncHandler)
AmazonECSAsyncReturns a list of services. You can filter the results by cluster, launch type, and scheduling strategy.
listServicesAsync in interface AmazonECSAsyncasyncHandler - 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 AmazonECSAsynclistServicesAsync(ListServicesRequest)public Future<ListServicesResult> listServicesAsync(AsyncHandler<ListServicesRequest,ListServicesResult> asyncHandler)
listServicesAsync in interface AmazonECSAsynclistServicesAsync(ListServicesRequest, com.amazonaws.handlers.AsyncHandler)public Future<ListServicesByNamespaceResult> listServicesByNamespaceAsync(ListServicesByNamespaceRequest request)
AmazonECSAsync
This operation lists all of the services that are associated with a Cloud Map namespace. This list might include
services in different clusters. In contrast, ListServices can only list services in one cluster at a
time. If you need to filter the list of services in a single cluster by various parameters, use
ListServices. For more information, see Service Connect in
the Amazon Elastic Container Service Developer Guide.
listServicesByNamespaceAsync in interface AmazonECSAsyncpublic Future<ListServicesByNamespaceResult> listServicesByNamespaceAsync(ListServicesByNamespaceRequest request, AsyncHandler<ListServicesByNamespaceRequest,ListServicesByNamespaceResult> asyncHandler)
AmazonECSAsync
This operation lists all of the services that are associated with a Cloud Map namespace. This list might include
services in different clusters. In contrast, ListServices can only list services in one cluster at a
time. If you need to filter the list of services in a single cluster by various parameters, use
ListServices. For more information, see Service Connect in
the Amazon Elastic Container Service Developer Guide.
listServicesByNamespaceAsync in interface AmazonECSAsyncasyncHandler - 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<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonECSAsyncList the tags for an Amazon ECS resource.
listTagsForResourceAsync in interface AmazonECSAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonECSAsyncList the tags for an Amazon ECS resource.
listTagsForResourceAsync in interface AmazonECSAsyncasyncHandler - 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(ListTaskDefinitionFamiliesRequest request)
AmazonECSAsync
Returns a list of task definition families that are registered to your account. This list includes task
definition families that no longer have any ACTIVE task definition revisions.
You can filter out task definition families that don't 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 AmazonECSAsyncpublic Future<ListTaskDefinitionFamiliesResult> listTaskDefinitionFamiliesAsync(ListTaskDefinitionFamiliesRequest request, AsyncHandler<ListTaskDefinitionFamiliesRequest,ListTaskDefinitionFamiliesResult> asyncHandler)
AmazonECSAsync
Returns a list of task definition families that are registered to your account. This list includes task
definition families that no longer have any ACTIVE task definition revisions.
You can filter out task definition families that don't 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 AmazonECSAsyncasyncHandler - 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 AmazonECSAsynclistTaskDefinitionFamiliesAsync(ListTaskDefinitionFamiliesRequest)public Future<ListTaskDefinitionFamiliesResult> listTaskDefinitionFamiliesAsync(AsyncHandler<ListTaskDefinitionFamiliesRequest,ListTaskDefinitionFamiliesResult> asyncHandler)
listTaskDefinitionFamiliesAsync in interface AmazonECSAsynclistTaskDefinitionFamiliesAsync(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 AmazonECSAsyncpublic 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 AmazonECSAsyncasyncHandler - 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 AmazonECSAsynclistTaskDefinitionsAsync(ListTaskDefinitionsRequest)public Future<ListTaskDefinitionsResult> listTaskDefinitionsAsync(AsyncHandler<ListTaskDefinitionsRequest,ListTaskDefinitionsResult> asyncHandler)
listTaskDefinitionsAsync in interface AmazonECSAsynclistTaskDefinitionsAsync(ListTaskDefinitionsRequest, com.amazonaws.handlers.AsyncHandler)public Future<ListTasksResult> listTasksAsync(ListTasksRequest request)
AmazonECSAsyncReturns a list of tasks. You can filter the results by cluster, task definition family, container instance, launch type, what IAM principal started the task, or by the desired status of the task.
Recently stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour.
listTasksAsync in interface AmazonECSAsyncpublic Future<ListTasksResult> listTasksAsync(ListTasksRequest request, AsyncHandler<ListTasksRequest,ListTasksResult> asyncHandler)
AmazonECSAsyncReturns a list of tasks. You can filter the results by cluster, task definition family, container instance, launch type, what IAM principal started the task, or by the desired status of the task.
Recently stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour.
listTasksAsync in interface AmazonECSAsyncasyncHandler - 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 AmazonECSAsynclistTasksAsync(ListTasksRequest)public Future<ListTasksResult> listTasksAsync(AsyncHandler<ListTasksRequest,ListTasksResult> asyncHandler)
listTasksAsync in interface AmazonECSAsynclistTasksAsync(ListTasksRequest, com.amazonaws.handlers.AsyncHandler)public Future<PutAccountSettingResult> putAccountSettingAsync(PutAccountSettingRequest request)
AmazonECSAsyncModifies an account setting. Account settings are set on a per-Region basis.
If you change the account setting for the root user, the default settings for all of the users and roles that no individual account setting was specified are reset for. For more information, see Account Settings in the Amazon Elastic Container Service Developer Guide.
When serviceLongArnFormat, taskLongArnFormat, or
containerInstanceLongArnFormat are specified, the Amazon Resource Name (ARN) and resource ID format
of the resource type for a specified user, role, or the root user for an account is affected. The opt-in and
opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a
resource is defined by the opt-in status of the user or role that created the resource. You must turn on this
setting to use Amazon ECS features such as resource tagging.
When awsvpcTrunking is specified, the elastic network interface (ENI) limit for any new container
instances that support the feature is changed. If awsvpcTrunking is enabled, any new container
instances that support the feature are launched have the increased ENI limits available to them. For more
information, see Elastic Network
Interface Trunking in the Amazon Elastic Container Service Developer Guide.
When containerInsights is specified, the default setting indicating whether CloudWatch Container
Insights is enabled for your clusters is changed. If containerInsights is enabled, any new clusters
that are created will have Container Insights enabled unless you disable it during cluster creation. For more
information, see CloudWatch
Container Insights in the Amazon Elastic Container Service Developer Guide.
putAccountSettingAsync in interface AmazonECSAsyncpublic Future<PutAccountSettingResult> putAccountSettingAsync(PutAccountSettingRequest request, AsyncHandler<PutAccountSettingRequest,PutAccountSettingResult> asyncHandler)
AmazonECSAsyncModifies an account setting. Account settings are set on a per-Region basis.
If you change the account setting for the root user, the default settings for all of the users and roles that no individual account setting was specified are reset for. For more information, see Account Settings in the Amazon Elastic Container Service Developer Guide.
When serviceLongArnFormat, taskLongArnFormat, or
containerInstanceLongArnFormat are specified, the Amazon Resource Name (ARN) and resource ID format
of the resource type for a specified user, role, or the root user for an account is affected. The opt-in and
opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a
resource is defined by the opt-in status of the user or role that created the resource. You must turn on this
setting to use Amazon ECS features such as resource tagging.
When awsvpcTrunking is specified, the elastic network interface (ENI) limit for any new container
instances that support the feature is changed. If awsvpcTrunking is enabled, any new container
instances that support the feature are launched have the increased ENI limits available to them. For more
information, see Elastic Network
Interface Trunking in the Amazon Elastic Container Service Developer Guide.
When containerInsights is specified, the default setting indicating whether CloudWatch Container
Insights is enabled for your clusters is changed. If containerInsights is enabled, any new clusters
that are created will have Container Insights enabled unless you disable it during cluster creation. For more
information, see CloudWatch
Container Insights in the Amazon Elastic Container Service Developer Guide.
putAccountSettingAsync in interface AmazonECSAsyncasyncHandler - 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<PutAccountSettingDefaultResult> putAccountSettingDefaultAsync(PutAccountSettingDefaultRequest request)
AmazonECSAsyncModifies an account setting for all users on an account for whom no individual account setting has been specified. Account settings are set on a per-Region basis.
putAccountSettingDefaultAsync in interface AmazonECSAsyncpublic Future<PutAccountSettingDefaultResult> putAccountSettingDefaultAsync(PutAccountSettingDefaultRequest request, AsyncHandler<PutAccountSettingDefaultRequest,PutAccountSettingDefaultResult> asyncHandler)
AmazonECSAsyncModifies an account setting for all users on an account for whom no individual account setting has been specified. Account settings are set on a per-Region basis.
putAccountSettingDefaultAsync in interface AmazonECSAsyncasyncHandler - 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<PutAttributesResult> putAttributesAsync(PutAttributesRequest request)
AmazonECSAsyncCreate or update an attribute on an Amazon ECS resource. If the attribute doesn't exist, it's created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
putAttributesAsync in interface AmazonECSAsyncpublic Future<PutAttributesResult> putAttributesAsync(PutAttributesRequest request, AsyncHandler<PutAttributesRequest,PutAttributesResult> asyncHandler)
AmazonECSAsyncCreate or update an attribute on an Amazon ECS resource. If the attribute doesn't exist, it's created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
putAttributesAsync in interface AmazonECSAsyncasyncHandler - 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<PutClusterCapacityProvidersResult> putClusterCapacityProvidersAsync(PutClusterCapacityProvidersRequest request)
AmazonECSAsyncModifies the available capacity providers and the default capacity provider strategy for a cluster.
You must specify both the available capacity providers and a default capacity provider strategy for the cluster. If the specified cluster has existing capacity providers associated with it, you must specify all existing capacity providers in addition to any new ones you want to add. Any existing capacity providers that are associated with a cluster that are omitted from a PutClusterCapacityProviders API call will be disassociated with the cluster. You can only disassociate an existing capacity provider from a cluster if it's not being used by any existing tasks.
When creating a service or running a task on a cluster, if no capacity provider or launch type is specified, then
the cluster's default capacity provider strategy is used. We recommend that you define a default capacity
provider strategy for your cluster. However, you must specify an empty array ([]) to bypass defining
a default strategy.
putClusterCapacityProvidersAsync in interface AmazonECSAsyncpublic Future<PutClusterCapacityProvidersResult> putClusterCapacityProvidersAsync(PutClusterCapacityProvidersRequest request, AsyncHandler<PutClusterCapacityProvidersRequest,PutClusterCapacityProvidersResult> asyncHandler)
AmazonECSAsyncModifies the available capacity providers and the default capacity provider strategy for a cluster.
You must specify both the available capacity providers and a default capacity provider strategy for the cluster. If the specified cluster has existing capacity providers associated with it, you must specify all existing capacity providers in addition to any new ones you want to add. Any existing capacity providers that are associated with a cluster that are omitted from a PutClusterCapacityProviders API call will be disassociated with the cluster. You can only disassociate an existing capacity provider from a cluster if it's not being used by any existing tasks.
When creating a service or running a task on a cluster, if no capacity provider or launch type is specified, then
the cluster's default capacity provider strategy is used. We recommend that you define a default capacity
provider strategy for your cluster. However, you must specify an empty array ([]) to bypass defining
a default strategy.
putClusterCapacityProvidersAsync in interface AmazonECSAsyncasyncHandler - 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<RegisterContainerInstanceResult> registerContainerInstanceAsync(RegisterContainerInstanceRequest request)
AmazonECSAsyncThis action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.
registerContainerInstanceAsync in interface AmazonECSAsyncpublic Future<RegisterContainerInstanceResult> registerContainerInstanceAsync(RegisterContainerInstanceRequest request, AsyncHandler<RegisterContainerInstanceRequest,RegisterContainerInstanceResult> asyncHandler)
AmazonECSAsyncThis action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.
registerContainerInstanceAsync in interface AmazonECSAsyncasyncHandler - 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 Elastic Container Service Developer Guide.
You can specify a role for your task with the taskRoleArn parameter. When you specify a role for a
task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the Amazon Web
Services services that are specified in the policy that's associated with the role. For more information, see IAM Roles for Tasks in
the Amazon Elastic Container Service Developer Guide.
You can specify a Docker networking mode for the containers in your task definition with the
networkMode parameter. The available network modes correspond to those described in Network settings in the Docker run
reference. If you specify the awsvpc network mode, the task is allocated an elastic network
interface, and you must specify a NetworkConfiguration when you create a service or run a task with the
task definition. For more information, see Task Networking in
the Amazon Elastic Container Service Developer Guide.
registerTaskDefinitionAsync in interface AmazonECSAsyncpublic 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 Elastic Container Service Developer Guide.
You can specify a role for your task with the taskRoleArn parameter. When you specify a role for a
task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the Amazon Web
Services services that are specified in the policy that's associated with the role. For more information, see IAM Roles for Tasks in
the Amazon Elastic Container Service Developer Guide.
You can specify a Docker networking mode for the containers in your task definition with the
networkMode parameter. The available network modes correspond to those described in Network settings in the Docker run
reference. If you specify the awsvpc network mode, the task is allocated an elastic network
interface, and you must specify a NetworkConfiguration when you create a service or run a task with the
task definition. For more information, see Task Networking in
the Amazon Elastic Container Service Developer Guide.
registerTaskDefinitionAsync in interface AmazonECSAsyncasyncHandler - 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)
AmazonECSAsyncStarts a new task using the specified task definition.
You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.
Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.
The Amazon ECS API follows an eventual consistency model. This is because of the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.
To manage eventual consistency, you can do the following:
Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.
Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.
runTaskAsync in interface AmazonECSAsyncpublic Future<RunTaskResult> runTaskAsync(RunTaskRequest request, AsyncHandler<RunTaskRequest,RunTaskResult> asyncHandler)
AmazonECSAsyncStarts a new task using the specified task definition.
You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.
Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.
The Amazon ECS API follows an eventual consistency model. This is because of the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.
To manage eventual consistency, you can do the following:
Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.
Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.
runTaskAsync in interface AmazonECSAsyncasyncHandler - 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)
AmazonECSAsyncStarts a new task from the specified task definition on the specified container instance or instances.
Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.
startTaskAsync in interface AmazonECSAsyncpublic Future<StartTaskResult> startTaskAsync(StartTaskRequest request, AsyncHandler<StartTaskRequest,StartTaskResult> asyncHandler)
AmazonECSAsyncStarts a new task from the specified task definition on the specified container instance or instances.
Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.
startTaskAsync in interface AmazonECSAsyncasyncHandler - 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)
AmazonECSAsyncStops a running task. Any tags associated with the task will be deleted.
When StopTask is called on a task, the equivalent of docker stop is issued to the containers
running in the task. This results in a SIGTERM value and a default 30-second timeout, after which
the SIGKILL value is sent and the containers are forcibly stopped. If the container handles the
SIGTERM value gracefully and exits within 30 seconds from receiving it, no SIGKILL
value is sent.
The default 30-second timeout can be configured on the Amazon ECS container agent with the
ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see Amazon ECS Container
Agent Configuration in the Amazon Elastic Container Service Developer Guide.
stopTaskAsync in interface AmazonECSAsyncpublic Future<StopTaskResult> stopTaskAsync(StopTaskRequest request, AsyncHandler<StopTaskRequest,StopTaskResult> asyncHandler)
AmazonECSAsyncStops a running task. Any tags associated with the task will be deleted.
When StopTask is called on a task, the equivalent of docker stop is issued to the containers
running in the task. This results in a SIGTERM value and a default 30-second timeout, after which
the SIGKILL value is sent and the containers are forcibly stopped. If the container handles the
SIGTERM value gracefully and exits within 30 seconds from receiving it, no SIGKILL
value is sent.
The default 30-second timeout can be configured on the Amazon ECS container agent with the
ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see Amazon ECS Container
Agent Configuration in the Amazon Elastic Container Service Developer Guide.
stopTaskAsync in interface AmazonECSAsyncasyncHandler - 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<SubmitAttachmentStateChangesResult> submitAttachmentStateChangesAsync(SubmitAttachmentStateChangesRequest request)
AmazonECSAsyncThis action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Sent to acknowledge that an attachment changed states.
submitAttachmentStateChangesAsync in interface AmazonECSAsyncpublic Future<SubmitAttachmentStateChangesResult> submitAttachmentStateChangesAsync(SubmitAttachmentStateChangesRequest request, AsyncHandler<SubmitAttachmentStateChangesRequest,SubmitAttachmentStateChangesResult> asyncHandler)
AmazonECSAsyncThis action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Sent to acknowledge that an attachment changed states.
submitAttachmentStateChangesAsync in interface AmazonECSAsyncasyncHandler - 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)
AmazonECSAsyncThis action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a container changed states.
submitContainerStateChangeAsync in interface AmazonECSAsyncpublic Future<SubmitContainerStateChangeResult> submitContainerStateChangeAsync(SubmitContainerStateChangeRequest request, AsyncHandler<SubmitContainerStateChangeRequest,SubmitContainerStateChangeResult> asyncHandler)
AmazonECSAsyncThis action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a container changed states.
submitContainerStateChangeAsync in interface AmazonECSAsyncasyncHandler - 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 AmazonECSAsyncsubmitContainerStateChangeAsync(SubmitContainerStateChangeRequest)public Future<SubmitContainerStateChangeResult> submitContainerStateChangeAsync(AsyncHandler<SubmitContainerStateChangeRequest,SubmitContainerStateChangeResult> asyncHandler)
submitContainerStateChangeAsync in interface AmazonECSAsyncsubmitContainerStateChangeAsync(SubmitContainerStateChangeRequest, com.amazonaws.handlers.AsyncHandler)public Future<SubmitTaskStateChangeResult> submitTaskStateChangeAsync(SubmitTaskStateChangeRequest request)
AmazonECSAsyncThis action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a task changed states.
submitTaskStateChangeAsync in interface AmazonECSAsyncpublic Future<SubmitTaskStateChangeResult> submitTaskStateChangeAsync(SubmitTaskStateChangeRequest request, AsyncHandler<SubmitTaskStateChangeRequest,SubmitTaskStateChangeResult> asyncHandler)
AmazonECSAsyncThis action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a task changed states.
submitTaskStateChangeAsync in interface AmazonECSAsyncasyncHandler - 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<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonECSAsync
Associates the specified tags to a resource with the specified resourceArn. If existing tags on a
resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags
that are associated with that resource are deleted as well.
tagResourceAsync in interface AmazonECSAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonECSAsync
Associates the specified tags to a resource with the specified resourceArn. If existing tags on a
resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags
that are associated with that resource are deleted as well.
tagResourceAsync in interface AmazonECSAsyncasyncHandler - 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<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonECSAsyncDeletes specified tags from a resource.
untagResourceAsync in interface AmazonECSAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonECSAsyncDeletes specified tags from a resource.
untagResourceAsync in interface AmazonECSAsyncasyncHandler - 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<UpdateCapacityProviderResult> updateCapacityProviderAsync(UpdateCapacityProviderRequest request)
AmazonECSAsyncModifies the parameters for a capacity provider.
updateCapacityProviderAsync in interface AmazonECSAsyncpublic Future<UpdateCapacityProviderResult> updateCapacityProviderAsync(UpdateCapacityProviderRequest request, AsyncHandler<UpdateCapacityProviderRequest,UpdateCapacityProviderResult> asyncHandler)
AmazonECSAsyncModifies the parameters for a capacity provider.
updateCapacityProviderAsync in interface AmazonECSAsyncasyncHandler - 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<UpdateClusterResult> updateClusterAsync(UpdateClusterRequest request)
AmazonECSAsyncUpdates the cluster.
updateClusterAsync in interface AmazonECSAsyncpublic Future<UpdateClusterResult> updateClusterAsync(UpdateClusterRequest request, AsyncHandler<UpdateClusterRequest,UpdateClusterResult> asyncHandler)
AmazonECSAsyncUpdates the cluster.
updateClusterAsync in interface AmazonECSAsyncasyncHandler - 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<UpdateClusterSettingsResult> updateClusterSettingsAsync(UpdateClusterSettingsRequest request)
AmazonECSAsyncModifies the settings to use for a cluster.
updateClusterSettingsAsync in interface AmazonECSAsyncpublic Future<UpdateClusterSettingsResult> updateClusterSettingsAsync(UpdateClusterSettingsRequest request, AsyncHandler<UpdateClusterSettingsRequest,UpdateClusterSettingsResult> asyncHandler)
AmazonECSAsyncModifies the settings to use for a cluster.
updateClusterSettingsAsync in interface AmazonECSAsyncasyncHandler - 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)
AmazonECSAsyncUpdates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent doesn't 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.
The UpdateContainerAgent API isn't supported for container instances using the Amazon ECS-optimized
Amazon Linux 2 (arm64) AMI. To update the container agent, you can update the ecs-init package. This
updates the agent. For more information, see Updating the Amazon
ECS container agent in the Amazon Elastic Container Service Developer Guide.
Agent updates with the UpdateContainerAgent API operation do not apply to Windows container
instances. We recommend that you launch new container instances to update the agent version in your Windows
clusters.
The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or Amazon Linux AMI with the
ecs-init service installed and running. For help updating the Amazon ECS container agent on other
operating systems, see Manually updating the Amazon ECS container agent in the Amazon Elastic Container Service Developer
Guide.
updateContainerAgentAsync in interface AmazonECSAsyncpublic Future<UpdateContainerAgentResult> updateContainerAgentAsync(UpdateContainerAgentRequest request, AsyncHandler<UpdateContainerAgentRequest,UpdateContainerAgentResult> asyncHandler)
AmazonECSAsyncUpdates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent doesn't 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.
The UpdateContainerAgent API isn't supported for container instances using the Amazon ECS-optimized
Amazon Linux 2 (arm64) AMI. To update the container agent, you can update the ecs-init package. This
updates the agent. For more information, see Updating the Amazon
ECS container agent in the Amazon Elastic Container Service Developer Guide.
Agent updates with the UpdateContainerAgent API operation do not apply to Windows container
instances. We recommend that you launch new container instances to update the agent version in your Windows
clusters.
The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or Amazon Linux AMI with the
ecs-init service installed and running. For help updating the Amazon ECS container agent on other
operating systems, see Manually updating the Amazon ECS container agent in the Amazon Elastic Container Service Developer
Guide.
updateContainerAgentAsync in interface AmazonECSAsyncasyncHandler - 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<UpdateContainerInstancesStateResult> updateContainerInstancesStateAsync(UpdateContainerInstancesStateRequest request)
AmazonECSAsyncModifies the status of an Amazon ECS container instance.
Once a container instance has reached an ACTIVE state, you can change the status of a container
instance to DRAINING to manually remove an instance from a cluster, for example to perform system
updates, update the Docker daemon, or scale down the cluster size.
A container instance can't be changed to DRAINING until it has reached an ACTIVE
status. If the instance is in any other status, an error will be received.
When you set a container instance to DRAINING, Amazon ECS prevents new tasks from being scheduled
for placement on the container instance and replacement service tasks are started on other container instances in
the cluster if the resources are available. Service tasks on the container instance that are in the
PENDING state are stopped immediately.
Service tasks on the container instance that are in the RUNNING state are stopped and replaced
according to the service's deployment configuration parameters, minimumHealthyPercent and
maximumPercent. You can change the deployment configuration of your service using
UpdateService.
If minimumHealthyPercent is below 100%, the scheduler can 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're in the RUNNING state.
Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state
and are reported as healthy by the load balancer.
The maximumPercent parameter represents an upper limit on the number of running tasks during task
replacement. You can use this to define the replacement batch size. For example, if desiredCount is
four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained, provided that
the cluster resources required to do this are available. If the maximum is 100%, then replacement tasks can't
start until the draining tasks have stopped.
Any PENDING or RUNNING tasks that do not belong to a service aren't affected. You must
wait for them to finish or stop them manually.
A container instance has completed draining when it has no more RUNNING tasks. You can verify this
using ListTasks.
When a container instance has been drained, you can set a container instance to ACTIVE status and
once it has reached that status the Amazon ECS scheduler can begin scheduling tasks on the instance again.
updateContainerInstancesStateAsync in interface AmazonECSAsyncpublic Future<UpdateContainerInstancesStateResult> updateContainerInstancesStateAsync(UpdateContainerInstancesStateRequest request, AsyncHandler<UpdateContainerInstancesStateRequest,UpdateContainerInstancesStateResult> asyncHandler)
AmazonECSAsyncModifies the status of an Amazon ECS container instance.
Once a container instance has reached an ACTIVE state, you can change the status of a container
instance to DRAINING to manually remove an instance from a cluster, for example to perform system
updates, update the Docker daemon, or scale down the cluster size.
A container instance can't be changed to DRAINING until it has reached an ACTIVE
status. If the instance is in any other status, an error will be received.
When you set a container instance to DRAINING, Amazon ECS prevents new tasks from being scheduled
for placement on the container instance and replacement service tasks are started on other container instances in
the cluster if the resources are available. Service tasks on the container instance that are in the
PENDING state are stopped immediately.
Service tasks on the container instance that are in the RUNNING state are stopped and replaced
according to the service's deployment configuration parameters, minimumHealthyPercent and
maximumPercent. You can change the deployment configuration of your service using
UpdateService.
If minimumHealthyPercent is below 100%, the scheduler can 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're in the RUNNING state.
Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state
and are reported as healthy by the load balancer.
The maximumPercent parameter represents an upper limit on the number of running tasks during task
replacement. You can use this to define the replacement batch size. For example, if desiredCount is
four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained, provided that
the cluster resources required to do this are available. If the maximum is 100%, then replacement tasks can't
start until the draining tasks have stopped.
Any PENDING or RUNNING tasks that do not belong to a service aren't affected. You must
wait for them to finish or stop them manually.
A container instance has completed draining when it has no more RUNNING tasks. You can verify this
using ListTasks.
When a container instance has been drained, you can set a container instance to ACTIVE status and
once it has reached that status the Amazon ECS scheduler can begin scheduling tasks on the instance again.
updateContainerInstancesStateAsync in interface AmazonECSAsyncasyncHandler - 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)
AmazonECSAsyncModifies the parameters of a service.
For services using the rolling update (ECS) you can update the desired count, deployment
configuration, network configuration, load balancers, service registries, enable ECS managed tags option,
propagate tags option, task placement constraints and strategies, and task definition. When you update any of
these parameters, Amazon ECS starts new tasks with the new configuration.
For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired count,
deployment configuration, health check grace period, task placement constraints and strategies, enable ECS
managed tags option, and propagate tags can be updated using this API. If the network configuration, platform
version, task definition, or load balancer need to be updated, create a new CodeDeploy deployment. For more
information, see CreateDeployment
in the CodeDeploy API Reference.
For services using an external deployment controller, you can update only the desired count, task placement constraints and strategies, health check grace period, enable ECS managed tags option, and propagate tags option, using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be updated, create a new task set For more information, see CreateTaskSet.
You can add to or subtract from the number of instantiations of a task definition in a service by specifying the
cluster that the service is running in and a new desiredCount parameter.
If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy.
If your updated Docker image uses the same tag as what is in the existing task definition for your service (for
example, my_image:latest), you don't need to create a new revision of your task definition. You can
update the service using the forceNewDeployment option. The new tasks launched by the deployment
pull the current image/tag combination from your repository when they start.
You can also update the deployment configuration of a service. When a deployment is triggered by updating the
task definition of a service, the service scheduler uses the deployment configuration parameters,
minimumHealthyPercent and maximumPercent, to determine the deployment strategy.
If minimumHealthyPercent is below 100%, the scheduler can 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 don't use a load
balancer are considered healthy if they're in the RUNNING state. Tasks for services that use a load
balancer are considered healthy if they're in the RUNNING state and are reported as healthy by the
load balancer.
The maximumPercent parameter represents an upper limit on the number of running tasks during a
deployment. You can use it 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
this, 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 even though 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.
You must have a service-linked role when you update any of the following service properties. If you specified a custom role when you created the service, Amazon ECS automatically replaces the roleARN associated with the service with the ARN of your service-linked role. For more information, see Service-linked roles in the Amazon Elastic Container Service Developer Guide.
loadBalancers,
serviceRegistries
updateServiceAsync in interface AmazonECSAsyncpublic Future<UpdateServiceResult> updateServiceAsync(UpdateServiceRequest request, AsyncHandler<UpdateServiceRequest,UpdateServiceResult> asyncHandler)
AmazonECSAsyncModifies the parameters of a service.
For services using the rolling update (ECS) you can update the desired count, deployment
configuration, network configuration, load balancers, service registries, enable ECS managed tags option,
propagate tags option, task placement constraints and strategies, and task definition. When you update any of
these parameters, Amazon ECS starts new tasks with the new configuration.
For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired count,
deployment configuration, health check grace period, task placement constraints and strategies, enable ECS
managed tags option, and propagate tags can be updated using this API. If the network configuration, platform
version, task definition, or load balancer need to be updated, create a new CodeDeploy deployment. For more
information, see CreateDeployment
in the CodeDeploy API Reference.
For services using an external deployment controller, you can update only the desired count, task placement constraints and strategies, health check grace period, enable ECS managed tags option, and propagate tags option, using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be updated, create a new task set For more information, see CreateTaskSet.
You can add to or subtract from the number of instantiations of a task definition in a service by specifying the
cluster that the service is running in and a new desiredCount parameter.
If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy.
If your updated Docker image uses the same tag as what is in the existing task definition for your service (for
example, my_image:latest), you don't need to create a new revision of your task definition. You can
update the service using the forceNewDeployment option. The new tasks launched by the deployment
pull the current image/tag combination from your repository when they start.
You can also update the deployment configuration of a service. When a deployment is triggered by updating the
task definition of a service, the service scheduler uses the deployment configuration parameters,
minimumHealthyPercent and maximumPercent, to determine the deployment strategy.
If minimumHealthyPercent is below 100%, the scheduler can 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 don't use a load
balancer are considered healthy if they're in the RUNNING state. Tasks for services that use a load
balancer are considered healthy if they're in the RUNNING state and are reported as healthy by the
load balancer.
The maximumPercent parameter represents an upper limit on the number of running tasks during a
deployment. You can use it 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
this, 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 even though 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.
You must have a service-linked role when you update any of the following service properties. If you specified a custom role when you created the service, Amazon ECS automatically replaces the roleARN associated with the service with the ARN of your service-linked role. For more information, see Service-linked roles in the Amazon Elastic Container Service Developer Guide.
loadBalancers,
serviceRegistries
updateServiceAsync in interface AmazonECSAsyncasyncHandler - 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<UpdateServicePrimaryTaskSetResult> updateServicePrimaryTaskSetAsync(UpdateServicePrimaryTaskSetRequest request)
AmazonECSAsync
Modifies which task set in a service is the primary task set. Any parameters that are updated on the primary task
set in a service will transition to the service. This is used when a service uses the EXTERNAL
deployment controller type. For more information, see Amazon ECS Deployment
Types in the Amazon Elastic Container Service Developer Guide.
updateServicePrimaryTaskSetAsync in interface AmazonECSAsyncpublic Future<UpdateServicePrimaryTaskSetResult> updateServicePrimaryTaskSetAsync(UpdateServicePrimaryTaskSetRequest request, AsyncHandler<UpdateServicePrimaryTaskSetRequest,UpdateServicePrimaryTaskSetResult> asyncHandler)
AmazonECSAsync
Modifies which task set in a service is the primary task set. Any parameters that are updated on the primary task
set in a service will transition to the service. This is used when a service uses the EXTERNAL
deployment controller type. For more information, see Amazon ECS Deployment
Types in the Amazon Elastic Container Service Developer Guide.
updateServicePrimaryTaskSetAsync in interface AmazonECSAsyncasyncHandler - 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<UpdateTaskProtectionResult> updateTaskProtectionAsync(UpdateTaskProtectionRequest request)
AmazonECSAsync
Updates the protection status of a task. You can set protectionEnabled to true to
protect your task from termination during scale-in events from Service
Autoscaling or deployments.
Task-protection, by default, expires after 2 hours at which point Amazon ECS unsets the
protectionEnabled property making the task eligible for termination by a subsequent scale-in event.
You can specify a custom expiration period for task protection from 1 minute to up to 2,880 minutes (48 hours).
To specify the custom expiration period, set the expiresInMinutes property. The
expiresInMinutes property is always reset when you invoke this operation for a task that already has
protectionEnabled set to true. You can keep extending the protection expiration period
of a task by invoking this operation repeatedly.
To learn more about Amazon ECS task protection, see Task scale-in protection in the Amazon Elastic Container Service Developer Guide .
This operation is only supported for tasks belonging to an Amazon ECS service. Invoking this operation for a
standalone task will result in an TASK_NOT_VALID failure. For more information, see API failure
reasons.
If you prefer to set task protection from within the container, we recommend using the Task scale-in protection endpoint.
updateTaskProtectionAsync in interface AmazonECSAsyncpublic Future<UpdateTaskProtectionResult> updateTaskProtectionAsync(UpdateTaskProtectionRequest request, AsyncHandler<UpdateTaskProtectionRequest,UpdateTaskProtectionResult> asyncHandler)
AmazonECSAsync
Updates the protection status of a task. You can set protectionEnabled to true to
protect your task from termination during scale-in events from Service
Autoscaling or deployments.
Task-protection, by default, expires after 2 hours at which point Amazon ECS unsets the
protectionEnabled property making the task eligible for termination by a subsequent scale-in event.
You can specify a custom expiration period for task protection from 1 minute to up to 2,880 minutes (48 hours).
To specify the custom expiration period, set the expiresInMinutes property. The
expiresInMinutes property is always reset when you invoke this operation for a task that already has
protectionEnabled set to true. You can keep extending the protection expiration period
of a task by invoking this operation repeatedly.
To learn more about Amazon ECS task protection, see Task scale-in protection in the Amazon Elastic Container Service Developer Guide .
This operation is only supported for tasks belonging to an Amazon ECS service. Invoking this operation for a
standalone task will result in an TASK_NOT_VALID failure. For more information, see API failure
reasons.
If you prefer to set task protection from within the container, we recommend using the Task scale-in protection endpoint.
updateTaskProtectionAsync in interface AmazonECSAsyncasyncHandler - 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<UpdateTaskSetResult> updateTaskSetAsync(UpdateTaskSetRequest request)
AmazonECSAsync
Modifies a task set. This is used when a service uses the EXTERNAL deployment controller type. For
more information, see Amazon ECS Deployment
Types in the Amazon Elastic Container Service Developer Guide.
updateTaskSetAsync in interface AmazonECSAsyncpublic Future<UpdateTaskSetResult> updateTaskSetAsync(UpdateTaskSetRequest request, AsyncHandler<UpdateTaskSetRequest,UpdateTaskSetResult> asyncHandler)
AmazonECSAsync
Modifies a task set. This is used when a service uses the EXTERNAL deployment controller type. For
more information, see Amazon ECS Deployment
Types in the Amazon Elastic Container Service Developer Guide.
updateTaskSetAsync in interface AmazonECSAsyncasyncHandler - 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 void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AmazonECSshutdown in class AmazonECSClient