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.CodePipeline.StopPipelineExecution

Contents

Description

Stops the specified pipeline execution. You choose to either stop the pipeline execution by completing in-progress actions without starting subsequent actions, or by abandoning in-progress actions. While completing or abandoning in-progress actions, the pipeline execution is in a Stopping state. After all in-progress actions are completed or abandoned, the pipeline execution is in a Stopped state.

Synopsis

data StopPipelineExecution = StopPipelineExecution' {
- abandon :: Maybe Bool
- reason :: Maybe Text
- pipelineName :: Text
- pipelineExecutionId :: Text
}
newStopPipelineExecution :: Text -> Text -> StopPipelineExecution
stopPipelineExecution_abandon :: Lens' StopPipelineExecution (Maybe Bool)
stopPipelineExecution_reason :: Lens' StopPipelineExecution (Maybe Text)
stopPipelineExecution_pipelineName :: Lens' StopPipelineExecution Text
stopPipelineExecution_pipelineExecutionId :: Lens' StopPipelineExecution Text
data StopPipelineExecutionResponse = StopPipelineExecutionResponse' {
- pipelineExecutionId :: Maybe Text
- httpStatus :: Int
}
newStopPipelineExecutionResponse :: Int -> StopPipelineExecutionResponse
stopPipelineExecutionResponse_pipelineExecutionId :: Lens' StopPipelineExecutionResponse (Maybe Text)
stopPipelineExecutionResponse_httpStatus :: Lens' StopPipelineExecutionResponse Int

Creating a Request

data StopPipelineExecution Source #

See: newStopPipelineExecution smart constructor.

Constructors

StopPipelineExecution'

Fields

abandon :: Maybe Bool
Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.
This option can lead to failed or out-of-sequence tasks.
reason :: Maybe Text
Use this option to enter comments, such as the reason the pipeline was stopped.
pipelineName :: Text
The name of the pipeline to stop.
pipelineExecutionId :: Text
The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

Instances

Instances details

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

newStopPipelineExecution Source #

Arguments

:: Text	`StopPipelineExecution`
-> Text	`StopPipelineExecution`
-> StopPipelineExecution

Create a value of StopPipelineExecution 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:abandon:StopPipelineExecution', stopPipelineExecution_abandon - Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.

This option can lead to failed or out-of-sequence tasks.

StopPipelineExecution, stopPipelineExecution_reason - Use this option to enter comments, such as the reason the pipeline was stopped.

StopPipelineExecution, stopPipelineExecution_pipelineName - The name of the pipeline to stop.

StopPipelineExecution, stopPipelineExecution_pipelineExecutionId - The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

Request Lenses

stopPipelineExecution_abandon :: Lens' StopPipelineExecution (Maybe Bool) Source #

Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.

This option can lead to failed or out-of-sequence tasks.

stopPipelineExecution_reason :: Lens' StopPipelineExecution (Maybe Text) Source #

Use this option to enter comments, such as the reason the pipeline was stopped.

stopPipelineExecution_pipelineName :: Lens' StopPipelineExecution Text Source #

The name of the pipeline to stop.

stopPipelineExecution_pipelineExecutionId :: Lens' StopPipelineExecution Text Source #

The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

Destructuring the Response

data StopPipelineExecutionResponse Source #

See: newStopPipelineExecutionResponse smart constructor.

Constructors

StopPipelineExecutionResponse'
Fields pipelineExecutionId :: Maybe Text The unique system-generated ID of the pipeline execution that was stopped. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic StopPipelineExecutionResponse Source #
Instance details Defined in Amazonka.CodePipeline.StopPipelineExecution Associated Types type Rep StopPipelineExecutionResponse :: Type -> Type # Methods from :: StopPipelineExecutionResponse -> Rep StopPipelineExecutionResponse x # to :: Rep StopPipelineExecutionResponse x -> StopPipelineExecutionResponse #
Read StopPipelineExecutionResponse Source #
Instance details Defined in Amazonka.CodePipeline.StopPipelineExecution Methods readsPrec :: Int -> ReadS StopPipelineExecutionResponse # readList :: ReadS [StopPipelineExecutionResponse] # readPrec :: ReadPrec StopPipelineExecutionResponse # readListPrec :: ReadPrec [StopPipelineExecutionResponse] #
Show StopPipelineExecutionResponse Source #
Instance details Defined in Amazonka.CodePipeline.StopPipelineExecution Methods showsPrec :: Int -> StopPipelineExecutionResponse -> ShowS # show :: StopPipelineExecutionResponse -> String # showList :: [StopPipelineExecutionResponse] -> ShowS #
NFData StopPipelineExecutionResponse Source #
Instance details Defined in Amazonka.CodePipeline.StopPipelineExecution Methods rnf :: StopPipelineExecutionResponse -> () #
Eq StopPipelineExecutionResponse Source #
Instance details Defined in Amazonka.CodePipeline.StopPipelineExecution Methods (==) :: StopPipelineExecutionResponse -> StopPipelineExecutionResponse -> Bool # (/=) :: StopPipelineExecutionResponse -> StopPipelineExecutionResponse -> Bool #
type Rep StopPipelineExecutionResponse Source #
Instance details Defined in Amazonka.CodePipeline.StopPipelineExecution type Rep StopPipelineExecutionResponse = D1 ('MetaData "StopPipelineExecutionResponse" "Amazonka.CodePipeline.StopPipelineExecution" "amazonka-codepipeline-2.0-AHHPJTmnvhi1gPjRAFzjQE" 'False) (C1 ('MetaCons "StopPipelineExecutionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pipelineExecutionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStopPipelineExecutionResponse Source #

Arguments

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

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

StopPipelineExecution, stopPipelineExecutionResponse_pipelineExecutionId - The unique system-generated ID of the pipeline execution that was stopped.

$sel:httpStatus:StopPipelineExecutionResponse', stopPipelineExecutionResponse_httpStatus - The response's http status code.

Response Lenses

stopPipelineExecutionResponse_pipelineExecutionId :: Lens' StopPipelineExecutionResponse (Maybe Text) Source #

The unique system-generated ID of the pipeline execution that was stopped.

stopPipelineExecutionResponse_httpStatus :: Lens' StopPipelineExecutionResponse Int Source #

The response's http status code.