View a markdown version of this page

Use DeleteService with an AWS SDK or CLI - AWS SDK Code Examples

There are more AWS SDK examples available in the AWS Doc SDK Examples GitHub repo.

Use DeleteService with an AWS SDK or CLI

The following code examples show how to use DeleteService.

Action examples are code excerpts from larger programs and must be run in context. You can see this action in context in the following code examples:

CLI
AWS CLI

To delete a service

The following ecs delete-service example deletes the specified service from a cluster. You can include the --force parameter to delete a service even if it has not been scaled to zero tasks.

aws ecs delete-service --cluster MyCluster --service MyService1 --force

For more information, see Deleting a Service in the Amazon ECS Developer Guide.

  • For API details, see DeleteService in AWS CLI Command Reference.

Java
SDK for Java 2.x
Note

There's more on GitHub. Find the complete example and learn how to set up and run in the AWS Code Examples Repository.

import software.amazon.awssdk.regions.Region; import software.amazon.awssdk.services.ecs.EcsClient; import software.amazon.awssdk.services.ecs.model.DeleteServiceRequest; import software.amazon.awssdk.services.ecs.model.EcsException; /** * Before running this Java V2 code example, set up your development * environment, including your credentials. * * For more information, see the following documentation topic: * * https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html */ public class DeleteService { public static void main(String[] args) { final String usage = """ Usage: <clusterName> <serviceArn>\s Where: clusterName - The name of the ECS cluster. serviceArn - The ARN of the ECS service. """; if (args.length != 2) { System.out.println(usage); System.exit(1); } String clusterName = args[0]; String serviceArn = args[1]; Region region = Region.US_EAST_1; EcsClient ecsClient = EcsClient.builder() .region(region) .build(); deleteSpecificService(ecsClient, clusterName, serviceArn); ecsClient.close(); } public static void deleteSpecificService(EcsClient ecsClient, String clusterName, String serviceArn) { try { DeleteServiceRequest serviceRequest = DeleteServiceRequest.builder() .cluster(clusterName) .service(serviceArn) .build(); ecsClient.deleteService(serviceRequest); System.out.println("The Service was successfully deleted"); } catch (EcsException e) { System.err.println(e.awsErrorDetails().errorMessage()); System.exit(1); } } }
  • For API details, see DeleteService in AWS SDK for Java 2.x API Reference.

PowerShell
Tools for PowerShell V4

Example 1: Deletes the service named 'my-http-service' in the default cluster. The service must have a desired count and running count of 0 before you can delete it. You are prompted for confirmation before the command proceeds. To bypass the confirmation prompt add the -Force switch.

Remove-ECSService -Service my-http-service

Example 2: Deletes the service named 'my-http-service' in the named cluster.

Remove-ECSService -Cluster myCluster -Service my-http-service
  • For API details, see DeleteService in AWS Tools for PowerShell Cmdlet Reference (V4).

Tools for PowerShell V5

Example 1: Deletes the service named 'my-http-service' in the default cluster. The service must have a desired count and running count of 0 before you can delete it. You are prompted for confirmation before the command proceeds. To bypass the confirmation prompt add the -Force switch.

Remove-ECSService -Service my-http-service

Example 2: Deletes the service named 'my-http-service' in the named cluster.

Remove-ECSService -Cluster myCluster -Service my-http-service
  • For API details, see DeleteService in AWS Tools for PowerShell Cmdlet Reference (V5).

Python
SDK for Python (Boto3)
Note

There's more on GitHub. Find the complete example and learn how to set up and run in the AWS Code Examples Repository.

class EcsWrapper: """Encapsulates Amazon ECS operations.""" def __init__(self, ecs_client: BaseClient): """ Initializes the EcsWrapper with an ECS client. :param ecs_client: A Boto3 Amazon ECS client. Boto3 clients are created by the ``boto3.client`` factory function and are instances of ``botocore.client.BaseClient``, which is the correct type to annotate here (``boto3.client`` itself is a function, not a type). """ self.ecs_client = ecs_client @classmethod def from_client(cls) -> "EcsWrapper": """Creates an EcsWrapper using a default Boto3 ECS client.""" ecs_client = boto3.client("ecs") return cls(ecs_client) def delete_service( self, cluster: str, service: str, force: bool = True, ) -> Dict[str, Any]: """ Deletes a service from a cluster. :param cluster: The cluster name or ARN. :param service: The service name or ARN. :param force: If True, deletes the service even if it has active tasks. :return: The deleted service details. :raises ClientError: If the request fails (e.g., ServiceNotFoundException). """ try: response = self.ecs_client.delete_service( cluster=cluster, service=service, force=force, ) svc = response["service"] logger.info( "Deleted service '%s' from cluster '%s'", svc["serviceName"], cluster, ) return svc except ClientError as err: if err.response["Error"]["Code"] == "ServiceNotFoundException": logger.error( "Service '%s' not found (may already be deleted): %s", service, err.response["Error"]["Message"], ) raise
  • For API details, see DeleteService in AWS SDK for Python (Boto3) API Reference.