libZSservicesZSamazonka-ecsZSamazonka-ecs
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ECS.DeleteService

Description

Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService.

When you delete a service, if there are still running tasks that require cleanup, the service status moves from ACTIVE to DRAINING, and the service is no longer visible in the console or in the ListServices API operation. After 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.

Synopsis

Creating a Request

data DeleteService Source #

See: newDeleteService smart constructor.

Constructors

DeleteService' 

Fields

  • cluster :: Maybe Text

    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed.

  • force :: Maybe Bool

    If true, allows you to delete a service even if it has not been scaled down to zero tasks. It is only necessary to use this if the service is using the REPLICA scheduling strategy.

  • service :: Text

    The name of the service to delete.

Instances

Instances details
Eq DeleteService Source # 
Instance details

Defined in Amazonka.ECS.DeleteService

Read DeleteService Source # 
Instance details

Defined in Amazonka.ECS.DeleteService

Show DeleteService Source # 
Instance details

Defined in Amazonka.ECS.DeleteService

Generic DeleteService Source # 
Instance details

Defined in Amazonka.ECS.DeleteService

Associated Types

type Rep DeleteService :: Type -> Type #

NFData DeleteService Source # 
Instance details

Defined in Amazonka.ECS.DeleteService

Methods

rnf :: DeleteService -> () #

Hashable DeleteService Source # 
Instance details

Defined in Amazonka.ECS.DeleteService

ToJSON DeleteService Source # 
Instance details

Defined in Amazonka.ECS.DeleteService

AWSRequest DeleteService Source # 
Instance details

Defined in Amazonka.ECS.DeleteService

Associated Types

type AWSResponse DeleteService #

ToHeaders DeleteService Source # 
Instance details

Defined in Amazonka.ECS.DeleteService

ToPath DeleteService Source # 
Instance details

Defined in Amazonka.ECS.DeleteService

ToQuery DeleteService Source # 
Instance details

Defined in Amazonka.ECS.DeleteService

type Rep DeleteService Source # 
Instance details

Defined in Amazonka.ECS.DeleteService

type Rep DeleteService = D1 ('MetaData "DeleteService" "Amazonka.ECS.DeleteService" "libZSservicesZSamazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "DeleteService'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "force") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "service") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse DeleteService Source # 
Instance details

Defined in Amazonka.ECS.DeleteService

newDeleteService Source #

Create a value of DeleteService with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cluster:DeleteService', deleteService_cluster - The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed.

$sel:force:DeleteService', deleteService_force - If true, allows you to delete a service even if it has not been scaled down to zero tasks. It is only necessary to use this if the service is using the REPLICA scheduling strategy.

$sel:service:DeleteService', deleteService_service - The name of the service to delete.

Request Lenses

deleteService_cluster :: Lens' DeleteService (Maybe Text) Source #

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed.

deleteService_force :: Lens' DeleteService (Maybe Bool) Source #

If true, allows you to delete a service even if it has not been scaled down to zero tasks. It is only necessary to use this if the service is using the REPLICA scheduling strategy.

deleteService_service :: Lens' DeleteService Text Source #

The name of the service to delete.

Destructuring the Response

data DeleteServiceResponse Source #

See: newDeleteServiceResponse smart constructor.

Constructors

DeleteServiceResponse' 

Fields

Instances

Instances details
Eq DeleteServiceResponse Source # 
Instance details

Defined in Amazonka.ECS.DeleteService

Read DeleteServiceResponse Source # 
Instance details

Defined in Amazonka.ECS.DeleteService

Show DeleteServiceResponse Source # 
Instance details

Defined in Amazonka.ECS.DeleteService

Generic DeleteServiceResponse Source # 
Instance details

Defined in Amazonka.ECS.DeleteService

Associated Types

type Rep DeleteServiceResponse :: Type -> Type #

NFData DeleteServiceResponse Source # 
Instance details

Defined in Amazonka.ECS.DeleteService

Methods

rnf :: DeleteServiceResponse -> () #

type Rep DeleteServiceResponse Source # 
Instance details

Defined in Amazonka.ECS.DeleteService

type Rep DeleteServiceResponse = D1 ('MetaData "DeleteServiceResponse" "Amazonka.ECS.DeleteService" "libZSservicesZSamazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "DeleteServiceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "service") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContainerService)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeleteServiceResponse Source #

Create a value of DeleteServiceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:service:DeleteService', deleteServiceResponse_service - The full description of the deleted service.

$sel:httpStatus:DeleteServiceResponse', deleteServiceResponse_httpStatus - The response's http status code.

Response Lenses