AutoCloseable
@Generated("software.amazon.awssdk:codegen") public interface ECSClient extends AutoCloseable
builder()
method.
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.
Modifier and Type | Field | Description |
---|---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method | Description |
---|---|---|
static ECSClientBuilder |
builder() |
Create a builder that can be used to configure and create a
ECSClient . |
static ECSClient |
create() |
Create a
ECSClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateClusterResponse |
createCluster(CreateClusterRequest createClusterRequest) |
Creates a new Amazon ECS cluster.
|
default CreateServiceResponse |
createService(CreateServiceRequest createServiceRequest) |
Runs and maintains a desired number of tasks from a specified task definition.
|
default DeleteAttributesResponse |
deleteAttributes(DeleteAttributesRequest deleteAttributesRequest) |
Deletes one or more custom attributes from an Amazon ECS resource.
|
default DeleteClusterResponse |
deleteCluster(DeleteClusterRequest deleteClusterRequest) |
Deletes the specified cluster.
|
default DeleteServiceResponse |
deleteService(DeleteServiceRequest deleteServiceRequest) |
Deletes a specified service within a cluster.
|
default DeregisterContainerInstanceResponse |
deregisterContainerInstance(DeregisterContainerInstanceRequest deregisterContainerInstanceRequest) |
Deregisters an Amazon ECS container instance from the specified cluster.
|
default DeregisterTaskDefinitionResponse |
deregisterTaskDefinition(DeregisterTaskDefinitionRequest deregisterTaskDefinitionRequest) |
Deregisters the specified task definition by family and revision.
|
default DescribeClustersResponse |
describeClusters(DescribeClustersRequest describeClustersRequest) |
Describes one or more of your clusters.
|
default DescribeContainerInstancesResponse |
describeContainerInstances(DescribeContainerInstancesRequest describeContainerInstancesRequest) |
Describes Amazon EC2 Container Service container instances.
|
default DescribeServicesResponse |
describeServices(DescribeServicesRequest describeServicesRequest) |
Describes the specified services running in your cluster.
|
default DescribeTaskDefinitionResponse |
describeTaskDefinition(DescribeTaskDefinitionRequest describeTaskDefinitionRequest) |
Describes a task definition.
|
default DescribeTasksResponse |
describeTasks(DescribeTasksRequest describeTasksRequest) |
Describes a specified task or tasks.
|
default DiscoverPollEndpointResponse |
discoverPollEndpoint(DiscoverPollEndpointRequest discoverPollEndpointRequest) |
|
default ListAttributesResponse |
listAttributes(ListAttributesRequest listAttributesRequest) |
Lists the attributes for Amazon ECS resources within a specified target type and cluster.
|
default ListClustersResponse |
listClusters(ListClustersRequest listClustersRequest) |
Returns a list of existing clusters.
|
default ListContainerInstancesResponse |
listContainerInstances(ListContainerInstancesRequest listContainerInstancesRequest) |
Returns a list of container instances in a specified cluster.
|
default ListServicesResponse |
listServices(ListServicesRequest listServicesRequest) |
Lists the services that are running in a specified cluster.
|
default ListTaskDefinitionFamiliesResponse |
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). |
default ListTaskDefinitionsResponse |
listTaskDefinitions(ListTaskDefinitionsRequest listTaskDefinitionsRequest) |
Returns a list of task definitions that are registered to your account.
|
default ListTasksResponse |
listTasks(ListTasksRequest listTasksRequest) |
Returns a list of tasks for a specified cluster.
|
default PutAttributesResponse |
putAttributes(PutAttributesRequest putAttributesRequest) |
Create or update an attribute on an Amazon ECS resource.
|
default RegisterContainerInstanceResponse |
registerContainerInstance(RegisterContainerInstanceRequest registerContainerInstanceRequest) |
|
default RegisterTaskDefinitionResponse |
registerTaskDefinition(RegisterTaskDefinitionRequest registerTaskDefinitionRequest) |
Registers a new task definition from the supplied
family and containerDefinitions . |
default RunTaskResponse |
runTask(RunTaskRequest runTaskRequest) |
Starts a new task using the specified task definition.
|
static ServiceMetadata |
serviceMetadata() |
|
default StartTaskResponse |
startTask(StartTaskRequest startTaskRequest) |
Starts a new task from the specified task definition on the specified container instance or instances.
|
default StopTaskResponse |
stopTask(StopTaskRequest stopTaskRequest) |
Stops a running task.
|
default SubmitContainerStateChangeResponse |
submitContainerStateChange(SubmitContainerStateChangeRequest submitContainerStateChangeRequest) |
|
default SubmitTaskStateChangeResponse |
submitTaskStateChange(SubmitTaskStateChangeRequest submitTaskStateChangeRequest) |
|
default UpdateContainerAgentResponse |
updateContainerAgent(UpdateContainerAgentRequest updateContainerAgentRequest) |
Updates the Amazon ECS container agent on a specified container instance.
|
default UpdateContainerInstancesStateResponse |
updateContainerInstancesState(UpdateContainerInstancesStateRequest updateContainerInstancesStateRequest) |
Modifies the status of an Amazon ECS container instance.
|
default UpdateServiceResponse |
updateService(UpdateServiceRequest updateServiceRequest) |
Modifies the desired count, deployment configuration, or task definition used in a service.
|
ECSClientWaiters |
waiters() |
close
static final String SERVICE_NAME
static ECSClient create()
ECSClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static ECSClientBuilder builder()
ECSClient
.default CreateClusterResponse createCluster(CreateClusterRequest createClusterRequest) throws ServerException, ClientException, InvalidParameterException, SdkBaseException, SdkClientException, ECSException
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.
createClusterRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateServiceResponse createService(CreateServiceRequest createServiceRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, SdkBaseException, SdkClientException, ECSException
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 copy 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. For more information, see Service Load Balancing in the Amazon EC2 Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. During a deployment (which is triggered
by changing the task definition or the desired count of a service with an UpdateService operation), the
service scheduler uses the minimumHealthyPercent
and maximumPercent
parameters to
determine the deployment strategy.
The minimumHealthyPercent
represents a lower limit on the number of your service's tasks that must
remain in the RUNNING
state during a deployment, as a percentage of the desiredCount
(rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster
capacity. For example, if your service has a desiredCount
of four tasks and a
minimumHealthyPercent
of 50%, the scheduler can stop two existing tasks to free up cluster capacity
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 they are 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 your service's tasks that
are allowed in the RUNNING
or PENDING
state during a deployment, as a percentage of the
desiredCount
(rounded down to the nearest integer). This parameter enables you to define the
deployment batch size. For example, if your service has a desiredCount
of four tasks and a
maximumPercent
value of 200%, the scheduler can start 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 determines task placement in your cluster using 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).
By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although
you can choose a different placement strategy) with the placementStrategy
parameter):
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.
createServiceRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteAttributesResponse deleteAttributes(DeleteAttributesRequest deleteAttributesRequest) throws ClusterNotFoundException, TargetNotFoundException, InvalidParameterException, SdkBaseException, SdkClientException, ECSException
Deletes one or more custom attributes from an Amazon ECS resource.
deleteAttributesRequest
- ClusterNotFoundException
- The specified cluster could not be found. You can view your available clusters with ListClusters.
Amazon ECS clusters are region-specific.TargetNotFoundException
- The specified target could not be found. You can view your available container instances with
ListContainerInstances. Amazon ECS container instances are cluster-specific and region-specific.InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteClusterResponse deleteCluster(DeleteClusterRequest deleteClusterRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ClusterContainsContainerInstancesException, ClusterContainsServicesException, SdkBaseException, SdkClientException, ECSException
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.
deleteClusterRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteServiceResponse deleteService(DeleteServiceRequest deleteServiceRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ServiceNotFoundException, SdkBaseException, SdkClientException, ECSException
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.
deleteServiceRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeregisterContainerInstanceResponse deregisterContainerInstance(DeregisterContainerInstanceRequest deregisterContainerInstanceRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, SdkBaseException, SdkClientException, ECSException
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, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated).
deregisterContainerInstanceRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeregisterTaskDefinitionResponse deregisterTaskDefinition(DeregisterTaskDefinitionRequest deregisterTaskDefinitionRequest) throws ServerException, ClientException, InvalidParameterException, SdkBaseException, SdkClientException, ECSException
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).
At this time, INACTIVE
task definitions remain discoverable in your account indefinitely; however,
this behavior is subject to change in the future, so you should not rely on INACTIVE
task
definitions persisting beyond the life cycle of any associated tasks and services.
deregisterTaskDefinitionRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeClustersResponse describeClusters(DescribeClustersRequest describeClustersRequest) throws ServerException, ClientException, InvalidParameterException, SdkBaseException, SdkClientException, ECSException
Describes one or more of your clusters.
describeClustersRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeContainerInstancesResponse describeContainerInstances(DescribeContainerInstancesRequest describeContainerInstancesRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, SdkBaseException, SdkClientException, ECSException
Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
describeContainerInstancesRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeServicesResponse describeServices(DescribeServicesRequest describeServicesRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, SdkBaseException, SdkClientException, ECSException
Describes the specified services running in your cluster.
describeServicesRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeTaskDefinitionResponse describeTaskDefinition(DescribeTaskDefinitionRequest describeTaskDefinitionRequest) throws ServerException, ClientException, InvalidParameterException, SdkBaseException, SdkClientException, ECSException
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.
describeTaskDefinitionRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeTasksResponse describeTasks(DescribeTasksRequest describeTasksRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, SdkBaseException, SdkClientException, ECSException
Describes a specified task or tasks.
describeTasksRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DiscoverPollEndpointResponse discoverPollEndpoint(DiscoverPollEndpointRequest discoverPollEndpointRequest) throws ServerException, ClientException, SdkBaseException, SdkClientException, ECSException
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.
discoverPollEndpointRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListAttributesResponse listAttributes(ListAttributesRequest listAttributesRequest) throws ClusterNotFoundException, InvalidParameterException, SdkBaseException, SdkClientException, ECSException
Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a
target type and cluster, ListAttributes
returns a list of attribute objects, one for each attribute
on each resource. You can filter the list of results to a single attribute name to only return results that have
that name. You can also filter the results by attribute name and value, for example, to see which container
instances in a cluster are running a Linux AMI (ecs.os-type=linux
).
listAttributesRequest
- ClusterNotFoundException
- The specified cluster could not be found. You can view your available clusters with ListClusters.
Amazon ECS clusters are region-specific.InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListClustersResponse listClusters(ListClustersRequest listClustersRequest) throws ServerException, ClientException, InvalidParameterException, SdkBaseException, SdkClientException, ECSException
Returns a list of existing clusters.
listClustersRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListContainerInstancesResponse listContainerInstances(ListContainerInstancesRequest listContainerInstancesRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, SdkBaseException, SdkClientException, ECSException
Returns a list of container instances in a specified cluster. You can filter the results of a
ListContainerInstances
operation with cluster query language statements inside the
filter
parameter. For more information, see Cluster Query
Language in the Amazon EC2 Container Service Developer Guide.
listContainerInstancesRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListServicesResponse listServices(ListServicesRequest listServicesRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, SdkBaseException, SdkClientException, ECSException
Lists the services that are running in a specified cluster.
listServicesRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListTaskDefinitionFamiliesResponse listTaskDefinitionFamilies(ListTaskDefinitionFamiliesRequest listTaskDefinitionFamiliesRequest) throws ServerException, ClientException, InvalidParameterException, SdkBaseException, SdkClientException, ECSException
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.
listTaskDefinitionFamiliesRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListTaskDefinitionsResponse listTaskDefinitions(ListTaskDefinitionsRequest listTaskDefinitionsRequest) throws ServerException, ClientException, InvalidParameterException, SdkBaseException, SdkClientException, ECSException
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.
listTaskDefinitionsRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListTasksResponse listTasks(ListTasksRequest listTasksRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ServiceNotFoundException, SdkBaseException, SdkClientException, ECSException
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.
Recently-stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour.
listTasksRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault PutAttributesResponse putAttributes(PutAttributesRequest putAttributesRequest) throws ClusterNotFoundException, TargetNotFoundException, AttributeLimitExceededException, InvalidParameterException, SdkBaseException, SdkClientException, ECSException
Create or update an attribute on an Amazon ECS resource. If the attribute does not exist, it is created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes in the Amazon EC2 Container Service Developer Guide.
putAttributesRequest
- ClusterNotFoundException
- The specified cluster could not be found. You can view your available clusters with ListClusters.
Amazon ECS clusters are region-specific.TargetNotFoundException
- The specified target could not be found. You can view your available container instances with
ListContainerInstances. Amazon ECS container instances are cluster-specific and region-specific.AttributeLimitExceededException
- You can apply up to 10 custom attributes per resource. You can view the attributes of a resource with
ListAttributes. You can remove existing attributes on a resource with DeleteAttributes.InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RegisterContainerInstanceResponse registerContainerInstance(RegisterContainerInstanceRequest registerContainerInstanceRequest) throws ServerException, ClientException, SdkBaseException, SdkClientException, ECSException
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.
registerContainerInstanceRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RegisterTaskDefinitionResponse registerTaskDefinition(RegisterTaskDefinitionRequest registerTaskDefinitionRequest) throws ServerException, ClientException, InvalidParameterException, SdkBaseException, SdkClientException, ECSException
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.
You can specify an IAM role for your task with the taskRoleArn
parameter. When you specify an IAM
role for a task, its containers can then use the latest versions of the AWS CLI or SDKs to make API requests to
the AWS services that are specified in the IAM policy associated with the role. For more information, see IAM Roles for Tasks in
the Amazon EC2 Container Service Developer Guide.
You can specify a Docker networking mode for the containers in your task definition with the
networkMode
parameter. The available network modes correspond to those described in Network settings in the Docker run
reference.
registerTaskDefinitionRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RunTaskResponse runTask(RunTaskRequest runTaskRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, SdkBaseException, SdkClientException, ECSException
Starts a new task using the specified task definition.
You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon EC2 Container Service Developer Guide.
Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.
runTaskRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault StartTaskResponse startTask(StartTaskRequest startTaskRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, SdkBaseException, SdkClientException, ECSException
Starts a new task from the specified task definition on the specified container instance or instances.
Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon EC2 Container Service Developer Guide.
startTaskRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault StopTaskResponse stopTask(StopTaskRequest stopTaskRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, SdkBaseException, SdkClientException, ECSException
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 default 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.
The default 30-second timeout can be configured on the Amazon ECS container agent with the
ECS_CONTAINER_STOP_TIMEOUT
variable. For more information, see Amazon ECS Container
Agent Configuration in the Amazon EC2 Container Service Developer Guide.
stopTaskRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault SubmitContainerStateChangeResponse submitContainerStateChange(SubmitContainerStateChangeRequest submitContainerStateChangeRequest) throws ServerException, ClientException, SdkBaseException, SdkClientException, ECSException
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.
submitContainerStateChangeRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault SubmitTaskStateChangeResponse submitTaskStateChange(SubmitTaskStateChangeRequest submitTaskStateChangeRequest) throws ServerException, ClientException, SdkBaseException, SdkClientException, ECSException
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.
submitTaskStateChangeRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateContainerAgentResponse updateContainerAgent(UpdateContainerAgentRequest updateContainerAgentRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, UpdateInProgressException, NoUpdateAvailableException, MissingVersionException, SdkBaseException, SdkClientException, ECSException
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.
updateContainerAgentRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateContainerInstancesStateResponse updateContainerInstancesState(UpdateContainerInstancesStateRequest updateContainerInstancesStateRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, SdkBaseException, SdkClientException, ECSException
Modifies the status of an Amazon ECS container instance.
You can change the status of a container instance to DRAINING
to manually remove an instance from a
cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size.
When you set a container instance to DRAINING
, Amazon ECS prevents new tasks from being scheduled
for placement on the container instance and replacement service tasks are started on other container instances in
the cluster if the resources are available. Service tasks on the container instance that are in the
PENDING
state are stopped immediately.
Service tasks on the container instance that are in the RUNNING
state are stopped and replaced
according the service's deployment configuration parameters, minimumHealthyPercent
and
maximumPercent
. Note that you can change the deployment configuration of your service using
UpdateService.
If minimumHealthyPercent
is below 100%, the scheduler can ignore desiredCount
temporarily during task replacement. For example, desiredCount
is four tasks, a minimum of 50%
allows the scheduler to stop two existing tasks before starting two new tasks. If the minimum is 100%, the
service scheduler can't remove existing tasks until the replacement tasks are considered healthy. Tasks for
services that do not use a load balancer are considered healthy if they are in the RUNNING
state.
Tasks for services that use a load balancer are considered healthy if they are in the RUNNING
state
and the container instance they are hosted on is reported as healthy by the load balancer.
The maximumPercent
parameter represents an upper limit on the number of running tasks during task
replacement, which enables you to define the replacement batch size. For example, if desiredCount
of
four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained (provided that
the cluster resources required to do this are available). If the maximum is 100%, then replacement tasks can't
start until the draining tasks have stopped.
Any PENDING
or RUNNING
tasks that do not belong to a service are not affected; you must
wait for them to finish or stop them manually.
A container instance has completed draining when it has no more RUNNING
tasks. You can verify this
using ListTasks.
When you set a container instance to ACTIVE
, the Amazon ECS scheduler can begin scheduling tasks on
the instance again.
updateContainerInstancesStateRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateServiceResponse updateService(UpdateServiceRequest updateServiceRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ServiceNotFoundException, ServiceNotActiveException, SdkBaseException, SdkClientException, ECSException
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 minimumHealthyPercent
is below 100%, the scheduler can ignore desiredCount
temporarily during a deployment. For example, if desiredCount
is four tasks, a minimum 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 use a load
balancer are considered healthy if they are in the RUNNING
state and the container instance they are
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 desiredCount
is
four tasks, a maximum 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 determines task placement 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).
By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy):
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.
When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:
Sort the container instances by the largest 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 two, container instances in either zone B or C are considered optimal for termination.
Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service.
updateServiceRequest
- 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.SdkBaseException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc)ECSException
- Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typestatic ServiceMetadata serviceMetadata()
ECSClientWaiters waiters()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.