Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ECS.DeleteService

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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.

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 Methods (==) :: DeleteService -> DeleteService -> Bool # (/=) :: DeleteService -> DeleteService -> Bool #
Read DeleteService Source #
Instance details Defined in Amazonka.ECS.DeleteService Methods readsPrec :: Int -> ReadS DeleteService # readList :: ReadS [DeleteService] # readPrec :: ReadPrec DeleteService # readListPrec :: ReadPrec [DeleteService] #
Show DeleteService Source #
Instance details Defined in Amazonka.ECS.DeleteService Methods showsPrec :: Int -> DeleteService -> ShowS # show :: DeleteService -> String # showList :: [DeleteService] -> ShowS #
Generic DeleteService Source #
Instance details Defined in Amazonka.ECS.DeleteService Associated Types type Rep DeleteService :: Type -> Type # Methods from :: DeleteService -> Rep DeleteService x # to :: Rep DeleteService x -> DeleteService #
NFData DeleteService Source #
Instance details Defined in Amazonka.ECS.DeleteService Methods rnf :: DeleteService -> () #
Hashable DeleteService Source #
Instance details Defined in Amazonka.ECS.DeleteService Methods hashWithSalt :: Int -> DeleteService -> Int # hash :: DeleteService -> Int #
ToJSON DeleteService Source #
Instance details Defined in Amazonka.ECS.DeleteService Methods toJSON :: DeleteService -> Value # toEncoding :: DeleteService -> Encoding # toJSONList :: [DeleteService] -> Value # toEncodingList :: [DeleteService] -> Encoding #
AWSRequest DeleteService Source #
Instance details Defined in Amazonka.ECS.DeleteService Associated Types type AWSResponse DeleteService # Methods request :: DeleteService -> Request DeleteService # response :: MonadResource m => Logger -> Service -> Proxy DeleteService -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteService))) #
ToHeaders DeleteService Source #
Instance details Defined in Amazonka.ECS.DeleteService Methods toHeaders :: DeleteService -> [Header] #
ToPath DeleteService Source #
Instance details Defined in Amazonka.ECS.DeleteService Methods toPath :: DeleteService -> ByteString #
ToQuery DeleteService Source #
Instance details Defined in Amazonka.ECS.DeleteService Methods toQuery :: DeleteService -> QueryString #
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 type AWSResponse DeleteService = DeleteServiceResponse

newDeleteService Source #

Arguments

:: Text	`$sel:service:DeleteService'`
-> DeleteService

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 service :: Maybe ContainerService The full description of the deleted service. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DeleteServiceResponse Source #
Instance details Defined in Amazonka.ECS.DeleteService Methods (==) :: DeleteServiceResponse -> DeleteServiceResponse -> Bool # (/=) :: DeleteServiceResponse -> DeleteServiceResponse -> Bool #
Read DeleteServiceResponse Source #
Instance details Defined in Amazonka.ECS.DeleteService Methods readsPrec :: Int -> ReadS DeleteServiceResponse # readList :: ReadS [DeleteServiceResponse] # readPrec :: ReadPrec DeleteServiceResponse # readListPrec :: ReadPrec [DeleteServiceResponse] #
Show DeleteServiceResponse Source #
Instance details Defined in Amazonka.ECS.DeleteService Methods showsPrec :: Int -> DeleteServiceResponse -> ShowS # show :: DeleteServiceResponse -> String # showList :: [DeleteServiceResponse] -> ShowS #
Generic DeleteServiceResponse Source #
Instance details Defined in Amazonka.ECS.DeleteService Associated Types type Rep DeleteServiceResponse :: Type -> Type # Methods from :: DeleteServiceResponse -> Rep DeleteServiceResponse x # to :: Rep DeleteServiceResponse x -> DeleteServiceResponse #
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 #

Arguments

:: Int	`$sel:httpStatus:DeleteServiceResponse'`
-> DeleteServiceResponse

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

deleteServiceResponse_service :: Lens' DeleteServiceResponse (Maybe ContainerService) Source #

The full description of the deleted service.

deleteServiceResponse_httpStatus :: Lens' DeleteServiceResponse Int Source #

The response's http status code.