Interface EcsAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface EcsAsyncClient extends AwsClient
Service client for accessing Amazon ECS asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call. Amazon Elastic Container Service

Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service. It makes it easy to run, stop, and manage Docker containers. You can host your cluster on a serverless infrastructure that's managed by Amazon ECS by launching your services or tasks on Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) or External (on-premises) instances that you manage.

Amazon ECS makes it easy to launch and stop container-based applications with simple API calls. This makes it easy 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. With Amazon ECS, you don't need to operate your own cluster management and configuration management systems. You also don't need to worry about scaling your management infrastructure.

  • Field Details

  • Method Details

    • createCapacityProvider

      default CompletableFuture<CreateCapacityProviderResponse> createCapacityProvider(CreateCapacityProviderRequest createCapacityProviderRequest)

      Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used in capacity provider strategies to facilitate cluster auto scaling.

      Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on Fargate use the FARGATE and FARGATE_SPOT capacity providers. These providers are available to all accounts in the Amazon Web Services Regions that Fargate supports.

      Parameters:
      createCapacityProviderRequest -
      Returns:
      A Java Future containing the result of the CreateCapacityProvider operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • LimitExceededException The limit for the resource was exceeded.
        • UpdateInProgressException There's already a current Amazon ECS container agent update in progress on the container instance that's specified. If the container agent becomes disconnected while it's 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.
        • 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.
      See Also:

    • createCapacityProvider

      default CompletableFuture<CreateCapacityProviderResponse> createCapacityProvider(Consumer<CreateCapacityProviderRequest.Builder> createCapacityProviderRequest)

      Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used in capacity provider strategies to facilitate cluster auto scaling.

      Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on Fargate use the FARGATE and FARGATE_SPOT capacity providers. These providers are available to all accounts in the Amazon Web Services Regions that Fargate supports.


      This is a convenience which creates an instance of the CreateCapacityProviderRequest.Builder avoiding the need to create one manually via CreateCapacityProviderRequest.builder()

      Parameters:
      createCapacityProviderRequest - A Consumer that will call methods on CreateCapacityProviderRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateCapacityProvider operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • LimitExceededException The limit for the resource was exceeded.
        • UpdateInProgressException There's already a current Amazon ECS container agent update in progress on the container instance that's specified. If the container agent becomes disconnected while it's 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.
        • 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.
      See Also:

    • createCluster

      default CompletableFuture<CreateClusterResponse> createCluster(CreateClusterRequest createClusterRequest)

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

      When you call the CreateCluster API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes the call doesn't have permissions to create the service-linked role, it isn't created. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      createClusterRequest -
      Returns:
      A Java Future containing the result of the CreateCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • NamespaceNotFoundException The specified namespace wasn't found.
        • 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.
      See Also:

    • createCluster

      default CompletableFuture<CreateClusterResponse> createCluster(Consumer<CreateClusterRequest.Builder> createClusterRequest)

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

      When you call the CreateCluster API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes the call doesn't have permissions to create the service-linked role, it isn't 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()

      Parameters:
      createClusterRequest - A Consumer that will call methods on CreateClusterRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • NamespaceNotFoundException The specified namespace wasn't found.
        • 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.
      See Also:

    • createCluster

      default CompletableFuture<CreateClusterResponse> createCluster()

      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.

      When you call the CreateCluster API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes the call doesn't have permissions to create the service-linked role, it isn't created. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

      Returns:
      A Java Future containing the result of the CreateCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • NamespaceNotFoundException The specified namespace wasn't found.
        • 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.
      See Also:

    • createService

      default CompletableFuture<CreateServiceResponse> createService(CreateServiceRequest createServiceRequest)

      Runs and maintains your desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, use UpdateService.

      On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

      Amazon Elastic Inference (EI) is no longer available to customers.

      In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute 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 attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. volumeConfigurations is only supported for REPLICA service and not DAEMON service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

      Tasks for services that don't use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state and are reported as healthy by the load balancer.

      There are two service scheduler strategies available:

      • REPLICA - The replica scheduling strategy places and maintains your desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.

      • DAEMON - The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It also stops tasks that don't meet the placement constraints. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.

      You can optionally specify a deployment configuration for your service. The deployment is initiated by changing properties. For example, the deployment might be initiated by the task definition or by your desired count of a service. You can use UpdateService. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%.

      If a service uses 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. Specifically, it represents it as a percentage of your desired number of tasks (rounded up to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can deploy without using additional cluster capacity. For example, if you set your service to have desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. If they're in the RUNNING state, tasks for services that don't use a load balancer are considered healthy . If they're in the RUNNING state and reported as healthy by the load balancer, tasks for services that do use a load balancer are considered healthy . The default value for minimum healthy percent is 100%.

      If a service uses 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. Specifically, it represents it as a percentage of the desired number of tasks (rounded down to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can 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 uses either the CODE_DEPLOY or EXTERNAL deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state. This is 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 aren't used. This is the case even if they're currently visible when describing your service.

      When creating a service that uses the EXTERNAL deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

      When the service scheduler launches new tasks, it determines task placement. For information about task placement and task placement strategies, see Amazon ECS task placement in the Amazon Elastic Container Service Developer Guide

      Parameters:
      createServiceRequest -
      Returns:
      A Java Future containing the result of the CreateService operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • UnsupportedFeatureException The specified task isn't supported in this Region.
        • PlatformUnknownException The specified platform version doesn't exist.
        • PlatformTaskDefinitionIncompatibilityException The specified platform version doesn't satisfy the required capabilities of the task definition.
        • AccessDeniedException You don't have authorization to perform the requested action.
        • NamespaceNotFoundException The specified namespace wasn't found.
        • 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.
      See Also:

    • createService

      default CompletableFuture<CreateServiceResponse> createService(Consumer<CreateServiceRequest.Builder> createServiceRequest)

      Runs and maintains your desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, use UpdateService.

      On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

      Amazon Elastic Inference (EI) is no longer available to customers.

      In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute 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 attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. volumeConfigurations is only supported for REPLICA service and not DAEMON service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

      Tasks for services that don't use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state and are reported as healthy by the load balancer.

      There are two service scheduler strategies available:

      • REPLICA - The replica scheduling strategy places and maintains your desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.

      • DAEMON - The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It also stops tasks that don't meet the placement constraints. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service scheduler concepts in the Amazon Elastic Container Service Developer Guide.

      You can optionally specify a deployment configuration for your service. The deployment is initiated by changing properties. For example, the deployment might be initiated by the task definition or by your desired count of a service. You can use UpdateService. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%.

      If a service uses 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. Specifically, it represents it as a percentage of your desired number of tasks (rounded up to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can deploy without using additional cluster capacity. For example, if you set your service to have desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. If they're in the RUNNING state, tasks for services that don't use a load balancer are considered healthy . If they're in the RUNNING state and reported as healthy by the load balancer, tasks for services that do use a load balancer are considered healthy . The default value for minimum healthy percent is 100%.

      If a service uses 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. Specifically, it represents it as a percentage of the desired number of tasks (rounded down to the nearest integer). This happens when any of your container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Using this parameter, you can 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 uses either the CODE_DEPLOY or EXTERNAL deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state. This is 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 aren't used. This is the case even if they're currently visible when describing your service.

      When creating a service that uses the EXTERNAL deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

      When the service scheduler launches new tasks, it determines task placement. For information about task placement and task placement strategies, see Amazon ECS task placement in the Amazon Elastic Container Service Developer Guide


      This is a convenience which creates an instance of the CreateServiceRequest.Builder avoiding the need to create one manually via CreateServiceRequest.builder()

      Parameters:
      createServiceRequest - A Consumer that will call methods on CreateServiceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateService operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • UnsupportedFeatureException The specified task isn't supported in this Region.
        • PlatformUnknownException The specified platform version doesn't exist.
        • PlatformTaskDefinitionIncompatibilityException The specified platform version doesn't satisfy the required capabilities of the task definition.
        • AccessDeniedException You don't have authorization to perform the requested action.
        • NamespaceNotFoundException The specified namespace wasn't found.
        • 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.
      See Also:

    • createTaskSet

      default CompletableFuture<CreateTaskSetResponse> createTaskSet(CreateTaskSetRequest createTaskSetRequest)

      Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

      On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

      For information about the maximum number of task sets and other quotas, see Amazon ECS service quotas in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      createTaskSetRequest -
      Returns:
      A Java Future containing the result of the CreateTaskSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • UnsupportedFeatureException The specified task isn't supported in this Region.
        • PlatformUnknownException The specified platform version doesn't exist.
        • PlatformTaskDefinitionIncompatibilityException The specified platform version doesn't satisfy the required capabilities of the task definition.
        • AccessDeniedException You don't have authorization to perform the requested action.
        • ServiceNotFoundException The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.
        • ServiceNotActiveException The specified service isn't active. You can't update a service that's inactive. If you have previously deleted a service, you can re-create it with CreateService.
        • NamespaceNotFoundException The specified namespace wasn't found.
        • 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.
      See Also:

    • createTaskSet

      default CompletableFuture<CreateTaskSetResponse> createTaskSet(Consumer<CreateTaskSetRequest.Builder> createTaskSetRequest)

      Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

      On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

      For information about the maximum number of task sets and other quotas, see Amazon ECS service quotas in the Amazon Elastic Container Service Developer Guide.


      This is a convenience which creates an instance of the CreateTaskSetRequest.Builder avoiding the need to create one manually via CreateTaskSetRequest.builder()

      Parameters:
      createTaskSetRequest - A Consumer that will call methods on CreateTaskSetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateTaskSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • UnsupportedFeatureException The specified task isn't supported in this Region.
        • PlatformUnknownException The specified platform version doesn't exist.
        • PlatformTaskDefinitionIncompatibilityException The specified platform version doesn't satisfy the required capabilities of the task definition.
        • AccessDeniedException You don't have authorization to perform the requested action.
        • ServiceNotFoundException The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.
        • ServiceNotActiveException The specified service isn't active. You can't update a service that's inactive. If you have previously deleted a service, you can re-create it with CreateService.
        • NamespaceNotFoundException The specified namespace wasn't found.
        • 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.
      See Also:

    • deleteAccountSetting

      default CompletableFuture<DeleteAccountSettingResponse> deleteAccountSetting(DeleteAccountSettingRequest deleteAccountSettingRequest)

      Disables an account setting for a specified user, role, or the root user for an account.

      Parameters:
      deleteAccountSettingRequest -
      Returns:
      A Java Future containing the result of the DeleteAccountSetting operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • deleteAccountSetting

      default CompletableFuture<DeleteAccountSettingResponse> deleteAccountSetting(Consumer<DeleteAccountSettingRequest.Builder> deleteAccountSettingRequest)

      Disables an account setting for a specified user, role, or the root user for an account.


      This is a convenience which creates an instance of the DeleteAccountSettingRequest.Builder avoiding the need to create one manually via DeleteAccountSettingRequest.builder()

      Parameters:
      deleteAccountSettingRequest - A Consumer that will call methods on DeleteAccountSettingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAccountSetting operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • deleteAttributes

      default CompletableFuture<DeleteAttributesResponse> deleteAttributes(DeleteAttributesRequest deleteAttributesRequest)

      Deletes one or more custom attributes from an Amazon ECS resource.

      Parameters:
      deleteAttributesRequest -
      Returns:
      A Java Future containing the result of the DeleteAttributes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
      • TargetNotFoundException The specified target wasn't found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and Region-specific.
      • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • deleteAttributes

      default CompletableFuture<DeleteAttributesResponse> deleteAttributes(Consumer<DeleteAttributesRequest.Builder> deleteAttributesRequest)

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

      Parameters:
      deleteAttributesRequest - A Consumer that will call methods on DeleteAttributesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAttributes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
      • TargetNotFoundException The specified target wasn't found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and Region-specific.
      • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • deleteCapacityProvider

      default CompletableFuture<DeleteCapacityProviderResponse> deleteCapacityProvider(DeleteCapacityProviderRequest deleteCapacityProviderRequest)

      Deletes the specified capacity provider.

      The FARGATE and FARGATE_SPOT capacity providers are reserved and can't be deleted. You can disassociate them from a cluster using either PutCapacityProviderProviders or by deleting the cluster.

      Prior to a capacity provider being deleted, the capacity provider must be removed from the capacity provider strategy from all services. The UpdateService API can be used to remove a capacity provider from a service's capacity provider strategy. When updating a service, the forceNewDeployment option can be used to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity provider are transitioned to use the capacity from the remaining capacity providers. Only capacity providers that aren't associated with a cluster can be deleted. To remove a capacity provider from a cluster, you can either use PutCapacityProviderProviders or delete the cluster.

      Parameters:
      deleteCapacityProviderRequest -
      Returns:
      A Java Future containing the result of the DeleteCapacityProvider operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • deleteCapacityProvider

      default CompletableFuture<DeleteCapacityProviderResponse> deleteCapacityProvider(Consumer<DeleteCapacityProviderRequest.Builder> deleteCapacityProviderRequest)

      Deletes the specified capacity provider.

      The FARGATE and FARGATE_SPOT capacity providers are reserved and can't be deleted. You can disassociate them from a cluster using either PutCapacityProviderProviders or by deleting the cluster.

      Prior to a capacity provider being deleted, the capacity provider must be removed from the capacity provider strategy from all services. The UpdateService API can be used to remove a capacity provider from a service's capacity provider strategy. When updating a service, the forceNewDeployment option can be used to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity provider are transitioned to use the capacity from the remaining capacity providers. Only capacity providers that aren't associated with a cluster can be deleted. To remove a capacity provider from a cluster, you can either use PutCapacityProviderProviders or delete the cluster.


      This is a convenience which creates an instance of the DeleteCapacityProviderRequest.Builder avoiding the need to create one manually via DeleteCapacityProviderRequest.builder()

      Parameters:
      deleteCapacityProviderRequest - A Consumer that will call methods on DeleteCapacityProviderRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteCapacityProvider operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • deleteCluster

      default CompletableFuture<DeleteClusterResponse> deleteCluster(DeleteClusterRequest deleteClusterRequest)

      Deletes the specified cluster. The cluster transitions to the INACTIVE state. Clusters with an INACTIVE status might remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely on INACTIVE clusters persisting.

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

      Parameters:
      deleteClusterRequest -
      Returns:
      A Java Future containing the result of the DeleteCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • ClusterContainsContainerInstancesException You can't 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 can't 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 can't delete a cluster that has active tasks.
        • UpdateInProgressException There's already a current Amazon ECS container agent update in progress on the container instance that's specified. If the container agent becomes disconnected while it's 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.
        • 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.
      See Also:

    • deleteCluster

      default CompletableFuture<DeleteClusterResponse> deleteCluster(Consumer<DeleteClusterRequest.Builder> deleteClusterRequest)

      Deletes the specified cluster. The cluster transitions to the INACTIVE state. Clusters with an INACTIVE status might remain discoverable in your account for a period of time. However, this behavior is subject to change in the future. We don't recommend that you rely on INACTIVE clusters persisting.

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

      Parameters:
      deleteClusterRequest - A Consumer that will call methods on DeleteClusterRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • ClusterContainsContainerInstancesException You can't 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 can't 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 can't delete a cluster that has active tasks.
        • UpdateInProgressException There's already a current Amazon ECS container agent update in progress on the container instance that's specified. If the container agent becomes disconnected while it's 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.
        • 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.
      See Also:

    • deleteService

      default CompletableFuture<DeleteServiceResponse> deleteService(DeleteServiceRequest deleteServiceRequest)

      Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you can't 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 all tasks have transitioned to either STOPPING or STOPPED status, 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.

      Parameters:
      deleteServiceRequest -
      Returns:
      A Java Future containing the result of the DeleteService operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • ServiceNotFoundException The specified service wasn't 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.
      See Also:

    • deleteService

      default CompletableFuture<DeleteServiceResponse> deleteService(Consumer<DeleteServiceRequest.Builder> deleteServiceRequest)

      Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you can't 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 all tasks have transitioned to either STOPPING or STOPPED status, 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()

      Parameters:
      deleteServiceRequest - A Consumer that will call methods on DeleteServiceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteService operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • ServiceNotFoundException The specified service wasn't 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.
      See Also:

    • deleteTaskDefinitions

      default CompletableFuture<DeleteTaskDefinitionsResponse> deleteTaskDefinitions(DeleteTaskDefinitionsRequest deleteTaskDefinitionsRequest)

      Deletes one or more task definitions.

      You must deregister a task definition revision before you delete it. For more information, see DeregisterTaskDefinition.

      When you delete a task definition revision, it is immediately transitions from the INACTIVE to DELETE_IN_PROGRESS. Existing tasks and services that reference a DELETE_IN_PROGRESS task definition revision continue to run without disruption. Existing services that reference a DELETE_IN_PROGRESS task definition revision can still scale up or down by modifying the service's desired count.

      You can't use a DELETE_IN_PROGRESS task definition revision to run new tasks or create new services. You also can't update an existing service to reference a DELETE_IN_PROGRESS task definition revision.

      A task definition revision will stay in DELETE_IN_PROGRESS status until all the associated tasks and services have been terminated.

      When you delete all INACTIVE task definition revisions, the task definition name is not displayed in the console and not returned in the API. If a task definition revisions are in the DELETE_IN_PROGRESS state, the task definition name is displayed in the console and returned in the API. The task definition name is retained by Amazon ECS and the revision is incremented the next time you create a task definition with that name.

      Parameters:
      deleteTaskDefinitionsRequest -
      Returns:
      A Java Future containing the result of the DeleteTaskDefinitions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have authorization to perform the requested action.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ServerException These errors are usually caused by a server issue.
        • 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.
      See Also:

    • deleteTaskDefinitions

      default CompletableFuture<DeleteTaskDefinitionsResponse> deleteTaskDefinitions(Consumer<DeleteTaskDefinitionsRequest.Builder> deleteTaskDefinitionsRequest)

      Deletes one or more task definitions.

      You must deregister a task definition revision before you delete it. For more information, see DeregisterTaskDefinition.

      When you delete a task definition revision, it is immediately transitions from the INACTIVE to DELETE_IN_PROGRESS. Existing tasks and services that reference a DELETE_IN_PROGRESS task definition revision continue to run without disruption. Existing services that reference a DELETE_IN_PROGRESS task definition revision can still scale up or down by modifying the service's desired count.

      You can't use a DELETE_IN_PROGRESS task definition revision to run new tasks or create new services. You also can't update an existing service to reference a DELETE_IN_PROGRESS task definition revision.

      A task definition revision will stay in DELETE_IN_PROGRESS status until all the associated tasks and services have been terminated.

      When you delete all INACTIVE task definition revisions, the task definition name is not displayed in the console and not returned in the API. If a task definition revisions are in the DELETE_IN_PROGRESS state, the task definition name is displayed in the console and returned in the API. The task definition name is retained by Amazon ECS and the revision is incremented the next time you create a task definition with that name.


      This is a convenience which creates an instance of the DeleteTaskDefinitionsRequest.Builder avoiding the need to create one manually via DeleteTaskDefinitionsRequest.builder()

      Parameters:
      deleteTaskDefinitionsRequest - A Consumer that will call methods on DeleteTaskDefinitionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteTaskDefinitions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have authorization to perform the requested action.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ServerException These errors are usually caused by a server issue.
        • 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.
      See Also:

    • deleteTaskSet

      default CompletableFuture<DeleteTaskSetResponse> deleteTaskSet(DeleteTaskSetRequest deleteTaskSetRequest)

      Deletes a specified task set within a service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      deleteTaskSetRequest -
      Returns:
      A Java Future containing the result of the DeleteTaskSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • UnsupportedFeatureException The specified task isn't supported in this Region.
        • AccessDeniedException You don't have authorization to perform the requested action.
        • ServiceNotFoundException The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.
        • ServiceNotActiveException The specified service isn't active. You can't update a service that's inactive. If you have previously deleted a service, you can re-create it with CreateService.
        • TaskSetNotFoundException The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region.
        • 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.
      See Also:

    • deleteTaskSet

      default CompletableFuture<DeleteTaskSetResponse> deleteTaskSet(Consumer<DeleteTaskSetRequest.Builder> deleteTaskSetRequest)

      Deletes a specified task set within a service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS deployment types in the Amazon Elastic Container Service Developer Guide.


      This is a convenience which creates an instance of the DeleteTaskSetRequest.Builder avoiding the need to create one manually via DeleteTaskSetRequest.builder()

      Parameters:
      deleteTaskSetRequest - A Consumer that will call methods on DeleteTaskSetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteTaskSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • UnsupportedFeatureException The specified task isn't supported in this Region.
        • AccessDeniedException You don't have authorization to perform the requested action.
        • ServiceNotFoundException The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.
        • ServiceNotActiveException The specified service isn't active. You can't update a service that's inactive. If you have previously deleted a service, you can re-create it with CreateService.
        • TaskSetNotFoundException The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region.
        • 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.
      See Also:

    • deregisterContainerInstance

      default CompletableFuture<DeregisterContainerInstanceResponse> deregisterContainerInstance(DeregisterContainerInstanceRequest deregisterContainerInstanceRequest)

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

      If you intend to use the container instance for some other purpose after deregistration, we recommend that you 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 doesn't 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 aren't automatically deregistered when terminated).

      Parameters:
      deregisterContainerInstanceRequest -
      Returns:
      A Java Future containing the result of the DeregisterContainerInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't 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.
      See Also:

    • deregisterContainerInstance

      default CompletableFuture<DeregisterContainerInstanceResponse> deregisterContainerInstance(Consumer<DeregisterContainerInstanceRequest.Builder> deregisterContainerInstanceRequest)

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

      If you intend to use the container instance for some other purpose after deregistration, we recommend that you 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 doesn't 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 aren't 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()

      Parameters:
      deregisterContainerInstanceRequest - A Consumer that will call methods on DeregisterContainerInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeregisterContainerInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't 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.
      See Also:

    • deregisterTaskDefinition

      default CompletableFuture<DeregisterTaskDefinitionResponse> deregisterTaskDefinition(DeregisterTaskDefinitionRequest deregisterTaskDefinitionRequest)

      Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE. Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service's desired count. If you want to delete a task definition revision, you must first deregister the task definition revision.

      You can't use an INACTIVE task definition to run new tasks or create new services, and you can't 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. We don't recommend that you rely on INACTIVE task definitions persisting beyond the lifecycle of any associated tasks and services.

      You must deregister a task definition revision before you delete it. For more information, see DeleteTaskDefinitions.

      Parameters:
      deregisterTaskDefinitionRequest -
      Returns:
      A Java Future containing the result of the DeregisterTaskDefinition operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • deregisterTaskDefinition

      default CompletableFuture<DeregisterTaskDefinitionResponse> deregisterTaskDefinition(Consumer<DeregisterTaskDefinitionRequest.Builder> deregisterTaskDefinitionRequest)

      Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE. Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service's desired count. If you want to delete a task definition revision, you must first deregister the task definition revision.

      You can't use an INACTIVE task definition to run new tasks or create new services, and you can't 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. We don't recommend that you rely on INACTIVE task definitions persisting beyond the lifecycle of any associated tasks and services.

      You must deregister a task definition revision before you delete it. For more information, see DeleteTaskDefinitions.


      This is a convenience which creates an instance of the DeregisterTaskDefinitionRequest.Builder avoiding the need to create one manually via DeregisterTaskDefinitionRequest.builder()

      Parameters:
      deregisterTaskDefinitionRequest - A Consumer that will call methods on DeregisterTaskDefinitionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeregisterTaskDefinition operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • describeCapacityProviders

      default CompletableFuture<DescribeCapacityProvidersResponse> describeCapacityProviders(DescribeCapacityProvidersRequest describeCapacityProvidersRequest)

      Describes one or more of your capacity providers.

      Parameters:
      describeCapacityProvidersRequest -
      Returns:
      A Java Future containing the result of the DescribeCapacityProviders operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • describeCapacityProviders

      default CompletableFuture<DescribeCapacityProvidersResponse> describeCapacityProviders(Consumer<DescribeCapacityProvidersRequest.Builder> describeCapacityProvidersRequest)

      Describes one or more of your capacity providers.


      This is a convenience which creates an instance of the DescribeCapacityProvidersRequest.Builder avoiding the need to create one manually via DescribeCapacityProvidersRequest.builder()

      Parameters:
      describeCapacityProvidersRequest - A Consumer that will call methods on DescribeCapacityProvidersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeCapacityProviders operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • describeClusters

      default CompletableFuture<DescribeClustersResponse> describeClusters(DescribeClustersRequest describeClustersRequest)

      Describes one or more of your clusters.

      Parameters:
      describeClustersRequest -
      Returns:
      A Java Future containing the result of the DescribeClusters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • describeClusters

      default CompletableFuture<DescribeClustersResponse> describeClusters(Consumer<DescribeClustersRequest.Builder> describeClustersRequest)

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

      Parameters:
      describeClustersRequest - A Consumer that will call methods on DescribeClustersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeClusters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • describeClusters

      default CompletableFuture<DescribeClustersResponse> describeClusters()

      Describes one or more of your clusters.

      Returns:
      A Java Future containing the result of the DescribeClusters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • describeContainerInstances

      default CompletableFuture<DescribeContainerInstancesResponse> describeContainerInstances(DescribeContainerInstancesRequest describeContainerInstancesRequest)

      Describes one or more container instances. Returns metadata about each container instance requested.

      Parameters:
      describeContainerInstancesRequest -
      Returns:
      A Java Future containing the result of the DescribeContainerInstances operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't 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.
      See Also:

    • describeContainerInstances

      default CompletableFuture<DescribeContainerInstancesResponse> describeContainerInstances(Consumer<DescribeContainerInstancesRequest.Builder> describeContainerInstancesRequest)

      Describes one or more container instances. Returns metadata about 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()

      Parameters:
      describeContainerInstancesRequest - A Consumer that will call methods on DescribeContainerInstancesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeContainerInstances operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't 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.
      See Also:

    • describeServices

      default CompletableFuture<DescribeServicesResponse> describeServices(DescribeServicesRequest describeServicesRequest)

      Describes the specified services running in your cluster.

      Parameters:
      describeServicesRequest -
      Returns:
      A Java Future containing the result of the DescribeServices operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't 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.
      See Also:

    • describeServices

      default CompletableFuture<DescribeServicesResponse> describeServices(Consumer<DescribeServicesRequest.Builder> describeServicesRequest)

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

      Parameters:
      describeServicesRequest - A Consumer that will call methods on DescribeServicesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeServices operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't 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.
      See Also:

    • describeTaskDefinition

      default CompletableFuture<DescribeTaskDefinitionResponse> describeTaskDefinition(DescribeTaskDefinitionRequest describeTaskDefinitionRequest)

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

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

      Parameters:
      describeTaskDefinitionRequest -
      Returns:
      A Java Future containing the result of the DescribeTaskDefinition operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • describeTaskDefinition

      default CompletableFuture<DescribeTaskDefinitionResponse> describeTaskDefinition(Consumer<DescribeTaskDefinitionRequest.Builder> describeTaskDefinitionRequest)

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

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


      This is a convenience which creates an instance of the DescribeTaskDefinitionRequest.Builder avoiding the need to create one manually via DescribeTaskDefinitionRequest.builder()

      Parameters:
      describeTaskDefinitionRequest - A Consumer that will call methods on DescribeTaskDefinitionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeTaskDefinition operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • describeTaskSets

      default CompletableFuture<DescribeTaskSetsResponse> describeTaskSets(DescribeTaskSetsRequest describeTaskSetsRequest)

      Describes the task sets in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      describeTaskSetsRequest -
      Returns:
      A Java Future containing the result of the DescribeTaskSets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • UnsupportedFeatureException The specified task isn't supported in this Region.
        • AccessDeniedException You don't have authorization to perform the requested action.
        • ServiceNotFoundException The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.
        • ServiceNotActiveException The specified service isn't active. You can't update a service that's inactive. If you have previously deleted a service, you can re-create it with CreateService.
        • 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.
      See Also:

    • describeTaskSets

      default CompletableFuture<DescribeTaskSetsResponse> describeTaskSets(Consumer<DescribeTaskSetsRequest.Builder> describeTaskSetsRequest)

      Describes the task sets in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.


      This is a convenience which creates an instance of the DescribeTaskSetsRequest.Builder avoiding the need to create one manually via DescribeTaskSetsRequest.builder()

      Parameters:
      describeTaskSetsRequest - A Consumer that will call methods on DescribeTaskSetsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeTaskSets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • UnsupportedFeatureException The specified task isn't supported in this Region.
        • AccessDeniedException You don't have authorization to perform the requested action.
        • ServiceNotFoundException The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.
        • ServiceNotActiveException The specified service isn't active. You can't update a service that's inactive. If you have previously deleted a service, you can re-create it with CreateService.
        • 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.
      See Also:

    • describeTasks

      default CompletableFuture<DescribeTasksResponse> describeTasks(DescribeTasksRequest describeTasksRequest)

      Describes a specified task or tasks.

      Currently, stopped tasks appear in the returned results for at least one hour.

      If you have tasks with tags, and then delete the cluster, the tagged tasks are returned in the response. If you create a new cluster with the same name as the deleted cluster, the tagged tasks are not included in the response.

      Parameters:
      describeTasksRequest -
      Returns:
      A Java Future containing the result of the DescribeTasks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't 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.
      See Also:

    • describeTasks

      default CompletableFuture<DescribeTasksResponse> describeTasks(Consumer<DescribeTasksRequest.Builder> describeTasksRequest)

      Describes a specified task or tasks.

      Currently, stopped tasks appear in the returned results for at least one hour.

      If you have tasks with tags, and then delete the cluster, the tagged tasks are returned in the response. If you create a new cluster with the same name as the deleted cluster, the tagged tasks are not included in the response.


      This is a convenience which creates an instance of the DescribeTasksRequest.Builder avoiding the need to create one manually via DescribeTasksRequest.builder()

      Parameters:
      describeTasksRequest - A Consumer that will call methods on DescribeTasksRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeTasks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't 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.
      See Also:

    • discoverPollEndpoint

      default CompletableFuture<DiscoverPollEndpointResponse> discoverPollEndpoint(DiscoverPollEndpointRequest discoverPollEndpointRequest)

      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.

      Parameters:
      discoverPollEndpointRequest -
      Returns:
      A Java Future containing the result of the DiscoverPollEndpoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • 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.
      See Also:

    • discoverPollEndpoint

      default CompletableFuture<DiscoverPollEndpointResponse> discoverPollEndpoint(Consumer<DiscoverPollEndpointRequest.Builder> discoverPollEndpointRequest)

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

      Parameters:
      discoverPollEndpointRequest - A Consumer that will call methods on DiscoverPollEndpointRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DiscoverPollEndpoint operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • 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.
      See Also:

    • executeCommand

      default CompletableFuture<ExecuteCommandResponse> executeCommand(ExecuteCommandRequest executeCommandRequest)

      Runs a command remotely on a container within a task.

      If you use a condition key in your IAM policy to refine the conditions for the policy statement, for example limit the actions to a specific cluster, you receive an AccessDeniedException when there is a mismatch between the condition key value and the corresponding parameter value.

      For information about required permissions and considerations, see Using Amazon ECS Exec for debugging in the Amazon ECS Developer Guide.

      Parameters:
      executeCommandRequest -
      Returns:
      A Java Future containing the result of the ExecuteCommand operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • AccessDeniedException You don't have authorization to perform the requested action.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • TargetNotConnectedException The execute command cannot run. This error can be caused by any of the following configuration issues:

          • Incorrect IAM permissions

          • The SSM agent is not installed or is not running

          • There is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for Systems Manager Session Manager

          For information about how to troubleshoot the issues, see Troubleshooting issues with ECS Exec in the Amazon Elastic Container Service Developer Guide.

        • 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.
      See Also:

    • executeCommand

      default CompletableFuture<ExecuteCommandResponse> executeCommand(Consumer<ExecuteCommandRequest.Builder> executeCommandRequest)

      Runs a command remotely on a container within a task.

      If you use a condition key in your IAM policy to refine the conditions for the policy statement, for example limit the actions to a specific cluster, you receive an AccessDeniedException when there is a mismatch between the condition key value and the corresponding parameter value.

      For information about required permissions and considerations, see Using Amazon ECS Exec for debugging in the Amazon ECS Developer Guide.


      This is a convenience which creates an instance of the ExecuteCommandRequest.Builder avoiding the need to create one manually via ExecuteCommandRequest.builder()

      Parameters:
      executeCommandRequest - A Consumer that will call methods on ExecuteCommandRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ExecuteCommand operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • AccessDeniedException You don't have authorization to perform the requested action.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • TargetNotConnectedException The execute command cannot run. This error can be caused by any of the following configuration issues:

          • Incorrect IAM permissions

          • The SSM agent is not installed or is not running

          • There is an interface Amazon VPC endpoint for Amazon ECS, but there is not one for Systems Manager Session Manager

          For information about how to troubleshoot the issues, see Troubleshooting issues with ECS Exec in the Amazon Elastic Container Service Developer Guide.

        • 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.
      See Also:

    • getTaskProtection

      default CompletableFuture<GetTaskProtectionResponse> getTaskProtection(GetTaskProtectionRequest getTaskProtectionRequest)

      Retrieves the protection status of tasks in an Amazon ECS service.

      Parameters:
      getTaskProtectionRequest -
      Returns:
      A Java Future containing the result of the GetTaskProtection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have authorization to perform the requested action.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ResourceNotFoundException The specified resource wasn't found.
        • ServerException These errors are usually caused by a server issue.
        • UnsupportedFeatureException The specified task isn't supported in this Region.
        • 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.
      See Also:

    • getTaskProtection

      default CompletableFuture<GetTaskProtectionResponse> getTaskProtection(Consumer<GetTaskProtectionRequest.Builder> getTaskProtectionRequest)

      Retrieves the protection status of tasks in an Amazon ECS service.


      This is a convenience which creates an instance of the GetTaskProtectionRequest.Builder avoiding the need to create one manually via GetTaskProtectionRequest.builder()

      Parameters:
      getTaskProtectionRequest - A Consumer that will call methods on GetTaskProtectionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetTaskProtection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have authorization to perform the requested action.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ResourceNotFoundException The specified resource wasn't found.
        • ServerException These errors are usually caused by a server issue.
        • UnsupportedFeatureException The specified task isn't supported in this Region.
        • 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.
      See Also:

    • listAccountSettings

      default CompletableFuture<ListAccountSettingsResponse> listAccountSettings(ListAccountSettingsRequest listAccountSettingsRequest)

      Lists the account settings for a specified principal.

      Parameters:
      listAccountSettingsRequest -
      Returns:
      A Java Future containing the result of the ListAccountSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listAccountSettings

      default CompletableFuture<ListAccountSettingsResponse> listAccountSettings(Consumer<ListAccountSettingsRequest.Builder> listAccountSettingsRequest)

      Lists the account settings 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()

      Parameters:
      listAccountSettingsRequest - A Consumer that will call methods on ListAccountSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAccountSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listAccountSettings

      default CompletableFuture<ListAccountSettingsResponse> listAccountSettings()

      Lists the account settings for a specified principal.

      Returns:
      A Java Future containing the result of the ListAccountSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listAccountSettingsPaginator

      default ListAccountSettingsPublisher listAccountSettingsPaginator()

      This is a variant of listAccountSettings(software.amazon.awssdk.services.ecs.model.ListAccountSettingsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ecs.paginators.ListAccountSettingsPublisher publisher = client.listAccountSettingsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ecs.paginators.ListAccountSettingsPublisher publisher = client.listAccountSettingsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListAccountSettingsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ecs.model.ListAccountSettingsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAccountSettings(software.amazon.awssdk.services.ecs.model.ListAccountSettingsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listAccountSettingsPaginator

      default ListAccountSettingsPublisher listAccountSettingsPaginator(ListAccountSettingsRequest listAccountSettingsRequest)

      This is a variant of listAccountSettings(software.amazon.awssdk.services.ecs.model.ListAccountSettingsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ecs.paginators.ListAccountSettingsPublisher publisher = client.listAccountSettingsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ecs.paginators.ListAccountSettingsPublisher publisher = client.listAccountSettingsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListAccountSettingsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ecs.model.ListAccountSettingsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAccountSettings(software.amazon.awssdk.services.ecs.model.ListAccountSettingsRequest) operation.

      Parameters:
      listAccountSettingsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listAccountSettingsPaginator

      default ListAccountSettingsPublisher listAccountSettingsPaginator(Consumer<ListAccountSettingsRequest.Builder> listAccountSettingsRequest)

      This is a variant of listAccountSettings(software.amazon.awssdk.services.ecs.model.ListAccountSettingsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ecs.paginators.ListAccountSettingsPublisher publisher = client.listAccountSettingsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ecs.paginators.ListAccountSettingsPublisher publisher = client.listAccountSettingsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListAccountSettingsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ecs.model.ListAccountSettingsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAccountSettings(software.amazon.awssdk.services.ecs.model.ListAccountSettingsRequest) operation.


      This is a convenience which creates an instance of the ListAccountSettingsRequest.Builder avoiding the need to create one manually via ListAccountSettingsRequest.builder()

      Parameters:
      listAccountSettingsRequest - A Consumer that will call methods on ListAccountSettingsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listAttributes

      default CompletableFuture<ListAttributesResponse> listAttributes(ListAttributesRequest listAttributesRequest)

      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. You can do this, for example, to see which container instances in a cluster are running a Linux AMI (ecs.os-type=linux).

      Parameters:
      listAttributesRequest -
      Returns:
      A Java Future containing the result of the ListAttributes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
      • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listAttributes

      default CompletableFuture<ListAttributesResponse> listAttributes(Consumer<ListAttributesRequest.Builder> listAttributesRequest)

      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. You can do this, 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()

      Parameters:
      listAttributesRequest - A Consumer that will call methods on ListAttributesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAttributes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
      • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listAttributesPaginator

      default ListAttributesPublisher listAttributesPaginator(ListAttributesRequest listAttributesRequest)

      This is a variant of listAttributes(software.amazon.awssdk.services.ecs.model.ListAttributesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ecs.paginators.ListAttributesPublisher publisher = client.listAttributesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ecs.paginators.ListAttributesPublisher publisher = client.listAttributesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListAttributesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ecs.model.ListAttributesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAttributes(software.amazon.awssdk.services.ecs.model.ListAttributesRequest) operation.

      Parameters:
      listAttributesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
      • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listAttributesPaginator

      default ListAttributesPublisher listAttributesPaginator(Consumer<ListAttributesRequest.Builder> listAttributesRequest)

      This is a variant of listAttributes(software.amazon.awssdk.services.ecs.model.ListAttributesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ecs.paginators.ListAttributesPublisher publisher = client.listAttributesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ecs.paginators.ListAttributesPublisher publisher = client.listAttributesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListAttributesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ecs.model.ListAttributesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listAttributes(software.amazon.awssdk.services.ecs.model.ListAttributesRequest) operation.


      This is a convenience which creates an instance of the ListAttributesRequest.Builder avoiding the need to create one manually via ListAttributesRequest.builder()

      Parameters:
      listAttributesRequest - A Consumer that will call methods on ListAttributesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
      • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listClusters

      default CompletableFuture<ListClustersResponse> listClusters(ListClustersRequest listClustersRequest)

      Returns a list of existing clusters.

      Parameters:
      listClustersRequest -
      Returns:
      A Java Future containing the result of the ListClusters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listClusters

      default CompletableFuture<ListClustersResponse> listClusters(Consumer<ListClustersRequest.Builder> listClustersRequest)

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

      Parameters:
      listClustersRequest - A Consumer that will call methods on ListClustersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListClusters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listClusters

      default CompletableFuture<ListClustersResponse> listClusters()

      Returns a list of existing clusters.

      Returns:
      A Java Future containing the result of the ListClusters operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listClustersPaginator

      default ListClustersPublisher listClustersPaginator()

      This is a variant of listClusters(software.amazon.awssdk.services.ecs.model.ListClustersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ecs.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ecs.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListClustersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ecs.model.ListClustersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listClusters(software.amazon.awssdk.services.ecs.model.ListClustersRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listClustersPaginator

      default ListClustersPublisher listClustersPaginator(ListClustersRequest listClustersRequest)

      This is a variant of listClusters(software.amazon.awssdk.services.ecs.model.ListClustersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ecs.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ecs.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListClustersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ecs.model.ListClustersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listClusters(software.amazon.awssdk.services.ecs.model.ListClustersRequest) operation.

      Parameters:
      listClustersRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listClustersPaginator

      default ListClustersPublisher listClustersPaginator(Consumer<ListClustersRequest.Builder> listClustersRequest)

      This is a variant of listClusters(software.amazon.awssdk.services.ecs.model.ListClustersRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ecs.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ecs.paginators.ListClustersPublisher publisher = client.listClustersPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListClustersResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ecs.model.ListClustersResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

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

      Parameters:
      listClustersRequest - A Consumer that will call methods on ListClustersRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listContainerInstances

      default CompletableFuture<ListContainerInstancesResponse> listContainerInstances(ListContainerInstancesRequest listContainerInstancesRequest)

      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.

      Parameters:
      listContainerInstancesRequest -
      Returns:
      A Java Future containing the result of the ListContainerInstances operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't 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.
      See Also:

    • listContainerInstances

      default CompletableFuture<ListContainerInstancesResponse> listContainerInstances(Consumer<ListContainerInstancesRequest.Builder> listContainerInstancesRequest)

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

      Parameters:
      listContainerInstancesRequest - A Consumer that will call methods on ListContainerInstancesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListContainerInstances operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't 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.
      See Also:

    • listContainerInstances

      default CompletableFuture<ListContainerInstancesResponse> listContainerInstances()

      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.

      Returns:
      A Java Future containing the result of the ListContainerInstances operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't 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.
      See Also:

    • listContainerInstancesPaginator

      default ListContainerInstancesPublisher listContainerInstancesPaginator()

      This is a variant of listContainerInstances(software.amazon.awssdk.services.ecs.model.ListContainerInstancesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ecs.paginators.ListContainerInstancesPublisher publisher = client.listContainerInstancesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ecs.paginators.ListContainerInstancesPublisher publisher = client.listContainerInstancesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListContainerInstancesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ecs.model.ListContainerInstancesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listContainerInstances(software.amazon.awssdk.services.ecs.model.ListContainerInstancesRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't 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.
      See Also:

    • listContainerInstancesPaginator

      default ListContainerInstancesPublisher listContainerInstancesPaginator(ListContainerInstancesRequest listContainerInstancesRequest)

      This is a variant of listContainerInstances(software.amazon.awssdk.services.ecs.model.ListContainerInstancesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ecs.paginators.ListContainerInstancesPublisher publisher = client.listContainerInstancesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ecs.paginators.ListContainerInstancesPublisher publisher = client.listContainerInstancesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListContainerInstancesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ecs.model.ListContainerInstancesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listContainerInstances(software.amazon.awssdk.services.ecs.model.ListContainerInstancesRequest) operation.

      Parameters:
      listContainerInstancesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't 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.
      See Also:

    • listContainerInstancesPaginator

      default ListContainerInstancesPublisher listContainerInstancesPaginator(Consumer<ListContainerInstancesRequest.Builder> listContainerInstancesRequest)

      This is a variant of listContainerInstances(software.amazon.awssdk.services.ecs.model.ListContainerInstancesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ecs.paginators.ListContainerInstancesPublisher publisher = client.listContainerInstancesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ecs.paginators.ListContainerInstancesPublisher publisher = client.listContainerInstancesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListContainerInstancesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ecs.model.ListContainerInstancesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

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

      Parameters:
      listContainerInstancesRequest - A Consumer that will call methods on ListContainerInstancesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't 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.
      See Also:

    • listServices

      default CompletableFuture<ListServicesResponse> listServices(ListServicesRequest listServicesRequest)

      Returns a list of services. You can filter the results by cluster, launch type, and scheduling strategy.

      Parameters:
      listServicesRequest -
      Returns:
      A Java Future containing the result of the ListServices operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't 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.
      See Also:

    • listServices

      default CompletableFuture<ListServicesResponse> listServices(Consumer<ListServicesRequest.Builder> listServicesRequest)

      Returns a list of services. You can filter the results by cluster, launch type, and scheduling strategy.


      This is a convenience which creates an instance of the ListServicesRequest.Builder avoiding the need to create one manually via ListServicesRequest.builder()

      Parameters:
      listServicesRequest - A Consumer that will call methods on ListServicesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListServices operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't 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.
      See Also:

    • listServices

      default CompletableFuture<ListServicesResponse> listServices()

      Returns a list of services. You can filter the results by cluster, launch type, and scheduling strategy.

      Returns:
      A Java Future containing the result of the ListServices operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't 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.
      See Also:

    • listServicesByNamespace

      default CompletableFuture<ListServicesByNamespaceResponse> listServicesByNamespace(ListServicesByNamespaceRequest listServicesByNamespaceRequest)

      This operation lists all of the services that are associated with a Cloud Map namespace. This list might include services in different clusters. In contrast, ListServices can only list services in one cluster at a time. If you need to filter the list of services in a single cluster by various parameters, use ListServices. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      listServicesByNamespaceRequest -
      Returns:
      A Java Future containing the result of the ListServicesByNamespace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • NamespaceNotFoundException The specified namespace wasn't found.
        • 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.
      See Also:

    • listServicesByNamespace

      default CompletableFuture<ListServicesByNamespaceResponse> listServicesByNamespace(Consumer<ListServicesByNamespaceRequest.Builder> listServicesByNamespaceRequest)

      This operation lists all of the services that are associated with a Cloud Map namespace. This list might include services in different clusters. In contrast, ListServices can only list services in one cluster at a time. If you need to filter the list of services in a single cluster by various parameters, use ListServices. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.


      This is a convenience which creates an instance of the ListServicesByNamespaceRequest.Builder avoiding the need to create one manually via ListServicesByNamespaceRequest.builder()

      Parameters:
      listServicesByNamespaceRequest - A Consumer that will call methods on ListServicesByNamespaceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListServicesByNamespace operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • NamespaceNotFoundException The specified namespace wasn't found.
        • 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.
      See Also:

    • listServicesByNamespacePaginator

      default ListServicesByNamespacePublisher listServicesByNamespacePaginator(ListServicesByNamespaceRequest listServicesByNamespaceRequest)

      This is a variant of listServicesByNamespace(software.amazon.awssdk.services.ecs.model.ListServicesByNamespaceRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ecs.paginators.ListServicesByNamespacePublisher publisher = client.listServicesByNamespacePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ecs.paginators.ListServicesByNamespacePublisher publisher = client.listServicesByNamespacePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListServicesByNamespaceResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ecs.model.ListServicesByNamespaceResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listServicesByNamespace(software.amazon.awssdk.services.ecs.model.ListServicesByNamespaceRequest) operation.

      Parameters:
      listServicesByNamespaceRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • NamespaceNotFoundException The specified namespace wasn't found.
        • 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.
      See Also:

    • listServicesByNamespacePaginator

      default ListServicesByNamespacePublisher listServicesByNamespacePaginator(Consumer<ListServicesByNamespaceRequest.Builder> listServicesByNamespaceRequest)

      This is a variant of listServicesByNamespace(software.amazon.awssdk.services.ecs.model.ListServicesByNamespaceRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ecs.paginators.ListServicesByNamespacePublisher publisher = client.listServicesByNamespacePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ecs.paginators.ListServicesByNamespacePublisher publisher = client.listServicesByNamespacePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListServicesByNamespaceResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ecs.model.ListServicesByNamespaceResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listServicesByNamespace(software.amazon.awssdk.services.ecs.model.ListServicesByNamespaceRequest) operation.


      This is a convenience which creates an instance of the ListServicesByNamespaceRequest.Builder avoiding the need to create one manually via ListServicesByNamespaceRequest.builder()

      Parameters:
      listServicesByNamespaceRequest - A Consumer that will call methods on ListServicesByNamespaceRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • NamespaceNotFoundException The specified namespace wasn't found.
        • 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.
      See Also:

    • listServicesPaginator

      default ListServicesPublisher listServicesPaginator()

      This is a variant of listServices(software.amazon.awssdk.services.ecs.model.ListServicesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ecs.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ecs.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListServicesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ecs.model.ListServicesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listServices(software.amazon.awssdk.services.ecs.model.ListServicesRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't 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.
      See Also:

    • listServicesPaginator

      default ListServicesPublisher listServicesPaginator(ListServicesRequest listServicesRequest)

      This is a variant of listServices(software.amazon.awssdk.services.ecs.model.ListServicesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ecs.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ecs.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListServicesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ecs.model.ListServicesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listServices(software.amazon.awssdk.services.ecs.model.ListServicesRequest) operation.

      Parameters:
      listServicesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't 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.
      See Also:

    • listServicesPaginator

      default ListServicesPublisher listServicesPaginator(Consumer<ListServicesRequest.Builder> listServicesRequest)

      This is a variant of listServices(software.amazon.awssdk.services.ecs.model.ListServicesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ecs.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ecs.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListServicesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ecs.model.ListServicesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

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

      Parameters:
      listServicesRequest - A Consumer that will call methods on ListServicesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't 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.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      List the tags for an Amazon ECS resource.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

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

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listTaskDefinitionFamilies

      default CompletableFuture<ListTaskDefinitionFamiliesResponse> listTaskDefinitionFamilies(ListTaskDefinitionFamiliesRequest listTaskDefinitionFamiliesRequest)

      Returns a list of task definition families that are registered to your account. This list includes task definition families that no longer have any ACTIVE task definition revisions.

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

      Parameters:
      listTaskDefinitionFamiliesRequest -
      Returns:
      A Java Future containing the result of the ListTaskDefinitionFamilies operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listTaskDefinitionFamilies

      default CompletableFuture<ListTaskDefinitionFamiliesResponse> listTaskDefinitionFamilies(Consumer<ListTaskDefinitionFamiliesRequest.Builder> listTaskDefinitionFamiliesRequest)

      Returns a list of task definition families that are registered to your account. This list includes task definition families that no longer have any ACTIVE task definition revisions.

      You can filter out task definition families that don't 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()

      Parameters:
      listTaskDefinitionFamiliesRequest - A Consumer that will call methods on ListTaskDefinitionFamiliesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTaskDefinitionFamilies operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listTaskDefinitionFamilies

      default CompletableFuture<ListTaskDefinitionFamiliesResponse> listTaskDefinitionFamilies()

      Returns a list of task definition families that are registered to your account. This list includes task definition families that no longer have any ACTIVE task definition revisions.

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

      Returns:
      A Java Future containing the result of the ListTaskDefinitionFamilies operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listTaskDefinitionFamiliesPaginator

      default ListTaskDefinitionFamiliesPublisher listTaskDefinitionFamiliesPaginator()

      This is a variant of listTaskDefinitionFamilies(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesPublisher publisher = client.listTaskDefinitionFamiliesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesPublisher publisher = client.listTaskDefinitionFamiliesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTaskDefinitionFamilies(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listTaskDefinitionFamiliesPaginator

      default ListTaskDefinitionFamiliesPublisher listTaskDefinitionFamiliesPaginator(ListTaskDefinitionFamiliesRequest listTaskDefinitionFamiliesRequest)

      This is a variant of listTaskDefinitionFamilies(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesPublisher publisher = client.listTaskDefinitionFamiliesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesPublisher publisher = client.listTaskDefinitionFamiliesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTaskDefinitionFamilies(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesRequest) operation.

      Parameters:
      listTaskDefinitionFamiliesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listTaskDefinitionFamiliesPaginator

      default ListTaskDefinitionFamiliesPublisher listTaskDefinitionFamiliesPaginator(Consumer<ListTaskDefinitionFamiliesRequest.Builder> listTaskDefinitionFamiliesRequest)

      This is a variant of listTaskDefinitionFamilies(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesPublisher publisher = client.listTaskDefinitionFamiliesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionFamiliesPublisher publisher = client.listTaskDefinitionFamiliesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionFamiliesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

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

      Parameters:
      listTaskDefinitionFamiliesRequest - A Consumer that will call methods on ListTaskDefinitionFamiliesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listTaskDefinitions

      default CompletableFuture<ListTaskDefinitionsResponse> listTaskDefinitions(ListTaskDefinitionsRequest listTaskDefinitionsRequest)

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

      Parameters:
      listTaskDefinitionsRequest -
      Returns:
      A Java Future containing the result of the ListTaskDefinitions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listTaskDefinitions

      default CompletableFuture<ListTaskDefinitionsResponse> listTaskDefinitions(Consumer<ListTaskDefinitionsRequest.Builder> listTaskDefinitionsRequest)

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


      This is a convenience which creates an instance of the ListTaskDefinitionsRequest.Builder avoiding the need to create one manually via ListTaskDefinitionsRequest.builder()

      Parameters:
      listTaskDefinitionsRequest - A Consumer that will call methods on ListTaskDefinitionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTaskDefinitions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listTaskDefinitions

      default CompletableFuture<ListTaskDefinitionsResponse> listTaskDefinitions()

      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.

      Returns:
      A Java Future containing the result of the ListTaskDefinitions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listTaskDefinitionsPaginator

      default ListTaskDefinitionsPublisher listTaskDefinitionsPaginator()

      This is a variant of listTaskDefinitions(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsPublisher publisher = client.listTaskDefinitionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsPublisher publisher = client.listTaskDefinitionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTaskDefinitions(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listTaskDefinitionsPaginator

      default ListTaskDefinitionsPublisher listTaskDefinitionsPaginator(ListTaskDefinitionsRequest listTaskDefinitionsRequest)

      This is a variant of listTaskDefinitions(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsPublisher publisher = client.listTaskDefinitionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsPublisher publisher = client.listTaskDefinitionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTaskDefinitions(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsRequest) operation.

      Parameters:
      listTaskDefinitionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listTaskDefinitionsPaginator

      default ListTaskDefinitionsPublisher listTaskDefinitionsPaginator(Consumer<ListTaskDefinitionsRequest.Builder> listTaskDefinitionsRequest)

      This is a variant of listTaskDefinitions(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsPublisher publisher = client.listTaskDefinitionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ecs.paginators.ListTaskDefinitionsPublisher publisher = client.listTaskDefinitionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ecs.model.ListTaskDefinitionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

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

      Parameters:
      listTaskDefinitionsRequest - A Consumer that will call methods on ListTaskDefinitionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • listTasks

      default CompletableFuture<ListTasksResponse> listTasks(ListTasksRequest listTasksRequest)

      Returns a list of tasks. You can filter the results by cluster, task definition family, container instance, launch type, what IAM principal started the task, or by the desired status of the task.

      Recently stopped tasks might appear in the returned results.

      Parameters:
      listTasksRequest -
      Returns:
      A Java Future containing the result of the ListTasks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • ServiceNotFoundException The specified service wasn't 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.
      See Also:

    • listTasks

      default CompletableFuture<ListTasksResponse> listTasks(Consumer<ListTasksRequest.Builder> listTasksRequest)

      Returns a list of tasks. You can filter the results by cluster, task definition family, container instance, launch type, what IAM principal started the task, or by the desired status of the task.

      Recently stopped tasks might appear in the returned results.


      This is a convenience which creates an instance of the ListTasksRequest.Builder avoiding the need to create one manually via ListTasksRequest.builder()

      Parameters:
      listTasksRequest - A Consumer that will call methods on ListTasksRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTasks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • ServiceNotFoundException The specified service wasn't 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.
      See Also:

    • listTasks

      default CompletableFuture<ListTasksResponse> listTasks()

      Returns a list of tasks. You can filter the results by cluster, task definition family, container instance, launch type, what IAM principal started the task, or by the desired status of the task.

      Recently stopped tasks might appear in the returned results.

      Returns:
      A Java Future containing the result of the ListTasks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • ServiceNotFoundException The specified service wasn't 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.
      See Also:

    • listTasksPaginator

      default ListTasksPublisher listTasksPaginator()

      This is a variant of listTasks(software.amazon.awssdk.services.ecs.model.ListTasksRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ecs.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ecs.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListTasksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ecs.model.ListTasksResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTasks(software.amazon.awssdk.services.ecs.model.ListTasksRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • ServiceNotFoundException The specified service wasn't 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.
      See Also:

    • listTasksPaginator

      default ListTasksPublisher listTasksPaginator(ListTasksRequest listTasksRequest)

      This is a variant of listTasks(software.amazon.awssdk.services.ecs.model.ListTasksRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ecs.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ecs.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListTasksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ecs.model.ListTasksResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTasks(software.amazon.awssdk.services.ecs.model.ListTasksRequest) operation.

      Parameters:
      listTasksRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • ServiceNotFoundException The specified service wasn't 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.
      See Also:

    • listTasksPaginator

      default ListTasksPublisher listTasksPaginator(Consumer<ListTasksRequest.Builder> listTasksRequest)

      This is a variant of listTasks(software.amazon.awssdk.services.ecs.model.ListTasksRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.ecs.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.ecs.paginators.ListTasksPublisher publisher = client.listTasksPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.ecs.model.ListTasksResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.ecs.model.ListTasksResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

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

      Parameters:
      listTasksRequest - A Consumer that will call methods on ListTasksRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • ServiceNotFoundException The specified service wasn't 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.
      See Also:

    • putAccountSetting

      default CompletableFuture<PutAccountSettingResponse> putAccountSetting(PutAccountSettingRequest putAccountSettingRequest)

      Modifies an account setting. Account settings are set on a per-Region basis.

      If you change the root user account setting, the default settings are reset for users and roles that do not have specified individual account settings. For more information, see Account Settings in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      putAccountSettingRequest -
      Returns:
      A Java Future containing the result of the PutAccountSetting operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • putAccountSetting

      default CompletableFuture<PutAccountSettingResponse> putAccountSetting(Consumer<PutAccountSettingRequest.Builder> putAccountSettingRequest)

      Modifies an account setting. Account settings are set on a per-Region basis.

      If you change the root user account setting, the default settings are reset for users and roles that do not have specified individual account settings. For more information, see Account Settings in the Amazon Elastic Container Service Developer Guide.


      This is a convenience which creates an instance of the PutAccountSettingRequest.Builder avoiding the need to create one manually via PutAccountSettingRequest.builder()

      Parameters:
      putAccountSettingRequest - A Consumer that will call methods on PutAccountSettingRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutAccountSetting operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • putAccountSettingDefault

      default CompletableFuture<PutAccountSettingDefaultResponse> putAccountSettingDefault(PutAccountSettingDefaultRequest putAccountSettingDefaultRequest)

      Modifies an account setting for all users on an account for whom no individual account setting has been specified. Account settings are set on a per-Region basis.

      Parameters:
      putAccountSettingDefaultRequest -
      Returns:
      A Java Future containing the result of the PutAccountSettingDefault operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • putAccountSettingDefault

      default CompletableFuture<PutAccountSettingDefaultResponse> putAccountSettingDefault(Consumer<PutAccountSettingDefaultRequest.Builder> putAccountSettingDefaultRequest)

      Modifies an account setting for all users on an account for whom no individual account setting has been specified. Account settings are set on a per-Region basis.


      This is a convenience which creates an instance of the PutAccountSettingDefaultRequest.Builder avoiding the need to create one manually via PutAccountSettingDefaultRequest.builder()

      Parameters:
      putAccountSettingDefaultRequest - A Consumer that will call methods on PutAccountSettingDefaultRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutAccountSettingDefault operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • putAttributes

      default CompletableFuture<PutAttributesResponse> putAttributes(PutAttributesRequest putAttributesRequest)

      Create or update an attribute on an Amazon ECS resource. If the attribute doesn't exist, it's 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.

      Parameters:
      putAttributesRequest -
      Returns:
      A Java Future containing the result of the PutAttributes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
      • TargetNotFoundException The specified target wasn't 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 for each 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 isn't valid. 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.
      See Also:

    • putAttributes

      default CompletableFuture<PutAttributesResponse> putAttributes(Consumer<PutAttributesRequest.Builder> putAttributesRequest)

      Create or update an attribute on an Amazon ECS resource. If the attribute doesn't exist, it's 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()

      Parameters:
      putAttributesRequest - A Consumer that will call methods on PutAttributesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutAttributes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
      • TargetNotFoundException The specified target wasn't 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 for each 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 isn't valid. 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.
      See Also:

    • putClusterCapacityProviders

      default CompletableFuture<PutClusterCapacityProvidersResponse> putClusterCapacityProviders(PutClusterCapacityProvidersRequest putClusterCapacityProvidersRequest)

      Modifies the available capacity providers and the default capacity provider strategy for a cluster.

      You must specify both the available capacity providers and a default capacity provider strategy for the cluster. If the specified cluster has existing capacity providers associated with it, you must specify all existing capacity providers in addition to any new ones you want to add. Any existing capacity providers that are associated with a cluster that are omitted from a PutClusterCapacityProviders API call will be disassociated with the cluster. You can only disassociate an existing capacity provider from a cluster if it's not being used by any existing tasks.

      When creating a service or running a task on a cluster, if no capacity provider or launch type is specified, then the cluster's default capacity provider strategy is used. We recommend that you define a default capacity provider strategy for your cluster. However, you must specify an empty array ([]) to bypass defining a default strategy.

      Parameters:
      putClusterCapacityProvidersRequest -
      Returns:
      A Java Future containing the result of the PutClusterCapacityProviders operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • ResourceInUseException The specified resource is in-use and can't be removed.
        • UpdateInProgressException There's already a current Amazon ECS container agent update in progress on the container instance that's specified. If the container agent becomes disconnected while it's 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.
        • 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.
      See Also:

    • putClusterCapacityProviders

      default CompletableFuture<PutClusterCapacityProvidersResponse> putClusterCapacityProviders(Consumer<PutClusterCapacityProvidersRequest.Builder> putClusterCapacityProvidersRequest)

      Modifies the available capacity providers and the default capacity provider strategy for a cluster.

      You must specify both the available capacity providers and a default capacity provider strategy for the cluster. If the specified cluster has existing capacity providers associated with it, you must specify all existing capacity providers in addition to any new ones you want to add. Any existing capacity providers that are associated with a cluster that are omitted from a PutClusterCapacityProviders API call will be disassociated with the cluster. You can only disassociate an existing capacity provider from a cluster if it's not being used by any existing tasks.

      When creating a service or running a task on a cluster, if no capacity provider or launch type is specified, then the cluster's default capacity provider strategy is used. We recommend that you define a default capacity provider strategy for your cluster. However, you must specify an empty array ([]) to bypass defining a default strategy.


      This is a convenience which creates an instance of the PutClusterCapacityProvidersRequest.Builder avoiding the need to create one manually via PutClusterCapacityProvidersRequest.builder()

      Parameters:
      putClusterCapacityProvidersRequest - A Consumer that will call methods on PutClusterCapacityProvidersRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutClusterCapacityProviders operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • ResourceInUseException The specified resource is in-use and can't be removed.
        • UpdateInProgressException There's already a current Amazon ECS container agent update in progress on the container instance that's specified. If the container agent becomes disconnected while it's 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.
        • 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.
      See Also:

    • registerContainerInstance

      default CompletableFuture<RegisterContainerInstanceResponse> registerContainerInstance(RegisterContainerInstanceRequest registerContainerInstanceRequest)

      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.

      Parameters:
      registerContainerInstanceRequest -
      Returns:
      A Java Future containing the result of the RegisterContainerInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • registerContainerInstance

      default CompletableFuture<RegisterContainerInstanceResponse> registerContainerInstance(Consumer<RegisterContainerInstanceRequest.Builder> registerContainerInstanceRequest)

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

      Parameters:
      registerContainerInstanceRequest - A Consumer that will call methods on RegisterContainerInstanceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RegisterContainerInstance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • registerTaskDefinition

      default CompletableFuture<RegisterTaskDefinitionResponse> registerTaskDefinition(RegisterTaskDefinitionRequest registerTaskDefinitionRequest)

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

      You can specify a role for your task with the taskRoleArn parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the Amazon Web Services services that are specified in the policy that's 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. 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.

      Parameters:
      registerTaskDefinitionRequest -
      Returns:
      A Java Future containing the result of the RegisterTaskDefinition operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • registerTaskDefinition

      default CompletableFuture<RegisterTaskDefinitionResponse> registerTaskDefinition(Consumer<RegisterTaskDefinitionRequest.Builder> registerTaskDefinitionRequest)

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

      You can specify a role for your task with the taskRoleArn parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the Amazon Web Services services that are specified in the policy that's 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. 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()

      Parameters:
      registerTaskDefinitionRequest - A Consumer that will call methods on RegisterTaskDefinitionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RegisterTaskDefinition operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • runTask

      default CompletableFuture<RunTaskResponse> runTask(RunTaskRequest runTaskRequest)

      Starts a new task using the specified task definition.

      On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

      Amazon Elastic Inference (EI) is no longer available to customers.

      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.

      You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

      The Amazon ECS API follows an eventual consistency model. This is because of 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.

      Parameters:
      runTaskRequest -
      Returns:
      A Java Future containing the result of the RunTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • UnsupportedFeatureException The specified task isn't supported in this Region.
        • PlatformUnknownException The specified platform version doesn't exist.
        • PlatformTaskDefinitionIncompatibilityException The specified platform version doesn't satisfy the required capabilities of the task definition.
        • AccessDeniedException You don't have authorization to perform the requested action.
        • BlockedException Your Amazon Web Services account was blocked. For more information, contact Amazon Web Services Support.
        • ConflictException The RunTask request could not be processed due to conflicts. The provided clientToken is already in use with a different RunTask request. The resourceIds are the existing task ARNs which are already associated with the clientToken.

          To fix this issue:

          • Run RunTask with a unique clientToken.

          • Run RunTask with the clientToken and the original set of parameters

          • 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.
      See Also:

    • runTask

      default CompletableFuture<RunTaskResponse> runTask(Consumer<RunTaskRequest.Builder> runTaskRequest)

      Starts a new task using the specified task definition.

      On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

      Amazon Elastic Inference (EI) is no longer available to customers.

      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.

      You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

      The Amazon ECS API follows an eventual consistency model. This is because of 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()

      Parameters:
      runTaskRequest - A Consumer that will call methods on RunTaskRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RunTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • UnsupportedFeatureException The specified task isn't supported in this Region.
        • PlatformUnknownException The specified platform version doesn't exist.
        • PlatformTaskDefinitionIncompatibilityException The specified platform version doesn't satisfy the required capabilities of the task definition.
        • AccessDeniedException You don't have authorization to perform the requested action.
        • BlockedException Your Amazon Web Services account was blocked. For more information, contact Amazon Web Services Support.
        • ConflictException The RunTask request could not be processed due to conflicts. The provided clientToken is already in use with a different RunTask request. The resourceIds are the existing task ARNs which are already associated with the clientToken.

          To fix this issue:

          • Run RunTask with a unique clientToken.

          • Run RunTask with the clientToken and the original set of parameters

          • 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.
      See Also:

    • startTask

      default CompletableFuture<StartTaskResponse> startTask(StartTaskRequest startTaskRequest)

      Starts a new task from the specified task definition on the specified container instance or instances.

      On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

      Amazon Elastic Inference (EI) is no longer available to customers.

      Alternatively, you can useRunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.

      You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      startTaskRequest -
      Returns:
      A Java Future containing the result of the StartTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • UnsupportedFeatureException The specified task isn't supported in this Region.
        • 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.
      See Also:

    • startTask

      default CompletableFuture<StartTaskResponse> startTask(Consumer<StartTaskRequest.Builder> startTaskRequest)

      Starts a new task from the specified task definition on the specified container instance or instances.

      On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

      Amazon Elastic Inference (EI) is no longer available to customers.

      Alternatively, you can useRunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.

      You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when creating or updating a service. For more infomation, see Amazon EBS volumes 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()

      Parameters:
      startTaskRequest - A Consumer that will call methods on StartTaskRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • UnsupportedFeatureException The specified task isn't supported in this Region.
        • 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.
      See Also:

    • stopTask

      default CompletableFuture<StopTaskResponse> stopTask(StopTaskRequest stopTaskRequest)

      Stops a running task. Any tags associated with the task will be deleted.

      When you call StopTask 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.

      For Windows containers, POSIX signals do not work and runtime stops the container by sending a CTRL_SHUTDOWN_EVENT. For more information, see Unable to react to graceful shutdown of (Windows) container #25982 on GitHub.

      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.

      Parameters:
      stopTaskRequest -
      Returns:
      A Java Future containing the result of the StopTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't 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.
      See Also:

    • stopTask

      default CompletableFuture<StopTaskResponse> stopTask(Consumer<StopTaskRequest.Builder> stopTaskRequest)

      Stops a running task. Any tags associated with the task will be deleted.

      When you call StopTask 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.

      For Windows containers, POSIX signals do not work and runtime stops the container by sending a CTRL_SHUTDOWN_EVENT. For more information, see Unable to react to graceful shutdown of (Windows) container #25982 on GitHub.

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

      Parameters:
      stopTaskRequest - A Consumer that will call methods on StopTaskRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StopTask operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't 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.
      See Also:

    • submitAttachmentStateChanges

      default CompletableFuture<SubmitAttachmentStateChangesResponse> submitAttachmentStateChanges(SubmitAttachmentStateChangesRequest submitAttachmentStateChangesRequest)

      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 an attachment changed states.

      Parameters:
      submitAttachmentStateChangesRequest -
      Returns:
      A Java Future containing the result of the SubmitAttachmentStateChanges operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • AccessDeniedException You don't have authorization to perform the requested action.
        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • submitAttachmentStateChanges

      default CompletableFuture<SubmitAttachmentStateChangesResponse> submitAttachmentStateChanges(Consumer<SubmitAttachmentStateChangesRequest.Builder> submitAttachmentStateChangesRequest)

      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 an attachment changed states.


      This is a convenience which creates an instance of the SubmitAttachmentStateChangesRequest.Builder avoiding the need to create one manually via SubmitAttachmentStateChangesRequest.builder()

      Parameters:
      submitAttachmentStateChangesRequest - A Consumer that will call methods on SubmitAttachmentStateChangesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SubmitAttachmentStateChanges operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • AccessDeniedException You don't have authorization to perform the requested action.
        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • submitContainerStateChange

      default CompletableFuture<SubmitContainerStateChangeResponse> submitContainerStateChange(SubmitContainerStateChangeRequest submitContainerStateChangeRequest)

      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.

      Parameters:
      submitContainerStateChangeRequest -
      Returns:
      A Java Future containing the result of the SubmitContainerStateChange operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • AccessDeniedException You don't 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.
      See Also:

    • submitContainerStateChange

      default CompletableFuture<SubmitContainerStateChangeResponse> submitContainerStateChange(Consumer<SubmitContainerStateChangeRequest.Builder> submitContainerStateChangeRequest)

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

      Parameters:
      submitContainerStateChangeRequest - A Consumer that will call methods on SubmitContainerStateChangeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SubmitContainerStateChange operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • AccessDeniedException You don't 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.
      See Also:

    • submitTaskStateChange

      default CompletableFuture<SubmitTaskStateChangeResponse> submitTaskStateChange(SubmitTaskStateChangeRequest submitTaskStateChangeRequest)

      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.

      Parameters:
      submitTaskStateChangeRequest -
      Returns:
      A Java Future containing the result of the SubmitTaskStateChange operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • AccessDeniedException You don't have authorization to perform the requested action.
        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • submitTaskStateChange

      default CompletableFuture<SubmitTaskStateChangeResponse> submitTaskStateChange(Consumer<SubmitTaskStateChangeRequest.Builder> submitTaskStateChangeRequest)

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

      Parameters:
      submitTaskStateChangeRequest - A Consumer that will call methods on SubmitTaskStateChangeRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the SubmitTaskStateChange operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • AccessDeniedException You don't have authorization to perform the requested action.
        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags that are associated with that resource are deleted as well.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • ResourceNotFoundException The specified resource wasn't found.
        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags that are 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()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • ResourceNotFoundException The specified resource wasn't found.
        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Deletes specified tags from a resource.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • ResourceNotFoundException The specified resource wasn't found.
        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

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

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • ResourceNotFoundException The specified resource wasn't found.
        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • updateCapacityProvider

      default CompletableFuture<UpdateCapacityProviderResponse> updateCapacityProvider(UpdateCapacityProviderRequest updateCapacityProviderRequest)

      Modifies the parameters for a capacity provider.

      Parameters:
      updateCapacityProviderRequest -
      Returns:
      A Java Future containing the result of the UpdateCapacityProvider operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • updateCapacityProvider

      default CompletableFuture<UpdateCapacityProviderResponse> updateCapacityProvider(Consumer<UpdateCapacityProviderRequest.Builder> updateCapacityProviderRequest)

      Modifies the parameters for a capacity provider.


      This is a convenience which creates an instance of the UpdateCapacityProviderRequest.Builder avoiding the need to create one manually via UpdateCapacityProviderRequest.builder()

      Parameters:
      updateCapacityProviderRequest - A Consumer that will call methods on UpdateCapacityProviderRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateCapacityProvider operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • updateCluster

      default CompletableFuture<UpdateClusterResponse> updateCluster(UpdateClusterRequest updateClusterRequest)

      Updates the cluster.

      Parameters:
      updateClusterRequest -
      Returns:
      A Java Future containing the result of the UpdateCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • NamespaceNotFoundException The specified namespace wasn't found.
        • 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.
      See Also:

    • updateCluster

      default CompletableFuture<UpdateClusterResponse> updateCluster(Consumer<UpdateClusterRequest.Builder> updateClusterRequest)

      Updates the cluster.


      This is a convenience which creates an instance of the UpdateClusterRequest.Builder avoiding the need to create one manually via UpdateClusterRequest.builder()

      Parameters:
      updateClusterRequest - A Consumer that will call methods on UpdateClusterRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateCluster operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • NamespaceNotFoundException The specified namespace wasn't found.
        • 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.
      See Also:

    • updateClusterSettings

      default CompletableFuture<UpdateClusterSettingsResponse> updateClusterSettings(UpdateClusterSettingsRequest updateClusterSettingsRequest)

      Modifies the settings to use for a cluster.

      Parameters:
      updateClusterSettingsRequest -
      Returns:
      A Java Future containing the result of the UpdateClusterSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • updateClusterSettings

      default CompletableFuture<UpdateClusterSettingsResponse> updateClusterSettings(Consumer<UpdateClusterSettingsRequest.Builder> updateClusterSettingsRequest)

      Modifies the settings to use for a cluster.


      This is a convenience which creates an instance of the UpdateClusterSettingsRequest.Builder avoiding the need to create one manually via UpdateClusterSettingsRequest.builder()

      Parameters:
      updateClusterSettingsRequest - A Consumer that will call methods on UpdateClusterSettingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateClusterSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • InvalidParameterException The specified parameter isn't valid. 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.
      See Also:

    • updateContainerAgent

      default CompletableFuture<UpdateContainerAgentResponse> updateContainerAgent(UpdateContainerAgentRequest updateContainerAgentRequest)

      Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent doesn't 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.

      The UpdateContainerAgent API isn't supported for container instances using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent, you can update the ecs-init package. This updates the agent. For more information, see Updating the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.

      Agent updates with the UpdateContainerAgent API operation do not apply to Windows container instances. We recommend that you launch new container instances to update the agent version in your Windows clusters.

      The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or Amazon Linux AMI 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.

      Parameters:
      updateContainerAgentRequest -
      Returns:
      A Java Future containing the result of the UpdateContainerAgent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • UpdateInProgressException There's already a current Amazon ECS container agent update in progress on the container instance that's specified. If the container agent becomes disconnected while it's 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's no update available for this Amazon ECS container agent. This might be because the agent is already running the latest version or because it's so old that there's no update path to the current version.
        • MissingVersionException Amazon ECS can't determine the current version of the Amazon ECS container agent on the container instance and doesn't have enough information to proceed with an update. This could be because the agent running on the container instance is a previous or custom version that doesn't 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.
      See Also:

    • updateContainerAgent

      default CompletableFuture<UpdateContainerAgentResponse> updateContainerAgent(Consumer<UpdateContainerAgentRequest.Builder> updateContainerAgentRequest)

      Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent doesn't 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.

      The UpdateContainerAgent API isn't supported for container instances using the Amazon ECS-optimized Amazon Linux 2 (arm64) AMI. To update the container agent, you can update the ecs-init package. This updates the agent. For more information, see Updating the Amazon ECS container agent in the Amazon Elastic Container Service Developer Guide.

      Agent updates with the UpdateContainerAgent API operation do not apply to Windows container instances. We recommend that you launch new container instances to update the agent version in your Windows clusters.

      The UpdateContainerAgent API requires an Amazon ECS-optimized AMI or Amazon Linux AMI 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()

      Parameters:
      updateContainerAgentRequest - A Consumer that will call methods on UpdateContainerAgentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateContainerAgent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • UpdateInProgressException There's already a current Amazon ECS container agent update in progress on the container instance that's specified. If the container agent becomes disconnected while it's 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's no update available for this Amazon ECS container agent. This might be because the agent is already running the latest version or because it's so old that there's no update path to the current version.
        • MissingVersionException Amazon ECS can't determine the current version of the Amazon ECS container agent on the container instance and doesn't have enough information to proceed with an update. This could be because the agent running on the container instance is a previous or custom version that doesn't 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.
      See Also:

    • updateContainerInstancesState

      default CompletableFuture<UpdateContainerInstancesStateResponse> updateContainerInstancesState(UpdateContainerInstancesStateRequest updateContainerInstancesStateRequest)

      Modifies the status of an Amazon ECS container instance.

      Once a container instance has reached an ACTIVE state, 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.

      A container instance can't be changed to DRAINING until it has reached an ACTIVE status. If the instance is in any other status, an error will be received.

      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're in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state and are reported as healthy by the load balancer.

      • The maximumPercent parameter represents an upper limit on the number of running tasks during task replacement. You can use this 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 aren't 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 a container instance has been drained, you can set a container instance to ACTIVE status and once it has reached that status the Amazon ECS scheduler can begin scheduling tasks on the instance again.

      Parameters:
      updateContainerInstancesStateRequest -
      Returns:
      A Java Future containing the result of the UpdateContainerInstancesState operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't 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.
      See Also:

    • updateContainerInstancesState

      default CompletableFuture<UpdateContainerInstancesStateResponse> updateContainerInstancesState(Consumer<UpdateContainerInstancesStateRequest.Builder> updateContainerInstancesStateRequest)

      Modifies the status of an Amazon ECS container instance.

      Once a container instance has reached an ACTIVE state, 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.

      A container instance can't be changed to DRAINING until it has reached an ACTIVE status. If the instance is in any other status, an error will be received.

      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're in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state and are reported as healthy by the load balancer.

      • The maximumPercent parameter represents an upper limit on the number of running tasks during task replacement. You can use this 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 aren't 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 a container instance has been drained, you can set a container instance to ACTIVE status and once it has reached that status 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()

      Parameters:
      updateContainerInstancesStateRequest - A Consumer that will call methods on UpdateContainerInstancesStateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateContainerInstancesState operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't 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.
      See Also:

    • updateService

      default CompletableFuture<UpdateServiceResponse> updateService(UpdateServiceRequest updateServiceRequest)

      Modifies the parameters of a service.

      On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

      For services using the rolling update (ECS) you can update the desired count, deployment configuration, network configuration, load balancers, service registries, enable ECS managed tags option, propagate tags option, task placement constraints and strategies, and task definition. When you update any of these parameters, Amazon ECS starts new tasks with the new configuration.

      You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a task, or when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide. You can update your volume configurations and trigger a new deployment. volumeConfigurations is only supported for REPLICA service and not DAEMON service. If you leave volumeConfigurations null, it doesn't trigger a new deployment. For more infomation on volumes, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

      For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired count, deployment configuration, health check grace period, task placement constraints and strategies, enable ECS managed tags option, and propagate tags can be updated using this API. If the network configuration, platform version, task definition, or load balancer need to be updated, create a new CodeDeploy deployment. For more information, see CreateDeployment in the CodeDeploy API Reference.

      For services using an external deployment controller, you can update only the desired count, task placement constraints and strategies, health check grace period, enable ECS managed tags option, and propagate tags option, using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be updated, create a new task set For more information, see CreateTaskSet.

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

      You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a task, or when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

      If you have updated the container 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 don't 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 don't use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state and are reported as healthy by the load balancer.

      • The maximumPercent parameter represents an upper limit on the number of running tasks during a deployment. You can use it 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 this, 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 even though 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.

      You must have a service-linked role when you update any of the following service properties:

      • loadBalancers,

      • serviceRegistries

      For more information about the role see the CreateService request parameter role .

      Parameters:
      updateServiceRequest -
      Returns:
      A Java Future containing the result of the UpdateService operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • ServiceNotFoundException The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.
        • ServiceNotActiveException The specified service isn't active. You can't update a service that's inactive. If you have previously deleted a service, you can re-create it with CreateService.
        • PlatformUnknownException The specified platform version doesn't exist.
        • PlatformTaskDefinitionIncompatibilityException The specified platform version doesn't satisfy the required capabilities of the task definition.
        • AccessDeniedException You don't have authorization to perform the requested action.
        • NamespaceNotFoundException The specified namespace wasn't found.
        • UnsupportedFeatureException The specified task isn't supported in this Region.
        • 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.
      See Also:

    • updateService

      default CompletableFuture<UpdateServiceResponse> updateService(Consumer<UpdateServiceRequest.Builder> updateServiceRequest)

      Modifies the parameters of a service.

      On March 21, 2024, a change was made to resolve the task definition revision before authorization. When a task definition revision is not specified, authorization will occur using the latest revision of a task definition.

      For services using the rolling update (ECS) you can update the desired count, deployment configuration, network configuration, load balancers, service registries, enable ECS managed tags option, propagate tags option, task placement constraints and strategies, and task definition. When you update any of these parameters, Amazon ECS starts new tasks with the new configuration.

      You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a task, or when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide. You can update your volume configurations and trigger a new deployment. volumeConfigurations is only supported for REPLICA service and not DAEMON service. If you leave volumeConfigurations null, it doesn't trigger a new deployment. For more infomation on volumes, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

      For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired count, deployment configuration, health check grace period, task placement constraints and strategies, enable ECS managed tags option, and propagate tags can be updated using this API. If the network configuration, platform version, task definition, or load balancer need to be updated, create a new CodeDeploy deployment. For more information, see CreateDeployment in the CodeDeploy API Reference.

      For services using an external deployment controller, you can update only the desired count, task placement constraints and strategies, health check grace period, enable ECS managed tags option, and propagate tags option, using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be updated, create a new task set For more information, see CreateTaskSet.

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

      You can attach Amazon EBS volumes to Amazon ECS tasks by configuring the volume when starting or running a task, or when creating or updating a service. For more infomation, see Amazon EBS volumes in the Amazon Elastic Container Service Developer Guide.

      If you have updated the container 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 don't 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 don't use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they're in the RUNNING state and are reported as healthy by the load balancer.

      • The maximumPercent parameter represents an upper limit on the number of running tasks during a deployment. You can use it 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 this, 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 even though 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.

      You must have a service-linked role when you update any of the following service properties:

      • loadBalancers,

      • serviceRegistries

      For more information about the role see the CreateService request parameter role .


      This is a convenience which creates an instance of the UpdateServiceRequest.Builder avoiding the need to create one manually via UpdateServiceRequest.builder()

      Parameters:
      updateServiceRequest - A Consumer that will call methods on UpdateServiceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateService operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • ServiceNotFoundException The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.
        • ServiceNotActiveException The specified service isn't active. You can't update a service that's inactive. If you have previously deleted a service, you can re-create it with CreateService.
        • PlatformUnknownException The specified platform version doesn't exist.
        • PlatformTaskDefinitionIncompatibilityException The specified platform version doesn't satisfy the required capabilities of the task definition.
        • AccessDeniedException You don't have authorization to perform the requested action.
        • NamespaceNotFoundException The specified namespace wasn't found.
        • UnsupportedFeatureException The specified task isn't supported in this Region.
        • 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.
      See Also:

    • updateServicePrimaryTaskSet

      default CompletableFuture<UpdateServicePrimaryTaskSetResponse> updateServicePrimaryTaskSet(UpdateServicePrimaryTaskSetRequest updateServicePrimaryTaskSetRequest)

      Modifies which task set in a service is the primary task set. Any parameters that are updated on the primary task set in a service will transition to the service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      updateServicePrimaryTaskSetRequest -
      Returns:
      A Java Future containing the result of the UpdateServicePrimaryTaskSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • UnsupportedFeatureException The specified task isn't supported in this Region.
        • ServiceNotFoundException The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.
        • ServiceNotActiveException The specified service isn't active. You can't update a service that's inactive. If you have previously deleted a service, you can re-create it with CreateService.
        • TaskSetNotFoundException The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region.
        • AccessDeniedException You don't 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.
      See Also:

    • updateServicePrimaryTaskSet

      default CompletableFuture<UpdateServicePrimaryTaskSetResponse> updateServicePrimaryTaskSet(Consumer<UpdateServicePrimaryTaskSetRequest.Builder> updateServicePrimaryTaskSetRequest)

      Modifies which task set in a service is the primary task set. Any parameters that are updated on the primary task set in a service will transition to the service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.


      This is a convenience which creates an instance of the UpdateServicePrimaryTaskSetRequest.Builder avoiding the need to create one manually via UpdateServicePrimaryTaskSetRequest.builder()

      Parameters:
      updateServicePrimaryTaskSetRequest - A Consumer that will call methods on UpdateServicePrimaryTaskSetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateServicePrimaryTaskSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • UnsupportedFeatureException The specified task isn't supported in this Region.
        • ServiceNotFoundException The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.
        • ServiceNotActiveException The specified service isn't active. You can't update a service that's inactive. If you have previously deleted a service, you can re-create it with CreateService.
        • TaskSetNotFoundException The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region.
        • AccessDeniedException You don't 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.
      See Also:

    • updateTaskProtection

      default CompletableFuture<UpdateTaskProtectionResponse> updateTaskProtection(UpdateTaskProtectionRequest updateTaskProtectionRequest)

      Updates the protection status of a task. You can set protectionEnabled to true to protect your task from termination during scale-in events from Service Autoscaling or deployments.

      Task-protection, by default, expires after 2 hours at which point Amazon ECS clears the protectionEnabled property making the task eligible for termination by a subsequent scale-in event.

      You can specify a custom expiration period for task protection from 1 minute to up to 2,880 minutes (48 hours). To specify the custom expiration period, set the expiresInMinutes property. The expiresInMinutes property is always reset when you invoke this operation for a task that already has protectionEnabled set to true. You can keep extending the protection expiration period of a task by invoking this operation repeatedly.

      To learn more about Amazon ECS task protection, see Task scale-in protection in the Amazon Elastic Container Service Developer Guide .

      This operation is only supported for tasks belonging to an Amazon ECS service. Invoking this operation for a standalone task will result in an TASK_NOT_VALID failure. For more information, see API failure reasons.

      If you prefer to set task protection from within the container, we recommend using the Task scale-in protection endpoint.

      Parameters:
      updateTaskProtectionRequest -
      Returns:
      A Java Future containing the result of the UpdateTaskProtection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have authorization to perform the requested action.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ResourceNotFoundException The specified resource wasn't found.
        • ServerException These errors are usually caused by a server issue.
        • UnsupportedFeatureException The specified task isn't supported in this Region.
        • 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.
      See Also:

    • updateTaskProtection

      default CompletableFuture<UpdateTaskProtectionResponse> updateTaskProtection(Consumer<UpdateTaskProtectionRequest.Builder> updateTaskProtectionRequest)

      Updates the protection status of a task. You can set protectionEnabled to true to protect your task from termination during scale-in events from Service Autoscaling or deployments.

      Task-protection, by default, expires after 2 hours at which point Amazon ECS clears the protectionEnabled property making the task eligible for termination by a subsequent scale-in event.

      You can specify a custom expiration period for task protection from 1 minute to up to 2,880 minutes (48 hours). To specify the custom expiration period, set the expiresInMinutes property. The expiresInMinutes property is always reset when you invoke this operation for a task that already has protectionEnabled set to true. You can keep extending the protection expiration period of a task by invoking this operation repeatedly.

      To learn more about Amazon ECS task protection, see Task scale-in protection in the Amazon Elastic Container Service Developer Guide .

      This operation is only supported for tasks belonging to an Amazon ECS service. Invoking this operation for a standalone task will result in an TASK_NOT_VALID failure. For more information, see API failure reasons.

      If you prefer to set task protection from within the container, we recommend using the Task scale-in protection endpoint.


      This is a convenience which creates an instance of the UpdateTaskProtectionRequest.Builder avoiding the need to create one manually via UpdateTaskProtectionRequest.builder()

      Parameters:
      updateTaskProtectionRequest - A Consumer that will call methods on UpdateTaskProtectionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateTaskProtection operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • AccessDeniedException You don't have authorization to perform the requested action.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ResourceNotFoundException The specified resource wasn't found.
        • ServerException These errors are usually caused by a server issue.
        • UnsupportedFeatureException The specified task isn't supported in this Region.
        • 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.
      See Also:

    • updateTaskSet

      default CompletableFuture<UpdateTaskSetResponse> updateTaskSet(UpdateTaskSetRequest updateTaskSetRequest)

      Modifies a task set. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      updateTaskSetRequest -
      Returns:
      A Java Future containing the result of the UpdateTaskSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • UnsupportedFeatureException The specified task isn't supported in this Region.
        • AccessDeniedException You don't have authorization to perform the requested action.
        • ServiceNotFoundException The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.
        • ServiceNotActiveException The specified service isn't active. You can't update a service that's inactive. If you have previously deleted a service, you can re-create it with CreateService.
        • TaskSetNotFoundException The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region.
        • 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.
      See Also:

    • updateTaskSet

      default CompletableFuture<UpdateTaskSetResponse> updateTaskSet(Consumer<UpdateTaskSetRequest.Builder> updateTaskSetRequest)

      Modifies a task set. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.


      This is a convenience which creates an instance of the UpdateTaskSetRequest.Builder avoiding the need to create one manually via UpdateTaskSetRequest.builder()

      Parameters:
      updateTaskSetRequest - A Consumer that will call methods on UpdateTaskSetRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateTaskSet operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • ServerException These errors are usually caused by a server issue.
      • ClientException These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.

        The following list includes additional causes for the error:

        • The RunTask could not be processed because you use managed scaling and there is a capacity error because the quota of tasks in the PROVISIONING per cluster has been reached. For information about the service quotas, see Amazon ECS service quotas.

        • InvalidParameterException The specified parameter isn't valid. Review the available parameters for the API request.
        • ClusterNotFoundException The specified cluster wasn't found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region specific.
        • UnsupportedFeatureException The specified task isn't supported in this Region.
        • AccessDeniedException You don't have authorization to perform the requested action.
        • ServiceNotFoundException The specified service wasn't found. You can view your available services with ListServices. Amazon ECS services are cluster specific and Region specific.
        • ServiceNotActiveException The specified service isn't active. You can't update a service that's inactive. If you have previously deleted a service, you can re-create it with CreateService.
        • TaskSetNotFoundException The specified task set wasn't found. You can view your available task sets with DescribeTaskSets. Task sets are specific to each cluster, service and Region.
        • 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.
      See Also:

    • waiter

      default EcsAsyncWaiter waiter()
      Create an instance of EcsAsyncWaiter using this client.

      Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.

      Returns:
      an instance of EcsAsyncWaiter

    • serviceClientConfiguration

      default EcsServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static EcsAsyncClient create()
      Create a EcsAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static EcsAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a EcsAsyncClient.