@Generated(value="software.amazon.awssdk:codegen") public interface EcsClient extends SdkClient
builder()
method.
Amazon Elastic 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. You can host your cluster on a serverless infrastructure that is managed by Amazon ECS by launching your services or tasks using the Fargate launch type. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage by using the EC2 launch type. For more information about launch types, see Amazon ECS Launch Types.
Amazon ECS lets you launch and stop container-based 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.
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 ECS 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 and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and 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()
Creates a new Amazon ECS cluster.
|
default CreateClusterResponse |
createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)
Creates a new Amazon ECS cluster.
|
default CreateClusterResponse |
createCluster(CreateClusterRequest createClusterRequest)
Creates a new Amazon ECS cluster.
|
default CreateServiceResponse |
createService(Consumer<CreateServiceRequest.Builder> createServiceRequest)
Runs and maintains a desired number of tasks from a specified task definition.
|
default CreateServiceResponse |
createService(CreateServiceRequest createServiceRequest)
Runs and maintains a desired number of tasks from a specified task definition.
|
default DeleteAccountSettingResponse |
deleteAccountSetting(Consumer<DeleteAccountSettingRequest.Builder> deleteAccountSettingRequest)
Modifies the ARN and resource ID format of a resource for a specified IAM user, IAM role, or the root user for an
account.
|
default DeleteAccountSettingResponse |
deleteAccountSetting(DeleteAccountSettingRequest deleteAccountSettingRequest)
Modifies the ARN and resource ID format of a resource for a specified IAM user, IAM role, or the root user for an
account.
|
default DeleteAttributesResponse |
deleteAttributes(Consumer<DeleteAttributesRequest.Builder> deleteAttributesRequest)
Deletes one or more custom attributes from an Amazon ECS resource.
|
default DeleteAttributesResponse |
deleteAttributes(DeleteAttributesRequest deleteAttributesRequest)
Deletes one or more custom attributes from an Amazon ECS resource.
|
default DeleteClusterResponse |
deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)
Deletes the specified cluster.
|
default DeleteClusterResponse |
deleteCluster(DeleteClusterRequest deleteClusterRequest)
Deletes the specified cluster.
|
default DeleteServiceResponse |
deleteService(Consumer<DeleteServiceRequest.Builder> deleteServiceRequest)
Deletes a specified service within a cluster.
|
default DeleteServiceResponse |
deleteService(DeleteServiceRequest deleteServiceRequest)
Deletes a specified service within a cluster.
|
default DeregisterContainerInstanceResponse |
deregisterContainerInstance(Consumer<DeregisterContainerInstanceRequest.Builder> deregisterContainerInstanceRequest)
Deregisters an Amazon ECS container instance from the specified cluster.
|
default DeregisterContainerInstanceResponse |
deregisterContainerInstance(DeregisterContainerInstanceRequest deregisterContainerInstanceRequest)
Deregisters an Amazon ECS container instance from the specified cluster.
|
default DeregisterTaskDefinitionResponse |
deregisterTaskDefinition(Consumer<DeregisterTaskDefinitionRequest.Builder> deregisterTaskDefinitionRequest)
Deregisters the specified task definition by family and revision.
|
default DeregisterTaskDefinitionResponse |
deregisterTaskDefinition(DeregisterTaskDefinitionRequest deregisterTaskDefinitionRequest)
Deregisters the specified task definition by family and revision.
|
default DescribeClustersResponse |
describeClusters()
Describes one or more of your clusters.
|
default DescribeClustersResponse |
describeClusters(Consumer<DescribeClustersRequest.Builder> describeClustersRequest)
Describes one or more of your clusters.
|
default DescribeClustersResponse |
describeClusters(DescribeClustersRequest describeClustersRequest)
Describes one or more of your clusters.
|
default DescribeContainerInstancesResponse |
describeContainerInstances(Consumer<DescribeContainerInstancesRequest.Builder> describeContainerInstancesRequest)
Describes Amazon Elastic Container Service container instances.
|
default DescribeContainerInstancesResponse |
describeContainerInstances(DescribeContainerInstancesRequest describeContainerInstancesRequest)
Describes Amazon Elastic Container Service container instances.
|
default DescribeServicesResponse |
describeServices(Consumer<DescribeServicesRequest.Builder> describeServicesRequest)
Describes the specified services running in your cluster.
|
default DescribeServicesResponse |
describeServices(DescribeServicesRequest describeServicesRequest)
Describes the specified services running in your cluster.
|
default DescribeTaskDefinitionResponse |
describeTaskDefinition(Consumer<DescribeTaskDefinitionRequest.Builder> describeTaskDefinitionRequest)
Describes a task definition.
|
default DescribeTaskDefinitionResponse |
describeTaskDefinition(DescribeTaskDefinitionRequest describeTaskDefinitionRequest)
Describes a task definition.
|
default DescribeTasksResponse |
describeTasks(Consumer<DescribeTasksRequest.Builder> describeTasksRequest)
Describes a specified task or tasks.
|
default DescribeTasksResponse |
describeTasks(DescribeTasksRequest describeTasksRequest)
Describes a specified task or tasks.
|
default DiscoverPollEndpointResponse |
discoverPollEndpoint(Consumer<DiscoverPollEndpointRequest.Builder> discoverPollEndpointRequest)
|
default DiscoverPollEndpointResponse |
discoverPollEndpoint(DiscoverPollEndpointRequest discoverPollEndpointRequest)
|
default ListAccountSettingsResponse |
listAccountSettings()
Lists the account settings for an Amazon ECS resource for a specified principal.
|
default ListAccountSettingsResponse |
listAccountSettings(Consumer<ListAccountSettingsRequest.Builder> listAccountSettingsRequest)
Lists the account settings for an Amazon ECS resource for a specified principal.
|
default ListAccountSettingsResponse |
listAccountSettings(ListAccountSettingsRequest listAccountSettingsRequest)
Lists the account settings for an Amazon ECS resource for a specified principal.
|
default ListAttributesResponse |
listAttributes(Consumer<ListAttributesRequest.Builder> listAttributesRequest)
Lists the attributes for Amazon ECS resources within a specified target type and cluster.
|
default ListAttributesResponse |
listAttributes(ListAttributesRequest listAttributesRequest)
Lists the attributes for Amazon ECS resources within a specified target type and cluster.
|
default ListClustersResponse |
listClusters()
Returns a list of existing clusters.
|
default ListClustersResponse |
listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)
Returns a list of existing clusters.
|
default ListClustersResponse |
listClusters(ListClustersRequest listClustersRequest)
Returns a list of existing clusters.
|
default ListClustersIterable |
listClustersPaginator()
Returns a list of existing clusters.
|
default ListClustersIterable |
listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest)
Returns a list of existing clusters.
|
default ListClustersIterable |
listClustersPaginator(ListClustersRequest listClustersRequest)
Returns a list of existing clusters.
|
default ListContainerInstancesResponse |
listContainerInstances()
Returns a list of container instances in a specified cluster.
|
default ListContainerInstancesResponse |
listContainerInstances(Consumer<ListContainerInstancesRequest.Builder> listContainerInstancesRequest)
Returns a list of container instances in a specified cluster.
|
default ListContainerInstancesResponse |
listContainerInstances(ListContainerInstancesRequest listContainerInstancesRequest)
Returns a list of container instances in a specified cluster.
|
default ListContainerInstancesIterable |
listContainerInstancesPaginator()
Returns a list of container instances in a specified cluster.
|
default ListContainerInstancesIterable |
listContainerInstancesPaginator(Consumer<ListContainerInstancesRequest.Builder> listContainerInstancesRequest)
Returns a list of container instances in a specified cluster.
|
default ListContainerInstancesIterable |
listContainerInstancesPaginator(ListContainerInstancesRequest listContainerInstancesRequest)
Returns a list of container instances in a specified cluster.
|
default ListServicesResponse |
listServices()
Lists the services that are running in a specified cluster.
|
default ListServicesResponse |
listServices(Consumer<ListServicesRequest.Builder> listServicesRequest)
Lists the services that are running in a specified cluster.
|
default ListServicesResponse |
listServices(ListServicesRequest listServicesRequest)
Lists the services that are running in a specified cluster.
|
default ListServicesIterable |
listServicesPaginator()
Lists the services that are running in a specified cluster.
|
default ListServicesIterable |
listServicesPaginator(Consumer<ListServicesRequest.Builder> listServicesRequest)
Lists the services that are running in a specified cluster.
|
default ListServicesIterable |
listServicesPaginator(ListServicesRequest listServicesRequest)
Lists the services that are running in a specified cluster.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
List the tags for an Amazon ECS resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List the tags for an Amazon ECS resource.
|
default ListTaskDefinitionFamiliesResponse |
listTaskDefinitionFamilies()
Returns a list of task definition families that are registered to your account (which may include task definition
families that no longer have any
ACTIVE task definition revisions). |
default ListTaskDefinitionFamiliesResponse |
listTaskDefinitionFamilies(Consumer<ListTaskDefinitionFamiliesRequest.Builder> 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 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 ListTaskDefinitionFamiliesIterable |
listTaskDefinitionFamiliesPaginator()
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 ListTaskDefinitionFamiliesIterable |
listTaskDefinitionFamiliesPaginator(Consumer<ListTaskDefinitionFamiliesRequest.Builder> 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 ListTaskDefinitionFamiliesIterable |
listTaskDefinitionFamiliesPaginator(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()
Returns a list of task definitions that are registered to your account.
|
default ListTaskDefinitionsResponse |
listTaskDefinitions(Consumer<ListTaskDefinitionsRequest.Builder> listTaskDefinitionsRequest)
Returns a list of task definitions that are registered to your account.
|
default ListTaskDefinitionsResponse |
listTaskDefinitions(ListTaskDefinitionsRequest listTaskDefinitionsRequest)
Returns a list of task definitions that are registered to your account.
|
default ListTaskDefinitionsIterable |
listTaskDefinitionsPaginator()
Returns a list of task definitions that are registered to your account.
|
default ListTaskDefinitionsIterable |
listTaskDefinitionsPaginator(Consumer<ListTaskDefinitionsRequest.Builder> listTaskDefinitionsRequest)
Returns a list of task definitions that are registered to your account.
|
default ListTaskDefinitionsIterable |
listTaskDefinitionsPaginator(ListTaskDefinitionsRequest listTaskDefinitionsRequest)
Returns a list of task definitions that are registered to your account.
|
default ListTasksResponse |
listTasks()
Returns a list of tasks for a specified cluster.
|
default ListTasksResponse |
listTasks(Consumer<ListTasksRequest.Builder> listTasksRequest)
Returns a list of tasks for a specified cluster.
|
default ListTasksResponse |
listTasks(ListTasksRequest listTasksRequest)
Returns a list of tasks for a specified cluster.
|
default ListTasksIterable |
listTasksPaginator()
Returns a list of tasks for a specified cluster.
|
default ListTasksIterable |
listTasksPaginator(Consumer<ListTasksRequest.Builder> listTasksRequest)
Returns a list of tasks for a specified cluster.
|
default ListTasksIterable |
listTasksPaginator(ListTasksRequest listTasksRequest)
Returns a list of tasks for a specified cluster.
|
default PutAccountSettingResponse |
putAccountSetting(Consumer<PutAccountSettingRequest.Builder> putAccountSettingRequest)
Modifies the ARN and resource ID format of a resource for a specified IAM user, IAM role, or the root user for an
account.
|
default PutAccountSettingResponse |
putAccountSetting(PutAccountSettingRequest putAccountSettingRequest)
Modifies the ARN and resource ID format of a resource for a specified IAM user, IAM role, or the root user for an
account.
|
default PutAttributesResponse |
putAttributes(Consumer<PutAttributesRequest.Builder> putAttributesRequest)
Create or update an attribute on an Amazon ECS resource.
|
default PutAttributesResponse |
putAttributes(PutAttributesRequest putAttributesRequest)
Create or update an attribute on an Amazon ECS resource.
|
default RegisterContainerInstanceResponse |
registerContainerInstance(Consumer<RegisterContainerInstanceRequest.Builder> registerContainerInstanceRequest)
|
default RegisterContainerInstanceResponse |
registerContainerInstance(RegisterContainerInstanceRequest registerContainerInstanceRequest)
|
default RegisterTaskDefinitionResponse |
registerTaskDefinition(Consumer<RegisterTaskDefinitionRequest.Builder> registerTaskDefinitionRequest)
Registers a new task definition from the supplied
family and containerDefinitions . |
default RegisterTaskDefinitionResponse |
registerTaskDefinition(RegisterTaskDefinitionRequest registerTaskDefinitionRequest)
Registers a new task definition from the supplied
family and containerDefinitions . |
default RunTaskResponse |
runTask(Consumer<RunTaskRequest.Builder> runTaskRequest)
Starts a new task using the specified task definition.
|
default RunTaskResponse |
runTask(RunTaskRequest runTaskRequest)
Starts a new task using the specified task definition.
|
static ServiceMetadata |
serviceMetadata() |
default StartTaskResponse |
startTask(Consumer<StartTaskRequest.Builder> startTaskRequest)
Starts a new task from the specified task definition on the specified container instance or instances.
|
default StartTaskResponse |
startTask(StartTaskRequest startTaskRequest)
Starts a new task from the specified task definition on the specified container instance or instances.
|
default StopTaskResponse |
stopTask(Consumer<StopTaskRequest.Builder> stopTaskRequest)
Stops a running task.
|
default StopTaskResponse |
stopTask(StopTaskRequest stopTaskRequest)
Stops a running task.
|
default SubmitContainerStateChangeResponse |
submitContainerStateChange(Consumer<SubmitContainerStateChangeRequest.Builder> submitContainerStateChangeRequest)
|
default SubmitContainerStateChangeResponse |
submitContainerStateChange(SubmitContainerStateChangeRequest submitContainerStateChangeRequest)
|
default SubmitTaskStateChangeResponse |
submitTaskStateChange(Consumer<SubmitTaskStateChangeRequest.Builder> submitTaskStateChangeRequest)
|
default SubmitTaskStateChangeResponse |
submitTaskStateChange(SubmitTaskStateChangeRequest submitTaskStateChangeRequest)
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Associates the specified tags to a resource with the specified
resourceArn . |
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Associates the specified tags to a resource with the specified
resourceArn . |
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Deletes specified tags from a resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Deletes specified tags from a resource.
|
default UpdateContainerAgentResponse |
updateContainerAgent(Consumer<UpdateContainerAgentRequest.Builder> updateContainerAgentRequest)
Updates the Amazon ECS container agent on a specified container instance.
|
default UpdateContainerAgentResponse |
updateContainerAgent(UpdateContainerAgentRequest updateContainerAgentRequest)
Updates the Amazon ECS container agent on a specified container instance.
|
default UpdateContainerInstancesStateResponse |
updateContainerInstancesState(Consumer<UpdateContainerInstancesStateRequest.Builder> updateContainerInstancesStateRequest)
Modifies the status of an Amazon ECS container instance.
|
default UpdateContainerInstancesStateResponse |
updateContainerInstancesState(UpdateContainerInstancesStateRequest updateContainerInstancesStateRequest)
Modifies the status of an Amazon ECS container instance.
|
default UpdateServiceResponse |
updateService(Consumer<UpdateServiceRequest.Builder> updateServiceRequest)
Modifies the parameters of a service.
|
default UpdateServiceResponse |
updateService(UpdateServiceRequest updateServiceRequest)
Modifies the parameters of a service.
|
serviceName
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() throws ServerException, ClientException, InvalidParameterException, AwsServiceException, 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.
When you call the CreateCluster API operation, Amazon ECS attempts to create the service-linked role for your account so that required resources in other AWS services can be managed on your behalf. However, if the IAM user that makes the call does not have permissions to create the service-linked role, it is not created. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
createCluster(CreateClusterRequest)
,
AWS API
Documentationdefault CreateClusterResponse createCluster(CreateClusterRequest createClusterRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, 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.
When you call the CreateCluster API operation, Amazon ECS attempts to create the service-linked role for your account so that required resources in other AWS services can be managed on your behalf. However, if the IAM user that makes the call does not have permissions to create the service-linked role, it is not created. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateClusterResponse createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, 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.
When you call the CreateCluster API operation, Amazon ECS attempts to create the service-linked role for your account so that required resources in other AWS services can be managed on your behalf. However, if the IAM user that makes the call does not have permissions to create the service-linked role, it is not created. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
This is a convenience which creates an instance of the CreateClusterRequest.Builder
avoiding the need to
create one manually via CreateClusterRequest.builder()
createClusterRequest
- A Consumer
that will call methods on CreateClusterRequest.Builder
to create a request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateServiceResponse createService(CreateServiceRequest createServiceRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, UnsupportedFeatureException, PlatformUnknownException, PlatformTaskDefinitionIncompatibilityException, AccessDeniedException, AwsServiceException, 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 Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment is triggered by changing properties, such as the task definition or the desired count of a service, with an UpdateService operation.
If a service is using the ECS
deployment controller, the minimum healthy percent represents a
lower limit on the number of tasks in a service that must remain in the RUNNING
state during a
deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any
container instances are in the DRAINING
state if the service contains tasks using the EC2 launch
type. This parameter enables you to deploy without using additional cluster capacity. For example, if your
service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may 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 they are
reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.
If a service is using the ECS
deployment controller, the maximum percent parameter represents
an upper limit on the number of tasks in a service that are allowed in the RUNNING
or
PENDING
state during a deployment, as a percentage of the desired number of tasks (rounded down to
the nearest integer), and while any container instances are in the DRAINING
state if the service
contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For
example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler
may 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 maximum percent is 200%.
If a service is using the CODE_DEPLOY
deployment controller and tasks that use the EC2 launch type,
the minimum healthy percent and maximum percent values are only used to define the lower and upper
limit on the number of the tasks in the service that remain in the RUNNING
state while the container
instances are in the DRAINING
state. If the tasks in the service use the Fargate launch type, the
minimum healthy percent and maximum percent values are not used, although they are currently visible when
describing your service.
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 a replica service for minimumHealthyPercent
is 100%. The
default value for a daemon service for minimumHealthyPercent
is 0%.
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, giving priority to instances that have the fewest number of running tasks for this service in their respective Availability Zone. 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 permissions 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.UnsupportedFeatureException
- The specified task is not supported in this Region.PlatformUnknownException
- The specified platform version does not exist.PlatformTaskDefinitionIncompatibilityException
- The specified platform version does not satisfy the task definition's required capabilities.AccessDeniedException
- You do not have authorization to perform the requested action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateServiceResponse createService(Consumer<CreateServiceRequest.Builder> createServiceRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, UnsupportedFeatureException, PlatformUnknownException, PlatformTaskDefinitionIncompatibilityException, AccessDeniedException, AwsServiceException, 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 Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment is triggered by changing properties, such as the task definition or the desired count of a service, with an UpdateService operation.
If a service is using the ECS
deployment controller, the minimum healthy percent represents a
lower limit on the number of tasks in a service that must remain in the RUNNING
state during a
deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any
container instances are in the DRAINING
state if the service contains tasks using the EC2 launch
type. This parameter enables you to deploy without using additional cluster capacity. For example, if your
service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may 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 they are
reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.
If a service is using the ECS
deployment controller, the maximum percent parameter represents
an upper limit on the number of tasks in a service that are allowed in the RUNNING
or
PENDING
state during a deployment, as a percentage of the desired number of tasks (rounded down to
the nearest integer), and while any container instances are in the DRAINING
state if the service
contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For
example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler
may 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 maximum percent is 200%.
If a service is using the CODE_DEPLOY
deployment controller and tasks that use the EC2 launch type,
the minimum healthy percent and maximum percent values are only used to define the lower and upper
limit on the number of the tasks in the service that remain in the RUNNING
state while the container
instances are in the DRAINING
state. If the tasks in the service use the Fargate launch type, the
minimum healthy percent and maximum percent values are not used, although they are currently visible when
describing your service.
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 a replica service for minimumHealthyPercent
is 100%. The
default value for a daemon service for minimumHealthyPercent
is 0%.
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, giving priority to instances that have the fewest number of running tasks for this service in their respective Availability Zone. 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.
This is a convenience which creates an instance of the CreateServiceRequest.Builder
avoiding the need to
create one manually via CreateServiceRequest.builder()
createServiceRequest
- A Consumer
that will call methods on CreateServiceRequest.Builder
to create a request.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 permissions 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.UnsupportedFeatureException
- The specified task is not supported in this Region.PlatformUnknownException
- The specified platform version does not exist.PlatformTaskDefinitionIncompatibilityException
- The specified platform version does not satisfy the task definition's required capabilities.AccessDeniedException
- You do not have authorization to perform the requested action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteAccountSettingResponse deleteAccountSetting(DeleteAccountSettingRequest deleteAccountSettingRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException
Modifies the ARN and resource ID format of a resource for a specified IAM user, IAM role, or the root user for an account. You can specify whether the new ARN and resource ID format are disabled for new resources that are created.
deleteAccountSettingRequest
- 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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteAccountSettingResponse deleteAccountSetting(Consumer<DeleteAccountSettingRequest.Builder> deleteAccountSettingRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException
Modifies the ARN and resource ID format of a resource for a specified IAM user, IAM role, or the root user for an account. You can specify whether the new ARN and resource ID format are disabled for new resources that are created.
This is a convenience which creates an instance of the DeleteAccountSettingRequest.Builder
avoiding the
need to create one manually via DeleteAccountSettingRequest.builder()
deleteAccountSettingRequest
- A Consumer
that will call methods on DeleteAccountSettingRequest.Builder
to create a
request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteAttributesResponse deleteAttributes(DeleteAttributesRequest deleteAttributesRequest) throws ClusterNotFoundException, TargetNotFoundException, InvalidParameterException, AwsServiceException, 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteAttributesResponse deleteAttributes(Consumer<DeleteAttributesRequest.Builder> deleteAttributesRequest) throws ClusterNotFoundException, TargetNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException
Deletes one or more custom attributes from an Amazon ECS resource.
This is a convenience which creates an instance of the DeleteAttributesRequest.Builder
avoiding the need
to create one manually via DeleteAttributesRequest.builder()
deleteAttributesRequest
- A Consumer
that will call methods on DeleteAttributesRequest.Builder
to create a request.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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteClusterResponse deleteCluster(DeleteClusterRequest deleteClusterRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ClusterContainsContainerInstancesException, ClusterContainsServicesException, ClusterContainsTasksException, AwsServiceException, 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 permissions 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. 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. First, update the service to reduce its desired task
count to 0 and then delete the service. For more information, see UpdateService and
DeleteService.ClusterContainsTasksException
- You cannot delete a cluster that has active tasks.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteClusterResponse deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ClusterContainsContainerInstancesException, ClusterContainsServicesException, ClusterContainsTasksException, AwsServiceException, 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.
This is a convenience which creates an instance of the DeleteClusterRequest.Builder
avoiding the need to
create one manually via DeleteClusterRequest.builder()
deleteClusterRequest
- A Consumer
that will call methods on DeleteClusterRequest.Builder
to create a request.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 permissions 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. 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. First, update the service to reduce its desired task
count to 0 and then delete the service. For more information, see UpdateService and
DeleteService.ClusterContainsTasksException
- You cannot delete a cluster that has active tasks.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteServiceResponse deleteService(DeleteServiceRequest deleteServiceRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ServiceNotFoundException, AwsServiceException, 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 the
ListServices API operation. 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 the DescribeServices API operation. However, in the future,
INACTIVE
services may be cleaned up and purged from Amazon ECS record keeping, and
DescribeServices calls on those services return a ServiceNotFoundException
error.
If you attempt to create a new service with the same name as an existing service in either ACTIVE
or
DRAINING
status, you receive an 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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteServiceResponse deleteService(Consumer<DeleteServiceRequest.Builder> deleteServiceRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ServiceNotFoundException, AwsServiceException, 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 the
ListServices API operation. 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 the DescribeServices API operation. However, in the future,
INACTIVE
services may be cleaned up and purged from Amazon ECS record keeping, and
DescribeServices calls on those services return a ServiceNotFoundException
error.
If you attempt to create a new service with the same name as an existing service in either ACTIVE
or
DRAINING
status, you receive an error.
This is a convenience which creates an instance of the DeleteServiceRequest.Builder
avoiding the need to
create one manually via DeleteServiceRequest.builder()
deleteServiceRequest
- A Consumer
that will call methods on DeleteServiceRequest.Builder
to create a request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeregisterContainerInstanceResponse deregisterContainerInstance(DeregisterContainerInstanceRequest deregisterContainerInstanceRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, 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. That prevents 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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeregisterContainerInstanceResponse deregisterContainerInstance(Consumer<DeregisterContainerInstanceRequest.Builder> deregisterContainerInstanceRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, 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. That prevents 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).
This is a convenience which creates an instance of the DeregisterContainerInstanceRequest.Builder
avoiding the need to create one manually via DeregisterContainerInstanceRequest.builder()
deregisterContainerInstanceRequest
- A Consumer
that will call methods on DeregisterContainerInstanceRequest.Builder
to create
a request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeregisterTaskDefinitionResponse deregisterTaskDefinition(DeregisterTaskDefinitionRequest deregisterTaskDefinitionRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, 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. However, 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 lifecycle 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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeregisterTaskDefinitionResponse deregisterTaskDefinition(Consumer<DeregisterTaskDefinitionRequest.Builder> deregisterTaskDefinitionRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, 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. However, 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 lifecycle of any associated tasks and services.
This is a convenience which creates an instance of the DeregisterTaskDefinitionRequest.Builder
avoiding
the need to create one manually via DeregisterTaskDefinitionRequest.builder()
deregisterTaskDefinitionRequest
- A Consumer
that will call methods on DeregisterTaskDefinitionRequest.Builder
to create a
request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeClustersResponse describeClusters() throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException
Describes one or more of your clusters.
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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeClusters(DescribeClustersRequest)
,
AWS API
Documentationdefault DescribeClustersResponse describeClusters(DescribeClustersRequest describeClustersRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, 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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeClustersResponse describeClusters(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException
Describes one or more of your clusters.
This is a convenience which creates an instance of the DescribeClustersRequest.Builder
avoiding the need
to create one manually via DescribeClustersRequest.builder()
describeClustersRequest
- A Consumer
that will call methods on DescribeClustersRequest.Builder
to create a request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeContainerInstancesResponse describeContainerInstances(DescribeContainerInstancesRequest describeContainerInstancesRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException
Describes Amazon Elastic 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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeContainerInstancesResponse describeContainerInstances(Consumer<DescribeContainerInstancesRequest.Builder> describeContainerInstancesRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException
Describes Amazon Elastic Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
This is a convenience which creates an instance of the DescribeContainerInstancesRequest.Builder
avoiding
the need to create one manually via DescribeContainerInstancesRequest.builder()
describeContainerInstancesRequest
- A Consumer
that will call methods on DescribeContainerInstancesRequest.Builder
to create a
request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeServicesResponse describeServices(DescribeServicesRequest describeServicesRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, 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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeServicesResponse describeServices(Consumer<DescribeServicesRequest.Builder> describeServicesRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException
Describes the specified services running in your cluster.
This is a convenience which creates an instance of the DescribeServicesRequest.Builder
avoiding the need
to create one manually via DescribeServicesRequest.builder()
describeServicesRequest
- A Consumer
that will call methods on DescribeServicesRequest.Builder
to create a request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeTaskDefinitionResponse describeTaskDefinition(DescribeTaskDefinitionRequest describeTaskDefinitionRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, 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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeTaskDefinitionResponse describeTaskDefinition(Consumer<DescribeTaskDefinitionRequest.Builder> describeTaskDefinitionRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, 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.
This is a convenience which creates an instance of the DescribeTaskDefinitionRequest.Builder
avoiding the
need to create one manually via DescribeTaskDefinitionRequest.builder()
describeTaskDefinitionRequest
- A Consumer
that will call methods on DescribeTaskDefinitionRequest.Builder
to create a
request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeTasksResponse describeTasks(DescribeTasksRequest describeTasksRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, 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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeTasksResponse describeTasks(Consumer<DescribeTasksRequest.Builder> describeTasksRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException
Describes a specified task or tasks.
This is a convenience which creates an instance of the DescribeTasksRequest.Builder
avoiding the need to
create one manually via DescribeTasksRequest.builder()
describeTasksRequest
- A Consumer
that will call methods on DescribeTasksRequest.Builder
to create a request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DiscoverPollEndpointResponse discoverPollEndpoint(DiscoverPollEndpointRequest discoverPollEndpointRequest) throws ServerException, ClientException, AwsServiceException, SdkClientException, EcsException
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Returns an endpoint for the Amazon ECS 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 permissions to use the action or resource, or specifying an identifier that is not
valid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DiscoverPollEndpointResponse discoverPollEndpoint(Consumer<DiscoverPollEndpointRequest.Builder> discoverPollEndpointRequest) throws ServerException, ClientException, AwsServiceException, SdkClientException, EcsException
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Returns an endpoint for the Amazon ECS agent to poll for updates.
This is a convenience which creates an instance of the DiscoverPollEndpointRequest.Builder
avoiding the
need to create one manually via DiscoverPollEndpointRequest.builder()
discoverPollEndpointRequest
- A Consumer
that will call methods on DiscoverPollEndpointRequest.Builder
to create a
request.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 permissions to use the action or resource, or specifying an identifier that is not
valid.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAccountSettingsResponse listAccountSettings() throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException
Lists the account settings for an Amazon ECS resource for a specified principal.
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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listAccountSettings(ListAccountSettingsRequest)
,
AWS API
Documentationdefault ListAccountSettingsResponse listAccountSettings(ListAccountSettingsRequest listAccountSettingsRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException
Lists the account settings for an Amazon ECS resource for a specified principal.
listAccountSettingsRequest
- 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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAccountSettingsResponse listAccountSettings(Consumer<ListAccountSettingsRequest.Builder> listAccountSettingsRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException
Lists the account settings for an Amazon ECS resource for a specified principal.
This is a convenience which creates an instance of the ListAccountSettingsRequest.Builder
avoiding the
need to create one manually via ListAccountSettingsRequest.builder()
listAccountSettingsRequest
- A Consumer
that will call methods on ListAccountSettingsRequest.Builder
to create a
request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAttributesResponse listAttributes(ListAttributesRequest listAttributesRequest) throws ClusterNotFoundException, InvalidParameterException, AwsServiceException, 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAttributesResponse listAttributes(Consumer<ListAttributesRequest.Builder> listAttributesRequest) throws ClusterNotFoundException, InvalidParameterException, AwsServiceException, 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
).
This is a convenience which creates an instance of the ListAttributesRequest.Builder
avoiding the need to
create one manually via ListAttributesRequest.builder()
listAttributesRequest
- A Consumer
that will call methods on ListAttributesRequest.Builder
to create a request.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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListClustersResponse listClusters() throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException
Returns a list of existing clusters.
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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listClusters(ListClustersRequest)
,
AWS API
Documentationdefault ListClustersResponse listClusters(ListClustersRequest listClustersRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, 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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListClustersResponse listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException
Returns a list of existing clusters.
This is a convenience which creates an instance of the ListClustersRequest.Builder
avoiding the need to
create one manually via ListClustersRequest.builder()
listClustersRequest
- A Consumer
that will call methods on ListClustersRequest.Builder
to create a request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListClustersIterable listClustersPaginator() throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException
Returns a list of existing clusters.
This is a variant of listClusters(software.amazon.awssdk.services.ecs.model.ListClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecs.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ecs.paginators.ListClustersIterable responses = client.listClustersPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListClustersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ecs.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listClusters(software.amazon.awssdk.services.ecs.model.ListClustersRequest)
operation.
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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listClustersPaginator(ListClustersRequest)
,
AWS API
Documentationdefault ListClustersIterable listClustersPaginator(ListClustersRequest listClustersRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException
Returns a list of existing clusters.
This is a variant of listClusters(software.amazon.awssdk.services.ecs.model.ListClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecs.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ecs.paginators.ListClustersIterable responses = client.listClustersPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListClustersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ecs.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listClusters(software.amazon.awssdk.services.ecs.model.ListClustersRequest)
operation.
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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListClustersIterable listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException
Returns a list of existing clusters.
This is a variant of listClusters(software.amazon.awssdk.services.ecs.model.ListClustersRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecs.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ecs.paginators.ListClustersIterable responses = client.listClustersPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListClustersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ecs.paginators.ListClustersIterable responses = client.listClustersPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listClusters(software.amazon.awssdk.services.ecs.model.ListClustersRequest)
operation.
This is a convenience which creates an instance of the ListClustersRequest.Builder
avoiding the need to
create one manually via ListClustersRequest.builder()
listClustersRequest
- A Consumer
that will call methods on ListClustersRequest.Builder
to create a request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListContainerInstancesResponse listContainerInstances() throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, 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 Elastic Container Service Developer Guide.
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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listContainerInstances(ListContainerInstancesRequest)
,
AWS API
Documentationdefault ListContainerInstancesResponse listContainerInstances(ListContainerInstancesRequest listContainerInstancesRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, 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 Elastic 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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListContainerInstancesResponse listContainerInstances(Consumer<ListContainerInstancesRequest.Builder> listContainerInstancesRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, 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 Elastic Container Service Developer Guide.
This is a convenience which creates an instance of the ListContainerInstancesRequest.Builder
avoiding the
need to create one manually via ListContainerInstancesRequest.builder()
listContainerInstancesRequest
- A Consumer
that will call methods on ListContainerInstancesRequest.Builder
to create a
request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListContainerInstancesIterable listContainerInstancesPaginator() throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, 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 Elastic Container Service Developer Guide.
This is a variant of
listContainerInstances(software.amazon.awssdk.services.ecs.model.ListContainerInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecs.paginators.ListContainerInstancesIterable responses = client.listContainerInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ecs.paginators.ListContainerInstancesIterable responses = client .listContainerInstancesPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListContainerInstancesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ecs.paginators.ListContainerInstancesIterable responses = client.listContainerInstancesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listContainerInstances(software.amazon.awssdk.services.ecs.model.ListContainerInstancesRequest)
operation.
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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listContainerInstancesPaginator(ListContainerInstancesRequest)
,
AWS API
Documentationdefault ListContainerInstancesIterable listContainerInstancesPaginator(ListContainerInstancesRequest listContainerInstancesRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, 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 Elastic Container Service Developer Guide.
This is a variant of
listContainerInstances(software.amazon.awssdk.services.ecs.model.ListContainerInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecs.paginators.ListContainerInstancesIterable responses = client.listContainerInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ecs.paginators.ListContainerInstancesIterable responses = client .listContainerInstancesPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListContainerInstancesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ecs.paginators.ListContainerInstancesIterable responses = client.listContainerInstancesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listContainerInstances(software.amazon.awssdk.services.ecs.model.ListContainerInstancesRequest)
operation.
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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListContainerInstancesIterable listContainerInstancesPaginator(Consumer<ListContainerInstancesRequest.Builder> listContainerInstancesRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, 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 Elastic Container Service Developer Guide.
This is a variant of
listContainerInstances(software.amazon.awssdk.services.ecs.model.ListContainerInstancesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecs.paginators.ListContainerInstancesIterable responses = client.listContainerInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ecs.paginators.ListContainerInstancesIterable responses = client .listContainerInstancesPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListContainerInstancesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ecs.paginators.ListContainerInstancesIterable responses = client.listContainerInstancesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listContainerInstances(software.amazon.awssdk.services.ecs.model.ListContainerInstancesRequest)
operation.
This is a convenience which creates an instance of the ListContainerInstancesRequest.Builder
avoiding the
need to create one manually via ListContainerInstancesRequest.builder()
listContainerInstancesRequest
- A Consumer
that will call methods on ListContainerInstancesRequest.Builder
to create a
request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListServicesResponse listServices() throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException
Lists the services that are running in a specified cluster.
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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listServices(ListServicesRequest)
,
AWS API
Documentationdefault ListServicesResponse listServices(ListServicesRequest listServicesRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, 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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListServicesResponse listServices(Consumer<ListServicesRequest.Builder> listServicesRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException
Lists the services that are running in a specified cluster.
This is a convenience which creates an instance of the ListServicesRequest.Builder
avoiding the need to
create one manually via ListServicesRequest.builder()
listServicesRequest
- A Consumer
that will call methods on ListServicesRequest.Builder
to create a request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListServicesIterable listServicesPaginator() throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException
Lists the services that are running in a specified cluster.
This is a variant of listServices(software.amazon.awssdk.services.ecs.model.ListServicesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecs.paginators.ListServicesIterable responses = client.listServicesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ecs.paginators.ListServicesIterable responses = client.listServicesPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListServicesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ecs.paginators.ListServicesIterable responses = client.listServicesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listServices(software.amazon.awssdk.services.ecs.model.ListServicesRequest)
operation.
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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listServicesPaginator(ListServicesRequest)
,
AWS API
Documentationdefault ListServicesIterable listServicesPaginator(ListServicesRequest listServicesRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException
Lists the services that are running in a specified cluster.
This is a variant of listServices(software.amazon.awssdk.services.ecs.model.ListServicesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecs.paginators.ListServicesIterable responses = client.listServicesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ecs.paginators.ListServicesIterable responses = client.listServicesPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListServicesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ecs.paginators.ListServicesIterable responses = client.listServicesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listServices(software.amazon.awssdk.services.ecs.model.ListServicesRequest)
operation.
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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListServicesIterable listServicesPaginator(Consumer<ListServicesRequest.Builder> listServicesRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException
Lists the services that are running in a specified cluster.
This is a variant of listServices(software.amazon.awssdk.services.ecs.model.ListServicesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecs.paginators.ListServicesIterable responses = client.listServicesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ecs.paginators.ListServicesIterable responses = client.listServicesPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListServicesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ecs.paginators.ListServicesIterable responses = client.listServicesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listServices(software.amazon.awssdk.services.ecs.model.ListServicesRequest)
operation.
This is a convenience which creates an instance of the ListServicesRequest.Builder
avoiding the need to
create one manually via ListServicesRequest.builder()
listServicesRequest
- A Consumer
that will call methods on ListServicesRequest.Builder
to create a request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ServerException, ClientException, ClusterNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException
List the tags for an Amazon ECS resource.
listTagsForResourceRequest
- 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 permissions to use the action or resource, or specifying an identifier that is not
valid.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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ServerException, ClientException, ClusterNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException
List the tags for an Amazon ECS resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder
avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest
- A Consumer
that will call methods on ListTagsForResourceRequest.Builder
to create a
request.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 permissions to use the action or resource, or specifying an identifier that is not
valid.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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTaskDefinitionFamiliesResponse listTaskDefinitionFamilies() throws ServerException, ClientException, InvalidParameterException, AwsServiceException, 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.
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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listTaskDefinitionFamilies(ListTaskDefinitionFamiliesRequest)
,
AWS
API Documentationdefault ListTaskDefinitionFamiliesResponse listTaskDefinitionFamilies(ListTaskDefinitionFamiliesRequest listTaskDefinitionFamiliesRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, 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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTaskDefinitionFamiliesResponse listTaskDefinitionFamilies(Consumer<ListTaskDefinitionFamiliesRequest.Builder> listTaskDefinitionFamiliesRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, 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.
This is a convenience which creates an instance of the ListTaskDefinitionFamiliesRequest.Builder
avoiding
the need to create one manually via ListTaskDefinitionFamiliesRequest.builder()
listTaskDefinitionFamiliesRequest
- A Consumer
that will call methods on ListTaskDefinitionFamiliesRequest.Builder
to create a
request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTaskDefinitionFamiliesIterable listTaskDefinitionFamiliesPaginator() throws ServerException, ClientException, InvalidParameterException, AwsServiceException, 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.
This is a variant of
listTaskDefinitionFamilies(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesIterable responses = client.listTaskDefinitionFamiliesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesIterable responses = client .listTaskDefinitionFamiliesPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesIterable responses = client.listTaskDefinitionFamiliesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listTaskDefinitionFamilies(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesRequest)
operation.
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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listTaskDefinitionFamiliesPaginator(ListTaskDefinitionFamiliesRequest)
,
AWS
API Documentationdefault ListTaskDefinitionFamiliesIterable listTaskDefinitionFamiliesPaginator(ListTaskDefinitionFamiliesRequest listTaskDefinitionFamiliesRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, 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.
This is a variant of
listTaskDefinitionFamilies(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesIterable responses = client.listTaskDefinitionFamiliesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesIterable responses = client .listTaskDefinitionFamiliesPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesIterable responses = client.listTaskDefinitionFamiliesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listTaskDefinitionFamilies(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesRequest)
operation.
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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTaskDefinitionFamiliesIterable listTaskDefinitionFamiliesPaginator(Consumer<ListTaskDefinitionFamiliesRequest.Builder> listTaskDefinitionFamiliesRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, 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.
This is a variant of
listTaskDefinitionFamilies(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesIterable responses = client.listTaskDefinitionFamiliesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesIterable responses = client .listTaskDefinitionFamiliesPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesIterable responses = client.listTaskDefinitionFamiliesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listTaskDefinitionFamilies(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesRequest)
operation.
This is a convenience which creates an instance of the ListTaskDefinitionFamiliesRequest.Builder
avoiding
the need to create one manually via ListTaskDefinitionFamiliesRequest.builder()
listTaskDefinitionFamiliesRequest
- A Consumer
that will call methods on ListTaskDefinitionFamiliesRequest.Builder
to create a
request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTaskDefinitionsResponse listTaskDefinitions() throws ServerException, ClientException, InvalidParameterException, AwsServiceException, 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.
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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listTaskDefinitions(ListTaskDefinitionsRequest)
,
AWS API
Documentationdefault ListTaskDefinitionsResponse listTaskDefinitions(ListTaskDefinitionsRequest listTaskDefinitionsRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, 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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTaskDefinitionsResponse listTaskDefinitions(Consumer<ListTaskDefinitionsRequest.Builder> listTaskDefinitionsRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, 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.
This is a convenience which creates an instance of the ListTaskDefinitionsRequest.Builder
avoiding the
need to create one manually via ListTaskDefinitionsRequest.builder()
listTaskDefinitionsRequest
- A Consumer
that will call methods on ListTaskDefinitionsRequest.Builder
to create a
request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTaskDefinitionsIterable listTaskDefinitionsPaginator() throws ServerException, ClientException, InvalidParameterException, AwsServiceException, 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.
This is a variant of
listTaskDefinitions(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsIterable responses = client.listTaskDefinitionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsIterable responses = client .listTaskDefinitionsPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsIterable responses = client.listTaskDefinitionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listTaskDefinitions(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsRequest)
operation.
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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listTaskDefinitionsPaginator(ListTaskDefinitionsRequest)
,
AWS API
Documentationdefault ListTaskDefinitionsIterable listTaskDefinitionsPaginator(ListTaskDefinitionsRequest listTaskDefinitionsRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, 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.
This is a variant of
listTaskDefinitions(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsIterable responses = client.listTaskDefinitionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsIterable responses = client .listTaskDefinitionsPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsIterable responses = client.listTaskDefinitionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listTaskDefinitions(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsRequest)
operation.
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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTaskDefinitionsIterable listTaskDefinitionsPaginator(Consumer<ListTaskDefinitionsRequest.Builder> listTaskDefinitionsRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, 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.
This is a variant of
listTaskDefinitions(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsIterable responses = client.listTaskDefinitionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsIterable responses = client .listTaskDefinitionsPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsIterable responses = client.listTaskDefinitionsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listTaskDefinitions(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsRequest)
operation.
This is a convenience which creates an instance of the ListTaskDefinitionsRequest.Builder
avoiding the
need to create one manually via ListTaskDefinitionsRequest.builder()
listTaskDefinitionsRequest
- A Consumer
that will call methods on ListTaskDefinitionsRequest.Builder
to create a
request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTasksResponse listTasks() throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ServiceNotFoundException, AwsServiceException, 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.
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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listTasks(ListTasksRequest)
,
AWS API
Documentationdefault ListTasksResponse listTasks(ListTasksRequest listTasksRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ServiceNotFoundException, AwsServiceException, 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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTasksResponse listTasks(Consumer<ListTasksRequest.Builder> listTasksRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ServiceNotFoundException, AwsServiceException, 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.
This is a convenience which creates an instance of the ListTasksRequest.Builder
avoiding the need to
create one manually via ListTasksRequest.builder()
listTasksRequest
- A Consumer
that will call methods on ListTasksRequest.Builder
to create a request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTasksIterable listTasksPaginator() throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ServiceNotFoundException, AwsServiceException, 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.
This is a variant of listTasks(software.amazon.awssdk.services.ecs.model.ListTasksRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecs.paginators.ListTasksIterable responses = client.listTasksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ecs.paginators.ListTasksIterable responses = client.listTasksPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListTasksResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ecs.paginators.ListTasksIterable responses = client.listTasksPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listTasks(software.amazon.awssdk.services.ecs.model.ListTasksRequest)
operation.
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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listTasksPaginator(ListTasksRequest)
,
AWS API
Documentationdefault ListTasksIterable listTasksPaginator(ListTasksRequest listTasksRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ServiceNotFoundException, AwsServiceException, 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.
This is a variant of listTasks(software.amazon.awssdk.services.ecs.model.ListTasksRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecs.paginators.ListTasksIterable responses = client.listTasksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ecs.paginators.ListTasksIterable responses = client.listTasksPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListTasksResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ecs.paginators.ListTasksIterable responses = client.listTasksPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listTasks(software.amazon.awssdk.services.ecs.model.ListTasksRequest)
operation.
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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTasksIterable listTasksPaginator(Consumer<ListTasksRequest.Builder> listTasksRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ServiceNotFoundException, AwsServiceException, 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.
This is a variant of listTasks(software.amazon.awssdk.services.ecs.model.ListTasksRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.ecs.paginators.ListTasksIterable responses = client.listTasksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.ecs.paginators.ListTasksIterable responses = client.listTasksPaginator(request); for (software.amazon.awssdk.services.ecs.model.ListTasksResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.ecs.paginators.ListTasksIterable responses = client.listTasksPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listTasks(software.amazon.awssdk.services.ecs.model.ListTasksRequest)
operation.
This is a convenience which creates an instance of the ListTasksRequest.Builder
avoiding the need to
create one manually via ListTasksRequest.builder()
listTasksRequest
- A Consumer
that will call methods on ListTasksRequest.Builder
to create a request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutAccountSettingResponse putAccountSetting(PutAccountSettingRequest putAccountSettingRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException
Modifies the ARN and resource ID format of a resource for a specified IAM user, IAM role, or the root user for an account. You can specify whether the new ARN and resource ID format are enabled for new resources that are created. Enabling this setting is required to use new Amazon ECS features such as resource tagging.
putAccountSettingRequest
- 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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutAccountSettingResponse putAccountSetting(Consumer<PutAccountSettingRequest.Builder> putAccountSettingRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException
Modifies the ARN and resource ID format of a resource for a specified IAM user, IAM role, or the root user for an account. You can specify whether the new ARN and resource ID format are enabled for new resources that are created. Enabling this setting is required to use new Amazon ECS features such as resource tagging.
This is a convenience which creates an instance of the PutAccountSettingRequest.Builder
avoiding the need
to create one manually via PutAccountSettingRequest.builder()
putAccountSettingRequest
- A Consumer
that will call methods on PutAccountSettingRequest.Builder
to create a request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutAttributesResponse putAttributes(PutAttributesRequest putAttributesRequest) throws ClusterNotFoundException, TargetNotFoundException, AttributeLimitExceededException, InvalidParameterException, AwsServiceException, 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 Elastic 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutAttributesResponse putAttributes(Consumer<PutAttributesRequest.Builder> putAttributesRequest) throws ClusterNotFoundException, TargetNotFoundException, AttributeLimitExceededException, InvalidParameterException, AwsServiceException, 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 Elastic Container Service Developer Guide.
This is a convenience which creates an instance of the PutAttributesRequest.Builder
avoiding the need to
create one manually via PutAttributesRequest.builder()
putAttributesRequest
- A Consumer
that will call methods on PutAttributesRequest.Builder
to create a request.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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RegisterContainerInstanceResponse registerContainerInstance(RegisterContainerInstanceRequest registerContainerInstanceRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException
This action is only used by the Amazon ECS 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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RegisterContainerInstanceResponse registerContainerInstance(Consumer<RegisterContainerInstanceRequest.Builder> registerContainerInstanceRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException
This action is only used by the Amazon ECS 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.
This is a convenience which creates an instance of the RegisterContainerInstanceRequest.Builder
avoiding
the need to create one manually via RegisterContainerInstanceRequest.builder()
registerContainerInstanceRequest
- A Consumer
that will call methods on RegisterContainerInstanceRequest.Builder
to create a
request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RegisterTaskDefinitionResponse registerTaskDefinition(RegisterTaskDefinitionRequest registerTaskDefinitionRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, 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 Elastic 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 Elastic 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. If you specify the awsvpc
network mode, the task is allocated an elastic network
interface, and you must specify a NetworkConfiguration when you create a service or run a task with the
task definition. For more information, see Task Networking in the
Amazon Elastic Container Service Developer Guide.
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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RegisterTaskDefinitionResponse registerTaskDefinition(Consumer<RegisterTaskDefinitionRequest.Builder> registerTaskDefinitionRequest) throws ServerException, ClientException, InvalidParameterException, AwsServiceException, 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 Elastic 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 Elastic 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. If you specify the awsvpc
network mode, the task is allocated an elastic network
interface, and you must specify a NetworkConfiguration when you create a service or run a task with the
task definition. For more information, see Task Networking in the
Amazon Elastic Container Service Developer Guide.
This is a convenience which creates an instance of the RegisterTaskDefinitionRequest.Builder
avoiding the
need to create one manually via RegisterTaskDefinitionRequest.builder()
registerTaskDefinitionRequest
- A Consumer
that will call methods on RegisterTaskDefinitionRequest.Builder
to create a
request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RunTaskResponse runTask(RunTaskRequest runTaskRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, UnsupportedFeatureException, PlatformUnknownException, PlatformTaskDefinitionIncompatibilityException, AccessDeniedException, BlockedException, AwsServiceException, 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 Elastic Container Service Developer Guide.
Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.
The Amazon ECS API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.
To manage eventual consistency, you can do the following:
Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.
Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.
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 permissions 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.UnsupportedFeatureException
- The specified task is not supported in this Region.PlatformUnknownException
- The specified platform version does not exist.PlatformTaskDefinitionIncompatibilityException
- The specified platform version does not satisfy the task definition's required capabilities.AccessDeniedException
- You do not have authorization to perform the requested action.BlockedException
- Your AWS account has been blocked. For more information, contact AWS Support.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RunTaskResponse runTask(Consumer<RunTaskRequest.Builder> runTaskRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, UnsupportedFeatureException, PlatformUnknownException, PlatformTaskDefinitionIncompatibilityException, AccessDeniedException, BlockedException, AwsServiceException, 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 Elastic Container Service Developer Guide.
Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.
The Amazon ECS API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.
To manage eventual consistency, you can do the following:
Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.
Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.
This is a convenience which creates an instance of the RunTaskRequest.Builder
avoiding the need to create
one manually via RunTaskRequest.builder()
runTaskRequest
- A Consumer
that will call methods on RunTaskRequest.Builder
to create a request.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 permissions 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.UnsupportedFeatureException
- The specified task is not supported in this Region.PlatformUnknownException
- The specified platform version does not exist.PlatformTaskDefinitionIncompatibilityException
- The specified platform version does not satisfy the task definition's required capabilities.AccessDeniedException
- You do not have authorization to perform the requested action.BlockedException
- Your AWS account has been blocked. For more information, contact AWS Support.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartTaskResponse startTask(StartTaskRequest startTaskRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, 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 Elastic 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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartTaskResponse startTask(Consumer<StartTaskRequest.Builder> startTaskRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, 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 Elastic Container Service Developer Guide.
This is a convenience which creates an instance of the StartTaskRequest.Builder
avoiding the need to
create one manually via StartTaskRequest.builder()
startTaskRequest
- A Consumer
that will call methods on StartTaskRequest.Builder
to create a request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopTaskResponse stopTask(StopTaskRequest stopTaskRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException
Stops a running task. Any tags associated with the task will be deleted.
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
value and a default 30-second timeout, after which
the SIGKILL
value is sent and the containers are forcibly stopped. If the container handles the
SIGTERM
value gracefully and exits within 30 seconds from receiving it, no SIGKILL
value 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 Elastic 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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopTaskResponse stopTask(Consumer<StopTaskRequest.Builder> stopTaskRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, SdkClientException, EcsException
Stops a running task. Any tags associated with the task will be deleted.
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
value and a default 30-second timeout, after which
the SIGKILL
value is sent and the containers are forcibly stopped. If the container handles the
SIGTERM
value gracefully and exits within 30 seconds from receiving it, no SIGKILL
value 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 Elastic Container Service Developer Guide.
This is a convenience which creates an instance of the StopTaskRequest.Builder
avoiding the need to
create one manually via StopTaskRequest.builder()
stopTaskRequest
- A Consumer
that will call methods on StopTaskRequest.Builder
to create a request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SubmitContainerStateChangeResponse submitContainerStateChange(SubmitContainerStateChangeRequest submitContainerStateChangeRequest) throws ServerException, ClientException, AccessDeniedException, AwsServiceException, SdkClientException, EcsException
This action is only used by the Amazon ECS 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 permissions to use the action or resource, or specifying an identifier that is not
valid.AccessDeniedException
- You do not have authorization to perform the requested action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SubmitContainerStateChangeResponse submitContainerStateChange(Consumer<SubmitContainerStateChangeRequest.Builder> submitContainerStateChangeRequest) throws ServerException, ClientException, AccessDeniedException, AwsServiceException, SdkClientException, EcsException
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a container changed states.
This is a convenience which creates an instance of the SubmitContainerStateChangeRequest.Builder
avoiding
the need to create one manually via SubmitContainerStateChangeRequest.builder()
submitContainerStateChangeRequest
- A Consumer
that will call methods on SubmitContainerStateChangeRequest.Builder
to create a
request.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 permissions to use the action or resource, or specifying an identifier that is not
valid.AccessDeniedException
- You do not have authorization to perform the requested action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SubmitTaskStateChangeResponse submitTaskStateChange(SubmitTaskStateChangeRequest submitTaskStateChangeRequest) throws ServerException, ClientException, AccessDeniedException, AwsServiceException, SdkClientException, EcsException
This action is only used by the Amazon ECS 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 permissions to use the action or resource, or specifying an identifier that is not
valid.AccessDeniedException
- You do not have authorization to perform the requested action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default SubmitTaskStateChangeResponse submitTaskStateChange(Consumer<SubmitTaskStateChangeRequest.Builder> submitTaskStateChangeRequest) throws ServerException, ClientException, AccessDeniedException, AwsServiceException, SdkClientException, EcsException
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a task changed states.
This is a convenience which creates an instance of the SubmitTaskStateChangeRequest.Builder
avoiding the
need to create one manually via SubmitTaskStateChangeRequest.builder()
submitTaskStateChangeRequest
- A Consumer
that will call methods on SubmitTaskStateChangeRequest.Builder
to create a
request.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 permissions to use the action or resource, or specifying an identifier that is not
valid.AccessDeniedException
- You do not have authorization to perform the requested action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ServerException, ClientException, ClusterNotFoundException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException
Associates the specified tags to a resource with the specified resourceArn
. If existing tags on a
resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags
associated with that resource are deleted as well.
tagResourceRequest
- 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 permissions to use the action or resource, or specifying an identifier that is not
valid.ClusterNotFoundException
- The specified cluster could not be found. You can view your available clusters with ListClusters.
Amazon ECS clusters are Region-specific.ResourceNotFoundException
- The specified resource could not be found.InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ServerException, ClientException, ClusterNotFoundException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException
Associates the specified tags to a resource with the specified resourceArn
. If existing tags on a
resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags
associated with that resource are deleted as well.
This is a convenience which creates an instance of the TagResourceRequest.Builder
avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest
- A Consumer
that will call methods on TagResourceRequest.Builder
to create a request.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 permissions to use the action or resource, or specifying an identifier that is not
valid.ClusterNotFoundException
- The specified cluster could not be found. You can view your available clusters with ListClusters.
Amazon ECS clusters are Region-specific.ResourceNotFoundException
- The specified resource could not be found.InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ServerException, ClientException, ClusterNotFoundException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException
Deletes specified tags from a resource.
untagResourceRequest
- 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 permissions to use the action or resource, or specifying an identifier that is not
valid.ClusterNotFoundException
- The specified cluster could not be found. You can view your available clusters with ListClusters.
Amazon ECS clusters are Region-specific.ResourceNotFoundException
- The specified resource could not be found.InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ServerException, ClientException, ClusterNotFoundException, ResourceNotFoundException, InvalidParameterException, AwsServiceException, SdkClientException, EcsException
Deletes specified tags from a resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder
avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest
- A Consumer
that will call methods on UntagResourceRequest.Builder
to create a request.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 permissions to use the action or resource, or specifying an identifier that is not
valid.ClusterNotFoundException
- The specified cluster could not be found. You can view your available clusters with ListClusters.
Amazon ECS clusters are Region-specific.ResourceNotFoundException
- The specified resource could not be found.InvalidParameterException
- The specified parameter is invalid. Review the available parameters for the API request.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateContainerAgentResponse updateContainerAgent(UpdateContainerAgentRequest updateContainerAgentRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, UpdateInProgressException, NoUpdateAvailableException, MissingVersionException, AwsServiceException, 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 Elastic 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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateContainerAgentResponse updateContainerAgent(Consumer<UpdateContainerAgentRequest.Builder> updateContainerAgentRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, UpdateInProgressException, NoUpdateAvailableException, MissingVersionException, AwsServiceException, 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 Elastic Container Service Developer
Guide.
This is a convenience which creates an instance of the UpdateContainerAgentRequest.Builder
avoiding the
need to create one manually via UpdateContainerAgentRequest.builder()
updateContainerAgentRequest
- A Consumer
that will call methods on UpdateContainerAgentRequest.Builder
to create a
request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateContainerInstancesStateResponse updateContainerInstancesState(UpdateContainerInstancesStateRequest updateContainerInstancesStateRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, 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 to the service's deployment configuration parameters, minimumHealthyPercent
and
maximumPercent
. 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
is
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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateContainerInstancesStateResponse updateContainerInstancesState(Consumer<UpdateContainerInstancesStateRequest.Builder> updateContainerInstancesStateRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, AwsServiceException, 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 to the service's deployment configuration parameters, minimumHealthyPercent
and
maximumPercent
. 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
is
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.
This is a convenience which creates an instance of the UpdateContainerInstancesStateRequest.Builder
avoiding the need to create one manually via UpdateContainerInstancesStateRequest.builder()
updateContainerInstancesStateRequest
- A Consumer
that will call methods on UpdateContainerInstancesStateRequest.Builder
to
create a request.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 permissions 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.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateServiceResponse updateService(UpdateServiceRequest updateServiceRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ServiceNotFoundException, ServiceNotActiveException, PlatformUnknownException, PlatformTaskDefinitionIncompatibilityException, AccessDeniedException, AwsServiceException, SdkClientException, EcsException
Modifies the parameters of a service.
For services using the rolling update (ECS
) deployment controller, the desired count, deployment
configuration, network configuration, or task definition used can be updated.
For services using the blue/green (CODE_DEPLOY
) deployment controller, only the desired count,
deployment configuration, and health check grace period can be updated using this API. If the network
configuration, platform version, or task definition need to be updated, a new AWS CodeDeploy deployment should be
created. For more information, see CreateDeployment
in the AWS CodeDeploy API Reference.
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.
If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy.
If your updated Docker image uses the same tag as what is in the existing task definition for your service (for
example, my_image:latest
), you do not need to create a new revision of your task definition. You can
update the service using the forceNewDeployment
option. The new tasks launched by the deployment
pull the current image/tag combination from your repository when they start.
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 permissions 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 can't update a service that is inactive. If you have previously
deleted a service, you can re-create it with CreateService.PlatformUnknownException
- The specified platform version does not exist.PlatformTaskDefinitionIncompatibilityException
- The specified platform version does not satisfy the task definition's required capabilities.AccessDeniedException
- You do not have authorization to perform the requested action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateServiceResponse updateService(Consumer<UpdateServiceRequest.Builder> updateServiceRequest) throws ServerException, ClientException, InvalidParameterException, ClusterNotFoundException, ServiceNotFoundException, ServiceNotActiveException, PlatformUnknownException, PlatformTaskDefinitionIncompatibilityException, AccessDeniedException, AwsServiceException, SdkClientException, EcsException
Modifies the parameters of a service.
For services using the rolling update (ECS
) deployment controller, the desired count, deployment
configuration, network configuration, or task definition used can be updated.
For services using the blue/green (CODE_DEPLOY
) deployment controller, only the desired count,
deployment configuration, and health check grace period can be updated using this API. If the network
configuration, platform version, or task definition need to be updated, a new AWS CodeDeploy deployment should be
created. For more information, see CreateDeployment
in the AWS CodeDeploy API Reference.
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.
If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy.
If your updated Docker image uses the same tag as what is in the existing task definition for your service (for
example, my_image:latest
), you do not need to create a new revision of your task definition. You can
update the service using the forceNewDeployment
option. The new tasks launched by the deployment
pull the current image/tag combination from your repository when they start.
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.
This is a convenience which creates an instance of the UpdateServiceRequest.Builder
avoiding the need to
create one manually via UpdateServiceRequest.builder()
updateServiceRequest
- A Consumer
that will call methods on UpdateServiceRequest.Builder
to create a request.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 permissions 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 can't update a service that is inactive. If you have previously
deleted a service, you can re-create it with CreateService.PlatformUnknownException
- The specified platform version does not exist.PlatformTaskDefinitionIncompatibilityException
- The specified platform version does not satisfy the task definition's required capabilities.AccessDeniedException
- You do not have authorization to perform the requested action.SdkException
- 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 class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.