@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonECSClient extends AmazonWebServiceClient implements AmazonECS
Amazon EC2 Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster of EC2 instances. Amazon ECS lets you launch and stop container-enabled applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features like security groups, Amazon EBS volumes, and IAM roles.
You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon EC2 Container Service eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AmazonECSClient()
Deprecated.
|
AmazonECSClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonECSClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AmazonECSClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AmazonECSClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonECSClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonECSClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AmazonECSClient(ClientConfiguration clientConfiguration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static AmazonECSClientBuilder |
builder() |
CreateClusterResult |
createCluster()
Simplified method form for invoking the CreateCluster operation.
|
CreateClusterResult |
createCluster(CreateClusterRequest request)
Creates a new Amazon ECS cluster.
|
CreateServiceResult |
createService(CreateServiceRequest request)
Runs and maintains a desired number of tasks from a specified task definition.
|
DeleteAttributesResult |
deleteAttributes(DeleteAttributesRequest request)
Deletes one or more custom attributes from an Amazon ECS resource.
|
DeleteClusterResult |
deleteCluster(DeleteClusterRequest request)
Deletes the specified cluster.
|
DeleteServiceResult |
deleteService(DeleteServiceRequest request)
Deletes a specified service within a cluster.
|
DeregisterContainerInstanceResult |
deregisterContainerInstance(DeregisterContainerInstanceRequest request)
Deregisters an Amazon ECS container instance from the specified cluster.
|
DeregisterTaskDefinitionResult |
deregisterTaskDefinition(DeregisterTaskDefinitionRequest request)
Deregisters the specified task definition by family and revision.
|
DescribeClustersResult |
describeClusters()
Simplified method form for invoking the DescribeClusters operation.
|
DescribeClustersResult |
describeClusters(DescribeClustersRequest request)
Describes one or more of your clusters.
|
DescribeContainerInstancesResult |
describeContainerInstances(DescribeContainerInstancesRequest request)
Describes Amazon EC2 Container Service container instances.
|
DescribeServicesResult |
describeServices(DescribeServicesRequest request)
Describes the specified services running in your cluster.
|
DescribeTaskDefinitionResult |
describeTaskDefinition(DescribeTaskDefinitionRequest request)
Describes a task definition.
|
DescribeTasksResult |
describeTasks(DescribeTasksRequest request)
Describes a specified task or tasks.
|
DiscoverPollEndpointResult |
discoverPollEndpoint()
Simplified method form for invoking the DiscoverPollEndpoint operation.
|
DiscoverPollEndpointResult |
discoverPollEndpoint(DiscoverPollEndpointRequest request)
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
ListAttributesResult |
listAttributes(ListAttributesRequest request)
Lists the attributes for Amazon ECS resources within a specified target type and cluster.
|
ListClustersResult |
listClusters()
Simplified method form for invoking the ListClusters operation.
|
ListClustersResult |
listClusters(ListClustersRequest request)
Returns a list of existing clusters.
|
ListContainerInstancesResult |
listContainerInstances()
Simplified method form for invoking the ListContainerInstances operation.
|
ListContainerInstancesResult |
listContainerInstances(ListContainerInstancesRequest request)
Returns a list of container instances in a specified cluster.
|
ListServicesResult |
listServices()
Simplified method form for invoking the ListServices operation.
|
ListServicesResult |
listServices(ListServicesRequest request)
Lists the services that are running in a specified cluster.
|
ListTaskDefinitionFamiliesResult |
listTaskDefinitionFamilies()
Simplified method form for invoking the ListTaskDefinitionFamilies operation.
|
ListTaskDefinitionFamiliesResult |
listTaskDefinitionFamilies(ListTaskDefinitionFamiliesRequest request)
Returns a list of task definition families that are registered to your account (which may include task definition
families that no longer have any
ACTIVE task definition revisions). |
ListTaskDefinitionsResult |
listTaskDefinitions()
Simplified method form for invoking the ListTaskDefinitions operation.
|
ListTaskDefinitionsResult |
listTaskDefinitions(ListTaskDefinitionsRequest request)
Returns a list of task definitions that are registered to your account.
|
ListTasksResult |
listTasks()
Simplified method form for invoking the ListTasks operation.
|
ListTasksResult |
listTasks(ListTasksRequest request)
Returns a list of tasks for a specified cluster.
|
PutAttributesResult |
putAttributes(PutAttributesRequest request)
Create or update an attribute on an Amazon ECS resource.
|
RegisterContainerInstanceResult |
registerContainerInstance(RegisterContainerInstanceRequest request)
|
RegisterTaskDefinitionResult |
registerTaskDefinition(RegisterTaskDefinitionRequest request)
Registers a new task definition from the supplied
family and containerDefinitions. |
RunTaskResult |
runTask(RunTaskRequest request)
Starts a new task using the specified task definition.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
StartTaskResult |
startTask(StartTaskRequest request)
Starts a new task from the specified task definition on the specified container instance or instances.
|
StopTaskResult |
stopTask(StopTaskRequest request)
Stops a running task.
|
SubmitContainerStateChangeResult |
submitContainerStateChange()
Simplified method form for invoking the SubmitContainerStateChange operation.
|
SubmitContainerStateChangeResult |
submitContainerStateChange(SubmitContainerStateChangeRequest request)
|
SubmitTaskStateChangeResult |
submitTaskStateChange(SubmitTaskStateChangeRequest request)
|
UpdateContainerAgentResult |
updateContainerAgent(UpdateContainerAgentRequest request)
Updates the Amazon ECS container agent on a specified container instance.
|
UpdateContainerInstancesStateResult |
updateContainerInstancesState(UpdateContainerInstancesStateRequest request)
Modifies the status of an Amazon ECS container instance.
|
UpdateServiceResult |
updateService(UpdateServiceRequest request)
Modifies the desired count, deployment configuration, or task definition used in a service.
|
AmazonECSWaiters |
waiters() |
addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, 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, waitsetEndpoint, setRegion@Deprecated public AmazonECSClient()
AmazonECSClientBuilder.defaultClient()All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain@Deprecated public AmazonECSClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration - The client configuration options controlling how this client connects to Amazon ECS (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain@Deprecated public AmazonECSClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonECSClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.@Deprecated public AmazonECSClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon ECS (ex: proxy settings,
retry counts, etc.).@Deprecated public AmazonECSClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.@Deprecated public AmazonECSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon ECS (ex: proxy settings,
retry counts, etc.).@Deprecated public AmazonECSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - The client configuration options controlling how this client connects to Amazon ECS (ex: proxy settings,
retry counts, etc.).requestMetricCollector - optional request metric collectorpublic static AmazonECSClientBuilder builder()
public CreateClusterResult createCluster(CreateClusterRequest request)
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.
createCluster in interface AmazonECScreateClusterRequest - ServerException - These errors are usually caused by a server issue.ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.public CreateClusterResult createCluster()
AmazonECScreateCluster in interface AmazonECSAmazonECS.createCluster(CreateClusterRequest)public CreateServiceResult createService(CreateServiceRequest request)
Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in
a service drops below desiredCount, Amazon ECS spawns another copy of the task in the specified
cluster. To update an existing service, see UpdateService.
In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind a load balancer. The load balancer distributes traffic across the tasks that are associated with the service. For more information, see Service Load Balancing in the Amazon EC2 Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. During a deployment (which is triggered
by changing the task definition or the desired count of a service with an UpdateService operation), the
service scheduler uses the minimumHealthyPercent and maximumPercent parameters to
determine the deployment strategy.
The minimumHealthyPercent represents a lower limit on the number of your service's tasks that must
remain in the RUNNING state during a deployment, as a percentage of the desiredCount
(rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster
capacity. For example, if your service has a desiredCount of four tasks and a
minimumHealthyPercent of 50%, the scheduler can stop two existing tasks to free up cluster capacity
before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy
if they are in the RUNNING state. Tasks for services that do use a load balancer are
considered healthy if they are in the RUNNING state and the container instance they are hosted on is
reported as healthy by the load balancer. The default value for minimumHealthyPercent is 50% in the
console and 100% for the AWS CLI, the AWS SDKs, and the APIs.
The maximumPercent parameter represents an upper limit on the number of your service's tasks that
are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the
desiredCount (rounded down to the nearest integer). This parameter enables you to define the
deployment batch size. For example, if your service has a desiredCount of four tasks and a
maximumPercent value of 200%, the scheduler can start four new tasks before stopping the four older
tasks (provided that the cluster resources required to do this are available). The default value for
maximumPercent is 200%.
When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic:
Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).
By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although
you can choose a different placement strategy) with the placementStrategy parameter):
Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.
Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
createService in interface AmazonECScreateServiceRequest - ServerException - These errors are usually caused by a server issue.ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters.
Amazon ECS clusters are region-specific.public DeleteAttributesResult deleteAttributes(DeleteAttributesRequest request)
Deletes one or more custom attributes from an Amazon ECS resource.
deleteAttributes in interface AmazonECSdeleteAttributesRequest - ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters.
Amazon ECS clusters are region-specific.TargetNotFoundException - The specified target could not be found. You can view your available container instances with
ListContainerInstances. Amazon ECS container instances are cluster-specific and region-specific.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.public DeleteClusterResult deleteCluster(DeleteClusterRequest request)
Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
deleteCluster in interface AmazonECSdeleteClusterRequest - ServerException - These errors are usually caused by a server issue.ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters.
Amazon ECS clusters are region-specific.ClusterContainsContainerInstancesException - You cannot delete a cluster that has registered container instances. You must first deregister the
container instances before you can delete the cluster. For more information, see
DeregisterContainerInstance.ClusterContainsServicesException - You cannot delete a cluster that contains services. You must first update the service to reduce its
desired task count to 0 and then delete the service. For more information, see UpdateService and
DeleteService.public DeleteServiceResult deleteService(DeleteServiceRequest request)
Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService.
When you delete a service, if there are still running tasks that require cleanup, the service status moves from
ACTIVE to DRAINING, and the service is no longer visible in the console or in
ListServices API operations. After the tasks have stopped, then the service status moves from
DRAINING to INACTIVE. Services in the DRAINING or INACTIVE
status can still be viewed with DescribeServices API operations; however, in the future,
INACTIVE services may be cleaned up and purged from Amazon ECS record keeping, and
DescribeServices API operations on those services will return a ServiceNotFoundException
error.
deleteService in interface AmazonECSdeleteServiceRequest - ServerException - These errors are usually caused by a server issue.ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters.
Amazon ECS clusters are region-specific.ServiceNotFoundException - The specified service could not be found. You can view your available services with ListServices.
Amazon ECS services are cluster-specific and region-specific.public DeregisterContainerInstanceResult deregisterContainerInstance(DeregisterContainerInstanceRequest request)
Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.
If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration to avoid any orphaned tasks from consuming resources.
Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance; if you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.
If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated).
deregisterContainerInstance in interface AmazonECSderegisterContainerInstanceRequest - ServerException - These errors are usually caused by a server issue.ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters.
Amazon ECS clusters are region-specific.public DeregisterTaskDefinitionResult deregisterTaskDefinition(DeregisterTaskDefinitionRequest request)
Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is
marked as INACTIVE. Existing tasks and services that reference an INACTIVE task
definition continue to run without disruption. Existing services that reference an INACTIVE task
definition can still scale up or down by modifying the service's desired count.
You cannot use an INACTIVE task definition to run new tasks or create new services, and you cannot
update an existing service to reference an INACTIVE task definition (although there may be up to a
10 minute window following deregistration where these restrictions have not yet taken effect).
At this time, INACTIVE task definitions remain discoverable in your account indefinitely; however,
this behavior is subject to change in the future, so you should not rely on INACTIVE task
definitions persisting beyond the life cycle of any associated tasks and services.
deregisterTaskDefinition in interface AmazonECSderegisterTaskDefinitionRequest - ServerException - These errors are usually caused by a server issue.ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.public DescribeClustersResult describeClusters(DescribeClustersRequest request)
Describes one or more of your clusters.
describeClusters in interface AmazonECSdescribeClustersRequest - ServerException - These errors are usually caused by a server issue.ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.public DescribeClustersResult describeClusters()
AmazonECSdescribeClusters in interface AmazonECSAmazonECS.describeClusters(DescribeClustersRequest)public DescribeContainerInstancesResult describeContainerInstances(DescribeContainerInstancesRequest request)
Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
describeContainerInstances in interface AmazonECSdescribeContainerInstancesRequest - ServerException - These errors are usually caused by a server issue.ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters.
Amazon ECS clusters are region-specific.public DescribeServicesResult describeServices(DescribeServicesRequest request)
Describes the specified services running in your cluster.
describeServices in interface AmazonECSdescribeServicesRequest - ServerException - These errors are usually caused by a server issue.ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters.
Amazon ECS clusters are region-specific.public DescribeTaskDefinitionResult describeTaskDefinition(DescribeTaskDefinitionRequest request)
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.
describeTaskDefinition in interface AmazonECSdescribeTaskDefinitionRequest - ServerException - These errors are usually caused by a server issue.ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.public DescribeTasksResult describeTasks(DescribeTasksRequest request)
Describes a specified task or tasks.
describeTasks in interface AmazonECSdescribeTasksRequest - ServerException - These errors are usually caused by a server issue.ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters.
Amazon ECS clusters are region-specific.public DiscoverPollEndpointResult discoverPollEndpoint(DiscoverPollEndpointRequest request)
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Returns an endpoint for the Amazon EC2 Container Service agent to poll for updates.
discoverPollEndpoint in interface AmazonECSdiscoverPollEndpointRequest - ServerException - These errors are usually caused by a server issue.ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.public DiscoverPollEndpointResult discoverPollEndpoint()
AmazonECSdiscoverPollEndpoint in interface AmazonECSAmazonECS.discoverPollEndpoint(DiscoverPollEndpointRequest)public ListAttributesResult listAttributes(ListAttributesRequest request)
Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a
target type and cluster, ListAttributes returns a list of attribute objects, one for each attribute
on each resource. You can filter the list of results to a single attribute name to only return results that have
that name. You can also filter the results by attribute name and value, for example, to see which container
instances in a cluster are running a Linux AMI (ecs.os-type=linux).
listAttributes in interface AmazonECSlistAttributesRequest - ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters.
Amazon ECS clusters are region-specific.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.public ListClustersResult listClusters(ListClustersRequest request)
Returns a list of existing clusters.
listClusters in interface AmazonECSlistClustersRequest - ServerException - These errors are usually caused by a server issue.ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.public ListClustersResult listClusters()
AmazonECSlistClusters in interface AmazonECSAmazonECS.listClusters(ListClustersRequest)public ListContainerInstancesResult listContainerInstances(ListContainerInstancesRequest request)
Returns a list of container instances in a specified cluster. You can filter the results of a
ListContainerInstances operation with cluster query language statements inside the
filter parameter. For more information, see Cluster Query
Language in the Amazon EC2 Container Service Developer Guide.
listContainerInstances in interface AmazonECSlistContainerInstancesRequest - ServerException - These errors are usually caused by a server issue.ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters.
Amazon ECS clusters are region-specific.public ListContainerInstancesResult listContainerInstances()
AmazonECSlistContainerInstances in interface AmazonECSAmazonECS.listContainerInstances(ListContainerInstancesRequest)public ListServicesResult listServices(ListServicesRequest request)
Lists the services that are running in a specified cluster.
listServices in interface AmazonECSlistServicesRequest - ServerException - These errors are usually caused by a server issue.ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters.
Amazon ECS clusters are region-specific.public ListServicesResult listServices()
AmazonECSlistServices in interface AmazonECSAmazonECS.listServices(ListServicesRequest)public ListTaskDefinitionFamiliesResult listTaskDefinitionFamilies(ListTaskDefinitionFamiliesRequest request)
Returns a list of task definition families that are registered to your account (which may include task definition
families that no longer have any ACTIVE task definition revisions).
You can filter out task definition families that do not contain any ACTIVE task definition revisions
by setting the status parameter to ACTIVE. You can also filter the results with the
familyPrefix parameter.
listTaskDefinitionFamilies in interface AmazonECSlistTaskDefinitionFamiliesRequest - ServerException - These errors are usually caused by a server issue.ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.public ListTaskDefinitionFamiliesResult listTaskDefinitionFamilies()
AmazonECSlistTaskDefinitionFamilies in interface AmazonECSAmazonECS.listTaskDefinitionFamilies(ListTaskDefinitionFamiliesRequest)public ListTaskDefinitionsResult listTaskDefinitions(ListTaskDefinitionsRequest request)
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.
listTaskDefinitions in interface AmazonECSlistTaskDefinitionsRequest - ServerException - These errors are usually caused by a server issue.ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.public ListTaskDefinitionsResult listTaskDefinitions()
AmazonECSlistTaskDefinitions in interface AmazonECSAmazonECS.listTaskDefinitions(ListTaskDefinitionsRequest)public ListTasksResult listTasks(ListTasksRequest request)
Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular
container instance, or by the desired status of the task with the family,
containerInstance, and desiredStatus parameters.
Recently-stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour.
listTasks in interface AmazonECSlistTasksRequest - ServerException - These errors are usually caused by a server issue.ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters.
Amazon ECS clusters are region-specific.ServiceNotFoundException - The specified service could not be found. You can view your available services with ListServices.
Amazon ECS services are cluster-specific and region-specific.public ListTasksResult listTasks()
AmazonECSlistTasks in interface AmazonECSAmazonECS.listTasks(ListTasksRequest)public PutAttributesResult putAttributes(PutAttributesRequest request)
Create or update an attribute on an Amazon ECS resource. If the attribute does not exist, it is created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes in the Amazon EC2 Container Service Developer Guide.
putAttributes in interface AmazonECSputAttributesRequest - ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters.
Amazon ECS clusters are region-specific.TargetNotFoundException - The specified target could not be found. You can view your available container instances with
ListContainerInstances. Amazon ECS container instances are cluster-specific and region-specific.AttributeLimitExceededException - You can apply up to 10 custom attributes per resource. You can view the attributes of a resource with
ListAttributes. You can remove existing attributes on a resource with DeleteAttributes.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.public RegisterContainerInstanceResult registerContainerInstance(RegisterContainerInstanceRequest request)
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.
registerContainerInstance in interface AmazonECSregisterContainerInstanceRequest - ServerException - These errors are usually caused by a server issue.ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.public RegisterTaskDefinitionResult registerTaskDefinition(RegisterTaskDefinitionRequest request)
Registers a new task definition from the supplied family and containerDefinitions.
Optionally, you can add data volumes to your containers with the volumes parameter. For more
information about task definition parameters and defaults, see Amazon ECS Task
Definitions in the Amazon EC2 Container Service Developer Guide.
You can specify an IAM role for your task with the taskRoleArn parameter. When you specify an IAM
role for a task, its containers can then use the latest versions of the AWS CLI or SDKs to make API requests to
the AWS services that are specified in the IAM policy associated with the role. For more information, see IAM Roles for Tasks in
the Amazon EC2 Container Service Developer Guide.
You can specify a Docker networking mode for the containers in your task definition with the
networkMode parameter. The available network modes correspond to those described in Network settings in the Docker run
reference.
registerTaskDefinition in interface AmazonECSregisterTaskDefinitionRequest - ServerException - These errors are usually caused by a server issue.ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.public RunTaskResult runTask(RunTaskRequest request)
Starts a new task using the specified task definition.
You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon EC2 Container Service Developer Guide.
Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.
runTask in interface AmazonECSrunTaskRequest - ServerException - These errors are usually caused by a server issue.ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters.
Amazon ECS clusters are region-specific.public StartTaskResult startTask(StartTaskRequest request)
Starts a new task from the specified task definition on the specified container instance or instances.
Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon EC2 Container Service Developer Guide.
startTask in interface AmazonECSstartTaskRequest - ServerException - These errors are usually caused by a server issue.ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters.
Amazon ECS clusters are region-specific.public StopTaskResult stopTask(StopTaskRequest request)
Stops a running task.
When StopTask is called on a task, the equivalent of docker stop is issued to the containers
running in the task. This results in a SIGTERM and a default 30-second timeout, after which
SIGKILL is sent and the containers are forcibly stopped. If the container handles the
SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.
The default 30-second timeout can be configured on the Amazon ECS container agent with the
ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see Amazon ECS Container
Agent Configuration in the Amazon EC2 Container Service Developer Guide.
stopTask in interface AmazonECSstopTaskRequest - ServerException - These errors are usually caused by a server issue.ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters.
Amazon ECS clusters are region-specific.public SubmitContainerStateChangeResult submitContainerStateChange(SubmitContainerStateChangeRequest request)
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a container changed states.
submitContainerStateChange in interface AmazonECSsubmitContainerStateChangeRequest - ServerException - These errors are usually caused by a server issue.ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.public SubmitContainerStateChangeResult submitContainerStateChange()
AmazonECSsubmitContainerStateChange in interface AmazonECSAmazonECS.submitContainerStateChange(SubmitContainerStateChangeRequest)public SubmitTaskStateChangeResult submitTaskStateChange(SubmitTaskStateChangeRequest request)
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a task changed states.
submitTaskStateChange in interface AmazonECSsubmitTaskStateChangeRequest - ServerException - These errors are usually caused by a server issue.ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.public UpdateContainerAgentResult updateContainerAgent(UpdateContainerAgentRequest request)
Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.
UpdateContainerAgent requires the Amazon ECS-optimized AMI or Amazon Linux with the
ecs-init service installed and running. For help updating the Amazon ECS container agent on other
operating systems, see Manually Updating the Amazon ECS Container Agent in the Amazon EC2 Container Service Developer Guide.
updateContainerAgent in interface AmazonECSupdateContainerAgentRequest - ServerException - These errors are usually caused by a server issue.ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters.
Amazon ECS clusters are region-specific.UpdateInProgressException - There is already a current Amazon ECS container agent update in progress on the specified container
instance. If the container agent becomes disconnected while it is in a transitional stage, such as
PENDING or STAGING, the update process can get stuck in that state. However,
when the agent reconnects, it resumes where it stopped previously.NoUpdateAvailableException - There is no update available for this Amazon ECS container agent. This could be because the agent is
already running the latest version, or it is so old that there is no update path to the current version.MissingVersionException - Amazon ECS is unable to determine the current version of the Amazon ECS container agent on the container
instance and does not have enough information to proceed with an update. This could be because the agent
running on the container instance is an older or custom version that does not use our version
information.public UpdateContainerInstancesStateResult updateContainerInstancesState(UpdateContainerInstancesStateRequest request)
Modifies the status of an Amazon ECS container instance.
You can change the status of a container instance to DRAINING to manually remove an instance from a
cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size.
When you set a container instance to DRAINING, Amazon ECS prevents new tasks from being scheduled
for placement on the container instance and replacement service tasks are started on other container instances in
the cluster if the resources are available. Service tasks on the container instance that are in the
PENDING state are stopped immediately.
Service tasks on the container instance that are in the RUNNING state are stopped and replaced
according the service's deployment configuration parameters, minimumHealthyPercent and
maximumPercent. Note that you can change the deployment configuration of your service using
UpdateService.
If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount
temporarily during task replacement. For example, desiredCount is four tasks, a minimum of 50%
allows the scheduler to stop two existing tasks before starting two new tasks. If the minimum is 100%, the
service scheduler can't remove existing tasks until the replacement tasks are considered healthy. Tasks for
services that do not use a load balancer are considered healthy if they are in the RUNNING state.
Tasks for services that use a load balancer are considered healthy if they are in the RUNNING state
and the container instance they are hosted on is reported as healthy by the load balancer.
The maximumPercent parameter represents an upper limit on the number of running tasks during task
replacement, which enables you to define the replacement batch size. For example, if desiredCount of
four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained (provided that
the cluster resources required to do this are available). If the maximum is 100%, then replacement tasks can't
start until the draining tasks have stopped.
Any PENDING or RUNNING tasks that do not belong to a service are not affected; you must
wait for them to finish or stop them manually.
A container instance has completed draining when it has no more RUNNING tasks. You can verify this
using ListTasks.
When you set a container instance to ACTIVE, the Amazon ECS scheduler can begin scheduling tasks on
the instance again.
updateContainerInstancesState in interface AmazonECSupdateContainerInstancesStateRequest - ServerException - These errors are usually caused by a server issue.ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters.
Amazon ECS clusters are region-specific.public UpdateServiceResult updateService(UpdateServiceRequest request)
Modifies the desired count, deployment configuration, or task definition used in a service.
You can add to or subtract from the number of instantiations of a task definition in a service by specifying the
cluster that the service is running in and a new desiredCount parameter.
You can use UpdateService to modify your task definition and deploy a new version of your service.
You can also update the deployment configuration of a service. When a deployment is triggered by updating the
task definition of a service, the service scheduler uses the deployment configuration parameters,
minimumHealthyPercent and maximumPercent, to determine the deployment strategy.
If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount
temporarily during a deployment. For example, if desiredCount is four tasks, a minimum of 50% allows
the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that do not use a load
balancer are considered healthy if they are in the RUNNING state. Tasks for services that use a load
balancer are considered healthy if they are in the RUNNING state and the container instance they are
hosted on is reported as healthy by the load balancer.
The maximumPercent parameter represents an upper limit on the number of running tasks during a
deployment, which enables you to define the deployment batch size. For example, if desiredCount is
four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the
cluster resources required to do this are available).
When UpdateService stops a task during a deployment, the equivalent of docker stop is issued
to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after
which SIGKILL is sent and the containers are forcibly stopped. If the container handles the
SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.
When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic:
Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).
By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy):
Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.
Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:
Sort the container instances by the largest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have two, container instances in either zone B or C are considered optimal for termination.
Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service.
updateService in interface AmazonECSupdateServiceRequest - ServerException - These errors are usually caused by a server issue.ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a
user that doesn't have permission to use the action or resource, or specifying an identifier that is not
valid.InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters.
Amazon ECS clusters are region-specific.ServiceNotFoundException - The specified service could not be found. You can view your available services with ListServices.
Amazon ECS services are cluster-specific and region-specific.ServiceNotActiveException - The specified service is not active. You cannot update a service that is not active. If you have
previously deleted a service, you can re-create it with CreateService.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata in interface AmazonECSrequest - The originally executed requestpublic AmazonECSWaiters waiters()
public void shutdown()
AmazonWebServiceClientshutdown in interface AmazonECSshutdown in class AmazonWebServiceClientCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.