Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
   /*
    * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
    * 
    * Licensed under the Apache License, Version 2.0 (the "License").
    * You may not use this file except in compliance with the License.
    * A copy of the License is located at
    * 
    *  http://aws.amazon.com/apache2.0
    * 
   * or in the "license" file accompanying this file. This file is distributed
   * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
   * express or implied. See the License for the specific language governing
   * permissions and limitations under the License.
   */
  package com.amazonaws.services.ecs;
  
  import com.amazonaws.*;
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.

  
  public interface AmazonECS {

    
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 com.amazonaws.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:
java.lang.IllegalArgumentException If any problems are detected with the specified endpoint.
  
      public void setEndpoint(String endpointthrows java.lang.IllegalArgumentException;

    
An alternative to setEndpoint(java.lang.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 com.amazonaws.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.

  
     public void setRegion(Region regionthrows java.lang.IllegalArgumentException;
    
    

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:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ClusterContainsContainerInstancesException
com.amazonaws.services.ecs.model.ClusterNotFoundException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.services.ecs.model.ClusterContainsServicesException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public DeleteClusterResult deleteCluster(DeleteClusterRequest deleteClusterRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ClusterNotFoundException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.services.ecs.model.ServiceNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public DeleteServiceResult deleteService(DeleteServiceRequest deleteServiceRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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.

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:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public ListTaskDefinitionsResult listTaskDefinitions(ListTaskDefinitionsRequest listTaskDefinitionsRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ClusterNotFoundException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public RunTaskResult runTask(RunTaskRequest runTaskRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public ListClustersResult listClusters(ListClustersRequest listClustersRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public CreateClusterResult createCluster(CreateClusterRequest createClusterRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public DescribeClustersResult describeClusters(DescribeClustersRequest describeClustersRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ClusterNotFoundException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ClusterNotFoundException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public ListContainerInstancesResult listContainerInstances(ListContainerInstancesRequest listContainerInstancesRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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).

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:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

Updates the Amazon ECS container agent on a specified container instance.

Parameters:
updateContainerAgentRequest Container for the necessary parameters to execute the UpdateContainerAgent service method on AmazonECS.
Returns:
The response from the UpdateContainerAgent service method, as returned by AmazonECS.
Throws:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ClusterNotFoundException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.NoUpdateAvailableException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.services.ecs.model.MissingVersionException
com.amazonaws.services.ecs.model.UpdateInProgressException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public UpdateContainerAgentResult updateContainerAgent(UpdateContainerAgentRequest updateContainerAgentRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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 ACTIVE revision in that family.

NOTE: You can only describe INACTIVE task definitions while an active task or service references them.

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:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public DescribeTaskDefinitionResult describeTaskDefinition(DescribeTaskDefinitionRequest describeTaskDefinitionRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public RegisterTaskDefinitionResult registerTaskDefinition(RegisterTaskDefinitionRequest registerTaskDefinitionRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public SubmitTaskStateChangeResult submitTaskStateChange(SubmitTaskStateChangeRequest submitTaskStateChangeRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ClusterNotFoundException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ClusterNotFoundException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public DescribeServicesResult describeServices(DescribeServicesRequest describeServicesRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ClusterNotFoundException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public CreateServiceResult createService(CreateServiceRequest createServiceRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ClusterNotFoundException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public ListServicesResult listServices(ListServicesRequest listServicesRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ServiceNotActiveException
com.amazonaws.services.ecs.model.ClusterNotFoundException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.services.ecs.model.ServiceNotFoundException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public UpdateServiceResult updateService(UpdateServiceRequest updateServiceRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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 definitions). 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:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ClusterNotFoundException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public DescribeTasksResult describeTasks(DescribeTasksRequest describeTasksRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public DiscoverPollEndpointResult discoverPollEndpoint(DiscoverPollEndpointRequest discoverPollEndpointRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ClusterNotFoundException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public StartTaskResult startTask(StartTaskRequest startTaskRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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.

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:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ClusterNotFoundException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public ListTasksResult listTasks(ListTasksRequest listTasksRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ClusterNotFoundException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public StopTaskResult stopTask(StopTaskRequest stopTaskRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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:
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 

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.

Returns:
The response from the ListTaskDefinitions service method, as returned by AmazonECS.
Throws:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 

Returns a list of existing clusters.

Returns:
The response from the ListClusters service method, as returned by AmazonECS.
Throws:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

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:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

Describes one or more of your clusters.

Returns:
The response from the DescribeClusters service method, as returned by AmazonECS.
Throws:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

Returns a list of container instances in a specified cluster.

Returns:
The response from the ListContainerInstances service method, as returned by AmazonECS.
Throws:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ClusterNotFoundException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

Lists the services that are running in a specified cluster.

Returns:
The response from the ListServices service method, as returned by AmazonECS.
Throws:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ClusterNotFoundException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

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 definitions). You can filter the results with the familyPrefix parameter.

Returns:
The response from the ListTaskDefinitionFamilies service method, as returned by AmazonECS.
Throws:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

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:
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.

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.

Returns:
The response from the ListTasks service method, as returned by AmazonECS.
Throws:
com.amazonaws.services.ecs.model.InvalidParameterException
com.amazonaws.services.ecs.model.ClusterNotFoundException
com.amazonaws.services.ecs.model.ServerException
com.amazonaws.services.ecs.model.ClientException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
    public ListTasksResult listTasks() throws AmazonServiceExceptionAmazonClientException;
    
    
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.
    public void shutdown();
    
    
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.
}
        
New to GrepCode? Check out our FAQ X