Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.DataPipeline.DeletePipeline

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Deletes a pipeline, its pipeline definition, and its run history. AWS Data Pipeline attempts to cancel instances associated with the pipeline that are currently being processed by task runners.

Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline. To temporarily pause a pipeline instead of deleting it, call SetStatus with the status set to PAUSE on individual components. Components that are paused by SetStatus can be resumed.

Synopsis

data DeletePipeline = DeletePipeline' {
- pipelineId :: Text
}
newDeletePipeline :: Text -> DeletePipeline
deletePipeline_pipelineId :: Lens' DeletePipeline Text
data DeletePipelineResponse = DeletePipelineResponse' {
}
newDeletePipelineResponse :: DeletePipelineResponse

Creating a Request

data DeletePipeline Source #

Contains the parameters for DeletePipeline.

See: newDeletePipeline smart constructor.

Constructors

DeletePipeline'
Fields pipelineId :: Text The ID of the pipeline.

Instances

Instances details

ToJSON DeletePipeline Source #
Instance details Defined in Amazonka.DataPipeline.DeletePipeline Methods toJSON :: DeletePipeline -> Value # toEncoding :: DeletePipeline -> Encoding # toJSONList :: [DeletePipeline] -> Value # toEncodingList :: [DeletePipeline] -> Encoding #
ToHeaders DeletePipeline Source #
Instance details Defined in Amazonka.DataPipeline.DeletePipeline Methods toHeaders :: DeletePipeline -> [Header] #
ToPath DeletePipeline Source #
Instance details Defined in Amazonka.DataPipeline.DeletePipeline Methods toPath :: DeletePipeline -> ByteString #
ToQuery DeletePipeline Source #
Instance details Defined in Amazonka.DataPipeline.DeletePipeline Methods toQuery :: DeletePipeline -> QueryString #
AWSRequest DeletePipeline Source #
Instance details Defined in Amazonka.DataPipeline.DeletePipeline Associated Types type AWSResponse DeletePipeline # Methods request :: (Service -> Service) -> DeletePipeline -> Request DeletePipeline # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeletePipeline -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeletePipeline))) #
Generic DeletePipeline Source #
Instance details Defined in Amazonka.DataPipeline.DeletePipeline Associated Types type Rep DeletePipeline :: Type -> Type # Methods from :: DeletePipeline -> Rep DeletePipeline x # to :: Rep DeletePipeline x -> DeletePipeline #
Read DeletePipeline Source #
Instance details Defined in Amazonka.DataPipeline.DeletePipeline Methods readsPrec :: Int -> ReadS DeletePipeline # readList :: ReadS [DeletePipeline] # readPrec :: ReadPrec DeletePipeline # readListPrec :: ReadPrec [DeletePipeline] #
Show DeletePipeline Source #
Instance details Defined in Amazonka.DataPipeline.DeletePipeline Methods showsPrec :: Int -> DeletePipeline -> ShowS # show :: DeletePipeline -> String # showList :: [DeletePipeline] -> ShowS #
NFData DeletePipeline Source #
Instance details Defined in Amazonka.DataPipeline.DeletePipeline Methods rnf :: DeletePipeline -> () #
Eq DeletePipeline Source #
Instance details Defined in Amazonka.DataPipeline.DeletePipeline Methods (==) :: DeletePipeline -> DeletePipeline -> Bool # (/=) :: DeletePipeline -> DeletePipeline -> Bool #
Hashable DeletePipeline Source #
Instance details Defined in Amazonka.DataPipeline.DeletePipeline Methods hashWithSalt :: Int -> DeletePipeline -> Int # hash :: DeletePipeline -> Int #
type AWSResponse DeletePipeline Source #
Instance details Defined in Amazonka.DataPipeline.DeletePipeline type AWSResponse DeletePipeline = DeletePipelineResponse
type Rep DeletePipeline Source #
Instance details Defined in Amazonka.DataPipeline.DeletePipeline type Rep DeletePipeline = D1 ('MetaData "DeletePipeline" "Amazonka.DataPipeline.DeletePipeline" "amazonka-datapipeline-2.0-1cySuAk2jmdDRpZSxMUuos" 'False) (C1 ('MetaCons "DeletePipeline'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pipelineId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeletePipeline Source #

Arguments

:: Text	`DeletePipeline`
-> DeletePipeline

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

DeletePipeline, deletePipeline_pipelineId - The ID of the pipeline.

Request Lenses

deletePipeline_pipelineId :: Lens' DeletePipeline Text Source #

The ID of the pipeline.

Destructuring the Response

data DeletePipelineResponse Source #

See: newDeletePipelineResponse smart constructor.

Constructors

DeletePipelineResponse'

Instances

Instances details

Generic DeletePipelineResponse Source #
Instance details Defined in Amazonka.DataPipeline.DeletePipeline Associated Types type Rep DeletePipelineResponse :: Type -> Type # Methods from :: DeletePipelineResponse -> Rep DeletePipelineResponse x # to :: Rep DeletePipelineResponse x -> DeletePipelineResponse #
Read DeletePipelineResponse Source #
Instance details Defined in Amazonka.DataPipeline.DeletePipeline Methods readsPrec :: Int -> ReadS DeletePipelineResponse # readList :: ReadS [DeletePipelineResponse] # readPrec :: ReadPrec DeletePipelineResponse # readListPrec :: ReadPrec [DeletePipelineResponse] #
Show DeletePipelineResponse Source #
Instance details Defined in Amazonka.DataPipeline.DeletePipeline Methods showsPrec :: Int -> DeletePipelineResponse -> ShowS # show :: DeletePipelineResponse -> String # showList :: [DeletePipelineResponse] -> ShowS #
NFData DeletePipelineResponse Source #
Instance details Defined in Amazonka.DataPipeline.DeletePipeline Methods rnf :: DeletePipelineResponse -> () #
Eq DeletePipelineResponse Source #
Instance details Defined in Amazonka.DataPipeline.DeletePipeline Methods (==) :: DeletePipelineResponse -> DeletePipelineResponse -> Bool # (/=) :: DeletePipelineResponse -> DeletePipelineResponse -> Bool #
type Rep DeletePipelineResponse Source #
Instance details Defined in Amazonka.DataPipeline.DeletePipeline type Rep DeletePipelineResponse = D1 ('MetaData "DeletePipelineResponse" "Amazonka.DataPipeline.DeletePipeline" "amazonka-datapipeline-2.0-1cySuAk2jmdDRpZSxMUuos" 'False) (C1 ('MetaCons "DeletePipelineResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeletePipelineResponse :: DeletePipelineResponse Source #

Create a value of DeletePipelineResponse with all optional fields omitted.

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