Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
   /*
    * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
    * 
    * Licensed under the Apache License, Version 2.0 (the "License").
    * You may not use this file except in compliance with the License.
    * A copy of the License is located at
    * 
    *  http://aws.amazon.com/apache2.0
    * 
   * or in the "license" file accompanying this file. This file is distributed
   * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
   * express or implied. See the License for the specific language governing
   * permissions and limitations under the License.
   */
  package com.amazonaws.services.ecs;
  
  
Interface for accessing AmazonECS asynchronously. Each asynchronous method will return a Java Future object, and users are also allowed to provide a callback handler.

Amazon EC2 Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster of Amazon EC2 instances. Amazon ECS lets you launch and stop container-enabled applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features like security groups, Amazon EBS volumes, and IAM roles.

You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon EC2 Container Service eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.

  
  public interface AmazonECSAsync extends AmazonECS {
    

Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.

Parameters:
deleteClusterRequest Container for the necessary parameters to execute the DeleteCluster operation on AmazonECS.
Returns:
A Java Future object containing the response from the DeleteCluster service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
  
      public Future<DeleteClusterResultdeleteClusterAsync(DeleteClusterRequest deleteClusterRequest
              throws AmazonServiceExceptionAmazonClientException;

    

Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.

Parameters:
deleteClusterRequest Container for the necessary parameters to execute the DeleteCluster operation on AmazonECS.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the DeleteCluster service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public Future<DeleteClusterResultdeleteClusterAsync(DeleteClusterRequest deleteClusterRequest,
             AsyncHandler<DeleteClusterRequestDeleteClusterResultasyncHandler)
                     throws AmazonServiceExceptionAmazonClientException;

    

Deletes a specified service within a cluster.

Parameters:
deleteServiceRequest Container for the necessary parameters to execute the DeleteService operation on AmazonECS.
Returns:
A Java Future object containing the response from the DeleteService service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public Future<DeleteServiceResultdeleteServiceAsync(DeleteServiceRequest deleteServiceRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Deletes a specified service within a cluster.

Parameters:
deleteServiceRequest Container for the necessary parameters to execute the DeleteService operation on AmazonECS.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the DeleteService service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public Future<DeleteServiceResultdeleteServiceAsync(DeleteServiceRequest deleteServiceRequest,
             AsyncHandler<DeleteServiceRequestDeleteServiceResultasyncHandler)
                     throws AmazonServiceExceptionAmazonClientException;

    

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

Sent to acknowledge that a container changed states.

Parameters:
submitContainerStateChangeRequest Container for the necessary parameters to execute the SubmitContainerStateChange operation on AmazonECS.
Returns:
A Java Future object containing the response from the SubmitContainerStateChange service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

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

Sent to acknowledge that a container changed states.

Parameters:
submitContainerStateChangeRequest Container for the necessary parameters to execute the SubmitContainerStateChange operation on AmazonECS.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the SubmitContainerStateChange service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
                     throws AmazonServiceExceptionAmazonClientException;

    

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

Parameters:
listTaskDefinitionsRequest Container for the necessary parameters to execute the ListTaskDefinitions operation on AmazonECS.
Returns:
A Java Future object containing the response from the ListTaskDefinitions service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

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

Parameters:
listTaskDefinitionsRequest Container for the necessary parameters to execute the ListTaskDefinitions operation on AmazonECS.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the ListTaskDefinitions service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
             AsyncHandler<ListTaskDefinitionsRequestListTaskDefinitionsResultasyncHandler)
                     throws AmazonServiceExceptionAmazonClientException;

    

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

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

Parameters:
runTaskRequest Container for the necessary parameters to execute the RunTask operation on AmazonECS.
Returns:
A Java Future object containing the response from the RunTask service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public Future<RunTaskResultrunTaskAsync(RunTaskRequest runTaskRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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

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

Parameters:
runTaskRequest Container for the necessary parameters to execute the RunTask operation on AmazonECS.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the RunTask service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public Future<RunTaskResultrunTaskAsync(RunTaskRequest runTaskRequest,
             AsyncHandler<RunTaskRequestRunTaskResultasyncHandler)
                     throws AmazonServiceExceptionAmazonClientException;

    

Returns a list of existing clusters.

Parameters:
listClustersRequest Container for the necessary parameters to execute the ListClusters operation on AmazonECS.
Returns:
A Java Future object containing the response from the ListClusters service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public Future<ListClustersResultlistClustersAsync(ListClustersRequest listClustersRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Returns a list of existing clusters.

Parameters:
listClustersRequest Container for the necessary parameters to execute the ListClusters operation on AmazonECS.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the ListClusters service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public Future<ListClustersResultlistClustersAsync(ListClustersRequest listClustersRequest,
             AsyncHandler<ListClustersRequestListClustersResultasyncHandler)
                     throws AmazonServiceExceptionAmazonClientException;

    

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

Parameters:
createClusterRequest Container for the necessary parameters to execute the CreateCluster operation on AmazonECS.
Returns:
A Java Future object containing the response from the CreateCluster service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public Future<CreateClusterResultcreateClusterAsync(CreateClusterRequest createClusterRequest
             throws AmazonServiceExceptionAmazonClientException;

    

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

Parameters:
createClusterRequest Container for the necessary parameters to execute the CreateCluster operation on AmazonECS.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the CreateCluster service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public Future<CreateClusterResultcreateClusterAsync(CreateClusterRequest createClusterRequest,
             AsyncHandler<CreateClusterRequestCreateClusterResultasyncHandler)
                     throws AmazonServiceExceptionAmazonClientException;

    

Describes one or more of your clusters.

Parameters:
describeClustersRequest Container for the necessary parameters to execute the DescribeClusters operation on AmazonECS.
Returns:
A Java Future object containing the response from the DescribeClusters service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public Future<DescribeClustersResultdescribeClustersAsync(DescribeClustersRequest describeClustersRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Describes one or more of your clusters.

Parameters:
describeClustersRequest Container for the necessary parameters to execute the DescribeClusters operation on AmazonECS.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the DescribeClusters service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
             AsyncHandler<DescribeClustersRequestDescribeClustersResultasyncHandler)
                     throws AmazonServiceExceptionAmazonClientException;

    

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

Parameters:
deregisterContainerInstanceRequest Container for the necessary parameters to execute the DeregisterContainerInstance operation on AmazonECS.
Returns:
A Java Future object containing the response from the DeregisterContainerInstance service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

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

Parameters:
deregisterContainerInstanceRequest Container for the necessary parameters to execute the DeregisterContainerInstance operation on AmazonECS.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the DeregisterContainerInstance service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
                     throws AmazonServiceExceptionAmazonClientException;

    

Returns a list of container instances in a specified cluster.

Parameters:
listContainerInstancesRequest Container for the necessary parameters to execute the ListContainerInstances operation on AmazonECS.
Returns:
A Java Future object containing the response from the ListContainerInstances service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

Returns a list of container instances in a specified cluster.

Parameters:
listContainerInstancesRequest Container for the necessary parameters to execute the ListContainerInstances operation on AmazonECS.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the ListContainerInstances service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
                     throws AmazonServiceExceptionAmazonClientException;

    

NOT YET IMPLEMENTED.

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

Parameters:
deregisterTaskDefinitionRequest Container for the necessary parameters to execute the DeregisterTaskDefinition operation on AmazonECS.
Returns:
A Java Future object containing the response from the DeregisterTaskDefinition service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

NOT YET IMPLEMENTED.

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

Parameters:
deregisterTaskDefinitionRequest Container for the necessary parameters to execute the DeregisterTaskDefinition operation on AmazonECS.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the DeregisterTaskDefinition service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
                     throws AmazonServiceExceptionAmazonClientException;

    

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

Parameters:
describeTaskDefinitionRequest Container for the necessary parameters to execute the DescribeTaskDefinition operation on AmazonECS.
Returns:
A Java Future object containing the response from the DescribeTaskDefinition service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

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

Parameters:
describeTaskDefinitionRequest Container for the necessary parameters to execute the DescribeTaskDefinition operation on AmazonECS.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the DescribeTaskDefinition service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
                     throws AmazonServiceExceptionAmazonClientException;

    

Registers a new task definition from the supplied family and containerDefinitions . Optionally, you can add data volumes to your containers with the volumes parameter. For more information on task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide .

Parameters:
registerTaskDefinitionRequest Container for the necessary parameters to execute the RegisterTaskDefinition operation on AmazonECS.
Returns:
A Java Future object containing the response from the RegisterTaskDefinition service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

Registers a new task definition from the supplied family and containerDefinitions . Optionally, you can add data volumes to your containers with the volumes parameter. For more information on task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon EC2 Container Service Developer Guide .

Parameters:
registerTaskDefinitionRequest Container for the necessary parameters to execute the RegisterTaskDefinition operation on AmazonECS.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the RegisterTaskDefinition service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
                     throws AmazonServiceExceptionAmazonClientException;

    

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

Sent to acknowledge that a task changed states.

Parameters:
submitTaskStateChangeRequest Container for the necessary parameters to execute the SubmitTaskStateChange operation on AmazonECS.
Returns:
A Java Future object containing the response from the SubmitTaskStateChange service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

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

Sent to acknowledge that a task changed states.

Parameters:
submitTaskStateChangeRequest Container for the necessary parameters to execute the SubmitTaskStateChange operation on AmazonECS.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the SubmitTaskStateChange service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
                     throws AmazonServiceExceptionAmazonClientException;

    

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

Parameters:
describeContainerInstancesRequest Container for the necessary parameters to execute the DescribeContainerInstances operation on AmazonECS.
Returns:
A Java Future object containing the response from the DescribeContainerInstances service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

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

Parameters:
describeContainerInstancesRequest Container for the necessary parameters to execute the DescribeContainerInstances operation on AmazonECS.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the DescribeContainerInstances service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
                     throws AmazonServiceExceptionAmazonClientException;

    

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

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

Parameters:
registerContainerInstanceRequest Container for the necessary parameters to execute the RegisterContainerInstance operation on AmazonECS.
Returns:
A Java Future object containing the response from the RegisterContainerInstance service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

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

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

Parameters:
registerContainerInstanceRequest Container for the necessary parameters to execute the RegisterContainerInstance operation on AmazonECS.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the RegisterContainerInstance service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
                     throws AmazonServiceExceptionAmazonClientException;

    

Describes the specified services running in your cluster.

Parameters:
describeServicesRequest Container for the necessary parameters to execute the DescribeServices operation on AmazonECS.
Returns:
A Java Future object containing the response from the DescribeServices service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
 
     public Future<DescribeServicesResultdescribeServicesAsync(DescribeServicesRequest describeServicesRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Describes the specified services running in your cluster.

Parameters:
describeServicesRequest Container for the necessary parameters to execute the DescribeServices operation on AmazonECS.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the DescribeServices service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
            AsyncHandler<DescribeServicesRequestDescribeServicesResultasyncHandler)
                    throws AmazonServiceExceptionAmazonClientException;

    

Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below desiredCount , Amazon ECS will spawn another instantiation of the task in the specified cluster.

Parameters:
createServiceRequest Container for the necessary parameters to execute the CreateService operation on AmazonECS.
Returns:
A Java Future object containing the response from the CreateService service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
    public Future<CreateServiceResultcreateServiceAsync(CreateServiceRequest createServiceRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below desiredCount , Amazon ECS will spawn another instantiation of the task in the specified cluster.

Parameters:
createServiceRequest Container for the necessary parameters to execute the CreateService operation on AmazonECS.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the CreateService service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
            AsyncHandler<CreateServiceRequestCreateServiceResultasyncHandler)
                    throws AmazonServiceExceptionAmazonClientException;

    

Lists the services that are running in a specified cluster.

Parameters:
listServicesRequest Container for the necessary parameters to execute the ListServices operation on AmazonECS.
Returns:
A Java Future object containing the response from the ListServices service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
    public Future<ListServicesResultlistServicesAsync(ListServicesRequest listServicesRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Lists the services that are running in a specified cluster.

Parameters:
listServicesRequest Container for the necessary parameters to execute the ListServices operation on AmazonECS.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the ListServices service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
    public Future<ListServicesResultlistServicesAsync(ListServicesRequest listServicesRequest,
            AsyncHandler<ListServicesRequestListServicesResultasyncHandler)
                    throws AmazonServiceExceptionAmazonClientException;

    

Modify the desired count or task definition used in a service.

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

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

Parameters:
updateServiceRequest Container for the necessary parameters to execute the UpdateService operation on AmazonECS.
Returns:
A Java Future object containing the response from the UpdateService service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
    public Future<UpdateServiceResultupdateServiceAsync(UpdateServiceRequest updateServiceRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Modify the desired count or task definition used in a service.

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

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

Parameters:
updateServiceRequest Container for the necessary parameters to execute the UpdateService operation on AmazonECS.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the UpdateService service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
            AsyncHandler<UpdateServiceRequestUpdateServiceResultasyncHandler)
                    throws AmazonServiceExceptionAmazonClientException;

    

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

Parameters:
listTaskDefinitionFamiliesRequest Container for the necessary parameters to execute the ListTaskDefinitionFamilies operation on AmazonECS.
Returns:
A Java Future object containing the response from the ListTaskDefinitionFamilies service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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

Parameters:
listTaskDefinitionFamiliesRequest Container for the necessary parameters to execute the ListTaskDefinitionFamilies operation on AmazonECS.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the ListTaskDefinitionFamilies service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
                    throws AmazonServiceExceptionAmazonClientException;

    

Describes a specified task or tasks.

Parameters:
describeTasksRequest Container for the necessary parameters to execute the DescribeTasks operation on AmazonECS.
Returns:
A Java Future object containing the response from the DescribeTasks service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
    public Future<DescribeTasksResultdescribeTasksAsync(DescribeTasksRequest describeTasksRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Describes a specified task or tasks.

Parameters:
describeTasksRequest Container for the necessary parameters to execute the DescribeTasks operation on AmazonECS.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the DescribeTasks service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
            AsyncHandler<DescribeTasksRequestDescribeTasksResultasyncHandler)
                    throws AmazonServiceExceptionAmazonClientException;

    

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

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

Parameters:
discoverPollEndpointRequest Container for the necessary parameters to execute the DiscoverPollEndpoint operation on AmazonECS.
Returns:
A Java Future object containing the response from the DiscoverPollEndpoint service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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

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

Parameters:
discoverPollEndpointRequest Container for the necessary parameters to execute the DiscoverPollEndpoint operation on AmazonECS.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the DiscoverPollEndpoint service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
                    throws AmazonServiceExceptionAmazonClientException;

    

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

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

Parameters:
startTaskRequest Container for the necessary parameters to execute the StartTask operation on AmazonECS.
Returns:
A Java Future object containing the response from the StartTask service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
    public Future<StartTaskResultstartTaskAsync(StartTaskRequest startTaskRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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

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

Parameters:
startTaskRequest Container for the necessary parameters to execute the StartTask operation on AmazonECS.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the StartTask service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
    public Future<StartTaskResultstartTaskAsync(StartTaskRequest startTaskRequest,
            AsyncHandler<StartTaskRequestStartTaskResultasyncHandler)
                    throws AmazonServiceExceptionAmazonClientException;

    

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

Parameters:
listTasksRequest Container for the necessary parameters to execute the ListTasks operation on AmazonECS.
Returns:
A Java Future object containing the response from the ListTasks service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
    public Future<ListTasksResultlistTasksAsync(ListTasksRequest listTasksRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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

Parameters:
listTasksRequest Container for the necessary parameters to execute the ListTasks operation on AmazonECS.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the ListTasks service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
    public Future<ListTasksResultlistTasksAsync(ListTasksRequest listTasksRequest,
            AsyncHandler<ListTasksRequestListTasksResultasyncHandler)
                    throws AmazonServiceExceptionAmazonClientException;

    

Stops a running task.

Parameters:
stopTaskRequest Container for the necessary parameters to execute the StopTask operation on AmazonECS.
Returns:
A Java Future object containing the response from the StopTask service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
    public Future<StopTaskResultstopTaskAsync(StopTaskRequest stopTaskRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Stops a running task.

Parameters:
stopTaskRequest Container for the necessary parameters to execute the StopTask operation on AmazonECS.
asyncHandler Asynchronous callback handler for events in the life-cycle of the request. Users could provide the implementation of the four callback methods in this interface to process the operation result or handle the exception.
Returns:
A Java Future object containing the response from the StopTask service method, as returned by AmazonECS.
Throws:
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonECS indicating either a problem with the data in the request, or a server side issue.
    public Future<StopTaskResultstopTaskAsync(StopTaskRequest stopTaskRequest,
            AsyncHandler<StopTaskRequestStopTaskResultasyncHandler)
                    throws AmazonServiceExceptionAmazonClientException;
}
        
New to GrepCode? Check out our FAQ X