amazonka-ecs-2.0: Amazon EC2 Container Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ECS.DeregisterTaskDefinition

Description

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

You 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.

Synopsis

Creating a Request

data DeregisterTaskDefinition Source #

See: newDeregisterTaskDefinition smart constructor.

Constructors

DeregisterTaskDefinition' 

Fields

  • taskDefinition :: Text

    The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to deregister. You must specify a revision.

Instances

Instances details
ToJSON DeregisterTaskDefinition Source # 
Instance details

Defined in Amazonka.ECS.DeregisterTaskDefinition

ToHeaders DeregisterTaskDefinition Source # 
Instance details

Defined in Amazonka.ECS.DeregisterTaskDefinition

ToPath DeregisterTaskDefinition Source # 
Instance details

Defined in Amazonka.ECS.DeregisterTaskDefinition

ToQuery DeregisterTaskDefinition Source # 
Instance details

Defined in Amazonka.ECS.DeregisterTaskDefinition

AWSRequest DeregisterTaskDefinition Source # 
Instance details

Defined in Amazonka.ECS.DeregisterTaskDefinition

Generic DeregisterTaskDefinition Source # 
Instance details

Defined in Amazonka.ECS.DeregisterTaskDefinition

Associated Types

type Rep DeregisterTaskDefinition :: Type -> Type #

Read DeregisterTaskDefinition Source # 
Instance details

Defined in Amazonka.ECS.DeregisterTaskDefinition

Show DeregisterTaskDefinition Source # 
Instance details

Defined in Amazonka.ECS.DeregisterTaskDefinition

NFData DeregisterTaskDefinition Source # 
Instance details

Defined in Amazonka.ECS.DeregisterTaskDefinition

Eq DeregisterTaskDefinition Source # 
Instance details

Defined in Amazonka.ECS.DeregisterTaskDefinition

Hashable DeregisterTaskDefinition Source # 
Instance details

Defined in Amazonka.ECS.DeregisterTaskDefinition

type AWSResponse DeregisterTaskDefinition Source # 
Instance details

Defined in Amazonka.ECS.DeregisterTaskDefinition

type Rep DeregisterTaskDefinition Source # 
Instance details

Defined in Amazonka.ECS.DeregisterTaskDefinition

type Rep DeregisterTaskDefinition = D1 ('MetaData "DeregisterTaskDefinition" "Amazonka.ECS.DeregisterTaskDefinition" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "DeregisterTaskDefinition'" 'PrefixI 'True) (S1 ('MetaSel ('Just "taskDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeregisterTaskDefinition Source #

Create a value of DeregisterTaskDefinition 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:

DeregisterTaskDefinition, deregisterTaskDefinition_taskDefinition - The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to deregister. You must specify a revision.

Request Lenses

deregisterTaskDefinition_taskDefinition :: Lens' DeregisterTaskDefinition Text Source #

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to deregister. You must specify a revision.

Destructuring the Response

data DeregisterTaskDefinitionResponse Source #

See: newDeregisterTaskDefinitionResponse smart constructor.

Constructors

DeregisterTaskDefinitionResponse' 

Fields

Instances

Instances details
Generic DeregisterTaskDefinitionResponse Source # 
Instance details

Defined in Amazonka.ECS.DeregisterTaskDefinition

Associated Types

type Rep DeregisterTaskDefinitionResponse :: Type -> Type #

Read DeregisterTaskDefinitionResponse Source # 
Instance details

Defined in Amazonka.ECS.DeregisterTaskDefinition

Show DeregisterTaskDefinitionResponse Source # 
Instance details

Defined in Amazonka.ECS.DeregisterTaskDefinition

NFData DeregisterTaskDefinitionResponse Source # 
Instance details

Defined in Amazonka.ECS.DeregisterTaskDefinition

Eq DeregisterTaskDefinitionResponse Source # 
Instance details

Defined in Amazonka.ECS.DeregisterTaskDefinition

type Rep DeregisterTaskDefinitionResponse Source # 
Instance details

Defined in Amazonka.ECS.DeregisterTaskDefinition

type Rep DeregisterTaskDefinitionResponse = D1 ('MetaData "DeregisterTaskDefinitionResponse" "Amazonka.ECS.DeregisterTaskDefinition" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "DeregisterTaskDefinitionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "taskDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskDefinition)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeregisterTaskDefinitionResponse Source #

Create a value of DeregisterTaskDefinitionResponse 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:

DeregisterTaskDefinition, deregisterTaskDefinitionResponse_taskDefinition - The full description of the deregistered task.

$sel:httpStatus:DeregisterTaskDefinitionResponse', deregisterTaskDefinitionResponse_httpStatus - The response's http status code.

Response Lenses