{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.CodePipeline.DisableStageTransition -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Prevents artifacts in a pipeline from transitioning to the next stage in -- the pipeline. module Amazonka.CodePipeline.DisableStageTransition ( -- * Creating a Request DisableStageTransition (..), newDisableStageTransition, -- * Request Lenses disableStageTransition_pipelineName, disableStageTransition_stageName, disableStageTransition_transitionType, disableStageTransition_reason, -- * Destructuring the Response DisableStageTransitionResponse (..), newDisableStageTransitionResponse, ) where import Amazonka.CodePipeline.Types import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | Represents the input of a @DisableStageTransition@ action. -- -- /See:/ 'newDisableStageTransition' smart constructor. data DisableStageTransition = DisableStageTransition' { -- | The name of the pipeline in which you want to disable the flow of -- artifacts from one stage to another. pipelineName :: Prelude.Text, -- | The name of the stage where you want to disable the inbound or outbound -- transition of artifacts. stageName :: Prelude.Text, -- | Specifies whether artifacts are prevented from transitioning into the -- stage and being processed by the actions in that stage (inbound), or -- prevented from transitioning from the stage after they have been -- processed by the actions in that stage (outbound). transitionType :: StageTransitionType, -- | The reason given to the user that a stage is disabled, such as waiting -- for manual approval or manual tests. This message is displayed in the -- pipeline console UI. reason :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DisableStageTransition' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'pipelineName', 'disableStageTransition_pipelineName' - The name of the pipeline in which you want to disable the flow of -- artifacts from one stage to another. -- -- 'stageName', 'disableStageTransition_stageName' - The name of the stage where you want to disable the inbound or outbound -- transition of artifacts. -- -- 'transitionType', 'disableStageTransition_transitionType' - Specifies whether artifacts are prevented from transitioning into the -- stage and being processed by the actions in that stage (inbound), or -- prevented from transitioning from the stage after they have been -- processed by the actions in that stage (outbound). -- -- 'reason', 'disableStageTransition_reason' - The reason given to the user that a stage is disabled, such as waiting -- for manual approval or manual tests. This message is displayed in the -- pipeline console UI. newDisableStageTransition :: -- | 'pipelineName' Prelude.Text -> -- | 'stageName' Prelude.Text -> -- | 'transitionType' StageTransitionType -> -- | 'reason' Prelude.Text -> DisableStageTransition newDisableStageTransition pPipelineName_ pStageName_ pTransitionType_ pReason_ = DisableStageTransition' { pipelineName = pPipelineName_, stageName = pStageName_, transitionType = pTransitionType_, reason = pReason_ } -- | The name of the pipeline in which you want to disable the flow of -- artifacts from one stage to another. disableStageTransition_pipelineName :: Lens.Lens' DisableStageTransition Prelude.Text disableStageTransition_pipelineName = Lens.lens (\DisableStageTransition' {pipelineName} -> pipelineName) (\s@DisableStageTransition' {} a -> s {pipelineName = a} :: DisableStageTransition) -- | The name of the stage where you want to disable the inbound or outbound -- transition of artifacts. disableStageTransition_stageName :: Lens.Lens' DisableStageTransition Prelude.Text disableStageTransition_stageName = Lens.lens (\DisableStageTransition' {stageName} -> stageName) (\s@DisableStageTransition' {} a -> s {stageName = a} :: DisableStageTransition) -- | Specifies whether artifacts are prevented from transitioning into the -- stage and being processed by the actions in that stage (inbound), or -- prevented from transitioning from the stage after they have been -- processed by the actions in that stage (outbound). disableStageTransition_transitionType :: Lens.Lens' DisableStageTransition StageTransitionType disableStageTransition_transitionType = Lens.lens (\DisableStageTransition' {transitionType} -> transitionType) (\s@DisableStageTransition' {} a -> s {transitionType = a} :: DisableStageTransition) -- | The reason given to the user that a stage is disabled, such as waiting -- for manual approval or manual tests. This message is displayed in the -- pipeline console UI. disableStageTransition_reason :: Lens.Lens' DisableStageTransition Prelude.Text disableStageTransition_reason = Lens.lens (\DisableStageTransition' {reason} -> reason) (\s@DisableStageTransition' {} a -> s {reason = a} :: DisableStageTransition) instance Core.AWSRequest DisableStageTransition where type AWSResponse DisableStageTransition = DisableStageTransitionResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveNull DisableStageTransitionResponse' instance Prelude.Hashable DisableStageTransition where hashWithSalt _salt DisableStageTransition' {..} = _salt `Prelude.hashWithSalt` pipelineName `Prelude.hashWithSalt` stageName `Prelude.hashWithSalt` transitionType `Prelude.hashWithSalt` reason instance Prelude.NFData DisableStageTransition where rnf DisableStageTransition' {..} = Prelude.rnf pipelineName `Prelude.seq` Prelude.rnf stageName `Prelude.seq` Prelude.rnf transitionType `Prelude.seq` Prelude.rnf reason instance Data.ToHeaders DisableStageTransition where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "CodePipeline_20150709.DisableStageTransition" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON DisableStageTransition where toJSON DisableStageTransition' {..} = Data.object ( Prelude.catMaybes [ Prelude.Just ("pipelineName" Data..= pipelineName), Prelude.Just ("stageName" Data..= stageName), Prelude.Just ("transitionType" Data..= transitionType), Prelude.Just ("reason" Data..= reason) ] ) instance Data.ToPath DisableStageTransition where toPath = Prelude.const "/" instance Data.ToQuery DisableStageTransition where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newDisableStageTransitionResponse' smart constructor. data DisableStageTransitionResponse = DisableStageTransitionResponse' { } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DisableStageTransitionResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. newDisableStageTransitionResponse :: DisableStageTransitionResponse newDisableStageTransitionResponse = DisableStageTransitionResponse' instance Prelude.NFData DisableStageTransitionResponse where rnf _ = ()