com.amazonaws.services.ecs

Interface AmazonECS

All Known Subinterfaces:

AmazonECSAsync

All Known Implementing Classes:

AmazonECSAsyncClient, AmazonECSClient

public interface AmazonECS

Interface for accessing 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 Amazon 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.

Method Summary

Methods

Modifier and Type	Method and Description
CreateClusterResult	createCluster() Creates a new Amazon ECS cluster.
CreateClusterResult	createCluster(CreateClusterRequest createClusterRequest) Creates a new Amazon ECS cluster.
CreateServiceResult	createService(CreateServiceRequest createServiceRequest) Runs and maintains a desired number of tasks from a specified task definition.
DeleteClusterResult	deleteCluster(DeleteClusterRequest deleteClusterRequest) Deletes the specified cluster.
DeleteServiceResult	deleteService(DeleteServiceRequest deleteServiceRequest) Deletes a specified service within a cluster.
DeregisterContainerInstanceResult	deregisterContainerInstance(DeregisterContainerInstanceRequest deregisterContainerInstanceRequest) Deregisters an Amazon ECS container instance from the specified cluster.
DeregisterTaskDefinitionResult	deregisterTaskDefinition(DeregisterTaskDefinitionRequest deregisterTaskDefinitionRequest) NOT YET IMPLEMENTED.
DescribeClustersResult	describeClusters() Describes one or more of your clusters.
DescribeClustersResult	describeClusters(DescribeClustersRequest describeClustersRequest) Describes one or more of your clusters.
DescribeContainerInstancesResult	describeContainerInstances(DescribeContainerInstancesRequest describeContainerInstancesRequest) Describes Amazon EC2 Container Service container instances.
DescribeServicesResult	describeServices(DescribeServicesRequest describeServicesRequest) Describes the specified services running in your cluster.
DescribeTaskDefinitionResult	describeTaskDefinition(DescribeTaskDefinitionRequest describeTaskDefinitionRequest) Describes a task definition.
DescribeTasksResult	describeTasks(DescribeTasksRequest describeTasksRequest) Describes a specified task or tasks.
DiscoverPollEndpointResult	discoverPollEndpoint() NOTE: This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
DiscoverPollEndpointResult	discoverPollEndpoint(DiscoverPollEndpointRequest discoverPollEndpointRequest) NOTE: This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
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.
ListClustersResult	listClusters() Returns a list of existing clusters.
ListClustersResult	listClusters(ListClustersRequest listClustersRequest) Returns a list of existing clusters.
ListContainerInstancesResult	listContainerInstances() Returns a list of container instances in a specified cluster.
ListContainerInstancesResult	listContainerInstances(ListContainerInstancesRequest listContainerInstancesRequest) Returns a list of container instances in a specified cluster.
ListServicesResult	listServices() Lists the services that are running in a specified cluster.
ListServicesResult	listServices(ListServicesRequest listServicesRequest) Lists the services that are running in a specified cluster.
ListTaskDefinitionFamiliesResult	listTaskDefinitionFamilies() Returns a list of task definition families that are registered to your account.
ListTaskDefinitionFamiliesResult	listTaskDefinitionFamilies(ListTaskDefinitionFamiliesRequest listTaskDefinitionFamiliesRequest) Returns a list of task definition families that are registered to your account.
ListTaskDefinitionsResult	listTaskDefinitions() Returns a list of task definitions that are registered to your account.
ListTaskDefinitionsResult	listTaskDefinitions(ListTaskDefinitionsRequest listTaskDefinitionsRequest) Returns a list of task definitions that are registered to your account.
ListTasksResult	listTasks() Returns a list of tasks for a specified cluster.
ListTasksResult	listTasks(ListTasksRequest listTasksRequest) Returns a list of tasks for a specified cluster.
RegisterContainerInstanceResult	registerContainerInstance(RegisterContainerInstanceRequest registerContainerInstanceRequest) NOTE: This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
RegisterTaskDefinitionResult	registerTaskDefinition(RegisterTaskDefinitionRequest registerTaskDefinitionRequest) Registers a new task definition from the supplied family and containerDefinitions .
RunTaskResult	runTask(RunTaskRequest runTaskRequest) Start a task using random placement and the default Amazon ECS scheduler.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://ecs.us-east-1.amazonaws.com").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartTaskResult	startTask(StartTaskRequest startTaskRequest) Starts a new task from the specified task definition on the specified container instance or instances.
StopTaskResult	stopTask(StopTaskRequest stopTaskRequest) Stops a running task.
SubmitContainerStateChangeResult	submitContainerStateChange() NOTE: This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
SubmitContainerStateChangeResult	submitContainerStateChange(SubmitContainerStateChangeRequest submitContainerStateChangeRequest) NOTE: This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
SubmitTaskStateChangeResult	submitTaskStateChange(SubmitTaskStateChangeRequest submitTaskStateChangeRequest) NOTE: This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
UpdateServiceResult	updateService(UpdateServiceRequest updateServiceRequest) Modify the desired count or task definition used in a service.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
                 throws IllegalArgumentException

Overrides the default endpoint for this client ("https://ecs.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "ecs.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://ecs.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "ecs.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://ecs.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
               throws IllegalArgumentException

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

deleteCluster

DeleteClusterResult deleteCluster(DeleteClusterRequest deleteClusterRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

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.

Parameters:

deleteClusterRequest - Container for the necessary parameters to execute the DeleteCluster service method on AmazonECS.

Returns:

The response from the DeleteCluster service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

deleteService

DeleteServiceResult deleteService(DeleteServiceRequest deleteServiceRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Deletes a specified service within a cluster.

Parameters:

deleteServiceRequest - Container for the necessary parameters to execute the DeleteService service method on AmazonECS.

Returns:

The response from the DeleteService service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

submitContainerStateChange

SubmitContainerStateChangeResult submitContainerStateChange(SubmitContainerStateChangeRequest submitContainerStateChangeRequest)
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

NOTE: 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.

Parameters:

submitContainerStateChangeRequest - Container for the necessary parameters to execute the SubmitContainerStateChange service method on AmazonECS.

Returns:

The response from the SubmitContainerStateChange service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

listTaskDefinitions

ListTaskDefinitionsResult listTaskDefinitions(ListTaskDefinitionsRequest listTaskDefinitionsRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter.

Parameters:

listTaskDefinitionsRequest - Container for the necessary parameters to execute the ListTaskDefinitions service method on AmazonECS.

Returns:

The response from the ListTaskDefinitions service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

runTask

RunTaskResult runTask(RunTaskRequest runTaskRequest)
                      throws AmazonServiceException,
                             AmazonClientException

Start a task using random placement and the default Amazon ECS scheduler. If you want to use your own scheduler or place a task on a specific container instance, use StartTask instead.

IMPORTANT: The count parameter is limited to 10 tasks per call.

Parameters:

runTaskRequest - Container for the necessary parameters to execute the RunTask service method on AmazonECS.

Returns:

The response from the RunTask service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

listClusters

ListClustersResult listClusters(ListClustersRequest listClustersRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

Returns a list of existing clusters.

Parameters:

listClustersRequest - Container for the necessary parameters to execute the ListClusters service method on AmazonECS.

Returns:

The response from the ListClusters service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

createCluster

CreateClusterResult createCluster(CreateClusterRequest createClusterRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Creates a new Amazon ECS cluster. By default, your account will receive 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.

Parameters:

createClusterRequest - Container for the necessary parameters to execute the CreateCluster service method on AmazonECS.

Returns:

The response from the CreateCluster service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

describeClusters

DescribeClustersResult describeClusters(DescribeClustersRequest describeClustersRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Describes one or more of your clusters.

Parameters:

describeClustersRequest - Container for the necessary parameters to execute the DescribeClusters service method on AmazonECS.

Returns:

The response from the DescribeClusters service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

deregisterContainerInstance

DeregisterContainerInstanceResult deregisterContainerInstance(DeregisterContainerInstanceRequest deregisterContainerInstanceRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

Deregisters an Amazon ECS container instance from the specified cluster. This instance will no longer be available to run tasks.

Parameters:

deregisterContainerInstanceRequest - Container for the necessary parameters to execute the DeregisterContainerInstance service method on AmazonECS.

Returns:

The response from the DeregisterContainerInstance service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

listContainerInstances

ListContainerInstancesResult listContainerInstances(ListContainerInstancesRequest listContainerInstancesRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

Returns a list of container instances in a specified cluster.

Parameters:

listContainerInstancesRequest - Container for the necessary parameters to execute the ListContainerInstances service method on AmazonECS.

Returns:

The response from the ListContainerInstances service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

deregisterTaskDefinition

DeregisterTaskDefinitionResult deregisterTaskDefinition(DeregisterTaskDefinitionRequest deregisterTaskDefinitionRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

NOT YET IMPLEMENTED.

Deregisters the specified task definition. You will no longer be able to run tasks from this definition after deregistration.

Parameters:

deregisterTaskDefinitionRequest - Container for the necessary parameters to execute the DeregisterTaskDefinition service method on AmazonECS.

Returns:

The response from the DeregisterTaskDefinition service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

describeTaskDefinition

DescribeTaskDefinitionResult describeTaskDefinition(DescribeTaskDefinitionRequest describeTaskDefinitionRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

Describes a task definition. You can specify a family and revision to find information on a specific task definition, or you can simply specify the family to find the latest revision in that family.

Parameters:

describeTaskDefinitionRequest - Container for the necessary parameters to execute the DescribeTaskDefinition service method on AmazonECS.

Returns:

The response from the DescribeTaskDefinition service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

registerTaskDefinition

RegisterTaskDefinitionResult registerTaskDefinition(RegisterTaskDefinitionRequest registerTaskDefinitionRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

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 on task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide .

Parameters:

registerTaskDefinitionRequest - Container for the necessary parameters to execute the RegisterTaskDefinition service method on AmazonECS.

Returns:

The response from the RegisterTaskDefinition service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

submitTaskStateChange

SubmitTaskStateChangeResult submitTaskStateChange(SubmitTaskStateChangeRequest submitTaskStateChangeRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

NOTE: 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.

Parameters:

submitTaskStateChangeRequest - Container for the necessary parameters to execute the SubmitTaskStateChange service method on AmazonECS.

Returns:

The response from the SubmitTaskStateChange service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

describeContainerInstances

DescribeContainerInstancesResult describeContainerInstances(DescribeContainerInstancesRequest describeContainerInstancesRequest)
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.

Parameters:

describeContainerInstancesRequest - Container for the necessary parameters to execute the DescribeContainerInstances service method on AmazonECS.

Returns:

The response from the DescribeContainerInstances service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

registerContainerInstance

RegisterContainerInstanceResult registerContainerInstance(RegisterContainerInstanceRequest registerContainerInstanceRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

NOTE: 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 Amazon EC2 instance into the specified cluster. This instance will become available to place containers on.

Parameters:

registerContainerInstanceRequest - Container for the necessary parameters to execute the RegisterContainerInstance service method on AmazonECS.

Returns:

The response from the RegisterContainerInstance service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

describeServices

DescribeServicesResult describeServices(DescribeServicesRequest describeServicesRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Describes the specified services running in your cluster.

Parameters:

describeServicesRequest - Container for the necessary parameters to execute the DescribeServices service method on AmazonECS.

Returns:

The response from the DescribeServices service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

createService

CreateServiceResult createService(CreateServiceRequest createServiceRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

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 will spawn another instantiation of the task in the specified cluster.

Parameters:

createServiceRequest - Container for the necessary parameters to execute the CreateService service method on AmazonECS.

Returns:

The response from the CreateService service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

listServices

ListServicesResult listServices(ListServicesRequest listServicesRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

Lists the services that are running in a specified cluster.

Parameters:

listServicesRequest - Container for the necessary parameters to execute the ListServices service method on AmazonECS.

Returns:

The response from the ListServices service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

updateService

UpdateServiceResult updateService(UpdateServiceRequest updateServiceRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Modify the desired count 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, one task at a time. If you modify the task definition with UpdateService , Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running. Because UpdateService starts a new version of the task before stopping an old version, your cluster must have capacity to support one more instantiation of the task when UpdateService is run. If your cluster cannot support another instantiation of the task used in your service, you can reduce the desired count of your service by one before modifying the task definition.

Parameters:

updateServiceRequest - Container for the necessary parameters to execute the UpdateService service method on AmazonECS.

Returns:

The response from the UpdateService service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

listTaskDefinitionFamilies

ListTaskDefinitionFamiliesResult listTaskDefinitionFamilies(ListTaskDefinitionFamiliesRequest listTaskDefinitionFamiliesRequest)
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

Returns a list of task definition families that are registered to your account. You can filter the results with the familyPrefix parameter.

Parameters:

listTaskDefinitionFamiliesRequest - Container for the necessary parameters to execute the ListTaskDefinitionFamilies service method on AmazonECS.

Returns:

The response from the ListTaskDefinitionFamilies service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

describeTasks

DescribeTasksResult describeTasks(DescribeTasksRequest describeTasksRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

Describes a specified task or tasks.

Parameters:

describeTasksRequest - Container for the necessary parameters to execute the DescribeTasks service method on AmazonECS.

Returns:

The response from the DescribeTasks service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

discoverPollEndpoint

DiscoverPollEndpointResult discoverPollEndpoint(DiscoverPollEndpointRequest discoverPollEndpointRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

NOTE: 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.

Parameters:

discoverPollEndpointRequest - Container for the necessary parameters to execute the DiscoverPollEndpoint service method on AmazonECS.

Returns:

The response from the DiscoverPollEndpoint service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

startTask

StartTaskResult startTask(StartTaskRequest startTaskRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

Starts a new task from the specified task definition on the specified container instance or instances. If you want to use the default Amazon ECS scheduler to place your task, use RunTask instead.

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

Parameters:

startTaskRequest - Container for the necessary parameters to execute the StartTask service method on AmazonECS.

Returns:

The response from the StartTask service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

listTasks

ListTasksResult listTasks(ListTasksRequest listTasksRequest)
                          throws AmazonServiceException,
                                 AmazonClientException

Returns a list of tasks for a specified cluster. You can filter the results by family name or by a particular container instance with the family and containerInstance parameters.

Parameters:

listTasksRequest - Container for the necessary parameters to execute the ListTasks service method on AmazonECS.

Returns:

The response from the ListTasks service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

stopTask

StopTaskResult stopTask(StopTaskRequest stopTaskRequest)
                        throws AmazonServiceException,
                               AmazonClientException

Stops a running task.

Parameters:

stopTaskRequest - Container for the necessary parameters to execute the StopTask service method on AmazonECS.

Returns:

The response from the StopTask service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

submitContainerStateChange

SubmitContainerStateChangeResult submitContainerStateChange()
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

NOTE: 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.

Returns:

The response from the SubmitContainerStateChange service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

listTaskDefinitions

ListTaskDefinitionsResult listTaskDefinitions()
                                              throws AmazonServiceException,
                                                     AmazonClientException

Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter.

Returns:

The response from the ListTaskDefinitions service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

listClusters

ListClustersResult listClusters()
                                throws AmazonServiceException,
                                       AmazonClientException

Returns a list of existing clusters.

Returns:

The response from the ListClusters service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

createCluster

CreateClusterResult createCluster()
                                  throws AmazonServiceException,
                                         AmazonClientException

Creates a new Amazon ECS cluster. By default, your account will receive 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.

Returns:

The response from the CreateCluster service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

describeClusters

DescribeClustersResult describeClusters()
                                        throws AmazonServiceException,
                                               AmazonClientException

Describes one or more of your clusters.

Returns:

The response from the DescribeClusters service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

listContainerInstances

ListContainerInstancesResult listContainerInstances()
                                                    throws AmazonServiceException,
                                                           AmazonClientException

Returns a list of container instances in a specified cluster.

Returns:

The response from the ListContainerInstances service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

listServices

ListServicesResult listServices()
                                throws AmazonServiceException,
                                       AmazonClientException

Lists the services that are running in a specified cluster.

Returns:

The response from the ListServices service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

listTaskDefinitionFamilies

ListTaskDefinitionFamiliesResult listTaskDefinitionFamilies()
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

Returns a list of task definition families that are registered to your account. You can filter the results with the familyPrefix parameter.

Returns:

The response from the ListTaskDefinitionFamilies service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

discoverPollEndpoint

DiscoverPollEndpointResult discoverPollEndpoint()
                                                throws AmazonServiceException,
                                                       AmazonClientException

NOTE: 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.

Returns:

The response from the DiscoverPollEndpoint service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

listTasks

ListTasksResult listTasks()
                          throws AmazonServiceException,
                                 AmazonClientException

Returns a list of tasks for a specified cluster. You can filter the results by family name or by a particular container instance with the family and containerInstance parameters.

Returns:

The response from the ListTasks service method, as returned by AmazonECS.

Throws:

ServerException

ClientException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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 a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.