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

@ThreadSafe
public class AmazonECSClient
extends AmazonWebServiceClient
implements AmazonECS

Client for accessing Amazon ECS. 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 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 static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

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 Amazon ECS.
AmazonECSClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on Amazon ECS using the specified AWS account credentials.
AmazonECSClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Amazon ECS using the specified AWS account credentials and client configuration options.
AmazonECSClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on Amazon ECS using the specified AWS account credentials provider.
AmazonECSClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Amazon ECS 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 Amazon ECS 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 Amazon ECS.

Method Summary

Methods

Modifier and Type	Method and Description
CreateClusterResult	createCluster() Simplified method form for invoking the CreateCluster operation.
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() Simplified method form for invoking the DescribeClusters operation.
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() Simplified method form for invoking the DiscoverPollEndpoint operation.
DiscoverPollEndpointResult	discoverPollEndpoint(DiscoverPollEndpointRequest discoverPollEndpointRequest)
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() Simplified method form for invoking the ListClusters operation.
ListClustersResult	listClusters(ListClustersRequest listClustersRequest) Returns a list of existing clusters.
ListContainerInstancesResult	listContainerInstances() Simplified method form for invoking the ListContainerInstances operation.
ListContainerInstancesResult	listContainerInstances(ListContainerInstancesRequest listContainerInstancesRequest) Returns a list of container instances in a specified cluster.
ListServicesResult	listServices() Simplified method form for invoking the ListServices operation.
ListServicesResult	listServices(ListServicesRequest listServicesRequest) Lists the services that are running in a specified cluster.
ListTaskDefinitionFamiliesResult	listTaskDefinitionFamilies() Simplified method form for invoking the ListTaskDefinitionFamilies operation.
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 definition revisions).
ListTaskDefinitionsResult	listTaskDefinitions() Simplified method form for invoking the ListTaskDefinitions operation.
ListTaskDefinitionsResult	listTaskDefinitions(ListTaskDefinitionsRequest listTaskDefinitionsRequest) Returns a list of task definitions that are registered to your account.
ListTasksResult	listTasks() Simplified method form for invoking the ListTasks operation.
ListTasksResult	listTasks(ListTasksRequest listTasksRequest) Returns a list of tasks for a specified cluster.
RegisterContainerInstanceResult	registerContainerInstance(RegisterContainerInstanceRequest registerContainerInstanceRequest)
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.
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() Simplified method form for invoking the SubmitContainerStateChange operation.
SubmitContainerStateChangeResult	submitContainerStateChange(SubmitContainerStateChangeRequest submitContainerStateChangeRequest)
SubmitTaskStateChangeResult	submitTaskStateChange(SubmitTaskStateChangeRequest submitTaskStateChangeRequest)
UpdateContainerAgentResult	updateContainerAgent(UpdateContainerAgentRequest updateContainerAgentRequest) Updates the Amazon ECS container agent on a specified container instance.
UpdateServiceResult	updateService(UpdateServiceRequest updateServiceRequest) Modifies the desired count, deployment configuration, or task definition used in a service.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, 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

setEndpoint, setRegion, shutdown

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Constructor Detail

AmazonECSClient

public AmazonECSClient()

Constructs a new client to invoke service methods on Amazon ECS. 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 Amazon ECS. 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 Amazon ECS (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonECSClient

public AmazonECSClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on Amazon ECS 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 Amazon ECS 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 Amazon ECS (ex: proxy settings, retry counts, etc.).

AmazonECSClient

public AmazonECSClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on Amazon ECS 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 Amazon ECS 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 Amazon ECS (ex: proxy settings, retry counts, etc.).

AmazonECSClient

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

Constructs a new client to invoke service methods on Amazon ECS 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 Amazon ECS (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

createCluster

public CreateClusterResult createCluster(CreateClusterRequest createClusterRequest)

Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action.

Specified by:

createCluster in interface AmazonECS

Parameters:

createClusterRequest -

Returns:

Result of the CreateCluster operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server issue.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

createCluster

public CreateClusterResult createCluster()

Description copied from interface: AmazonECS

Simplified method form for invoking the CreateCluster operation.

Specified by:

createCluster in interface AmazonECS

See Also:

AmazonECS.createCluster(CreateClusterRequest)

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 spawns another instantiation of the task in the specified cluster. To update an existing service, see UpdateService.

In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind a load balancer. The load balancer distributes traffic across the tasks that are associated with the service.

You can optionally specify a deployment configuration for your service. During a deployment (which is triggered by changing the task definition of a service with an UpdateService operation), the service scheduler uses the minimumHealthyPercent and maximumPercent parameters to determine the deployment strategy.

If the minimumHealthyPercent is below 100%, the scheduler can ignore the desiredCount temporarily during a deployment. For example, if your service has a desiredCount of four tasks, a minimumHealthyPercent of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and the container instance it is hosted on is reported as healthy by the load balancer. The default value for minimumHealthyPercent is 50% in the console and 100% for the AWS CLI, the AWS SDKs, and the APIs.

The maximumPercent parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if your service has a desiredCount of four tasks, a maximumPercent value of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximumPercent is 200%.

When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones in your cluster with the following logic:

• Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).

• Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.

• Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.

Specified by:

createService in interface AmazonECS

Parameters:

createServiceRequest -

Returns:

Result of the CreateService operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server issue.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

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 -

Returns:

Result of the DeleteCluster operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server issue.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

ClusterContainsContainerInstancesException - You cannot delete a cluster that has registered container instances. You must first deregister the container instances before you can delete the cluster. For more information, see DeregisterContainerInstance.

ClusterContainsServicesException - You cannot delete a cluster that contains services. You must first update the service to reduce its desired task count to 0 and then delete the service. For more information, see UpdateService and DeleteService.

deleteService

public DeleteServiceResult deleteService(DeleteServiceRequest deleteServiceRequest)

Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService.

When you delete a service, if there are still running tasks that require cleanup, the service status moves from ACTIVE to DRAINING, and the service is no longer visible in the console or in ListServices API operations. After the tasks have stopped, then the service status moves from DRAINING to INACTIVE. Services in the DRAINING or INACTIVE status can still be viewed with DescribeServices API operations; however, in the future, INACTIVE services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices API operations on those services will return a ServiceNotFoundException error.

Specified by:

deleteService in interface AmazonECS

Parameters:

deleteServiceRequest -

Returns:

Result of the DeleteService operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server issue.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

ServiceNotFoundException - The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and region-specific.

deregisterContainerInstance

public DeregisterContainerInstanceResult deregisterContainerInstance(DeregisterContainerInstanceRequest deregisterContainerInstanceRequest)

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

If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration to avoid any orphaned tasks from consuming resources.

Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance; if you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.

If you terminate a running container instance with a connected Amazon ECS container agent, the agent automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated).

Specified by:

deregisterContainerInstance in interface AmazonECS

Parameters:

deregisterContainerInstanceRequest -

Returns:

Result of the DeregisterContainerInstance operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server issue.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

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 -

Returns:

Result of the DeregisterTaskDefinition operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server issue.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

describeClusters

public DescribeClustersResult describeClusters(DescribeClustersRequest describeClustersRequest)

Describes one or more of your clusters.

Specified by:

describeClusters in interface AmazonECS

Parameters:

describeClustersRequest -

Returns:

Result of the DescribeClusters operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server issue.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

describeClusters

public DescribeClustersResult describeClusters()

Description copied from interface: AmazonECS

Simplified method form for invoking the DescribeClusters operation.

Specified by:

describeClusters in interface AmazonECS

See Also:

AmazonECS.describeClusters(DescribeClustersRequest)

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 -

Returns:

Result of the DescribeContainerInstances operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server issue.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

describeServices

public DescribeServicesResult describeServices(DescribeServicesRequest describeServicesRequest)

Describes the specified services running in your cluster.

Specified by:

describeServices in interface AmazonECS

Parameters:

describeServicesRequest -

Returns:

Result of the DescribeServices operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server issue.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

describeTaskDefinition

public DescribeTaskDefinitionResult describeTaskDefinition(DescribeTaskDefinitionRequest describeTaskDefinitionRequest)

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

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

Specified by:

describeTaskDefinition in interface AmazonECS

Parameters:

describeTaskDefinitionRequest -

Returns:

Result of the DescribeTaskDefinition operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server issue.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

describeTasks

public DescribeTasksResult describeTasks(DescribeTasksRequest describeTasksRequest)

Describes a specified task or tasks.

Specified by:

describeTasks in interface AmazonECS

Parameters:

describeTasksRequest -

Returns:

Result of the DescribeTasks operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server issue.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

discoverPollEndpoint

public DiscoverPollEndpointResult discoverPollEndpoint(DiscoverPollEndpointRequest discoverPollEndpointRequest)

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 -

Returns:

Result of the DiscoverPollEndpoint operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server issue.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

discoverPollEndpoint

public DiscoverPollEndpointResult discoverPollEndpoint()

Description copied from interface: AmazonECS

Simplified method form for invoking the DiscoverPollEndpoint operation.

Specified by:

discoverPollEndpoint in interface AmazonECS

See Also:

AmazonECS.discoverPollEndpoint(DiscoverPollEndpointRequest)

listClusters

public ListClustersResult listClusters(ListClustersRequest listClustersRequest)

Returns a list of existing clusters.

Specified by:

listClusters in interface AmazonECS

Parameters:

listClustersRequest -

Returns:

Result of the ListClusters operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server issue.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

listClusters

public ListClustersResult listClusters()

Description copied from interface: AmazonECS

Simplified method form for invoking the ListClusters operation.

Specified by:

listClusters in interface AmazonECS

See Also:

AmazonECS.listClusters(ListClustersRequest)

listContainerInstances

public ListContainerInstancesResult listContainerInstances(ListContainerInstancesRequest listContainerInstancesRequest)

Returns a list of container instances in a specified cluster.

Specified by:

listContainerInstances in interface AmazonECS

Parameters:

listContainerInstancesRequest -

Returns:

Result of the ListContainerInstances operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server issue.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

listContainerInstances

public ListContainerInstancesResult listContainerInstances()

Description copied from interface: AmazonECS

Simplified method form for invoking the ListContainerInstances operation.

Specified by:

listContainerInstances in interface AmazonECS

See Also:

AmazonECS.listContainerInstances(ListContainerInstancesRequest)

listServices

public ListServicesResult listServices(ListServicesRequest listServicesRequest)

Lists the services that are running in a specified cluster.

Specified by:

listServices in interface AmazonECS

Parameters:

listServicesRequest -

Returns:

Result of the ListServices operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server issue.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

listServices

public ListServicesResult listServices()

Description copied from interface: AmazonECS

Simplified method form for invoking the ListServices operation.

Specified by:

listServices in interface AmazonECS

See Also:

AmazonECS.listServices(ListServicesRequest)

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

You can filter out task definition families that do not contain any ACTIVE task definition revisions by setting the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter.

Specified by:

listTaskDefinitionFamilies in interface AmazonECS

Parameters:

listTaskDefinitionFamiliesRequest -

Returns:

Result of the ListTaskDefinitionFamilies operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server issue.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

listTaskDefinitionFamilies

public ListTaskDefinitionFamiliesResult listTaskDefinitionFamilies()

Description copied from interface: AmazonECS

Simplified method form for invoking the ListTaskDefinitionFamilies operation.

Specified by:

listTaskDefinitionFamilies in interface AmazonECS

See Also:

AmazonECS.listTaskDefinitionFamilies(ListTaskDefinitionFamiliesRequest)

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 -

Returns:

Result of the ListTaskDefinitions operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server issue.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

listTaskDefinitions

public ListTaskDefinitionsResult listTaskDefinitions()

Description copied from interface: AmazonECS

Simplified method form for invoking the ListTaskDefinitions operation.

Specified by:

listTaskDefinitions in interface AmazonECS

See Also:

AmazonECS.listTaskDefinitions(ListTaskDefinitionsRequest)

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 -

Returns:

Result of the ListTasks operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server issue.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

ServiceNotFoundException - The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and region-specific.

listTasks

public ListTasksResult listTasks()

Description copied from interface: AmazonECS

Simplified method form for invoking the ListTasks operation.

Specified by:

listTasks in interface AmazonECS

See Also:

AmazonECS.listTasks(ListTasksRequest)

registerContainerInstance

public RegisterContainerInstanceResult registerContainerInstance(RegisterContainerInstanceRequest registerContainerInstanceRequest)

This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.

Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.

Specified by:

registerContainerInstance in interface AmazonECS

Parameters:

registerContainerInstanceRequest -

Returns:

Result of the RegisterContainerInstance operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server issue.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

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 about 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 -

Returns:

Result of the RegisterTaskDefinition operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server issue.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

runTask

public RunTaskResult runTask(RunTaskRequest runTaskRequest)

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

The count parameter is limited to 10 tasks per call.

Specified by:

runTask in interface AmazonECS

Parameters:

runTaskRequest -

Returns:

Result of the RunTask operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server issue.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

startTask

public StartTaskResult startTask(StartTaskRequest startTaskRequest)

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

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

Specified by:

startTask in interface AmazonECS

Parameters:

startTaskRequest -

Returns:

Result of the StartTask operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server issue.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

stopTask

public StopTaskResult stopTask(StopTaskRequest stopTaskRequest)

Stops a running task.

When StopTask is called on a task, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.

Specified by:

stopTask in interface AmazonECS

Parameters:

stopTaskRequest -

Returns:

Result of the StopTask operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server issue.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

submitContainerStateChange

public SubmitContainerStateChangeResult submitContainerStateChange(SubmitContainerStateChangeRequest submitContainerStateChangeRequest)

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 -

Returns:

Result of the SubmitContainerStateChange operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server issue.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

submitContainerStateChange

public SubmitContainerStateChangeResult submitContainerStateChange()

Description copied from interface: AmazonECS

Simplified method form for invoking the SubmitContainerStateChange operation.

Specified by:

submitContainerStateChange in interface AmazonECS

See Also:

AmazonECS.submitContainerStateChange(SubmitContainerStateChangeRequest)

submitTaskStateChange

public SubmitTaskStateChangeResult submitTaskStateChange(SubmitTaskStateChangeRequest submitTaskStateChangeRequest)

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 -

Returns:

Result of the SubmitTaskStateChange operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server issue.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

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 -

Returns:

Result of the UpdateContainerAgent operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server issue.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

UpdateInProgressException - There is already a current Amazon ECS container agent update in progress on the specified container instance. If the container agent becomes disconnected while it is in a transitional stage, such as PENDING or STAGING, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.

NoUpdateAvailableException - There is no update available for this Amazon ECS container agent. This could be because the agent is already running the latest version, or it is so old that there is no update path to the current version.

MissingVersionException - Amazon ECS is unable to determine the current version of the Amazon ECS container agent on the container instance and does not have enough information to proceed with an update. This could be because the agent running on the container instance is an older or custom version that does not use our version information.

updateService

public UpdateServiceResult updateService(UpdateServiceRequest updateServiceRequest)

Modifies the desired count, deployment configuration, or task definition used in a service.

You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter.

You can use UpdateService to modify your task definition and deploy a new version of your service.

You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, minimumHealthyPercent and maximumPercent, to determine the deployment strategy.

If the minimumHealthyPercent is below 100%, the scheduler can ignore the desiredCount temporarily during a deployment. For example, if your service has a desiredCount of four tasks, a minimumHealthyPercent of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and the container instance it is hosted on is reported as healthy by the load balancer.

The maximumPercent parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if your service has a desiredCount of four tasks, a maximumPercent value of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).

When UpdateService stops a task during a deployment, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.

When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones in your cluster with the following logic:

• Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).

• Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.

• Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.

Specified by:

updateService in interface AmazonECS

Parameters:

updateServiceRequest -

Returns:

Result of the UpdateService operation returned by the service.

Throws:

ServerException - These errors are usually caused by a server issue.

ClientException - These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid.

InvalidParameterException - The specified parameter is invalid. Review the available parameters for the API request.

ClusterNotFoundException - The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are region-specific.

ServiceNotFoundException - The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and region-specific.

ServiceNotActiveException - The specified service is not active. You cannot update a service that is not active. If you have previously deleted a service, you can re-create it with CreateService.

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.