com.amazonaws.services.ecs

Class AmazonECSClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.ecs.AmazonECSClient

All Implemented Interfaces:

AmazonECS

Direct Known Subclasses:

AmazonECSAsyncClient

public class AmazonECSClient
extends AmazonWebServiceClient
implements AmazonECS

Client for accessing AmazonECS. All service calls made using this client are blocking, and will not return until the service call completes.

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.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<com.amazonaws.transform.JsonErrorUnmarshaller>	jsonErrorUnmarshallers List of exception unmarshallers for all AmazonECS exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AmazonECSClient() Constructs a new client to invoke service methods on AmazonECS.
AmazonECSClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AmazonECS using the specified AWS account credentials.
AmazonECSClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonECS using the specified AWS account credentials and client configuration options.
AmazonECSClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AmazonECS using the specified AWS account credentials provider.
AmazonECSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonECS using the specified AWS account credentials provider and client configuration options.
AmazonECSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on AmazonECS using the specified AWS account credentials provider, client configuration options and request metric collector.
AmazonECSClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonECS.

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) Deregisters the specified task definition by family and revision.
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 (which may include task definition families that no longer have any ACTIVE task definitions).
ListTaskDefinitionFamiliesResult	listTaskDefinitionFamilies(ListTaskDefinitionFamiliesRequest listTaskDefinitionFamiliesRequest) 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).
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.
void	setEndpoint(String endpoint, String serviceName, String regionId) An internal method that is not expected to be normally called except for AWS internal development purposes.
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.
UpdateContainerAgentResult	updateContainerAgent(UpdateContainerAgentRequest updateContainerAgentRequest) Updates the Amazon ECS container agent on a specified container instance.
UpdateServiceResult	updateService(UpdateServiceRequest updateServiceRequest) Modify the desired count or task definition used in a service.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.ecs.AmazonECS

setRegion, shutdown

Field Detail

jsonErrorUnmarshallers

protected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers

List of exception unmarshallers for all AmazonECS exceptions.

Constructor Detail

AmazonECSClient

public AmazonECSClient()

Constructs a new client to invoke service methods on AmazonECS. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AmazonECSClient

public AmazonECSClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonECS. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AmazonECS (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonECSClient

public AmazonECSClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AmazonECS using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonECSClient

public AmazonECSClient(AWSCredentials awsCredentials,
               ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonECS using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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 AmazonECS (ex: proxy settings, retry counts, etc.).

AmazonECSClient

public AmazonECSClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AmazonECS using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonECSClient

public AmazonECSClient(AWSCredentialsProvider awsCredentialsProvider,
               ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonECS using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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 AmazonECS (ex: proxy settings, retry counts, etc.).

AmazonECSClient

public AmazonECSClient(AWSCredentialsProvider awsCredentialsProvider,
               ClientConfiguration clientConfiguration,
               RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on AmazonECS using the specified AWS account credentials provider, client configuration options and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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 AmazonECS (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

deleteCluster

public DeleteClusterResult deleteCluster(DeleteClusterRequest deleteClusterRequest)

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.

Specified by:

deleteCluster in interface AmazonECS

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:

InvalidParameterException

ClusterContainsContainerInstancesException

ClusterNotFoundException

ServerException

ClientException

ClusterContainsServicesException

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

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

Sent to acknowledge that a container changed states.

Specified by:

submitContainerStateChange in interface AmazonECS

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.

deleteService

public DeleteServiceResult deleteService(DeleteServiceRequest deleteServiceRequest)

Deletes a specified service within a cluster.

Specified by:

deleteService in interface AmazonECS

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:

InvalidParameterException

ClusterNotFoundException

ServerException

ClientException

ServiceNotFoundException

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

public ListTaskDefinitionsResult listTaskDefinitions(ListTaskDefinitionsRequest listTaskDefinitionsRequest)

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.

Specified by:

listTaskDefinitions in interface AmazonECS

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:

InvalidParameterException

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

public RunTaskResult runTask(RunTaskRequest runTaskRequest)

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.

Specified by:

runTask in interface AmazonECS

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:

InvalidParameterException

ClusterNotFoundException

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

public ListClustersResult listClusters(ListClustersRequest listClustersRequest)

Returns a list of existing clusters.

Specified by:

listClusters in interface AmazonECS

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:

InvalidParameterException

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

public CreateClusterResult createCluster(CreateClusterRequest createClusterRequest)

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.

Specified by:

createCluster in interface AmazonECS

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:

InvalidParameterException

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

public DescribeClustersResult describeClusters(DescribeClustersRequest describeClustersRequest)

Describes one or more of your clusters.

Specified by:

describeClusters in interface AmazonECS

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:

InvalidParameterException

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

public DeregisterTaskDefinitionResult deregisterTaskDefinition(DeregisterTaskDefinitionRequest deregisterTaskDefinitionRequest)

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

Specified by:

deregisterTaskDefinition in interface AmazonECS

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:

InvalidParameterException

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

public DeregisterContainerInstanceResult deregisterContainerInstance(DeregisterContainerInstanceRequest deregisterContainerInstanceRequest)

Deregisters an Amazon ECS container instance from the specified cluster. This instance will no longer be 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.

NOTE: When you terminate a container instance, it is automatically deregistered from your cluster.

Specified by:

deregisterContainerInstance in interface AmazonECS

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:

InvalidParameterException

ClusterNotFoundException

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

public ListContainerInstancesResult listContainerInstances(ListContainerInstancesRequest listContainerInstancesRequest)

Returns a list of container instances in a specified cluster.

Specified by:

listContainerInstances in interface AmazonECS

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:

InvalidParameterException

ClusterNotFoundException

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.

updateContainerAgent

public UpdateContainerAgentResult updateContainerAgent(UpdateContainerAgentRequest updateContainerAgentRequest)

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 .

Specified by:

updateContainerAgent in interface AmazonECS

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:

InvalidParameterException

ClusterNotFoundException

ServerException

NoUpdateAvailableException

ClientException

MissingVersionException

UpdateInProgressException

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

public DescribeTaskDefinitionResult describeTaskDefinition(DescribeTaskDefinitionRequest describeTaskDefinitionRequest)

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.

Specified by:

describeTaskDefinition in interface AmazonECS

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:

InvalidParameterException

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

public RegisterTaskDefinitionResult registerTaskDefinition(RegisterTaskDefinitionRequest registerTaskDefinitionRequest)

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 .

Specified by:

registerTaskDefinition in interface AmazonECS

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:

InvalidParameterException

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

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

Sent to acknowledge that a task changed states.

Specified by:

submitTaskStateChange in interface AmazonECS

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.

createService

public CreateServiceResult createService(CreateServiceRequest createServiceRequest)

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.

Specified by:

createService in interface AmazonECS

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:

InvalidParameterException

ClusterNotFoundException

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

public DescribeContainerInstancesResult describeContainerInstances(DescribeContainerInstancesRequest describeContainerInstancesRequest)

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

Specified by:

describeContainerInstances in interface AmazonECS

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:

InvalidParameterException

ClusterNotFoundException

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

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

Registers an Amazon EC2 instance into the specified cluster. This instance will become available to place containers on.

Specified by:

registerContainerInstance in interface AmazonECS

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

public DescribeServicesResult describeServices(DescribeServicesRequest describeServicesRequest)

Describes the specified services running in your cluster.

Specified by:

describeServices in interface AmazonECS

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:

InvalidParameterException

ClusterNotFoundException

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

public ListServicesResult listServices(ListServicesRequest listServicesRequest)

Lists the services that are running in a specified cluster.

Specified by:

listServices in interface AmazonECS

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:

InvalidParameterException

ClusterNotFoundException

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

public UpdateServiceResult updateService(UpdateServiceRequest updateServiceRequest)

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.

Specified by:

updateService in interface AmazonECS

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:

InvalidParameterException

ServiceNotActiveException

ClusterNotFoundException

ServerException

ClientException

ServiceNotFoundException

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

public ListTaskDefinitionFamiliesResult listTaskDefinitionFamilies(ListTaskDefinitionFamiliesRequest listTaskDefinitionFamiliesRequest)

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.

Specified by:

listTaskDefinitionFamilies in interface AmazonECS

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:

InvalidParameterException

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

public DescribeTasksResult describeTasks(DescribeTasksRequest describeTasksRequest)

Describes a specified task or tasks.

Specified by:

describeTasks in interface AmazonECS

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:

InvalidParameterException

ClusterNotFoundException

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

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

Returns an endpoint for the Amazon EC2 Container Service agent to poll for updates.

Specified by:

discoverPollEndpoint in interface AmazonECS

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

public StartTaskResult startTask(StartTaskRequest startTaskRequest)

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.

Specified by:

startTask in interface AmazonECS

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:

InvalidParameterException

ClusterNotFoundException

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

public ListTasksResult listTasks(ListTasksRequest listTasksRequest)

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.

Specified by:

listTasks in interface AmazonECS

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:

InvalidParameterException

ClusterNotFoundException

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

public StopTaskResult stopTask(StopTaskRequest stopTaskRequest)

Stops a running task.

Specified by:

stopTask in interface AmazonECS

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:

InvalidParameterException

ClusterNotFoundException

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

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

Specified by:

submitContainerStateChange in interface 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

public 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 or by status with the status parameter.

Specified by:

listTaskDefinitions in interface AmazonECS

Returns:

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

Throws:

InvalidParameterException

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

public ListClustersResult listClusters()
                                throws AmazonServiceException,
                                       AmazonClientException

Returns a list of existing clusters.

Specified by:

listClusters in interface AmazonECS

Returns:

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

Throws:

InvalidParameterException

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

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

Specified by:

createCluster in interface AmazonECS

Returns:

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

Throws:

InvalidParameterException

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

public DescribeClustersResult describeClusters()
                                        throws AmazonServiceException,
                                               AmazonClientException

Describes one or more of your clusters.

Specified by:

describeClusters in interface AmazonECS

Returns:

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

Throws:

InvalidParameterException

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

public ListContainerInstancesResult listContainerInstances()
                                                    throws AmazonServiceException,
                                                           AmazonClientException

Returns a list of container instances in a specified cluster.

Specified by:

listContainerInstances in interface AmazonECS

Returns:

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

Throws:

InvalidParameterException

ClusterNotFoundException

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

public ListServicesResult listServices()
                                throws AmazonServiceException,
                                       AmazonClientException

Lists the services that are running in a specified cluster.

Specified by:

listServices in interface AmazonECS

Returns:

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

Throws:

InvalidParameterException

ClusterNotFoundException

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

public ListTaskDefinitionFamiliesResult listTaskDefinitionFamilies()
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

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.

Specified by:

listTaskDefinitionFamilies in interface AmazonECS

Returns:

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

Throws:

InvalidParameterException

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

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

Specified by:

discoverPollEndpoint in interface 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.

listTasks

public ListTasksResult listTasks()
                          throws AmazonServiceException,
                                 AmazonClientException

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.

Specified by:

listTasks in interface AmazonECS

Returns:

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

Throws:

InvalidParameterException

ClusterNotFoundException

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.

setEndpoint

public void setEndpoint(String endpoint)

Description copied from class: AmazonWebServiceClient

Overrides the default endpoint for this client. Callers can use this method to control which AWS region they want to work with.

This method is not threadsafe. Endpoints 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.

Callers can pass in just the endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.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

Specified by:

setEndpoint in interface AmazonECS

Overrides:

setEndpoint in class AmazonWebServiceClient

Parameters:

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

setEndpoint

public void setEndpoint(String endpoint,
               String serviceName,
               String regionId)
                 throws IllegalArgumentException

Description copied from class: AmazonWebServiceClient

An internal method that is not expected to be normally called except for AWS internal development purposes.

Overrides the default endpoint for this client ("http://dynamodb.us-east-1.amazonaws.com/") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests. In almost all cases, this region ID and service name are automatically determined from the endpoint, and callers should use the simpler one-argument form of setEndpoint instead of this method.

Callers can pass in just the endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "http://dynamodb.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

Overrides:

setEndpoint in class AmazonWebServiceClient

Parameters:

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

serviceName - This parameter is ignored.

regionId - The ID of the region in which this service resides AND the overriding region for signing purposes.

Throws:

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

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonECS

Parameters:

request - The originally executed request

Returns:

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